BusinessTemplate.py 186 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

29
from Shared.DC.ZRDB.Connection import Connection as RDBConnection
30
from Globals import Persistent, PersistentMapping
31
from Acquisition import Implicit, aq_base
32
from AccessControl.Permission import Permission
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33 34
from AccessControl import ClassSecurityInfo
from Products.CMFCore.utils import getToolByName
35
from Products.CMFCore.WorkflowCore import WorkflowMethod
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
37 38 39 40
from Products.ERP5Type.Utils import readLocalDocument, \
                                    writeLocalDocument, \
                                    importLocalDocument, \
                                    removeLocalDocument
41 42 43 44
from Products.ERP5Type.Utils import readLocalPropertySheet, \
                                    writeLocalPropertySheet, \
                                    importLocalPropertySheet, \
                                    removeLocalPropertySheet
45
from Products.ERP5Type.Utils import readLocalConstraint, \
Romain Courteaud's avatar
Romain Courteaud committed
46
                                    writeLocalConstraint, \
47 48 49 50
                                    importLocalConstraint, \
                                    removeLocalConstraint
from Products.ERP5Type.Utils import readLocalExtension, \
                                    writeLocalExtension, \
51
                                    removeLocalExtension
52 53
from Products.ERP5Type.Utils import readLocalTest, \
                                    writeLocalTest, \
54
                                    removeLocalTest
Jean-Paul Smets's avatar
Jean-Paul Smets committed
55
from Products.ERP5Type.XMLObject import XMLObject
56
from Products.ERP5Type.RoleInformation import RoleInformation
57
import fnmatch
Aurel's avatar
Aurel committed
58
import re, os, sys, string, tarfile
Yoshinori Okuji's avatar
Yoshinori Okuji committed
59
from Products.ERP5Type.Cache import clearCache
60
from DateTime import DateTime
Aurel's avatar
Aurel committed
61
from OFS.Traversable import NotFound
62 63
from OFS import XMLExportImport
from cStringIO import StringIO
Aurel's avatar
Aurel committed
64 65
from copy import deepcopy
from App.config import getConfiguration
66
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
67 68 69 70
import OFS.XMLExportImport
customImporters={
    XMLExportImport.magic: XMLExportImport.importXML,
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
71

Jérome Perrin's avatar
Jérome Perrin committed
72
from zLOG import LOG, WARNING, ERROR
Aurel's avatar
Aurel committed
73 74
from OFS.ObjectManager import customImporters
from gzip import GzipFile
75
from xml.dom.minidom import parse
76
from Products.CMFCore.Expression import Expression
Aurel's avatar
Aurel committed
77
import tarfile
78
from urllib import pathname2url, url2pathname
79
from difflib import unified_diff
Aurel's avatar
Aurel committed
80 81


82 83
# those attributes from CatalogMethodTemplateItem are kept for
# backward compatibility
Aurel's avatar
Aurel committed
84 85
catalog_method_list = ('_is_catalog_list_method_archive',
                       '_is_uncatalog_method_archive',
86 87
                       '_is_clear_method_archive',
                       '_is_filtered_archive',)
88

89 90 91
catalog_method_filter_list = ('_filter_expression_archive',
                              '_filter_expression_instance_archive',
                              '_filter_type_archive',)
92

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
def _getCatalog(acquisition_context):
  """
    Return the id of the SQLCatalog which correspond to the current BT.
  """
  catalog_method_id_list = acquisition_context.getTemplateCatalogMethodIdList()
  if len(catalog_method_id_list) == 0:
    return None
  catalog_method_id = catalog_method_id_list[0]
  return catalog_method_id.split('/')[0]

def _getCatalogValue(acquisition_context):
  """
    Returns the catalog object which correspond to the ZSQLMethods
    stored/to store in the business template.

    NB: acquisition_context must make possible to reach portal object
        and getTemplateCatalogMethodIdList.
  """
  catalog_id = _getCatalog(acquisition_context)
  if catalog_id is None:
    return None
  try:
    return acquisition_context.getPortalObject().portal_catalog[catalog_id]
  except KeyError:
    return None

119 120 121 122 123
def _recursiveRemoveUid(obj):
  """Recusivly set uid to None, to prevent (un)indexing.
  This is used to prevent unindexing real objects when we delete subobjects on
  a copy of this object.
  """
124 125
  if hasattr(aq_base(obj), 'uid'):
    obj.uid = None
126 127 128
  for subobj in obj.objectValues():
    _recursiveRemoveUid(subobj)

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
def removeAll(entry):
  '''
    Remove all files and directories under 'entry'.
    XXX: This is defined here, because os.removedirs() is buggy.
  '''
  try:
    if os.path.isdir(entry) and not os.path.islink(entry):
      pwd = os.getcwd()
      os.chmod(entry, 0755)
      os.chdir(entry)
      for e in os.listdir(os.curdir):
        removeAll(e)
      os.chdir(pwd)
      os.rmdir(entry)
    else:
      if not os.path.islink(entry):
        os.chmod(entry, 0644)
      os.remove(entry)
  except OSError:
    pass

Aurel's avatar
Aurel committed
150

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
def getChainByType(context):
  """
  This is used in order to construct the full list
  of mapping between type and list of workflow associated
  This is only useful in order to use
  portal_workflow.manage_changeWorkflows
  """
  pw = context.portal_workflow
  cbt = pw._chains_by_type
  ti = pw._listTypeInfo()
  types_info = []
  for t in ti:
    id = t.getId()
    title = t.Title()
    if title == id:
      title = None
    if cbt is not None and cbt.has_key(id):
      chain = ', '.join(cbt[id])
    else:
      chain = '(Default)'
    types_info.append({'id': id,
                      'title': title,
                      'chain': chain})
  new_dict = {}
  for item in types_info:
    new_dict['chain_%s' % item['id']] = item['chain']
  default_chain=', '.join(pw._default_chain)
  return (default_chain, new_dict)

180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
def fixZSQLMethod(portal, method):
  """Make sure the ZSQLMethod uses a valid connection.
  """
  if not isinstance(getattr(portal, method.connection_id, None),
                      RDBConnection):
    # if not valid, we assign to the first valid connection found
    sql_connection_list = portal.objectIds(
                          spec=('Z MySQL Database Connection',))
    if (method.connection_id not in sql_connection_list) and \
       (len(sql_connection_list) != 0):
      LOG('BusinessTemplate', WARNING,
          'connection_id for Z SQL Method %s is invalid, using %s' % (
                    method.getId(), sql_connection_list[0]))
      method.connection_id = sql_connection_list[0]

Aurel's avatar
Aurel committed
195 196 197
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
198
  """
Aurel's avatar
Aurel committed
199 200 201 202 203 204 205 206 207 208 209 210

  def __init__(self, creation=0, importing=0, file=None, path=None, **kw):
    if creation:
      self._initCreation(path=path, **kw)
    elif importing:
      self._initImport(file=file, path=path, **kw)

  def addFolder(self, **kw):
    pass

  def addObject(self, *kw):
    pass
211

Aurel's avatar
Aurel committed
212 213 214 215 216
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
217
    Class archiving business template into a folder tree
218
  """
Aurel's avatar
Aurel committed
219 220 221 222 223 224
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
225
      removeAll(self.path)
Aurel's avatar
Aurel committed
226 227 228
      os.makedirs(self.path)

  def addFolder(self, name=''):
229
     if name !='':
Aurel's avatar
Aurel committed
230
      path = os.path.join(self.path, name)
231
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
232 233 234
        os.makedirs(path)
      return path

235
  def addObject(self, obj, name, path=None, ext='.xml'):
236
    name = pathname2url(name)
Aurel's avatar
Aurel committed
237 238 239
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
240 241
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
242 243
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
244
    f.write(str(obj))
Aurel's avatar
Aurel committed
245 246 247
    f.close()

  def _initImport(self, file=None, path=None, **kw):
248 249 250
    # Normalize the paths to eliminate the effect of double-slashes.
    self.file_list = [os.path.normpath(f) for f in file]
    path = os.path.normpath(path)
251
    # to make id consistent, must remove a part of path while importing
252
    self.root_path_len = len(string.split(path, os.sep)) + 1
Aurel's avatar
Aurel committed
253

254
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
255 256 257 258
    """
      Import file from a local folder
    """
    class_name = klass.__class__.__name__
259
    for file_path in self.file_list:
260
      if class_name in file_path.split(os.sep):
261 262
        if os.path.isfile(file_path):
          file = open(file_path, 'r')
Aurel's avatar
Aurel committed
263
          # get object id
264 265
          folders = file_path.split(os.sep)
          file_name = string.join(folders[self.root_path_len:], os.sep)
266 267
          if '%' in file_name:
            file_name = url2pathname(file_name)
268
          klass._importFile(file_name, file)
Aurel's avatar
Aurel committed
269
          # close file
270
          file.close()
271

Aurel's avatar
Aurel committed
272 273 274 275 276 277
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
278
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
279 280 281 282 283
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
284
      removeAll(self.path)
Aurel's avatar
Aurel committed
285 286 287 288 289 290
      os.makedirs(self.path)
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)

  def addFolder(self, name=''):
Aurel's avatar
Aurel committed
291
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
292 293
      os.makedirs(name)

294
  def addObject(self, obj, name, path=None, ext='.xml'):
295
    name = pathname2url(name)
Aurel's avatar
Aurel committed
296 297 298
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
299 300
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
301 302
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
303
    f.write(str(obj))
Aurel's avatar
Aurel committed
304 305 306 307 308
    f.close()

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
309
    removeAll(self.path)
Aurel's avatar
Aurel committed
310 311 312 313 314
    return self.fobj

  def _initImport(self, file=None, **kw):
    self.f = file

315
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
316 317
    """
      Import all file from the archive to the site
318
    """
Aurel's avatar
Aurel committed
319 320 321 322 323 324
    class_name = klass.__class__.__name__
    self.f.seek(0)
    data = GzipFile(fileobj=self.f).read()
    io = StringIO(data)
    tar = tarfile.TarFile(fileobj=io)
    for info in tar.getmembers():
Yoshinori Okuji's avatar
Yoshinori Okuji committed
325 326
      if 'CVS' in info.name.split('/'):
        continue
Yoshinori Okuji's avatar
Yoshinori Okuji committed
327 328
      if '.svn' in info.name.split('/'):
        continue
329
      if class_name in info.name.split('/'):
Aurel's avatar
Aurel committed
330 331
        if info.isreg():
          file = tar.extractfile(info)
332 333 334
          tar_file_name = info.name.startswith('./') and info.name[2:] or \
              info.name
          folders = string.split(tar_file_name, os.sep)
335 336 337 338
          file_name = (os.sep).join(folders[2:])
          if '%' in file_name:
            file_name = url2pathname(file_name)
          klass._importFile(file_name, file)
Aurel's avatar
Aurel committed
339 340 341
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
342

343
class TemplateConditionError(Exception): pass
344
class TemplateConflictError(Exception): pass
345
class BusinessTemplateMissingDependency(Exception): pass
346

347
class BaseTemplateItem(Implicit, Persistent):
348
  """
349
    This class is the base class for all template items.
350
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
351

352
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
353
    self.__dict__.update(kw)
354
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
355
    self._objects = PersistentMapping()
356
    for id in id_list:
357 358
      if id is not None and id != '':
        self._archive[id] = None
359 360 361 362

  def build(self, context, **kw):
    pass

363
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
364 365
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
366
      new_keys = self._objects.keys()
367
      for path in new_keys:
368 369
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
370 371
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
372 373 374 375 376 377 378 379 380 381 382 383
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
384
    pass
385 386 387

  def uninstall(self, context, **kw):
    pass
388

389 390 391 392
  def remove(self, context, **kw):
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
393
    keys.reverse()
394 395 396 397 398 399 400 401 402 403 404
    # if you choose remove, the object and all its subobjects will be removed
    # even if you choose backup or keep for subobjects
    # it is same behaviour for backup_and_remove, all we be save
    for path in keys:
      if remove_dict.has_key(path):
        action = remove_dict[path]
        if action == 'save_and_remove':
          # like trash
          self.uninstall(context, trash=1, object_path=path, **kw)
        elif action == 'remove':
          self.uninstall(context, trash=0, object_path=path, **kw)
405

406

407 408 409 410
  def trash(self, context, new_item, **kw):
    # trash is quite similar to uninstall.
    return self.uninstall(context, new_item=new_item, trash=1, **kw)

Aurel's avatar
Aurel committed
411
  def export(self, context, bta, **kw):
412
    pass
Aurel's avatar
Aurel committed
413

414 415
  def getKeys(self):
    return self._objects.keys()
416

Aurel's avatar
Aurel committed
417
  def importFile(self, bta, **kw):
418
    bta.importFiles(klass=self)
419

420 421 422
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
423
    """
424 425
    if hasattr(aq_base(obj), '_dav_writelocks'):
      del aq_base(obj)._dav_writelocks
426 427 428 429 430 431 432
    if hasattr(obj, '__ac_local_roles__'):
      # remove local roles
      obj.__ac_local_roles__ = None
    if hasattr(obj, '_owner'):
      obj._owner = None
    if hasattr(aq_base(obj), 'uid'):
      obj.uid = None
433 434
    if hasattr(aq_base(obj), '_filepath'):
      obj._filepath = None
435
    if hasattr(aq_base(obj), 'workflow_history'):
436 437 438 439
      if hasattr(obj.__class__, 'workflow_history'):
        obj.workflow_history = None
      else:
        del obj.workflow_history
440 441 442
    if getattr(obj, 'meta_type', None) == 'Script (Python)':
      if hasattr(aq_base(obj), '_code'):
        obj._code = None
443 444
      if hasattr(aq_base(obj), 'Python_magic'):
        obj.Python_magic = None
445 446 447
    elif getattr(obj, 'meta_type', None) == 'ERP5 PDF Form' :
      if not obj.getProperty('business_template_include_content', 1) :
        obj.deletePdfContent()
448 449
    return obj

