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

29
from Shared.DC.ZRDB.Connection import Connection as RDBConnection
30
from Globals import Persistent, PersistentMapping
31
from Acquisition import Implicit, aq_base
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32 33
from AccessControl import ClassSecurityInfo
from Products.CMFCore.utils import getToolByName
34
from Products.ERP5Type.Base import WorkflowMethod
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
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
53
from Products.ERP5Type import Permissions, PropertySheet
Jean-Paul Smets's avatar
Jean-Paul Smets committed
54
from Products.ERP5Type.XMLObject import XMLObject
55
from Products.ERP5Type.RoleInformation import RoleInformation
56
import fnmatch
57
import re, os
Aurel's avatar
Aurel committed
58
from OFS.Traversable import NotFound
59 60
from OFS import XMLExportImport
from cStringIO import StringIO
Aurel's avatar
Aurel committed
61
from copy import deepcopy
62
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
63 64 65 66
import OFS.XMLExportImport
customImporters={
    XMLExportImport.magic: XMLExportImport.importXML,
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
67

68
from zLOG import LOG, WARNING
69
from warnings import warn
Aurel's avatar
Aurel committed
70 71
from OFS.ObjectManager import customImporters
from gzip import GzipFile
72
from xml.dom.minidom import parse
73
from Products.CMFCore.Expression import Expression
Aurel's avatar
Aurel committed
74
import tarfile
75
from urllib import quote, unquote
76
from difflib import unified_diff
77
import posixpath
78
import shutil
79
    
80 81
# those attributes from CatalogMethodTemplateItem are kept for
# backward compatibility
Aurel's avatar
Aurel committed
82 83
catalog_method_list = ('_is_catalog_list_method_archive',
                       '_is_uncatalog_method_archive',
84 85
                       '_is_clear_method_archive',
                       '_is_filtered_archive',)
86

87 88 89
catalog_method_filter_list = ('_filter_expression_archive',
                              '_filter_expression_instance_archive',
                              '_filter_type_archive',)
90

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

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

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

117 118 119 120 121
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.
  """
122 123
  if hasattr(aq_base(obj), 'uid'):
    obj.uid = None
124 125 126
  for subobj in obj.objectValues():
    _recursiveRemoveUid(subobj)

127
def removeAll(entry):
128 129 130
  warn('removeAll is deprecated; use shutil.rmtree instead.',
       DeprecationWarning)
  shutil.rmtree(entry, True)
Aurel's avatar
Aurel committed
131

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
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)

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
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
176 177 178
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
179
  """
Aurel's avatar
Aurel committed
180 181 182 183 184 185 186 187 188 189 190 191

  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
192

Aurel's avatar
Aurel committed
193 194 195 196 197
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
198
    Class archiving business template into a folder tree
199
  """
Aurel's avatar
Aurel committed
200 201 202 203 204 205
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
206
      shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
207 208 209
      os.makedirs(self.path)

  def addFolder(self, name=''):
210
     if name !='':
211
      name = os.path.normpath(name)
Aurel's avatar
Aurel committed
212
      path = os.path.join(self.path, name)
213
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
214 215 216
        os.makedirs(path)
      return path

217
  def addObject(self, obj, name, path=None, ext='.xml'):
218 219 220
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
221 222 223
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
224
      if '%' not in path:
225 226 227 228
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
Aurel's avatar
Aurel committed
229
      object_path = os.path.join(path, name)
230
    f = open(object_path+ext, 'wb')
231
    f.write(str(obj))
Aurel's avatar
Aurel committed
232 233 234
    f.close()

  def _initImport(self, file=None, path=None, **kw):
235
    # Normalize the paths to eliminate the effect of double-slashes.
236 237 238 239 240 241 242 243
    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
244

245
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
246 247 248
    """
      Import file from a local folder
    """
249
    class_name = item.__class__.__name__
250 251 252 253 254 255 256
    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:]
257
          if '%' in file_name:
258
            file_name = unquote(file_name)
259
          item._importFile(file_name, file)
260
        finally:
261
          file.close()
262

Aurel's avatar
Aurel committed
263 264 265 266 267 268
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
269
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
270 271 272 273 274
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
275
      shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
276 277 278 279 280 281
      os.makedirs(self.path)
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)

  def addFolder(self, name=''):
282
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
283
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
284 285
      os.makedirs(name)

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

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
306
    shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
307 308 309 310 311
    return self.fobj

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

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

340
class TemplateConditionError(Exception): pass
341
class TemplateConflictError(Exception): pass
342
class BusinessTemplateMissingDependency(Exception): pass
343

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

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

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

360
  def preinstall(self, context, installed_bt, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
361 362 363 364 365 366 367 368
    """
      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
369 370
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
371
      new_keys = self._objects.keys()
372
      for path in new_keys:
373
        if installed_bt._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
374
          # compare objects to see it there are changes
375 376
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
377 378
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
379
          # else, compared versions are identical, don't overwrite the old one
380 381
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
382
      # list removed objects
383 384 385 386 387 388 389
      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):
390
    pass
391 392 393

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

395
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
396 397 398 399 400 401
    """
      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.
    """
402 403 404
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
405
    keys.reverse()
406 407 408 409 410 411 412 413 414 415 416
    # 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)
417

418

419 420 421 422
  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
423
  def export(self, context, bta, **kw):
424
    pass
Aurel's avatar
Aurel committed
425

426 427
  def getKeys(self):
    return self._objects.keys()
428

Aurel's avatar
Aurel committed
429
  def importFile(self, bta, **kw):
430
    bta.importFiles(item=self)
431

