BusinessTemplate.py 211 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
76
from Products.ERP5Type 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
        else:
          # As the list of available actions is not strictly defined,
          # prevent mistake if an action is not handled
          raise ValueError, 'Unknown action "%s"' % action
430

431

432 433 434 435
  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
436
  def export(self, context, bta, **kw):
437
    pass
Aurel's avatar
Aurel committed
438

439 440
  def getKeys(self):
    return self._objects.keys()
441

Aurel's avatar
Aurel committed
442
  def importFile(self, bta, **kw):
443
    bta.importFiles(item=self)
444

445 446 447
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
448
    """
449 450 451 452 453 454 455 456 457 458 459 460 461 462
    meta_type = getattr(aq_base(obj), 'meta_type', None)

    attr_list = [ '_dav_writelocks', '_filepath', '_owner', 'uid',
                  'workflow_history', '__ac_local_roles__' ]
    attr_list += {
        'Script (Python)': ('_lazy_compilation', 'Python_magic'),
      }.get(meta_type, ())

    for attr in attr_list:
      if attr in obj.__dict__:
        delattr(obj, attr)

    if meta_type == 'ERP5 PDF Form':
      if not obj.getProperty('business_template_include_content', 1):
463
        obj.deletePdfContent()
464 465
    elif meta_type == 'Script (Python)':
      obj._code = None
466 467
    return obj

468 469 470
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
471
  """
472

473 474 475 476
  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()
477
      self._archive.clear()
478 479 480
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
481

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

Aurel's avatar
Aurel committed
506
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
507
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
508 509 510
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
511
      relative_url = '/'.join([url,id])
512 513
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
514
      obj = self.removeProperties(obj)
Vincent Pelletier's avatar
Vincent Pelletier committed
515 516 517
      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
518
        groups = deepcopy(obj.groups)
519
      if id_list:
Aurel's avatar
Aurel committed
520
        self.build_sub_objects(context, id_list, relative_url)
521
        for id_ in list(id_list):
522
          obj._delObject(id_)
523
      if hasattr(aq_base(obj), 'groups'):
524 525 526
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
527 528
    return sub_list

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

556 557 558 559
  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):
560
          LOG('Business Template', 0, 'Compiling %s to %s...' % (file.name, compiled_file))
561
          try:
562
              from Shared.DC.xml import ppml
563
              from OFS.XMLExportImport import start_zopedata, save_record, save_zopedata
564
              import pyexpat
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
              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)

587
  def _importFile(self, file_name, file_obj):
588
    # import xml file
589
    if not file_name.endswith('.xml'):
590 591
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
592
      return
593 594 595 596 597
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
598
    __traceback_info__ = 'Importing %s' % file_name
599 600 601 602 603 604 605
    # 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)
606 607
    else:
      obj = connection.importFile(file_obj, customImporters=customImporters)
608
    self.removeProperties(obj)
609 610
    self._objects[file_name[:-4]] = obj

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

642
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
643 644 645
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
646
    subobjects_dict = {}
647
    if trashbin is None: # must return subobjects
648 649 650 651 652 653
      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)
654
        subobjects_dict[subobject_id] = subobject_copy
655
      return subobjects_dict
656 657
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
658
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, **kw)
659
    elif action == 'install':
660
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0, **kw)
661 662 663 664
    else:
      # As the list of available actions is not strictly defined,
      # prevent mistake if an action is not handled
      raise ValueError, 'Unknown action "%s"' % action
665
    return subobjects_dict
666

667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
  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

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

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
952
    trash = kw.get('trash', 0)
953 954 955 956 957
    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
958
      object_keys = self._archive.keys()
959
    for relative_url in object_keys:
960 961
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
962
      try:
963
        container = portal.unrestrictedTraverse(container_path)
964
        object = container._getOb(object_id) # We force access to the object to be sure
965 966
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
967
        if trash and trashbin is not None:
968
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
969 970 971 972 973 974
        if container.meta_type == 'CMF Skins Tool':
          # we are removing a skin folder, check and remove if registered skin selection
          skin_folder = container[object_id]
          registered_skin_selections = getattr(skin_folder, 'business_template_registered_skin_selections', None)
          if registered_skin_selections is not None:
            container.manage_skinLayers(chosen=registered_skin_selections, del_skin=1)
975
        container.manage_delObjects([object_id])
976 977
        if container.aq_parent.meta_type == 'ERP5 Catalog' and len(container.objectIds()) == 0:
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
978
          container.getParentValue().manage_delObjects([container.id])
979
      except (NotFound, KeyError, BadRequest, AttributeError):
980
        # object is already backup and/or removed
981
        pass
982 983
    BaseTemplateItem.uninstall(self, context, **kw)

984 985 986 987 988 989 990 991 992 993 994 995
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

996 997 998 999 1000 1001 1002 1003 1004
  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()
1005 1006
    object_keys.sort()
    object_keys.reverse()
1007 1008
    p = context.getPortalObject()
    for path in object_keys:
1009 1010 1011 1012 1013
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1014 1015 1016
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1017
        try:
Aurel's avatar
Aurel committed
1018 1019
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
1020 1021
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
1022 1023
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1024
                                           keep_subobjects=1)
1025 1026 1027 1028 1029 1030
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1031 1032 1033
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1034

1035 1036 1037 1038 1039 1040 1041 1042 1043
      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.
1044 1045 1046
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1047
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1048 1049
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1050
      if object_id != "":
1051
        path_list.extend(self._resolvePath(
1052
            folder._getOb(object_id),
1053
            relative_url_list + [object_id], id_list[1:]))
1054
    return path_list
Aurel's avatar
Aurel committed
1055

1056 1057 1058
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1059
    keys = self._path_archive.keys()
1060
    keys.sort()
Aurel's avatar
Aurel committed
1061
    for path in keys:
1062 1063 1064
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
1065
      for relative_url in self._resolvePath(p, [], path.split('/')):
1066 1067
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1068
        obj = obj.__of__(context)
1069
        _recursiveRemoveUid(obj)
1070
        id_list = obj.objectIds()
1071
        obj = self.removeProperties(obj)
1072
        if hasattr(aq_base(obj), 'groups'):
1073
          # we must keep groups because it's ereased when we delete subobjects
1074
          groups = deepcopy(obj.groups)
1075
        if len(id_list) > 0:
1076 1077
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1078
          for id_ in list(id_list):
1079
            obj._delObject(id_)
1080
        if hasattr(aq_base(obj), 'groups'):
1081 1082 1083
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1084

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1085 1086 1087 1088 1089 1090 1091 1092
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)

1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
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")
1108
    if len(id_list) != 1:
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
      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():
1121
      pref = portal.unrestrictedTraverse(object_path)
1122
      # XXX getPreferenceState is a bad name
1123 1124 1125
      if pref.getPreferenceState() == 'disabled':
        portal.portal_workflow.doActionFor(
                      pref,
1126 1127 1128 1129
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")

1130 1131
class CategoryTemplateItem(ObjectTemplateItem):

1132 1133
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1134

1135 1136 1137 1138
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1139 1140
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1141
      obj = self.removeProperties(obj)
1142
      id_list = obj.objectIds()
1143
      if id_list:
1144
        self.build_sub_objects(context, id_list, relative_url)
1145
        for id_ in list(id_list):
1146
          obj._delObject(id_)
1147 1148
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1149 1150 1151 1152 1153

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1154 1155
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1156
      _recursiveRemoveUid(obj)
1157
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1158
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1159
      id_list = obj.objectIds()
1160 1161
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1162
        for id_ in list(id_list):
1163
          obj._delObject(id_)
1164
      else:
1165
        for id_ in list(id_list):
1166
          obj._delObject(id_)
1167 1168
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1169

1170 1171 1172 1173 1174 1175 1176 1177
  def beforeInstall(self):
    self._installed_new_category = False

  def onNewObject(self):
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1178 1179
      # reset accessors if we installed a new category
      _aq_reset()
1180

1181 1182
class SkinTemplateItem(ObjectTemplateItem):

1183 1184
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1185

1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
  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

1201
  def install(self, context, trashbin, **kw):
1202
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1203 1204
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1205 1206 1207
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1208
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1209 1210
        fixZSQLMethod(p, obj)

1211
    ps = p.portal_skins
1212 1213 1214 1215
    request = context.REQUEST
    register_skin_selection = request.get('your_register_skin_selection', 1)
    reorder_skin_selection = request.get('your_reorder_skin_selection', 1)
    skin_layer_list = request.get('your_skin_layer_list', ps.getSkinSelections()) 
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
    # 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:
1231 1232
        # user may explicitly choose not to register skin
        if skin_selection not in ps.getSkinSelections() and register_skin_selection:
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
          # 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()
1249 1250
          # add newly created skins to list of skins we care for 
          skin_layer_list.append(skin_selection)
1251 1252 1253
          ps.addSkinSelection(skin_selection, skin_path)

    # Add new folders into skin paths.
1254
    for skin_name, selection in ps.getSkinPaths():
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
      # install only if user selected this skin to be reordered according to priority
      if skin_name in skin_layer_list:      
        new_selection = []
        selection = selection.split(',')
        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]
          skin_id = relative_url.split('/')[-1]
          selection_list = obj.getProperty('business_template_registered_skin_selections', None)
          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
        if reorder_skin_selection:
          new_selection.sort(
            key=lambda x: x in ps.objectIds() and -ps[x].getProperty(
            'business_template_skin_layer_priority', 0) or 0)
        ps.manage_skinLayers(skinpath = tuple(new_selection), skinname = skin_name, add_skin = 1)