450 451 452
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
453
  """
454

455 456 457 458
  def __init__(self, id_list, tool_id=None, **kw):
    BaseTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
    if tool_id is not None:
      id_list = self._archive.keys()
459
      self._archive.clear()
460 461 462
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
463

464 465 466 467 468
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
469
      obj = self._objects[key]
470 471
      # create folder and subfolders
      folders, id = os.path.split(key)
Aurel's avatar
Aurel committed
472 473 474 475 476 477 478
      encode_folders = []
      for folder in folders.split('/'):
        if '%' not in folder:
          encode_folders.append(pathname2url(folder))
        else:
          encode_folders.append(folder)
      path = os.path.join(root_path, (os.sep).join(encode_folders))
479 480 481
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
482 483
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
484

Aurel's avatar
Aurel committed
485 486 487 488
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
489
      relative_url = '/'.join([url,id])
490 491
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
492
      obj = self.removeProperties(obj)
493
      id_list = obj.objectIds()
494
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
495
        # we must keep groups because it's ereased when we delete subobjects
496
        groups = deepcopy(obj.groups)
497
      if id_list:
Aurel's avatar
Aurel committed
498
        self.build_sub_objects(context, id_list, relative_url)
499
        for id_ in list(id_list):
500
          obj._delObject(id_)
501
      if hasattr(aq_base(obj), 'groups'):
502 503 504
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
505 506
    return sub_list

507 508 509 510
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
511 512 513 514
      try:
        obj = p.unrestrictedTraverse(relative_url)
      except ValueError:
        raise ValueError, "Can not access to %s" % relative_url
515 516 517 518
      try:
        obj = obj._getCopy(context)
      except AttributeError:
        raise AttributeError, "Could not find object '%s' during business template processing." % relative_url
519
      _recursiveRemoveUid(obj)
520
      obj = self.removeProperties(obj)
521
      id_list = obj.objectIds()
522
      if hasattr(aq_base(obj), 'groups'):
Christophe Dumez's avatar
Christophe Dumez committed
523
        # we must keep groups because it's erased when we delete subobjects
524
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
525 526
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
527
        for id_ in list(id_list):
528
          obj._delObject(id_)
529
      if hasattr(aq_base(obj), 'groups'):
530 531 532
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
533

534 535 536 537 538 539 540
  def _importFile(self, file_name, file):
    # import xml file
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
541 542
    __traceback_info__ = 'Importing %s' % file_name
    obj = connection.importFile(file, customImporters=customImporters)
543 544
    self._objects[file_name[:-4]] = obj

545
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
546 547
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
548 549 550 551 552 553 554
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
          new_object = self._objects[path]
          old_object = installed_bt._objects[path]
555 556
          new_object = self.removeProperties(new_object)
          old_object = self.removeProperties(old_object)
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
          new_io = StringIO()
          old_io = StringIO()
          OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, new_io)
          OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
          new_obj_xml = new_io.getvalue()
          old_obj_xml = old_io.getvalue()
          new_io.close()
          old_io.close()
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

576
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
577 578 579
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
580
    subobjects_dict = {}
581
    if trashbin is None: # must return subobjects
582 583 584 585 586 587
      object_path = container_path + [object_id]
      obj = self.unrestrictedTraverse(object_path)
      for subobject_id in list(obj.objectIds()):
        subobject_path = object_path + [subobject_id]
        subobject = self.unrestrictedTraverse(subobject_path)
        subobject_copy = subobject._p_jar.exportFile(subobject._p_oid)
588
        subobjects_dict[subobject_id] = subobject_copy
589
      return subobjects_dict
590 591
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
592
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, **kw)
593
    elif action == 'install':
594
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0, **kw)
595
    return subobjects_dict
596

597 598 599
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
600
    if context.getTemplateFormatVersion() == 1:
601
      groups = {}
602
      old_groups = {}
603 604 605 606 607
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
608 609 610 611 612 613
        if update_dict.has_key(path) or force:
          # get action for the oject
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
614
          action = 'backup'
615
          # get subobjects in path
616 617 618
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
619 620 621 622
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
623
            container_url = '/'.join(container_path)
624 625 626 627
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
628
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
629 630
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
631
              container_container = portal.unrestrictedTraverse(container_path[:-1])
632 633 634 635 636
              if container_container.meta_type == 'ERP5 Catalog':
                container_container.manage_addProduct['ZSQLCatalog'].manage_addSQLCatalog(id=container_path[-1], title='')
                if len(container_container.objectIds()) == 1:
                  container_container.default_sql_catalog_id = container_path[-1]
                container = portal.unrestrictedTraverse(container_path)
637 638
            else:
              raise
639 640 641
          container_ids = container.objectIds()
          subobjects_dict = {}
          # Object already exists
642
          if object_id in container_ids:
643
            old_obj = container._getOb(object_id)
644 645 646 647 648 649
            if hasattr(aq_base(old_obj), 'groups'):
              # we must keep original order groups
              # from old form in case we keep some
              # old widget, thus we can readd them in
              # the right order group
              old_groups[path] = deepcopy(old_obj.groups)
650
            subobjects_dict = self._backupObject(action, trashbin,
651
                                                 container_path, object_id)
652 653
            container.manage_delObjects([object_id])
          # install object
654
          obj = self._objects[path]
655 656 657
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
658
          if hasattr(aq_base(obj), 'groups'):
659
            # we must keep original order groups
660
            # because they change when we add subobjects
661
            groups[path] = deepcopy(obj.groups)
662
          # copy the object
663 664 665
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
666 667
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
668
          self.REQUEST.set('is_business_template_installation', 1)
669 670
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
671
          # if portal types upgrade, set backup properties
672 673
          if getattr(obj, 'meta_type', None) == 'ERP5 Type Information' and \
              len(subobjects_dict) > 0:
674
            setattr(obj, 'allowed_content_types',
675
                    subobjects_dict['allowed_content_type_list'] or [])
676
            setattr(obj, 'hidden_content_type_list',
677
                    subobjects_dict['hidden_content_type_list'] or [])
678
            setattr(obj, 'property_sheet_list',
679
                    subobjects_dict['property_sheet_list'] or [])
680
            setattr(obj, 'base_category_list',
681
                    subobjects_dict['base_category_list'] or [])
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
            setattr(obj, '_roles', subobjects_dict['roles_list'] or [])
            # set actions
            action_list = subobjects_dict['action_list']
            for action in action_list:
              obj.addAction(id = action.id
                            , name = action.title
                            , action = action.action.text
                            , condition = action.getCondition()
                            , permission = action.permissions
                            , category = action.category
                            , visible = action.visible
                            , icon = getattr(action, 'icon', None) and action.icon.text or ''
                            , priority = action.priority
                            )
            # set workflow chain
            wf_chain = subobjects_dict['workflow_chain']
            chain_dict = getChainByType(context)[1]
            default_chain = ''
700
            chain_dict['chain_%s' % (object_id)] = wf_chain
701
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
702
          # import sub objects if there is
703
          elif len(subobjects_dict) > 0:
704
            # get a jar
705 706
            connection = obj._p_jar
            o = obj
707
            while connection is None:
708 709
              o = o.aq_parent
              connection = o._p_jar
710 711 712 713 714
            # import subobjects
            for subobject_id in subobjects_dict.keys():
              subobject_data = subobjects_dict[subobject_id]
              subobject_data.seek(0)
              subobject = connection.importFile(subobject_data)
715
              if subobject_id not in obj.objectIds():
716
                obj._setObject(subobject_id, subobject)
717
          if obj.meta_type in ('Z SQL Method',):
718
            fixZSQLMethod(portal, obj)
719
      # now put original order group
720 721
      # we remove object not added in forms
      # we put old objects we have kept
722
      for path in groups.keys():
723
        new_groups_dict = groups[path]
724 725 726 727 728 729 730 731 732
        if not old_groups.has_key(path):
          # installation of a new form
          obj = portal.unrestrictedTraverse(path)
          obj.groups = new_groups_dict
        else:
          # upgrade of a form
          old_groups_dict = old_groups[path]
          obj = portal.unrestrictedTraverse(path)
          # first check that all widgets are in new order
733
          # excetp the one that had to be removed
734 735 736 737
          widget_id_list = obj.objectIds()
          for widget_id in widget_id_list:
            widget_path = path+'/'+widget_id
            if update_dict.has_key(widget_path) and update_dict[widget_path] in ('remove', 'save_and_remove'):
738 739
              continue
            widget_in_form = 0
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
            for group_id in new_groups_dict.keys():
              group_values = new_groups_dict[group_id]
              if widget_id in group_values:
                widget_in_form = 1
                break
            # if not, add it in the same groups
            # defined on the former form
            previous_group_id = None
            if not widget_in_form:
              for old_group_id in old_groups_dict.keys():
                old_group_values = old_groups_dict[old_group_id]
                if widget_id in old_group_values:
                  previous_group_id = old_group_id
              # if we find same group in new one, add widget to it
              if previous_group_id is not None and new_groups_dict.has_key(previous_group_id):
                new_groups_dict[previous_group_id].append(widget_id)
              # otherwise use a specific group
              else:
                if new_groups_dict.has_key('not_assigned'):
                  new_groups_dict['not_assigned'].append(widget_id)
                else:
                  new_groups_dict['not_assigned'] = [widget_id,]
762
                  obj.group_list = list(obj.group_list) + ['not_assigned']
763 764 765 766 767 768 769 770
          # second check all widget_id in order are in form
          for group_id in new_groups_dict.keys():
            for widget_id in new_groups_dict[group_id]:
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
                new_groups_dict[group_id].remove(widget_id)
          # now set new group object
771
          obj.groups = new_groups_dict
Aurel's avatar
Aurel committed
772
    else:
773 774
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
775
      portal = context.getPortalObject()
776
      for relative_url in self._archive.keys():
777
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
778 779 780 781
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
782
        if object_id in container_ids:    # Object already exists
783
          self._backupObject('backup', trashbin, container_path, object_id)
784
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
785
        # Set a hard link
786 787 788 789 790 791
        obj = obj._getCopy(container)
        container._setObject(object_id, obj)
        obj = container._getOb(object_id)
        obj.manage_afterClone(obj)
        obj.wl_clearLocks()
        if obj.meta_type in ('Z SQL Method',):
792
          fixZSQLMethod(portal, obj)
793 794 795

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
796
    trash = kw.get('trash', 0)
797 798 799 800 801
    trashbin = kw.get('trashbin', None)
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
Aurel's avatar
Aurel committed
802
      object_keys = self._archive.keys()
803
    for relative_url in object_keys:
804 805
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
806
      try:
807
        container = portal.unrestrictedTraverse(container_path)
808
        if trash and trashbin is not None:
809 810
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
        container.manage_delObjects([object_id])
811 812
        if container.aq_parent.meta_type == 'ERP5 Catalog' and len(container.objectIds()) == 0:
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
813
          container.getParentValue().manage_delObjects([container.id])
814
      except (NotFound, KeyError, BadRequest):
815
        # object is already backup and/or removed
816
        pass
817 818
    BaseTemplateItem.uninstall(self, context, **kw)

819 820 821 822 823 824 825 826 827 828 829 830
class PathTemplateItem(ObjectTemplateItem):
  """
    This class is used to store objects with wildcards supported.
  """
  def __init__(self, id_list, tool_id=None, **kw):
    BaseTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
    id_list = self._archive.keys()
    self._archive.clear()
    self._path_archive = PersistentMapping()
    for id in id_list:
      self._path_archive[id] = None

831 832 833 834 835 836 837 838 839
  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
    trash = kw.get('trash', 0)
    trashbin = kw.get('trashbin', None)
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._path_archive.keys()
840 841
    object_keys.sort()
    object_keys.reverse()
842 843
    p = context.getPortalObject()
    for path in object_keys:
844 845 846 847 848
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
849 850 851
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
852
        try:
Aurel's avatar
Aurel committed
853 854
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
855 856
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
857 858
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
859
                                           keep_subobjects=1)
860 861 862 863 864 865
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

866 867 868
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
869

870 871 872 873 874 875 876 877 878
      The folder is the current object which contains sub-objects.
      The list of ids are path components. If the list is empty,
      the current folder is valid.
    """
    if len(id_list) == 0:
      return ['/'.join(relative_url_list)]
    id = id_list[0]
    if re.search('[\*\?\[\]]', id) is None:
      # If the id has no meta character, do not have to check all objects.
879 880 881
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
882
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
883 884
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
885
      if object_id != "":
886
        path_list.extend(self._resolvePath(
887
            folder._getOb(object_id),
888
            relative_url_list + [object_id], id_list[1:]))
889
    return path_list
Aurel's avatar
Aurel committed
890

891 892 893
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
894
    keys = self._path_archive.keys()
895
    keys.sort()
Aurel's avatar
Aurel committed
896
    for path in keys:
897 898 899
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
900
      for relative_url in self._resolvePath(p, [], path.split('/')):
901 902
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
903
        obj = obj.__of__(context)
904
        _recursiveRemoveUid(obj)
905
        id_list = obj.objectIds()
906
        obj = self.removeProperties(obj)
907
        if hasattr(aq_base(obj), 'groups'):
908
          # we must keep groups because it's ereased when we delete subobjects
909
          groups = deepcopy(obj.groups)
910
        if len(id_list) > 0:
911 912
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
913
          for id_ in list(id_list):
914
            obj._delObject(id_)
915
        if hasattr(aq_base(obj), 'groups'):
916 917 918
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
919

