BusinessTemplate.py 210 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
import sys
30
from Shared.DC.ZRDB.Connection import Connection as RDBConnection
31
from Globals import Persistent, PersistentMapping
32
from Acquisition import Implicit, aq_base
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33 34
from AccessControl import ClassSecurityInfo
from Products.CMFCore.utils import getToolByName
35
from Products.ERP5Type.Base import WorkflowMethod, _aq_reset
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
from Products.ERP5Type.Utils import readLocalDocument, \
                                    writeLocalDocument, \
                                    importLocalDocument, \
                                    removeLocalDocument
from Products.ERP5Type.Utils import readLocalPropertySheet, \
                                    writeLocalPropertySheet, \
                                    importLocalPropertySheet, \
                                    removeLocalPropertySheet
from Products.ERP5Type.Utils import readLocalConstraint, \
                                    writeLocalConstraint, \
                                    importLocalConstraint, \
                                    removeLocalConstraint
from Products.ERP5Type.Utils import readLocalExtension, \
                                    writeLocalExtension, \
                                    removeLocalExtension
from Products.ERP5Type.Utils import readLocalTest, \
                                    writeLocalTest, \
                                    removeLocalTest
54
from Products.ERP5Type import Permissions, PropertySheet
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
58
import re, os
Aurel's avatar
Aurel committed
59
from OFS.Traversable import NotFound
60 61
from OFS import XMLExportImport
from cStringIO import StringIO
Aurel's avatar
Aurel committed
62
from copy import deepcopy
63
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
64 65 66 67
import OFS.XMLExportImport
customImporters={
    XMLExportImport.magic: XMLExportImport.importXML,
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
68

69
from zLOG import LOG, WARNING, PROBLEM
70
from warnings import warn
Aurel's avatar
Aurel committed
71 72
from OFS.ObjectManager import customImporters
from gzip import GzipFile
73
from xml.dom.minidom import parse
74
from xml.sax.saxutils import escape
75
from Products.CMFCore.Expression import Expression
Aurel's avatar
Aurel committed
76
import tarfile
77
from urllib import quote, unquote
78
from difflib import unified_diff
79
import posixpath
80
import shutil
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
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'

95 96 97 98 99 100
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:
101 102 103 104
    try:
      return acquisition_context.getPortalObject().portal_catalog.objectIds('SQLCatalog')[0]
    except IndexError:
      return None
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
  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

124 125 126 127 128
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.
  """
129 130
  if hasattr(aq_base(obj), 'uid'):
    obj.uid = None
131 132 133
  for subobj in obj.objectValues():
    _recursiveRemoveUid(subobj)

134
def removeAll(entry):
135 136 137
  warn('removeAll is deprecated; use shutil.rmtree instead.',
       DeprecationWarning)
  shutil.rmtree(entry, True)
Aurel's avatar
Aurel committed
138

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
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)

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
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
183 184 185
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
186
  """
Aurel's avatar
Aurel committed
187 188 189 190 191 192 193 194 195 196 197 198

  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
199

Aurel's avatar
Aurel committed
200 201 202 203 204
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
205
    Class archiving business template into a folder tree
206
  """
Aurel's avatar
Aurel committed
207 208 209 210 211 212
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
213
      shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
214 215 216
      os.makedirs(self.path)

  def addFolder(self, name=''):
Jérome Perrin's avatar
Jérome Perrin committed
217
    if name != '':
218
      name = os.path.normpath(name)
Aurel's avatar
Aurel committed
219
      path = os.path.join(self.path, name)
220
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
221 222 223
        os.makedirs(path)
      return path

224
  def addObject(self, obj, name, path=None, ext='.xml'):
225 226 227
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
228 229 230
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
231
      if '%' not in path:
232 233 234 235
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
Aurel's avatar
Aurel committed
236
      object_path = os.path.join(path, name)
237
    f = open(object_path+ext, 'wb')
238
    f.write(str(obj))
Aurel's avatar
Aurel committed
239 240 241
    f.close()

  def _initImport(self, file=None, path=None, **kw):
242
    # Normalize the paths to eliminate the effect of double-slashes.
243 244 245 246 247 248 249 250
    root_path_len = len(os.path.normpath(path)) + len(os.sep)
    self.root_path_len = root_path_len
    d = {}
    for f in file:
      f = os.path.normpath(f)
      klass = f[root_path_len:].split(os.sep, 1)[0]
      d.setdefault(klass, []).append(f)
    self.file_list_dict = d
Aurel's avatar
Aurel committed
251

252
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
253 254 255
    """
      Import file from a local folder
    """
256
    class_name = item.__class__.__name__
257 258 259 260 261 262 263
    root_path_len = self.root_path_len
    prefix_len = root_path_len + len(class_name) + len(os.sep)
    for file_path in self.file_list_dict.get(class_name, ()):
      if os.path.isfile(file_path):
        file = open(file_path, 'rb')
        try:
          file_name = file_path[prefix_len:]
264
          if '%' in file_name:
265
            file_name = unquote(file_name)
266
          item._importFile(file_name, file)
267
        finally:
268
          file.close()
269

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

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

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

293
  def addObject(self, obj, name, path=None, ext='.xml'):
294 295 296
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
297 298 299
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
300
      if '%' not in path:
301 302 303 304
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
Aurel's avatar
Aurel committed
305
      object_path = os.path.join(path, name)
306
    f = open(object_path+ext, 'wb')
307
    f.write(str(obj))
Aurel's avatar
Aurel committed
308 309 310 311 312
    f.close()

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
313
    shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
314 315 316 317 318
    return self.fobj

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

319
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
320 321
    """
      Import all file from the archive to the site
322
    """
323
    class_name = item.__class__.__name__
Aurel's avatar
Aurel committed
324 325 326 327 328
    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
329 330
      if 'CVS' in info.name.split('/'):
        continue
Yoshinori Okuji's avatar
Yoshinori Okuji committed
331 332
      if '.svn' in info.name.split('/'):
        continue
333
      if class_name in info.name.split('/'):
Aurel's avatar
Aurel committed
334 335
        if info.isreg():
          file = tar.extractfile(info)
336 337
          tar_file_name = info.name.startswith('./') and info.name[2:] or \
              info.name
338
          folders = tar_file_name.split('/')
339
          file_name = ('/').join(folders[2:])
340
          if '%' in file_name:
341
            file_name = unquote(file_name)
342
          item._importFile(file_name, file)
Aurel's avatar
Aurel committed
343 344 345
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
346

347
class TemplateConditionError(Exception): pass
348
class TemplateConflictError(Exception): pass
349
class BusinessTemplateMissingDependency(Exception): pass
350

351
class BaseTemplateItem(Implicit, Persistent):
352
  """
353
    This class is the base class for all template items.
354
    is_bt_for_diff means This BT is used to compare self temporary BT with installed BT
355
  """
356
  is_bt_for_diff = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
357

358
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
359
    self.__dict__.update(kw)
360
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
361
    self._objects = PersistentMapping()
362
    for id in id_list:
363 364
      if id is not None and id != '':
        self._archive[id] = None
365 366 367 368

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

369
  def preinstall(self, context, installed_bt, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
370 371 372 373 374 375 376 377
    """
      Build a list of added/removed/changed files between the BusinessTemplate
      being installed (self) and the installed one (installed_bt).
      Note : we compare files between BTs, *not* between the installed BT and
      the objects in the DataFS.

      XXX: -12 used here is -len('TemplateItem')
    """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
378 379
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
380
      new_keys = self._objects.keys()
381
      for path in new_keys:
382
        if installed_bt._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
383
          # compare objects to see it there are changes
384 385
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
386 387
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
388
          # else, compared versions are identical, don't overwrite the old one
389 390
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
391
      # list removed objects
392 393 394 395 396 397 398
      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):
399
    pass
400 401 402

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

404
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
405 406 407 408 409 410
    """
      If 'remove' is chosen on an object containing subobjects, all the
      subobjects will be removed too, even if 'backup' or 'keep' was chosen for
      the subobjects.
      Likewise, for 'save_and_remove' : subobjects will get saved too.
    """
411 412 413
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
414
    keys.reverse()
415 416 417 418 419 420 421 422 423 424 425
    # 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)
426

427

428 429 430 431
  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
432
  def export(self, context, bta, **kw):
433
    pass
Aurel's avatar
Aurel committed
434

435 436
  def getKeys(self):
    return self._objects.keys()
437

Aurel's avatar
Aurel committed
438
  def importFile(self, bta, **kw):
439
    bta.importFiles(item=self)
440

441 442 443
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
444
    """
445 446
    _marker = []
    base_obj = aq_base(obj)
447

448
    if getattr(base_obj, '_dav_writelocks', _marker) is not _marker:
449
      del aq_base(obj)._dav_writelocks
450
    if getattr(base_obj, '__ac_local_roles__', _marker) is not _marker:
451 452
      # remove local roles
      obj.__ac_local_roles__ = None
453
    if getattr(base_obj, '_owner', _marker) is not _marker:
454
      obj._owner = None
455
    if getattr(base_obj, 'uid', _marker) is not _marker:
456
      obj.uid = None
457
    if getattr(base_obj, '_filepath', _marker) is not _marker:
458
      obj._filepath = None
459 460 461
    if getattr(base_obj, 'workflow_history', _marker) is not _marker:
      if getattr(base_obj.__class__, 'workflow_history', _marker) \
          is not _marker:
462 463 464
        obj.workflow_history = None
      else:
        del obj.workflow_history
465 466
    if getattr(base_obj, 'meta_type', None) == 'Script (Python)':
      if getattr(base_obj, '_code', _marker) is not _marker:
467
        obj._code = None
468
      if getattr(base_obj, 'Python_magic', _marker) is not _marker:
469
        obj.Python_magic = None
470
    elif getattr(base_obj, 'meta_type', None) == 'ERP5 PDF Form' :
471 472
      if not obj.getProperty('business_template_include_content', 1) :
        obj.deletePdfContent()
473 474
    return obj

475 476 477
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
478
  """
479

480 481 482 483
  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()
484
      self._archive.clear()
485 486 487
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
488

489
  def export(self, context, bta, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
490 491 492 493
    """
      Export the business template : fill the BusinessTemplateArchive with
      objects exported as XML, hierarchicaly organised.
    """
494 495 496
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
Vincent Pelletier's avatar
Vincent Pelletier committed
497
    for key, obj in self._objects.iteritems():
498
      # create folder and subfolders
499
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
500 501 502
      encode_folders = []
      for folder in folders.split('/'):
        if '%' not in folder:
503
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
504 505 506
        else:
          encode_folders.append(folder)
      path = os.path.join(root_path, (os.sep).join(encode_folders))
507 508 509
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
510 511
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
512

Aurel's avatar
Aurel committed
513
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
514
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
515 516 517
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
518
      relative_url = '/'.join([url,id])
519 520
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
521
      obj = self.removeProperties(obj)
Vincent Pelletier's avatar
Vincent Pelletier committed
522 523 524
      id_list = obj.objectIds() # FIXME duplicated variable name
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
525
        groups = deepcopy(obj.groups)
526
      if id_list:
Aurel's avatar
Aurel committed
527
        self.build_sub_objects(context, id_list, relative_url)
528
        for id_ in list(id_list):
529
          obj._delObject(id_)
530
      if hasattr(aq_base(obj), 'groups'):
531 532 533
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
534 535
    return sub_list

536 537 538 539
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
540 541 542 543
      try:
        obj = p.unrestrictedTraverse(relative_url)
      except ValueError:
        raise ValueError, "Can not access to %s" % relative_url
544 545 546 547
      try:
        obj = obj._getCopy(context)
      except AttributeError:
        raise AttributeError, "Could not find object '%s' during business template processing." % relative_url
548
      _recursiveRemoveUid(obj)
549
      obj = self.removeProperties(obj)
550
      id_list = obj.objectIds()
Vincent Pelletier's avatar
Vincent Pelletier committed
551 552
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
553
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
554 555
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
556
        for id_ in list(id_list):
557
          obj._delObject(id_)
558
      if hasattr(aq_base(obj), 'groups'):
559 560 561
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
562

563 564 565 566
  def _compileXML(self, file):
      name, ext = os.path.splitext(file.name)
      compiled_file = name + '.zexp'
      if not os.path.exists(compiled_file) or os.path.getmtime(file.name) > os.path.getmtime(compiled_file):
567
          LOG('Business Template', 0, 'Compiling %s to %s...' % (file.name, compiled_file))
568
          try:
569
              from Shared.DC.xml import ppml
570
              from OFS.XMLExportImport import start_zopedata, save_record, save_zopedata
571
              import pyexpat
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
              outfile=open(compiled_file, 'wb')
              try:
                  data=file.read()
                  F=ppml.xmlPickler()
                  F.end_handlers['record'] = save_record
                  F.end_handlers['ZopeData'] = save_zopedata
                  F.start_handlers['ZopeData'] = start_zopedata
                  F.binary=1
                  F.file=outfile
                  p=pyexpat.ParserCreate()
                  p.CharacterDataHandler=F.handle_data
                  p.StartElementHandler=F.unknown_starttag
                  p.EndElementHandler=F.unknown_endtag
                  r=p.Parse(data)
              finally:
                  outfile.close()
          except:
              if os.path.exists(compiled_file):
                  os.remove(compiled_file)
              raise
      return open(compiled_file)

594
  def _importFile(self, file_name, file_obj):
595
    # import xml file
596
    if not file_name.endswith('.xml'):
597 598
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
599
      return
600 601 602 603 604
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
605
    __traceback_info__ = 'Importing %s' % file_name
606 607 608 609 610 611 612
    # The pre-compilation hack is disabled, because the design is not
    # nice. Do not enable it without yo's approval.
    if 0:
      if isinstance(file_obj, file):
        obj = connection.importFile(self._compileXML(file_obj))
      else:
        obj = connection.importFile(file_obj, customImporters=customImporters)
613 614
    else:
      obj = connection.importFile(file_obj, customImporters=customImporters)
615
    self.removeProperties(obj)
616 617
    self._objects[file_name[:-4]] = obj

618
  def preinstall(self, context, installed_bt, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
619
    #XXX -12 used here is -len('TemplateItem')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
620 621
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
622 623 624 625 626 627 628
      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]
629
          old_object = self.removeProperties(old_object)
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
          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

649
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
650 651 652
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
653
    subobjects_dict = {}
654
    if trashbin is None: # must return subobjects
655 656 657 658 659 660
      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)
661
        subobjects_dict[subobject_id] = subobject_copy
662
      return subobjects_dict
663 664
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
665
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, **kw)
666
    elif action == 'install':
667
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0, **kw)
668
    return subobjects_dict
669

670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
  def beforeInstall(self):
    """
      Installation hook.
      Called right at the begining of "install" method.
      Can be overridden by subclasses.
    """
    pass

  def afterInstall(self):
    """
      Installation hook.
      Called right before returning in "install" method.
      Can be overridden by subclasses.
    """
    pass

  def onNewObject(self):
    """
      Installation hook.
      Called when installation process determined that object to install is
      new on current site (it's not replacing an existing object).
      Can be overridden by subclasses.
    """
    pass

695
  def install(self, context, trashbin, **kw):
696
    self.beforeInstall()
697 698
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
699
    if context.getTemplateFormatVersion() == 1:
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
      def recurse(hook, document, prefix=''):
        my_prefix = '%s/%s' % (prefix, document.id)
        if (hook(document, my_prefix)):
          for subdocument in document.objectValues():
            recurse(hook, subdocument, my_prefix)
      def saveHook(document, prefix):
        uid = getattr(document, 'uid', None)
        if uid is None:
          return 0
        else:
          saved_uid_dict[prefix] = uid
          return 1
      def restoreHook(document, prefix):
        uid = saved_uid_dict.get(prefix)
        if uid is None:
          return 0
        else:
          document.uid = uid
          return 1
719
      groups = {}
720
      old_groups = {}
721 722 723 724 725
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
726 727
        if update_dict.has_key(path) or force:
          # get action for the oject
Yoshinori Okuji's avatar
Yoshinori Okuji committed
728
          action = 'backup'
729 730 731 732 733
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          # get subobjects in path
734 735 736
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
737 738 739 740
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
741
            container_url = '/'.join(container_path)
742 743 744 745
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
746
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
747 748
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
749
              container_container = portal.unrestrictedTraverse(container_path[:-1])
750 751 752 753 754
              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)
755 756
            else:
              raise
757
          saved_uid_dict = {}
758 759
          subobjects_dict = {}
          # Object already exists
760 761
          old_obj = container._getOb(object_id, None)
          if old_obj is not None:
762
            recurse(saveHook, old_obj)
763
            if getattr(aq_base(old_obj), 'groups', None) is not None:
764 765 766 767 768
              # 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)
769
            subobjects_dict = self._backupObject(action, trashbin,
770
                                                 container_path, object_id)
771
            container.manage_delObjects([object_id])
772 773
          else:
            self.onNewObject()
774
          # install object
775
          obj = self._objects[path]
776 777 778
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
779
          if getattr(aq_base(obj), 'groups', None) is not None:
780
            # we must keep original order groups
781
            # because they change when we add subobjects
782
            groups[path] = deepcopy(obj.groups)
783
          # copy the object
784
          obj = obj._getCopy(container)
785 786 787 788 789
          try:
            container._setObject(object_id, obj)
          except AttributeError:
            LOG("BT, install", 0, object_id)
            raise
790
          obj = container._getOb(object_id)
791 792
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
793
          self.REQUEST.set('is_business_template_installation', 1)
794 795
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
796
          # if portal types upgrade, set backup properties
797 798
          if getattr(obj, 'meta_type', None) == 'ERP5 Type Information' and \
              len(subobjects_dict) > 0:
799
            setattr(obj, 'allowed_content_types',
800
                    subobjects_dict['allowed_content_type_list'] or [])
801
            setattr(obj, 'hidden_content_type_list',
802
                    subobjects_dict['hidden_content_type_list'] or [])
803
            setattr(obj, 'property_sheet_list',
804
                    subobjects_dict['property_sheet_list'] or [])
805
            setattr(obj, 'base_category_list',
806
                    subobjects_dict['base_category_list'] or [])
807 808 809 810
            setattr(obj, '_roles', subobjects_dict['roles_list'] or [])
            # set actions
            action_list = subobjects_dict['action_list']
            for action in action_list:
811 812 813
              action_text = action.action
              if isinstance(action_text, Expression):
                action_text = action_text.text
814 815
              obj.addAction(id = action.id
                            , name = action.title
816
                            , action = action_text
817 818 819 820 821 822 823 824 825 826 827
                            , 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 = ''
828
            chain_dict['chain_%s' % (object_id)] = wf_chain
829
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
830
          # import sub objects if there is
831
          elif len(subobjects_dict) > 0:
832
            # get a jar
833 834
            connection = obj._p_jar
            o = obj
835
            while connection is None:
836 837
              o = o.aq_parent
              connection = o._p_jar
838
            # import subobjects
839
            for subobject_id, subobject_data in subobjects_dict.iteritems():
840 841 842 843 844 845 846 847 848 849 850
              try:
                if obj._getOb(subobject_id, None) is None:
                  subobject_data.seek(0)
                  subobject = connection.importFile(subobject_data)
                  obj._setObject(subobject_id, subobject)
              except AttributeError:
                # XXX this may happen when an object which can contain
                # sub-objects (e.g. ERP5 Form) has been replaced with
                # an object which cannot (e.g. External Method).
                LOG('BusinessTemplate', WARNING,
                    'could not restore %r in %r' % (subobject_id, obj))
851
          if obj.meta_type in ('Z SQL Method',):
852
            fixZSQLMethod(portal, obj)
853 854 855
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
856 857 858
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
859 860 861 862 863 864 865 866 867 868
          recurse(restoreHook, obj)
          # Reindex created object (if possible) after all unindexObject
          # activites are finished, to make sure it is indexed in the end.
          recursiveReindexObject = getattr(obj, 'recursiveReindexObject', None)
          if recursiveReindexObject is not None:
            # XXX: Using SQLQueue to make sure this activity does not get
            # merged and dropped because of another existing
            # 'recursiveReindexObject' on same path.
            recursiveReindexObject(activate_kw={'activity': 'SQLQueue',
              'after_method_id': 'unindexObject'})
869
      # now put original order group
870 871
      # we remove object not added in forms
      # we put old objects we have kept
872
      for path, new_groups_dict in groups.iteritems():
873 874 875 876 877 878 879 880 881
        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
882
          # excetp the one that had to be removed
883 884 885 886
          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'):
887 888
              continue
            widget_in_form = 0
889 890
            for group_id, group_value_list in new_groups_dict.iteritems():
              if widget_id in group_value_list:
891 892 893 894 895 896
                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:
897
              for old_group_id, old_group_values in old_groups_dict.iteritems():
898 899 900 901 902 903 904 905 906 907 908
                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,]
909
                  obj.group_list = list(obj.group_list) + ['not_assigned']
910
          # second check all widget_id in order are in form
911 912
          for group_id, group_value_list in new_groups_dict.iteritems():
            for widget_id in tuple(group_value_list):
913 914 915
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
916
                group_value_list.remove(widget_id)
917
          # now set new group object
918
          obj.groups = new_groups_dict
Aurel's avatar
Aurel committed
919
    else:
920 921
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
922
      portal = context.getPortalObject()
923
      for relative_url in self._archive.keys():
924
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
925 926 927 928
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
929
        if object_id in container_ids:    # Object already exists
930
          self._backupObject('backup', trashbin, container_path, object_id)
931
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
932
        # Set a hard link
933 934 935 936 937 938
        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',):
939
          fixZSQLMethod(portal, obj)
940
    self.afterInstall()
941 942 943

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
944
    trash = kw.get('trash', 0)
945 946 947 948 949
    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
950
      object_keys = self._archive.keys()
951
    for relative_url in object_keys:
952 953
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
954
      try:
955
        container = portal.unrestrictedTraverse(container_path)
956
        object = container._getOb(object_id) # We force access to the object to be sure
957 958
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
959
        if trash and trashbin is not None:
960 961
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
        container.manage_delObjects([object_id])
962 963
        if container.aq_parent.meta_type == 'ERP5 Catalog' and len(container.objectIds()) == 0:
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
964
          container.getParentValue().manage_delObjects([container.id])
965
      except (NotFound, KeyError, BadRequest, AttributeError):
966
        # object is already backup and/or removed
967
        pass
968 969
    BaseTemplateItem.uninstall(self, context, **kw)

970 971 972 973 974 975 976 977 978 979 980 981
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

982 983 984 985 986 987 988 989 990
  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()
991 992
    object_keys.sort()
    object_keys.reverse()
993 994
    p = context.getPortalObject()
    for path in object_keys:
995 996 997 998 999
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1000 1001 1002
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1003
        try:
Aurel's avatar
Aurel committed
1004 1005
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
1006 1007
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
1008 1009
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1010
                                           keep_subobjects=1)
1011 1012 1013 1014 1015 1016
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1017 1018 1019
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1020

1021 1022 1023 1024 1025 1026 1027 1028 1029
      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.
1030 1031 1032
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1033
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1034 1035
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1036
      if object_id != "":
1037
        path_list.extend(self._resolvePath(
1038
            folder._getOb(object_id),
1039
            relative_url_list + [object_id], id_list[1:]))
1040
    return path_list
Aurel's avatar
Aurel committed
1041

1042 1043 1044
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1045
    keys = self._path_archive.keys()
1046
    keys.sort()
Aurel's avatar
Aurel committed
1047
    for path in keys:
1048 1049 1050
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
1051
      for relative_url in self._resolvePath(p, [], path.split('/')):
1052 1053
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1054
        obj = obj.__of__(context)
1055
        _recursiveRemoveUid(obj)
1056
        id_list = obj.objectIds()
1057
        obj = self.removeProperties(obj)
1058
        if hasattr(aq_base(obj), 'groups'):
1059
          # we must keep groups because it's ereased when we delete subobjects
1060
          groups = deepcopy(obj.groups)
1061
        if len(id_list) > 0:
1062 1063
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1064
          for id_ in list(id_list):
1065
            obj._delObject(id_)
1066
        if hasattr(aq_base(obj), 'groups'):
1067 1068 1069
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1070

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1071 1072 1073 1074 1075 1076 1077 1078
class ToolTemplateItem(PathTemplateItem):
  """This class is used only for making a distinction between other objects
  and tools, because tools may not be backed up."""
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
    """Fake as if a trashbin is not available."""
    return PathTemplateItem._backupObject(self, action, None, container_path,
                                          object_id, **kw)

1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
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")
1094
    if len(id_list) != 1:
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
      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():
1107
      pref = portal.unrestrictedTraverse(object_path)
1108
      # XXX getPreferenceState is a bad name
1109 1110 1111
      if pref.getPreferenceState() == 'disabled':
        portal.portal_workflow.doActionFor(
                      pref,
1112 1113 1114 1115
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")

1116 1117
class CategoryTemplateItem(ObjectTemplateItem):

1118 1119
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1120

1121 1122 1123 1124
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1125 1126
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1127
      obj = self.removeProperties(obj)
1128
      id_list = obj.objectIds()
1129
      if id_list:
1130
        self.build_sub_objects(context, id_list, relative_url)
1131
        for id_ in list(id_list):
1132
          obj._delObject(id_)
1133 1134
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1135 1136 1137 1138 1139

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1140 1141
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1142
      _recursiveRemoveUid(obj)
1143
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1144
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1145
      id_list = obj.objectIds()
1146 1147
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1148
        for id_ in list(id_list):
1149
          obj._delObject(id_)
1150
      else:
1151
        for id_ in list(id_list):
1152
          obj._delObject(id_)
1153 1154
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1155

1156 1157 1158 1159 1160 1161 1162 1163
  def beforeInstall(self):
    self._installed_new_category = False

  def onNewObject(self):
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1164 1165
      # reset accessors if we installed a new category
      _aq_reset()
1166

1167 1168
class SkinTemplateItem(ObjectTemplateItem):

1169 1170
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1171

1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
  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

1187
  def install(self, context, trashbin, **kw):
1188
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1189 1190
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1191 1192 1193
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1194
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1195 1196
        fixZSQLMethod(p, obj)

1197
    ps = p.portal_skins
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
    # Add new skin selection if not already existing
    for relative_url in self._archive.keys():
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
        obj = self._objects[relative_url]
      else:
        obj = self._archive[relative_url]
      selection_list = obj.getProperty(
          'business_template_registered_skin_selections', [])
      if isinstance(selection_list, basestring):
        selection_list = selection_list.split()
      for skin_selection in selection_list:
        if skin_selection not in ps.getSkinSelections():
          # This skin selection does not exist, so we create a new one.
          # We'll initialize it with all skin folders, unless:
          #  - they explictly define a list of
          #    "business_template_registered_skin_selections", and we
          #    are not in this list.
          #  - they are not registred in the default skin selection
          skin_path = ''
          for skin_folder in ps.objectValues():
            if skin_selection in skin_folder.getProperty(
                     'business_template_registered_skin_selections',
                     (skin_selection, )):
              if skin_folder.getId() in ps.getSkinPath(ps.getDefaultSkin()):
                if skin_path:
                  skin_path = '%s,%s' % (skin_path, skin_folder.getId())
                else:
                  skin_path= skin_folder.getId()
          ps.addSkinSelection(skin_selection, skin_path)

    # Add new folders into skin paths.
1233 1234 1235 1236
    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
1237
        if context.getTemplateFormatVersion() == 1:
1238 1239
          if update_dict.has_key(relative_url) or force:
            if not force:
1240
              if update_dict[relative_url] == 'nothing':
1241
                continue
1242
          obj = self._objects[relative_url]
1243
        else:
1244
          obj = self._archive[relative_url]
1245
        skin_id = relative_url.split('/')[-1]
1246
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
        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)
1260 1261 1262

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
1263 1264 1265 1266
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1267
      object_keys = self._archive.keys()
1268
    ps = context.portal_skins
1269
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
1270 1271 1272 1273 1274 1275 1276
    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)
1277
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
1278
    context.getPortalObject().changeSkin(None)
1279 1280 1281
    ObjectTemplateItem.uninstall(self, context, **kw)


1282
class WorkflowTemplateItem(ObjectTemplateItem):
1283

1284 1285
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1286

1287
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1288 1289
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1290 1291 1292
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
1293
        if installed_bt._objects.has_key(path):
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
          # 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']})
1310 1311 1312 1313 1314 1315 1316 1317
      # 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
1318
    if context.getTemplateFormatVersion() == 1:
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
      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:
1333
            action = 'backup'
1334 1335 1336 1337 1338 1339
          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
1340
            container_url = '/'.join(container_path)
1341 1342 1343 1344 1345 1346
            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
1347
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1348
            container.manage_delObjects([object_id])
1349
          obj = self._objects[path]
1350 1351 1352
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1353 1354 1355 1356 1357
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1358 1359 1360 1361
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1362 1363
class PortalTypeTemplateItem(ObjectTemplateItem):

1364 1365
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1366 1367
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1368 1369 1370
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1371 1372
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1373 1374
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1375 1376 1377
      # remove actions and properties
      action_len = len(obj.listActions())
      obj.deleteActions(selections=range(action_len))
1378
      obj = self.removeProperties(obj)
1379 1380 1381 1382 1383 1384 1385 1386 1387
      # 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
1388 1389
      if hasattr(obj, '_roles'):
        setattr(obj, '_roles', [])
1390 1391
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1392

1393 1394
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1395 1396 1397 1398
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1399 1400
    # We now need to setup the list of workflows corresponding to
    # each portal type
1401
    (default_chain, chain_dict) = getChainByType(context)
1402
    # Set the default chain to the empty string is probably the
1403
    # best solution, by default it is 'default_workflow', which is
1404
    # not very usefull
1405
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1406
    if context.getTemplateFormatVersion() == 1:
1407
      object_list = self._objects
1408
    else:
1409 1410
      object_list = self._archive
    for path in object_list.keys():
1411 1412 1413 1414
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1415
            continue
1416 1417
        obj = object_list[path]
        portal_type = obj.id
1418 1419 1420
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1421 1422
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1423

1424 1425
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1426 1427 1428 1429 1430 1431 1432
  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:
1433
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1434 1435 1436 1437 1438
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1439
        dict[str(ptype)] = str(workflow)
1440 1441 1442 1443
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1444
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1445 1446

  def build(self, context, **kw):
1447 1448 1449 1450 1451
    # 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
1452
    p = context.getPortalObject()
1453
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1454
    for key in self._archive.keys():
1455 1456 1457
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1458
        workflow = wflist[1]
1459
      else:
1460
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1461
        portal_type = wflist[0][:-2]
1462 1463
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1464 1465 1466 1467
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
1468
        if workflow[0] != '-' and \
1469
            workflow_name not in chain_dict['chain_%s' % portal_type]:
1470 1471
          if not self.is_bt_for_diff:
            raise NotFound, 'workflow %s not found in chain for portal_type %s'\
1472
                % (workflow, portal_type)
1473
        if self._objects.has_key(portal_type):
1474 1475
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1476
        else:
1477
          self._objects[portal_type] = [workflow,]
1478
      elif not self.is_bt_for_diff:
1479 1480
        raise NotFound, 'portal type %s not found in workflow chain'\
                                                    % portal_type
1481

Christophe Dumez's avatar
Christophe Dumez committed
1482
  # Function to generate XML Code Manually
1483 1484 1485 1486 1487
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1488
      workflow_list = self._objects[key]
1489 1490 1491
      # XXX Not always a list
      if isinstance(workflow_list, str):
        workflow_list = [workflow_list]
1492 1493 1494 1495 1496
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
      xml_data += '\n  <workflow>%s</workflow>' %(', '.join(workflow_list))
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
    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
1513
    (default_chain, chain_dict) = getChainByType(context)
1514
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1515
    # best solution, by default it is 'default_workflow', which is
1516 1517 1518 1519 1520 1521 1522
    # 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':
1523
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1524 1525
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
1526
        if len(path_splitted) < 1:
Jérome Perrin's avatar
Jérome Perrin committed
1527
          continue
1528
        portal_type = path_splitted[-1]
1529
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1530 1531 1532
          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 != '':
1533
            old_chain_workflow_id_set = {}
1534
            # get existent workflow id list
1535 1536
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1537
            # get new workflow id list
1538
            for wf_id in self._objects[path].split(', '):
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
              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
1553 1554
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1555
          else:
Romain Courteaud's avatar
Romain Courteaud committed
1556 1557 1558 1559 1560 1561
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
            for wf_id in self._objects[path].split(', '):
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
1562
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1563 1564
        else:
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1565 1566
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1567

1568 1569
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1570 1571 1572 1573 1574 1575
    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:
1576 1577 1578 1579 1580 1581
      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():
1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
        chain = chain_dict[id]
        # It should be better to use regexp
        chain = chain.replace(' ', '')
        workflow_list = chain.split(',')
        workflow_id = self._objects[path]
        for i in range(workflow_list.count(workflow_id)):
          workflow_list.remove(workflow_id)
        chain = ', '.join(workflow_list)
        if chain == '':
          del chain_dict[id]
        else:
          chain_dict[id] = chain
1594
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1595

1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
      for key in installed_bt._objects.keys():
        if not "portal_type_workflow_chain/" in key:
          new_key = 'portal_type_workflow_chain/%s' %key
          new_dict[new_key] = installed_bt._objects[key]
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
        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]
          old_object = installed_bt._objects[path]
          # compare same type of object
          if isinstance(old_object, list) or isinstance(old_object, tuple):
            old_object = ', '.join(old_object)
          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

1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640
  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
1641 1642
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1643 1644 1645
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1646 1647
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1648

1649
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
1650 1651 1652
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
1653 1654 1655 1656
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'

  def build(self, context, **kw):
1657 1658
    types_tool = self.getPortalObject().portal_types
    types_list = list(types_tool.objectIds())
1659
    for key in self._archive.keys():
1660 1661 1662 1663
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
1664 1665 1666 1667 1668
      # check properties corresponds to what is defined in site
      if not portal_type in types_list:
        raise ValueError, "Portal Type %s not found in site" %(portal_type,)
      ob = types_tool._getOb(portal_type)
      prop_value = getattr(ob, self.class_property, ())
1669
      if not allowed_type in prop_value and not self.is_bt_for_diff:
1670 1671 1672 1673
        raise ValueError, "%s  %s not found in portal type %s" % (
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)

1674 1675 1676 1677 1678 1679 1680
      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
1681
  # Function to generate XML Code Manually
1682
  def generateXml(self, path=None):
1683
    dictio = self._objects
1684
    xml_data = '<%s>' %(self.xml_tag,)
1685
    keys = dictio.keys()
1686 1687
    keys.sort()
    for key in keys:
1688
      allowed_list = dictio[key]
1689
      xml_data += '\n <portal_type id="%s">' %(key,)
1690
      for allowed_item in allowed_list:
1691 1692 1693
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704
    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)

1705 1706 1707 1708 1709
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
1710 1711 1712 1713
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
      for key in installed_bt._objects.keys():
        if self.class_property not in key:
1714
          new_key = '%s/%s' % (self.class_property, key)
1715
          new_dict[new_key] = installed_bt._objects[key]
1716 1717 1718
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
1719 1720 1721 1722 1723
        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]
1724
          old_object = installed_bt._objects[path]
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735
          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

1736
  def _importFile(self, file_name, file):
1737
    path, name = posixpath.split(file_name)
1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
    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)
1762
        except AttributeError:
1763 1764 1765 1766 1767 1768 1769 1770
          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:
1771 1772
            if id not in property_list:
              property_list.append(id)
1773 1774
        setattr(portal_type, self.class_property, list(property_list))

Aurel's avatar
Aurel committed
1775
  def uninstall(self, context, **kw):
1776
    object_path = kw.get('object_path', None)
1777
    p = context.getPortalObject()
1778
    pt = p.unrestrictedTraverse('portal_types')
1779 1780 1781 1782 1783 1784 1785 1786
    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)
1787
      except AttributeError:
1788 1789 1790
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
1791 1792
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
1793 1794
      for id in property_list:
        if id in original_property_list:
1795
          original_property_list.remove(id)
1796
      setattr(portal_type, self.class_property, list(original_property_list))
1797

1798

1799 1800
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

1801
  name = 'Hidden Content Type'
1802 1803 1804
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'

1805

1806 1807
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

1808
  name = 'Property Sheet'
1809 1810 1811
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'

1812

1813 1814
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

1815
  name = 'Base Category'
1816 1817 1818
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'

1819

1820
class CatalogMethodTemplateItem(ObjectTemplateItem):
1821
  """Template Item for catalog methods.
1822

1823 1824 1825 1826 1827
    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.
  """
1828

1829 1830
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1831
    # a mapping to store properties of methods.
1832 1833 1834 1835 1836
    # 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()
1837

1838 1839 1840 1841 1842
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856
  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

1857 1858
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1859

1860
    catalog = _getCatalogValue(self)
1861
    if catalog is None:
1862
      LOG('BusinessTemplate build', 0, 'catalog not found')
1863
      return
1864

1865 1866 1867
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
1868

1869 1870
    for obj in self._objects.values():
      method_id = obj.id
1871 1872
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
1873
      self._is_filtered_archive[method_id] = 0
1874
      if catalog.filter_dict.has_key(method_id):
1875 1876 1877 1878 1879 1880 1881 1882 1883
        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']
1884

Aurel's avatar
Aurel committed
1885
  def export(self, context, bta, **kw):
1886
    catalog = _getCatalogValue(self)
1887 1888 1889 1890
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

Aurel's avatar
Aurel committed
1891 1892 1893 1894
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
1895
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1896
      # create folder and subfolders
1897
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
1898 1899 1900 1901
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
1902 1903
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1904
      # add all datas specific to catalog inside one file
1905
      method_id = obj.id
1906 1907
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

1908
      f = open(object_path, 'wb')
1909
      xml_data = '<catalog_method>'
1910

1911
      for method_property, value in self._method_properties[method_id].items():
1912 1913 1914
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
1915

Aurel's avatar
Aurel committed
1916
      if catalog.filter_dict.has_key(method_id):
1917
        if catalog.filter_dict[method_id]['filtered']:
1918 1919 1920
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
1921 1922 1923 1924
          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'')):
1925 1926 1927
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
1928
              elif type(value) in (type(()), type([])):
1929
                xml_data += '\n <item key="%s" type="tuple">'%(method)
1930
                for item in value:
1931 1932 1933
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
      xml_data += '\n</catalog_method>'
1934
      f.write(xml_data)
Aurel's avatar
Aurel committed
1935
      f.close()
1936

Christophe Dumez's avatar
Christophe Dumez committed
1937 1938 1939 1940 1941 1942
  # 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:
1943 1944
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
Christophe Dumez's avatar
Christophe Dumez committed
1945
    return xml_data
1946

1947 1948
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1949
    catalog = _getCatalogValue(self)
1950 1951 1952 1953 1954 1955 1956
    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)
1957

1958 1959 1960
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1961
    new_bt_format = context.getTemplateFormatVersion()
1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977

    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':
1978
              continue
1979 1980 1981 1982
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
1983

1984 1985
    for obj in values:
      method_id = obj.id
1986

1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997
      # 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))
1998

1999 2000
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2001
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2002
        if context.getTemplateFormatVersion() == 1:
2003 2004 2005
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2006
        filter_type = self._filter_type_archive[method_id]
2007 2008 2009
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2010
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2011
        catalog.filter_dict[method_id]['type'] = filter_type
2012
      elif method_id in catalog.filter_dict.keys():
2013
        catalog.filter_dict[method_id]['filtered'] = 0
2014

2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040
      # 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)
2041

2042 2043 2044 2045 2046 2047
        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)
2048

2049
  def uninstall(self, context, **kw):
2050
    catalog = _getCatalogValue(self)
2051 2052 2053
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2054

2055 2056 2057 2058
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2059 2060 2061 2062
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2063
    else:
2064 2065 2066 2067
      try:
        value = self._archive[object_path]
      except KeyError:
        value = None
2068 2069
      if value is not None:
        values.append(value)
2070
    for obj in values:
2071
      method_id = obj.id
2072 2073 2074 2075 2076 2077 2078 2079 2080
      # 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)
2081

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2082
      if catalog.filter_dict.has_key(method_id):
2083
        del catalog.filter_dict[method_id]
2084

2085
    # uninstall objects
2086
    ObjectTemplateItem.uninstall(self, context, **kw)
2087

2088
  def _importFile(self, file_name, file):
2089
    if file_name.endswith('.catalog_keys.xml'):
2090
      # recreate data mapping specific to catalog method
2091 2092
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2093
      xml = parse(file)
2094
      method_list = xml.getElementsByTagName('item')
2095
      for method in method_list:
2096
        key = method.getAttribute('key')
2097 2098
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
2099 2100 2101 2102
          if len(method.getElementsByTagName('value')[0].childNodes):
            value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          else:
            value = ''
2103
          key = str(key)
2104
        elif key_type == "int":
2105
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
2106
          key = str(key)
2107
        elif key_type == "tuple":
2108 2109 2110 2111
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
2112
        else:
2113
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2114
          continue
2115
        if key in catalog_method_list or key in catalog_method_filter_list:
2116
          dict = getattr(self, key, {})
2117
          dict[id] = value
2118 2119 2120
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132
    elif file_name.endswith('.xml'):
      # 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.removeProperties(obj)
      self._objects[file_name[:-4]] = obj
    else:
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2133

2134
class ActionTemplateItem(ObjectTemplateItem):
2135 2136

  def __init__(self, id_list, **kw):
2137
    # XXX It's look like ObjectTemplateItem __init__
2138 2139 2140 2141 2142 2143
    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

2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164
  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

2165 2166 2167 2168
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2169
      relative_url, value = id.split(' | ')
2170 2171
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
2172
        if getattr(ai, 'id') == value:
2173 2174
          url = posixpath.split(relative_url)
          key = posixpath.join(url[-2], url[-1], value)
2175
          action = ai._getCopy(context)
2176
          action = self.removeProperties(action)
2177
          self._objects[key] = action
Aurel's avatar
Aurel committed
2178
          self._objects[key].wl_clearLocks()
2179 2180
          break
      else:
2181 2182
        if not self.is_bt_for_diff:
          raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
2183

2184 2185 2186
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2187
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2188 2189
      p = context.getPortalObject()
      for id in self._objects.keys():
2190 2191 2192 2193 2194
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2195
          path = id.split('/')
2196 2197
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
2198
          for index in range(len(action_list)):
2199
            if getattr(action_list[index], 'id') == path[-1]:
2200
              # remove previous action
2201
              obj.deleteActions(selections=(index,))
2202
          action = self._objects[id]
2203 2204 2205
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2206
          obj.addAction(
2207 2208
                        id = action.id
                      , name = action.title
2209
                      , action = action_text
2210 2211 2212 2213
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2214 2215
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2216
                      , priority = action.priority
Aurel's avatar
Aurel committed
2217
                    )
2218
          # sort action based on the priority define on it
2219 2220 2221 2222 2223 2224 2225 2226 2227
          # 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
2228
    else:
2229
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2230
      p = context.getPortalObject()
2231 2232
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2233
        relative_url, key, value = self._splitPath(id)
2234 2235
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2236
          if getattr(ai, key) == value:
2237
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2238 2239 2240
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2241
        obj.addAction(
Aurel's avatar
Aurel committed
2242 2243
                      id = action.id
                    , name = action.title
2244
                    , action = action_text
Aurel's avatar
Aurel committed
2245 2246 2247 2248
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2249 2250
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2251
                    )
Aurel's avatar
Aurel committed
2252 2253 2254 2255 2256 2257 2258
        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))
2259 2260
          obj.moveDownActions(selections=tuple(move_down_list))

2261 2262
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2263 2264
    object_path = kw.get("object_path", None)
    if object_path is not None:
2265 2266 2267 2268 2269 2270 2271 2272
      if '/' in object_path:
        # here object_path is the path of the actions, something like
        # portal_type/Person/view
        ti, action_id = object_path.rsplit('/', 1)
        keys = ['%s | %s' % (ti, action_id)]
      else:
        # compatibility ?
        keys = [object_path]
2273
    else:
2274
      keys = self._archive.keys()
2275
    for id in keys:
2276 2277 2278 2279
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290
        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 )
2291 2292
    BaseTemplateItem.uninstall(self, context, **kw)

2293 2294 2295
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2296
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308
    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
2309
        for property in ('id', 'title', 'description',
2310 2311 2312 2313
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
2314 2315 2316 2317
        # condition
        prop_value = getattr(role, 'condition')
        if prop_value:
          type_role_dict['condition'] = prop_value.text
2318 2319 2320 2321 2322 2323 2324 2325 2326
        # 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
2327
  # Function to generate XML Code Manually
2328 2329 2330 2331
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2332
      xml_data += "\n  <role id='%s'>" % role['id']
2333 2334 2335 2336 2337
      # uniq
      for property in ('title', 'description', 'condition', 'priority',
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2338 2339
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2340
          xml_data += "\n   <property id='%s'>%s</property>" % \
2341 2342 2343
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2344
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2345 2346
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2347
          xml_data += "\n   <multi_property "\
2348
          "id='%s'>%s</multi_property>" % (property, prop_value)
2349 2350
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2351
    return xml_data
2352

2353 2354 2355 2356 2357 2358 2359
  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)
2360 2361
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2362 2363 2364 2365 2366 2367
      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)
2368
    xml_type_roles_list = xml.getElementsByTagName('role')
2369 2370 2371 2372 2373 2374 2375 2376
    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():
2377
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2378 2379 2380 2381 2382 2383 2384 2385 2386 2387
          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():
2388
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403
          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]
2404 2405 2406 2407 2408 2409
      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))
2410 2411 2412

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2413 2414 2415 2416 2417 2418
    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:
2419
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2420 2421 2422 2423 2424
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2425

2426 2427 2428 2429 2430 2431
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2432 2433
      for property in p.propertyMap():
        if property['id'] == id:
2434
          obj = p.getProperty(id)
2435
          prop_type = property['type']
2436 2437
          break
      else:
2438
        obj = None
2439
      if obj is None and not self.is_bt_for_diff:
2440
        raise NotFound, 'the property %s is not found' % id
2441
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2442

2443 2444 2445 2446 2447 2448
  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
2449 2450
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2451 2452 2453 2454 2455 2456 2457
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2458
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2459
      self._objects[str(id)] = (str(prop_type), value)
2460

2461 2462 2463
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2464
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2465 2466
      p = context.getPortalObject()
      for path in self._objects.keys():
2467 2468 2469 2470
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2471
              continue
2472
          dir, id = posixpath.split(path)
2473
          prop_type, property = self._objects[path]
2474 2475 2476 2477 2478 2479 2480 2481
          if p.hasProperty(id):
            if p.getPropertyType(id) != prop_type:
              p._delProperty(id)
              p._setProperty(id, property, type=prop_type)
            else:
              p._updateProperty(id, property)
          else:
            p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
2482
    else:
2483
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2484
      p = context.getPortalObject()
2485
      for id, property in self._archive.keys():
2486
        property = self._archive[id]
Aurel's avatar
Aurel committed
2487
        if p.hasProperty(id):
2488 2489 2490 2491 2492 2493 2494
          if p.getPropertyType(id) != property['type']:
            p._delProperty(id)
            p._setProperty(id, property['value'], type=property['type'])
          else:
            p._updateProperty(id, property['value'])
        else:
          p._setProperty(id, property['value'], type=property['type'])
2495 2496 2497

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2498 2499 2500 2501 2502 2503
    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:
2504 2505 2506 2507
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2508
  # Function to generate XML Code Manually
2509
  def generateXml(self, path=None):
2510
    xml_data = ''
2511
    prop_type, obj = self._objects[path]
2512
    xml_data += '\n <property>'
2513 2514
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
2515
    if prop_type in ('lines', 'tokens'):
2516
      xml_data += '\n  <value>'
2517
      for item in obj:
2518
        if item != '':
2519
          xml_data += '\n   <item>%s</item>' % escape(str(item))
2520
      xml_data += '\n  </value>'
2521
    else:
2522
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
2523
    xml_data += '\n </property>'
2524 2525
    return xml_data

Aurel's avatar
Aurel committed
2526 2527 2528 2529 2530
  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)
2531 2532 2533 2534
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2535
      xml_data += self.generateXml(path)
2536
    xml_data += '\n</site_property>'
2537
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2538

2539 2540 2541 2542 2543 2544 2545
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)
2546 2547 2548 2549 2550 2551 2552 2553
      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
2554

Christophe Dumez's avatar
Christophe Dumez committed
2555
  # Function to generate XML Code Manually
2556
  def generateXml(self, path=None):
2557 2558
    dict = self._objects[path]
    xml_data = '<module>'
2559 2560 2561 2562
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2563 2564
      if key =='permission_list':
        # separe permission dict into xml
2565
        xml_data += '\n <%s>' %(key,)
2566 2567
        permission_list = dict[key]
        for perm in permission_list:
2568 2569 2570 2571 2572
          # the type of the permission defined if we use acquired or not
          if type(perm[1]) == type([]):
            ptype = "list"
          else:
            ptype = "tuple"
2573 2574
          xml_data += "\n  <permission type='%s'>" %(ptype,)
          xml_data += '\n   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2575
          role_list = list(perm[1])
2576
          role_list.sort()
2577
          for role in role_list:
2578 2579 2580
            xml_data += '\n   <role>%s</role>' %(role)
          xml_data += '\n  </permission>'
        xml_data += '\n </%s>' %(key,)
2581
      else:
2582 2583
        xml_data += '\n <%s>%s</%s>' %(key, dict[key], key)
    xml_data += '\n</module>'
2584 2585
    return xml_data

2586 2587 2588 2589 2590
  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)
2591 2592 2593
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
2594
      # expor module one by one
2595
      xml_data = self.generateXml(path=id)
2596
      bta.addObject(obj=xml_data, name=id, path=path)
2597

2598
  def install(self, context, trashbin, **kw):
2599
    portal = context.getPortalObject()
2600 2601
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2602
    if context.getTemplateFormatVersion() == 1:
2603
      items = self._objects
2604
    else:
2605 2606 2607 2608 2609 2610 2611 2612 2613
      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]
2614
        path, id = posixpath.split(id)
2615 2616
        if id in portal.objectIds():
          module = portal._getOb(id)
2617
          module.portal_type = str(mapping['portal_type'])
2618 2619 2620
        else:
          module = portal.newContent(id=id, portal_type=str(mapping['portal_type']))
        module.setTitle(str(mapping['title']))
2621
        for name, role_list in list(mapping['permission_list']):
2622 2623 2624 2625 2626
          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.
2627 2628 2629
            LOG('ERP5', PROBLEM,
                'Unable to update module permission "%s" with roles %s' % (
                  name, role_list), error=sys.exc_info())
2630 2631 2632 2633 2634 2635 2636 2637 2638 2639

  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:
2640
          perm_type = perm.getAttribute('type').encode() or None
2641 2642 2643 2644 2645 2646 2647 2648 2649
          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))
2650 2651 2652 2653
          if perm_type == "list" or perm_type is None:
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664
          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

2665
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2666 2667 2668
    trash = kw.get('trash', 0)
    if trash:
      return
2669 2670 2671 2672 2673 2674
    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]
2675 2676
    p = context.getPortalObject()
    id_list = p.objectIds()
2677
    for id in keys:
2678
      if id in id_list:
2679
        try:
2680
          if trash and trashbin is not None:
2681 2682
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2683
          p.manage_delObjects([id])
2684
        except NotFound:
2685
          pass
2686 2687
    BaseTemplateItem.uninstall(self, context, **kw)

2688 2689 2690
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2691 2692

class DocumentTemplateItem(BaseTemplateItem):
2693 2694 2695 2696
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2697 2698 2699 2700

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

2703
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2704 2705
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2706
      new_keys = self._objects.keys()
2707 2708 2709 2710 2711 2712 2713 2714 2715 2716
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
      for key in installed_bt._objects.keys():
        if self.__class__.__name__ in key:
          new_key = key[len('%s/' % self.__class__.__name__):]
          new_dict[new_key] = installed_bt._objects[key]
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
        installed_bt._objects = new_dict
2717 2718 2719 2720 2721 2722
      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:
2723 2724
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
2725
        else: # new object
2726 2727
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
2728 2729 2730 2731
          # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
2732 2733
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
2734 2735 2736 2737 2738
    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
2739
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2740
      for id in self._objects.keys():
2741 2742 2743 2744 2745 2746
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
2747
          path, name = posixpath.split(id)
2748 2749
          # This raises an exception if the file already exists.
          try:
2750
            globals()[self.local_file_writer_name](name, text, create=0)
2751
          except IOError, error:
2752
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
2753 2754
            if error.errno :
              raise
2755 2756 2757
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
2758
    else:
2759 2760 2761
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
2762
        # This raises an exception if the file exists.
2763
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
2764 2765
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
2766 2767

  def uninstall(self, context, **kw):
2768
    object_path = kw.get('object_path', None)
2769 2770 2771 2772 2773
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
2774
      globals()[self.local_file_remover_name](id)
2775 2776
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
2777 2778 2779 2780 2781 2782
  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():
2783 2784
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
2785

2786
  def _importFile(self, file_name, file):
2787 2788 2789
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2790
    text = file.read()
2791
    self._objects[file_name[:-3]]=text
2792

2793 2794 2795 2796 2797 2798
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

2799 2800 2801 2802 2803
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
2804

2805 2806 2807
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
2808 2809
  # Extension needs no import
  local_file_importer_name = None
2810 2811 2812 2813 2814
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
2815
  # Test needs no import
2816 2817 2818
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
2819

2820 2821 2822
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
2823 2824 2825

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2826 2827 2828 2829
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2830
    if len(role_list) > 0:
2831
      self._objects[self.__class__.__name__+'/'+'role_list'] = role_list
Aurel's avatar
Aurel committed
2832

2833
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2834 2835
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2836
      new_roles = self._objects.keys()
2837
      if installed_bt.id == INSTALLED_BT_FOR_DIFF:
2838 2839
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
2840 2841 2842
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
2843 2844
        for key in old_keys:
          new_dict[key] = ''
2845
        installed_bt._objects = new_dict
2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858
      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):
2859
    p = context.getPortalObject()
2860
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2861
    if context.getTemplateFormatVersion() == 1:
2862
      role_list = self._objects.keys()
2863
    else:
2864
      role_list = self._archive.keys()
2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876
    # 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
2877
    for role in role_list:
2878 2879 2880 2881 2882 2883 2884 2885 2886 2887
      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
2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899

  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)

2900 2901 2902 2903 2904 2905 2906 2907 2908
  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
2909
      if role in roles and role not in new_roles:
2910 2911 2912
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
2913
  # Function to generate XML Code Manually
2914
  def generateXml(self, path):
2915
    obj = self._objects[path]
2916
    xml_data = '<role_list>'
2917 2918
    obj.sort()
    for role in obj:
2919 2920
      xml_data += '\n <role>%s</role>' %(role)
    xml_data += '\n</role_list>'
2921 2922
    return xml_data

Aurel's avatar
Aurel committed
2923 2924 2925 2926 2927 2928
  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():
2929
      xml_data = self.generateXml(path=path)
2930
      bta.addObject(obj=xml_data, name=path, path=None,)
2931

2932 2933
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2934
  def build(self, context, **kw):
2935
    catalog = _getCatalogValue(self)
2936 2937 2938
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2939
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2940
    key_list = []
2941
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2942
      if key in sql_search_result_keys:
2943
        key_list.append(key)
2944
      elif not self.is_bt_for_diff:
2945
        raise NotFound, 'Result key "%r" not found in catalog' %(key,)
2946
    if len(key_list) > 0:
2947
      self._objects[self.__class__.__name__+'/'+'result_key_list'] = key_list
2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958

  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

2959
  def install(self, context, trashbin, **kw):
2960
    catalog = _getCatalogValue(self)
2961 2962 2963
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2964

2965
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2966
    if context.getTemplateFormatVersion() == 1:
2967 2968
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
2969 2970 2971
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2972
    else:
2973
      keys = self._archive.keys()
2974 2975
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2976
    # XXX same as related key
Aurel's avatar
Aurel committed
2977
    if update_dict.has_key('result_key_list') or force:
2978
      if not force:
Aurel's avatar
Aurel committed
2979
        action = update_dict['result_key_list']
2980
        if action == 'nothing':
Aurel's avatar
Aurel committed
2981
          return
2982
      for key in keys:
2983 2984
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
2985
      catalog.sql_search_result_keys = sql_search_result_keys
2986

2987
  def uninstall(self, context, **kw):
2988
    catalog = _getCatalogValue(self)
2989 2990 2991 2992
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2993
    object_path = kw.get('object_path', None)
2994 2995 2996 2997 2998
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2999 3000
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
3001
    catalog.sql_search_result_keys = sql_search_result_keys
3002 3003
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3004
  # Function to generate XML Code Manually
3005
  def generateXml(self, path=None):
3006
    obj = self._objects[path]
3007
    xml_data = '<key_list>'
3008 3009
    obj.sort()
    for key in obj:
3010 3011
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3012 3013
    return xml_data

Aurel's avatar
Aurel committed
3014 3015 3016 3017 3018
  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)
3019
    for path in self._objects.keys():
3020
      xml_data = self.generateXml(path=path)
3021
      bta.addObject(obj=xml_data, name=path, path=None)
3022

3023 3024
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3025
  def build(self, context, **kw):
3026
    catalog = _getCatalogValue(self)
3027 3028 3029
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3030
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
3031
    key_list = []
3032
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3033
      if key in sql_search_related_keys:
3034
        key_list.append(key)
3035
      elif not self.is_bt_for_diff:
3036
        raise NotFound, 'Related key "%r" not found in catalog' %(key,)
3037
    if len(key_list) > 0:
3038
      self._objects[self.__class__.__name__+'/'+'related_key_list'] = key_list
3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049

  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

3050
  def install(self, context, trashbin, **kw):
3051
    catalog = _getCatalogValue(self)
3052 3053 3054
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3055

3056
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3057
    if context.getTemplateFormatVersion() == 1:
3058
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3059
        return
3060 3061 3062
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3063
    else:
3064
      keys = self._archive.keys()
3065 3066
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3067
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
3068
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3069
      if not force:
Aurel's avatar
Aurel committed
3070 3071 3072 3073
        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
3074 3075 3076
        if action == 'nothing':
          return
      for key in keys:
3077 3078
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
3079
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
3080

3081
  def uninstall(self, context, **kw):
3082
    catalog = _getCatalogValue(self)
3083 3084 3085
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3086
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
3087
    object_path = kw.get('object_path', None)
3088 3089 3090 3091 3092
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3093 3094 3095 3096 3097
      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
3098
  # Function to generate XML Code Manually
3099
  def generateXml(self, path=None):
3100
    obj = self._objects[path]
3101
    xml_data = '<key_list>'
3102 3103
    obj.sort()
    for key in obj:
3104 3105
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3106 3107
    return xml_data

Aurel's avatar
Aurel committed
3108 3109 3110 3111 3112 3113
  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():
3114
      xml_data = self.generateXml(path=path)
3115
      bta.addObject(obj=xml_data, name=path, path=None)
3116

3117 3118
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3119
  def build(self, context, **kw):
3120
    catalog = _getCatalogValue(self)
3121 3122 3123
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3124
    sql_search_result_tables = list(catalog.sql_search_tables)
3125
    key_list = []
3126
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3127
      if key in sql_search_result_tables:
3128
        key_list.append(key)
3129
      elif not self.is_bt_for_diff:
3130
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
3131
    if len(key_list) > 0:
3132
      self._objects[self.__class__.__name__+'/'+'result_table_list'] = key_list
3133 3134 3135 3136 3137 3138 3139 3140 3141 3142

  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
3143

3144
  def install(self, context, trashbin, **kw):
3145
    catalog = _getCatalogValue(self)
3146 3147 3148
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3149

3150
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3151
    if context.getTemplateFormatVersion() == 1:
3152
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3153
        return
3154 3155 3156
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3157
    else:
3158
      keys = self._archive.keys()
3159 3160
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3161
    # XXX same as related keys
Aurel's avatar
Aurel committed
3162
    if update_dict.has_key('result_table_list') or force:
3163
      if not force:
Aurel's avatar
Aurel committed
3164
        action = update_dict['result_table_list']
3165
        if action == 'nothing':
Aurel's avatar
Aurel committed
3166
          return
3167
      for key in keys:
3168 3169
        if key not in sql_search_tables:
          sql_search_tables.append(key)
3170
      catalog.sql_search_tables = tuple(sql_search_tables)
3171 3172

  def uninstall(self, context, **kw):
3173
    catalog = _getCatalogValue(self)
3174 3175 3176 3177
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
3178
    object_path = kw.get('object_path', None)
3179 3180 3181 3182 3183
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3184 3185
      if key in sql_search_tables:
        sql_search_tables.remove(key)
3186
    catalog.sql_search_tables = sql_search_tables
3187 3188
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3189
  # Function to generate XML Code Manually
3190
  def generateXml(self, path=None):
3191
    obj = self._objects[path]
3192
    xml_data = '<key_list>'
3193 3194
    obj.sort()
    for key in obj:
3195 3196
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3197 3198
    return xml_data

Aurel's avatar
Aurel committed
3199 3200 3201 3202 3203 3204
  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():
3205
      xml_data = self.generateXml(path=path)
3206
      bta.addObject(obj=xml_data, name=path, path=None)
3207

3208 3209
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3210 3211

  def build(self, context, **kw):
3212
    catalog = _getCatalogValue(self)
3213 3214 3215 3216 3217 3218 3219 3220
    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)
3221
      elif not self.is_bt_for_diff:
3222
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3223
    if len(key_list) > 0:
3224
      self._objects[self.__class__.__name__+'/'+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3225

3226 3227 3228 3229 3230 3231 3232 3233 3234
  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
3235 3236

  def install(self, context, trashbin, **kw):
3237
    catalog = _getCatalogValue(self)
3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250
    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()
3251 3252
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264
    # 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):
3265
    catalog = _getCatalogValue(self)
3266 3267 3268 3269
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3270
    object_path = kw.get('object_path', None)
3271 3272
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3273
    else:
3274 3275 3276 3277 3278 3279 3280
      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
3281
  # Function to generate XML Code Manually
3282 3283 3284 3285 3286
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3287 3288
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3289
    return xml_data
Aurel's avatar
Aurel committed
3290 3291 3292 3293

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3294 3295 3296 3297 3298
    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)
3299

3300 3301 3302 3303 3304 3305 3306 3307
# datetime
class CatalogDateTimeKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3308
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3309 3310 3311 3312
    key_list = []
    for key in self._archive.keys():
      if key in sql_datetime_keys:
        key_list.append(key)
3313
      elif not self.is_bt_for_diff:
3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333
        raise NotFound, 'DateTime key "%r" not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+'/'+'datetime_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):
    catalog = _getCatalogValue(context)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

3334
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360
    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('datetime_key_list') or force:
      if not force:
        action = update_dict['datetime_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_datetime_keys:
          sql_datetime_keys.append(key)
      catalog.sql_catalog_datetime_search_keys = sql_datetime_keys

  def uninstall(self, context, **kw):
    catalog = _getCatalogValue(context)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available - uninstall')
      return
3361
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391
    object_path = kw.get('object_path', None)
    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_datetime_keys:
        sql_datetime_keys.remove(key)
    catalog.sql_catalog_datetime_search_keys = sql_datetime_keys
    BaseTemplateItem.uninstall(self, context, **kw)

  # 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 += '\n <key>%s</key>' %(key)
    xml_data += '\n</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)      
      
3392 3393
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3394

3395
  def build(self, context, **kw):
3396
    catalog = _getCatalogValue(self)
3397 3398 3399 3400 3401 3402 3403 3404
    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)
3405
      elif not self.is_bt_for_diff:
3406
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
3407
    if len(key_list) > 0:
3408
      self._objects[self.__class__.__name__+'/'+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3409

3410 3411 3412 3413 3414 3415 3416 3417 3418
  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
3419

3420
  def install(self, context, trashbin, **kw):
3421
    catalog = _getCatalogValue(self)
3422 3423 3424
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3425

3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446
    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
3447

3448
  def uninstall(self, context, **kw):
3449
    catalog = _getCatalogValue(self)
3450 3451 3452 3453
    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)
3454
    object_path = kw.get('object_path', None)
3455 3456 3457 3458 3459 3460 3461 3462 3463 3464
    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
3465
  # Function to generate XML Code Manually
3466 3467 3468 3469 3470
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3471 3472
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488
    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):
3489
    catalog = _getCatalogValue(self)
3490 3491 3492 3493 3494 3495 3496 3497
    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)
3498
      elif not self.is_bt_for_diff:
3499
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
3500
    if len(key_list) > 0:
3501
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513

  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):
3514
    catalog = _getCatalogValue(self)
3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541
    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):
3542
    catalog = _getCatalogValue(self)
3543 3544 3545 3546
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
3547
    object_path = kw.get('object_path', None)
3548 3549 3550 3551 3552 3553 3554 3555 3556 3557
    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
3558
  # Function to generate XML Code Manually
3559 3560 3561 3562 3563
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3564 3565
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580
    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):
3581
    catalog = _getCatalogValue(self)
3582 3583 3584 3585 3586 3587 3588 3589
    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)
3590
      elif not self.is_bt_for_diff:
3591
        raise NotFound, 'Multivalue key "%r" not found in catalog' %(key,)
3592
    if len(key_list) > 0:
3593
      self._objects[self.__class__.__name__+'/'+'multivalue_key_list'] = key_list
3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605

  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):
3606
    catalog = _getCatalogValue(self)
3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632
    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):
3633
    catalog = _getCatalogValue(self)
3634 3635 3636 3637
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
3638
    object_path = kw.get('object_path', None)
3639 3640 3641 3642 3643 3644 3645 3646 3647 3648
    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
3649
  # Function to generate XML Code Manually
3650 3651 3652 3653 3654
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3655 3656
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671
    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):
3672
    catalog = _getCatalogValue(self)
3673 3674 3675 3676 3677 3678 3679 3680
    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)
3681
      elif not self.is_bt_for_diff:
3682
        raise NotFound, 'Topic key "%r" not found in catalog' %(key,)
3683
    if len(key_list) > 0:
3684
      self._objects[self.__class__.__name__+'/'+'topic_key_list'] = key_list
3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696

  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):
3697
    catalog = _getCatalogValue(self)
3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724
    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):
3725
    catalog = _getCatalogValue(self)
3726 3727 3728 3729
    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)
3730
    object_path = kw.get('object_path', None)
3731 3732 3733 3734 3735 3736 3737 3738 3739 3740
    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
3741
  # Function to generate XML Code Manually
3742 3743 3744 3745 3746
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3747 3748
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759
    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)

3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771
class CatalogScriptableKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_scriptable_keys = list(catalog.sql_catalog_scriptable_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_catalog_scriptable_keys:
        key_list.append(key)
3772
      elif not self.is_bt_for_diff:
3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851
        raise NotFound, 'Scriptable key "%r" not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+'/'+'scriptable_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):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_scriptable_keys = list(catalog.sql_catalog_scriptable_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 scriptable key
    if update_dict.has_key('scriptable_key_list') or force:
      if not force:
        if update_dict.has_key('scriptable_key_list'):
          action = update_dict['scriptable_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_scriptable_keys:
          sql_catalog_scriptable_keys.append(key)
      catalog.sql_catalog_scriptable_keys = tuple(sql_catalog_scriptable_keys)

  def uninstall(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_scriptable_keys = list(catalog.sql_catalog_scriptable_keys)
    object_path = kw.get('object_path', None)
    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_scriptable_keys:
        sql_catalog_scriptable_keys.remove(key)
    catalog.sql_catalog_scriptable_keys = tuple(sql_catalog_scriptable_keys)
    BaseTemplateItem.uninstall(self, context, **kw)

  # 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 += '\n <key>%s</key>' %(key)
    xml_data += '\n</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)

3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864
class CatalogRoleKeyTemplateItem(BaseTemplateItem):
  # XXX Copy/paste from CatalogScriptableKeyTemplateItem

  def build(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_role_keys = list(catalog.sql_catalog_role_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_catalog_role_keys:
        key_list.append(key)
3865
      elif not self.is_bt_for_diff:
3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957
        raise NotFound, 'Role key "%r" not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+'/'+'role_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):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_role_keys = list(catalog.sql_catalog_role_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 scriptable key
    if update_dict.has_key('role_key_list') or force:
      if not force:
        if update_dict.has_key('role_key_list'):
          action = update_dict['role_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_role_keys:
          sql_catalog_role_keys.append(key)
      catalog.sql_catalog_role_keys = tuple(sql_catalog_role_keys)

  def uninstall(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_role_keys = list(catalog.sql_catalog_role_keys)
    object_path = kw.get('object_path', None)
    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_role_keys:
        sql_catalog_role_keys.remove(key)
    catalog.sql_catalog_role_keys = tuple(sql_catalog_role_keys)
    BaseTemplateItem.uninstall(self, context, **kw)

  # 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 += '\n <key>%s</key>' %(key)
    xml_data += '\n</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 CatalogLocalRoleKeyTemplateItem(BaseTemplateItem):
  # XXX Copy/paste from CatalogScriptableKeyTemplateItem

  def build(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_local_role_keys = list(catalog.sql_catalog_local_role_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_catalog_local_role_keys:
        key_list.append(key)
3958
      elif not self.is_bt_for_diff:
3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037
        raise NotFound, 'LocalRole key "%r" not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+'/'+'local_role_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):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_local_role_keys = list(catalog.sql_catalog_local_role_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 scriptable key
    if update_dict.has_key('local_role_key_list') or force:
      if not force:
        if update_dict.has_key('local_role_key_list'):
          action = update_dict['local_role_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_local_role_keys:
          sql_catalog_local_role_keys.append(key)
      catalog.sql_catalog_local_role_keys = tuple(sql_catalog_local_role_keys)

  def uninstall(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_local_role_keys = list(catalog.sql_catalog_local_role_keys)
    object_path = kw.get('object_path', None)
    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_local_role_keys:
        sql_catalog_local_role_keys.remove(key)
    catalog.sql_catalog_local_role_keys = tuple(sql_catalog_local_role_keys)
    BaseTemplateItem.uninstall(self, context, **kw)

  # 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 += '\n <key>%s</key>' %(key)
    xml_data += '\n</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)

4038 4039 4040 4041
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4042 4043 4044 4045 4046 4047
    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'
4048
      path = posixpath.join(lang, catalog)
4049 4050
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081

  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':
4082
              continue
4083
          path = path.split('/')
4084 4085 4086 4087 4088 4089
          if len(path) == 2:
            lang = path[0]
            catalog = path[1]
          else:
            lang = path[-3]
            catalog = path[-2]
4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115
          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)
4116
      f = open(path+os.sep+'translation.po', 'wb')
4117 4118 4119 4120
      f.write(str(obj))
      f.close()

  def _importFile(self, file_name, file):
4121
    if posixpath.split(file_name)[1] == 'translation.po':
4122 4123
      text = file.read()
      self._objects[file_name[:-3]] = text
4124

Aurel's avatar
Aurel committed
4125 4126
class LocalRolesTemplateItem(BaseTemplateItem):

4127
  def __init__(self, id_list, **kw):
4128
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4129 4130
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4131 4132 4133
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4134
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4135 4136 4137 4138
      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
4139 4140
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

Christophe Dumez's avatar
Christophe Dumez committed
4141
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4142 4143 4144 4145 4146 4147 4148 4149
  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>'
4150
    xml_data += '\n <local_roles>'
Aurel's avatar
Aurel committed
4151
    for key in local_roles_keys:
4152
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4153 4154
      tuple = local_roles_dict[key]
      for item in tuple:
4155 4156 4157
        xml_data += "\n   <item>%s</item>" %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </local_roles>'
Aurel's avatar
Aurel committed
4158
    # group local roles
4159
    xml_data += '\n <group_local_roles>'
Aurel's avatar
Aurel committed
4160
    for key in group_local_roles_keys:
4161
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4162 4163
      tuple = group_local_roles_dict[key]
      for item in tuple:
4164 4165 4166 4167
        xml_data += '\n   <item>%s</item>' %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </group_local_roles>'
    xml_data += '\n</local_roles_item>'
Aurel's avatar
Aurel committed
4168
    return xml_data
4169

Aurel's avatar
Aurel committed
4170 4171 4172 4173 4174 4175 4176 4177
  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)

4178
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4179
      encode_folders = []
4180
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4181
        if '%' not in folder:
4182
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4183 4184
        else:
          encode_folders.append(folder)
4185
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4186 4187 4188 4189 4190 4191 4192
      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]
4193
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
4194 4195 4196
    local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
4197 4198
      if isinstance(id, unicode):
        id = id.encode('utf-8')
Aurel's avatar
Aurel committed
4199 4200 4201 4202 4203 4204 4205
      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]
4206
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
4207 4208 4209
    group_local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
4210 4211
      if isinstance(id, unicode):
        id = id.encode('utf-8')
Aurel's avatar
Aurel committed
4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241
      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__', {})
4242

4243 4244 4245
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4246
    in part or completely. Each object is separated from its
4247 4248 4249 4250 4251 4252 4253 4254 4255 4256
    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
4257 4258
      - object without optimal actions
      - list of relation between portal type and workflow
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268

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

    - site property definition
      - id
      - type
4269
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4270

4271 4272
    - document/propertysheet/extension/test definition
      - copy of the local file
4273

4274
    - message transalation definition
4275
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4276

4277 4278
    The Business Template properties are exported to the bt folder with
    one property per file
4279

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4280 4281
    Technology:

4282 4283
    - 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
4284

4285
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4286 4287 4288 4289

    Use case:

    - install core ERP5 (the minimum)
4290

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

4293 4294
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4295
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4296 4297 4298 4299 4300
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4301
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4302 4303 4304 4305 4306
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
4307
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4308 4309 4310 4311

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4312
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4313
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4314
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4315
                      , PropertySheet.BusinessTemplate
4316
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4317 4318
                      )

4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335
    # 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
      }

4336 4337
    # This is a global variable
    # Order is important for installation
4338 4339 4340 4341 4342 4343
    # 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 )
4344 4345 4346
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
4347
      '_constraint_item',
4348 4349 4350 4351
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4352
      '_tool_item',
4353 4354 4355 4356
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4357
      '_portal_type_workflow_chain_item',
4358 4359 4360 4361
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4362 4363
      '_category_item',
      '_module_item',
4364
      '_path_item',
4365
      '_skin_item',
4366
      '_preference_item',
4367
      '_action_item',
4368
      '_portal_type_roles_item',
4369
      '_local_roles_item',
4370
      '_catalog_method_item',
4371 4372 4373
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4374
      '_catalog_keyword_key_item',
4375
      '_catalog_datetime_key_item',
4376 4377 4378 4379
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4380
      '_catalog_scriptable_key_item',
4381 4382
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4383 4384 4385 4386
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4387 4388 4389 4390 4391 4392
      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
4393
        self._baseGetTemplateFormatVersion()
4394

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4395 4396 4397
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4398

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4399
      return 0
4400

4401
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4402 4403 4404 4405 4406 4407 4408
    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".
4409 4410
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4411
          # XXX Not good to access the attribute directly,
4412 4413 4414
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4415

4416 4417
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4418 4419 4420 4421 4422 4423
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4424
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4425 4426 4427 4428 4429 4430 4431 4432
        """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)
4433

4434
    security.declareProtected(Permissions.ManagePortal, 'build')
4435
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4436 4437 4438
      """
        Copy existing portal objects to self
      """
4439
      if no_action: return
4440
        # this is use at import of Business Template to get the status built
4441 4442
      # Make sure that everything is sane.
      self.clean()
4443

4444
      self.updateRevisionNumber()
4445

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4446 4447
      self._setTemplateFormatVersion(1)

4448
      # Store all data
4449 4450
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4451
      self._portal_type_workflow_chain_item = \
4452
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
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())
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())
4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494
      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())