432 433 434
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
435
    """
436 437 438 439
    _marker = []
    base_obj = aq_base(obj)
    
    if getattr(base_obj, '_dav_writelocks', _marker) is not _marker:
440
      del aq_base(obj)._dav_writelocks
441
    if getattr(base_obj, '__ac_local_roles__', _marker) is not _marker:
442 443
      # remove local roles
      obj.__ac_local_roles__ = None
444
    if getattr(base_obj, '_owner', _marker) is not _marker:
445
      obj._owner = None
446
    if getattr(base_obj, 'uid', _marker) is not _marker:
447
      obj.uid = None
448
    if getattr(base_obj, '_filepath', _marker) is not _marker:
449
      obj._filepath = None
450 451 452
    if getattr(base_obj, 'workflow_history', _marker) is not _marker:
      if getattr(base_obj.__class__, 'workflow_history', _marker) \
          is not _marker:
453 454 455
        obj.workflow_history = None
      else:
        del obj.workflow_history
456 457
    if getattr(base_obj, 'meta_type', None) == 'Script (Python)':
      if getattr(base_obj, '_code', _marker) is not _marker:
458
        obj._code = None
459
      if getattr(base_obj, 'Python_magic', _marker) is not _marker:
460
        obj.Python_magic = None
461
    elif getattr(base_obj, 'meta_type', None) == 'ERP5 PDF Form' :
462 463
      if not obj.getProperty('business_template_include_content', 1) :
        obj.deletePdfContent()
464 465
    return obj

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

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

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

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

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

554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
  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):
          print 'Compiling %s to %s...' % (file.name, compiled_file)
          try:
              import Shared.DC.xml.ppml
              ppml = Shared.DC.xml.ppml
              from OFS.XMLExportImport import start_zopedata, save_record, save_zopedata
              import Shared.DC.xml.pyexpat.pyexpat
              pyexpat=Shared.DC.xml.pyexpat.pyexpat
              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 588
  def _importFile(self, file_name, file):
    # import xml file
589 590 591
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
592 593 594 595 596
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
597 598
    __traceback_info__ = 'Importing %s' % file_name
    obj = connection.importFile(file, customImporters=customImporters)
599
    # obj = connection.importFile(self._compileXML(file))
600 601
    self._objects[file_name[:-4]] = obj

602
  def preinstall(self, context, installed_bt, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
603
    #XXX -12 used here is -len('TemplateItem')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
604 605
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
606 607 608 609 610 611 612
      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]
613 614
          new_object = self.removeProperties(new_object)
          old_object = self.removeProperties(old_object)
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
          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

634
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
635 636 637
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
638
    subobjects_dict = {}
639
    if trashbin is None: # must return subobjects
640 641 642 643 644 645
      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)
646
        subobjects_dict[subobject_id] = subobject_copy
647
      return subobjects_dict
648 649
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
650
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, **kw)
651
    elif action == 'install':
652
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0, **kw)
653
    return subobjects_dict
654

655 656 657
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
658
    if context.getTemplateFormatVersion() == 1:
659
      groups = {}
660
      old_groups = {}
661 662 663 664 665
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
666 667 668 669 670 671
        if update_dict.has_key(path) or force:
          # get action for the oject
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
672
          action = 'backup'
673
          # get subobjects in path
674 675 676
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
677 678 679 680
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
681
            container_url = '/'.join(container_path)
682 683 684 685
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
686
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
687 688
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
689
              container_container = portal.unrestrictedTraverse(container_path[:-1])
690 691 692 693 694
              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)
695 696
            else:
              raise
697 698
          subobjects_dict = {}
          # Object already exists
699 700 701
          old_obj = container._getOb(object_id, None)
          if old_obj is not None:
            if getattr(aq_base(old_obj), 'groups', None) is not None:
702 703 704 705 706
              # 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)
707
            subobjects_dict = self._backupObject(action, trashbin,
708
                                                 container_path, object_id)
709 710
            container.manage_delObjects([object_id])
          # install object
711
          obj = self._objects[path]
712 713 714
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
715
          if getattr(aq_base(obj), 'groups', None) is not None:
716
            # we must keep original order groups
717
            # because they change when we add subobjects
718
            groups[path] = deepcopy(obj.groups)
719
          # copy the object
720
          obj = obj._getCopy(container)
721 722 723 724 725
          try:
            container._setObject(object_id, obj)
          except AttributeError:
            LOG("BT, install", 0, object_id)
            raise
726
          obj = container._getOb(object_id)
727 728
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
729
          self.REQUEST.set('is_business_template_installation', 1)
730 731
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
732
          # if portal types upgrade, set backup properties
733 734
          if getattr(obj, 'meta_type', None) == 'ERP5 Type Information' and \
              len(subobjects_dict) > 0:
735
            setattr(obj, 'allowed_content_types',
736
                    subobjects_dict['allowed_content_type_list'] or [])
737
            setattr(obj, 'hidden_content_type_list',
738
                    subobjects_dict['hidden_content_type_list'] or [])
739
            setattr(obj, 'property_sheet_list',
740
                    subobjects_dict['property_sheet_list'] or [])
741
            setattr(obj, 'base_category_list',
742
                    subobjects_dict['base_category_list'] or [])
743 744 745 746
            setattr(obj, '_roles', subobjects_dict['roles_list'] or [])
            # set actions
            action_list = subobjects_dict['action_list']
            for action in action_list:
747 748 749
              action_text = action.action
              if isinstance(action_text, Expression):
                action_text = action_text.text
750 751
              obj.addAction(id = action.id
                            , name = action.title
752
                            , action = action_text
753 754 755 756 757 758 759 760 761 762 763
                            , condition = action.getCondition()
                            , permission = action.permissions
                            , category = action.category
                            , visible = action.visible
                            , icon = getattr(action, 'icon', None) and action.icon.text or ''
                            , priority = action.priority
                            )
            # set workflow chain
            wf_chain = subobjects_dict['workflow_chain']
            chain_dict = getChainByType(context)[1]
            default_chain = ''
764
            chain_dict['chain_%s' % (object_id)] = wf_chain
765
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
766
          # import sub objects if there is
767
          elif len(subobjects_dict) > 0:
768
            # get a jar
769 770
            connection = obj._p_jar
            o = obj
771
            while connection is None:
772 773
              o = o.aq_parent
              connection = o._p_jar
774
            # import subobjects
775
            for subobject_id, subobject_data in subobjects_dict.iteritems():
776
              if obj._getOb(subobject_id, None) is None:
777 778
                subobject_data.seek(0)
                subobject = connection.importFile(subobject_data)
779
                obj._setObject(subobject_id, subobject)
780
          if obj.meta_type in ('Z SQL Method',):
781
            fixZSQLMethod(portal, obj)
782
      # now put original order group
783 784
      # we remove object not added in forms
      # we put old objects we have kept
785
      for path, new_groups_dict in groups.iteritems():
786 787 788 789 790 791 792 793 794
        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
795
          # excetp the one that had to be removed
796 797 798 799
          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'):
800 801
              continue
            widget_in_form = 0
802 803
            for group_id, group_value_list in new_groups_dict.iteritems():
              if widget_id in group_value_list:
804 805 806 807 808 809
                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:
810
              for old_group_id, old_group_values in old_groups_dict.iteritems():
811 812 813 814 815 816 817 818 819 820 821
                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,]
822
                  obj.group_list = list(obj.group_list) + ['not_assigned']
823
          # second check all widget_id in order are in form
824 825
          for group_id, group_value_list in new_groups_dict.iteritems():
            for widget_id in tuple(group_value_list):
826 827 828
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
829
                group_value_list.remove(widget_id)
830
          # now set new group object
831
          obj.groups = new_groups_dict
Aurel's avatar
Aurel committed
832
    else:
833 834
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
835
      portal = context.getPortalObject()
836
      for relative_url in self._archive.keys():
837
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
838 839 840 841
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
842
        if object_id in container_ids:    # Object already exists
843
          self._backupObject('backup', trashbin, container_path, object_id)
844
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
845
        # Set a hard link
846 847 848 849 850 851
        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',):
852
          fixZSQLMethod(portal, obj)
853 854 855

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
856
    trash = kw.get('trash', 0)
857 858 859 860 861
    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
862
      object_keys = self._archive.keys()
863
    for relative_url in object_keys:
864 865
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
866
      try:
867
        container = portal.unrestrictedTraverse(container_path)
868
        object = container._getOb(object_id) # We force access to the object to be sure
869 870
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
871
        if trash and trashbin is not None:
872 873
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
        container.manage_delObjects([object_id])
874 875
        if container.aq_parent.meta_type == 'ERP5 Catalog' and len(container.objectIds()) == 0:
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
876
          container.getParentValue().manage_delObjects([container.id])
877
      except (NotFound, KeyError, BadRequest, AttributeError):
878
        # object is already backup and/or removed
879
        pass
880 881
    BaseTemplateItem.uninstall(self, context, **kw)

882 883 884 885 886 887 888 889 890 891 892 893
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

894 895 896 897 898 899 900 901 902
  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()
903 904
    object_keys.sort()
    object_keys.reverse()
905 906
    p = context.getPortalObject()
    for path in object_keys:
907 908 909 910 911
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
912 913 914
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
915
        try:
Aurel's avatar
Aurel committed
916 917
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
918 919
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
920 921
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
922
                                           keep_subobjects=1)
923 924 925 926 927 928
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

929 930 931
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
932

933 934 935 936 937 938 939 940 941
      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.
942 943 944
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
945
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
946 947
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
948
      if object_id != "":
949
        path_list.extend(self._resolvePath(
950
            folder._getOb(object_id),
951
            relative_url_list + [object_id], id_list[1:]))
952
    return path_list
Aurel's avatar
Aurel committed
953

954 955 956
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
957
    keys = self._path_archive.keys()
958
    keys.sort()
Aurel's avatar
Aurel committed
959
    for path in keys:
960 961 962
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
963
      for relative_url in self._resolvePath(p, [], path.split('/')):
964 965
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
966
        obj = obj.__of__(context)
967
        _recursiveRemoveUid(obj)
968
        id_list = obj.objectIds()
969
        obj = self.removeProperties(obj)
970
        if hasattr(aq_base(obj), 'groups'):
971
          # we must keep groups because it's ereased when we delete subobjects
972
          groups = deepcopy(obj.groups)
973
        if len(id_list) > 0:
974 975
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
976
          for id_ in list(id_list):
977
            obj._delObject(id_)
978
        if hasattr(aq_base(obj), 'groups'):
979 980 981
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
982

Yoshinori Okuji's avatar
Yoshinori Okuji committed
983 984 985 986 987 988 989 990
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)

991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
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")
1006
    if len(id_list) != 1:
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
      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():
1019
      pref = portal.unrestrictedTraverse(object_path)
1020
      # XXX getPreferenceState is a bad name
1021 1022 1023
      if pref.getPreferenceState() == 'disabled':
        portal.portal_workflow.doActionFor(
                      pref,
1024 1025 1026 1027 1028
                      'enable_action',
                      wf_id='preference_workflow',
                      comment="Initialized during Business Template " \
                              "installation.")

1029 1030
class CategoryTemplateItem(ObjectTemplateItem):

1031 1032
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1033

1034 1035 1036 1037
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1038 1039
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1040
      obj = self.removeProperties(obj)
1041
      id_list = obj.objectIds()
1042
      if id_list:
1043
        self.build_sub_objects(context, id_list, relative_url)
1044
        for id_ in list(id_list):
1045
          obj._delObject(id_)
1046 1047
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1048 1049 1050 1051 1052

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1053 1054
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1055
      _recursiveRemoveUid(obj)
1056
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1057
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1058
      id_list = obj.objectIds()
1059 1060
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1061
        for id_ in list(id_list):
1062
          obj._delObject(id_)
1063
      else:
1064
        for id_ in list(id_list):
1065
          obj._delObject(id_)
1066 1067
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1068

1069
  def install(self, context, trashbin, **kw):
1070 1071
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1072
    if context.getTemplateFormatVersion() == 1:
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          else:
            action = 'backup'
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
          obj = self._objects[path]
          obj = obj.__of__(category_tool)
          container_path = path.split('/')[:-1]
          category_id = path.split('/')[-1]
          try:
            container = category_tool.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
            container_url = '/'.join(container_path)
            if update_dict.has_key(container_url):
              if update_dict[container_url] == 'nothing':
1098
                continue
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
            raise
          container_ids = container.objectIds()
          # Object already exists
          object_uid = None
          subobjects_dict = {}
          if category_id in container_ids:
            object_uid = container[category_id].getUid()
            subobjects_dict = self._backupObject(action, trashbin, container_path, category_id)
            container.manage_delObjects([category_id])
          category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
          if object_uid is not None:
            category.setUid(object_uid)
1111 1112 1113 1114
          for prop in obj.propertyIds():
            if prop not in ('id', 'uid'):
              try:
                prop_value = obj.getProperty(prop, evaluate=0)
1115
              except TypeError: # the getter doesn't support evaluate=
1116 1117
                prop_value = obj.getProperty(prop)
              category.setProperty(prop, prop_value)
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
          # import sub objects if there is
          if len(subobjects_dict) > 0:
            # get a jar
            connection = obj._p_jar
            o = category
            while connection is None:
              o = o.aq_parent
              connection = o._p_jar
            # import subobjects
            for subobject_id in subobjects_dict.keys():
              subobject_data = subobjects_dict[subobject_id]
              subobject_data.seek(0)
              subobject = connection.importFile(subobject_data)
              if subobject_id not in category.objectIds():
                category._setObject(subobject_id, subobject)
1133
    else:
1134
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1135 1136 1137
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
      for relative_url in self._archive.keys():
        obj = self._archive[relative_url]
        # Wrap the object by an aquisition wrapper for _aq_dynamic.
        obj = obj.__of__(category_tool)
        container_path = relative_url.split('/')[0:-1]
        category_id = relative_url.split('/')[-1]
        container = category_tool.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
        if category_id in container_ids:    # Object already exists
          # XXX call backup here
          subobjects_dict = self._backupObject('backup', trashbin, container_path, category_id)
          container.manage_delObjects([category_id])
        category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
        for prop in obj.propertyIds():
          if prop not in ('id', 'uid'):
            try:
              prop_value = obj.getProperty(prop, evaluate=0)
            except TypeError: # the getter doesn't support evaluate=
              prop_value = obj.getProperty(prop)
            category.setProperty(prop, prop_value)
        # import sub objects if there is
        if len(subobjects_dict) > 0:
          # get a jar
          connection = obj._p_jar
          o = category
          while connection is None:
            o = o.aq_parent
            connection = o._p_jar
          # import subobjects
          for subobject_id in subobjects_dict.keys():
            subobject_data = subobjects_dict[subobject_id]
            subobject_data.seek(0)
            subobject = connection.importFile(subobject_data)
            if subobject_id not in category.objectIds():
              category._setObject(subobject_id, subobject)
1173

1174

1175 1176
class SkinTemplateItem(ObjectTemplateItem):

1177 1178
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1179

1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
  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

1195
  def install(self, context, trashbin, **kw):
1196
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1197 1198
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1199 1200 1201
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1202
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1203 1204
        fixZSQLMethod(p, obj)

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

    # Add new folders into skin paths.
1241 1242 1243 1244
    for skin_name, selection in ps.getSkinPaths():
      new_selection = []
      selection = selection.split(',')
      for relative_url in self._archive.keys():
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1245
        if context.getTemplateFormatVersion() == 1:
1246 1247
          if update_dict.has_key(relative_url) or force:
            if not force:
1248
              if update_dict[relative_url] == 'nothing':
1249
                continue
1250
          obj = self._objects[relative_url]
1251
        else:
1252
          obj = self._archive[relative_url]
1253
        skin_id = relative_url.split('/')[-1]
1254
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
        if selection_list is None or skin_name in selection_list:
          if skin_id not in selection:
            new_selection.append(skin_id)
      new_selection.extend(selection)
      # sort the layer according to skin priorities
      new_selection.sort(lambda a, b : cmp(
        b in ps.objectIds() and ps[b].getProperty(
            'business_template_skin_layer_priority', 0) or 0,
        a in ps.objectIds() and ps[a].getProperty(
            'business_template_skin_layer_priority', 0) or 0))
      ps.manage_skinLayers(skinpath = tuple(new_selection), skinname = skin_name, add_skin = 1)
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
    p.changeSkin(None)
1268 1269 1270

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


1290
class WorkflowTemplateItem(ObjectTemplateItem):
1291

1292 1293
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1294

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


1370 1371
class PortalTypeTemplateItem(ObjectTemplateItem):

1372 1373
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1374 1375
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1376 1377 1378
    self._workflow_chain_archive = PersistentMapping()

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

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

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

1452
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1453 1454

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

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

1569 1570
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1571 1572 1573 1574 1575 1576
    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:
1577 1578 1579 1580 1581 1582 1583 1584
      path_splitted = path.split('/', 1)
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
      id = 'chain_%s' % portal_type
      if id in chain_dict.keys():
        del chain_dict[id]
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1585

1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
  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

1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
  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
1631 1632
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1633 1634 1635
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1636 1637
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1638

1639
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
1640 1641 1642
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
1643 1644 1645 1646
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'

  def build(self, context, **kw):
1647 1648
    types_tool = self.getPortalObject().portal_types
    types_list = list(types_tool.objectIds())
1649
    for key in self._archive.keys():
1650
      portal_type, allowed_type = key.split(' | ')
1651 1652 1653 1654 1655 1656
      # 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, ())
      if not allowed_type in prop_value:
1657 1658 1659 1660
        raise ValueError, "%s  %s not found in portal type %s" % (
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)

1661 1662 1663 1664 1665 1666 1667
      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
1668
  # Function to generate XML Code Manually
1669
  def generateXml(self, path=None):
1670
    dictio = self._objects
1671
    xml_data = '<%s>' %(self.xml_tag,)
1672
    keys = dictio.keys()
1673 1674
    keys.sort()
    for key in keys:
1675
      allowed_list = dictio[key]
1676
      xml_data += '\n <portal_type id="%s">' %(key,)
1677
      for allowed_item in allowed_list:
1678 1679 1680
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
    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)

1692 1693 1694 1695 1696
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
1697 1698 1699 1700
      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:
1701
          new_key = '%s/%s' % (self.class_property, key)
1702
          new_dict[new_key] = installed_bt._objects[key]
1703 1704 1705
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
1706 1707 1708 1709 1710
        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]
1711
          old_object = installed_bt._objects[path]
1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722
          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

1723
  def _importFile(self, file_name, file):
1724
    path, name = posixpath.split(file_name)
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
    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)
1749
        except AttributeError:
1750 1751 1752 1753 1754 1755 1756 1757
          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:
1758 1759
            if id not in property_list:
              property_list.append(id)
1760 1761
        setattr(portal_type, self.class_property, list(property_list))

Aurel's avatar
Aurel committed
1762
  def uninstall(self, context, **kw):
1763
    object_path = kw.get('object_path', None)
1764
    p = context.getPortalObject()
1765
    pt = p.unrestrictedTraverse('portal_types')
1766 1767 1768 1769 1770 1771 1772 1773
    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)
1774
      except AttributeError:
1775 1776 1777
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
1778 1779
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
1780 1781
      for id in property_list:
        if id in original_property_list:
1782
          original_property_list.remove(id)
1783
      setattr(portal_type, self.class_property, list(original_property_list))
1784

1785

1786 1787
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

1788
  name = 'Hidden Content Type'
1789 1790 1791
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'

1792

1793 1794
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

1795
  name = 'Property Sheet'
1796 1797 1798
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'

1799

1800 1801
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

1802
  name = 'Base Category'
1803 1804 1805
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'

1806

1807
class CatalogMethodTemplateItem(ObjectTemplateItem):
1808
  """Template Item for catalog methods.