920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
class PreferenceTemplateItem(PathTemplateItem):
  """
  This class is used to store preference objects
  """
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
    This method calls itself recursively.

    The folder is the current object which contains sub-objects.
    The list of ids are path components. If the list is empty,
    the current folder is valid.
    """
    if relative_url_list != []:
      LOG("PreferenceTemplateItem, _resolvePath", WARNING,
          "Should be empty")
935
    if len(id_list) != 1:
936 937 938 939 940 941 942 943 944 945 946 947
      LOG("PreferenceTemplateItem, _resolvePath", WARNING,
          "Should contain only one element")
    # XXX hardcoded
    return ['portal_preferences/%s' % id_list[0]]

  def install(self, context, trashbin, **kw):
    """
    Enable Preference
    """
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    for object_path in self._objects.keys():
948
      pref = portal.unrestrictedTraverse(object_path)
949
      # XXX getPreferenceState is a bad name
950 951 952
      if pref.getPreferenceState() == 'disabled':
        portal.portal_workflow.doActionFor(
                      pref,
953 954 955 956 957
                      'enable_action',
                      wf_id='preference_workflow',
                      comment="Initialized during Business Template " \
                              "installation.")

958 959
class CategoryTemplateItem(ObjectTemplateItem):

960 961
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
962

963 964 965 966
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
967 968
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
969
      obj = self.removeProperties(obj)
970
      id_list = obj.objectIds()
971
      if id_list:
972
        self.build_sub_objects(context, id_list, relative_url)
973
        for id_ in list(id_list):
974
          obj._delObject(id_)
975 976
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
977 978 979 980 981

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
982 983
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
984
      _recursiveRemoveUid(obj)
985
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
986
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
987
      id_list = obj.objectIds()
988 989
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
990
        for id_ in list(id_list):
991
          obj._delObject(id_)
992
      else:
993
        for id_ in list(id_list):
994
          obj._delObject(id_)
995 996
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
997

998
  def install(self, context, trashbin, **kw):
999 1000
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1001
    if context.getTemplateFormatVersion() == 1:
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          else:
            action = 'backup'
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
          obj = self._objects[path]
          obj = obj.__of__(category_tool)
          container_path = path.split('/')[:-1]
          category_id = path.split('/')[-1]
          try:
            container = category_tool.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
            container_url = '/'.join(container_path)
            if update_dict.has_key(container_url):
              if update_dict[container_url] == 'nothing':
1027
                continue
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
            raise
          container_ids = container.objectIds()
          # Object already exists
          object_uid = None
          subobjects_dict = {}
          if category_id in container_ids:
            object_uid = container[category_id].getUid()
            subobjects_dict = self._backupObject(action, trashbin, container_path, category_id)
            container.manage_delObjects([category_id])
          category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
          if object_uid is not None:
            category.setUid(object_uid)
1040 1041 1042 1043
          for prop in obj.propertyIds():
            if prop not in ('id', 'uid'):
              try:
                prop_value = obj.getProperty(prop, evaluate=0)
1044
              except TypeError: # the getter doesn't support evaluate=
1045 1046
                prop_value = obj.getProperty(prop)
              category.setProperty(prop, prop_value)
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
          # import sub objects if there is
          if len(subobjects_dict) > 0:
            # get a jar
            connection = obj._p_jar
            o = category
            while connection is None:
              o = o.aq_parent
              connection = o._p_jar
            # import subobjects
            for subobject_id in subobjects_dict.keys():
              subobject_data = subobjects_dict[subobject_id]
              subobject_data.seek(0)
              subobject = connection.importFile(subobject_data)
              if subobject_id not in category.objectIds():
                category._setObject(subobject_id, subobject)
1062
    else:
1063
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1064 1065 1066
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
      for relative_url in self._archive.keys():
        obj = self._archive[relative_url]
        # Wrap the object by an aquisition wrapper for _aq_dynamic.
        obj = obj.__of__(category_tool)
        container_path = relative_url.split('/')[0:-1]
        category_id = relative_url.split('/')[-1]
        container = category_tool.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
        if category_id in container_ids:    # Object already exists
          # XXX call backup here
          subobjects_dict = self._backupObject('backup', trashbin, container_path, category_id)
          container.manage_delObjects([category_id])
        category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
        for prop in obj.propertyIds():
          if prop not in ('id', 'uid'):
            try:
              prop_value = obj.getProperty(prop, evaluate=0)
            except TypeError: # the getter doesn't support evaluate=
              prop_value = obj.getProperty(prop)
            category.setProperty(prop, prop_value)
        # import sub objects if there is
        if len(subobjects_dict) > 0:
          # get a jar
          connection = obj._p_jar
          o = category
          while connection is None:
            o = o.aq_parent
            connection = o._p_jar
          # import subobjects
          for subobject_id in subobjects_dict.keys():
            subobject_data = subobjects_dict[subobject_id]
            subobject_data.seek(0)
            subobject = connection.importFile(subobject_data)
            if subobject_id not in category.objectIds():
              category._setObject(subobject_id, subobject)
1102

1103

1104 1105
class SkinTemplateItem(ObjectTemplateItem):

1106 1107
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1108

1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_bt, **kw)
    # We must install/update an ERP5 Form if one of its widget is modified.
    # This allow to keep the widget order and the form layout after an update
    #   from a BT to another one.
    for (bt_obj_path, bt_obj) in self._objects.items():
      if getattr(bt_obj, 'meta_type', None) == 'ERP5 Form':
        # search sub-objects of ERP5 Forms that are marked as "modified"
        for upd_obj_path in modified_object_list.keys():
          if upd_obj_path.startswith(bt_obj_path):
            # a child of the ERP5 Form must be updated, so the form too
            if not modified_object_list.has_key(bt_obj_path):
              modified_object_list.update({bt_obj_path: ['Modified', self.__class__.__name__[:-12]]})
    return modified_object_list

1124
  def install(self, context, trashbin, **kw):
1125
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1126 1127
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1128 1129 1130
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1131
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1132 1133
        fixZSQLMethod(p, obj)

1134 1135 1136 1137 1138 1139
    # Add new folders into skin paths.
    ps = p.portal_skins
    for skin_name, selection in ps.getSkinPaths():
      new_selection = []
      selection = selection.split(',')
      for relative_url in self._archive.keys():
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1140
        if context.getTemplateFormatVersion() == 1:
1141 1142
          if update_dict.has_key(relative_url) or force:
            if not force:
1143
              if update_dict[relative_url] == 'nothing':
1144
                continue
1145
          obj = self._objects[relative_url]
1146
        else:
1147
          obj = self._archive[relative_url]
1148
        skin_id = relative_url.split('/')[-1]
1149
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
        if selection_list is None or skin_name in selection_list:
          if skin_id not in selection:
            new_selection.append(skin_id)
      new_selection.extend(selection)
      # sort the layer according to skin priorities
      new_selection.sort(lambda a, b : cmp(
        b in ps.objectIds() and ps[b].getProperty(
            'business_template_skin_layer_priority', 0) or 0,
        a in ps.objectIds() and ps[a].getProperty(
            'business_template_skin_layer_priority', 0) or 0))
      ps.manage_skinLayers(skinpath = tuple(new_selection), skinname = skin_name, add_skin = 1)
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
    p.changeSkin(None)
1163 1164 1165

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
1166 1167 1168 1169
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1170
      object_keys = self._archive.keys()
1171
    ps = context.portal_skins
1172
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
1173 1174 1175 1176 1177 1178 1179
    for skin_name, selection in ps.getSkinPaths():
      new_selection = []
      selection = selection.split(',')
      for skin_id in selection:
        if skin_id not in skin_id_list:
          new_selection.append(skin_id)
      ps.manage_skinLayers(skinpath = tuple(new_selection), skinname = skin_name, add_skin = 1)
1180
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
1181
    context.getPortalObject().changeSkin(None)
1182 1183 1184
    ObjectTemplateItem.uninstall(self, context, **kw)


1185
class WorkflowTemplateItem(ObjectTemplateItem):
1186

1187 1188
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1189

1190
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1191 1192
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1193 1194 1195
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
1196
        if installed_bt._objects.has_key(path):
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
          # compare object to see it there is changes
          new_object = self._objects[path]
          old_object = installed_bt._objects[path]
          new_io = StringIO()
          old_io = StringIO()
          OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, new_io)
          OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
          new_obj_xml = new_io.getvalue()
          old_obj_xml = old_io.getvalue()
          new_io.close()
          old_io.close()
          if new_obj_xml != old_obj_xml:
            wf_id = path.split('/')[:2]
            modified_object_list.update({'/'.join(wf_id) : ['Modified', 'Workflow']})
        else: # new object
          modified_object_list.update({path : ['New', 'Workflow']})
1213 1214 1215 1216 1217 1218 1219 1220
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1221
    if context.getTemplateFormatVersion() == 1:
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
      for path in keys:
        wf_path = '/'.join(path.split('/')[:2])
        if wf_path in update_dict or force:
          if not force:
            action = update_dict[wf_path]
            if action == 'nothing':
              continue
          else:
1236
            action = 'backup'
1237 1238 1239 1240 1241 1242
          container_path = path.split('/')[:-1]
          object_id = path.split('/')[-1]
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1243
            container_url = '/'.join(container_path)
1244 1245 1246 1247 1248 1249
            if update_dict.has_key(container_url):
              if update_dict[container_url] == 'nothing':
                continue
            raise
          container_ids = container.objectIds()
          if object_id in container_ids:    # Object already exists
1250
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1251
            container.manage_delObjects([object_id])
1252
          obj = self._objects[path]
1253 1254 1255
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1256 1257 1258 1259 1260
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1261 1262 1263 1264
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1265 1266
class PortalTypeTemplateItem(ObjectTemplateItem):

1267 1268
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1269 1270
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1271 1272 1273
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1274 1275
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1276 1277
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1278 1279 1280
      # remove actions and properties
      action_len = len(obj.listActions())
      obj.deleteActions(selections=range(action_len))
1281
      obj = self.removeProperties(obj)
1282 1283 1284 1285 1286 1287 1288 1289 1290
      # remove some properties
      if hasattr(obj, 'allowed_content_types'):
        setattr(obj, 'allowed_content_types', ())
      if hasattr(obj, 'hidden_content_type_list'):
        setattr(obj, 'hidden_content_type_list', ())
      if hasattr(obj, 'property_sheet_list'):
        setattr(obj, 'property_sheet_list', ())
      if hasattr(obj, 'base_category_list'):
        setattr(obj, 'base_category_list', ())
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1291 1292
      if hasattr(obj, '_roles'):
        setattr(obj, '_roles', [])
1293 1294
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1295

1296 1297
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1298 1299 1300 1301
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1302 1303
    # We now need to setup the list of workflows corresponding to
    # each portal type
1304
    (default_chain, chain_dict) = getChainByType(context)
1305
    # Set the default chain to the empty string is probably the
1306
    # best solution, by default it is 'default_workflow', which is
1307
    # not very usefull
1308
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1309
    if context.getTemplateFormatVersion() == 1:
1310
      object_list = self._objects
1311
    else:
1312 1313
      object_list = self._archive
    for path in object_list.keys():
1314 1315 1316 1317
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1318
            continue
1319 1320
        obj = object_list[path]
        portal_type = obj.id
1321 1322 1323
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1324 1325
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1326

1327 1328
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1329 1330 1331 1332 1333 1334 1335
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
      dict = {}
      xml = parse(file)
      chain_list = xml.getElementsByTagName('chain')
      for chain in chain_list:
1336
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1337 1338 1339 1340 1341
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1342
        dict[str(ptype)] = str(workflow)
1343 1344 1345 1346
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1347
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1348 1349

  def build(self, context, **kw):
1350 1351 1352 1353 1354
    # we can either specify nothing, +, - or = before the chain
    # this is used to know how to manage the chain
    # if nothing or +, chain is added to the existing one
    # if - chain is removed from the exisiting one
    # if = chain replaced the existing one
1355
    p = context.getPortalObject()
1356
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1357
    for key in self._archive.keys():
1358 1359 1360
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1361
        workflow = wflist[1]
1362
      else:
1363
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1364
        portal_type = wflist[0][:-2]
1365 1366
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1367 1368 1369 1370
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
1371
        if workflow[0] != '-' and \
1372
            workflow_name not in chain_dict['chain_%s' % portal_type]:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1373
          raise NotFound, 'workflow %s not found in chain for portal_type %s'\
1374
                % (workflow, portal_type)
1375
        if self._objects.has_key(portal_type):
1376 1377
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1378
        else:
1379
          self._objects[portal_type] = [workflow,]
1380
      else:
1381 1382
        raise NotFound, 'portal type %s not found in workflow chain'\
                                                    % portal_type
1383

Christophe Dumez's avatar
Christophe Dumez committed
1384
  # Function to generate XML Code Manually
1385 1386 1387 1388 1389
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1390
      workflow_list = self._objects[key]
1391 1392 1393
      # XXX Not always a list
      if isinstance(workflow_list, str):
        workflow_list = [workflow_list]
1394 1395
      xml_data += os.linesep+' <chain>'
      xml_data += os.linesep+'  <type>%s</type>' %(key,)
1396
      xml_data += os.linesep+'  <workflow>%s</workflow>' %(', '.join(workflow_list))
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414
      xml_data += os.linesep+' </chain>'
    xml_data += os.linesep+'</workflow_chain>'
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
    xml_data = self.generateXml()
    bta.addObject(obj=xml_data, name='workflow_chain_type',  path=root_path)

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # We now need to setup the list of workflows corresponding to
    # each portal type
1415
    (default_chain, chain_dict) = getChainByType(context)
1416
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1417
    # best solution, by default it is 'default_workflow', which is
1418 1419 1420 1421 1422 1423 1424
    # not very usefull
    default_chain = ''
    for path in self._objects.keys():
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1425
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1426 1427 1428 1429
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
        if len(path_splitted) < 2:
          continue
1430
        portal_type = path_splitted[1]
1431
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1432 1433 1434
          old_chain_dict = chain_dict['chain_%s' % portal_type]
          # XXX we don't use the chain (Default) in erp5 so don't keep it
          if old_chain_dict != '(Default)' and old_chain_dict != '':
1435
            old_chain_workflow_id_set = {}
1436
            # get existent workflow id list
1437 1438
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1439
            # get new workflow id list
1440
            for wf_id in self._objects[path].split(', '):
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454
              if wf_id[0] == '-':
                # remove wf id if already present
                if old_chain_workflow_id_set.has_key(wf_id[1:]):
                  old_chain_workflow_id_set.pop(wf_id[1:])
              elif wf_id[0] == '=':
                # replace existing chain by this one
                old_chain_workflow_id_set = {}
                old_chain_workflow_id_set[wf_id[1:]] = 1
              # then either '+' or nothing, add wf id to the list
              elif wf_id[0] == '+':
                old_chain_workflow_id_set[wf_id[1:]] = 1
              else:
                old_chain_workflow_id_set[wf_id] = 1
            # create the new chain
1455 1456
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1457
          else:
1458
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1459 1460
        else:
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1461 1462
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1463

1464 1465
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1466 1467 1468 1469 1470 1471
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._objects.keys()
    for path in object_keys:
1472 1473 1474 1475 1476 1477 1478 1479
      path_splitted = path.split('/', 1)
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
      id = 'chain_%s' % portal_type
      if id in chain_dict.keys():
        del chain_dict[id]
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492

  def _importFile(self, file_name, file):
    # import workflow chain for portal_type
    dict = {}
    xml = parse(file)
    chain_list = xml.getElementsByTagName('chain')
    for chain in chain_list:
      ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
      workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
      if len(workflow_list) == 0:
        workflow = ''
      else:
        workflow = workflow_list[0].data
1493 1494
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1495 1496 1497
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1498 1499
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1500

1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):

  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'

  def build(self, context, **kw):
    for key in self._archive.keys():
      portal_type, allowed_type = key.split(' | ')
      if self._objects.has_key(portal_type):
        allowed_list = self._objects[portal_type]
        allowed_list.append(allowed_type)
        self._objects[portal_type] = allowed_list
      else:
        self._objects[portal_type] = [allowed_type]

Christophe Dumez's avatar
Christophe Dumez committed
1516
  # Function to generate XML Code Manually
1517
  def generateXml(self, path=None):
1518
    dictio = self._objects
1519
    xml_data = '<%s>' %(self.xml_tag,)
1520
    keys = dictio.keys()
1521 1522
    keys.sort()
    for key in keys:
1523
      allowed_list = dictio[key]
1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
      xml_data += os.linesep+' <portal_type id="%s">' %(key,)
      for allowed_item in allowed_list:
        xml_data += os.linesep+'  <item>%s</item>' %(allowed_item,)
      xml_data += os.linesep+' </portal_type>'
    xml_data += os.linesep+'</%s>' %(self.xml_tag,)
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    path = self.__class__.__name__+os.sep+self.class_property
    xml_data = self.generateXml(path=None)
    bta.addObject(obj=xml_data, name=path, path=None)

1540 1541 1542 1543 1544 1545
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      if installed_bt.id == 'installed_bt_for_diff':
1546
        #must rename keys in dict if reinstall
1547 1548 1549 1550 1551 1552 1553 1554 1555
        new_dict = PersistentMapping()
        for key in installed_bt._objects.keys():
          new_key = self.class_property+'/'+key
          new_dict[new_key] = installed_bt._objects[key]
        installed_bt._objects = new_dict
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
          new_object = self._objects[path]
1556
          old_object = installed_bt._objects[path]
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
  def _importFile(self, file_name, file):
    path, name = os.path.split(file_name)
    id = string.split(name, '.')[0]
    xml = parse(file)
    portal_type_list = xml.getElementsByTagName('portal_type')
    for portal_type in portal_type_list:
      id = portal_type.getAttribute('id')
      item_type_list = []
      item_list = portal_type.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      self._objects[self.class_property+'/'+id] = item_type_list

  def install(self, context, trashbin, **kw):
    p = context.getPortalObject()
    pt = p.unrestrictedTraverse('portal_types')
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    for key in self._objects.keys():
      if update_dict.has_key(key) or force:
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
        try:
          portal_id = key.split('/')[-1]
          portal_type = pt._getOb(portal_id)
1595
        except AttributeError:
1596 1597 1598 1599 1600 1601 1602 1603
          LOG("portal types not found : ", 100, portal_id)
          continue
        property_list = self._objects[key]
        object_property_list = getattr(portal_type, self.class_property, ())
        if len(object_property_list) > 0:
          # merge differences between portal types properties
          # only add new, do not remove
          for id in object_property_list:
1604 1605
            if id not in property_list:
              property_list.append(id)
1606 1607
        setattr(portal_type, self.class_property, list(property_list))

Aurel's avatar
Aurel committed
1608
  def uninstall(self, context, **kw):
1609
    object_path = kw.get('object_path', None)
1610
    p = context.getPortalObject()
1611
    pt = p.unrestrictedTraverse('portal_types')
1612 1613 1614 1615 1616 1617 1618 1619
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._objects.keys()
    for key in object_keys:
      try:
        portal_id = key.split('/')[-1]
        portal_type = pt._getOb(portal_id)
1620
      except AttributeError:
1621 1622 1623
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
1624 1625
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
1626 1627
      for id in property_list:
        if id in original_property_list:
1628
          original_property_list.remove(id)
1629
      setattr(portal_type, self.class_property, list(original_property_list))
1630

1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'

class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'

class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

  xml_tag = 'base_category_list'
  class_property = 'base_category_list'

1646
class CatalogMethodTemplateItem(ObjectTemplateItem):
1647
  """Template Item for catalog methods.
1648