4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506
      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())
4507 4508
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4509 4510
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4511 4512
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4513
               self.getTemplateCatalogKeywordKeyList())
4514 4515 4516
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4517 4518
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4519
               self.getTemplateCatalogFullTextKeyList())
4520 4521
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4522
               self.getTemplateCatalogRequestKeyList())
4523 4524
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4525
               self.getTemplateCatalogMultivalueKeyList())
4526 4527 4528
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4529 4530 4531
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4532 4533 4534
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4535 4536 4537
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4538 4539 4540 4541 4542 4543
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4544

4545 4546
      # Build each part
      for item_name in self._item_name_list:
4547 4548 4549 4550
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4551

4552
    build = WorkflowMethod(build)
4553 4554

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4555
      """
4556
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4557
      """
4558
      return self.portal_templates.publish(self, url, username=username,
4559
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4560

4561
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4562
      """
4563
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4564
      """
4565
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4566

4567 4568 4569 4570 4571
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4572 4573 4574 4575 4576 4577 4578 4579 4580 4581
      default_catalog = self.getPortalObject().portal_catalog.getSQLCatalog()
      my_catalog = _getCatalogValue(self)
      if default_catalog is not None and my_catalog is not None \
             and catalog_method is not None and self.getTemplateFormatVersion() == 1:
        if default_catalog.getId() == my_catalog.getId():
          # It is needed to update the catalog only if the default SQLCatalog is modified.
          for method_id in catalog_method._objects.keys():
            if 'related' not in method_id:
              # must update catalog
              return True
4582 4583
      return False

4584
    def preinstall(self, check_dependencies=1, **kw):
4585 4586 4587
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4588
      """
4589

4590 4591 4592 4593 4594
      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()
4595

4596 4597
      modified_object_list = {}
      bt_title = self.getTitle()
4598 4599 4600 4601 4602 4603 4604

      #  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)
4605 4606 4607
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4608
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4609

4610
      # if reinstall business template, must compare to object in ZODB
4611
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4612
      # same if we make a diff and select only one business template
4613
      reinstall = 0
4614 4615
      if installed_bt == self:
        reinstall = 1
4616 4617 4618 4619 4620 4621 4622 4623 4624
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, id=INSTALLED_BT_FOR_DIFF)
          # update portal types properties to get last modifications
          bt2.getPortalTypesProperties()
          bt2.edit(description='tmp bt generated for diff', bt_for_diff=1)
          bt2.build()
          installed_bt = bt2
        else:
          installed_bt = self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF)
4625

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4626
      new_bt_format = self.getTemplateFormatVersion()
4627 4628 4629 4630 4631 4632
      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:
4633
          item = getattr(self, item_name, None)
4634 4635 4636 4637
          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
4638

4639
      for item_name in self._item_name_list:
4640
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4641
        old_item = getattr(installed_bt, item_name, None)
4642
        if new_item is not None:
4643
          if old_item is not None and hasattr(old_item, '_objects'):
4644
            modified_object = new_item.preinstall(context=self, installed_bt=old_item)
4645 4646 4647 4648 4649 4650 4651
            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:
4652
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
4653

4654 4655
      return modified_object_list

4656 4657
    def _install(self, force=1, object_to_update=None, update_translation=0,
                 update_catalog=0, **kw):
4658
      """
Christophe Dumez's avatar
Christophe Dumez committed
4659
        Install a new Business Template, if force, all will be upgraded or installed
4660 4661
        otherwise depends of dict object_to_update
      """
4662 4663 4664 4665
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4666

4667 4668
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
4669 4670
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4671
        if installed_bt.getTemplateFormatVersion() == 0:
4672
          force = 1
4673
        installed_bt.replace(self)
4674

4675 4676 4677 4678
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4679 4680 4681
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4682

4683 4684 4685
      if not force:
        self.checkDependencies()

4686
      site = self.getPortalObject()
4687 4688 4689 4690 4691 4692
      custom_generator_class = getattr(site, '_generator_class', None)
      if custom_generator_class is not None:
        gen = custom_generator_class()
      else:
        from Products.ERP5.ERP5Site import ERP5Generator
        gen = ERP5Generator()
4693 4694 4695
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Activity Tool')
4696
        gen.setupLastTools(site, update=1, create_activities=1)
4697 4698
      if not force:
        if len(object_to_update) == 0:
4699 4700 4701 4702 4703
          # 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():
4704
            LOG('Business Template', 0, 'Updating Business Template Workflows')
4705
            gen.setupWorkflow(site)
4706
          return
4707

4708 4709
      # 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
4710
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
4711 4712 4713 4714 4715
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
4716
      if len(object_to_update) or force:
4717 4718 4719
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
4720
            item.install(self, force=force, object_to_update=object_to_update, trashbin=trashbin)
4721

4722
      # update catalog if necessary
4723 4724
      if force and self.isCatalogUpdatable():
        update_catalog = 1
4725
      if update_catalog:
4726
        catalog = _getCatalogValue(self)
4727
        if (catalog is None) or (not site.isIndexable):
4728 4729 4730 4731 4732
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4733

4734
      # get objects to remove
4735
      # do remove after because we may need backup object from installation
4736
      remove_object_dict = {}
4737 4738
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
4739
          remove_object_dict[path] = action
4740

4741
      # remove object from old business template
4742
      if len(remove_object_dict):
4743
        # XXX: this code assumes that there is an installed_bt
4744
        for item_name in installed_bt._item_name_list:
4745
          item = getattr(installed_bt, item_name, None)
4746
          if item is not None:
4747
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
4748

4749 4750 4751 4752 4753 4754

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

4755
      # check if we have to update business template workflow
4756
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4757
        LOG('Business Template', 0, 'Updating Business Template Workflows')
4758 4759 4760 4761 4762
        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)

4763 4764
      # remove trashbin if empty
      if trashbin is not None:
4765
        if len(trashbin) == 0:
4766 4767
          trash_tool.manage_delObjects([trashbin.getId(),])

4768 4769
      if update_catalog:
        site.ERP5Site_reindexAll()
4770

4771 4772
      # Update translation table, in case we added new portal types or
      # workflow states.
4773 4774
      if update_translation:
        site.ERP5Site_updateTranslationTable()
4775

4776 4777
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
4778

4779
    security.declareProtected(Permissions.ManagePortal, 'install')
4780 4781 4782
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4783
      """
4784
      return self._install(**kw)
4785

4786
    install = WorkflowMethod(install)
4787

4788
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4789
    def reinstall(self, **kw):
4790 4791 4792 4793
      """Reinstall Business Template.
      """
      return self._install(**kw)

4794
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4795

4796
    security.declareProtected(Permissions.ManagePortal, 'trash')
4797 4798
    def trash(self, new_bt, **kw):
      """
4799
        Trash unnecessary items before upgrading to a new business
4800
        template.
4801
        This is similar to uninstall, but different in that this does
4802
        not remove all items.
4803
      """
4804 4805
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4806
        item = getattr(self, item_name, None)
4807 4808
        if item is not None:
          item.trash(
4809
                self,
4810
                getattr(new_bt, item_name))
4811

4812
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
4813
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4814
      """
4815
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4816
      """
4817 4818 4819
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4820
        item = getattr(self, item_name, None)
4821
        if item is not None:
4822
          item.uninstall(self)
4823
      # It is better to clear cache because the uninstallation of a
4824
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
4825
      self.getPortalObject().portal_caches.clearAllCache()
4826

4827 4828
    uninstall = WorkflowMethod(uninstall)

4829
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4830
    def _clean(self):
4831
      """
4832
        Clean built information.
4833
      """
4834
      # First, remove obsolete attributes if present.
4835 4836 4837 4838
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4839
                    '_module_archive',
4840 4841 4842
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4843
                    '_property_sheet_archive'):