1809

1810 1811 1812 1813 1814
    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.
  """
1815

1816 1817
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1818
    # a mapping to store properties of methods.
1819 1820 1821 1822 1823
    # 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()
1824

1825 1826 1827 1828 1829
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843
  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

1844 1845
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1846

1847
    catalog = _getCatalogValue(self)
1848
    if catalog is None:
1849
      LOG('BusinessTemplate build', 0, 'catalog not found')
1850
      return
1851

1852 1853 1854
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
1855

1856 1857
    for obj in self._objects.values():
      method_id = obj.id
1858 1859
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
1860
      self._is_filtered_archive[method_id] = 0
1861
      if catalog.filter_dict.has_key(method_id):
1862 1863 1864 1865 1866 1867 1868 1869 1870
        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']
1871

Aurel's avatar
Aurel committed
1872
  def export(self, context, bta, **kw):
1873
    catalog = _getCatalogValue(self)
1874 1875 1876 1877
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

Aurel's avatar
Aurel committed
1878 1879 1880 1881
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
1882
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1883
      # create folder and subfolders
1884
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
1885 1886 1887 1888
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
1889 1890
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1891
      # add all datas specific to catalog inside one file
1892
      method_id = obj.id
1893 1894
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

1895
      f = open(object_path, 'wb')
1896
      xml_data = '<catalog_method>'
1897

1898
      for method_property, value in self._method_properties[method_id].items():
1899 1900 1901
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
1902

Aurel's avatar
Aurel committed
1903
      if catalog.filter_dict.has_key(method_id):
1904
        if catalog.filter_dict[method_id]['filtered']:
1905 1906 1907
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
1908 1909 1910 1911
          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'')):
1912 1913 1914
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
1915
              elif type(value) in (type(()), type([])):
1916
                xml_data += '\n <item key="%s" type="tuple">'%(method)
1917
                for item in value:
1918 1919 1920
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
      xml_data += '\n</catalog_method>'
1921
      f.write(xml_data)
Aurel's avatar
Aurel committed
1922
      f.close()
1923

Christophe Dumez's avatar
Christophe Dumez committed
1924 1925 1926 1927 1928 1929
  # 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:
1930 1931
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
Christophe Dumez's avatar
Christophe Dumez committed
1932
    return xml_data
1933

1934 1935
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1936
    catalog = _getCatalogValue(self)
1937 1938 1939 1940 1941 1942 1943
    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)
1944

1945 1946 1947
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1948
    new_bt_format = context.getTemplateFormatVersion()
1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964

    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':
1965
              continue
1966 1967 1968 1969
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
1970

1971 1972
    for obj in values:
      method_id = obj.id
1973

1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984
      # 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))
1985

1986 1987
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
1988
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1989
        if context.getTemplateFormatVersion() == 1:
1990 1991 1992
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1993
        filter_type = self._filter_type_archive[method_id]
1994 1995 1996
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1997
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1998
        catalog.filter_dict[method_id]['type'] = filter_type
1999
      elif method_id in catalog.filter_dict.keys():
2000
        catalog.filter_dict[method_id]['filtered'] = 0
2001

2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
      # 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)
2028

2029 2030 2031 2032 2033 2034
        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)
2035

2036
  def uninstall(self, context, **kw):
2037
    catalog = _getCatalogValue(self)
2038 2039 2040
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2041

2042 2043 2044 2045
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2046 2047 2048 2049
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2050
    else:
2051 2052 2053 2054
      try:
        value = self._archive[object_path]
      except KeyError:
        value = None
2055 2056
      if value is not None:
        values.append(value)
2057
    for obj in values:
2058
      method_id = obj.id
2059 2060 2061 2062 2063 2064 2065 2066 2067
      # 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)
2068

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2069
      if catalog.filter_dict.has_key(method_id):
2070
        del catalog.filter_dict[method_id]
2071

2072
    # uninstall objects
2073
    ObjectTemplateItem.uninstall(self, context, **kw)
2074

2075
  def _importFile(self, file_name, file):
2076
    if not '.catalog_keys' in file_name:
2077 2078 2079 2080 2081 2082 2083 2084
      # just import xml object
      obj = self
      connection = None
      while connection is None:
        obj=obj.aq_parent
        connection=obj._p_jar
      obj = connection.importFile(file, customImporters=customImporters)
      self._objects[file_name[:-4]] = obj
2085
    else:
2086
      # recreate data mapping specific to catalog method
2087 2088
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2089
      xml = parse(file)
2090
      method_list = xml.getElementsByTagName('item')
2091
      for method in method_list:
2092
        key = method.getAttribute('key')
2093 2094
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
2095 2096 2097 2098
          if len(method.getElementsByTagName('value')[0].childNodes):
            value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          else:
            value = ''
2099
          key = str(key)
2100
        elif key_type == "int":
2101
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
2102
          key = str(key)
2103
        elif key_type == "tuple":
2104 2105 2106 2107
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
2108
        else:
2109
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2110
          continue
2111
        if key in catalog_method_list or key in catalog_method_filter_list:
2112
          dict = getattr(self, key, {})
2113
          dict[id] = value
2114 2115 2116
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2117

2118
class ActionTemplateItem(ObjectTemplateItem):
2119 2120

  def __init__(self, id_list, **kw):
2121
    # XXX It's look like ObjectTemplateItem __init__
2122 2123 2124 2125 2126 2127
    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

2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148
  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

2149 2150 2151 2152
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2153
      relative_url, value = id.split(' | ')
2154 2155
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
2156
        if getattr(ai, 'id') == value:
2157 2158
          url = posixpath.split(relative_url)
          key = posixpath.join(url[-2], url[-1], value)
2159
          action = ai._getCopy(context)
2160
          action = self.removeProperties(action)
2161
          self._objects[key] = action
Aurel's avatar
Aurel committed
2162
          self._objects[key].wl_clearLocks()
2163 2164
          break
      else:
2165
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
2166

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

2244 2245
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2246 2247
    object_path = kw.get("object_path", None)
    if object_path is not None:
2248 2249 2250 2251 2252 2253 2254 2255
      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]
2256
    else:
2257
      keys = self._archive.keys()
2258
    for id in keys:
2259 2260 2261 2262
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273
        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 )
2274 2275
    BaseTemplateItem.uninstall(self, context, **kw)

2276 2277 2278
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2279
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
    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
2292
        for property in ('id', 'title', 'description',
2293 2294 2295 2296
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
2297 2298 2299 2300
        # condition
        prop_value = getattr(role, 'condition')
        if prop_value:
          type_role_dict['condition'] = prop_value.text
2301 2302 2303 2304 2305 2306 2307 2308 2309
        # multi
        for property in ('category', 'base_category'):
          prop_value_list = []
          for prop_value in getattr(role, property):
            prop_value_list.append(prop_value)
          type_role_dict[property] = prop_value_list
        type_role_list.append(type_role_dict)
      self._objects[relative_url] = type_role_list

Christophe Dumez's avatar
Christophe Dumez committed
2310
  # Function to generate XML Code Manually
2311 2312 2313 2314
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2315
      xml_data += "\n  <role id='%s'>" % role['id']
2316 2317 2318 2319 2320
      # uniq
      for property in ('title', 'description', 'condition', 'priority',
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
2321
          xml_data += "\n   <property id='%s'>%s</property>" % \
2322 2323 2324
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2325
        for prop_value in role.get(property, []):
2326
          xml_data += "\n   <multi_property "\
2327
          "id='%s'>%s</multi_property>" % (property, prop_value)
2328 2329
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2330
    return xml_data
2331

2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      xml_data = self.generateXml(key)
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
    type_roles_list = []
    xml = parse(file)
2345
    xml_type_roles_list = xml.getElementsByTagName('role')
2346 2347 2348 2349 2350 2351 2352 2353
    for role in xml_type_roles_list:
      id = role.getAttribute('id')
      type_role_property_dict = {'id':id}
      # uniq
      property_list = role.getElementsByTagName('property')
      for property in property_list:
        property_id = property.getAttribute('id').encode()
        if property.hasChildNodes():
2354
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2355 2356 2357 2358 2359 2360 2361 2362 2363 2364
          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():
2365
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380
          type_role_property_dict[property_id].append(property_value)
      type_roles_list.append(type_role_property_dict)
    self._objects['portal_type_roles/'+file_name[:-4]] = type_roles_list

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    p = context.getPortalObject()
    for roles_path in self._objects.keys():
      if update_dict.has_key(roles_path) or force:
        if not force:
          action = update_dict[roles_path]
          if action == 'nothing':
            continue
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2381 2382 2383 2384 2385 2386
      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))
2387 2388 2389

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2390 2391 2392 2393 2394 2395
    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:
2396
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2397 2398 2399 2400 2401
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2402

2403 2404 2405 2406 2407 2408
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2409 2410
      for property in p.propertyMap():
        if property['id'] == id:
2411
          obj = p.getProperty(id)
2412
          prop_type = property['type']
2413 2414
          break
      else:
2415 2416
        obj = None
      if obj is None:
2417
        raise NotFound, 'the property %s is not found' % id
2418
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2419

2420 2421 2422 2423 2424 2425
  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
2426 2427
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2428 2429 2430 2431 2432 2433 2434
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2435
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2436
      self._objects[str(id)] = (str(prop_type), value)
2437

2438 2439 2440
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2441
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2442 2443
      p = context.getPortalObject()
      for path in self._objects.keys():
2444 2445 2446 2447
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2448
              continue
2449
          dir, id = posixpath.split(path)
2450 2451
          if p.hasProperty(id):
            continue
2452 2453
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
2454
    else:
2455
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2456
      p = context.getPortalObject()
2457 2458
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
2459 2460 2461 2462 2463
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
2464 2465 2466

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2467 2468 2469 2470 2471 2472
    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:
2473 2474 2475 2476
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2477
  # Function to generate XML Code Manually
2478
  def generateXml(self, path=None):
2479
    xml_data = ''
2480
    prop_type, obj = self._objects[path]
2481 2482 2483
    xml_data += '\n <property>'
    xml_data += '\n  <id>%s</id>' %(path,)
    xml_data += '\n  <type>%s</type>' %(prop_type,)
2484
    if prop_type in ('lines', 'tokens'):
2485
      xml_data += '\n  <value>'
2486
      for item in obj:
2487
        if item != '':
2488 2489
          xml_data += '\n   <item>%s</item>' %(item,)
      xml_data += '\n  </value>'
2490
    else:
2491 2492
      xml_data += '\n  <value>%r</value>' %(('\n').join(obj),)
    xml_data += '\n </property>'
2493 2494
    return xml_data

Aurel's avatar
Aurel committed
2495 2496 2497 2498 2499
  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)
2500 2501 2502 2503
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2504
      xml_data += self.generateXml(path)
2505
    xml_data += '\n</site_property>'
2506
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2507

2508 2509 2510 2511 2512 2513 2514
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)
2515 2516 2517 2518 2519 2520 2521 2522
      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
2523

Christophe Dumez's avatar
Christophe Dumez committed
2524
  # Function to generate XML Code Manually
2525
  def generateXml(self, path=None):
2526 2527
    dict = self._objects[path]
    xml_data = '<module>'
2528 2529 2530 2531
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2532 2533
      if key =='permission_list':
        # separe permission dict into xml
2534
        xml_data += '\n <%s>' %(key,)
2535 2536
        permission_list = dict[key]
        for perm in permission_list:
2537 2538 2539 2540 2541
          # the type of the permission defined if we use acquired or not
          if type(perm[1]) == type([]):
            ptype = "list"
          else:
            ptype = "tuple"
2542 2543
          xml_data += "\n  <permission type='%s'>" %(ptype,)
          xml_data += '\n   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2544
          role_list = list(perm[1])
2545
          role_list.sort()
2546
          for role in role_list:
2547 2548 2549
            xml_data += '\n   <role>%s</role>' %(role)
          xml_data += '\n  </permission>'
        xml_data += '\n </%s>' %(key,)
2550
      else:
2551 2552
        xml_data += '\n <%s>%s</%s>' %(key, dict[key], key)
    xml_data += '\n</module>'
2553 2554
    return xml_data

2555 2556 2557 2558 2559
  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)
2560 2561 2562
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
2563
      # expor module one by one
2564
      xml_data = self.generateXml(path=id)
2565
      bta.addObject(obj=xml_data, name=id, path=path)
2566

2567
  def install(self, context, trashbin, **kw):
2568
    portal = context.getPortalObject()
2569 2570
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2571
    if context.getTemplateFormatVersion() == 1:
2572
      items = self._objects
2573
    else:
2574 2575 2576 2577 2578 2579 2580 2581 2582
      items = self._archive

    for id in items.keys():
      if update_dict.has_key(id) or force:
        if not force:
          action = update_dict[id]
          if action == 'nothing':
            continue
        mapping = items[id]
2583
        path, id = posixpath.split(id)
2584 2585
        if id in portal.objectIds():
          module = portal._getOb(id)
2586
          module.portal_type = str(mapping['portal_type'])
2587 2588 2589 2590 2591 2592 2593 2594 2595 2596
        else:
          module = portal.newContent(id=id, portal_type=str(mapping['portal_type']))
        module.setTitle(str(mapping['title']))
        for name,role_list in list(mapping['permission_list']):
          acquire = (type(role_list) == type([]))
          try:
            module.manage_permission(name, roles=role_list, acquire=acquire)
          except ValueError:
            # Ignore a permission not present in this system.
            pass
2597 2598 2599 2600 2601 2602 2603 2604 2605 2606

  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:
2607
          perm_type = perm.getAttribute('type').encode() or None
2608 2609 2610 2611 2612 2613 2614 2615 2616
          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))
2617 2618 2619 2620
          if perm_type == "list" or perm_type is None:
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631
          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

2632
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2633 2634 2635
    trash = kw.get('trash', 0)
    if trash:
      return
2636 2637 2638 2639 2640 2641
    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]
2642 2643
    p = context.getPortalObject()
    id_list = p.objectIds()
2644
    for id in keys:
2645
      if id in id_list:
2646
        try:
2647
          if trash and trashbin is not None:
2648 2649
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2650
          p.manage_delObjects([id])
2651
        except NotFound:
2652
          pass
2653 2654
    BaseTemplateItem.uninstall(self, context, **kw)

2655 2656 2657
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2658 2659

class DocumentTemplateItem(BaseTemplateItem):
2660 2661 2662 2663
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2664 2665 2666 2667

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

2670
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2671 2672
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2673
      new_keys = self._objects.keys()
2674 2675 2676 2677 2678 2679 2680 2681 2682 2683
      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
2684 2685 2686 2687 2688 2689
      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:
2690 2691
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
2692
        else: # new object
2693 2694
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
2695 2696 2697 2698
          # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
2699 2700
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
2701 2702 2703 2704 2705
    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
2706
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2707
      for id in self._objects.keys():
2708 2709 2710 2711 2712 2713
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
2714
          path, name = posixpath.split(id)
2715 2716
          # This raises an exception if the file already exists.
          try:
2717
            globals()[self.local_file_writer_name](name, text, create=0)
2718
          except IOError, error:
2719
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
2720 2721
            if error.errno :
              raise
2722 2723 2724
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
2725
    else:
2726 2727 2728
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
2729
        # This raises an exception if the file exists.
2730
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
2731 2732
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
2733 2734

  def uninstall(self, context, **kw):
2735
    object_path = kw.get('object_path', None)
2736 2737 2738 2739 2740
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
2741
      globals()[self.local_file_remover_name](id)
2742 2743
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
2744 2745 2746 2747 2748 2749
  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():
2750 2751
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
2752

2753 2754
  def _importFile(self, file_name, file):
    text = file.read()
2755
    self._objects[file_name[:-3]]=text
2756

2757 2758 2759 2760 2761 2762
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

2763 2764 2765 2766 2767
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
2768

2769 2770 2771
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
2772 2773
  # Extension needs no import
  local_file_importer_name = None
2774 2775 2776 2777 2778
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
2779
  # Test needs no import
2780 2781 2782
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
2783

2784 2785 2786
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
2787 2788 2789

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2790 2791 2792 2793
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2794
    if len(role_list) > 0:
2795
      self._objects[self.__class__.__name__+'/'+'role_list'] = role_list
Aurel's avatar
Aurel committed
2796

2797
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2798 2799
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2800
      new_roles = self._objects.keys()
2801 2802 2803
      if installed_bt.id == 'installed_bt_for_diff':
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
2804 2805 2806
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
2807 2808
        for key in old_keys:
          new_dict[key] = ''
2809
        installed_bt._objects = new_dict
2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822
      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):
2823
    p = context.getPortalObject()
2824
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2825
    if context.getTemplateFormatVersion() == 1:
2826
      role_list = self._objects.keys()
2827
    else:
2828
      role_list = self._archive.keys()
2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840
    # 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
2841
    for role in role_list:
2842 2843 2844 2845 2846 2847 2848 2849 2850 2851
      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
2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863

  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)

2864 2865 2866 2867 2868 2869 2870 2871 2872
  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
2873
      if role in roles and role not in new_roles:
2874 2875 2876
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
2877
  # Function to generate XML Code Manually
2878
  def generateXml(self, path):
2879
    obj = self._objects[path]
2880
    xml_data = '<role_list>'
2881 2882
    obj.sort()
    for role in obj:
2883 2884
      xml_data += '\n <role>%s</role>' %(role)
    xml_data += '\n</role_list>'
2885 2886
    return xml_data

Aurel's avatar
Aurel committed
2887 2888 2889 2890 2891 2892
  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():
2893
      xml_data = self.generateXml(path=path)
2894
      bta.addObject(obj=xml_data, name=path, path=None,)
2895

2896 2897
class CatalogResultKeyTemplateItem(BaseTemplateItem):

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

  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

2923
  def install(self, context, trashbin, **kw):
2924
    catalog = _getCatalogValue(self)
2925 2926 2927
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2928

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

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

Christophe Dumez's avatar
Christophe Dumez committed
2968
  # Function to generate XML Code Manually
2969
  def generateXml(self, path=None):
2970
    obj = self._objects[path]
2971
    xml_data = '<key_list>'
2972 2973
    obj.sort()
    for key in obj:
2974 2975
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
2976 2977
    return xml_data

Aurel's avatar
Aurel committed
2978 2979 2980 2981 2982
  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)
2983
    for path in self._objects.keys():
2984
      xml_data = self.generateXml(path=path)
2985
      bta.addObject(obj=xml_data, name=path, path=None)
2986

2987 2988
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2989
  def build(self, context, **kw):
2990
    catalog = _getCatalogValue(self)
2991 2992 2993
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2994
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2995
    key_list = []
2996
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2997
      if key in sql_search_related_keys:
2998
        key_list.append(key)
Aurel's avatar
Aurel committed
2999
      else:
3000
        raise NotFound, 'Related key "%r" not found in catalog' %(key,)
3001
    if len(key_list) > 0:
3002
      self._objects[self.__class__.__name__+'/'+'related_key_list'] = key_list
3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013

  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

3014
  def install(self, context, trashbin, **kw):
3015
    catalog = _getCatalogValue(self)
3016 3017 3018
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3019

3020
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3021
    if context.getTemplateFormatVersion() == 1:
3022
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3023
        return
3024 3025 3026
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3027
    else:
3028
      keys = self._archive.keys()
3029 3030
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3031
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
3032
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3033
      if not force:
Aurel's avatar
Aurel committed
3034 3035 3036 3037
        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
3038 3039 3040
        if action == 'nothing':
          return
      for key in keys:
3041 3042
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
3043
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
3044

3045
  def uninstall(self, context, **kw):
3046
    catalog = _getCatalogValue(self)
3047 3048 3049
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3050
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
3051
    object_path = kw.get('object_path', None)
3052 3053 3054 3055 3056
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3057 3058 3059 3060 3061
      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
3062
  # Function to generate XML Code Manually
3063
  def generateXml(self, path=None):
3064
    obj = self._objects[path]
3065
    xml_data = '<key_list>'
3066 3067
    obj.sort()
    for key in obj:
3068 3069
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3070 3071
    return xml_data

Aurel's avatar
Aurel committed
3072 3073 3074 3075 3076 3077
  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():
3078
      xml_data = self.generateXml(path=path)
3079
      bta.addObject(obj=xml_data, name=path, path=None)
3080

3081 3082
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3083
  def build(self, context, **kw):
3084
    catalog = _getCatalogValue(self)
3085 3086 3087
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3088
    sql_search_result_tables = list(catalog.sql_search_tables)
3089
    key_list = []
3090
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3091
      if key in sql_search_result_tables:
3092
        key_list.append(key)
Aurel's avatar
Aurel committed
3093
      else:
3094
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
3095
    if len(key_list) > 0:
3096
      self._objects[self.__class__.__name__+'/'+'result_table_list'] = key_list
3097 3098 3099 3100 3101 3102 3103 3104 3105 3106

  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
3107

3108
  def install(self, context, trashbin, **kw):
3109
    catalog = _getCatalogValue(self)
3110 3111 3112
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3113

3114
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3115
    if context.getTemplateFormatVersion() == 1:
3116
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3117
        return
3118 3119 3120
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3121
    else:
3122
      keys = self._archive.keys()
3123 3124
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3125
    # XXX same as related keys
Aurel's avatar
Aurel committed
3126
    if update_dict.has_key('result_table_list') or force:
3127
      if not force:
Aurel's avatar
Aurel committed
3128
        action = update_dict['result_table_list']
3129
        if action == 'nothing':
Aurel's avatar
Aurel committed
3130
          return
3131
      for key in keys:
3132 3133
        if key not in sql_search_tables:
          sql_search_tables.append(key)
3134
      catalog.sql_search_tables = tuple(sql_search_tables)
3135 3136

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

Christophe Dumez's avatar
Christophe Dumez committed
3153
  # Function to generate XML Code Manually
3154
  def generateXml(self, path=None):
3155
    obj = self._objects[path]
3156
    xml_data = '<key_list>'
3157 3158
    obj.sort()
    for key in obj:
3159 3160
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3161 3162
    return xml_data

Aurel's avatar
Aurel committed
3163 3164 3165 3166 3167 3168
  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():
3169
      xml_data = self.generateXml(path=path)
3170
      bta.addObject(obj=xml_data, name=path, path=None)
3171

3172 3173
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3174 3175

  def build(self, context, **kw):
3176
    catalog = _getCatalogValue(self)
3177 3178 3179 3180 3181 3182 3183 3184 3185
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_keyword_keys:
        key_list.append(key)
      else:
3186
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3187
    if len(key_list) > 0:
3188
      self._objects[self.__class__.__name__+'/'+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3189

3190 3191 3192 3193 3194 3195 3196 3197 3198
  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
3199 3200

  def install(self, context, trashbin, **kw):
3201
    catalog = _getCatalogValue(self)
3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214
    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()
3215 3216
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228
    # 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):
3229
    catalog = _getCatalogValue(self)
3230 3231 3232 3233
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3234
    object_path = kw.get('object_path', None)
3235 3236
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3237
    else:
3238 3239 3240 3241 3242 3243 3244
      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
3245
  # Function to generate XML Code Manually
3246 3247 3248 3249 3250
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3251 3252
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3253
    return xml_data
Aurel's avatar
Aurel committed
3254 3255 3256 3257

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3258 3259 3260 3261 3262
    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)
3263

3264 3265
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3266

3267
  def build(self, context, **kw):
3268
    catalog = _getCatalogValue(self)
3269 3270 3271 3272 3273 3274 3275 3276 3277
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_full_text_keys = list(catalog.sql_catalog_full_text_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_full_text_keys:
        key_list.append(key)
      else:
3278
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
3279
    if len(key_list) > 0:
3280
      self._objects[self.__class__.__name__+'/'+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3281

3282 3283 3284 3285 3286 3287 3288 3289 3290
  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
3291

3292
  def install(self, context, trashbin, **kw):
3293
    catalog = _getCatalogValue(self)
3294 3295 3296
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3297

3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318
    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
3319

3320
  def uninstall(self, context, **kw):
3321
    catalog = _getCatalogValue(self)
3322 3323 3324 3325
    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)
3326
    object_path = kw.get('object_path', None)
3327 3328 3329 3330 3331 3332 3333 3334 3335 3336
    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
3337
  # Function to generate XML Code Manually
3338 3339 3340 3341 3342
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3343 3344
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360
    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):
3361
    catalog = _getCatalogValue(self)
3362 3363 3364 3365 3366 3367 3368 3369 3370
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_request_keys = list(catalog.sql_catalog_request_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_request_keys:
        key_list.append(key)
      else:
3371
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
3372
    if len(key_list) > 0:
3373
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385

  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):
3386
    catalog = _getCatalogValue(self)
3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413
    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):
3414
    catalog = _getCatalogValue(self)
3415 3416 3417 3418
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
3419
    object_path = kw.get('object_path', None)
3420 3421 3422 3423 3424 3425 3426 3427 3428 3429
    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
3430
  # Function to generate XML Code Manually
3431 3432 3433 3434 3435
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3436 3437
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452
    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):
3453
    catalog = _getCatalogValue(self)
3454 3455 3456 3457 3458 3459 3460 3461 3462
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_multivalue_keys:
        key_list.append(key)
      else:
3463
        raise NotFound, 'Multivalue key "%r" not found in catalog' %(key,)
3464
    if len(key_list) > 0:
3465
      self._objects[self.__class__.__name__+'/'+'multivalue_key_list'] = key_list
3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477

  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):
3478
    catalog = _getCatalogValue(self)
3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504
    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):
3505
    catalog = _getCatalogValue(self)
3506 3507 3508 3509
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
3510
    object_path = kw.get('object_path', None)
3511 3512 3513 3514 3515 3516 3517 3518 3519 3520
    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
3521
  # Function to generate XML Code Manually
3522 3523 3524 3525 3526
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3527 3528
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543
    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):
3544
    catalog = _getCatalogValue(self)
3545 3546 3547 3548 3549 3550 3551 3552 3553
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_catalog_topic_search_keys:
        key_list.append(key)
      else:
3554
        raise NotFound, 'Topic key "%r" not found in catalog' %(key,)
3555
    if len(key_list) > 0:
3556
      self._objects[self.__class__.__name__+'/'+'topic_key_list'] = key_list
3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568

  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):
3569
    catalog = _getCatalogValue(self)
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596
    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):
3597
    catalog = _getCatalogValue(self)
3598 3599 3600 3601
    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)
3602
    object_path = kw.get('object_path', None)
3603 3604 3605 3606 3607 3608 3609 3610 3611 3612
    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
3613
  # Function to generate XML Code Manually
3614 3615 3616 3617 3618
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3619 3620
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635
    return xml_data

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

class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
3636 3637 3638 3639 3640 3641
    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'
3642
      path = posixpath.join(lang, catalog)
3643 3644
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675

  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':
3676
              continue
3677
          path = path.split('/')
3678 3679 3680 3681 3682 3683
          if len(path) == 2:
            lang = path[0]
            catalog = path[1]
          else:
            lang = path[-3]
            catalog = path[-2]
3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709
          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)
3710
      f = open(path+os.sep+'translation.po', 'wb')
3711 3712 3713 3714
      f.write(str(obj))
      f.close()

  def _importFile(self, file_name, file):
3715
    if posixpath.split(file_name)[1] == 'translation.po':
3716 3717
      text = file.read()
      self._objects[file_name[:-3]] = text
3718

Aurel's avatar
Aurel committed
3719 3720
class LocalRolesTemplateItem(BaseTemplateItem):

3721
  def __init__(self, id_list, **kw):
3722
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
3723 3724
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
3725 3726 3727
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
3728
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
3729 3730 3731 3732
      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
3733 3734
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

Christophe Dumez's avatar
Christophe Dumez committed
3735
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
3736 3737 3738 3739 3740 3741 3742 3743
  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>'
3744
    xml_data += '\n <local_roles>'
Aurel's avatar
Aurel committed
3745
    for key in local_roles_keys:
3746
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
3747 3748
      tuple = local_roles_dict[key]
      for item in tuple:
3749 3750 3751
        xml_data += "\n   <item>%s</item>" %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </local_roles>'
Aurel's avatar
Aurel committed
3752
    # group local roles
3753
    xml_data += '\n <group_local_roles>'
Aurel's avatar
Aurel committed
3754
    for key in group_local_roles_keys:
3755
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
3756 3757
      tuple = group_local_roles_dict[key]
      for item in tuple:
3758 3759 3760 3761
        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
3762
    return xml_data
3763

Aurel's avatar
Aurel committed
3764 3765 3766 3767 3768 3769 3770 3771
  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)

3772
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
3773
      encode_folders = []
3774
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
3775
        if '%' not in folder:
3776
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
3777 3778
        else:
          encode_folders.append(folder)
3779
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
3780 3781 3782 3783 3784 3785 3786
      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]
3787
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3788 3789 3790 3791 3792 3793 3794 3795 3796 3797
    local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
      item_type_list = []
      item_list = role.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      local_roles_dict[id] = item_type_list
    # group local roles
    group_local_roles = xml.getElementsByTagName('group_local_roles')[0]
3798
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
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
    group_local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
      item_type_list = []
      item_list = role.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      group_local_roles_dict[id] = item_type_list
    self._objects['local_roles/'+file_name[:-4]] = (local_roles_dict, group_local_roles_dict)

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

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

3833 3834 3835
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
3836
    in part or completely. Each object is separated from its
3837 3838 3839 3840 3841 3842 3843 3844 3845 3846
    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
3847 3848
      - object without optimal actions
      - list of relation between portal type and workflow
3849 3850 3851 3852 3853 3854 3855 3856 3857 3858

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

    - site property definition
      - id
      - type
3859
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3860

3861 3862
    - document/propertysheet/extension/test definition
      - copy of the local file
3863

3864
    - message transalation definition
3865
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3866

3867 3868
    The Business Template properties are exported to the bt folder with
    one property per file
3869

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3870 3871
    Technology:

3872 3873
    - 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
3874

3875
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3876 3877 3878 3879

    Use case:

    - install core ERP5 (the minimum)
3880

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

3883 3884
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
3885
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3886 3887 3888 3889 3890
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
3891
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3892 3893 3894 3895 3896
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
3897
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3898 3899 3900 3901

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
3902
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3903
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3904
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3905
                      , PropertySheet.BusinessTemplate
3906
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3907 3908
                      )

3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925
    # 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
      }

3926 3927
    # This is a global variable
    # Order is important for installation
3928 3929 3930 3931 3932 3933
    # 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 )
3934 3935 3936
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
3937
      '_constraint_item',
3938 3939 3940 3941
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3942
      '_tool_item',
3943 3944 3945 3946
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
3947
      '_portal_type_workflow_chain_item',
3948 3949 3950 3951
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
3952 3953
      '_category_item',
      '_module_item',
3954
      '_path_item',
3955
      '_skin_item',
3956
      '_preference_item',
3957
      '_action_item',
3958
      '_portal_type_roles_item',
3959
      '_local_roles_item',
3960
      '_catalog_method_item',
3961 3962 3963
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
3964 3965 3966 3967 3968
      '_catalog_keyword_key_item',
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
3969 3970 3971 3972
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3973 3974 3975 3976 3977 3978
      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
3979
        self._baseGetTemplateFormatVersion()
3980

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3981 3982 3983
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
3984

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3985
      return 0
3986

3987
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
3988 3989 3990 3991 3992 3993 3994
    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".
3995 3996
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
3997
          # XXX Not good to access the attribute directly,
3998 3999 4000
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4001

4002 4003
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4004 4005 4006 4007 4008 4009
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4010
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4011 4012 4013 4014 4015 4016 4017 4018
        """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)