1649 1650 1651 1652 1653
    This template item stores catalog method and install them in the
    default catalog.
    The use Catalog makes for methods is saved as well and recreated on
    installation.
  """
1654

1655 1656
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1657
    # a mapping to store properties of methods.
1658 1659 1660 1661 1662
    # the mapping contains an entry for each method, and this entry is
    # another mapping having the id of the catalog property as key and a
    # boolean value to say wether the method is part of this catalog
    # configuration property.
    self._method_properties = PersistentMapping()
1663

1664 1665 1666 1667 1668
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682
  def _extractMethodProperties(self, catalog, method_id):
    """Extracts properties for a given method in the catalog.
    Returns a mapping of property name -> boolean """
    method_properties = PersistentMapping()
    for prop in catalog._properties:
      if prop.get('select_variable') == 'getCatalogMethodIds':
        if prop['type'] == 'selection' and \
            getattr(catalog, prop['id']) == method_id:
          method_properties[prop['id']] = 1
        elif prop['type'] == 'multiple selection' and \
            method_id in getattr(catalog, prop['id']):
          method_properties[prop['id']] = 1
    return method_properties

1683 1684
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1685

1686
    catalog = _getCatalogValue(self)
1687
    if catalog is None:
1688
      LOG('BusinessTemplate build', 0, 'catalog not found')
1689
      return
1690

1691 1692 1693
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
1694

1695 1696
    for obj in self._objects.values():
      method_id = obj.id
1697 1698
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
1699
      self._is_filtered_archive[method_id] = 0
1700
      if catalog.filter_dict.has_key(method_id):
1701 1702 1703 1704 1705 1706 1707 1708 1709
        if catalog.filter_dict[method_id]['filtered']:
          self._is_filtered_archive[method_id] = \
                      catalog.filter_dict[method_id]['filtered']
          self._filter_expression_archive[method_id] = \
                      catalog.filter_dict[method_id]['expression']
          self._filter_expression_instance_archive[method_id] = \
                      catalog.filter_dict[method_id]['expression_instance']
          self._filter_type_archive[method_id] = \
                      catalog.filter_dict[method_id]['type']
1710

Aurel's avatar
Aurel committed
1711
  def export(self, context, bta, **kw):
1712
    catalog = _getCatalogValue(self)
1713 1714 1715 1716
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

Aurel's avatar
Aurel committed
1717 1718 1719 1720
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
1721
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1722 1723 1724 1725 1726 1727
      # create folder and subfolders
      folders, id = os.path.split(key)
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
1728 1729
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1730
      # add all datas specific to catalog inside one file
1731
      method_id = obj.id
1732 1733
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1734
      f = open(object_path, 'wt')
1735
      xml_data = '<catalog_method>'
1736

1737 1738 1739
      for method_property, value in self._method_properties[method_id].items():
        xml_data += os.linesep+' <item key="%s" type="int">' %(method_property,)
        xml_data += os.linesep+'  <value>%s</value>' %(value,)
1740
        xml_data += os.linesep+' </item>'
1741

Aurel's avatar
Aurel committed
1742
      if catalog.filter_dict.has_key(method_id):
1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758
        if catalog.filter_dict[method_id]['filtered']:
          xml_data += os.linesep+' <item key="_is_filtered_archive" type="int">'
          xml_data += os.linesep+'  <value>1</value>'
          xml_data += os.linesep+' </item>'
          for method in catalog_method_filter_list:
            value = getattr(self, method, '')[method_id]
            if method != '_filter_expression_instance_archive':
              if type(value) in (type(''), type(u'')):
                xml_data += os.linesep+' <item key="%s" type="str">' %(method,)
                xml_data += os.linesep+'  <value>%s</value>' %(str(value))
                xml_data += os.linesep+' </item>'
              elif type(value) in (type(()), type([])):
                xml_data += os.linesep+' <item key="%s" type="tuple">'%(method)
                for item in value:
                  xml_data += os.linesep+'  <value>%s</value>' %(str(item))
                xml_data += os.linesep+' </item>'
1759
      xml_data += os.linesep+'</catalog_method>'
1760
      f.write(xml_data)
Aurel's avatar
Aurel committed
1761
      f.close()
1762

Christophe Dumez's avatar
Christophe Dumez committed
1763 1764 1765 1766 1767 1768 1769 1770 1771
  # Function to generate XML Code Manually
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data
1772

1773 1774
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1775
    catalog = _getCatalogValue(self)
1776 1777 1778 1779 1780 1781 1782
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    # Make copies of attributes of the default catalog of portal_catalog.
    sql_catalog_object_list = list(catalog.sql_catalog_object_list)
    sql_uncatalog_object = list(catalog.sql_uncatalog_object)
    sql_clear_catalog = list(catalog.sql_clear_catalog)
1783

1784 1785 1786
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1787
    new_bt_format = context.getTemplateFormatVersion()
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803

    if force: # get all objects
      if new_bt_format:
        values = self._objects.values()
      else:
        values = self._archive.values()
    else: # get only selected object
      if new_bt_format == 1:
        keys = self._objects.keys()
      else:
        keys = self._archive.keys()
      for key in keys:
        if update_dict.has_key(key) or force:
          if not force:
            action = update_dict[key]
            if action == 'nothing':
1804
              continue
1805 1806 1807 1808
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
1809

1810 1811
    for obj in values:
      method_id = obj.id
1812

1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823
      # Restore catalog properties for methods
      if hasattr(self, '_method_properties'):
        for key in self._method_properties.get(method_id, {}).keys():
          old_value = getattr(catalog, key, None)
          if isinstance(old_value, str):
            setattr(catalog, key, method_id)
          elif isinstance(old_value, list) or isinstance(old_value, tuple):
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
1824

1825 1826
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
1827
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1828
        if context.getTemplateFormatVersion() == 1:
1829 1830 1831
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1832
        filter_type = self._filter_type_archive[method_id]
1833 1834 1835
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1836
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1837
        catalog.filter_dict[method_id]['type'] = filter_type
1838
      elif method_id in catalog.filter_dict.keys():
1839
        catalog.filter_dict[method_id]['filtered'] = 0
1840

1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866
      # backward compatibility
      if hasattr(self, '_is_catalog_list_method_archive'):
        LOG("BusinessTemplate.CatalogMethodTemplateItem", 0,
            "installing old style catalog method configuration")
        is_catalog_list_method = int(
                  self._is_catalog_list_method_archive[method_id])
        is_uncatalog_method = int(
                  self._is_uncatalog_method_archive[method_id])
        is_clear_method = int(
                  self._is_clear_method_archive[method_id])

        if is_catalog_list_method and method_id not in sql_catalog_object_list:
          sql_catalog_object_list.append(method_id)
        elif not is_catalog_list_method and\
                        method_id in sql_catalog_object_list:
          sql_catalog_object_list.remove(method_id)

        if is_uncatalog_method and method_id not in sql_uncatalog_object:
          sql_uncatalog_object.append(method_id)
        elif not is_uncatalog_method and method_id in sql_uncatalog_object:
          sql_uncatalog_object.remove(method_id)

        if is_clear_method and method_id not in sql_clear_catalog:
          sql_clear_catalog.append(method_id)
        elif not is_clear_method and method_id in sql_clear_catalog:
          sql_clear_catalog.remove(method_id)
1867

1868 1869 1870 1871 1872 1873
        sql_catalog_object_list.sort()
        catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
        sql_uncatalog_object.sort()
        catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
        sql_clear_catalog.sort()
        catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1874

1875
  def uninstall(self, context, **kw):
1876
    catalog = _getCatalogValue(self)
1877 1878 1879
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1880

1881 1882 1883 1884
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
1885 1886 1887 1888
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
1889
    else:
1890 1891 1892 1893
      try:
        value = self._archive[object_path]
      except KeyError:
        value = None
1894 1895
      if value is not None:
        values.append(value)
1896
    for obj in values:
1897
      method_id = obj.id
1898 1899 1900 1901 1902 1903 1904 1905 1906
      # remove method references in portal_catalog
      for catalog_prop in catalog._properties:
        if catalog_prop.get('select_variable') == 'getCatalogMethodIds'\
            and catalog_prop['type'] == 'multiple selection':
          old_value = getattr(catalog, catalog_prop['id'], ())
          if method_id in old_value:
            new_value = list(old_value)
            new_value.remove(method_id)
            setattr(catalog, catalog_prop['id'], new_value)
1907

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1908
      if catalog.filter_dict.has_key(method_id):
1909
        del catalog.filter_dict[method_id]
1910

1911
    # uninstall objects
1912
    ObjectTemplateItem.uninstall(self, context, **kw)
1913

1914
  def _importFile(self, file_name, file):
1915
    if not '.catalog_keys' in file_name:
1916 1917 1918 1919 1920 1921 1922 1923
      # just import xml object
      obj = self
      connection = None
      while connection is None:
        obj=obj.aq_parent
        connection=obj._p_jar
      obj = connection.importFile(file, customImporters=customImporters)
      self._objects[file_name[:-4]] = obj
1924
    else:
1925 1926 1927 1928
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1929
      method_list = xml.getElementsByTagName('item')
1930
      for method in method_list:
1931
        key = method.getAttribute('key')
1932 1933
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1934 1935 1936 1937
          if len(method.getElementsByTagName('value')[0].childNodes):
            value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          else:
            value = ''
1938
          key = str(key)
1939
        elif key_type == "int":
1940
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1941
          key = str(key)
1942
        elif key_type == "tuple":
1943 1944 1945 1946
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1947
        else:
1948
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1949
          continue
1950
        if key in catalog_method_list or key in catalog_method_filter_list:
1951
          dict = getattr(self, key, {})
1952
          dict[id] = value
1953 1954 1955
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
1956

1957
class ActionTemplateItem(ObjectTemplateItem):
1958 1959

  def __init__(self, id_list, **kw):
1960
    # XXX It's look like ObjectTemplateItem __init__
1961 1962 1963 1964 1965 1966
    BaseTemplateItem.__init__(self, id_list, **kw)
    id_list = self._archive.keys()
    self._archive.clear()
    for id in id_list:
      self._archive["%s/%s" % ('portal_types', id)] = None

1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987
  def _splitPath(self, path):
    """
      Split path tries to split a complexe path such as:

      "foo/bar[id=zoo]"

      into

      "foo/bar", "id", "zoo"

      This is used mostly for generic objects
    """
    # Add error checking here
    if path.find('[') >= 0 and path.find(']') > path.find('=') and path.find('=') > path.find('['):
      relative_url = path[0:path.find('[')]
      id_block = path[path.find('[')+1:path.find(']')]
      key = id_block.split('=')[0]
      value = id_block.split('=')[1]
      return relative_url, key, value
    return path, None, None

1988 1989 1990 1991
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1992
      relative_url, value = id.split(' | ')
1993 1994
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1995
        if getattr(ai, 'id') == value:
1996
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1997
          key = os.path.join(url[-2], url[-1], value)
1998
          action = ai._getCopy(context)
1999
          action = self.removeProperties(action)
2000
          self._objects[key] = action
Aurel's avatar
Aurel committed
2001
          self._objects[key].wl_clearLocks()
2002 2003
          break
      else:
2004
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
2005

2006 2007 2008
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2009
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2010 2011
      p = context.getPortalObject()
      for id in self._objects.keys():
2012 2013 2014 2015 2016 2017
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
2018 2019
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
2020
          for index in range(len(action_list)):
2021
            if getattr(action_list[index], 'id') == path[-1]:
2022
              # remove previous action
2023
              obj.deleteActions(selections=(index,))
2024
          action = self._objects[id]
2025 2026 2027
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2028
          obj.addAction(
2029 2030
                        id = action.id
                      , name = action.title
2031
                      , action = action_text
2032 2033 2034 2035
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2036 2037
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2038
                      , priority = action.priority
Aurel's avatar
Aurel committed
2039
                    )
2040
          # sort action based on the priority define on it
2041 2042 2043 2044 2045 2046 2047 2048 2049
          # XXX suppose that priority are properly on actions
          new_priority = action.priority
          action_list = obj.listActions()
          move_down_list = []
          for index in range(len(action_list)):
            action = action_list[index]
            if action.priority > new_priority:
              move_down_list.append(str(index))
          obj.moveDownActions(selections=tuple(move_down_list))
Aurel's avatar
Aurel committed
2050
    else:
2051
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2052
      p = context.getPortalObject()
2053 2054
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2055
        relative_url, key, value = self._splitPath(id)
2056 2057
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2058
          if getattr(ai, key) == value:
2059
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2060 2061 2062
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2063
        obj.addAction(
Aurel's avatar
Aurel committed
2064 2065
                      id = action.id
                    , name = action.title
2066
                    , action = action_text
Aurel's avatar
Aurel committed
2067 2068 2069 2070
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2071 2072
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2073
                    )
Aurel's avatar
Aurel committed
2074 2075 2076 2077 2078 2079 2080
        new_priority = action.priority
        action_list = obj.listActions()
        move_down_list = []
        for index in range(len(action_list)):
          action = action_list[index]
          if action.priority > new_priority:
            move_down_list.append(str(index))
2081 2082
          obj.moveDownActions(selections=tuple(move_down_list))

2083 2084
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2085 2086 2087 2088
    object_path = kw.get("object_path", None)
    if object_path is not None:
      keys = [object_path]
    else:
2089
      keys = self._archive.keys()
2090
    for id in keys:
2091 2092 2093 2094
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105
        relative_url, key, value = self._splitPath(id)
      obj = p.unrestrictedTraverse(relative_url, None)
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
          if getattr(action_list[index], key) == value:
            obj.deleteActions(selections=(index,))
            break
      else :
        LOG('BusinessTemplate', 100,
            'unable to uninstall action at %s, ignoring' % relative_url )
2106 2107
    BaseTemplateItem.uninstall(self, context, **kw)

2108 2109 2110
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2111
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123
    BaseTemplateItem.__init__(self, id_list, **kw)

  def build(self, context, **kw):
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      obj = p.unrestrictedTraverse("portal_types/%s" %
          relative_url.split('/', 1)[1])
      type_roles_obj = getattr(obj, '_roles', ())
      type_role_list = []
      for role in type_roles_obj:
        type_role_dict = {}
        # uniq
2124
        for property in ('id', 'title', 'description',
2125 2126 2127 2128
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
2129 2130 2131 2132
        # condition
        prop_value = getattr(role, 'condition')
        if prop_value:
          type_role_dict['condition'] = prop_value.text
2133 2134 2135 2136 2137 2138 2139 2140 2141
        # multi
        for property in ('category', 'base_category'):
          prop_value_list = []
          for prop_value in getattr(role, property):
            prop_value_list.append(prop_value)
          type_role_dict[property] = prop_value_list
        type_role_list.append(type_role_dict)
      self._objects[relative_url] = type_role_list

Christophe Dumez's avatar
Christophe Dumez committed
2142
  # Function to generate XML Code Manually
2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
      xml_data += os.linesep+"  <role id='%s'>" % role['id']
      # uniq
      for property in ('title', 'description', 'condition', 'priority',
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
          xml_data += os.linesep+"   <property id='%s'>%s</property>" % \
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2157
        for prop_value in role.get(property, []):
2158 2159 2160 2161 2162
          xml_data += os.linesep+"   <multi_property "\
          "id='%s'>%s</multi_property>" % (property, prop_value)
      xml_data += os.linesep+"  </role>"
    xml_data += os.linesep+'</type_roles>'
    return xml_data
2163

2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      xml_data = self.generateXml(key)
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
    type_roles_list = []
    xml = parse(file)
2177
    xml_type_roles_list = xml.getElementsByTagName('role')
2178 2179 2180 2181 2182 2183 2184 2185
    for role in xml_type_roles_list:
      id = role.getAttribute('id')
      type_role_property_dict = {'id':id}
      # uniq
      property_list = role.getElementsByTagName('property')
      for property in property_list:
        property_id = property.getAttribute('id').encode()
        if property.hasChildNodes():
2186
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2187 2188 2189 2190 2191 2192 2193 2194 2195 2196
          if property_id == 'priority':
            property_value = float(property_value)
          type_role_property_dict[property_id] = property_value
      # multi
      multi_property_list = role.getElementsByTagName('multi_property')
      for property in multi_property_list:
        property_id = property.getAttribute('id').encode()
        if not type_role_property_dict.has_key(property_id):
          type_role_property_dict[property_id] = []
        if property.hasChildNodes():
2197
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212
          type_role_property_dict[property_id].append(property_value)
      type_roles_list.append(type_role_property_dict)
    self._objects['portal_type_roles/'+file_name[:-4]] = type_roles_list

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    p = context.getPortalObject()
    for roles_path in self._objects.keys():
      if update_dict.has_key(roles_path) or force:
        if not force:
          action = update_dict[roles_path]
          if action == 'nothing':
            continue
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2213 2214 2215 2216 2217 2218
      obj = p.unrestrictedTraverse(path, None)
      if obj is not None:
        setattr(obj, '_roles', []) # reset roles before applying
        type_roles_list = self._objects[roles_path] or []
        for type_role_property_dict in type_roles_list:
          obj._roles.append(RoleInformation(**type_role_property_dict))
2219 2220 2221

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2222 2223 2224 2225 2226 2227
    object_path = kw.get('object_path', None)
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
2228
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2229 2230 2231 2232 2233
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2234

2235 2236 2237 2238 2239 2240
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2241 2242
      for property in p.propertyMap():
        if property['id'] == id:
2243
          obj = p.getProperty(id)
2244
          prop_type = property['type']
2245 2246
          break
      else:
2247 2248
        obj = None
      if obj is None:
2249
        raise NotFound, 'the property %s is not found' % id
2250
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2251

2252 2253 2254 2255 2256 2257
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
    xml = parse(file)
    property_list = xml.getElementsByTagName('property')
    for prop in property_list:
      id = prop.getElementsByTagName('id')[0].childNodes[0].data
2258 2259
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2260 2261 2262 2263 2264 2265 2266
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2267
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2268
      self._objects[str(id)] = (str(prop_type), value)
2269

2270 2271 2272
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2273
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2274 2275
      p = context.getPortalObject()
      for path in self._objects.keys():
2276 2277 2278 2279
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2280
              continue
2281 2282 2283
          dir, id = os.path.split(path)
          if p.hasProperty(id):
            continue
2284 2285
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
2286
    else:
2287
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2288
      p = context.getPortalObject()
2289 2290
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
2291 2292 2293 2294 2295
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
2296 2297 2298

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2299 2300 2301 2302 2303 2304
    object_path = kw.get('object_path', None)
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._archive.keys()
    for id in keys:
2305 2306 2307 2308
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2309
  # Function to generate XML Code Manually
2310
  def generateXml(self, path=None):
2311
    xml_data = ''
2312
    prop_type, obj = self._objects[path]
2313 2314
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
2315 2316
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
2317
      xml_data += os.linesep+'  <value>'
2318
      for item in obj:
2319 2320 2321 2322
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
2323
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
2324
    xml_data += os.linesep+' </property>'
2325 2326
    return xml_data

Aurel's avatar
Aurel committed
2327 2328 2329 2330 2331
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
2332 2333 2334 2335
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2336
      xml_data += self.generateXml(path)
2337
    xml_data += os.linesep+'</site_property>'
2338
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2339

2340 2341 2342 2343 2344 2345 2346
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
      module = p.unrestrictedTraverse(id)
2347 2348 2349 2350 2351 2352 2353 2354
      dict = {}
      dict['id'] = module.getId()
      dict['title'] = module.getTitle()
      dict['portal_type'] = module.getPortalType()
      permission_list = []
      # use show permission
      dict['permission_list'] = module.showPermissions()
      self._objects[id] = dict
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2355

Christophe Dumez's avatar
Christophe Dumez committed
2356
  # Function to generate XML Code Manually
2357
  def generateXml(self, path=None):
2358 2359
    dict = self._objects[path]
    xml_data = '<module>'
2360 2361 2362 2363
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2364 2365 2366 2367 2368
      if key =='permission_list':
        # separe permission dict into xml
        xml_data += os.linesep+' <%s>' %(key,)
        permission_list = dict[key]
        for perm in permission_list:
2369 2370 2371 2372 2373 2374
          # the type of the permission defined if we use acquired or not
          if type(perm[1]) == type([]):
            ptype = "list"
          else:
            ptype = "tuple"
          xml_data += os.linesep+"  <permission type='%s'>" %(ptype,)
2375
          xml_data += os.linesep+'   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2376
          role_list = list(perm[1])
2377
          role_list.sort()
2378 2379 2380 2381 2382 2383 2384 2385 2386
          for role in role_list:
            xml_data += os.linesep+'   <role>%s</role>' %(role)
          xml_data += os.linesep+'  </permission>'
        xml_data += os.linesep+' </%s>' %(key,)
      else:
        xml_data += os.linesep+' <%s>%s</%s>' %(key, dict[key], key)
    xml_data += os.linesep+'</module>'
    return xml_data

2387 2388 2389 2390 2391
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
2392 2393 2394
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
2395
      # expor module one by one
2396
      xml_data = self.generateXml(path=id)
2397
      bta.addObject(obj=xml_data, name=id, path=path)
2398

2399
  def install(self, context, trashbin, **kw):
2400
    portal = context.getPortalObject()
2401 2402
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2403
    if context.getTemplateFormatVersion() == 1:
2404
      items = self._objects
2405
    else:
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417
      items = self._archive

    for id in items.keys():
      if update_dict.has_key(id) or force:
        if not force:
          action = update_dict[id]
          if action == 'nothing':
            continue
        mapping = items[id]
        path, id = os.path.split(id)
        if id in portal.objectIds():
          module = portal._getOb(id)
2418
          module.portal_type = str(mapping['portal_type'])
2419 2420 2421 2422 2423 2424 2425 2426 2427 2428
        else:
          module = portal.newContent(id=id, portal_type=str(mapping['portal_type']))
        module.setTitle(str(mapping['title']))
        for name,role_list in list(mapping['permission_list']):
          acquire = (type(role_list) == type([]))
          try:
            module.manage_permission(name, roles=role_list, acquire=acquire)
          except ValueError:
            # Ignore a permission not present in this system.
            pass
2429 2430 2431 2432 2433 2434 2435 2436 2437 2438

  def _importFile(self, file_name, file):
    dict = {}
    xml = parse(file)
    for id in ('portal_type', 'id', 'title', 'permission_list'):
      elt = xml.getElementsByTagName(id)[0]
      if id == 'permission_list':
        plist = []
        perm_list = elt.getElementsByTagName('permission')
        for perm in perm_list:
2439
          perm_type = perm.getAttribute('type').encode() or None
2440 2441 2442 2443 2444 2445 2446 2447 2448
          name_elt = perm.getElementsByTagName('name')[0]
          name_node = name_elt.childNodes[0]
          name = name_node.data
          role_list = perm.getElementsByTagName('role')
          rlist = []
          for role in role_list:
            role_node = role.childNodes[0]
            role = role_node.data
            rlist.append(str(role))
2449 2450 2451 2452
          if perm_type == "list" or perm_type is None:
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463
          plist.append(perm_tuple)
        dict[id] = plist
      else:
        node_list = elt.childNodes
        if len(node_list) == 0:
          value=''
        else:
          value = node_list[0].data
        dict[id] = str(value)
    self._objects[file_name[:-4]] = dict

2464
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2465 2466 2467
    trash = kw.get('trash', 0)
    if trash:
      return
2468 2469 2470 2471 2472 2473
    object_path = kw.get('object_path', None)
    trashbin = kw.get('trashbin', None)
    if object_path is None:
      keys = self._archive.keys()
    else:
      keys = [object_path]
2474 2475
    p = context.getPortalObject()
    id_list = p.objectIds()
2476
    for id in keys:
2477
      if id in id_list:
2478
        try:
2479
          if trash and trashbin is not None:
2480 2481
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2482
          p.manage_delObjects([id])
2483
        except NotFound:
2484
          pass
2485 2486
    BaseTemplateItem.uninstall(self, context, **kw)

2487 2488 2489
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2490 2491

class DocumentTemplateItem(BaseTemplateItem):
2492 2493 2494 2495
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2496 2497 2498 2499

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    for id in self._archive.keys():
2500
      self._objects[self.__class__.__name__+os.sep+id] = globals()[self.local_file_reader_name](id)
Aurel's avatar
Aurel committed
2501

2502
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2503 2504
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524
      new_keys = self._objects.keys()
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
          old_obj_code = installed_bt._objects[path]
          if new_obj_code != old_obj_code:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
          # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2525
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2526
      for id in self._objects.keys():
2527 2528 2529 2530 2531 2532 2533 2534 2535
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
          path, name = os.path.split(id)
          # This raises an exception if the file already exists.
          try:
2536
            globals()[self.local_file_writer_name](name, text, create=0)
2537
          except IOError, error:
2538
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
2539 2540
            if error.errno :
              raise
2541 2542 2543
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
2544
    else:
2545 2546 2547
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
2548
        # This raises an exception if the file exists.
2549
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
2550 2551
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
2552 2553

  def uninstall(self, context, **kw):
2554
    object_path = kw.get('object_path', None)
2555 2556 2557 2558 2559
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
2560
      globals()[self.local_file_remover_name](id)
2561 2562
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
2563 2564 2565 2566 2567 2568
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
2569 2570
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
2571

2572 2573
  def _importFile(self, file_name, file):
    text = file.read()
2574
    self._objects[file_name[:-3]]=text
2575

2576 2577 2578 2579 2580 2581
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

2582 2583 2584 2585 2586
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
2587

2588 2589 2590
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
2591 2592
  # Extension needs no import
  local_file_importer_name = None
2593 2594 2595 2596 2597
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
2598
  # Test needs no import
2599 2600 2601
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
2602

2603 2604 2605
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
2606 2607 2608

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2609 2610 2611 2612
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2613 2614
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
2615

2616
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2617 2618
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2619
      new_roles = self._objects.keys()
2620 2621 2622
      if installed_bt.id == 'installed_bt_for_diff':
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
2623 2624 2625
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
2626 2627
        for key in old_keys:
          new_dict[key] = ''
2628
        installed_bt._objects = new_dict
2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641
      for role in new_roles:
        if installed_bt._objects.has_key(role):
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
      old_roles = installed_bt._objects.keys()
      for role in old_roles:
        if role not in new_roles:
          modified_object_list.update({role : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
2642
    p = context.getPortalObject()
2643
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2644
    if context.getTemplateFormatVersion() == 1:
2645
      role_list = self._objects.keys()
2646
    else:
2647
      role_list = self._archive.keys()
2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659
    # set roles in PAS
    if p.acl_users.meta_type == 'Pluggable Auth Service':
      role_manager_list = p.acl_users.objectValues('ZODB Role Manager')
      for role_manager in role_manager_list:
        existing_role_list = role_manager.listRoleIds()
        for role in role_list:
          if role not in existing_role_list:
            role_manager.addRole(role)
    # set roles on portal
    roles = {}
    for role in p.__ac_roles__:
      roles[role] = 1
2660
    for role in role_list:
2661 2662 2663 2664 2665 2666 2667 2668 2669 2670
      roles[role] = 1
    p.__ac_roles__ = tuple(roles.keys())

  def _importFile(self, file_name, file):
    xml = parse(file)
    role_list = xml.getElementsByTagName('role')
    for role in role_list:
      node = role.childNodes[0]
      value = node.data
      self._objects[str(value)] = 1
2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
    roles = {}
    for role in p.__ac_roles__:
      roles[role] = 1
    for role in self._archive.keys():
      if role in roles:
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())
    BaseTemplateItem.uninstall(self, context, **kw)

2683 2684 2685 2686 2687 2688 2689 2690 2691
  def trash(self, context, new_item, **kw):
    p = context.getPortalObject()
    new_roles = {}
    for role in new_item._archive.keys():
      new_roles[role] = 1
    roles = {}
    for role in p.__ac_roles__:
      roles[role] = 1
    for role in self._archive.keys():
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2692
      if role in roles and role not in new_roles:
2693 2694 2695
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
2696
  # Function to generate XML Code Manually
2697
  def generateXml(self, path):
2698
    obj = self._objects[path]
2699
    xml_data = '<role_list>'
2700 2701
    obj.sort()
    for role in obj:
2702 2703 2704 2705
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

Aurel's avatar
Aurel committed
2706 2707 2708 2709 2710 2711
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
2712
      xml_data = self.generateXml(path=path)
2713
      bta.addObject(obj=xml_data, name=path, path=None,)
2714

2715 2716
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2717
  def build(self, context, **kw):
2718
    catalog = _getCatalogValue(self)
2719 2720 2721
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2722
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2723
    key_list = []
2724
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2725
      if key in sql_search_result_keys:
2726
        key_list.append(key)
Aurel's avatar
Aurel committed
2727
      else:
2728
        raise NotFound, 'Result key "%r" not found in catalog' %(key,)
2729
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2730
      self._objects[self.__class__.__name__+os.sep+'result_key_list'] = key_list
2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741

  def _importFile(self, file_name, file):
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

2742
  def install(self, context, trashbin, **kw):
2743
    catalog = _getCatalogValue(self)
2744 2745 2746
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2747

2748
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2749
    if context.getTemplateFormatVersion() == 1:
2750 2751
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
2752 2753 2754
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2755
    else:
2756
      keys = self._archive.keys()
2757 2758
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2759
    # XXX same as related key
Aurel's avatar
Aurel committed
2760
    if update_dict.has_key('result_key_list') or force:
2761
      if not force:
Aurel's avatar
Aurel committed
2762
        action = update_dict['result_key_list']
2763
        if action == 'nothing':
Aurel's avatar
Aurel committed
2764
          return
2765
      for key in keys:
2766 2767
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
2768
      catalog.sql_search_result_keys = sql_search_result_keys
2769

2770
  def uninstall(self, context, **kw):
2771
    catalog = _getCatalogValue(self)
2772 2773 2774 2775
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2776
    object_path = kw.get('object_path', None)
2777 2778 2779 2780 2781
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2782 2783
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2784
    catalog.sql_search_result_keys = sql_search_result_keys
2785 2786
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2787
  # Function to generate XML Code Manually
2788
  def generateXml(self, path=None):
2789
    obj = self._objects[path]
2790
    xml_data = '<key_list>'
2791 2792
    obj.sort()
    for key in obj:
2793 2794 2795 2796
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2797 2798 2799 2800 2801
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
2802
    for path in self._objects.keys():
2803
      xml_data = self.generateXml(path=path)
2804
      bta.addObject(obj=xml_data, name=path, path=None)
2805

2806 2807
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2808
  def build(self, context, **kw):
2809
    catalog = _getCatalogValue(self)
2810 2811 2812
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2813
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2814
    key_list = []
2815
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2816
      if key in sql_search_related_keys:
2817
        key_list.append(key)
Aurel's avatar
Aurel committed
2818
      else:
2819
        raise NotFound, 'Related key "%r" not found in catalog' %(key,)
2820
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2821
      self._objects[self.__class__.__name__+os.sep+'related_key_list'] = key_list
2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832

  def _importFile(self, file_name, file):
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

2833
  def install(self, context, trashbin, **kw):
2834
    catalog = _getCatalogValue(self)
2835 2836 2837
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2838

2839
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2840
    if context.getTemplateFormatVersion() == 1:
2841
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2842
        return
2843 2844 2845
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2846
    else:
2847
      keys = self._archive.keys()
2848 2849
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
2850
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
2851
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
2852
      if not force:
Aurel's avatar
Aurel committed
2853 2854 2855 2856
        if update_dict.has_key('related_key_list'):
          action = update_dict['related_key_list']
        else: # XXX for backward compatibility
          action = update_dict['key_list']
Aurel's avatar
Aurel committed
2857 2858 2859
        if action == 'nothing':
          return
      for key in keys:
2860 2861
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
2862
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
2863

2864
  def uninstall(self, context, **kw):
2865
    catalog = _getCatalogValue(self)
2866 2867 2868
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2869
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2870
    object_path = kw.get('object_path', None)
2871 2872 2873 2874 2875
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2876 2877 2878 2879 2880
      if key in sql_catalog_related_keys:
        sql_catalog_related_keys.remove(key)
    catalog.sql_catalog_related_keys = sql_catalog_related_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2881
  # Function to generate XML Code Manually
2882
  def generateXml(self, path=None):
2883
    obj = self._objects[path]
2884
    xml_data = '<key_list>'
2885 2886
    obj.sort()
    for key in obj:
2887 2888 2889 2890
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2891 2892 2893 2894 2895 2896
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
2897
      xml_data = self.generateXml(path=path)
2898
      bta.addObject(obj=xml_data, name=path, path=None)
2899

2900 2901
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2902
  def build(self, context, **kw):
2903
    catalog = _getCatalogValue(self)
2904 2905 2906
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2907
    sql_search_result_tables = list(catalog.sql_search_tables)
2908
    key_list = []
2909
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2910
      if key in sql_search_result_tables:
2911
        key_list.append(key)
Aurel's avatar
Aurel committed
2912
      else:
2913
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
2914
    if len(key_list) > 0:
2915
      self._objects[self.__class__.__name__+os.sep+'result_table_list'] = key_list
2916 2917 2918 2919 2920 2921 2922 2923 2924 2925

  def _importFile(self, file_name, file):
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list
Aurel's avatar
Aurel committed
2926

2927
  def install(self, context, trashbin, **kw):
2928
    catalog = _getCatalogValue(self)
2929 2930 2931
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2932

2933
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2934
    if context.getTemplateFormatVersion() == 1:
2935
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2936
        return
2937 2938 2939
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2940
    else:
2941
      keys = self._archive.keys()
2942 2943
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2944
    # XXX same as related keys
Aurel's avatar
Aurel committed
2945
    if update_dict.has_key('result_table_list') or force:
2946
      if not force:
Aurel's avatar
Aurel committed
2947
        action = update_dict['result_table_list']
2948
        if action == 'nothing':
Aurel's avatar
Aurel committed
2949
          return
2950
      for key in keys:
2951 2952
        if key not in sql_search_tables:
          sql_search_tables.append(key)
2953
      catalog.sql_search_tables = tuple(sql_search_tables)
2954 2955

  def uninstall(self, context, **kw):
2956
    catalog = _getCatalogValue(self)
2957 2958 2959 2960
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2961
    object_path = kw.get('object_path', None)
2962 2963 2964 2965 2966
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2967 2968
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2969
    catalog.sql_search_tables = sql_search_tables
2970 2971
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2972
  # Function to generate XML Code Manually
2973
  def generateXml(self, path=None):
2974
    obj = self._objects[path]
2975
    xml_data = '<key_list>'
2976 2977
    obj.sort()
    for key in obj:
2978
      xml_data += os.linesep+' <key>%s</key>' %(key)
2979
    xml_data += os.linesep+'</key_list>'
2980 2981
    return xml_data

Aurel's avatar
Aurel committed
2982 2983 2984 2985 2986 2987
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
2988
      xml_data = self.generateXml(path=path)
2989
      bta.addObject(obj=xml_data, name=path, path=None)
2990

2991 2992
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
2993 2994

  def build(self, context, **kw):
2995
    catalog = _getCatalogValue(self)
2996 2997 2998 2999 3000 3001 3002 3003 3004
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_keyword_keys:
        key_list.append(key)
      else:
3005
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3006 3007
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3008

3009 3010 3011 3012 3013 3014 3015 3016 3017
  def _importFile(self, file_name, file):
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list
3018 3019

  def install(self, context, trashbin, **kw):
3020
    catalog = _getCatalogValue(self)
3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
3034 3035
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047
    # XXX same as related key
    if update_dict.has_key('keyword_key_list') or force:
      if not force:
        action = update_dict['keyword_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_keyword_keys:
          sql_keyword_keys.append(key)
      catalog.sql_catalog_keyword_search_keys = sql_keyword_keys

  def uninstall(self, context, **kw):
3048
    catalog = _getCatalogValue(self)
3049 3050 3051 3052
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3053
    object_path = kw.get('object_path', None)
3054 3055
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3056
    else:
3057 3058 3059 3060 3061 3062 3063
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_keyword_keys:
        sql_keyword_keys.remove(key)
    catalog.sql_catalog_keyword_search_keys = sql_keyword_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3064
  # Function to generate XML Code Manually
3065 3066 3067 3068 3069 3070 3071 3072
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data
Aurel's avatar
Aurel committed
3073 3074 3075 3076

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3077 3078 3079 3080 3081
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)
3082

3083 3084
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3085

3086
  def build(self, context, **kw):
3087
    catalog = _getCatalogValue(self)
3088 3089 3090 3091 3092 3093 3094 3095 3096
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_full_text_keys = list(catalog.sql_catalog_full_text_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_full_text_keys:
        key_list.append(key)
      else:
3097
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
3098
    if len(key_list) > 0:
3099
      self._objects[self.__class__.__name__+os.sep+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3100

3101 3102 3103 3104 3105 3106 3107 3108 3109
  def _importFile(self, file_name, file):
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3110

3111
  def install(self, context, trashbin, **kw):
3112
    catalog = _getCatalogValue(self)
3113 3114 3115
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3116

3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137
    sql_full_text_keys = list(catalog.sql_catalog_full_text_search_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX same as related key
    if update_dict.has_key('full_text_key_list') or force:
      if not force:
        action = update_dict['full_text_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_full_text_keys:
          sql_full_text_keys.append(key)
      catalog.sql_catalog_full_text_search_keys = sql_full_text_keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3138

3139
  def uninstall(self, context, **kw):
3140
    catalog = _getCatalogValue(self)
3141 3142 3143 3144
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_full_text_keys = list(catalog.sql_catalog_full_text_search_keys)
3145
    object_path = kw.get('object_path', None)
3146 3147 3148 3149 3150 3151 3152 3153 3154 3155
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_full_text_keys:
        sql_full_text_keys.remove(key)
    catalog.sql_catalog_full_text_search_keys = sql_full_text_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3156
  # Function to generate XML Code Manually
3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)


# request
class CatalogRequestKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
3180
    catalog = _getCatalogValue(self)
3181 3182 3183 3184 3185 3186 3187 3188 3189
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_request_keys = list(catalog.sql_catalog_request_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_request_keys:
        key_list.append(key)
      else:
3190
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'request_key_list'] = key_list

  def _importFile(self, file_name, file):
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
3205
    catalog = _getCatalogValue(self)
3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX must a find a better way to manage related key
    if update_dict.has_key('request_key_list') or force:
      if not force:
        action = update_dict['request_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_request_keys:
          sql_catalog_request_keys.append(key)
      catalog.sql_catalog_request_keys = tuple(sql_catalog_request_keys)

  def uninstall(self, context, **kw):
3233
    catalog = _getCatalogValue(self)
3234 3235 3236 3237
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
3238
    object_path = kw.get('object_path', None)
3239 3240 3241 3242 3243 3244 3245 3246 3247 3248
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_request_keys:
        sql_catalog_request_keys.remove(key)
    catalog.sql_catalog_request_keys = sql_catalog_request_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3249
  # Function to generate XML Code Manually
3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)

# multivalue
class CatalogMultivalueKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
3272
    catalog = _getCatalogValue(self)
3273 3274 3275 3276 3277 3278 3279 3280 3281
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_multivalue_keys:
        key_list.append(key)
      else:
3282
        raise NotFound, 'Multivalue key "%r" not found in catalog' %(key,)
3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'multivalue_key_list'] = key_list

  def _importFile(self, file_name, file):
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
3297
    catalog = _getCatalogValue(self)
3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    if update_dict.has_key('multivalue_key_list') or force:
      if not force:
        action = update_dict['multivalue_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_multivalue_keys:
          sql_catalog_multivalue_keys.append(key)
      catalog.sql_catalog_multivalue_keys = tuple(sql_catalog_multivalue_keys)

  def uninstall(self, context, **kw):
3324
    catalog = _getCatalogValue(self)
3325 3326 3327 3328
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
3329
    object_path = kw.get('object_path', None)
3330 3331 3332 3333 3334 3335 3336 3337 3338 3339
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_multivalue_keys:
        sql_catalog_multivalue_keys.remove(key)
    catalog.sql_catalog_multivalue_keys = sql_catalog_multivalue_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3340
  # Function to generate XML Code Manually
3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)

# topic
class CatalogTopicKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
3363
    catalog = _getCatalogValue(self)
3364 3365 3366 3367 3368 3369 3370 3371 3372
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_catalog_topic_search_keys:
        key_list.append(key)
      else:
3373
        raise NotFound, 'Topic key "%r" not found in catalog' %(key,)
3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'topic_key_list'] = key_list

  def _importFile(self, file_name, file):
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
3388
    catalog = _getCatalogValue(self)
3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX same as related key
    if update_dict.has_key('topic_key_list') or force:
      if not force:
        action = update_dict['topic_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_topic_search_keys:
          sql_catalog_topic_search_keys.append(key)
      catalog.sql_catalog_topic_search_keys = sql_catalog_topic_search_keys

  def uninstall(self, context, **kw):
3416
    catalog = _getCatalogValue(self)
3417 3418 3419 3420
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
3421
    object_path = kw.get('object_path', None)
3422 3423 3424 3425 3426 3427 3428 3429 3430 3431
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_topic_search_keys:
        sql_catalog_topic_search_keys.remove(key)
    catalog.sql_catalog_topic_search_keys = sql_catalog_topic_search_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3432
  # Function to generate XML Code Manually
3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)

class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
3455 3456 3457 3458 3459 3460 3461 3462 3463
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
      else: # XXX backward compatibilty
        lang = lang_key
        catalog = 'erp5_ui'
      path = os.path.join(lang, catalog)
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494

  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
          old_obj_code = installed_bt._objects[path]
          if new_obj_code != old_obj_code:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
    localizer = context.getPortalObject().Localizer
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
      for path, po in self._objects.items():
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
3495
              continue
3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524
          path = string.split(path, '/')
          lang = path[-3]
          catalog = path[-2]
          if lang not in localizer.get_languages():
            localizer.manage_addLanguage(lang)
          mc = localizer._getOb(catalog)
          if lang not in mc.get_languages():
            mc.manage_addLanguage(lang)
          mc.manage_import(lang, po)
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for lang, catalogs in self._archive.items():
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
          mc = localizer._getOb(catalog)
          if lang not in mc.get_languages():
            mc.manage_addLanguage(lang)
          mc.manage_import(lang, po)

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      obj = self._objects[key]
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
Aurel's avatar
Aurel committed
3525
      f = open(path+os.sep+'translation.po', 'wt')
3526 3527 3528 3529
      f.write(str(obj))
      f.close()

  def _importFile(self, file_name, file):
3530 3531 3532
    if os.path.split(file_name)[1] == 'translation.po':
      text = file.read()
      self._objects[file_name[:-3]] = text
3533

Aurel's avatar
Aurel committed
3534 3535
class LocalRolesTemplateItem(BaseTemplateItem):

3536
  def __init__(self, id_list, **kw):
3537
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
3538 3539
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
3540 3541 3542
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
3543
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
3544 3545 3546 3547
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
      group_local_roles_dict = getattr(obj, '__ac_local_group_roles__',
                                        {}) or {}
Aurel's avatar
Aurel committed
3548 3549
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

Christophe Dumez's avatar
Christophe Dumez committed
3550
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577
  def generateXml(self, path=None):
    local_roles_dict, group_local_roles_dict = self._objects[path]
    local_roles_keys = local_roles_dict.keys()
    group_local_roles_keys = group_local_roles_dict.keys()
    local_roles_keys.sort()
    group_local_roles_keys.sort()
    # local roles
    xml_data = '<local_roles_item>'
    xml_data += os.linesep+' <local_roles>'
    for key in local_roles_keys:
      xml_data += os.linesep+"  <role id='%s'>" %(key,)
      tuple = local_roles_dict[key]
      for item in tuple:
        xml_data += os.linesep+"   <item>%s</item>" %(item,)
      xml_data += os.linesep+"  </role>"
    xml_data += os.linesep+' </local_roles>'
    # group local roles
    xml_data += os.linesep+' <group_local_roles>'
    for key in group_local_roles_keys:
      xml_data += os.linesep+"  <role id='%s'>" %(key,)
      tuple = group_local_roles_dict[key]
      for item in tuple:
        xml_data += os.linesep+"   <item>%s</item>" %(item,)
      xml_data += os.linesep+"  </role>"
    xml_data += os.linesep+' </group_local_roles>'
    xml_data += os.linesep+'</local_roles_item>'
    return xml_data
3578

Aurel's avatar
Aurel committed
3579 3580 3581 3582 3583 3584 3585 3586 3587 3588
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      xml_data = self.generateXml(key)

      folders, id = os.path.split(key)
      encode_folders = []
3589
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
3590 3591 3592 3593
        if '%' not in folder:
          encode_folders.append(pathname2url(folder))
        else:
          encode_folders.append(folder)
3594
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
3595 3596 3597 3598 3599 3600 3601
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
    xml = parse(file)
    # local roles
    local_roles = xml.getElementsByTagName('local_roles')[0]
3602
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3603 3604 3605 3606 3607 3608 3609 3610 3611 3612
    local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
      item_type_list = []
      item_list = role.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      local_roles_dict[id] = item_type_list
    # group local roles
    group_local_roles = xml.getElementsByTagName('group_local_roles')[0]
3613
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646
    group_local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
      item_type_list = []
      item_list = role.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      group_local_roles_dict[id] = item_type_list
    self._objects['local_roles/'+file_name[:-4]] = (local_roles_dict, group_local_roles_dict)

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    p = context.getPortalObject()
    for roles_path in self._objects.keys():
      if update_dict.has_key(roles_path) or force:
        if not force:
          action = update_dict[roles_path]
          if action == 'nothing':
            continue
      path = roles_path.split('/')[1:]
      obj = p.unrestrictedTraverse(path)
      local_roles_dict, group_local_roles_dict = self._objects[roles_path]
      setattr(obj, '__ac_local_roles__', local_roles_dict)
      setattr(obj, '__ac_local_group_roles__', group_local_roles_dict)

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
    for roles_path in self._objects.keys():
      path = roles_path.split('/')[1:]
      obj = p.unrestrictedTraverse(path)
      setattr(obj, '__ac_local_roles__', {})
      setattr(obj, '__ac_local_group_roles__', {})
3647

3648 3649 3650
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
3651
    in part or completely. Each object is separated from its
3652 3653 3654 3655 3656 3657 3658 3659 3660 3661
    subobjects and exported in xml format.
    It may include:

    - catalog definition
      - SQL method objects
      - SQL methods including:
        - purpose (catalog, uncatalog, etc.)
        - filter definition

    - portal_types definition
Christophe Dumez's avatar
Christophe Dumez committed
3662 3663
      - object without optimal actions
      - list of relation between portal type and workflow
3664 3665 3666 3667 3668 3669 3670 3671 3672 3673

    - module definition
      - id
      - title
      - portal type
      - roles/security

    - site property definition
      - id
      - type
3674
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3675

3676 3677
    - document/propertysheet/extension/test definition
      - copy of the local file
3678

3679
    - message transalation definition
3680
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3681

3682 3683
    The Business Template properties are exported to the bt folder with
    one property per file
3684

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3685 3686
    Technology:

3687 3688
    - download a gzip file or folder tree (from the web, from a CVS repository,
      from local file system) (import/donwload)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3689

3690
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3691 3692 3693 3694

    Use case:

    - install core ERP5 (the minimum)
3695

3696
    - go to "BT" menu. Import BT. Select imported BT. Click install.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3697

3698 3699
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
3700
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3701 3702 3703 3704 3705
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
3706
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3707 3708 3709 3710 3711
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
3712
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3713 3714 3715 3716

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
3717
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3718
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3719
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3720 3721 3722
                      , PropertySheet.BusinessTemplate
                      )

3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739
    # Factory Type Information
    factory_type_information = \
      {    'id'             : portal_type
         , 'meta_type'      : meta_type
         , 'description'    : """\