4844 4845 4846
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4847 4848
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4849

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

4852
    security.declareProtected(Permissions.AccessContentsInformation,
4853
                              'getBuildingState')
4854
    def getBuildingState(self, default=None, id_only=1):
4855
      """
4856
        Returns the current state in building
4857
      """
4858
      portal_workflow = getToolByName(self, 'portal_workflow')
4859 4860
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4861
      return wf._getWorkflowStateOf(self, id_only=id_only )
4862

4863
    security.declareProtected(Permissions.AccessContentsInformation,
4864
                              'getInstallationState')
4865
    def getInstallationState(self, default=None, id_only=1):
4866
      """
4867
        Returns the current state in installation
4868
      """
4869
      portal_workflow = getToolByName(self, 'portal_workflow')
4870 4871
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4872
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4873

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4874 4875 4876 4877 4878 4879
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4880
      export_string = portal_templates.manage_exportObject(
4881 4882
                                               id=self.getId(),
                                               toxml=1,
4883
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4884
      return export_string
4885

4886
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4887
      """
4888 4889
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4890
      """
4891
      result = getattr(self, id, ())
4892 4893 4894 4895
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4896
        # XXX Why do we need to return a tuple ?
4897 4898
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4899

4900
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4901
      """
4902 4903
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4904
      """
4905
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4906

4907
    def getTemplateBaseCategoryList(self):
4908
      """
4909 4910
      We have to set this method because we want an
      ordered list
4911
      """
4912
      return self._getOrderedList('template_base_category')
4913

4914
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4915
      """
4916 4917
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4918
      """
4919
      return self._getOrderedList('template_workflow_id')
4920

4921
    def getTemplatePortalTypeIdList(self):
4922
      """
4923 4924
      We have to set this method because we want an
      ordered list
4925
      """
4926
      return self._getOrderedList('template_portal_type_id')
4927

4928 4929 4930 4931 4932 4933 4934
    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
4935 4936 4937 4938 4939 4940 4941
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

4942 4943 4944 4945 4946 4947 4948
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

4949 4950 4951 4952 4953 4954
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4955

4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976
    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')

4977
    def getTemplateActionPathList(self):
4978
      """
4979 4980
      We have to set this method because we want an
      ordered list
4981
      """
4982
      return self._getOrderedList('template_action_path')
4983

4984 4985 4986 4987 4988 4989 4990
    def getTemplatePortalTypeRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_roles')

4991
    def getTemplateSkinIdList(self):
4992
      """
4993 4994
      We have to set this method because we want an
      ordered list
4995
      """
4996
      return self._getOrderedList('template_skin_id')
4997

4998
    def getTemplateModuleIdList(self):
4999
      """
5000 5001
      We have to set this method because we want an
      ordered list
5002
      """
5003
      return self._getOrderedList('template_module_id')
5004 5005 5006 5007 5008 5009 5010

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5012 5013 5014 5015 5016 5017 5018
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5019
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5020 5021 5022 5023
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5024
      if self.getBuildingState() != 'built':
5025
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5026
              'Business Template must be built before export'
5027 5028 5029
      if self.getInstallationState() == 'installed':
        raise TemplateConditionError, \
              'Can not export installed Business Template'
5030

Aurel's avatar
Aurel committed
5031 5032 5033 5034 5035 5036 5037
      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)