1280 1281
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
    p.changeSkin(None)
1282 1283 1284

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
1285 1286 1287 1288
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1289
      object_keys = self._archive.keys()
1290
    ps = context.portal_skins
1291
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
1292 1293 1294 1295 1296 1297 1298
    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)
1299
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
1300
    context.getPortalObject().changeSkin(None)
1301 1302 1303
    ObjectTemplateItem.uninstall(self, context, **kw)


1304
class WorkflowTemplateItem(ObjectTemplateItem):
1305

1306 1307
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1308

1309
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1310 1311
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1312 1313 1314
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
1315
        if installed_bt._objects.has_key(path):
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
          # 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']})
1332 1333 1334 1335 1336 1337 1338 1339
      # 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
1340
    if context.getTemplateFormatVersion() == 1:
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
      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:
1355
            action = 'backup'
1356 1357 1358 1359 1360 1361
          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
1362
            container_url = '/'.join(container_path)
1363 1364 1365 1366 1367 1368
            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
1369
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1370
            container.manage_delObjects([object_id])
1371
          obj = self._objects[path]
1372 1373 1374
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1375 1376 1377 1378 1379
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1380 1381 1382 1383
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1384 1385
class PortalTypeTemplateItem(ObjectTemplateItem):

1386 1387
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1388 1389
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1390 1391 1392
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1393 1394
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1395 1396
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1397 1398 1399
      # remove actions and properties
      action_len = len(obj.listActions())
      obj.deleteActions(selections=range(action_len))
1400
      obj = self.removeProperties(obj)
1401 1402 1403 1404 1405 1406 1407 1408 1409
      # 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
1410 1411
      if hasattr(obj, '_roles'):
        setattr(obj, '_roles', [])
1412 1413
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1414

1415 1416
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1417 1418 1419 1420
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1421 1422
    # We now need to setup the list of workflows corresponding to
    # each portal type
1423
    (default_chain, chain_dict) = getChainByType(context)
1424
    # Set the default chain to the empty string is probably the
1425
    # best solution, by default it is 'default_workflow', which is
1426
    # not very usefull
1427
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1428
    if context.getTemplateFormatVersion() == 1:
1429
      object_list = self._objects
1430
    else:
1431 1432
      object_list = self._archive
    for path in object_list.keys():
1433 1434 1435 1436
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1437
            continue
1438 1439
        obj = object_list[path]
        portal_type = obj.id
1440 1441 1442
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1443 1444
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1445

1446 1447
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1448 1449 1450 1451 1452 1453 1454
  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:
1455
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1456 1457 1458 1459 1460
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1461
        dict[str(ptype)] = str(workflow)
1462 1463 1464 1465
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1466
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1467 1468

  def build(self, context, **kw):
1469 1470 1471 1472 1473
    # 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
1474
    p = context.getPortalObject()
1475
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1476
    for key in self._archive.keys():
1477 1478 1479
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1480
        workflow = wflist[1]
1481
      else:
1482
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1483
        portal_type = wflist[0][:-2]
1484 1485
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1486 1487 1488 1489
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
1490
        if workflow[0] != '-' and \
1491
            workflow_name not in chain_dict['chain_%s' % portal_type]:
1492 1493
          if not self.is_bt_for_diff:
            raise NotFound, 'workflow %s not found in chain for portal_type %s'\
1494
                % (workflow, portal_type)
1495
        if self._objects.has_key(portal_type):
1496 1497
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1498
        else:
1499
          self._objects[portal_type] = [workflow,]
1500
      elif not self.is_bt_for_diff:
1501 1502
        raise NotFound, 'portal type %s not found in workflow chain'\
                                                    % portal_type
1503

Christophe Dumez's avatar
Christophe Dumez committed
1504
  # Function to generate XML Code Manually
1505 1506 1507 1508 1509
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1510
      workflow_list = self._objects[key]
1511 1512 1513
      # XXX Not always a list
      if isinstance(workflow_list, str):
        workflow_list = [workflow_list]
1514 1515 1516 1517 1518
      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>'
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
    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
1535
    (default_chain, chain_dict) = getChainByType(context)
1536
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1537
    # best solution, by default it is 'default_workflow', which is
1538 1539 1540 1541 1542 1543 1544
    # 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':
1545
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1546 1547
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
1548
        if len(path_splitted) < 1:
Jérome Perrin's avatar
Jérome Perrin committed
1549
          continue
1550
        portal_type = path_splitted[-1]
1551
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1552 1553 1554
          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 != '':
1555
            old_chain_workflow_id_set = {}
1556
            # get existent workflow id list
1557 1558
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1559
            # get new workflow id list
1560
            for wf_id in self._objects[path].split(', '):
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
              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
1575 1576
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1577
          else:
Romain Courteaud's avatar
Romain Courteaud committed
1578 1579 1580 1581 1582 1583
            # 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)
1584
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1585 1586
        else:
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1587 1588
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1589

1590 1591
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1592 1593 1594 1595 1596 1597
    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:
1598 1599 1600 1601 1602 1603
      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():
1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615
        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
1616
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1617

1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
  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

1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
  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
1663 1664
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1665 1666 1667
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1668 1669
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1670

1671
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
1672 1673 1674
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
1675 1676 1677 1678
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'

  def build(self, context, **kw):
1679 1680
    types_tool = self.getPortalObject().portal_types
    types_list = list(types_tool.objectIds())
1681
    for key in self._archive.keys():
1682 1683 1684 1685
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
1686 1687 1688 1689 1690
      # 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, ())
1691
      if not allowed_type in prop_value and not self.is_bt_for_diff:
1692 1693 1694 1695
        raise ValueError, "%s  %s not found in portal type %s" % (
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)

1696 1697 1698 1699 1700 1701 1702
      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
1703
  # Function to generate XML Code Manually
1704
  def generateXml(self, path=None):
1705
    dictio = self._objects
1706
    xml_data = '<%s>' %(self.xml_tag,)
1707
    keys = dictio.keys()
1708 1709
    keys.sort()
    for key in keys:
1710
      allowed_list = dictio[key]
1711
      xml_data += '\n <portal_type id="%s">' %(key,)
1712
      for allowed_item in allowed_list:
1713 1714 1715
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726
    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)

1727 1728 1729 1730 1731
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
1732 1733 1734 1735
      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:
1736
          new_key = '%s/%s' % (self.class_property, key)
1737
          new_dict[new_key] = installed_bt._objects[key]
1738 1739 1740
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
1741 1742 1743 1744 1745
        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]
1746
          old_object = installed_bt._objects[path]
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757
          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

1758
  def _importFile(self, file_name, file):
1759
    path, name = posixpath.split(file_name)
1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
    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)
1784
        except AttributeError:
1785 1786 1787 1788 1789 1790 1791 1792
          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:
1793 1794
            if id not in property_list:
              property_list.append(id)
1795
        setattr(portal_type, self.class_property, tuple(property_list))
1796

Aurel's avatar
Aurel committed
1797
  def uninstall(self, context, **kw):
1798
    object_path = kw.get('object_path', None)
1799
    p = context.getPortalObject()
1800
    pt = p.unrestrictedTraverse('portal_types')
1801 1802 1803 1804 1805 1806 1807 1808
    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)
1809
      except AttributeError:
1810 1811 1812
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
1813 1814
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
1815 1816
      for id in property_list:
        if id in original_property_list:
1817
          original_property_list.remove(id)
1818
      setattr(portal_type, self.class_property, tuple(original_property_list))
1819

1820

1821 1822
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

1823
  name = 'Hidden Content Type'
1824 1825 1826
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'

1827

1828 1829
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

1830
  name = 'Property Sheet'