Business Template is a set of definitions, such as skins, portal types and categories. This is used to set up a new ERP5 site very efficiently."""
         , 'icon'           : 'order_line_icon.gif'
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
         , 'global_allow'   : 1
      }

3740 3741
    # This is a global variable
    # Order is important for installation
3742 3743 3744 3745 3746 3747
    # We want to have:
    #  * path after module, because path can be module content
    #  * path after categories, because path can be categories content
    #  * skin after paths, because we can install a custom connection string as
    #       path and use it with SQLMethods in a skin.
    #    ( and more )
3748 3749 3750
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
3751
      '_constraint_item',
3752 3753 3754 3755 3756 3757 3758 3759
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
3760
      '_portal_type_workflow_chain_item',
3761 3762 3763 3764
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
3765 3766
      '_category_item',
      '_module_item',
3767
      '_path_item',
3768
      '_skin_item',
3769
      '_preference_item',
3770
      '_action_item',
3771
      '_portal_type_roles_item',
3772
      '_local_roles_item',
3773
      '_catalog_method_item',
3774 3775 3776
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
3777 3778 3779 3780 3781
      '_catalog_keyword_key_item',
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
3782 3783 3784 3785
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3786 3787 3788 3789 3790 3791
      self._clean()

    def getTemplateFormatVersion(self, **kw):
      """This is a workaround, because template_format_version was not set even for the new format.
      """
      if self.hasProperty('template_format_version'):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3792
        self._baseGetTemplateFormatVersion()
3793

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3794 3795 3796
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
3797

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3798
      return 0
3799

3800
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
3801 3802 3803 3804 3805 3806 3807
    def manage_afterAdd(self, item, container):
      """
        This is called when a new business template is added or imported.
      """
      portal_workflow = getToolByName(self, 'portal_workflow')
      if portal_workflow is not None:
        # Make sure that the installation state is "not installed".
3808 3809
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
3810
          # XXX Not good to access the attribute directly,
3811 3812 3813
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
3814

3815 3816
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
3817 3818 3819 3820 3821 3822
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

3823
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
3824 3825 3826 3827 3828 3829 3830 3831
        """Increment bt revision number.
        """
        revision_number = self.getRevision()
        if revision_number is None or revision_number.strip() == '':
          revision_number = 1
        else:
          revision_number = int(revision_number)+1
        self.setRevision(revision_number)
3832

3833
    security.declareProtected(Permissions.ManagePortal, 'build')
3834
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3835 3836 3837
      """
        Copy existing portal objects to self
      """
3838
      if no_action: return
3839
        # this is use at import of Business Template to get the status built
3840 3841
      # Make sure that everything is sane.
      self.clean()
3842

3843 3844 3845
      # Update revision number
      # <christophe@nexedi.com>
      self.updateRevisionNumber()
3846

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3847 3848
      self._setTemplateFormatVersion(1)

3849
      # Store all data
3850 3851
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
3852
      self._portal_type_workflow_chain_item = \
3853
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
3854 3855 3856 3857 3858 3859 3860 3861 3862 3863
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
3864 3865
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
3866 3867 3868 3869 3870 3871 3872 3873
      self._site_property_item = \
          SitePropertyTemplateItem(self.getTemplateSitePropertyIdList())
      self._module_item = \
          ModuleTemplateItem(self.getTemplateModuleIdList())
      self._document_item = \
          DocumentTemplateItem(self.getTemplateDocumentIdList())
      self._property_sheet_item = \
          PropertySheetTemplateItem(self.getTemplatePropertySheetIdList())
3874 3875
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895
      self._extension_item = \
          ExtensionTemplateItem(self.getTemplateExtensionIdList())
      self._test_item = \
          TestTemplateItem(self.getTemplateTestIdList())
      self._product_item = \
          ProductTemplateItem(self.getTemplateProductIdList())
      self._role_item = \
          RoleTemplateItem(self.getTemplateRoleList())
      self._catalog_result_key_item = \
          CatalogResultKeyTemplateItem(
               self.getTemplateCatalogResultKeyList())
      self._catalog_related_key_item = \
          CatalogRelatedKeyTemplateItem(
               self.getTemplateCatalogRelatedKeyList())
      self._catalog_result_table_item = \
          CatalogResultTableTemplateItem(
               self.getTemplateCatalogResultTableList())
      self._message_translation_item = \
          MessageTranslationTemplateItem(
               self.getTemplateMessageTranslationList())
3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907
      self._portal_type_allowed_content_type_item = \
           PortalTypeAllowedContentTypeTemplateItem(
               self.getTemplatePortalTypeAllowedContentTypeList())
      self._portal_type_hidden_content_type_item = \
           PortalTypeHiddenContentTypeTemplateItem(
               self.getTemplatePortalTypeHiddenContentTypeList())
      self._portal_type_property_sheet_item = \
           PortalTypePropertySheetTemplateItem(
               self.getTemplatePortalTypePropertySheetList())
      self._portal_type_base_category_item = \
           PortalTypeBaseCategoryTemplateItem(
               self.getTemplatePortalTypeBaseCategoryList())
3908 3909
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
3910 3911
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
3912 3913
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
3914
               self.getTemplateCatalogKeywordKeyList())
3915 3916
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
3917
               self.getTemplateCatalogFullTextKeyList())
3918 3919
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
3920
               self.getTemplateCatalogRequestKeyList())
3921 3922
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
3923
               self.getTemplateCatalogMultivalueKeyList())
3924 3925 3926
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
3927 3928 3929
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
3930

3931 3932 3933
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
3934

3935
    build = WorkflowMethod(build)
3936 3937

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3938
      """