5038
      # export bt
5039
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
5040
      for prop in self.propertyMap():
5041
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5042
        id = prop['id']
5043
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5044
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5045
          continue
Aurel's avatar
Aurel committed
5046
        value = self.getProperty(id)
5047
        if prop_type in ('text', 'string', 'int', 'boolean'):
5048
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
5049
        elif prop_type in ('lines', 'tokens'):
5050
          bta.addObject(obj=str('\n').join(value), name=id,
5051
                        path=path+os.sep+'bt', ext='')
5052

Aurel's avatar
Aurel committed
5053 5054 5055
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5056

Aurel's avatar
Aurel committed
5057 5058
      return bta.finishCreation()

5059
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5060 5061
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5062
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5063 5064 5065 5066 5067 5068 5069
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
5070
      self._portal_type_workflow_chain_item = \
5071
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
5072 5073 5074 5075 5076 5077 5078 5079 5080 5081
      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())
5082 5083
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
5084 5085 5086 5087 5088 5089 5090 5091
      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())
5092 5093
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115
      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())
5116 5117
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131
      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(
5132
               self.getTemplateCatalogKeywordKeyList())
5133 5134 5135
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
5136 5137
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
5138
               self.getTemplateCatalogFullTextKeyList())
5139 5140
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
5141
               self.getTemplateCatalogRequestKeyList())