4019

4020
    security.declareProtected(Permissions.ManagePortal, 'build')
4021
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4022 4023 4024
      """
        Copy existing portal objects to self
      """
4025
      if no_action: return
4026
        # this is use at import of Business Template to get the status built
4027 4028
      # Make sure that everything is sane.
      self.clean()
4029

4030
      self.updateRevisionNumber()
4031

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4032 4033
      self._setTemplateFormatVersion(1)

4034
      # Store all data
4035 4036
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4037
      self._portal_type_workflow_chain_item = \
4038
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4039 4040 4041 4042 4043 4044 4045 4046 4047 4048
      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())
4049 4050
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
4051 4052 4053 4054 4055 4056 4057 4058
      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())
4059 4060
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080
      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())
4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092
      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())
4093 4094
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4095 4096
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4097 4098
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4099
               self.getTemplateCatalogKeywordKeyList())
4100 4101
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4102
               self.getTemplateCatalogFullTextKeyList())
4103 4104
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4105
               self.getTemplateCatalogRequestKeyList())
4106 4107
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4108
               self.getTemplateCatalogMultivalueKeyList())
4109 4110 4111
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4112 4113 4114
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4115 4116 4117
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4118

4119 4120 4121
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
4122

4123
    build = WorkflowMethod(build)