1831 1832 1833
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'

1834

1835 1836
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

1837
  name = 'Base Category'
1838 1839 1840
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'

1841

1842
class CatalogMethodTemplateItem(ObjectTemplateItem):
1843
  """Template Item for catalog methods.
1844

1845 1846 1847 1848 1849
    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.
  """
1850

1851 1852
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1853
    # a mapping to store properties of methods.
1854 1855 1856 1857 1858
    # 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()
1859

1860 1861 1862 1863 1864
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878
  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

1879 1880
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1881

1882
    catalog = _getCatalogValue(self)
1883
    if catalog is None:
1884
      LOG('BusinessTemplate build', 0, 'catalog not found')
1885
      return
1886

1887 1888 1889
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
1890

1891 1892
    for obj in self._objects.values():
      method_id = obj.id
1893 1894
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
1895
      self._is_filtered_archive[method_id] = 0
1896
      if catalog.filter_dict.has_key(method_id):
1897 1898 1899 1900 1901 1902 1903 1904 1905
        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']
1906

Aurel's avatar
Aurel committed
1907
  def export(self, context, bta, **kw):
1908
    catalog = _getCatalogValue(self)
1909 1910 1911 1912
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

Aurel's avatar
Aurel committed
1913 1914 1915 1916
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
1917
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1918
      # create folder and subfolders
1919
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
1920 1921 1922 1923
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
1924 1925
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1926
      # add all datas specific to catalog inside one file
1927
      method_id = obj.id
1928 1929
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

1930
      f = open(object_path, 'wb')
1931
      xml_data = '<catalog_method>'
1932

1933
      for method_property, value in self._method_properties[method_id].items():
1934 1935 1936
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
1937

Aurel's avatar
Aurel committed
1938
      if catalog.filter_dict.has_key(method_id):
1939
        if catalog.filter_dict[method_id]['filtered']:
1940 1941 1942
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
1943 1944 1945 1946
          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'')):
1947 1948 1949
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
1950
              elif type(value) in (type(()), type([])):
1951
                xml_data += '\n <item key="%s" type="tuple">'%(method)
1952
                for item in value:
1953 1954 1955
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
      xml_data += '\n</catalog_method>'
1956
      f.write(xml_data)
Aurel's avatar
Aurel committed
1957
      f.close()
1958

Christophe Dumez's avatar
Christophe Dumez committed
1959 1960 1961 1962 1963 1964
  # 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:
1965 1966
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
Christophe Dumez's avatar
Christophe Dumez committed
1967
    return xml_data
1968

1969 1970
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1971
    catalog = _getCatalogValue(self)
1972 1973 1974 1975 1976 1977 1978
    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)
1979

1980 1981 1982
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1983
    new_bt_format = context.getTemplateFormatVersion()
1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999

    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':
2000
              continue
2001 2002 2003 2004
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2005

2006 2007
    for obj in values:
      method_id = obj.id
2008

2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019
      # 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))
2020

2021 2022
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2023
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2024
        if context.getTemplateFormatVersion() == 1:
2025 2026 2027
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2028
        filter_type = self._filter_type_archive[method_id]
2029 2030 2031
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2032
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2033
        catalog.filter_dict[method_id]['type'] = filter_type
2034
      elif method_id in catalog.filter_dict.keys():
2035
        catalog.filter_dict[method_id]['filtered'] = 0
2036

2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062
      # 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)
2063

2064 2065 2066 2067 2068 2069
        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)
2070

2071
  def uninstall(self, context, **kw):
2072
    catalog = _getCatalogValue(self)
2073 2074 2075
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2076

2077 2078 2079 2080
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2081 2082 2083 2084
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2085
    else:
2086 2087 2088 2089
      try:
        value = self._archive[object_path]
      except KeyError:
        value = None
2090 2091
      if value is not None:
        values.append(value)
2092
    for obj in values:
2093
      method_id = obj.id
2094 2095 2096 2097 2098 2099 2100 2101 2102
      # 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)
2103

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2104
      if catalog.filter_dict.has_key(method_id):
2105
        del catalog.filter_dict[method_id]
2106

2107
    # uninstall objects
2108
    ObjectTemplateItem.uninstall(self, context, **kw)
2109

2110
  def _importFile(self, file_name, file):
2111
    if file_name.endswith('.catalog_keys.xml'):
2112
      # recreate data mapping specific to catalog method
2113 2114
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2115
      xml = parse(file)
2116
      method_list = xml.getElementsByTagName('item')
2117
      for method in method_list:
2118
        key = method.getAttribute('key')
2119 2120
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
2121 2122 2123 2124
          if len(method.getElementsByTagName('value')[0].childNodes):
            value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          else:
            value = ''
2125
          key = str(key)
2126
        elif key_type == "int":
2127
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
2128
          key = str(key)
2129
        elif key_type == "tuple":
2130 2131 2132 2133
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
2134
        else:
2135
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2136
          continue
2137
        if key in catalog_method_list or key in catalog_method_filter_list:
2138
          dict = getattr(self, key, {})
2139
          dict[id] = value
2140 2141 2142
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154
    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, ))
2155

2156
class ActionTemplateItem(ObjectTemplateItem):
2157 2158

  def __init__(self, id_list, **kw):
2159
    # XXX It's look like ObjectTemplateItem __init__
2160 2161 2162 2163 2164 2165
    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

2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186
  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

2187 2188 2189 2190
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2191
      relative_url, value = id.split(' | ')
2192 2193
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
2194
        if getattr(ai, 'id') == value:
2195 2196
          url = posixpath.split(relative_url)
          key = posixpath.join(url[-2], url[-1], value)
2197
          action = ai._getCopy(context)
2198
          action = self.removeProperties(action)
2199
          self._objects[key] = action
Aurel's avatar
Aurel committed
2200
          self._objects[key].wl_clearLocks()
2201 2202
          break
      else:
2203 2204
        if not self.is_bt_for_diff:
          raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
2205

2206 2207 2208
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2209
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2210 2211
      p = context.getPortalObject()
      for id in self._objects.keys():
2212 2213 2214 2215 2216
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2217
          path = id.split('/')
2218 2219
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
2220
          for index in range(len(action_list)):
2221
            if getattr(action_list[index], 'id') == path[-1]:
2222
              # remove previous action
2223
              obj.deleteActions(selections=(index,))
2224
          action = self._objects[id]
2225 2226 2227
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2228
          obj.addAction(
2229 2230
                        id = action.id
                      , name = action.title
2231
                      , action = action_text
2232 2233 2234 2235
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2236 2237
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2238
                      , priority = action.priority
2239
                      , description = action.description
Aurel's avatar
Aurel committed
2240
                    )
2241
          # sort action based on the priority define on it
2242 2243 2244 2245 2246 2247 2248 2249 2250
          # 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
2251
    else:
2252
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2253
      p = context.getPortalObject()
2254 2255
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2256
        relative_url, key, value = self._splitPath(id)
2257 2258
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2259
          if getattr(ai, key) == value:
2260
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2261 2262 2263
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2264
        obj.addAction(
Aurel's avatar
Aurel committed
2265 2266
                      id = action.id
                    , name = action.title
2267
                    , action = action_text
Aurel's avatar
Aurel committed
2268 2269 2270 2271
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2272 2273
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2274
                    )
Aurel's avatar
Aurel committed
2275 2276 2277 2278 2279 2280 2281
        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))
2282 2283
          obj.moveDownActions(selections=tuple(move_down_list))

2284 2285
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2286 2287
    object_path = kw.get("object_path", None)
    if object_path is not None:
2288 2289 2290 2291 2292 2293 2294 2295
      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]
2296
    else:
2297
      keys = self._archive.keys()
2298
    for id in keys:
2299 2300 2301 2302
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313
        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 )
2314 2315
    BaseTemplateItem.uninstall(self, context, **kw)

2316 2317 2318
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2319
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331
    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
2332
        for property in ('id', 'title', 'description',
2333 2334 2335 2336
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
2337 2338 2339 2340
        # condition
        prop_value = getattr(role, 'condition')
        if prop_value:
          type_role_dict['condition'] = prop_value.text
2341
        # multi
2342 2343
        type_role_dict['category'] = role.getCategory()
        type_role_dict['base_category'] = role.getBaseCategory()
2344 2345 2346
        type_role_list.append(type_role_dict)
      self._objects[relative_url] = type_role_list

Christophe Dumez's avatar
Christophe Dumez committed
2347
  # Function to generate XML Code Manually
2348 2349 2350 2351
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2352
      xml_data += "\n  <role id='%s'>" % role['id']
2353 2354 2355 2356 2357
      # 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
2358 2359
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2360
          xml_data += "\n   <property id='%s'>%s</property>" % \
2361 2362 2363
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2364
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2365 2366
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2367
          xml_data += "\n   <multi_property "\
2368
          "id='%s'>%s</multi_property>" % (property, prop_value)
2369 2370
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2371
    return xml_data
2372

2373 2374 2375 2376 2377 2378 2379
  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)