3939
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3940
      """
3941
      return self.portal_templates.publish(self, url, username=username,
3942
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3943

3944
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3945
      """
3946
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3947
      """
3948
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3949

3950
    def preinstall(self, check_dependencies=1, **kw):
3951 3952 3953
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
3954
      """
3955

3956 3957 3958 3959 3960
      if check_dependencies:
        # required because in multi installation, dependencies has already
        # been checked before and it will failed here as dependencies can be
        # installed at the same time
        self.checkDependencies()
3961

3962 3963
      modified_object_list = {}
      bt_title = self.getTitle()
3964 3965 3966 3967 3968 3969 3970

      #  can be call to diff two Business Template in template tool
      bt2 = kw.get('compare_to', None)
      if  bt2 is not None:
        installed_bt = bt2
      else:
        installed_bt = self.portal_templates.getInstalledBusinessTemplate(title=bt_title)
3971 3972 3973
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3974
        installed_bt_format = installed_bt.getTemplateFormatVersion()
3975

3976
      # if reinstall business template, must compare to object in ZODB
3977
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
3978
      # same if we make a diff and select only one business template
3979
      reinstall = 0
3980 3981
      if installed_bt == self:
        reinstall = 1
3982 3983 3984
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
3985 3986 3987
        bt2.edit(description='tmp bt generated for diff')
        bt2.build()
        installed_bt = bt2