4124 4125

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4126
      """
4127
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4128
      """
4129
      return self.portal_templates.publish(self, url, username=username,
4130
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4131

4132
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4133
      """
4134
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4135
      """
4136
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4137

4138 4139 4140 4141 4142
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4143 4144 4145 4146 4147 4148 4149 4150 4151 4152
      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
4153 4154
      return False

4155
    def preinstall(self, check_dependencies=1, **kw):
4156 4157 4158
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4159
      """
4160

4161 4162 4163 4164 4165
      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()
4166

4167 4168
      modified_object_list = {}
      bt_title = self.getTitle()
4169 4170 4171 4172 4173 4174 4175

      #  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)
4176 4177 4178
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4179
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4180

4181
      # if reinstall business template, must compare to object in ZODB
4182
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4183
      # same if we make a diff and select only one business template
4184
      reinstall = 0
4185 4186
      if installed_bt == self:
        reinstall = 1
4187 4188 4189
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
4190 4191 4192
        bt2.edit(description='tmp bt generated for diff')
        bt2.build()
        installed_bt = bt2
4193

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4194
      new_bt_format = self.getTemplateFormatVersion()
4195 4196 4197 4198 4199 4200
      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:
4201
          item = getattr(self, item_name, None)
4202 4203 4204 4205
          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
4206

4207 4208 4209 4210
      # get the list of modified and new object
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
      for item_name in self._item_name_list:
4211
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4212
        old_item = getattr(installed_bt, item_name, None)
4213
        if new_item is not None:
4214
          if old_item is not None and hasattr(old_item, '_objects'):
4215 4216 4217 4218 4219 4220 4221 4222
            modified_object = new_item.preinstall(context=local_configuration, installed_bt=old_item)
            if len(modified_object) > 0:
              modified_object_list.update(modified_object)
          else:
            for path in new_item._objects.keys():
              modified_object_list.update({path : ['New', new_item.__class__.__name__[:-12]]})

      if reinstall:
4223
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4224

4225 4226
      return modified_object_list

4227
    def _install(self, force=1, object_to_update=None, **kw):
4228
      """
Christophe Dumez's avatar
Christophe Dumez committed
4229
        Install a new Business Template, if force, all will be upgraded or installed
4230 4231
        otherwise depends of dict object_to_update
      """
4232 4233 4234 4235
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4236

4237 4238
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
4239 4240
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4241
        if installed_bt.getTemplateFormatVersion() == 0:
4242
          force = 1
4243
        installed_bt.replace(self)
4244

4245 4246 4247 4248
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4249 4250 4251
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4252

4253 4254 4255
      if not force:
        self.checkDependencies()

4256
      site = self.getPortalObject()
4257 4258 4259 4260 4261 4262
      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()
4263 4264 4265
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Activity Tool')
4266
        gen.setupLastTools(site, update=1, create_activities=1)
4267 4268
      if not force:
        if len(object_to_update) == 0:
4269 4270 4271 4272 4273
          # 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():
4274
            LOG('Business Template', 0, 'Updating Business Template Workflows')
4275
            gen.setupWorkflow(site)
4276
          return
4277 4278 4279 4280

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

4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295
      # always created a trash bin because we may to save object already present
      # but not in a previous business templates apart at creation of a new site
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates.objectIds()) > 1):
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

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

4297
      # update catalog if necessary
4298 4299 4300 4301
      if force and self.isCatalogUpdatable():
        update_catalog = 1
      else:
        update_catalog = kw.get('update_catalog', 0)
4302
      if update_catalog:
4303
        catalog = _getCatalogValue(self)
4304
        if (catalog is None) or (not site.isIndexable):
4305 4306 4307 4308 4309
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4310

4311
      # get objects to remove
4312
      # do remove after because we may need backup object from installation
4313 4314 4315 4316 4317 4318
      remove_object_dict = {}
      for path in object_to_update.keys():
        action = object_to_update[path]
        if action == 'remove' or action == 'save_and_remove':
          remove_object_dict[path] = action
          object_to_update.pop(path)
4319

4320 4321 4322
      # remove object from old business template
      if len(remove_object_dict) > 0:
        for item_name in installed_bt._item_name_list:
4323
          item = getattr(installed_bt, item_name, None)
4324 4325
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
4326

4327 4328 4329 4330 4331 4332

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

4333
      # check if we have to update business template workflow
4334
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4335
        LOG('Business Template', 0, 'Updating Business Template Workflows')
4336 4337 4338 4339 4340
        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)

4341 4342 4343 4344 4345
      # remove trashbin if empty
      if trashbin is not None:
        if len(trashbin.objectIds()) == 0:
          trash_tool.manage_delObjects([trashbin.getId(),])

4346 4347
      if update_catalog:
        site.ERP5Site_reindexAll()
4348

4349 4350
      # Update translation table, in case we added new portal types or
      # workflow states.
4351 4352 4353
      update_translation = kw.get('update_translation', 0)
      if update_translation:
        site.ERP5Site_updateTranslationTable()
4354

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4355 4356
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
Aurel's avatar
Aurel committed
4357
      self.getPortalObject().portal_caches.clearAllCache()
4358

4359
    security.declareProtected(Permissions.ManagePortal, 'install')
4360 4361 4362
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4363
      """
4364
      return self._install(**kw)
4365

4366
    install = WorkflowMethod(install)
4367

4368
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4369
    def reinstall(self, **kw):
4370 4371 4372 4373
      """Reinstall Business Template.
      """
      return self._install(**kw)

4374
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4375

4376
    security.declareProtected(Permissions.ManagePortal, 'trash')
4377 4378
    def trash(self, new_bt, **kw):
      """
4379
        Trash unnecessary items before upgrading to a new business
4380
        template.
4381
        This is similar to uninstall, but different in that this does
4382
        not remove all items.
4383 4384 4385 4386 4387
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4388 4389
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4390
        item = getattr(self, item_name, None)
4391 4392 4393 4394
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
4395

4396
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
4397
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4398
      """
4399
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4400
      """
4401 4402 4403 4404
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4405 4406 4407
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4408
        item = getattr(self, item_name, None)
4409 4410
        if item is not None:
          item.uninstall(local_configuration)
4411
      # It is better to clear cache because the uninstallation of a
4412
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
4413
      self.getPortalObject().portal_caches.clearAllCache()
4414

4415 4416
    uninstall = WorkflowMethod(uninstall)

4417
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4418
    def _clean(self):
4419
      """
4420
        Clean built information.
4421
      """
4422
      # First, remove obsolete attributes if present.
4423 4424 4425 4426
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4427
                    '_module_archive',
4428 4429 4430
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4431
                    '_property_sheet_archive'):
4432 4433 4434
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4435 4436
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4437

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

4440
    security.declareProtected(Permissions.AccessContentsInformation,
4441
                              'getBuildingState')
4442
    def getBuildingState(self, default=None, id_only=1):
4443
      """
4444
        Returns the current state in building
4445
      """
4446
      portal_workflow = getToolByName(self, 'portal_workflow')
4447 4448
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4449
      return wf._getWorkflowStateOf(self, id_only=id_only )
4450

4451
    security.declareProtected(Permissions.AccessContentsInformation,
4452
                              'getInstallationState')
4453
    def getInstallationState(self, default=None, id_only=1):
4454
      """
4455
        Returns the current state in installation
4456
      """
4457
      portal_workflow = getToolByName(self, 'portal_workflow')
4458 4459
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4460
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4461

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4462 4463 4464 4465 4466 4467
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4468
      export_string = portal_templates.manage_exportObject(
4469 4470
                                               id=self.getId(),
                                               toxml=1,
4471
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4472
      return export_string
4473

4474
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4475
      """
4476 4477
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4478
      """
4479
      result = getattr(self, id, ())
4480 4481 4482 4483
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4484
        # XXX Why do we need to return a tuple ?
4485 4486
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4487

4488
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4489
      """
4490 4491
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4492
      """
4493
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4494

4495
    def getTemplateBaseCategoryList(self):
4496
      """
4497 4498
      We have to set this method because we want an
      ordered list
4499
      """
4500
      return self._getOrderedList('template_base_category')
4501

4502
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4503
      """
4504 4505
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4506
      """
4507
      return self._getOrderedList('template_workflow_id')
4508

4509
    def getTemplatePortalTypeIdList(self):
4510
      """
4511 4512
      We have to set this method because we want an
      ordered list
4513
      """
4514
      return self._getOrderedList('template_portal_type_id')
4515

4516 4517 4518 4519 4520 4521 4522
    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
4523 4524 4525 4526 4527 4528 4529
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

4530 4531 4532 4533 4534 4535 4536
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

4537 4538 4539 4540 4541 4542
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4543

4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564
    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')

4565
    def getTemplateActionPathList(self):
4566
      """
4567 4568
      We have to set this method because we want an
      ordered list
4569
      """
4570
      return self._getOrderedList('template_action_path')
4571

4572 4573 4574 4575 4576 4577 4578
    def getTemplatePortalTypeRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_roles')

4579
    def getTemplateSkinIdList(self):
4580
      """
4581 4582
      We have to set this method because we want an
      ordered list
4583
      """
4584
      return self._getOrderedList('template_skin_id')
4585

4586
    def getTemplateModuleIdList(self):
4587
      """
4588 4589
      We have to set this method because we want an
      ordered list
4590
      """
4591
      return self._getOrderedList('template_module_id')
4592 4593 4594 4595 4596 4597 4598

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4600 4601 4602 4603 4604 4605 4606
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

4607
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
4608 4609 4610 4611
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
4612
      if self.getBuildingState() != 'built':
4613
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
4614
              'Business Template must be built before export'
4615 4616 4617
      if self.getInstallationState() == 'installed':
        raise TemplateConditionError, \
              'Can not export installed Business Template'
4618

Aurel's avatar
Aurel committed
4619 4620 4621 4622 4623 4624 4625
      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)

4626
      # export bt
4627
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
4628
      for prop in self.propertyMap():
4629
        prop_type = prop['type']
Aurel's avatar
Aurel committed
4630
        id = prop['id']
4631
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
4632
                  'install_object_list_list', 'id_generator'):
4633
          continue
Aurel's avatar
Aurel committed
4634
        value = self.getProperty(id)
4635
        if prop_type in ('text', 'string', 'int', 'boolean'):
4636
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
4637
        elif prop_type in ('lines', 'tokens'):
4638
          bta.addObject(obj=str('\n').join(value), name=id,
4639
                        path=path+os.sep+'bt', ext='')
4640

Aurel's avatar
Aurel committed
4641 4642 4643
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
4644

Aurel's avatar
Aurel committed
4645 4646
      return bta.finishCreation()

4647
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
4648 4649
    def importFile(self, dir = 0, file=None, root_path=None):
      """
4650
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
4651 4652 4653 4654 4655
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
4656

Aurel's avatar
Aurel committed
4657 4658
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4659
      self._portal_type_workflow_chain_item = \
4660
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
4661 4662 4663 4664 4665 4666 4667 4668 4669 4670
      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())