5142 5143
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
5144
               self.getTemplateCatalogMultivalueKeyList())
5145 5146 5147
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
5148 5149 5150
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5151 5152 5153
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
5154 5155 5156
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
5157 5158 5159 5160 5161 5162
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
5163

Aurel's avatar
Aurel committed
5164 5165
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5166

5167 5168 5169 5170 5171
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5172 5173 5174
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5175
      return items_list
5176

5177 5178 5179 5180 5181 5182 5183 5184 5185 5186
    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:
5187
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5188
          dependency = dependency_couple_list[0]
5189 5190
          if dependency in (None, ''):
            continue
5191 5192
          version_restriction = None
          if len(dependency_couple_list) > 1:
5193
            version_restriction = dependency_couple_list[1]
5194 5195 5196
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5197 5198 5199
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5200
                  or (version_restriction not in (None, '') and
5201 5202 5203 5204
                     (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)
5205

Aurel's avatar
Aurel committed
5206
    def diffObject(self, REQUEST, **kw):
5207 5208
      """
        Make a diff between an object in the Business Template
5209
        and the same in the Business Template installed in the site
5210 5211 5212 5213
      """

      class_name_dict = {
        'Product' : '_product_item',
5214
        'PropertySheet' : '_property_sheet_item',
5215
        'Constraint' : '_constraint_item',
5216 5217 5218 5219 5220 5221 5222 5223 5224
        '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',
5225
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5226 5227 5228 5229
        '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',
5230 5231 5232 5233
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
5234
        'Preference' : '_preference_item',
5235
        'Action' : '_action_item',
5236
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5237
        'LocalRoles' : '_local_roles_item',
5238 5239 5240
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5241
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5242
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5243 5244 5245 5246
        'CatalogFullTextKey' : '_catalog_full_text_key_item',
        'CatalogRequestKey' : '_catalog_request_key_item',
        'CatalogMultivalueKey' : '_catalog_multivalue_key_item',
        'CatalogTopicKey' : '_catalog_topic_key_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5247
        'Tool': '_tool_item',
5248
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5249 5250
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5251
        }
5252

5253 5254
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5255

Christophe Dumez's avatar
Christophe Dumez committed
5256
      # Get objects
5257
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5258

Aurel's avatar
Aurel committed
5259
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
5260
      # Compare with a given business template
5261
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5262 5263
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5264 5265
        if bt2_id == self.getId():
          compare_to_zodb = 1
5266
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5267 5268
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5269 5270 5271
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5272 5273
          compare_to_zodb = 1
      if compare_to_zodb:
5274
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5275
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5276 5277 5278
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5279

5280 5281
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5282
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5283
        # XXX maybe only build for the given object to gain time
5284
        installed_item.build(self)
5285 5286 5287
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5288

Christophe Dumez's avatar
Christophe Dumez committed
5289
      # Real Zope Objects (can be exported into XML directly by Zope)
5290 5291
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5292
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5293
                     '_skin_item', '_action_item', '_tool_item', ]