2380 2381
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2382 2383 2384 2385 2386 2387
      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)
2388
    xml_type_roles_list = xml.getElementsByTagName('role')
2389
    for role in xml_type_roles_list:
2390
      id = role.getAttribute('id').encode('utf_8', 'backslashreplace')
2391 2392 2393 2394 2395 2396
      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():
2397
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2398 2399 2400 2401 2402 2403 2404 2405 2406 2407
          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():
2408
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422
          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
2423 2424 2425 2426 2427 2428 2429
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        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))
2430 2431 2432

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2433 2434 2435 2436 2437 2438
    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:
2439
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2440 2441 2442 2443 2444
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2445

2446 2447 2448 2449 2450 2451
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2452 2453
      for property in p.propertyMap():
        if property['id'] == id:
2454
          obj = p.getProperty(id)
2455
          prop_type = property['type']
2456 2457
          break
      else:
2458
        obj = None
2459
      if obj is None and not self.is_bt_for_diff:
2460
        raise NotFound, 'the property %s is not found' % id
2461
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2462

2463 2464 2465 2466 2467 2468
  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
2469 2470
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2471 2472 2473 2474 2475 2476 2477
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2478
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2479
      self._objects[str(id)] = (str(prop_type), value)
2480

2481 2482 2483
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2484
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2485 2486
      p = context.getPortalObject()
      for path in self._objects.keys():
2487 2488 2489 2490
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2491
              continue
2492
          dir, id = posixpath.split(path)
2493
          prop_type, property = self._objects[path]
2494 2495 2496 2497 2498 2499 2500 2501
          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
2502
    else:
2503
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2504
      p = context.getPortalObject()
2505
      for id, property in self._archive.keys():
2506
        property = self._archive[id]
Aurel's avatar
Aurel committed
2507
        if p.hasProperty(id):
2508 2509 2510 2511 2512 2513 2514
          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'])
2515 2516 2517

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2518 2519 2520 2521 2522 2523
    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:
2524 2525 2526 2527
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2528
  # Function to generate XML Code Manually
2529
  def generateXml(self, path=None):
2530
    xml_data = ''
2531
    prop_type, obj = self._objects[path]
2532
    xml_data += '\n <property>'
2533 2534
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
2535
    if prop_type in ('lines', 'tokens'):
2536
      xml_data += '\n  <value>'
2537
      for item in obj:
2538
        if item != '':
2539
          xml_data += '\n   <item>%s</item>' % escape(str(item))
2540
      xml_data += '\n  </value>'
2541
    else:
2542
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
2543
    xml_data += '\n </property>'
2544 2545
    return xml_data

Aurel's avatar
Aurel committed
2546 2547 2548 2549 2550
  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)
2551 2552 2553 2554
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2555
      xml_data += self.generateXml(path)
2556
    xml_data += '\n</site_property>'
2557
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2558

2559 2560 2561 2562 2563 2564 2565
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)
2566 2567 2568 2569 2570 2571 2572 2573
      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
2574

Christophe Dumez's avatar
Christophe Dumez committed
2575
  # Function to generate XML Code Manually
2576
  def generateXml(self, path=None):
2577 2578
    dict = self._objects[path]
    xml_data = '<module>'
2579 2580 2581 2582
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2583 2584
      if key =='permission_list':
        # separe permission dict into xml
2585
        xml_data += '\n <%s>' %(key,)
2586 2587
        permission_list = dict[key]
        for perm in permission_list:
2588 2589 2590 2591 2592
          # the type of the permission defined if we use acquired or not
          if type(perm[1]) == type([]):
            ptype = "list"
          else:
            ptype = "tuple"
2593 2594
          xml_data += "\n  <permission type='%s'>" %(ptype,)
          xml_data += '\n   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2595
          role_list = list(perm[1])
2596
          role_list.sort()
2597
          for role in role_list:
2598 2599 2600
            xml_data += '\n   <role>%s</role>' %(role)
          xml_data += '\n  </permission>'
        xml_data += '\n </%s>' %(key,)
2601
      else:
2602 2603
        xml_data += '\n <%s>%s</%s>' %(key, dict[key], key)
    xml_data += '\n</module>'
2604 2605
    return xml_data

2606 2607 2608 2609 2610
  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)
2611 2612 2613
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
2614
      # expor module one by one
2615
      xml_data = self.generateXml(path=id)
2616
      bta.addObject(obj=xml_data, name=id, path=path)
2617

2618
  def install(self, context, trashbin, **kw):
2619
    portal = context.getPortalObject()
2620 2621
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2622
    if context.getTemplateFormatVersion() == 1:
2623
      items = self._objects
2624
    else:
2625 2626
      items = self._archive

2627 2628
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
2629 2630 2631 2632 2633 2634 2635
    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]
2636
        path, id = posixpath.split(id)
2637 2638
        if id in portal.objectIds():
          module = portal._getOb(id)
2639
          module.portal_type = str(mapping['portal_type'])
2640 2641 2642
        else:
          module = portal.newContent(id=id, portal_type=str(mapping['portal_type']))
        module.setTitle(str(mapping['title']))
2643
        for name, role_list in list(mapping['permission_list']):
2644
          acquire = (type(role_list) == type([]))
2645
          if name in valid_permissions:
2646
            module.manage_permission(name, roles=role_list, acquire=acquire)
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656

  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:
2657
          perm_type = perm.getAttribute('type').encode() or None
2658 2659 2660 2661 2662 2663 2664 2665 2666
          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))
2667 2668 2669 2670
          if perm_type == "list" or perm_type is None:
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681
          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

2682
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2683 2684 2685
    trash = kw.get('trash', 0)
    if trash:
      return
2686 2687 2688 2689 2690 2691
    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]
2692 2693
    p = context.getPortalObject()
    id_list = p.objectIds()
2694
    for id in keys:
2695
      if id in id_list:
2696
        try:
2697
          if trash and trashbin is not None:
2698 2699
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2700
          p.manage_delObjects([id])
2701
        except NotFound:
2702
          pass
2703 2704
    BaseTemplateItem.uninstall(self, context, **kw)

2705 2706 2707
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2708 2709

class DocumentTemplateItem(BaseTemplateItem):
2710 2711 2712 2713
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2714 2715 2716 2717

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

2720
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2721 2722
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2723
      new_keys = self._objects.keys()
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733
      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
2734 2735 2736 2737 2738 2739
      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:
2740 2741
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
2742
        else: # new object
2743 2744
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
2745 2746 2747 2748
          # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
2749 2750
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
2751 2752 2753 2754 2755
    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
2756
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2757
      for id in self._objects.keys():
2758 2759 2760 2761 2762 2763
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
2764
          path, name = posixpath.split(id)
2765 2766
          # This raises an exception if the file already exists.
          try:
2767
            globals()[self.local_file_writer_name](name, text, create=0)
2768
          except IOError, error:
2769
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
2770 2771
            if error.errno :
              raise
2772 2773 2774
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
2775
    else:
2776 2777 2778
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
2779
        # This raises an exception if the file exists.
2780
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
2781 2782
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
2783 2784

  def uninstall(self, context, **kw):
2785
    object_path = kw.get('object_path', None)
2786 2787 2788 2789 2790
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
2791
      globals()[self.local_file_remover_name](id)
2792 2793
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
2794 2795 2796 2797 2798 2799
  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():
2800 2801
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
2802

2803
  def _importFile(self, file_name, file):
2804 2805 2806
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2807
    text = file.read()
2808
    self._objects[file_name[:-3]]=text
2809

2810 2811 2812 2813 2814 2815
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

2816 2817 2818 2819 2820
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
2821

2822 2823 2824
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
2825 2826
  # Extension needs no import
  local_file_importer_name = None
2827 2828 2829 2830 2831
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
2832
  # Test needs no import
2833 2834 2835
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
2836

2837 2838 2839
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
2840 2841 2842

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2843 2844 2845 2846
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2847
    if len(role_list) > 0:
2848
      self._objects[self.__class__.__name__+'/'+'role_list'] = role_list
Aurel's avatar
Aurel committed
2849

2850
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2851 2852
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2853
      new_roles = self._objects.keys()
2854
      if installed_bt.id == INSTALLED_BT_FOR_DIFF:
2855 2856
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
2857 2858 2859
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
2860 2861
        for key in old_keys:
          new_dict[key] = ''
2862
        installed_bt._objects = new_dict
2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875
      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):
2876
    p = context.getPortalObject()
2877
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2878
    if context.getTemplateFormatVersion() == 1:
2879
      role_list = self._objects.keys()
2880
    else:
2881
      role_list = self._archive.keys()
2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893
    # 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
2894
    for role in role_list:
2895 2896 2897 2898 2899 2900 2901 2902 2903 2904
      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
2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916

  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)

2917 2918 2919 2920 2921 2922 2923 2924 2925
  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
2926
      if role in roles and role not in new_roles:
2927 2928 2929
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
2930
  # Function to generate XML Code Manually
2931
  def generateXml(self, path):
2932
    obj = self._objects[path]
2933
    xml_data = '<role_list>'
2934 2935
    obj.sort()
    for role in obj:
2936 2937
      xml_data += '\n <role>%s</role>' %(role)
    xml_data += '\n</role_list>'
2938 2939
    return xml_data

Aurel's avatar
Aurel committed
2940 2941 2942 2943 2944 2945
  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():
2946
      xml_data = self.generateXml(path=path)
2947
      bta.addObject(obj=xml_data, name=path, path=None,)
2948

2949 2950
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2951
  def build(self, context, **kw):
2952
    catalog = _getCatalogValue(self)
2953 2954 2955
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2956
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2957
    key_list = []
2958
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2959
      if key in sql_search_result_keys:
2960
        key_list.append(key)
2961
      elif not self.is_bt_for_diff:
2962
        raise NotFound, 'Result key "%r" not found in catalog' %(key,)
2963
    if len(key_list) > 0:
2964
      self._objects[self.__class__.__name__+'/'+'result_key_list'] = key_list
2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975

  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

2976
  def install(self, context, trashbin, **kw):
2977
    catalog = _getCatalogValue(self)
2978 2979 2980
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2981

2982
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2983
    if context.getTemplateFormatVersion() == 1:
2984 2985
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
2986 2987 2988
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2989
    else:
2990
      keys = self._archive.keys()
2991 2992
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2993
    # XXX same as related key
Aurel's avatar
Aurel committed
2994
    if update_dict.has_key('result_key_list') or force:
2995
      if not force:
Aurel's avatar
Aurel committed
2996
        action = update_dict['result_key_list']
2997
        if action == 'nothing':
Aurel's avatar
Aurel committed
2998
          return
2999
      for key in keys:
3000 3001
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
3002
      catalog.sql_search_result_keys = sql_search_result_keys
3003

3004
  def uninstall(self, context, **kw):
3005
    catalog = _getCatalogValue(self)
3006 3007 3008 3009
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3010
    object_path = kw.get('object_path', None)
3011 3012 3013 3014 3015
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3016 3017
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
3018
    catalog.sql_search_result_keys = sql_search_result_keys
3019 3020
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3021
  # Function to generate XML Code Manually
3022
  def generateXml(self, path=None):
3023
    obj = self._objects[path]
3024
    xml_data = '<key_list>'
3025 3026
    obj.sort()
    for key in obj:
3027 3028
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3029 3030
    return xml_data

Aurel's avatar
Aurel committed
3031 3032 3033 3034 3035
  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)
3036
    for path in self._objects.keys():
3037
      xml_data = self.generateXml(path=path)
3038
      bta.addObject(obj=xml_data, name=path, path=None)
3039

3040 3041
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3042
  def build(self, context, **kw):
3043
    catalog = _getCatalogValue(self)
3044 3045 3046
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3047
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
3048
    key_list = []
3049
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3050
      if key in sql_search_related_keys:
3051
        key_list.append(key)
3052
      elif not self.is_bt_for_diff:
3053
        raise NotFound, 'Related key "%r" not found in catalog' %(key,)
3054
    if len(key_list) > 0:
3055
      self._objects[self.__class__.__name__+'/'+'related_key_list'] = key_list
3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066

  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

3067
  def install(self, context, trashbin, **kw):
3068
    catalog = _getCatalogValue(self)
3069 3070 3071
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3072

3073
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3074
    if context.getTemplateFormatVersion() == 1:
3075
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3076
        return
3077 3078 3079
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3080
    else:
3081
      keys = self._archive.keys()
3082 3083
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3084
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
3085
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3086
      if not force:
Aurel's avatar
Aurel committed
3087 3088 3089 3090
        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
3091 3092 3093
        if action == 'nothing':
          return
      for key in keys:
3094 3095
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
3096
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
3097

3098
  def uninstall(self, context, **kw):
3099
    catalog = _getCatalogValue(self)
3100 3101 3102
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3103
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
3104
    object_path = kw.get('object_path', None)
3105 3106 3107 3108 3109
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3110 3111 3112 3113 3114
      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
3115
  # Function to generate XML Code Manually
3116
  def generateXml(self, path=None):
3117
    obj = self._objects[path]
3118
    xml_data = '<key_list>'
3119 3120
    obj.sort()
    for key in obj:
3121 3122
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3123 3124
    return xml_data

Aurel's avatar
Aurel committed
3125 3126 3127 3128 3129 3130
  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():
3131
      xml_data = self.generateXml(path=path)
3132
      bta.addObject(obj=xml_data, name=path, path=None)
3133

3134 3135
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3136
  def build(self, context, **kw):
3137
    catalog = _getCatalogValue(self)
3138 3139 3140
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3141
    sql_search_result_tables = list(catalog.sql_search_tables)
3142
    key_list = []
3143
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3144
      if key in sql_search_result_tables:
3145
        key_list.append(key)
3146
      elif not self.is_bt_for_diff:
3147
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
3148
    if len(key_list) > 0:
3149
      self._objects[self.__class__.__name__+'/'+'result_table_list'] = key_list
3150 3151 3152 3153 3154 3155 3156 3157 3158 3159

  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
3160

3161
  def install(self, context, trashbin, **kw):
3162
    catalog = _getCatalogValue(self)
3163 3164 3165
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3166

3167
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3168
    if context.getTemplateFormatVersion() == 1:
3169
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3170
        return
3171 3172 3173
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3174
    else:
3175
      keys = self._archive.keys()
3176 3177
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3178
    # XXX same as related keys
Aurel's avatar
Aurel committed
3179
    if update_dict.has_key('result_table_list') or force:
3180
      if not force:
Aurel's avatar
Aurel committed
3181
        action = update_dict['result_table_list']
3182
        if action == 'nothing':
Aurel's avatar
Aurel committed
3183
          return
3184
      for key in keys:
3185 3186
        if key not in sql_search_tables:
          sql_search_tables.append(key)
3187
      catalog.sql_search_tables = tuple(sql_search_tables)
3188 3189

  def uninstall(self, context, **kw):
3190
    catalog = _getCatalogValue(self)
3191 3192 3193 3194
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
3195
    object_path = kw.get('object_path', None)
3196 3197 3198 3199 3200
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3201 3202
      if key in sql_search_tables:
        sql_search_tables.remove(key)
3203
    catalog.sql_search_tables = sql_search_tables
3204 3205
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3206
  # Function to generate XML Code Manually
3207
  def generateXml(self, path=None):
3208
    obj = self._objects[path]
3209
    xml_data = '<key_list>'
3210 3211
    obj.sort()
    for key in obj:
3212 3213
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3214 3215
    return xml_data

Aurel's avatar
Aurel committed
3216 3217 3218 3219 3220 3221
  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():
3222
      xml_data = self.generateXml(path=path)
3223
      bta.addObject(obj=xml_data, name=path, path=None)
3224

3225 3226
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3227 3228

  def build(self, context, **kw):
3229
    catalog = _getCatalogValue(self)
3230 3231 3232 3233 3234 3235 3236 3237
    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)
3238
      elif not self.is_bt_for_diff:
3239
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3240
    if len(key_list) > 0:
3241
      self._objects[self.__class__.__name__+'/'+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3242

3243 3244 3245 3246 3247 3248 3249 3250 3251
  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
3252 3253

  def install(self, context, trashbin, **kw):
3254
    catalog = _getCatalogValue(self)
3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267
    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()
3268 3269
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281
    # 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):
3282
    catalog = _getCatalogValue(self)
3283 3284 3285 3286
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3287
    object_path = kw.get('object_path', None)
3288 3289
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3290
    else:
3291 3292 3293 3294 3295 3296 3297
      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
3298
  # Function to generate XML Code Manually
3299 3300 3301 3302 3303
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3304 3305
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3306
    return xml_data
Aurel's avatar
Aurel committed
3307 3308 3309 3310

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3311 3312 3313 3314 3315
    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)