4671 4672
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
4673 4674 4675 4676 4677 4678 4679 4680
      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())
4681 4682
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704
      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())
4705 4706
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720
      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(
4721
               self.getTemplateCatalogKeywordKeyList())
4722 4723
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4724
               self.getTemplateCatalogFullTextKeyList())
4725 4726
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4727
               self.getTemplateCatalogRequestKeyList())
4728 4729
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4730
               self.getTemplateCatalogMultivalueKeyList())
4731 4732 4733
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4734 4735 4736
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4737 4738 4739
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4740

Aurel's avatar
Aurel committed
4741 4742
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4743

4744 4745 4746 4747 4748
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
4749 4750 4751
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
4752
      return items_list
4753

4754 4755 4756 4757 4758 4759 4760 4761 4762 4763
    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:
4764
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
4765
          dependency = dependency_couple_list[0]
4766 4767
          if dependency in (None, ''):
            continue
4768 4769
          version_restriction = None
          if len(dependency_couple_list) > 1:
4770
            version_restriction = dependency_couple_list[1]
4771 4772 4773
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
4774 4775 4776
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
4777
                  or (version_restriction not in (None, '') and
4778 4779 4780 4781
                     (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)
4782

Aurel's avatar
Aurel committed
4783
    def diffObject(self, REQUEST, **kw):
4784 4785
      """
        Make a diff between an object in the Business Template
4786
        and the same in the Business Template installed in the site
4787 4788 4789 4790
      """

      class_name_dict = {
        'Product' : '_product_item',
4791
        'PropertySheet' : '_property_sheet_item',
4792
        'Constraint' : '_constraint_item',
4793 4794 4795 4796 4797 4798 4799 4800 4801
        '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',
4802
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
4803 4804 4805 4806
        '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',
4807 4808 4809 4810
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
4811
        'Preference' : '_preference_item',
4812
        'Action' : '_action_item',
4813
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4814
        'LocalRoles' : '_local_roles_item',
4815 4816 4817
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4818 4819 4820 4821 4822
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
        'CatalogFullTextKey' : '_catalog_full_text_key_item',
        'CatalogRequestKey' : '_catalog_request_key_item',
        'CatalogMultivalueKey' : '_catalog_multivalue_key_item',
        'CatalogTopicKey' : '_catalog_topic_key_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4823
        'Tool': '_tool_item',
4824
        }
4825

4826 4827
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
4828

Christophe Dumez's avatar
Christophe Dumez committed
4829
      # Get objects
4830
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4831

Aurel's avatar
Aurel committed
4832
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
4833
      # Compare with a given business template
4834
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
4835 4836
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
4837 4838
        if bt2_id == self.getId():
          compare_to_zodb = 1
4839
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
4840 4841
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
4842 4843 4844
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
4845 4846 4847
          compare_to_zodb = 1
      if compare_to_zodb:
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
Christophe Dumez's avatar
Christophe Dumez committed
4848
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
4849 4850 4851
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
4852

4853 4854
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
4855
      if compare_to_zodb:
Aurel's avatar
Aurel committed
4856
        # XXX maybe only build for the given object to gain time
4857
        installed_item.build(self)
4858 4859 4860
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
4861

Christophe Dumez's avatar
Christophe Dumez committed
4862
      # Real Zope Objects (can be exported into XML directly by Zope)
4863 4864
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
4865
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4866
                     '_skin_item', '_action_item', '_tool_item', ]