5294

Christophe Dumez's avatar
Christophe Dumez committed
5295
      # Not considered as objects by Zope (will be exported into XML manually)
5296
      # XXX Bad naming
5297
      item_list_2 = ['_site_property_item', '_module_item',
5298
                     '_catalog_result_key_item', '_catalog_related_key_item',
5299 5300
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
5301
                     '_catalog_datetime_key_item',
5302 5303 5304 5305
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5306
                     '_catalog_scriptable_key_item',
5307 5308
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5309 5310 5311 5312 5313 5314
                     '_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',
5315
                     '_portal_type_workflow_chain_item',]
5316

Christophe Dumez's avatar
Christophe Dumez committed
5317
      # Text objects (no need to export them into XML)
5318
      # XXX Bad naming
5319 5320
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5321
                     '_test_item', '_message_translation_item',]
5322

5323
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5324 5325 5326
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5327 5328
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
5329
        # XML Export in memory
5330 5331 5332
        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()
5333
        f1.close()
5334 5335 5336 5337
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5338
        # End of XML export
5339

5340
        # Diff between XML objects
5341 5342
        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
5343
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5344 5345 5346
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5347

5348
      elif item_name in item_list_2:
5349
        # Generate XML code manually
5350 5351
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5352 5353
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5354
        # End of XML Code Generation