3316

3317 3318 3319 3320 3321 3322 3323 3324
# 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
3325
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3326 3327 3328 3329
    key_list = []
    for key in self._archive.keys():
      if key in sql_datetime_keys:
        key_list.append(key)
3330
      elif not self.is_bt_for_diff:
3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350
        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

3351
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377
    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
3378
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408
    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)      
      
3409 3410
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3411

3412
  def build(self, context, **kw):
3413
    catalog = _getCatalogValue(self)
3414 3415 3416 3417 3418 3419 3420 3421
    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)
3422
      elif not self.is_bt_for_diff:
3423
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
3424
    if len(key_list) > 0:
3425
      self._objects[self.__class__.__name__+'/'+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3426

3427 3428 3429 3430 3431 3432 3433 3434 3435
  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
3436

3437
  def install(self, context, trashbin, **kw):
3438
    catalog = _getCatalogValue(self)
3439 3440 3441
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3442

3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463
    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
3464

3465
  def uninstall(self, context, **kw):
3466
    catalog = _getCatalogValue(self)
3467 3468 3469 3470
    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)
3471
    object_path = kw.get('object_path', None)
3472 3473 3474 3475 3476 3477 3478 3479 3480 3481
    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
3482
  # Function to generate XML Code Manually
3483 3484 3485 3486 3487
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3488 3489
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505
    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):
3506
    catalog = _getCatalogValue(self)
3507 3508 3509 3510 3511 3512 3513 3514
    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)
3515
      elif not self.is_bt_for_diff:
3516
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
3517
    if len(key_list) > 0:
3518
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530

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

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

  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):
3714
    catalog = _getCatalogValue(self)
3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741
    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):
3742
    catalog = _getCatalogValue(self)
3743 3744 3745 3746
    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)
3747
    object_path = kw.get('object_path', None)
3748 3749 3750 3751 3752 3753 3754 3755 3756 3757
    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
3758
  # Function to generate XML Code Manually
3759 3760 3761 3762 3763
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3764 3765
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776
    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)

3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788
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)
3789
      elif not self.is_bt_for_diff:
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 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868
        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)

3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881
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)
3882
      elif not self.is_bt_for_diff:
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 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974
        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)
3975
      elif not self.is_bt_for_diff:
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 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054
        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)

4055 4056 4057 4058
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4059 4060 4061 4062 4063 4064
    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'
4065
      path = posixpath.join(lang, catalog)
4066 4067
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098

  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':
4099
              continue
4100
          path = path.split('/')
4101 4102 4103 4104 4105 4106
          if len(path) == 2:
            lang = path[0]
            catalog = path[1]
          else:
            lang = path[-3]
            catalog = path[-2]
4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132
          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)
4133
      f = open(path+os.sep+'translation.po', 'wb')
4134 4135 4136 4137
      f.write(str(obj))
      f.close()

  def _importFile(self, file_name, file):
4138
    if posixpath.split(file_name)[1] == 'translation.po':
4139 4140
      text = file.read()
      self._objects[file_name[:-3]] = text
4141

Aurel's avatar
Aurel committed
4142 4143
class LocalRolesTemplateItem(BaseTemplateItem):

4144
  def __init__(self, id_list, **kw):
4145
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4146 4147
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4148 4149 4150
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4151
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4152 4153 4154 4155
      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
4156 4157
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

Christophe Dumez's avatar
Christophe Dumez committed
4158
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4159 4160 4161 4162 4163 4164 4165 4166
  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>'
4167
    xml_data += '\n <local_roles>'
Aurel's avatar
Aurel committed
4168
    for key in local_roles_keys:
4169
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4170 4171
      tuple = local_roles_dict[key]
      for item in tuple:
4172 4173 4174
        xml_data += "\n   <item>%s</item>" %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </local_roles>'
Aurel's avatar
Aurel committed
4175
    # group local roles
4176
    xml_data += '\n <group_local_roles>'
Aurel's avatar
Aurel committed
4177
    for key in group_local_roles_keys:
4178
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4179 4180
      tuple = group_local_roles_dict[key]
      for item in tuple:
4181 4182 4183 4184
        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
4185
    return xml_data
4186

Aurel's avatar
Aurel committed
4187 4188 4189 4190 4191 4192 4193 4194
  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)

4195
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4196
      encode_folders = []
4197
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4198
        if '%' not in folder:
4199
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4200 4201
        else:
          encode_folders.append(folder)
4202
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4203 4204 4205 4206 4207 4208 4209
      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]
4210
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
4211 4212 4213
    local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
4214 4215
      if isinstance(id, unicode):
        id = id.encode('utf-8')
Aurel's avatar
Aurel committed
4216 4217 4218 4219 4220 4221 4222
      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]
4223
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
4224 4225 4226
    group_local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
4227 4228
      if isinstance(id, unicode):
        id = id.encode('utf-8')
Aurel's avatar
Aurel committed
4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245
      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
4246 4247 4248 4249 4250
        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)
Aurel's avatar
Aurel committed
4251 4252 4253 4254 4255 4256 4257 4258

  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__', {})
4259

4260 4261 4262
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4263
    in part or completely. Each object is separated from its
4264 4265 4266 4267 4268 4269 4270 4271 4272 4273
    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
4274 4275
      - object without optimal actions
      - list of relation between portal type and workflow
4276 4277 4278 4279 4280 4281 4282 4283 4284 4285

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

    - site property definition
      - id
      - type
4286
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4287

4288 4289
    - document/propertysheet/extension/test definition
      - copy of the local file
4290

4291
    - message transalation definition
4292
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4293

4294 4295
    The Business Template properties are exported to the bt folder with
    one property per file
4296

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4297 4298
    Technology:

4299 4300
    - 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
4301

4302
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4303 4304 4305 4306

    Use case:

    - install core ERP5 (the minimum)
4307

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

4310 4311
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4312
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4313 4314 4315 4316 4317
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4318
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4319 4320 4321 4322 4323
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
4324
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4325 4326 4327 4328

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4329
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4330
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4331
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4332
                      , PropertySheet.BusinessTemplate
4333
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4334 4335
                      )

4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352
    # 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
      }

4353 4354
    # This is a global variable
    # Order is important for installation
4355 4356 4357 4358 4359 4360
    # 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 )
4361 4362 4363
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
4364
      '_constraint_item',
4365 4366 4367 4368
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4369
      '_tool_item',
4370 4371 4372 4373
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4374
      '_portal_type_workflow_chain_item',
4375 4376 4377 4378
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4379 4380
      '_category_item',
      '_module_item',
4381
      '_path_item',
4382
      '_skin_item',
4383
      '_preference_item',
4384
      '_action_item',
4385
      '_portal_type_roles_item',
4386
      '_local_roles_item',
4387
      '_catalog_method_item',
4388 4389 4390
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4391
      '_catalog_keyword_key_item',
4392
      '_catalog_datetime_key_item',
4393 4394 4395 4396
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4397
      '_catalog_scriptable_key_item',
4398 4399
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4400 4401 4402 4403
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4404 4405 4406 4407 4408 4409
      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
4410
        self._baseGetTemplateFormatVersion()
4411

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4412 4413 4414
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4415

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4416
      return 0
4417

4418
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4419 4420 4421 4422 4423 4424 4425
    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".
4426 4427
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4428
          # XXX Not good to access the attribute directly,
4429 4430 4431
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4432

4433 4434
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4435 4436 4437 4438 4439 4440
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4441
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4442 4443 4444 4445 4446 4447 4448 4449
        """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)
4450

4451
    security.declareProtected(Permissions.ManagePortal, 'build')
4452
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4453 4454 4455
      """
        Copy existing portal objects to self
      """
4456
      if no_action: return
4457
        # this is use at import of Business Template to get the status built
4458 4459
      # Make sure that everything is sane.
      self.clean()
4460

4461
      self.updateRevisionNumber()
4462

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4463 4464
      self._setTemplateFormatVersion(1)

4465
      # Store all data
4466 4467
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4468
      self._portal_type_workflow_chain_item = \
4469
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4470 4471 4472 4473 4474 4475 4476 4477 4478 4479
      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())
4480 4481
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
4482 4483 4484 4485 4486 4487 4488 4489
      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())
4490 4491
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511
      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())
4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523
      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())
4524 4525
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4526 4527
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4528 4529
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4530
               self.getTemplateCatalogKeywordKeyList())
4531 4532 4533
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4534 4535
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4536
               self.getTemplateCatalogFullTextKeyList())
4537 4538
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4539
               self.getTemplateCatalogRequestKeyList())
4540 4541
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4542
               self.getTemplateCatalogMultivalueKeyList())
4543 4544 4545
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4546 4547 4548
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4549 4550 4551
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4552 4553 4554
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4555 4556 4557 4558 4559 4560
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4561

4562 4563
      # Build each part
      for item_name in self._item_name_list:
4564 4565 4566 4567
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4568

4569
    build = WorkflowMethod(build)
4570 4571

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4572
      """