4867

Christophe Dumez's avatar
Christophe Dumez committed
4868
      # Not considered as objects by Zope (will be exported into XML manually)
4869
      # XXX Bad naming
4870
      item_list_2 = ['_site_property_item', '_module_item',
4871
                     '_catalog_result_key_item', '_catalog_related_key_item',
4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
                     '_portal_type_allowed_content_type_item',
                     '_portal_type_hidden_content_type_item',
                     '_portal_type_property_sheet_item',
                     '_portal_type_roles_item',
                     '_portal_type_base_category_item',
                     '_local_roles_item',
4884
                     '_portal_type_workflow_chain_item',]
4885

Christophe Dumez's avatar
Christophe Dumez committed
4886
      # Text objects (no need to export them into XML)
4887
      # XXX Bad naming
4888 4889
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
4890
                     '_test_item', '_message_translation_item',]
4891

4892
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
4893 4894 4895
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
4896 4897
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
4898
        # XML Export in memory
4899 4900 4901
        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()
4902
        f1.close()
4903 4904 4905 4906
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
4907
        # End of XML export
4908

4909
        # Diff between XML objects
4910 4911
        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
4912
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4913 4914 4915
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4916

4917
      elif item_name in item_list_2:
4918
        # Generate XML code manually
4919 4920
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
4921 4922
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
4923
        # End of XML Code Generation