3988

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3989
      new_bt_format = self.getTemplateFormatVersion()
3990 3991 3992 3993 3994 3995
      if installed_bt_format == 0 and new_bt_format == 0:
        # still use old format, so install everything, no choice
        return modified_object_list
      elif installed_bt_format == 0 and new_bt_format == 1:
        # return list of all object in bt
        for item_name in self._item_name_list:
3996
          item = getattr(self, item_name, None)
3997 3998 3999 4000
          if item is not None:
            for path in item._objects.keys():
              modified_object_list.update({path : ['New', item.__class__.__name__[:-12]]})
        return modified_object_list
4001

4002 4003 4004 4005
      # get the list of modified and new object
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
      for item_name in self._item_name_list:
4006
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4007
        old_item = getattr(installed_bt, item_name, None)
4008
        if new_item is not None:
4009
          if old_item is not None and hasattr(old_item, '_objects'):
4010 4011 4012 4013 4014 4015 4016 4017
            modified_object = new_item.preinstall(context=local_configuration, installed_bt=old_item)
            if len(modified_object) > 0:
              modified_object_list.update(modified_object)
          else:
            for path in new_item._objects.keys():
              modified_object_list.update({path : ['New', new_item.__class__.__name__[:-12]]})

      if reinstall:
4018
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4019

4020 4021
      return modified_object_list

4022
    def _install(self, force=1, object_to_update=None, **kw):
4023
      """
Christophe Dumez's avatar
Christophe Dumez committed
4024
        Install a new Business Template, if force, all will be upgraded or installed
4025 4026
        otherwise depends of dict object_to_update
      """
4027 4028 4029 4030
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4031

4032 4033
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
4034
      if installed_bt is not None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4035
        if installed_bt.getTemplateFormatVersion() == 0:
4036
          force = 1
4037
        installed_bt.replace(self)
4038

4039 4040 4041 4042
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4043 4044 4045
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4046

4047 4048 4049
      if not force:
        self.checkDependencies()

4050 4051 4052 4053 4054 4055
      site = self.getPortalObject()
      from Products.ERP5.ERP5Site import ERP5Generator
      gen = ERP5Generator()
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Activity Tool')
4056
        gen.setupLastTools(site, update=1, create_activities=1)
4057 4058
      if not force:
        if len(object_to_update) == 0:
4059 4060 4061 4062 4063
          # check if we have to update tools
          if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
            LOG('Business Template', 0, 'Updating Tools')
            gen.setup(site, 0, update=1)
          if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4064
            LOG('Business Template', 0, 'Updating Business Template Workflows')
4065
            gen.setupWorkflow(site)
4066
          return
4067 4068 4069 4070

      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
4071
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4072

4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085
      # always created a trash bin because we may to save object already present
      # but not in a previous business templates apart at creation of a new site
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates.objectIds()) > 1):
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
      if len(object_to_update) > 0 or force:
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
            item.install(local_configuration, force=force, object_to_update=object_to_update, trashbin=trashbin)
4086

4087 4088 4089
      # update catalog if necessary
      update_catalog=0
      catalog_method = getattr(self, '_catalog_method_item', None)
4090 4091 4092
      if catalog_method is not None and self.getTemplateFormatVersion() == 1 \
        and _getCatalogValue(self) is self.getPortalObject().portal_catalog.getSQLCatalog():
        # It is needed to update the catalog only if the default SQLCatalog is modified.
4093 4094 4095 4096 4097 4098 4099 4100 4101
        for id in catalog_method._objects.keys():
          if id in object_to_update.keys() or force:
            if not force:
              action = object_to_update[id]
              if action == 'nothing':
                continue
            if 'related' not in id:
              # must update catalog
              update_catalog = 1
4102
              break
4103
      if update_catalog:
4104
        catalog = _getCatalogValue(self)
4105
        if (catalog is None) or (not site.isIndexable):
4106 4107 4108 4109 4110
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4111

4112
      # get objects to remove
4113
      # do remove after because we may need backup object from installation
4114 4115 4116 4117 4118 4119
      remove_object_dict = {}
      for path in object_to_update.keys():
        action = object_to_update[path]
        if action == 'remove' or action == 'save_and_remove':
          remove_object_dict[path] = action
          object_to_update.pop(path)
4120

4121 4122 4123
      # remove object from old business template
      if len(remove_object_dict) > 0:
        for item_name in installed_bt._item_name_list:
4124
          item = getattr(installed_bt, item_name, None)
4125 4126
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
4127

4128 4129 4130 4131 4132 4133

      # update tools if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Tools')
        gen.setup(site, 0, update=1)

4134
      # check if we have to update business template workflow
4135
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4136
        LOG('Business Template', 0, 'Updating Business Template Workflows')
4137 4138 4139 4140 4141
        gen.setupWorkflow(site)
        # XXX keep TM in case update of workflow doesn't work
        #         self._v_txn = WorkflowUpdateTM()
        #         self._v_txn.register(update=1, gen=gen, site=site)

4142 4143 4144 4145 4146
      # remove trashbin if empty
      if trashbin is not None:
        if len(trashbin.objectIds()) == 0:
          trash_tool.manage_delObjects([trashbin.getId(),])

4147 4148
      if update_catalog:
        site.ERP5Site_reindexAll()
4149

4150 4151 4152
      # Update translation table, in case we added new portal types or
      # workflow states.
      site.ERP5Site_updateTranslationTable()
4153

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4154 4155 4156
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
4157

4158
    security.declareProtected(Permissions.ManagePortal, 'install')
4159 4160 4161
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4162
      """
4163
      return self._install(**kw)
4164

4165
    install = WorkflowMethod(install)
4166

4167
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4168
    def reinstall(self, **kw):
4169 4170 4171 4172
      """Reinstall Business Template.
      """
      return self._install(**kw)

4173
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4174

4175
    security.declareProtected(Permissions.ManagePortal, 'trash')
4176 4177
    def trash(self, new_bt, **kw):
      """
4178
        Trash unnecessary items before upgrading to a new business
4179
        template.
4180
        This is similar to uninstall, but different in that this does
4181
        not remove all items.
4182 4183 4184 4185 4186
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4187 4188
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4189
        item = getattr(self, item_name, None)
4190 4191 4192 4193
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
4194

4195
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
4196
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4197
      """
4198
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4199
      """
4200 4201 4202 4203
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4204 4205 4206
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4207
        item = getattr(self, item_name, None)
4208 4209
        if item is not None:
          item.uninstall(local_configuration)
4210
      # It is better to clear cache because the uninstallation of a
4211
      # template deletes many things from the portal.
4212
      clearCache()
4213

4214 4215
    uninstall = WorkflowMethod(uninstall)

4216
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4217
    def _clean(self):
4218
      """
4219
        Clean built information.
4220
      """
4221
      # First, remove obsolete attributes if present.
4222 4223 4224 4225
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4226
                    '_module_archive',
4227 4228 4229
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4230
                    '_property_sheet_archive'):
4231 4232 4233
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4234 4235
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4236

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4237
    clean = WorkflowMethod(_clean)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4238

4239
    security.declareProtected(Permissions.AccessContentsInformation,
4240
                              'getBuildingState')
4241
    def getBuildingState(self, default=None, id_only=1):
4242
      """
4243
        Returns the current state in building
4244
      """
4245
      portal_workflow = getToolByName(self, 'portal_workflow')
4246 4247
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4248
      return wf._getWorkflowStateOf(self, id_only=id_only )
4249

4250
    security.declareProtected(Permissions.AccessContentsInformation,
4251
                              'getInstallationState')
4252
    def getInstallationState(self, default=None, id_only=1):
4253
      """
4254
        Returns the current state in installation
4255
      """
4256
      portal_workflow = getToolByName(self, 'portal_workflow')
4257 4258
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4259
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4260

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4261 4262 4263 4264 4265 4266
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4267
      export_string = portal_templates.manage_exportObject(
4268 4269
                                               id=self.getId(),
                                               toxml=1,
4270
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4271
      return export_string
4272

4273
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4274
      """
4275 4276
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4277
      """
4278
      result = getattr(self, id, ())
4279 4280 4281 4282
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4283
        # XXX Why do we need to return a tuple ?
4284 4285
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4286

4287
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4288
      """
4289 4290
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4291
      """
4292
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4293

4294
    def getTemplateBaseCategoryList(self):
4295
      """
4296 4297
      We have to set this method because we want an
      ordered list
4298
      """
4299
      return self._getOrderedList('template_base_category')
4300

4301
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4302
      """
4303 4304
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4305
      """
4306
      return self._getOrderedList('template_workflow_id')
4307

4308
    def getTemplatePortalTypeIdList(self):
4309
      """
4310 4311
      We have to set this method because we want an
      ordered list
4312
      """
4313
      return self._getOrderedList('template_portal_type_id')
4314

4315 4316 4317 4318 4319 4320 4321
    def getTemplatePortalTypeWorkflowChainList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_workflow_chain')

Alexandre Boeglin's avatar
Alexandre Boeglin committed
4322 4323 4324 4325 4326 4327 4328
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

4329 4330 4331 4332 4333 4334 4335
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

4336 4337 4338 4339 4340 4341
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4342

4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363
    def getTemplatePortalTypeHiddenContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_hidden_content_type')

    def getTemplatePortalTypePropertySheetList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_property_sheet')

    def getTemplatePortalTypeBaseCategoryList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_base_category')

4364
    def getTemplateActionPathList(self):
4365
      """
4366 4367
      We have to set this method because we want an
      ordered list
4368
      """
4369
      return self._getOrderedList('template_action_path')
4370

4371 4372 4373 4374 4375 4376 4377
    def getTemplatePortalTypeRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_roles')

4378
    def getTemplateSkinIdList(self):
4379
      """
4380 4381
      We have to set this method because we want an
      ordered list
4382
      """
4383
      return self._getOrderedList('template_skin_id')
4384

4385
    def getTemplateModuleIdList(self):
4386
      """
4387 4388
      We have to set this method because we want an
      ordered list
4389
      """
4390
      return self._getOrderedList('template_module_id')
4391 4392 4393 4394 4395 4396 4397

    def getTemplateMessageTranslationList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_message_translation')
4398

4399
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
4400 4401 4402 4403
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
4404
      if self.getBuildingState() != 'built':
4405
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
4406
              'Business Template must be built before export'
4407 4408 4409
      if self.getInstallationState() == 'installed':
        raise TemplateConditionError, \
              'Can not export installed Business Template'
4410

Aurel's avatar
Aurel committed
4411 4412 4413 4414 4415 4416 4417
      if local:
        # we export into a folder tree
        bta = BusinessTemplateFolder(creation=1, path=path)
      else:
        # We export BT into a tarball file
        bta = BusinessTemplateTarball(creation=1, path=path)

4418
      # export bt
4419
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
4420
      for prop in self.propertyMap():
4421
        prop_type = prop['type']
Aurel's avatar
Aurel committed
4422
        id = prop['id']
4423
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
4424
                  'install_object_list_list', 'id_generator'):
4425
          continue
Aurel's avatar
Aurel committed
4426
        value = self.getProperty(id)
4427
        if prop_type in ('text', 'string', 'int', 'boolean'):
4428
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
4429
        elif prop_type in ('lines', 'tokens'):
4430
          bta.addObject(obj=str(os.linesep).join(value), name=id,
4431
                        path=path+os.sep+'bt', ext='')
4432

Aurel's avatar
Aurel committed
4433 4434 4435
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
4436

Aurel's avatar
Aurel committed
4437 4438
      return bta.finishCreation()