4573
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4574
      """
4575
      return self.portal_templates.publish(self, url, username=username,
4576
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4577

4578
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4579
      """
4580
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4581
      """
4582
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4583

4584 4585 4586 4587 4588
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4589 4590 4591 4592 4593 4594 4595 4596 4597 4598
      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
4599 4600
      return False

4601
    def preinstall(self, check_dependencies=1, **kw):
4602 4603 4604
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4605
      """
4606

4607 4608 4609 4610 4611
      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()
4612

4613 4614
      modified_object_list = {}
      bt_title = self.getTitle()
4615 4616 4617 4618 4619 4620 4621

      #  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)
4622 4623 4624
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4625
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4626

4627
      # if reinstall business template, must compare to object in ZODB
4628
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4629
      # same if we make a diff and select only one business template
4630
      reinstall = 0
4631 4632
      if installed_bt == self:
        reinstall = 1
4633 4634 4635 4636 4637 4638 4639 4640 4641
        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)
4642

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4643
      new_bt_format = self.getTemplateFormatVersion()
4644 4645 4646 4647 4648 4649
      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:
4650
          item = getattr(self, item_name, None)
4651 4652 4653 4654
          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
4655

4656
      for item_name in self._item_name_list:
4657
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4658
        old_item = getattr(installed_bt, item_name, None)
4659
        if new_item is not None:
4660
          if old_item is not None and hasattr(old_item, '_objects'):
4661
            modified_object = new_item.preinstall(context=self, installed_bt=old_item)
4662 4663 4664 4665 4666 4667 4668
            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:
4669
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
4670

4671 4672
      return modified_object_list

4673 4674
    def _install(self, force=1, object_to_update=None, update_translation=0,
                 update_catalog=0, **kw):
4675
      """
Christophe Dumez's avatar
Christophe Dumez committed
4676
        Install a new Business Template, if force, all will be upgraded or installed
4677 4678
        otherwise depends of dict object_to_update
      """
4679 4680 4681 4682
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4683

4684 4685
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
4686 4687
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4688
        if installed_bt.getTemplateFormatVersion() == 0:
4689
          force = 1
4690
        installed_bt.replace(self)
4691

4692 4693 4694 4695
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4696 4697 4698
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4699

4700 4701 4702
      if not force:
        self.checkDependencies()

4703
      site = self.getPortalObject()
4704 4705 4706 4707 4708 4709
      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()
4710 4711 4712
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Activity Tool')
4713
        gen.setupLastTools(site, update=1, create_activities=1)
4714 4715
      if not force:
        if len(object_to_update) == 0:
4716 4717 4718 4719 4720
          # 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():
4721
            LOG('Business Template', 0, 'Updating Business Template Workflows')
4722
            gen.setupWorkflow(site)
4723
          return
4724

4725 4726
      # 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
4727
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
4728 4729 4730 4731 4732
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
4733
      if len(object_to_update) or force:
4734 4735 4736
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
4737
            item.install(self, force=force, object_to_update=object_to_update, trashbin=trashbin)
4738

4739
      # update catalog if necessary
4740 4741
      if force and self.isCatalogUpdatable():
        update_catalog = 1
4742
      if update_catalog:
4743
        catalog = _getCatalogValue(self)
4744
        if (catalog is None) or (not site.isIndexable):
4745 4746 4747 4748 4749
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4750

4751
      # get objects to remove
4752
      # do remove after because we may need backup object from installation
4753
      remove_object_dict = {}
4754 4755
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
4756
          remove_object_dict[path] = action
4757

4758
      # remove object from old business template
4759
      if len(remove_object_dict):
4760
        # XXX: this code assumes that there is an installed_bt
4761
        for item_name in installed_bt._item_name_list:
4762
          item = getattr(installed_bt, item_name, None)
4763
          if item is not None:
4764
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
4765

4766 4767 4768 4769 4770 4771

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

4772
      # check if we have to update business template workflow
4773
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4774
        LOG('Business Template', 0, 'Updating Business Template Workflows')
4775 4776 4777 4778 4779
        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)

4780 4781
      # remove trashbin if empty
      if trashbin is not None:
4782
        if len(trashbin) == 0:
4783 4784
          trash_tool.manage_delObjects([trashbin.getId(),])

4785 4786
      if update_catalog:
        site.ERP5Site_reindexAll()
4787

4788 4789
      # Update translation table, in case we added new portal types or
      # workflow states.
4790 4791
      if update_translation:
        site.ERP5Site_updateTranslationTable()
4792

4793 4794
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
4795

4796
    security.declareProtected(Permissions.ManagePortal, 'install')
4797 4798 4799
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4800
      """
4801
      return self._install(**kw)
4802

4803
    install = WorkflowMethod(install)
4804

4805
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4806
    def reinstall(self, **kw):
4807 4808 4809 4810
      """Reinstall Business Template.
      """
      return self._install(**kw)

4811
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4812

4813
    security.declareProtected(Permissions.ManagePortal, 'trash')
4814 4815
    def trash(self, new_bt, **kw):
      """
4816
        Trash unnecessary items before upgrading to a new business
4817
        template.
4818
        This is similar to uninstall, but different in that this does
4819
        not remove all items.
4820
      """
4821 4822
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4823
        item = getattr(self, item_name, None)
4824 4825
        if item is not None:
          item.trash(
4826
                self,
4827
                getattr(new_bt, item_name))
4828

4829
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
4830
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4831
      """
4832
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4833
      """
4834 4835 4836
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4837
        item = getattr(self, item_name, None)
4838
        if item is not None:
4839
          item.uninstall(self)
4840
      # It is better to clear cache because the uninstallation of a
4841
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
4842
      self.getPortalObject().portal_caches.clearAllCache()
4843

4844 4845
    uninstall = WorkflowMethod(uninstall)

4846
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4847
    def _clean(self):
4848
      """
4849
        Clean built information.
4850
      """
4851
      # First, remove obsolete attributes if present.
4852 4853 4854 4855
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4856
                    '_module_archive',
4857 4858 4859
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4860
                    '_property_sheet_archive'):
4861 4862 4863
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4864 4865
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4866

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

4869
    security.declareProtected(Permissions.AccessContentsInformation,
4870
                              'getBuildingState')
4871
    def getBuildingState(self, default=None, id_only=1):
4872
      """
4873
        Returns the current state in building
4874
      """
4875
      portal_workflow = getToolByName(self, 'portal_workflow')
4876 4877
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4878
      return wf._getWorkflowStateOf(self, id_only=id_only )
4879

4880
    security.declareProtected(Permissions.AccessContentsInformation,
4881
                              'getInstallationState')
4882
    def getInstallationState(self, default=None, id_only=1):
4883
      """
4884
        Returns the current state in installation
4885
      """
4886
      portal_workflow = getToolByName(self, 'portal_workflow')
4887 4888
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4889
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4890

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4891 4892 4893 4894 4895 4896
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4897
      export_string = portal_templates.manage_exportObject(
4898 4899
                                               id=self.getId(),
                                               toxml=1,
4900
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4901
      return export_string
4902

4903
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4904
      """
4905 4906
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4907
      """
4908
      result = getattr(self, id, ())
4909 4910 4911 4912
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4913
        # XXX Why do we need to return a tuple ?
4914 4915
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4916

4917
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4918
      """
4919 4920
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4921
      """
4922
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4923

4924
    def getTemplateBaseCategoryList(self):
4925
      """
4926 4927
      We have to set this method because we want an
      ordered list
4928
      """
4929
      return self._getOrderedList('template_base_category')
4930

4931
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4932
      """
4933 4934
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4935
      """
4936
      return self._getOrderedList('template_workflow_id')
4937

4938
    def getTemplatePortalTypeIdList(self):
4939
      """
4940 4941
      We have to set this method because we want an
      ordered list
4942
      """
4943
      return self._getOrderedList('template_portal_type_id')
4944

4945 4946 4947 4948 4949 4950 4951
    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
4952 4953 4954 4955 4956 4957 4958
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

4959 4960 4961 4962 4963 4964 4965
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

4966 4967 4968 4969 4970 4971
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4972

4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993
    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')

4994
    def getTemplateActionPathList(self):
4995
      """