4924

4925
        # Diff between XML objects
4926 4927
        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
4928
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4929 4930 4931
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4932

4933
      elif item_name in item_list_3:
4934
        # Diff between text objects
4935 4936 4937 4938
        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
4939
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4940 4941
          diff_msg += '\n'.join(diff_list)
        else:
4942
          diff_msg = 'No diff'
4943

4944
      else:
4945
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
4946

4947 4948
      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4949

4950
      return diff_msg
4951

4952

4953 4954 4955 4956
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
4957 4958
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
4959 4960 4961 4962 4963 4964 4965
      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 [])
4966 4967
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

4968
      p = self.getPortalObject()
4969
      for id in bt_portal_types_id_list:
4970 4971
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
4972
          continue
4973
        if len(getattr(portal_type, '_roles', ())) > 0:
4974 4975
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
4976

4977 4978 4979 4980
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
4981
        action_list = []
4982 4983 4984 4985 4986 4987 4988
        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'):
4989
          base_category_list = portal_type.base_category_list
4990 4991
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
4992

4993 4994 4995 4996
        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)
4997

4998
        for h_id in hidden_content_type_list:
4999 5000 5001
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5002

5003 5004 5005 5006
        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)
5007

5008 5009 5010 5011
        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)
5012

5013 5014 5015 5016
        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)
5017

5018
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5019
                                    if chain != '(Default)']:
5020 5021 5022
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5023

5024 5025 5026 5027
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5028
      bt_action_list.sort()
5029
      bt_wf_chain_list.sort()
5030

5031 5032 5033 5034 5035 5036 5037
      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)
5038 5039 5040 5041 5042 5043 5044 5045 5046
      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:
5047 5048
        raise TemplateConditionError, 'No module defined in business template'

5049 5050 5051 5052 5053 5054 5055 5056
      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:
5057
          return type_list
5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071

        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():
5072
            type_list.update(getChildPortalType(hidden_ptype_id))
5073
        return type_list
5074

5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121
      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

5122 5123 5124
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5125
  setattr(BusinessTemplate, key, None)
5126

5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153
# 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)
5154

5155 5156 5157 5158 5159 5160 5161 5162

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

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