4439
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
4440 4441
    def importFile(self, dir = 0, file=None, root_path=None):
      """
4442
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
4443 4444 4445 4446 4447
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
4448

Aurel's avatar
Aurel committed
4449 4450
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4451
      self._portal_type_workflow_chain_item = \
4452
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
4453 4454 4455 4456 4457 4458 4459 4460 4461 4462
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4463 4464
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
4465 4466 4467 4468 4469 4470 4471 4472
      self._site_property_item = \
          SitePropertyTemplateItem(self.getTemplateSitePropertyIdList())
      self._module_item = \
          ModuleTemplateItem(self.getTemplateModuleIdList())
      self._document_item = \
          DocumentTemplateItem(self.getTemplateDocumentIdList())
      self._property_sheet_item = \
          PropertySheetTemplateItem(self.getTemplatePropertySheetIdList())
4473 4474
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496
      self._extension_item = \
          ExtensionTemplateItem(self.getTemplateExtensionIdList())
      self._test_item = \
          TestTemplateItem(self.getTemplateTestIdList())
      self._product_item = \
          ProductTemplateItem(self.getTemplateProductIdList())
      self._role_item = \
          RoleTemplateItem(self.getTemplateRoleList())
      self._catalog_result_key_item = \
          CatalogResultKeyTemplateItem(
               self.getTemplateCatalogResultKeyList())
      self._catalog_related_key_item = \
          CatalogRelatedKeyTemplateItem(
               self.getTemplateCatalogRelatedKeyList())
      self._catalog_result_table_item = \
          CatalogResultTableTemplateItem(
               self.getTemplateCatalogResultTableList())
      self._message_translation_item = \
          MessageTranslationTemplateItem(
               self.getTemplateMessageTranslationList())
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4497 4498
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512
      self._portal_type_allowed_content_type_item = \
           PortalTypeAllowedContentTypeTemplateItem(
               self.getTemplatePortalTypeAllowedContentTypeList())
      self._portal_type_hidden_content_type_item = \
           PortalTypeHiddenContentTypeTemplateItem(
               self.getTemplatePortalTypeHiddenContentTypeList())
      self._portal_type_property_sheet_item = \
           PortalTypePropertySheetTemplateItem(
               self.getTemplatePortalTypePropertySheetList())
      self._portal_type_base_category_item = \
           PortalTypeBaseCategoryTemplateItem(
               self.getTemplatePortalTypeBaseCategoryList())
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4513
               self.getTemplateCatalogKeywordKeyList())
4514 4515
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4516
               self.getTemplateCatalogFullTextKeyList())
4517 4518
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4519
               self.getTemplateCatalogRequestKeyList())
4520 4521
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4522
               self.getTemplateCatalogMultivalueKeyList())
4523 4524 4525
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4526 4527 4528
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
4529

Aurel's avatar
Aurel committed
4530 4531
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4532

4533 4534 4535 4536 4537 4538
    #By christophe Dumez <christophe@nexedi.com>
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
4539 4540 4541
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
4542
      return items_list
4543

4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556
    #By christophe Dumez <christophe@nexedi.com>
    def checkDependencies(self):
      """
       Check if all the dependencies of the business template
       are installed. Raise an exception with the list of
       missing dependencies if some are missing
      """
      missing_dep_list = []
      dependency_list = self.getDependencyList()
      if len(dependency_list)!=0:
        for dependency_couple in dependency_list:
          dependency_couple_list = dependency_couple.split(' ')
          dependency = dependency_couple_list[0]
4557 4558
          if dependency in (None, ''):
            continue
4559 4560 4561 4562 4563 4564
          version_restriction = None
          if len(dependency_couple_list) > 1:
            version_restriction = dependency_couple_list[1][1:-1]
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
4565
                  or (version_restriction not in (None, '') and
4566 4567 4568 4569
                     (not self.portal_templates.compareVersionStrings(installed_bt.getVersion(), version_restriction)))):
            missing_dep_list.append((dependency, version_restriction or ''))
      if len(missing_dep_list) != 0:
        raise BusinessTemplateMissingDependency, 'Impossible to install, please install the following dependencies before: %s'%repr(missing_dep_list)
4570

Aurel's avatar
Aurel committed
4571
    def diffObject(self, REQUEST, **kw):
4572 4573
      """
        Make a diff between an object in the Business Template
4574
        and the same in the Business Template installed in the site
4575 4576 4577 4578
      """

      class_name_dict = {
        'Product' : '_product_item',
4579
        'PropertySheet' : '_property_sheet_item',
4580
        'Constraint' : '_constraint_item',
4581 4582 4583 4584 4585 4586 4587 4588 4589
        'Document' : '_document_item',
        'Extension' : '_extension_item',
        'Test' : '_test_item',
        'Role' : '_role_item',
        'MessageTranslation' : '_message_translation_item',
        'Workflow' : '_workflow_item',
        'CatalogMethod' : '_catalog_method_item',
        'SiteProperty' : '_site_property_item',
        'PortalType' : '_portal_type_item',
4590
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
4591 4592 4593 4594
        'PortalTypeAllowedContentType' : '_portal_type_allowed_content_type_item',
        'PortalHiddenAllowedContentType' : '_portal_type_hidden_content_type_item',
        'PortalTypePropertySheet' : '_portal_type_property_sheet_item',
        'PortalTypeBaseCategory' : '_portal_type_base_category_item',
4595 4596 4597 4598
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
4599
        'Preference' : '_preference_item',
4600
        'Action' : '_action_item',
4601
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4602
        'LocalRoles' : '_local_roles_item',
4603 4604 4605
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4606 4607 4608 4609 4610
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
        'CatalogFullTextKey' : '_catalog_full_text_key_item',
        'CatalogRequestKey' : '_catalog_request_key_item',
        'CatalogMultivalueKey' : '_catalog_multivalue_key_item',
        'CatalogTopicKey' : '_catalog_topic_key_item',
4611
        }
4612

4613 4614
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
4615

Christophe Dumez's avatar
Christophe Dumez committed
4616
      # Get objects
4617
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4618

Aurel's avatar
Aurel committed
4619
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
4620
      # Compare with a given business template
4621
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
4622 4623
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
4624 4625
        if bt2_id == self.getId():
          compare_to_zodb = 1
4626
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
4627 4628
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
4629 4630 4631
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
4632 4633 4634
          compare_to_zodb = 1
      if compare_to_zodb:
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
Christophe Dumez's avatar
Christophe Dumez committed
4635
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
4636 4637 4638
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
4639

4640 4641
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
4642
      if compare_to_zodb:
Aurel's avatar
Aurel committed
4643
        # XXX maybe only build for the given object to gain time
4644
        installed_item.build(self)
4645 4646 4647
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
4648

Christophe Dumez's avatar
Christophe Dumez committed
4649
      # Real Zope Objects (can be exported into XML directly by Zope)
4650 4651
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
4652
                     '_category_item', '_path_item', '_preference_tem',
Christophe Dumez's avatar
Christophe Dumez committed
4653
                     '_skin_item', '_action_item',]
4654

Christophe Dumez's avatar
Christophe Dumez committed
4655
      # Not considered as objects by Zope (will be exported into XML manually)
4656
      # XXX Bad naming
4657
      item_list_2 = ['_site_property_item', '_module_item',
4658
                     '_catalog_result_key_item', '_catalog_related_key_item',
4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
                     '_portal_type_allowed_content_type_item',
                     '_portal_type_hidden_content_type_item',
                     '_portal_type_property_sheet_item',
                     '_portal_type_roles_item',
                     '_portal_type_base_category_item',
                     '_local_roles_item',
4671
                     '_portal_type_workflow_chain_item',]
4672

Christophe Dumez's avatar
Christophe Dumez committed
4673
      # Text objects (no need to export them into XML)
4674
      # XXX Bad naming
4675 4676
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
4677
                     '_test_item', '_message_translation_item',]
4678

4679
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
4680 4681 4682
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
4683 4684
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
4685
        # XML Export in memory
4686 4687 4688
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
        OFS.XMLExportImport.exportXML(installed_object._p_jar, installed_object._p_oid, f2)
        new_obj_xml = f1.getvalue()
4689
        f1.close()
4690 4691 4692 4693
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
4694
        # End of XML export
4695

4696
        # Diff between XML objects
4697 4698
        diff_list = list(unified_diff(installed_ob_xml_lines, new_ob_xml_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
Christophe Dumez's avatar
Christophe Dumez committed
4699
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4700 4701 4702
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4703

4704
      elif item_name in item_list_2:
4705
        # Generate XML code manually
4706 4707
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
4708 4709
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
4710
        # End of XML Code Generation
4711

4712
        # Diff between XML objects
4713 4714
        diff_list = list(unified_diff(installed_obj_xml_lines, new_obj_xml_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
Christophe Dumez's avatar
Christophe Dumez committed
4715
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4716 4717 4718
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4719

4720
      elif item_name in item_list_3:
4721
        # Diff between text objects
4722 4723 4724 4725
        new_obj_lines = new_object.splitlines()
        installed_obj_lines = installed_object.splitlines()
        diff_list = list(unified_diff(installed_obj_lines, new_obj_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
Christophe Dumez's avatar
Christophe Dumez committed
4726
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4727 4728
          diff_msg += '\n'.join(diff_list)
        else:
4729
          diff_msg = 'No diff'
4730

Christophe Dumez's avatar
Christophe Dumez committed
4731
      else: # Added By <christophe@nexedi.com>
4732
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
4733

4734 4735
      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4736

4737
      return diff_msg
4738

4739

4740 4741 4742 4743
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
4744 4745
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
4746 4747 4748 4749 4750 4751 4752
      bt_allowed_content_type_list = list(getattr(self, 'template_portal_type_allowed_content_type', []) or [])
      bt_hidden_content_type_list = list(getattr(self, 'template_portal_type_hidden_content_type', []) or [])
      bt_property_sheet_list = list(getattr(self, 'template_portal_type_property_sheet', []) or [])
      bt_base_category_list = list(getattr(self, 'template_portal_type_base_category', []) or [])
      bt_action_list = list(getattr(self, 'template_action_path', []) or [])
      bt_portal_types_id_list = list(self.getTemplatePortalTypeIdList())
      bt_portal_type_roles_list =  list(getattr(self, 'template_portal_type_roles', []) or [])
4753 4754
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

4755
      p = self.getPortalObject()
4756
      for id in bt_portal_types_id_list:
4757 4758
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
4759
          continue
4760
        if len(getattr(portal_type, '_roles', ())) > 0:
4761 4762
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
4763

4764 4765 4766 4767
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
4768
        action_list = []
4769 4770 4771 4772 4773 4774 4775
        if hasattr(portal_type, 'allowed_content_types'):
          allowed_content_type_list = portal_type.allowed_content_types
        if hasattr(portal_type, 'hidden_content_type_list'):
          hidden_content_type_list = portal_type.hidden_content_type_list
        if hasattr(portal_type, 'property_sheet_list'):
          property_sheet_list = portal_type.property_sheet_list
        if hasattr(portal_type, 'base_category_list'):
4776
          base_category_list = portal_type.base_category_list
4777 4778
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
4779

4780 4781 4782 4783
        for a_id in allowed_content_type_list:
          allowed_id = id+' | '+a_id
          if allowed_id not in bt_allowed_content_type_list:
            bt_allowed_content_type_list.append(allowed_id)
4784

4785
        for h_id in hidden_content_type_list:
4786 4787 4788
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
4789

4790 4791 4792 4793
        for ps_id in property_sheet_list:
          p_sheet_id = id+' | '+ps_id
          if p_sheet_id not in bt_property_sheet_list:
            bt_property_sheet_list.append(p_sheet_id)
4794

4795 4796 4797 4798
        for bc_id in base_category_list:
          base_cat_id = id+' | '+bc_id
          if base_cat_id not in bt_base_category_list:
            bt_base_category_list.append(base_cat_id)
4799

4800 4801 4802 4803
        for act_id in action_list:
          action_id = id+' | '+act_id
          if action_id not in bt_action_list:
            bt_action_list.append(action_id)
4804

4805
        for workflow_id in [chain for chain in wtool.getChainFor(id)
4806
                                    if chain != '(Default)']:
4807 4808 4809
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
4810

4811 4812 4813 4814
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
4815
      bt_action_list.sort()
4816
      bt_wf_chain_list.sort()
4817

4818 4819 4820 4821 4822 4823 4824
      self.setProperty('template_portal_type_workflow_chain', bt_wf_chain_list)
      self.setProperty('template_portal_type_roles', bt_portal_type_roles_list)
      self.setProperty('template_portal_type_allowed_content_type', bt_allowed_content_type_list)
      self.setProperty('template_portal_type_hidden_content_type', bt_hidden_content_type_list)
      self.setProperty('template_portal_type_property_sheet', bt_property_sheet_list)
      self.setProperty('template_portal_type_base_category', bt_base_category_list)
      self.setProperty('template_action_path', bt_action_list)
4825 4826 4827 4828 4829 4830 4831 4832 4833
      return


    def guessPortalTypes(self, **kw):
      """
      This method guesses portal types based on modules define in the Business Template
      """
      bt_module_id_list = list(self.getTemplateModuleIdList())
      if len(bt_module_id_list) == 0:
4834 4835
        raise TemplateConditionError, 'No module defined in business template'

4836 4837 4838 4839 4840 4841 4842 4843
      bt_portal_types_id_list = list(self.getTemplatePortalTypeIdList())

      def getChildPortalType(type_id):
        type_list = {}
        p = self.getPortalObject()
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+type_id)
        except KeyError:
4844
          return type_list
4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858

        allowed_content_type_list = []
        hidden_content_type_list = []
        if hasattr(portal_type, 'allowed_content_types'):
          allowed_content_type_list = portal_type.allowed_content_types
        if hasattr(portal_type, 'hidden_content_type_list'):
          hidden_content_type_list = portal_type.hidden_content_type_list
        type_list[type_id] = ()
        # get same info for allowed portal types and hidden portal types
        for allowed_ptype_id in allowed_content_type_list:
          if allowed_ptype_id not in type_list.keys():
            type_list.update(getChildPortalType(allowed_ptype_id))
        for hidden_ptype_id in hidden_content_type_list:
          if hidden_ptype_id not in type_list.keys():
4859
            type_list.update(getChildPortalType(hidden_ptype_id))
4860
        return type_list
4861

4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908
      p = self.getPortalObject()
      portal_dict = {}
      for module_id in bt_module_id_list:
        module = p.unrestrictedTraverse(module_id)
        portal_type_id = module.getPortalType()
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+portal_type_id)
        except KeyError:
          continue
        allowed_content_type_list = []
        hidden_content_type_list = []
        if hasattr(portal_type, 'allowed_content_types'):
          allowed_content_type_list = portal_type.allowed_content_types
        if hasattr(portal_type, 'hidden_content_type_list'):
          hidden_content_type_list = portal_type.hidden_content_type_list

        portal_dict[portal_type_id] = ()

        for allowed_type_id in allowed_content_type_list:
          if allowed_type_id not in portal_dict.keys():
            portal_dict.update(getChildPortalType(allowed_type_id))

        for hidden_type_id in hidden_content_type_list:
          if hidden_type_id not in portal_dict.keys():
            portal_dict.update(getChildPortalType(hidden_type_id))

      # construct portal type list, keep already present portal types
      for id in portal_dict.keys():
        if id not in bt_portal_types_id_list:
          bt_portal_types_id_list.append(id)

      bt_portal_types_id_list.sort()

      setattr(self, 'template_portal_type_id', bt_portal_types_id_list)
      return

    def clearPortalTypes(self, **kw):
      """
      clear id list register for portal types
      """
      setattr(self, 'template_portal_type_id', ())
      setattr(self, 'template_portal_type_allowed_content_type', ())
      setattr(self, 'template_portal_type_hidden_content_type', ())
      setattr(self, 'template_portal_type_property_sheet', ())
      setattr(self, 'template_portal_type_base_category', ())
      return

4909 4910 4911
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
4912
  setattr(BusinessTemplate, key, None)
4913

4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940
# Transaction Manager used for update of business template workflow
# XXX update seems to works without it

# from Shared.DC.ZRDB.TM import TM

# class WorkflowUpdateTM(TM):

#   _p_oid=_p_changed=_registered=None
#   _update = 0

#   def __init__(self, ):
#     LOG('init TM', 0, '')

#   def register(self, update=0, gen=None, site=None):
#     LOG('register TM', 0, update)
#     self._gen = gen
#     self._site = site
#     self._update = update
#     self._register()

#   def tpc_prepare(self, *d, **kw):
#     LOG("tpc_prepare", 0, self._update)
#     if self._update:
#       # do it one time
#       self._update = 0
#       LOG('call update of wf', 0, '')
#       self._gen.setupWorkflow(self._site)
4941

4942 4943 4944 4945 4946 4947 4948 4949

#   def _finish(self, **kw):
#     LOG('finish TM', 0, '')
#     pass

#   def _abort(self, **kw):
#     LOG('abort TM', 0, '')
#     pass
4950