5355

5356
        # Diff between XML objects
5357 5358
        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
5359
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5360 5361 5362
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5363

5364
      elif item_name in item_list_3:
5365
        # Diff between text objects
5366 5367 5368 5369
        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
5370
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5371 5372
          diff_msg += '\n'.join(diff_list)
        else:
5373
          diff_msg = 'No diff'
5374

5375
      else:
5376
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5377

5378
      if compare_to_zodb:
5379
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5380

5381
      return diff_msg
5382

5383

5384 5385 5386 5387
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5388 5389
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5390 5391 5392 5393 5394 5395 5396
      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 [])
5397 5398
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5399
      p = self.getPortalObject()
5400
      for id in bt_portal_types_id_list:
5401 5402
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5403
          continue
5404
        if len(getattr(portal_type, '_roles', ())) > 0:
5405 5406
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5407

5408 5409 5410 5411
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5412
        action_list = []
5413 5414 5415 5416 5417 5418 5419
        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'):
5420
          base_category_list = portal_type.base_category_list
5421 5422
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
5423

5424 5425 5426 5427
        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)
5428

5429
        for h_id in hidden_content_type_list:
5430 5431 5432
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5433

5434 5435 5436 5437
        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)
5438

5439 5440 5441 5442
        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)
5443

5444 5445 5446 5447
        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)
5448

5449
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5450
                                    if chain != '(Default)']:
5451 5452 5453
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5454

5455 5456 5457 5458
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5459
      bt_action_list.sort()
5460
      bt_wf_chain_list.sort()
5461

5462 5463 5464 5465 5466 5467 5468
      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)
5469 5470 5471 5472 5473 5474 5475 5476 5477
      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:
5478 5479
        raise TemplateConditionError, 'No module defined in business template'

5480 5481 5482 5483 5484 5485 5486 5487
      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:
5488
          return type_list
5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502

        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():
5503
            type_list.update(getChildPortalType(hidden_ptype_id))
5504
        return type_list
5505

5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552
      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

5553 5554 5555
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5556
  setattr(BusinessTemplate, key, None)
5557

5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584
# 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)
5585

5586 5587 5588 5589 5590 5591 5592 5593

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

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