4996 4997
      We have to set this method because we want an
      ordered list
4998
      """
4999
      return self._getOrderedList('template_action_path')
5000

5001 5002 5003 5004 5005 5006 5007
    def getTemplatePortalTypeRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_roles')

5008 5009 5010 5011 5012 5013 5014
    def getTemplateLocalRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_local_roles')

5015
    def getTemplateSkinIdList(self):
5016
      """
5017 5018
      We have to set this method because we want an
      ordered list
5019
      """
5020
      return self._getOrderedList('template_skin_id')
5021

5022
    def getTemplateModuleIdList(self):
5023
      """
5024 5025
      We have to set this method because we want an
      ordered list
5026
      """
5027
      return self._getOrderedList('template_module_id')
5028 5029 5030 5031 5032 5033 5034

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5036 5037 5038 5039 5040 5041 5042
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5043
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5044 5045 5046 5047
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5048
      if self.getBuildingState() != 'built':
5049
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5050
              'Business Template must be built before export'
5051 5052 5053
      if self.getInstallationState() == 'installed':
        raise TemplateConditionError, \
              'Can not export installed Business Template'
5054

Aurel's avatar
Aurel committed
5055 5056 5057 5058 5059 5060 5061
      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)

5062
      # export bt
5063
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
5064
      for prop in self.propertyMap():
5065
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5066
        id = prop['id']
5067
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5068
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5069
          continue
Aurel's avatar
Aurel committed
5070
        value = self.getProperty(id)
5071
        if prop_type in ('text', 'string', 'int', 'boolean'):
5072
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
5073
        elif prop_type in ('lines', 'tokens'):
5074
          bta.addObject(obj=str('\n').join(value), name=id,
5075
                        path=path+os.sep+'bt', ext='')
5076

Aurel's avatar
Aurel committed
5077 5078 5079
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5080

Aurel's avatar
Aurel committed
5081 5082
      return bta.finishCreation()

5083
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5084 5085
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5086
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5087 5088 5089 5090 5091 5092 5093
      """
      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())
5094
      self._portal_type_workflow_chain_item = \
5095
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
5096 5097 5098 5099 5100 5101 5102 5103 5104 5105
      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())
5106 5107
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
5108 5109 5110 5111 5112 5113 5114 5115
      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())
5116 5117
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139
      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())
5140 5141
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155
      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(
5156
               self.getTemplateCatalogKeywordKeyList())
5157 5158 5159
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
5160 5161
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
5162
               self.getTemplateCatalogFullTextKeyList())
5163 5164
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
5165
               self.getTemplateCatalogRequestKeyList())
5166 5167
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
5168
               self.getTemplateCatalogMultivalueKeyList())
5169 5170 5171
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
5172 5173 5174
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5175 5176 5177
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
5178 5179 5180
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
5181 5182 5183 5184 5185 5186
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
5187

Aurel's avatar
Aurel committed
5188 5189
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5190

5191 5192 5193 5194 5195
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5196 5197 5198
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5199
      return items_list
5200

5201 5202 5203 5204 5205 5206 5207 5208 5209 5210
    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:
5211
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5212
          dependency = dependency_couple_list[0]
5213 5214
          if dependency in (None, ''):
            continue
5215 5216
          version_restriction = None
          if len(dependency_couple_list) > 1:
5217
            version_restriction = dependency_couple_list[1]
5218 5219 5220
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5221 5222 5223
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5224
                  or (version_restriction not in (None, '') and
5225 5226 5227 5228
                     (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)
5229

Aurel's avatar
Aurel committed
5230
    def diffObject(self, REQUEST, **kw):
5231 5232
      """
        Make a diff between an object in the Business Template
5233
        and the same in the Business Template installed in the site
5234 5235 5236 5237
      """

      class_name_dict = {
        'Product' : '_product_item',
5238
        'PropertySheet' : '_property_sheet_item',
5239
        'Constraint' : '_constraint_item',
5240 5241 5242 5243 5244 5245 5246 5247 5248
        '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',
5249
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5250 5251 5252 5253
        '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',
5254 5255 5256 5257
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
5258
        'Preference' : '_preference_item',
5259
        'Action' : '_action_item',
5260
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5261
        'LocalRoles' : '_local_roles_item',
5262 5263 5264
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5265
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5266
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5267 5268 5269 5270
        '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
5271
        'Tool': '_tool_item',
5272
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5273 5274
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5275
        }
5276

5277 5278
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5279

Christophe Dumez's avatar
Christophe Dumez committed
5280
      # Get objects
5281
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5282

Aurel's avatar
Aurel committed
5283
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
5284
      # Compare with a given business template
5285
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5286 5287
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5288 5289
        if bt2_id == self.getId():
          compare_to_zodb = 1
5290
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5291 5292
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5293 5294 5295
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5296 5297
          compare_to_zodb = 1
      if compare_to_zodb:
5298
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5299
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5300 5301 5302
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5303

5304 5305
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5306
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5307
        # XXX maybe only build for the given object to gain time
5308
        installed_item.build(self)
5309 5310 5311
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5312

Christophe Dumez's avatar
Christophe Dumez committed
5313
      # Real Zope Objects (can be exported into XML directly by Zope)
5314 5315
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5316
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5317
                     '_skin_item', '_action_item', '_tool_item', ]
5318

Christophe Dumez's avatar
Christophe Dumez committed
5319
      # Not considered as objects by Zope (will be exported into XML manually)
5320
      # XXX Bad naming
5321
      item_list_2 = ['_site_property_item', '_module_item',
5322
                     '_catalog_result_key_item', '_catalog_related_key_item',
5323 5324
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
5325
                     '_catalog_datetime_key_item',
5326 5327 5328 5329
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5330
                     '_catalog_scriptable_key_item',
5331 5332
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5333 5334 5335 5336 5337 5338
                     '_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',
5339
                     '_portal_type_workflow_chain_item',]
5340

Christophe Dumez's avatar
Christophe Dumez committed
5341
      # Text objects (no need to export them into XML)
5342
      # XXX Bad naming
5343 5344
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5345
                     '_test_item', '_message_translation_item',]
5346

5347
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5348 5349 5350
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5351 5352
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
5353
        # XML Export in memory
5354 5355 5356
        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()
5357
        f1.close()
5358 5359 5360 5361
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5362
        # End of XML export
5363

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

5372
      elif item_name in item_list_2:
5373
        # Generate XML code manually
5374 5375
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5376 5377
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5378
        # End of XML Code Generation
5379

5380
        # Diff between XML objects
5381 5382
        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
5383
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5384 5385 5386
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5387

5388
      elif item_name in item_list_3:
5389
        # Diff between text objects
5390 5391 5392 5393
        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
5394
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5395 5396
          diff_msg += '\n'.join(diff_list)
        else:
5397
          diff_msg = 'No diff'
5398

5399
      else:
5400
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5401

5402
      if compare_to_zodb:
5403
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5404

5405
      return diff_msg
5406

5407

5408 5409 5410 5411
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5412 5413
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5414 5415 5416 5417 5418 5419 5420
      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 [])
5421 5422
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5423
      p = self.getPortalObject()
5424
      for id in bt_portal_types_id_list:
5425 5426
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5427
          continue
5428
        if len(getattr(portal_type, '_roles', ())) > 0:
5429 5430
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5431

5432 5433 5434 5435
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5436
        action_list = []
5437 5438 5439 5440 5441 5442 5443
        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'):
5444
          base_category_list = portal_type.base_category_list
5445 5446
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
5447

5448 5449 5450 5451
        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)
5452

5453
        for h_id in hidden_content_type_list:
5454 5455 5456
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5457

5458 5459 5460 5461
        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)
5462

5463 5464 5465 5466
        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)
5467

5468 5469 5470 5471
        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)
5472

5473
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5474
                                    if chain != '(Default)']:
5475 5476 5477
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5478

5479 5480 5481 5482
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5483
      bt_action_list.sort()
5484
      bt_wf_chain_list.sort()
5485

5486 5487 5488 5489 5490 5491 5492
      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)
5493 5494 5495 5496 5497 5498 5499 5500 5501
      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:
5502 5503
        raise TemplateConditionError, 'No module defined in business template'

5504 5505 5506 5507 5508 5509 5510 5511
      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:
5512
          return type_list
5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526

        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():
5527
            type_list.update(getChildPortalType(hidden_ptype_id))
5528
        return type_list
5529

5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576
      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

5577 5578 5579
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5580
  setattr(BusinessTemplate, key, None)
5581

5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608
# 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)
5609

5610 5611 5612 5613 5614 5615 5616 5617

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

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