BusinessTemplate.py 216 KB
Newer Older
Nicolas Delaby's avatar
Nicolas Delaby committed
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3 4
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
5
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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.
#
##############################################################################

30
import fnmatch, gc, imp, os, re, shutil, sys
31
from Shared.DC.ZRDB import Aqueduct
32
from Shared.DC.ZRDB.Connection import Connection as RDBConnection
33
from Products.ERP5Type.DiffUtils import DiffFile
34
from Products.ERP5Type.Globals import Persistent, PersistentMapping
35
from Acquisition import Implicit, aq_base, aq_inner, aq_parent
36
from AccessControl import ClassSecurityInfo, Unauthorized, getSecurityManager
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37
from Products.CMFCore.utils import getToolByName
38
from Products.PythonScripts.PythonScript import PythonScript
39
from Products.ERP5Type.Accessor.Constant import PropertyGetter as ConstantGetter
40
from Products.ERP5Type.Base import WorkflowMethod, _aq_reset
Nicolas Dumazet's avatar
Nicolas Dumazet committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
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
59
from Products.ERP5Type.Utils import convertToUpperCase, PersistentMigrationMixin
60
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
61
from Products.ERP5Type.XMLObject import XMLObject
62
from Products.ERP5Type.dynamic.portal_type_class import synchronizeDynamicModules
Aurel's avatar
Aurel committed
63
from OFS.Traversable import NotFound
64
from OFS import SimpleItem, XMLExportImport
65
from cStringIO import StringIO
Aurel's avatar
Aurel committed
66
from copy import deepcopy
67
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
68
import OFS.XMLExportImport
69
from Products.ERP5Type.patches.ppml import importXML
Aurel's avatar
Aurel committed
70
customImporters={
71
    XMLExportImport.magic: importXML,
Aurel's avatar
Aurel committed
72
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
73

74
from zLOG import LOG, WARNING
75
from warnings import warn
Aurel's avatar
Aurel committed
76
from gzip import GzipFile
77
from lxml.etree import parse
78
from xml.sax.saxutils import escape
79
from Products.CMFCore.Expression import Expression
80
from Products.ERP5Type import tarfile
81
from urllib import quote, unquote
82
from difflib import unified_diff
83
import posixpath
Julien Muchembled's avatar
Julien Muchembled committed
84
import transaction
85

86 87 88 89 90 91
import threading

CACHE_DATABASE_PATH = None
try:
  if int(os.getenv('ERP5_BT5_CACHE', 0)):
    from App.config import getConfiguration
92
    import gdbm
93 94 95 96 97 98
    instancehome = getConfiguration().instancehome
    CACHE_DATABASE_PATH = os.path.join(instancehome, 'bt5cache.db')
except TypeError:
  pass
cache_database = threading.local()

99 100
# those attributes from CatalogMethodTemplateItem are kept for
# backward compatibility
Aurel's avatar
Aurel committed
101 102
catalog_method_list = ('_is_catalog_list_method_archive',
                       '_is_uncatalog_method_archive',
103 104
                       '_is_clear_method_archive',
                       '_is_filtered_archive',)
105

106 107
catalog_method_filter_list = ('_filter_expression_archive',
                              '_filter_expression_instance_archive',
108
                              '_filter_expression_cache_key_archive',
109
                              '_filter_type_archive',)
110

111
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'
112
_MARKER = []
113

114 115 116 117 118 119
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:
120 121 122 123
    try:
      return acquisition_context.getPortalObject().portal_catalog.objectIds('SQLCatalog')[0]
    except IndexError:
      return None
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
  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

143 144 145 146 147
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.
  """
148
  if getattr(aq_base(obj), 'uid', _MARKER) is not _MARKER:
149
    obj.uid = None
150 151 152
  for subobj in obj.objectValues():
    _recursiveRemoveUid(subobj)

153
def removeAll(entry):
154 155 156
  warn('removeAll is deprecated; use shutil.rmtree instead.',
       DeprecationWarning)
  shutil.rmtree(entry, True)
Aurel's avatar
Aurel committed
157

158 159 160 161 162 163 164
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
  """
165
  pw = context.getPortalObject().portal_workflow
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
  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)

187 188 189 190 191 192 193 194 195 196 197 198 199 200
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]
201 202 203
  # recompile the method
  method._arg = Aqueduct.parse(method.arguments_src)
  method.template = method.template_class(method.src)
204

205 206
def registerSkinFolder(skin_tool, skin_folder):
  request = skin_tool.REQUEST
207 208 209
  # XXX: Getting parameter from request instead of dialog is bad
  # XXX: This is even non consistent with rest of parameters selected by user
  #      (like update_translation or update_catalog)
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
  register_skin_selection = request.get('your_register_skin_selection', 1)
  reorder_skin_selection = request.get('your_reorder_skin_selection', 1)
  skin_layer_list = request.get('your_skin_layer_list', 
                                skin_tool.getSkinSelections()) 

  skin_folder_id = skin_folder.getId()

  try:
    skin_selection_list = skin_folder.getProperty(
                 'business_template_registered_skin_selections', 
                 skin_tool.getSkinSelections()
                 )
  except AttributeError:
    skin_selection_list = skin_tool.getSkinSelections()

225 226 227
  if isinstance(skin_selection_list, basestring):
    skin_selection_list = skin_selection_list.split()

228 229 230 231 232 233 234
  def skin_sort_key(skin_folder_id):
    obj = skin_tool._getOb(skin_folder_id, None)
    if obj is None:
      return 0, skin_folder_id
    return -obj.getProperty('business_template_skin_layer_priority',
      obj.meta_type == 'Filesystem Directory View' and -1 or 0), skin_folder_id

235 236 237 238 239 240 241 242 243
  for skin_name in skin_selection_list:

    if (skin_name not in skin_tool.getSkinSelections()) and \
                                          register_skin_selection:
      createSkinSelection(skin_tool, skin_name)
      # add newly created skins to list of skins we care for 
      skin_layer_list.append(skin_name)

    selection = skin_tool.getSkinPath(skin_name) or ''
244
    selection_list = selection.split(',')
245
    if (skin_folder_id not in selection_list):
246
      selection_list.insert(0, skin_folder_id)
247
    if reorder_skin_selection:
248 249
      # Sort by skin priority and ID
      selection_list.sort(key=skin_sort_key)
250
    if (skin_name in skin_layer_list):
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
      skin_tool.manage_skinLayers(skinpath=selection_list,
                                  skinname=skin_name, add_skin=1)
      skin_tool.getPortalObject().changeSkin(None)

def createSkinSelection(skin_tool, skin_name):
  # 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 skin_tool.objectValues():
    if skin_name in skin_folder.getProperty(
             'business_template_registered_skin_selections',
             (skin_name, )):
      if skin_folder.getId() in \
          skin_tool.getSkinPath(skin_tool.getDefaultSkin()):
        if skin_path:
          skin_path = '%s,%s' % (skin_path, skin_folder.getId())
        else:
          skin_path= skin_folder.getId()
  # add newly created skins to list of skins we care for 
  skin_tool.addSkinSelection(skin_name, skin_path)
  skin_tool.getPortalObject().changeSkin(None)

def deleteSkinSelection(skin_tool, skin_name):
  # Do not delete default skin
  if skin_tool.getDefaultSkin() != skin_name:

    skin_selection_registered = False
    for skin_folder in skin_tool.objectValues():
      try:
        skin_selection_list = skin_folder.getProperty(
               'business_template_registered_skin_selections', ())
        if skin_name in skin_selection_list:
          skin_selection_registered = True
          break
      except AttributeError:
        pass

    if (not skin_selection_registered):
      skin_tool.manage_skinLayers(chosen=[skin_name], 
                                  del_skin=1)
      skin_tool.getPortalObject().changeSkin(None)

def unregisterSkinFolder(skin_tool, skin_folder, skin_selection_list):
  skin_folder_id = skin_folder.getId()

  for skin_selection in skin_selection_list:
    selection = skin_tool.getSkinPath(skin_selection)
    selection = selection.split(',')
    if (skin_folder_id in selection):
      selection.remove(skin_folder_id)
      skin_tool.manage_skinLayers(skinpath=tuple(selection),
                                  skinname=skin_selection, add_skin=1)
      deleteSkinSelection(skin_tool, skin_selection)
      skin_tool.getPortalObject().changeSkin(None)

Aurel's avatar
Aurel committed
310 311 312
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
313
  """
314 315 316 317 318 319 320 321
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
      shutil.rmtree(self.path)
      os.makedirs(self.path)
Aurel's avatar
Aurel committed
322 323 324 325 326 327 328 329 330 331

  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

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
  def addObject(self, obj, name, path=None, ext='.xml'):
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
      if '%' not in path:
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wb')
    try:
      f.write(str(obj))
    finally:
      f.close()
350

351
  def finishCreation(self, name=None, **kw):
Aurel's avatar
Aurel committed
352 353 354 355
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
356
    Class archiving business template into a folder tree
357
  """
Aurel's avatar
Aurel committed
358
  def addFolder(self, name=''):
Jérome Perrin's avatar
Jérome Perrin committed
359
    if name != '':
360
      name = os.path.normpath(name)
Aurel's avatar
Aurel committed
361
      path = os.path.join(self.path, name)
362
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
363 364 365 366
        os.makedirs(path)
      return path

  def _initImport(self, file=None, path=None, **kw):
367
    # Normalize the paths to eliminate the effect of double-slashes.
368 369 370 371 372 373 374 375
    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
376

377
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
378 379 380
    """
      Import file from a local folder
    """
381
    class_name = item.__class__.__name__
382 383
    root_path_len = self.root_path_len
    prefix_len = root_path_len + len(class_name) + len(os.sep)
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
    if CACHE_DATABASE_PATH:
      try:
        cache_database.db = gdbm.open(CACHE_DATABASE_PATH, 'cf')
      except gdbm.error:
        cache_database.db = gdbm.open(CACHE_DATABASE_PATH, 'nf')
    try:
      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:]
            if '%' in file_name:
              file_name = unquote(file_name)
            item._importFile(file_name, file)
          finally:
            file.close()
    finally:
      if hasattr(cache_database, 'db'):
        cache_database.db.close()
        del cache_database.db
404

Aurel's avatar
Aurel committed
405 406 407 408 409 410
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
411 412
    BusinessTemplateArchive._initCreation(self, path)

413
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
414 415 416 417 418
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)

  def addFolder(self, name=''):
419
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
420
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
421 422
      os.makedirs(name)

423 424
  def finishCreation(self, name):
    self.tar.add(name)
Aurel's avatar
Aurel committed
425
    self.tar.close()
426
    shutil.rmtree(name)
Aurel's avatar
Aurel committed
427 428 429
    return self.fobj

  def _initImport(self, file=None, **kw):
430 431 432 433 434 435 436 437 438 439 440 441
    self.tar = tarfile.TarFile(fileobj=StringIO(GzipFile(fileobj=file).read()))
    self.item_dict = {}
    setdefault = self.item_dict.setdefault
    for info in self.tar.getmembers():
      if info.isreg():
        path = info.name.split('/')
        if path[0] == '.':
          del path[0]
        file_name = '/'.join(path[2:])
        if '%' in file_name:
          file_name = unquote(file_name)
        setdefault(path[1], []).append((file_name, info))
Aurel's avatar
Aurel committed
442

443
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
444 445
    """
      Import all file from the archive to the site
446
    """
447 448 449
    extractfile = self.tar.extractfile
    for file_name, info in self.item_dict.get(item.__class__.__name__, ()):
      item._importFile(file_name, extractfile(info))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
450

451
class TemplateConditionError(Exception): pass
452
class TemplateConflictError(Exception): pass
453
class BusinessTemplateMissingDependency(Exception): pass
454

455
class BaseTemplateItem(Implicit, Persistent):
456
  """
457
    This class is the base class for all template items.
458
    is_bt_for_diff means This BT is used to compare self temporary BT with installed BT
459
  """
460
  is_bt_for_diff = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
461

462
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
463
    self.__dict__.update(kw)
464
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
465
    self._objects = PersistentMapping()
466
    for id in id_list:
467 468
      if id is not None and id != '':
        self._archive[id] = None
469 470 471 472

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

473
  def preinstall(self, context, installed_item, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
474 475
    """
      Build a list of added/removed/changed files between the BusinessTemplate
476
      being installed (self) and the installed one (installed_item).
Vincent Pelletier's avatar
Vincent Pelletier committed
477 478 479 480 481
      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
482 483
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
484
      new_keys = self._objects.keys()
485
      for path in new_keys:
486
        if installed_item._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
487
          # compare objects to see it there are changes
488
          new_obj_xml = self.generateXml(path=path)
489
          old_obj_xml = installed_item.generateXml(path=path)
490 491
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
492
          # else, compared versions are identical, don't overwrite the old one
493 494
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
495
      # list removed objects
496
      old_keys = installed_item._objects.keys()
497 498 499 500 501 502
      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):
503
    pass
504 505 506

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

508
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
509 510 511 512 513 514
    """
      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.
    """
515 516 517
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
518
    keys.reverse()
519 520 521 522 523 524 525 526 527 528 529
    # 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)
530 531 532 533
        else:
          # As the list of available actions is not strictly defined,
          # prevent mistake if an action is not handled
          raise ValueError, 'Unknown action "%s"' % action
534

535

536 537 538 539
  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
540
  def export(self, context, bta, **kw):
541
    pass
Aurel's avatar
Aurel committed
542

543 544
  def getKeys(self):
    return self._objects.keys()
545

Aurel's avatar
Aurel committed
546
  def importFile(self, bta, **kw):
547
    bta.importFiles(item=self)
548

549
  def removeProperties(self, obj, export):
550 551
    """
    Remove unneeded properties for export
552
    """
553
    obj._p_activate()
554 555
    klass = obj.__class__
    classname = klass.__name__
556

557 558
    attr_set = set(('_dav_writelocks', '_filepath', '_owner', 'uid',
                    'workflow_history', '__ac_local_roles__'))
559
    if export:
560 561
      # PythonScript covers both Zope Python scripts
      # and ERP5 Python Scripts
562 563 564 565
      if isinstance(obj, PythonScript):
        # XXX forward compatibility: set to None instead of deleting '_code'
        #     so that old BT code can import recent BT
        obj._code = None
566 567 568 569 570
        attr_set.update((#'func_code', 'func_defaults', '_code',
                         '_lazy_compilation', 'Python_magic'))
      #elif classname == 'SQL' and klass.__module__== 'Products.ZSQLMethods':
      #  attr_set.update(('_arg', 'template'))
      elif interfaces.IIdGenerator.providedBy(obj):
Nicolas Dumazet's avatar
Nicolas Dumazet committed
571
        attr_set.update(('last_max_id_dict', 'last_id_dict'))
572

573 574
    for attr in obj.__dict__.keys():
      if attr in attr_set or attr.startswith('_cache_cookie_'):
575 576
        delattr(obj, attr)

577
    if classname == 'PDFForm':
578
      if not obj.getProperty('business_template_include_content', 1):
579
        obj.deletePdfContent()
580 581
    return obj

582 583 584 585 586 587 588 589 590
  def getTemplateTypeName(self):
    """
     Get a meaningfull class Name without 'TemplateItem'. Used to 
     present to the user.

     XXX: -12 used here is -len('TemplateItem')
    """
    return self.__class__.__name__[:-12]

591
  def restrictedResolveValue(self, context=None, path='', default=_MARKER):
592 593 594 595
    """
      Get the value with checking the security.
      This method does not acquire the parent.
    """
596 597
    return self.unrestrictedResolveValue(context, path, default=default,
                                         restricted=1)
598

599 600
  def unrestrictedResolveValue(self, context=None, path='', default=_MARKER,
                               restricted=0):
601 602 603 604 605 606 607 608 609 610 611
    """
      Get the value without checking the security.
      This method does not acquire the parent.
    """
    if isinstance(path, basestring):
      stack = path.split('/')
    else:
      stack = list(path)
    stack.reverse()
    if stack:
      if context is None:
612
        portal = aq_inner(self.getPortalObject())
613 614 615 616
        container = portal
      else:
        container = context

617 618 619 620
      if restricted:
        validate = getSecurityManager().validate

      while stack:
621
        key = stack.pop()
622 623 624 625 626 627 628 629
        try:
          value = container[key]
        except KeyError:
          LOG('BusinessTemplate', WARNING, 
              'Could not access object %s' % (path,))
          if default is _MARKER:
            raise
          return default
630

631 632 633 634 635 636 637 638 639 640 641 642
        if restricted:
          try:
            if not validate(container, container, key, value):
              raise Unauthorized('unauthorized access to element %s' % key)
          except Unauthorized:
            LOG('BusinessTemplate', WARNING,
                'access to %s is forbidden' % (path,))
          if default is _MARKER:
            raise
          return default

        container = value
643

644 645 646
      return value
    else:
      return context
647

648 649 650
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
651
  """
652

653 654 655 656
  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()
657
      self._archive.clear()
658 659 660
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
661

662
  def export(self, context, bta, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
663 664 665 666
    """
      Export the business template : fill the BusinessTemplateArchive with
      objects exported as XML, hierarchicaly organised.
    """
667 668 669
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
Vincent Pelletier's avatar
Vincent Pelletier committed
670
    for key, obj in self._objects.iteritems():
671
      # create folder and subfolders
672
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
673 674 675
      encode_folders = []
      for folder in folders.split('/'):
        if '%' not in folder:
676
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
677 678 679
        else:
          encode_folders.append(folder)
      path = os.path.join(root_path, (os.sep).join(encode_folders))
680 681
      bta.addFolder(name=path)
      # export object in xml
682
      f = StringIO()
683 684
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
685

Aurel's avatar
Aurel committed
686
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
687
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
688 689
    p = context.getPortalObject()
    for id in id_list:
690
      relative_url = '/'.join([url,id])
691 692
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
693
      obj = self.removeProperties(obj, 1)
Vincent Pelletier's avatar
Vincent Pelletier committed
694 695 696
      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
697
        groups = deepcopy(obj.groups)
698
      if id_list:
Aurel's avatar
Aurel committed
699
        self.build_sub_objects(context, id_list, relative_url)
700
        for id_ in list(id_list):
701
          obj._delObject(id_)
702
      if hasattr(aq_base(obj), 'groups'):
703 704 705
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
706

707 708 709 710
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
711 712 713 714
      try:
        obj = p.unrestrictedTraverse(relative_url)
      except ValueError:
        raise ValueError, "Can not access to %s" % relative_url
715 716 717 718
      try:
        obj = obj._getCopy(context)
      except AttributeError:
        raise AttributeError, "Could not find object '%s' during business template processing." % relative_url
719
      _recursiveRemoveUid(obj)
720
      obj = self.removeProperties(obj, 1)
721
      id_list = obj.objectIds()
Vincent Pelletier's avatar
Vincent Pelletier committed
722 723
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
724
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
725 726
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
727
        for id_ in list(id_list):
728
          obj._delObject(id_)
729
      if hasattr(aq_base(obj), 'groups'):
730 731 732
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
733

734
  def _compileXML(self, file):
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
    # This method converts XML to ZEXP. Because the conversion
    # is quite heavy, a persistent cache database is used to
    # store ZEXP, so the second run wouldn't have to re-generate
    # identical data again.
    #
    # For now, a pair of the path to an XML file and its modification time
    # are used as a unique key. In theory, a checksum of the content could
    # be used instead, and it could be more reliable, as modification time
    # might not be updated in some insane filesystems correctly. However,
    # in practice, checksums consume a lot of CPU time, so when the cache
    # does not hit, the increased overhead is significant. In addition, it
    # does rarely happen that two XML files in Business Templates contain
    # the same data, so it may not be expected to have more cache hits
    # with this approach.
    #
    # The disadvantage is that this wouldn't work with the archive format,
    # because each entry in an archive does not have a mtime in itself.
    # However, the plan is to have an archive to retain ZEXP directly
    # instead of XML, so the idea of caching would be completely useless
    # with the archive format.
    name = file.name
    mtime = os.path.getmtime(file.name)
    key = '%s:%s' % (name, mtime)

    try:
      return StringIO(cache_database.db[key])
    except:
      pass

    #LOG('Business Template', 0, 'Compiling %s...' % (name,))
    from Shared.DC.xml import ppml
    from OFS.XMLExportImport import start_zopedata, save_record, save_zopedata
    import xml.parsers.expat
    outfile=StringIO()
    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=xml.parsers.expat.ParserCreate('utf-8')
      p.returns_unicode = False
      p.CharacterDataHandler=F.handle_data
      p.StartElementHandler=F.unknown_starttag
      p.EndElementHandler=F.unknown_endtag
      r=p.Parse(data)

      try:
        cache_database.db[key] = outfile.getvalue()
      except:
        pass

      outfile.seek(0)
      return outfile
    except:
      outfile.close()
      raise
794

795
  def _importFile(self, file_name, file_obj):
796
    # import xml file
797
    if not file_name.endswith('.xml'):
798
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
799
      return
800 801 802 803 804
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
805
    __traceback_info__ = 'Importing %s' % file_name
806 807
    if hasattr(cache_database, 'db') and isinstance(file_obj, file):
      obj = connection.importFile(self._compileXML(file_obj))
808
    else:
809 810
      # FIXME: Why not use the importXML function directly? Are there any BT5s
      # with actual .zexp files on the wild?
811
      obj = connection.importFile(file_obj, customImporters=customImporters)
812 813
    self._objects[file_name[:-4]] = obj

814
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
815 816
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
817 818 819
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
      for path in self._objects:
820
        if installed_item._objects.has_key(path):
821
          upgrade_list.append((path, installed_item._objects[path]))
822
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
823 824 825 826 827 828 829 830 831 832
          modified_object_list[path] = 'New', type_name
      # update _p_jar property of objects cleaned by removeProperties
      transaction.savepoint(optimistic=True)
      for path, old_object in upgrade_list:
        # compare object to see it there is changes
        new_object = self._objects[path]
        new_io = StringIO()
        old_io = StringIO()
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, new_io)
        new_obj_xml = new_io.getvalue()
833 834 835
        try:
          OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
          old_obj_xml = old_io.getvalue()
836 837
        except (ImportError, UnicodeDecodeError), e: # module is already
                                                     # removed etc.
838
          old_obj_xml = '(%s: %s)' % (e.__class__.__name__, e)
Julien Muchembled's avatar
Julien Muchembled committed
839 840 841 842
        new_io.close()
        old_io.close()
        if new_obj_xml != old_obj_xml:
          modified_object_list[path] = 'Modified', type_name
843
      # get removed object
844
      for path in set(installed_item._objects) - set(self._objects):
Julien Muchembled's avatar
Julien Muchembled committed
845
        modified_object_list[path] = 'Removed', type_name
846 847
    return modified_object_list

848
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
849 850 851
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
852
    subobjects_dict = {}
853
    if trashbin is None: # must return subobjects
854 855 856 857 858 859
      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)
860
        subobjects_dict[subobject_id] = subobject_copy
861
      return subobjects_dict
862
    # XXX btsave is for backward compatibility
863
    if action == 'backup' or action == 'btsave' or action == 'save_and_remove':
864 865 866
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=1, **kw)
867
    elif action == 'install':
868 869 870
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=0, **kw)
871 872 873 874
    else:
      # As the list of available actions is not strictly defined,
      # prevent mistake if an action is not handled
      raise ValueError, 'Unknown action "%s"' % action
875
    return subobjects_dict
876

877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
  def beforeInstall(self):
    """
      Installation hook.
      Called right at the begining of "install" method.
      Can be overridden by subclasses.
    """
    pass

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

893
  def onNewObject(self, obj):
894 895 896 897
    """
      Installation hook.
      Called when installation process determined that object to install is
      new on current site (it's not replacing an existing object).
898
      `obj` parameter is the newly created object in its acquisition context.
899 900 901 902
      Can be overridden by subclasses.
    """
    pass

903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
  def setSafeReindexationMode(self, context):
    """
      Postpone indexations after unindexations.
      This avoids alarming error messages about a single uid being used
      by "deleted" path and reindexed object. This can happen here for
      objects on which the uid was restored: previous object was deleted,
      hence the "deleted" path, and new object does have the same uid.
    """
    original_reindex_parameters = context.getPlacelessDefaultReindexParameters()
    if original_reindex_parameters is None:
      original_reindex_parameters = {}
    activate_kw = original_reindex_parameters.get('activate_kw', {}).copy()
    activate_kw['after_method_id'] = 'unindexObject'
    context.setPlacelessDefaultReindexParameters(activate_kw=activate_kw, \
                                                 **original_reindex_parameters)
    return original_reindex_parameters

920 921 922 923 924 925
  def _getObjectKeyList(self):
    # sort to add objects before their subobjects
    keys = self._objects.keys()
    keys.sort()
    return keys

926
  def install(self, context, trashbin, **kw):
927
    self.beforeInstall()
928 929
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
930
    if context.getTemplateFormatVersion() == 1:
931 932 933 934 935 936
      def recurse(hook, document, prefix=''):
        my_prefix = '%s/%s' % (prefix, document.id)
        if (hook(document, my_prefix)):
          for subdocument in document.objectValues():
            recurse(hook, subdocument, my_prefix)
      def saveHook(document, prefix):
937
        uid = getattr(aq_base(document), 'uid', None)
938 939 940 941 942 943 944 945 946 947 948 949
        if uid is None:
          return 0
        else:
          saved_uid_dict[prefix] = uid
          return 1
      def restoreHook(document, prefix):
        uid = saved_uid_dict.get(prefix)
        if uid is None:
          return 0
        else:
          document.uid = uid
          return 1
950
      groups = {}
951
      old_groups = {}
952
      portal = context.getPortalObject()
953 954
      # set safe activities execution order
      original_reindex_parameters = self.setSafeReindexationMode(context)
955 956
      object_key_list = self._getObjectKeyList()
      for path in object_key_list:
957 958 959 960 961
        # We do not need to perform any backup because the object was
        # created during the Business Template installation
        if update_dict.get(path) == 'migrate':
          continue

962 963
        if update_dict.has_key(path) or force:
          # get action for the oject
Yoshinori Okuji's avatar
Yoshinori Okuji committed
964
          action = 'backup'
965 966 967 968 969
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          # get subobjects in path
970 971 972
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
973
          try:
974
            container = self.unrestrictedResolveValue(portal, container_path)
975 976
          except KeyError:
            # parent object can be set to nothing, in this case just go on
977
            container_url = '/'.join(container_path)
978 979 980 981
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
982
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
983 984
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
985
              container_container = portal.unrestrictedTraverse(container_path[:-1])
986 987 988 989 990
              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)
991 992
            else:
              raise
993
          saved_uid_dict = {}
994
          subobjects_dict = {}
Julien Muchembled's avatar
Julien Muchembled committed
995
          portal_type_dict = {}
996
          old_obj = container._getOb(object_id, None)
997
          object_existed = old_obj is not None
998
          if old_obj is not None:
999
            # Object already exists
1000
            recurse(saveHook, old_obj)
1001
            if getattr(aq_base(old_obj), 'groups', None) is not None:
1002 1003 1004 1005 1006
              # 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)
1007
            subobjects_dict = self._backupObject(action, trashbin,
1008
                                                 container_path, object_id)
Julien Muchembled's avatar
Julien Muchembled committed
1009
            # in case of portal types, we want to keep some properties
1010
            if interfaces.ITypeProvider.providedBy(container):
1011
              for attr in ('allowed_content_types',
Julien Muchembled's avatar
Julien Muchembled committed
1012 1013 1014 1015 1016 1017
                           'hidden_content_type_list',
                           'property_sheet_list',
                           'base_category_list'):
                portal_type_dict[attr] = getattr(old_obj, attr, ())
              portal_type_dict['workflow_chain'] = \
                getChainByType(context)[1].get('chain_' + object_id, '')
1018
            container.manage_delObjects([object_id])
1019

1020
          # install object
1021
          obj = self._objects[path]
1022 1023 1024 1025
          # XXX Following code make Python Scripts compile twice, because
          #     _getCopy returns a copy without the result of the compilation.
          #     A solution could be to add a specific _getCopy method to
          #     Python Scripts.
1026
          if getattr(aq_base(obj), 'groups', None) is not None:
1027
            # we must keep original order groups
1028
            # because they change when we add subobjects
1029
            groups[path] = deepcopy(obj.groups)
1030
          # copy the object
1031 1032 1033 1034 1035 1036 1037
          if (getattr(aq_base(obj), '_mt_index', None) is not None and
              obj._count() == 0):
            # some btrees were exported in a corrupted state. They're empty but
            # their metadata-index (._mt_index) contains entries which in
            # Zope 2.12 are used for .objectIds(), .objectValues() and
            # .objectItems(). In these cases, force the 
            LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
Łukasz Nowak's avatar
Łukasz Nowak committed
1038
                'Cleaning corrupted BTreeFolder2 object at %r.' % (path,))
1039
            obj._initBTrees()
1040
          obj = obj._getCopy(container)
1041
          self.removeProperties(obj, 0)
1042 1043 1044 1045 1046
          try:
            container._setObject(object_id, obj)
          except AttributeError:
            LOG("BT, install", 0, object_id)
            raise
1047
          obj = container._getOb(object_id)
1048 1049 1050 1051 1052

          if not object_existed:
            # A new object was added, call the hook
            self.onNewObject(obj)

1053 1054
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
1055
          self.REQUEST.set('is_business_template_installation', 1)
1056 1057 1058 1059
          # We set isIndexable to 0 before calling
          # manage_afterClone in order to not call recursiveReindex, this is
          # useless because we will already reindex every created object, so
          # we avoid duplication of reindexation
1060
          obj.isIndexable = ConstantGetter('isIndexable', value=False)
1061
          obj.manage_afterClone(obj)
1062 1063 1064
          del obj.isIndexable
          if getattr(aq_base(obj), 'reindexObject', None) is not None:
            obj.reindexObject()
1065
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
1066
          if portal_type_dict:
1067
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
1068
            wf_chain = portal_type_dict.pop('workflow_chain')
1069 1070
            chain_dict = getChainByType(context)[1]
            default_chain = ''
1071
            chain_dict['chain_%s' % (object_id)] = wf_chain
1072
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
1073 1074
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
1075
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
1076
          if subobjects_dict:
1077
            # get a jar
1078 1079
            connection = obj._p_jar
            o = obj
1080
            while connection is None:
1081 1082
              o = o.aq_parent
              connection = o._p_jar
1083
            # import subobjects
1084
            for subobject_id, subobject_data in subobjects_dict.iteritems():
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
              try:
                if obj._getOb(subobject_id, None) is None:
                  subobject_data.seek(0)
                  subobject = connection.importFile(subobject_data)
                  obj._setObject(subobject_id, subobject)
              except AttributeError:
                # XXX this may happen when an object which can contain
                # sub-objects (e.g. ERP5 Form) has been replaced with
                # an object which cannot (e.g. External Method).
                LOG('BusinessTemplate', WARNING,
                    'could not restore %r in %r' % (subobject_id, obj))
1096
          if obj.meta_type in ('Z SQL Method',):
1097
            fixZSQLMethod(portal, obj)
1098 1099 1100
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
1101 1102 1103
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
1104
          elif obj.meta_type in ('ERP5 Ram Cache',
1105
                                 'ERP5 Distributed Ram Cache',):
1106 1107
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
1108 1109
          elif (container.meta_type == 'CMF Skins Tool') and \
              (old_obj is not None):
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
            # Keep compatibility with previous export format of
            # business_template_registered_skin_selections
            # and do not modify exported value
            if obj.getProperty('business_template_registered_skin_selections', 
                               None) is None:
              # Keep previous value of register skin selection for skin folder
              skin_selection_list = old_obj.getProperty(
                  'business_template_registered_skin_selections', None)
              if skin_selection_list is not None:
                if isinstance(skin_selection_list, basestring):
                  skin_selection_list = skin_selection_list.split(' ')
                obj._setProperty(
                    'business_template_registered_skin_selections',
                    skin_selection_list, type='tokens')
1124 1125 1126 1127 1128 1129 1130 1131
          # in case the portal ids, we want keep the property dict
          elif interfaces.IIdGenerator.providedBy(obj) and \
            old_obj is not None:
            for dict_name in ('last_max_id_dict', 'last_id_dict'):
              # Keep previous last id dict
              if getattr(old_obj, dict_name, None) is not None:
                old_dict = getattr(old_obj, dict_name, None)
                setattr(obj, dict_name, old_dict)
1132

1133
          recurse(restoreHook, obj)
1134
      # now put original order group
1135 1136
      # we remove object not added in forms
      # we put old objects we have kept
1137
      for path, new_groups_dict in groups.iteritems():
1138 1139 1140 1141 1142 1143 1144 1145 1146
        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
1147
          # excetp the one that had to be removed
1148 1149 1150 1151
          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'):
1152 1153
              continue
            widget_in_form = 0
1154 1155
            for group_id, group_value_list in new_groups_dict.iteritems():
              if widget_id in group_value_list:
1156 1157 1158 1159 1160 1161
                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:
1162
              for old_group_id, old_group_values in old_groups_dict.iteritems():
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
                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,]
1174
                  obj.group_list = list(obj.group_list) + ['not_assigned']
1175
          # second check all widget_id in order are in form
1176 1177
          for group_id, group_value_list in new_groups_dict.iteritems():
            for widget_id in tuple(group_value_list):
1178 1179 1180
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
1181
                group_value_list.remove(widget_id)
1182
          # now set new group object
1183
          obj.groups = new_groups_dict
1184
      # restore previous activities execution order
1185
      context.setPlacelessDefaultReindexParameters(**original_reindex_parameters)
1186
      # Do not forget to delete all remaining objects if asked by user
1187 1188 1189 1190 1191 1192
      # Fetch all sub objects path recursively
      recursive_path_list = []
      def fillRecursivePathList(from_path_list):
        for from_path in from_path_list:
          container = portal.unrestrictedTraverse(from_path, None)
          if container is not None:
1193 1194
            if from_path in recursive_path_list:
              continue
1195 1196 1197 1198 1199
            recursive_path_list.append(from_path)
            # Check that container support iteration of sub_content_id
            if getattr(aq_base(container), 'objectIds', None) is not None:
              fillRecursivePathList(['%s/%s' % (from_path, sub_content_id) for\
                                        sub_content_id in container.objectIds()])
1200
      fillRecursivePathList(object_key_list)
1201 1202 1203
      for recursive_path in recursive_path_list:
        if recursive_path in update_dict:
          action = update_dict[recursive_path]
1204
          if action in ('remove', 'save_and_remove'):
1205
            document = self.unrestrictedResolveValue(portal, recursive_path, None)
1206 1207 1208
            if document is None:
              # It happens if the parent of target path is removed before
              continue
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
            if getattr(aq_base(document), 'getParentValue', None) is not None:
              # regular ERP5 object
              parent = document.getParentValue()
            else:
              parent = document.aq_parent
            document_id = document.getId()
            container_path_list = recursive_path.split('/')[:-1]
            self._backupObject(action, trashbin, container_path_list,
                               document_id)
            parent.manage_delObjects([document_id])
Aurel's avatar
Aurel committed
1219
    else:
1220 1221
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1222
      portal = context.getPortalObject()
1223
      for relative_url in self._archive.keys():
1224
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
1225 1226 1227 1228
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
1229
        if object_id in container_ids:    # Object already exists
1230
          self._backupObject('backup', trashbin, container_path, object_id)
1231
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
1232
        # Set a hard link
1233 1234 1235 1236 1237 1238
        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',):
1239
          fixZSQLMethod(portal, obj)
1240
    self.afterInstall()
1241 1242 1243

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
1244
    trash = kw.get('trash', 0)
1245 1246 1247 1248 1249
    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
1250
      object_keys = self._archive.keys()
1251
    for relative_url in object_keys:
1252 1253
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
1254
      try:
1255
        container = self.unrestrictedResolveValue(portal, container_path)
1256
        object = container._getOb(object_id) # We force access to the object to be sure
1257 1258
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
1259
        if trash and trashbin is not None:
1260
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
1261
        if container.meta_type == 'CMF Skins Tool':
1262 1263
          # we are removing a skin folder, check and 
          # remove if registered skin selection
1264
          skin_folder = container[object_id]
1265 1266 1267
          unregisterSkinFolder(container, skin_folder,
              container.getSkinSelections())

1268
        container.manage_delObjects([object_id])
1269
        if container.aq_parent.meta_type == 'ERP5 Catalog' and not len(container):
1270
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1271
          container.getParentValue().manage_delObjects([container.id])
1272
      except (NotFound, KeyError, BadRequest, AttributeError):
1273
        # object is already backup and/or removed
1274
        pass
1275 1276
    BaseTemplateItem.uninstall(self, context, **kw)

1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
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

1289 1290 1291 1292 1293 1294 1295 1296 1297
  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()
1298 1299
    object_keys.sort()
    object_keys.reverse()
1300 1301
    p = context.getPortalObject()
    for path in object_keys:
1302 1303 1304 1305 1306
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1307 1308 1309
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1310
        try:
Aurel's avatar
Aurel committed
1311 1312
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
1313
          container = self.unrestrictedResolveValue(portal, container_path)
1314
          if trash and trashbin is not None:
1315 1316
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1317
                                           keep_subobjects=1)
1318 1319 1320 1321 1322 1323
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1324 1325 1326
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1327

1328 1329 1330 1331 1332 1333 1334 1335 1336
      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.
1337 1338 1339
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1340
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1341 1342
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1343
      if object_id != "":
1344
        path_list.extend(self._resolvePath(
1345
            folder._getOb(object_id),
1346
            relative_url_list + [object_id], id_list[1:]))
1347
    return path_list
Aurel's avatar
Aurel committed
1348

1349 1350 1351
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1352
    keys = self._path_archive.keys()
1353
    keys.sort()
Aurel's avatar
Aurel committed
1354
    for path in keys:
1355
      include_subobjects = 0
Aurel's avatar
Aurel committed
1356
      if path.endswith("**"):
1357
        include_subobjects = 1
1358
      for relative_url in self._resolvePath(p, [], path.split('/')):
1359 1360
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1361
        obj = obj.__of__(context)
1362
        _recursiveRemoveUid(obj)
1363
        id_list = obj.objectIds()
1364
        obj = self.removeProperties(obj, 1)
1365
        if hasattr(aq_base(obj), 'groups'):
1366
          # we must keep groups because it's ereased when we delete subobjects
1367
          groups = deepcopy(obj.groups)
1368
        if len(id_list) > 0:
1369 1370
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1371
          for id_ in list(id_list):
1372
            obj._delObject(id_)
1373
        if hasattr(aq_base(obj), 'groups'):
1374 1375 1376
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1377

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1378 1379 1380 1381 1382 1383 1384 1385
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)

1386
  def install(self, context, trashbin, **kw):
1387
    """ When we install a tool that is a type provider not
1388
    registered on types tool, register it into the type provider.
1389
    """
1390 1391 1392 1393
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    for type_container_id, obj in self._objects.iteritems():
1394
      if interfaces.ITypeProvider.providedBy(obj) and \
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
          type_container_id not in types_tool.type_provider_list:
        types_tool.type_provider_list = tuple(types_tool.type_provider_list) + \
                                        (type_container_id,)

  def uninstall(self, context, **kw):
    """ When we uninstall a tool, unregister it from the type provider. """
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._path_archive.keys()
    for tool_id in object_keys:
      types_tool.type_provider_list = tuple([ \
        x for x in types_tool.type_provider_list \
        if x != tool_id])
    PathTemplateItem.uninstall(self, context, **kw)

  def remove(self, context, **kw):
    """ When we remove a tool, unregister it from the type provider. """
    portal = context.getPortalObject()
1417
    types_tool = portal.portal_types
1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    for tool_id in keys:
      if remove_dict.has_key(tool_id):
        action = remove_dict[tool_id]
        if 'remove' in action:
          types_tool.type_provider_list = tuple([ \
            x for x in types_tool.type_provider_list \
            if x != tool_id])
    PathTemplateItem.remove(self, context, **kw)
1428

1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
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")
1444
    if len(id_list) != 1:
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
      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():
1457
      pref = portal.unrestrictedTraverse(object_path)
1458
      # XXX getPreferenceState is a bad name
1459
      if pref.getPreferenceState() == 'disabled':
1460 1461
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1462 1463
        portal.portal_workflow.doActionFor(
                      pref,
1464 1465 1466
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1467 1468
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1469

1470 1471
class CategoryTemplateItem(ObjectTemplateItem):

1472 1473
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1474

1475 1476 1477 1478
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1479 1480
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1481
      obj = self.removeProperties(obj, 1)
1482
      id_list = obj.objectIds()
1483
      if id_list:
1484
        self.build_sub_objects(context, id_list, relative_url)
1485
        for id_ in list(id_list):
1486
          obj._delObject(id_)
1487 1488
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1489 1490 1491 1492 1493

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1494 1495 1496 1497 1498 1499 1500 1501
      try:
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
      except (KeyError, AttributeError):
        if self.is_bt_for_diff:
          continue
        else:
          raise ValueError, "%s not found" % relative_url
1502
      _recursiveRemoveUid(obj)
1503
      obj = self.removeProperties(obj, 1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1504
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1505
      id_list = obj.objectIds()
1506 1507
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1508
        for id_ in list(id_list):
1509
          obj._delObject(id_)
1510
      else:
1511
        for id_ in list(id_list):
1512
          obj._delObject(id_)
1513 1514
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1515

1516 1517 1518
  def beforeInstall(self):
    self._installed_new_category = False

1519
  def onNewObject(self, obj):
1520 1521 1522 1523
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1524 1525
      # reset accessors if we installed a new category
      _aq_reset()
1526

1527 1528
class SkinTemplateItem(ObjectTemplateItem):

1529 1530
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1531

1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
    for relative_url in self._objects.keys():
      obj = self._objects[relative_url]
      if (getattr(obj, 'meta_type', None) == 'Folder') and \
        (obj.getProperty('business_template_registered_skin_selections', None) \
            is not None):
          obj._delProperty(
              'business_template_registered_skin_selections')

1542 1543
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556
    # 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

1557
  def install(self, context, trashbin, **kw):
1558
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1559 1560
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1561
    p = context.getPortalObject()
1562
    skin_tool = p.portal_skins
1563 1564
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1565
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1566 1567
        fixZSQLMethod(p, obj)

1568
      # Do not register skin which were explicitely ask not to be installed
1569 1570 1571 1572 1573
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589
      if folder.aq_parent.meta_type == 'CMF Skins Tool':
        registerSkinFolder(skin_tool, folder)

class RegisteredSkinSelectionTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

    for key in self._archive.keys():
      skin_folder_id, skin_selection_id = key.split(' | ')

      skin_folder = skin_tool[skin_folder_id]
      selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections',
          [])
1590 1591 1592
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1593
      if skin_selection_id in selection_list:
1594
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1595
      else:
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
        raise NotFound, 'No skin selection %s found for skin folder %s.' \
                          % (skin_selection_id, skin_folder_id)

  # Function to generate XML Code Manually
  def generateXml(self, path=None):
    xml_data = '<registered_skin_selection>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
      skin_selection_list = self._objects[key]
      xml_data += '\n <skin_folder_selection>'
      xml_data += '\n  <skin_folder>%s</skin_folder>' % key
      xml_data += '\n  <skin_selection>%s</skin_selection>' \
                      % ','.join(skin_selection_list)
      xml_data += '\n </skin_folder_selection>'
    xml_data += '\n</registered_skin_selection>'
    return xml_data

  def export(self, context, bta, **kw):
1615
    if not self._objects:
1616 1617 1618 1619
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
1620 1621 1622
    bta.addObject(obj=self.generateXml(), 
                  name='registered_skin_selection',  
                  path=root_path)
1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

    for skin_folder_id in self._objects.keys():

      if update_dict.has_key(skin_folder_id) or force:
        if not force:
          action = update_dict[skin_folder_id]
          if action == 'nothing':
            continue
        skin_folder = skin_tool[skin_folder_id]
1638 1639 1640
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1641

1642
        if selection_list is default_value:
1643
          create_property = True
1644
          selection_list = self._objects[skin_folder_id]
1645
        else:
1646
          create_property = False
1647 1648 1649 1650 1651
          if isinstance(selection_list, basestring):
            selection_list = selection_list.replace(',', ' ').split(' ')
          elif isinstance(selection_list, tuple):
            selection_list = list(selection_list)
          selection_list.extend(self._objects[skin_folder_id])
1652 1653

        # Remove duplicate
1654
        selection_list = list(set(selection_list))
1655 1656 1657
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
1658
              selection_list, type='tokens')
1659 1660 1661
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
1662
              selection_list)
1663 1664

        unregisterSkinFolder(skin_tool, skin_folder,
1665
                             skin_tool.getSkinSelections())
1666
        registerSkinFolder(skin_tool, skin_folder)
1667 1668

  def uninstall(self, context, **kw):
1669 1670 1671
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1672 1673 1674 1675
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1676 1677 1678 1679
      object_keys = self._objects.keys()

    for skin_folder_id in object_keys:
      skin_folder = skin_tool[skin_folder_id]
1680
      current_selection_list = skin_folder.getProperty(
1681
        'business_template_registered_skin_selections', [])
1682
      current_selection_set = set(current_selection_list)
1683

1684 1685 1686
      skin_selection_list = workflow_id = self._objects[skin_folder_id]
      if isinstance(skin_selection_list, str):
        skin_selection_list = skin_selection_list.replace(',', ' ').split(' ')
1687 1688 1689 1690 1691
      for skin_selection in skin_selection_list:
        current_selection_set.remove(skin_selection)

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1692
        skin_folder._updateProperty(
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706
            'business_template_registered_skin_selections',
            current_selection_list)

        # Unregister skin folder from skin selection
        unregisterSkinFolder(skin_tool, skin_folder, skin_selection_list)
      else:
        delattr(skin_folder, 'business_template_registered_skin_selections')

        # Delete all skin selection
        for skin_selection in skin_selection_list:
          deleteSkinSelection(skin_tool, skin_selection)
        # Register to all other skin selection
        registerSkinFolder(skin_tool, skin_folder)

1707
  def preinstall(self, context, installed_item, **kw):
1708 1709 1710 1711 1712
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      for path in new_keys:
1713
        if installed_item._objects.has_key(path):
1714 1715
          # compare object to see it there is changes
          new_object = self._objects[path]
1716
          old_object = installed_item._objects[path]
1717 1718 1719 1720 1721
          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
1722
      old_keys = installed_item._objects.keys()
1723 1724 1725 1726 1727 1728 1729
      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 _importFile(self, file_name, file):
    if not file_name.endswith('.xml'):
1730
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1731 1732 1733 1734
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
1735 1736 1737
    for skin_folder_selection in xml.getroot():
      skin_folder_id = skin_folder_selection.find('skin_folder').text
      selection_string = skin_folder_selection.find('skin_selection').text
1738 1739
      if not selection_string:
        selection_list = []
1740
      else:
1741 1742
        selection_list = selection_string.split(',')
      skin_selection_dict[skin_folder_id] = selection_list
1743
    self._objects = skin_selection_dict
1744 1745


1746
class WorkflowTemplateItem(ObjectTemplateItem):
1747

1748 1749
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1750

1751 1752 1753 1754 1755
  # When the root object of a workflow is modified, the entire workflow is
  # recreated: all subobjects are discarded and must be reinstalled.
  # So we hide modified subobjects to the user and we always reinstall
  # (or remove) everything.

1756
  def preinstall(self, context, installed_item, installed_bt, **kw):
1757
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
1758
                                                         installed_item, **kw)
1759 1760 1761 1762
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1763
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1764 1765
      else:
        modified_workflow_dict[modified_object] = state
1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787
    removed_workflow_id_list = [x[0].split('/', 1)[1] \
                                for x in modified_workflow_dict.iteritems() \
                                if x[1][0] == 'Removed']
    if len(removed_workflow_id_list) > 0:
      installed_chain_list = [[y.strip() for y in x.split('|')] for x in \
                                installed_bt.getTemplatePortalTypeWorkflowChainList()]
      new_chain_list = [[y.strip() for y in x.split('|')] for x in \
                          context.getTemplatePortalTypeWorkflowChainList()]
      chain_dict = getChainByType(context)[1]
      for workflow_id in removed_workflow_id_list:
        affected_portal_type_set = set([x[0][6:] for x in \
                                        chain_dict.iteritems() \
                                        if workflow_id in \
                                        [y.strip() for y in x[1].split(',')]])
        safe_portal_type_set = set([x[0] for x in installed_chain_list \
                                    if x[1] == workflow_id]) - \
                               set([x[0] for x in new_chain_list \
                                    if x[1] == workflow_id])
        if affected_portal_type_set - safe_portal_type_set:
          value = modified_workflow_dict['portal_workflow/%s' % workflow_id]
          modified_workflow_dict['portal_workflow/%s' % workflow_id] = \
              ('Removed but used', value[1])
1788 1789
    return modified_workflow_dict

1790
  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1791
    if context.getTemplateFormatVersion() == 1:
1792 1793 1794
      portal = context.getPortalObject()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
Julien Muchembled's avatar
Julien Muchembled committed
1795 1796 1797
      # sort to add objects before their subobjects
      for path in sorted(self._objects):
          if force:
1798
            action = 'backup'
Julien Muchembled's avatar
Julien Muchembled committed
1799
          else:
1800
            action = update_dict.get('/'.join(path.split('/')[:2]))
Julien Muchembled's avatar
Julien Muchembled committed
1801 1802
            if action in (None, 'nothing'):
              continue
1803 1804 1805
          container_path = path.split('/')[:-1]
          object_id = path.split('/')[-1]
          try:
1806
            container = self.unrestrictedResolveValue(portal, container_path)
1807 1808
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1809
            container_url = '/'.join(container_path)
1810 1811 1812 1813 1814 1815
            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
1816
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1817
            container.manage_delObjects([object_id])
1818 1819
          obj = self._objects[path]
          obj = obj._getCopy(container)
1820
          self.removeProperties(obj, 0)
1821 1822 1823 1824
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1825 1826 1827
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)

1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842
  def uninstall(self, context, **kw):
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    removed_workflow_id_list = set([x.split('/', 1)[1] for x in object_keys])
    (default_chain, chain_dict) = getChainByType(context)
    for portal_type, workflow_ids in chain_dict.iteritems():
      workflow_ids = set([x.strip() for x in workflow_ids.split(',')]) - \
                     removed_workflow_id_list
      chain_dict[portal_type] = ', '.join(workflow_ids)
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
    ObjectTemplateItem.uninstall(self, context, **kw)
1843

1844 1845
class PortalTypeTemplateItem(ObjectTemplateItem):

1846 1847
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1848 1849
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1850 1851 1852
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1853 1854
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1855
      obj = p.unrestrictedTraverse(relative_url)
1856 1857 1858 1859
      # normalize relative_url, not all type informations are stored in
      # "portal_types"
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])

1860
      obj = obj._getCopy(context)
1861
      obj._p_activate()
1862
      for attr in obj.__dict__.keys():
1863 1864 1865 1866 1867 1868 1869 1870
        if attr == '_property_domain_dict':
          continue
        if attr[0] == '_' or attr in ('allowed_content_types',
                                      'hidden_content_type_list',
                                      'property_sheet_list',
                                      'base_category_list',
                                      'last_id', 'uid', 'workflow_history'):
          delattr(obj, attr)
1871 1872
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1873

1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889
  def _getObjectKeyList(self):
    # Sort portal types to install according to their dependencies
    object_key_list = self._objects.keys()
    path_dict = dict(x.split('/')[1:] + [x] for x in object_key_list)
    cache = {}
    def solveDependency(path):
      score = cache.get(path)
      if score is None:
        obj = self._objects[path]
        klass = obj.__class__
        if klass.__module__.startswith('Products.ERP5Type.Document.'):
          portal_type = obj.portal_type
          obj._p_deactivate()
        else:
          portal_type = klass.__name__
        depend = path_dict.get(portal_type)
1890 1891 1892 1893 1894 1895
        # Prevent infinite recursion for 'portal_types/Base Type',
        # only relevant with Portal Types classes because 'Base Type'
        # is an 'erp5.portal_type.Base Type' class
        if depend == path:
          assert depend == 'portal_types/Base Type'
          return 0, path
1896 1897 1898 1899 1900 1901 1902 1903 1904
        cache[path] = score = depend and 1 + solveDependency(depend)[0] or 0
      return score, path
    PersistentMigrationMixin._no_migration += 1
    try:
      object_key_list.sort(key=solveDependency)
    finally:
      PersistentMigrationMixin._no_migration -= 1
    return object_key_list

1905 1906
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1907 1908 1909 1910
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1911 1912
    # We now need to setup the list of workflows corresponding to
    # each portal type
1913
    (default_chain, chain_dict) = getChainByType(context)
1914
    # Set the default chain to the empty string is probably the
1915
    # best solution, by default it is 'default_workflow', which is
1916
    # not very usefull
1917
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1918
    if context.getTemplateFormatVersion() == 1:
1919
      object_list = self._objects
1920
    else:
1921 1922
      object_list = self._archive
    for path in object_list.keys():
1923 1924 1925 1926
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1927
            continue
1928 1929
        obj = object_list[path]
        portal_type = obj.id
1930 1931 1932
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1933 1934
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1935

1936 1937
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1938 1939 1940
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
1941
      result_dict = {}
1942
      xml = parse(file)
1943
      chain_list = xml.findall('//chain')
1944
      for chain in chain_list:
1945 1946 1947 1948
        portal_type = chain.find('type').text
        workflow = chain.find('workflow').text or ''
        result_dict[portal_type] = workflow
      self._workflow_chain_archive = result_dict
1949 1950 1951
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1952
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1953

1954 1955 1956
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

1957
  def build(self, context, **kw):
1958 1959 1960 1961 1962
    # 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
1963
    p = context.getPortalObject()
1964
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1965
    for key in self._archive.keys():
1966 1967 1968
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1969
        workflow = wflist[1]
1970
      else:
1971
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1972
        portal_type = wflist[0][:-2]
1973
        workflow = ''
1974 1975 1976 1977 1978
      portal_type_key = '%s%s' % (self._chain_string_prefix, portal_type)
      if portal_type_key in chain_dict:
        workflow_name = workflow.lstrip('+-=')
        if workflow[0] != '-' and workflow_name not in \
           chain_dict[portal_type_key].split(self._chain_string_separator):
1979
          if not self.is_bt_for_diff:
1980 1981 1982
            # here, we use 'LOG' instead of 'raise', because it can
            # happen when a workflow is removed from the chain by
            # another business template.
Jérome Perrin's avatar
Jérome Perrin committed
1983
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
1984
                       'in chain for portal_type %s' % (workflow_name, portal_type))
1985
        self._objects.setdefault(portal_type, []).append(workflow)
1986
      elif not self.is_bt_for_diff:
1987
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1988
                        'is probably a sign of a missing dependency.'\
1989
                                                    % portal_type
1990

Christophe Dumez's avatar
Christophe Dumez committed
1991
  # Function to generate XML Code Manually
1992 1993
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
1994 1995 1996
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
1997
      workflow_list = self._objects[key]
1998 1999
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
2000 2001
      xml_data += '\n  <workflow>%s</workflow>' %(
        self._chain_string_separator.join(sorted(workflow_list)))
2002 2003
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
2004 2005 2006
    return xml_data

  def export(self, context, bta, **kw):
2007
    if not self._objects:
2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019
      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
2020
    (default_chain, chain_dict) = getChainByType(context)
2021
    # First convert all workflow_ids into list.
2022 2023
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
2024
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
2025
    # best solution, by default it is 'default_workflow', which is
2026 2027
    # not very usefull
    default_chain = ''
2028 2029
    for path in self._objects:
      if path in update_dict or force:
2030 2031 2032
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2033
            continue
Jérome Perrin's avatar
Jérome Perrin committed
2034 2035
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
2036
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
2037
          continue
2038
        portal_type = path_splitted[-1]
2039 2040
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
2041
          # XXX we don't use the chain (Default) in erp5 so don't keep it
2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
          old_chain_list = [workflow_id for workflow_id in\
                            chain_dict[chain_key] if workflow_id not in\
                            ('(Default)', '',)]
          old_chain_workflow_id_set = set(old_chain_list)
          # get new workflow id list
          workflow_id_list = self._objects[path]
          for wf_id in workflow_id_list:
            if wf_id[0] == '-':
              # remove wf id if already present
              if wf_id[1:] in old_chain_workflow_id_set:
                old_chain_workflow_id_set.remove(wf_id[1:])
            elif wf_id[0] == '=':
              # replace existing chain by this one
              old_chain_workflow_id_set = set()
              old_chain_workflow_id_set.add(wf_id[1:])
            # then either '+' or nothing, add wf id to the list
            elif wf_id[0] == '+':
              old_chain_workflow_id_set.add(wf_id[1:])
            else:
              old_chain_workflow_id_set.add(wf_id)
2062
            # create the new chain
2063 2064
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
2065 2066
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
2067
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
2068 2069 2070
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
2071
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
2072
        else:
2073
          if context.portal_types.getTypeInfo(portal_type) is None:
2074
            raise ValueError('Cannot chain workflow %r to non existing '
2075 2076 2077 2078 2079
                           'portal type %r' % (self._chain_string_separator\
                                                     .join(self._objects[path])
                                               , portal_type))
          chain_dict[chain_key] = self._objects[path]
    # convert workflow list into string only at the end.
2080 2081
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
2082 2083
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2084

2085 2086
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
2087 2088
    object_path = kw.get('object_path', None)
    if object_path is not None:
2089
      object_key_list = [object_path]
2090
    else:
2091 2092 2093
      object_key_list = self._objects.keys()
    for object_key in object_key_list:
      path_splitted = object_key.split('/', 1)
2094 2095 2096
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
2097 2098 2099 2100 2101 2102 2103 2104 2105 2106
      path = '%s%s' % (self._chain_string_prefix, portal_type)
      if path in chain_dict:
        workflow_id_list = chain_dict[path].\
                                            split(self._chain_string_separator)
        removed_workflow_id_list = self._objects[object_key]
        for workflow_id in removed_workflow_id_list:
          for i in range(workflow_id_list.count(workflow_id)):
            workflow_id_list.remove(workflow_id)
        if not workflow_id_list:
          del chain_dict[path]
2107
        else:
2108 2109 2110 2111
          chain_dict[path] = self._chain_string_separator.\
                                                  join(workflow_id_list)
    context.getPortalObject().portal_workflow.\
                                   manage_changeWorkflows('', props=chain_dict)
2112

2113
  def preinstall(self, context, installed_item, **kw):
2114 2115
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2116
      new_key_list = self._objects.keys()
2117 2118
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
2119
      for key, value in installed_item._objects.iteritems():
2120 2121
        if not 'portal_type_workflow_chain/' in key:
          key = 'portal_type_workflow_chain/%s' % (key)
2122
        new_dict[key] = value
2123
      if new_dict:
2124
        installed_item._objects = new_dict
2125 2126
      for path in new_key_list:
        if path in installed_item._objects:
2127 2128
          # compare object to see it there is changes
          new_object = self._objects[path]
2129
          old_object = installed_item._objects[path]
2130 2131 2132 2133 2134 2135
          if isinstance(new_object, str):
            new_object = new_object.split(self._chain_string_separator)
          if isinstance(old_object, str):
            old_object = old_object.split(self._chain_string_separator)
          new_object.sort()
          old_object.sort()
2136
          if new_object != old_object:
2137
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2138
        else: # new object
2139
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2140
      # get removed object
2141 2142 2143
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2144 2145
    return modified_object_list

2146
  def _importFile(self, file_name, file):
2147
    if not file_name.endswith('.xml'):
2148
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2149
      return
2150
    # import workflow chain for portal_type
2151
    result_dict = {}
2152
    xml = parse(file)
2153
    chain_list = xml.findall('chain')
2154
    for chain in chain_list:
2155
      portal_type = chain.find('type').text
2156
      workflow_chain = chain.find('workflow').text or ''
2157
      if 'portal_type_workflow_chain/' not in portal_type:
2158 2159 2160 2161
        key = 'portal_type_workflow_chain/%s' % (portal_type,)
      else:
        key = portal_type
      result_dict[key] = workflow_chain.split(self._chain_string_separator)
2162
    self._objects = result_dict
2163

2164 2165
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2166

2167
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
2168 2169 2170
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
2171 2172
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
2173
  business_template_class_property = '_portal_type_allowed_content_type_item'
2174 2175

  def build(self, context, **kw):
2176
    types_tool = getToolByName(self.getPortalObject(), 'portal_types')
2177
    for key in self._archive.keys():
2178 2179 2180 2181
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
2182
      ob = types_tool.getTypeInfo(portal_type)
2183
      # check properties corresponds to what is defined in site
2184
      if ob is None:
2185 2186
        raise ValueError, "Portal Type %s not found in site" %(portal_type,)
      prop_value = getattr(ob, self.class_property, ())
2187 2188 2189 2190 2191 2192 2193
      if allowed_type in prop_value:
        if self.class_property not in portal_type:
          key = '%s/%s' % (self.class_property, portal_type)
        else:
          key = portal_type
        self._objects.setdefault(key, []).append(allowed_type)
      elif not self.is_bt_for_diff:
Jérome Perrin's avatar
Jérome Perrin committed
2194
        raise ValueError, "%s %s not found in portal type %s" % (
2195 2196
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)
2197

Christophe Dumez's avatar
Christophe Dumez committed
2198
  # Function to generate XML Code Manually
2199 2200
  def generateXml(self, path=None):
    xml_data = '<%s>' %(self.xml_tag,)
2201 2202 2203
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2204
      id_value = key.replace('%s/' % self.class_property, '')
2205
      allowed_item_list = sorted(self._objects[key])
2206
      xml_data += '\n <portal_type id="%s">' % (id_value)
2207
      for allowed_item in allowed_item_list:
2208 2209 2210
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
2211 2212 2213
    return xml_data

  def export(self, context, bta, **kw):
2214
    if not self._objects:
2215 2216 2217
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
2218
    path = os.sep.join((self.__class__.__name__, self.class_property,))
2219 2220 2221
    xml_data = self.generateXml(path=None)
    bta.addObject(obj=xml_data, name=path, path=None)

2222
  def preinstall(self, context, installed_item, **kw):
2223 2224 2225
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
2226
      new_key_list = self._objects.keys()
2227 2228
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
Nicolas Delaby's avatar
Nicolas Delaby committed
2229
      for key, value in installed_item._objects.iteritems():
2230
        if self.class_property not in key:
2231
          key = '%s/%s' % (self.class_property, key)
Nicolas Delaby's avatar
Nicolas Delaby committed
2232
        new_dict[key] = value
2233
      if new_dict:
2234
        installed_item._objects = new_dict
2235 2236
      for path in new_key_list:
        if path in installed_item._objects:
2237 2238
          # compare object to see it there is changes
          new_object = self._objects[path]
2239
          old_object = installed_item._objects[path]
2240 2241
          new_object.sort()
          old_object.sort()
2242
          if new_object != old_object:
2243
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2244
        else: # new object
2245
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2246
      # get removed object
2247 2248 2249
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2250 2251
    return modified_object_list

2252
  def _importFile(self, file_name, file):
2253
    if not file_name.endswith('.xml'):
2254
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2255
      return
2256
    path, name = posixpath.split(file_name)
2257
    xml = parse(file)
2258
    portal_type_list = xml.findall('portal_type')
2259
    for portal_type in portal_type_list:
2260 2261
      id = portal_type.get('id')
      item_type_list = [item.text for item in portal_type.findall('item')]
Nicolas Delaby's avatar
typo  
Nicolas Delaby committed
2262
      if self.class_property not in id:
2263 2264 2265 2266
        key = '%s/%s' % (self.class_property, id,)
      else:
        key = id
      self._objects[key] = item_type_list
2267 2268

  def install(self, context, trashbin, **kw):
Nicolas Delaby's avatar
Nicolas Delaby committed
2269 2270
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2271 2272
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2273 2274 2275 2276 2277 2278 2279
    installed_bt = kw.get('installed_bt')
    if installed_bt is not None:
      old_objects = getattr(installed_bt,
                            self.business_template_class_property)._objects
    else:
      old_objects = {}
    for key in set(self._objects.keys()).union(set(old_objects.keys())):
Nicolas Delaby's avatar
Nicolas Delaby committed
2280
      if key in update_dict or force:
2281 2282 2283 2284
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2285 2286 2287
        portal_id = key.split('/')[-1]
        type_information = types_tool.getTypeInfo(portal_id)
        if type_information is None:
2288 2289
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2290 2291
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
2292
        object_property_list = getattr(type_information, self.class_property, ())
Nicolas Delaby's avatar
Nicolas Delaby committed
2293 2294 2295 2296 2297 2298 2299 2300 2301
        # merge differences between portal types properties
        # for example:
        # * current value : [A,B,C]
        # * in new BT : [A,D]
        # * in old BT : [A,B]
        # -> [A,D,C] i.e. C is merged but B is not merged
        for id in object_property_list:
          if id not in property_list and id not in old_property_list:
            property_list.append(id)
2302
        setattr(type_information, self.class_property, tuple(property_list))
2303

Aurel's avatar
Aurel committed
2304
  def uninstall(self, context, **kw):
2305
    object_path = kw.get('object_path', None)
Nicolas Delaby's avatar
Nicolas Delaby committed
2306 2307
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2308
    if object_path is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
2309
      object_key_list = [object_path]
2310
    else:
Nicolas Delaby's avatar
Nicolas Delaby committed
2311 2312
      object_key_list = self._objects.keys()
    for key in object_key_list:
2313 2314 2315 2316 2317
      portal_id = key.split('/')[-1]
      type_information = types_tool.getTypeInfo(portal_id)
      if type_information is None:
        LOG("BusinessTemplate", WARNING,
            "Portal type %r not found while uninstalling" % (portal_id,))
2318 2319
        continue
      property_list = self._objects[key]
2320
      original_property_list = list(getattr(type_information,
2321
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2322 2323
      for id in property_list:
        if id in original_property_list:
2324
          original_property_list.remove(id)
2325
      setattr(type_information, self.class_property, tuple(original_property_list))
2326

2327

2328 2329
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2330
  name = 'Hidden Content Type'
2331 2332
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2333
  business_template_class_property = '_portal_type_hidden_content_type_item'
2334

2335

2336 2337
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2338
  name = 'Property Sheet'
2339 2340
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2341
  business_template_class_property = '_portal_type_property_sheet_item'
2342

2343

2344 2345
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2346
  name = 'Base Category'
2347 2348
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2349
  business_template_class_property = '_portal_type_base_category_item'
2350

2351

2352
class CatalogMethodTemplateItem(ObjectTemplateItem):
2353
  """Template Item for catalog methods.
2354

2355 2356 2357 2358 2359
    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.
  """
2360

2361 2362
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2363
    # a mapping to store properties of methods.
2364 2365 2366 2367 2368
    # 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()
2369

2370
    self._is_filtered_archive = PersistentMapping()
2371 2372
    for method in catalog_method_filter_list:
      setattr(self, method, PersistentMapping())
2373

2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387
  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

2388 2389
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2390

2391
    catalog = _getCatalogValue(self)
2392
    if catalog is None:
2393
      LOG('BusinessTemplate build', 0, 'catalog not found')
2394
      return
2395

2396 2397 2398
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2399

2400 2401
    for obj in self._objects.values():
      method_id = obj.id
2402 2403
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2404 2405 2406 2407 2408 2409
      filter = catalog.filter_dict.get(method_id, {})
      self._is_filtered_archive[method_id] = filter.get('filtered', 0)
      for method in catalog_method_filter_list:
        property = method[8:-8]
        if property in filter:
          getattr(self, method)[method_id] = filter[property]
2410

2411 2412 2413 2414 2415
  def generateXml(self, path):
    obj = self._objects[path]
    method_id = obj.id
    xml_data = '<catalog_method>'
    if self._method_properties.has_key(method_id):
2416
      for method_property, value in self._method_properties[method_id].items():
2417 2418 2419
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2420

2421
      if self._is_filtered_archive.get(method_id):
2422 2423 2424
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2425 2426
          for method in catalog_method_filter_list:
            if method != '_filter_expression_instance_archive':
2427 2428
              value = getattr(self, method, {}).get(method_id)
              if isinstance(value, basestring):
2429 2430 2431
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2432
              elif value:
2433
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2434
                for item in value:
2435 2436
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2437
    xml_data += '\n</catalog_method>\n'
Christophe Dumez's avatar
Christophe Dumez committed
2438
    return xml_data
2439

2440 2441 2442
  def preinstall(self, context, installed_item, **kw):
    modified_object_dict = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
    modified_object_dict.update(BaseTemplateItem.preinstall(self, context, installed_item, **kw))
2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468
    return modified_object_dict

  def export(self, context, bta, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
      obj = self._objects[key]
      # create folder and subfolders
      folders, id = posixpath.split(key)
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
      # add all datas specific to catalog inside one file
      key_name = os.path.join(obj.id+'.catalog_keys')
      xml_data = self.generateXml(key)
      bta.addObject(obj=xml_data, name=key_name, path=path)

2469 2470
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2471
    catalog = _getCatalogValue(self)
2472 2473 2474 2475 2476 2477 2478
    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)
2479

2480 2481 2482
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2483
    new_bt_format = context.getTemplateFormatVersion()
2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499

    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':
2500
              continue
2501 2502 2503 2504
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2505

2506 2507
    for obj in values:
      method_id = obj.id
2508

2509 2510 2511 2512 2513 2514
      # 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)
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2515
          elif isinstance(old_value, (list, tuple)):
2516 2517 2518 2519
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2520

2521 2522
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2523
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2524
        if context.getTemplateFormatVersion() == 1:
2525 2526 2527 2528 2529
          if expression and expression.strip():
            # only compile non-empty expressions
            expr_instance = Expression(expression)
          else:
            expr_instance = None
2530 2531
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2532 2533 2534
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2535
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2536 2537 2538 2539
        catalog.filter_dict[method_id]['expression_cache_key'] = \
          self._filter_expression_cache_key_archive.get(method_id, ())
        catalog.filter_dict[method_id]['type'] = \
          self._filter_type_archive.get(method_id, ())
2540
      elif method_id in catalog.filter_dict.keys():
2541
        catalog.filter_dict[method_id]['filtered'] = 0
2542

2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568
      # 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)
2569

2570 2571 2572 2573 2574 2575
        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)
2576

2577
  def uninstall(self, context, **kw):
2578
    catalog = _getCatalogValue(self)
2579 2580 2581
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2582

2583 2584 2585 2586
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2587 2588 2589 2590
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2591
    else:
2592
      try:
2593 2594 2595 2596
        if context.getTemplateFormatVersion() == 1:
          value = self._objects[object_path]
        else:
          value = self._archive[object_path]
2597 2598
      except KeyError:
        value = None
2599 2600
      if value is not None:
        values.append(value)
2601
    for obj in values:
2602
      method_id = obj.id
2603 2604 2605 2606 2607 2608 2609 2610 2611
      # 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)
2612

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2613
      if catalog.filter_dict.has_key(method_id):
2614
        del catalog.filter_dict[method_id]
2615

2616
    # uninstall objects
2617
    ObjectTemplateItem.uninstall(self, context, **kw)
2618

2619
  def _importFile(self, file_name, file):
2620
    if file_name.endswith('.catalog_keys.xml'):
2621
      # recreate data mapping specific to catalog method
2622 2623
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2624
      xml = parse(file)
2625
      method_list = xml.findall('item')
2626
      for method in method_list:
2627 2628 2629
        key = method.get('key')
        key_type = method.get('type')
        value_node = method.find('value')
2630
        if key_type == "str":
2631
          value = value_node.text or ''
2632
        elif key_type == "int":
2633
          value = int(value_node.text)
2634
        elif key_type == "tuple":
2635
          value = tuple([value_node.text for value_node in method.findall('value')])
2636
        else:
2637
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2638
          continue
2639
        if key in catalog_method_list or key in catalog_method_filter_list:
2640
          getattr(self, key)[id] = value
2641 2642 2643
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2644 2645 2646 2647 2648 2649 2650 2651
    elif file_name.endswith('.xml'):
      # just import xml object
      obj = self
      connection = None
      while connection is None:
        obj=obj.aq_parent
        connection=obj._p_jar
      obj = connection.importFile(file, customImporters=customImporters)
2652
      self.removeProperties(obj, 0)
2653 2654 2655
      self._objects[file_name[:-4]] = obj
    else:
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2656

2657
class ActionTemplateItem(ObjectTemplateItem):
2658 2659

  def __init__(self, id_list, **kw):
2660
    # XXX It's look like ObjectTemplateItem __init__
2661 2662 2663 2664 2665 2666
    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

2667 2668
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2669
      Split path tries to split a complex path such as:
2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687

      "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

2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720
  def _getPortalTypeActionCopy(self, obj, value):
    id_id = 'reference'
    for action in obj.getActionInformationList():
      if getattr(action, id_id, None) == value:
        return obj._exportOldAction(action)

  def _getPortalToolActionCopy(self, obj, context, value):
    try:
      from Products.CMFCore.interfaces import IActionProvider
    except ImportError:
      # BACK:
      # we still don't load ZCML on tests on 2.8, but on 2.8 actions from other
      # tools are not redirected to portal_actions
      pass
    else:
      if not IActionProvider.providedBy(obj):
        # look for the action in portal_actions, instead of the original object
        LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
            'Redirected action export',
            'Attempted to retrieve action %r from %r which is no longer an '
            'IActionProvided. Retrieving action from portal_actions instead' %
            (value, obj.getId()))
        obj = context.getPortalObject().portal_actions
    id_id = 'id'
    for action in obj.listActions():
      if getattr(action, id_id, None) == value:
        return action._getCopy(context)

  def _getActionCopy(self, obj, context, value):
    """
    Gets action copy from action provider given the action id or reference
    """
    # Several tools still use CMF actions
2721
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2722 2723 2724 2725
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2726 2727 2728 2729
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2730 2731 2732
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2733
      # normalize url
2734 2735 2736 2737 2738
      url = p.portal_url.getRelativeContentPath(obj)
      if len(url) == 1:
        # global actions are stored under 'portal_types', mostly for
        # compatibility
        url = 'portal_types', url[0]
2739 2740
      action = self._getActionCopy(obj, context, value)
      if action is None:
2741 2742 2743
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2744
      key = posixpath.join(url[-2], url[-1], value)
2745
      self._objects[key] = self.removeProperties(action, 1)
2746
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2747

2748 2749 2750
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2751
    if context.getTemplateFormatVersion() == 1:
2752
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2753 2754
      p = context.getPortalObject()
      for id in self._objects.keys():
2755 2756 2757 2758 2759
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2760 2761 2762
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2763

2764
          if interfaces.ITypeProvider.providedBy(aq_parent(aq_inner(container))):
2765 2766 2767
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2768 2769
            continue

Julien Muchembled's avatar
Julien Muchembled committed
2770 2771
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2772 2773 2774
          try:
            from Products.CMFCore.interfaces import IActionProvider
          except ImportError:
2775
              # BACK:
2776 2777 2778 2779 2780 2781 2782 2783
              # we still don't load ZCML on tests on 2.8, but on 2.8 we don't
              # need to redirect actions to portal_actions.
              pass
          else:
            if not IActionProvider.providedBy(container):
              # some tools stopped being ActionProviders in CMF 2.x. Drop the
              # action into portal_actions.
              LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
2784
                  'Redirected action import',
2785 2786 2787 2788
                  'Attempted to store action %r in %r which is no longer an '
                  'IActionProvided. Storing action on portal_actions instead' %
                  (id, path))
              container = p.portal_actions
2789
          obj, action = container, obj
2790
          action_list = obj.listActions()
2791
          for index in range(len(action_list)):
2792
            if action_list[index].id == id:
2793
              # remove previous action
2794
              obj.deleteActions(selections=(index,))
2795 2796 2797
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2798
          obj.addAction(
2799
                        id = action.id
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2800
                      , name = action.title
2801
                      , action = action_text
2802 2803 2804 2805
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2806 2807
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2808
                      , priority = action.priority
2809
                      , description = action.description
Aurel's avatar
Aurel committed
2810
                    )
2811
          # sort action based on the priority define on it
2812 2813 2814 2815 2816 2817 2818 2819 2820
          # 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))
2821 2822
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2823
        container.manage_delObjects([obj.id
2824
          for obj in container.getActionInformationList()
2825
          if obj.getReference() in action_dict])
2826 2827
        for obj in action_dict.itervalues():
          container._importOldAction(obj)
Aurel's avatar
Aurel committed
2828
    else:
2829
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2830
      p = context.getPortalObject()
2831 2832
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2833
        relative_url, key, value = self._splitPath(id)
2834 2835
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2836
          if getattr(ai, key) == value:
2837
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2838 2839 2840
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2841
        obj.addAction(
Aurel's avatar
Aurel committed
2842 2843
                      id = action.id
                    , name = action.title
2844
                    , action = action_text
Aurel's avatar
Aurel committed
2845 2846 2847 2848
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2849 2850
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2851
                    )
Aurel's avatar
Aurel committed
2852 2853 2854 2855 2856 2857 2858
        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))
2859 2860
          obj.moveDownActions(selections=tuple(move_down_list))

2861 2862
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2863 2864
    object_path = kw.get("object_path", None)
    if object_path is not None:
2865 2866 2867 2868 2869 2870 2871 2872
      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]
2873
    else:
2874
      keys = self._archive.keys()
2875
    for id in keys:
2876 2877
      if  '|' in id:
        relative_url, value = id.split(' | ')
2878 2879 2880
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
2881
          is_new_action = interfaces.ITypeProvider.providedBy(obj.getParentValue())
2882
          key = is_new_action and 'reference' or 'id'
2883
      else:
2884
        relative_url, key, value = self._splitPath(id)
2885
        obj = p.unrestrictedTraverse(relative_url, None)
2886 2887 2888
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2889
          if getattr(action_list[index], key, None) == value:
2890 2891
            obj.deleteActions(selections=(index,))
            break
2892 2893
      LOG('BusinessTemplate', WARNING,
          'Unable to uninstall action at %s, ignoring' % relative_url )
2894 2895
    BaseTemplateItem.uninstall(self, context, **kw)

2896 2897 2898
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2899
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2900 2901 2902 2903 2904 2905 2906
    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])
2907 2908
      # normalize url
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])
2909
      self._objects[relative_url] = type_role_list = []
2910
      for role in obj.getRoleInformationList():
2911
        type_role_dict = {}
2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928
        for k, v in aq_base(role).__getstate__().iteritems():
          if k == 'condition':
            if not v:
              continue
            v = v.text
          elif k in ('role_base_category', 'role_category'):
            k = k[5:]
          elif k == 'role_name':
            k, v = 'id', '; '.join(v)
          elif k not in ('title', 'description'):
            k = {'id': 'object_id', # for stable sort
                 'role_base_category': 'base_category',
                 'role_base_category_script_id': 'base_category_script',
                 'role_category': 'category'}.get(k)
            if not k:
              continue
          type_role_dict[k] = v
2929
        type_role_list.append(type_role_dict)
2930
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2931

Christophe Dumez's avatar
Christophe Dumez committed
2932
  # Function to generate XML Code Manually
2933 2934 2935 2936
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2937
      xml_data += "\n  <role id='%s'>" % role['id']
2938
      # uniq
2939
      for property in ('title', 'description', 'condition',
2940 2941 2942
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2943 2944
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2945
          xml_data += "\n   <property id='%s'>%s</property>" % \
2946 2947 2948
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2949
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2950 2951
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2952
          xml_data += "\n   <multi_property "\
2953
          "id='%s'>%s</multi_property>" % (property, prop_value)
2954 2955
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2956
    return xml_data
2957

2958 2959 2960 2961 2962 2963 2964
  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)
2965 2966
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2967 2968 2969 2970
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
2971 2972 2973
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2974 2975
    type_roles_list = []
    xml = parse(file)
2976
    xml_type_roles_list = xml.findall('role')
2977
    for role in xml_type_roles_list:
2978 2979 2980 2981
      id = role.get('id')
      if isinstance(id, unicode):
        id = id.encode('utf_8', 'backslashreplace')
      type_role_property_dict = {'id': id}
2982
      # uniq
2983 2984 2985 2986 2987 2988 2989 2990
      property_list = role.findall('property')
      for property_node in property_list:
        property_id = property_node.get('id')
        if property_node.text:
          value = property_node.text
          if isinstance(value, unicode):
            value = value.encode('utf_8', 'backslashreplace')
          type_role_property_dict[property_id] = value
2991
      # multi
2992 2993 2994 2995 2996 2997 2998 2999
      multi_property_list = role.findall('multi_property')
      for property_node in multi_property_list:
        property_id = property_node.get('id')
        if property_node.text:
          value = property_node.text
          if isinstance(value, unicode):
            value = value.encode('utf_8', 'backslashreplace')
          type_role_property_dict.setdefault(property_id, []).append(value)
3000
      type_roles_list.append(type_role_property_dict)
3001
    self._objects['portal_type_roles/%s' % (file_name[:-4],)] = type_roles_list
3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012

  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
3013 3014 3015
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
3016
          # reset roles before applying
3017
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
3018
          type_roles_list = self._objects[roles_path] or []
3019 3020
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
3021 3022 3023
        else:
          raise AttributeError("Path '%r' not found while "
                               "installing roles" % (path, ))
3024 3025 3026

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
3027 3028 3029 3030 3031 3032
    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:
3033
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
3034 3035 3036 3037 3038
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
3039

3040 3041 3042 3043 3044 3045
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
3046 3047
      for property in p.propertyMap():
        if property['id'] == id:
3048
          obj = p.getProperty(id)
3049
          prop_type = property['type']
3050 3051
          break
      else:
3052
        obj = None
3053
      if obj is None and not self.is_bt_for_diff:
3054
        raise NotFound, 'the property %s is not found' % id
3055
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
3056

3057 3058
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
3059
    if not file_name.endswith('.xml'):
3060
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3061
      return
3062
    xml = parse(file)
3063 3064 3065 3066 3067 3068 3069 3070 3071
    property_node = xml.getroot()[0]
    property_id = property_node.find('id').text
    prop_type = property_node.find('type').text
    value_node = property_node.find('value')
    if prop_type in ('lines', 'tokens'):
      value = [item.text for item in value_node.findall('item')]
    else:
      value = value_node.text
    self._objects[property_id] = (prop_type, value)
3072

3073 3074 3075
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3076
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3077 3078
      p = context.getPortalObject()
      for path in self._objects.keys():
3079 3080 3081 3082
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
3083
              continue
3084
          dir, id = posixpath.split(path)
3085
          prop_type, property = self._objects[path]
3086 3087 3088 3089 3090 3091 3092 3093
          if p.hasProperty(id):
            if p.getPropertyType(id) != prop_type:
              p._delProperty(id)
              p._setProperty(id, property, type=prop_type)
            else:
              p._updateProperty(id, property)
          else:
            p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
3094
    else:
3095
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
3096
      p = context.getPortalObject()
3097
      for id, property in self._archive.keys():
3098
        property = self._archive[id]
Aurel's avatar
Aurel committed
3099
        if p.hasProperty(id):
3100 3101 3102 3103 3104 3105 3106
          if p.getPropertyType(id) != property['type']:
            p._delProperty(id)
            p._setProperty(id, property['value'], type=property['type'])
          else:
            p._updateProperty(id, property['value'])
        else:
          p._setProperty(id, property['value'], type=property['type'])
3107 3108 3109

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3110 3111 3112 3113 3114 3115
    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:
3116 3117 3118 3119
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3120
  # Function to generate XML Code Manually
3121
  def generateXml(self, path=None):
3122
    xml_data = ''
3123
    prop_type, obj = self._objects[path]
3124
    xml_data += '\n <property>'
3125 3126
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
3127
    if prop_type in ('lines', 'tokens'):
3128
      xml_data += '\n  <value>'
3129
      for item in obj:
3130
        if item != '':
3131
          xml_data += '\n   <item>%s</item>' % escape(str(item))
3132
      xml_data += '\n  </value>'
3133
    else:
3134
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
3135
    xml_data += '\n </property>'
3136 3137
    return xml_data

Aurel's avatar
Aurel committed
3138 3139 3140 3141 3142
  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)
3143 3144 3145 3146
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
3147
      xml_data += self.generateXml(path)
3148
    xml_data += '\n</site_property>'
3149
    bta.addObject(obj=xml_data, name='properties', path=root_path)
3150

3151 3152 3153 3154 3155
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3156 3157 3158 3159 3160 3161
    for module_id in self._archive.keys():
      module = p.unrestrictedTraverse(module_id)
      mapping = {}
      mapping['id'] = module.getId()
      mapping['title'] = module.getTitle()
      mapping['portal_type'] = module.getPortalType()
3162
      permission_list = []
3163
      mapping['permission_list'] = module.showPermissions()
3164
      mapping['category_list'] = module.getCategoryList()
3165
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3166

Christophe Dumez's avatar
Christophe Dumez committed
3167
  # Function to generate XML Code Manually
3168
  def generateXml(self, path=None):
3169
    mapping = self._objects[path]
3170
    xml_data = ['<module>']
3171
    keys = mapping.keys()
3172 3173
    for key in sorted(keys):
      if key == 'permission_list':
3174
        # separe permission dict into xml
3175
        xml_data.append(' <%s>' % (key, ))
3176
        permission_list = mapping[key]
3177
        for perm in permission_list:
3178
          # the type of the permission defined if we use acquired or not
3179
          if isinstance(perm[1], list):
3180 3181 3182
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
3183
          role_list = list(perm[1])
3184 3185 3186
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
3187
          if (len(role_list) == 0 and ptype == 'list') or \
3188 3189
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
3190
          role_list.sort()
3191 3192
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
3193
          for role in role_list:
3194 3195 3196
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
3197 3198 3199 3200 3201 3202 3203 3204
      elif key == 'category_list':
        category_list = mapping[key]
        if not category_list:
          continue
        xml_data.append(' <%s>' % (key, ))
        for category in category_list:
          xml_data.append('  <category>%s</category>' % (category, ))
        xml_data.append(' </%s>' % (key, ))
3205
      else:
3206
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
3207 3208
    xml_data.append('</module>')
    return '\n'.join(xml_data)
3209

3210
  def export(self, context, bta, **kw):
3211
    if len(self._objects) == 0:
3212 3213 3214
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
3215 3216
    keys = self._objects.keys()
    keys.sort()
3217
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
3218
      # export modules one by one
3219 3220
      xml_data = self.generateXml(path=key)
      bta.addObject(obj=xml_data, name=key, path=path)
3221

3222
  def install(self, context, trashbin, **kw):
3223
    portal = context.getPortalObject()
3224 3225
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3226
    if context.getTemplateFormatVersion() == 1:
3227
      items = self._objects
3228
    else:
3229 3230
      items = self._archive

3231 3232
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
3233 3234
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
3235
        if not force:
3236
          action = update_dict[path]
3237 3238
          if action == 'nothing':
            continue
3239 3240
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
3241
        module = portal._getOb(module_id, None)
3242 3243
        if module is not None:
          module.portal_type = portal_type
3244
        else:
3245
          module = portal.newContent(id=module_id, portal_type=portal_type)
3246
        module.setTitle(str(mapping['title']))
3247 3248
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
3249
          # By default, Manager only without acquire permission
3250 3251
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
3252
          module.manage_permission(name, roles=role_list, acquire=acquire)
3253 3254
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
3255 3256

  def _importFile(self, file_name, file):
3257 3258 3259
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3260
    mapping = {}
3261
    xml = parse(file)
3262
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3263
      key_node = xml.find(key)
3264
      if key == 'permission_list':
3265 3266 3267 3268 3269 3270 3271
        permission_list = []
        for permission in key_node:
          permission_type = permission.get('type', None)
          name = permission.find('name').text
          role_list = [role.text for role in permission.findall('role')]
          if permission_type in ('list', None):
            perm_tuple = (name, list(role_list))
3272
          else:
3273 3274 3275
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3276
      else:
3277
        mapping[key] = key_node.text or ''
3278 3279

    category_list = []
3280 3281 3282 3283
    category_list_node = xml.find('category_list')
    if category_list_node is not None:
      category_list.extend(node.text for node\
                            in category_list_node.findall('category'))
3284 3285
    mapping['category_list'] = category_list

3286
    self._objects[file_name[:-4]] = mapping
3287

3288
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3289 3290 3291
    trash = kw.get('trash', 0)
    if trash:
      return
3292 3293 3294 3295 3296 3297
    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]
3298 3299
    p = context.getPortalObject()
    id_list = p.objectIds()
3300 3301
    for key in keys:
      if key in id_list:
3302
        try:
3303
          if trash and trashbin is not None:
3304
            container_path = key.split('/')
3305 3306
            self.portal_trash.backupObject(trashbin, container_path, 
                                           key, save=1, keep_subobjects=1)
3307
          p.manage_delObjects([key])
3308
        except NotFound:
3309
          pass
3310 3311
    BaseTemplateItem.uninstall(self, context, **kw)

3312 3313 3314
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3315 3316

class DocumentTemplateItem(BaseTemplateItem):
3317 3318 3319 3320
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3321 3322 3323

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
3324 3325
    for key in self._archive.iterkeys():
      self._objects[key] = self.local_file_reader_name(key)
Aurel's avatar
Aurel committed
3326

3327
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3328 3329
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3330
      new_keys = self._objects.keys()
3331
      # fix key if necessary in installed bt for diff
3332
      extra_prefix = self.__class__.__name__ + '/'
3333
      for key in installed_item._objects.keys():
3334 3335 3336 3337
        if key.startswith(extra_prefix):
          new_key = key[len(extra_prefix):]
          installed_item._objects[new_key] = installed_item._objects[key]
          del installed_item._objects[key]
3338
      for path in new_keys:
3339
        if installed_item._objects.has_key(path):
3340 3341
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3342
          old_obj_code = installed_item._objects[path]
3343
          if new_obj_code != old_obj_code:
3344 3345
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3346
        else: # new object
3347 3348
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3349
          # get removed object
3350
      old_keys = installed_item._objects.keys()
3351 3352
      for path in old_keys:
        if path not in new_keys:
3353 3354
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3355 3356
    return modified_object_list

3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371
  def _resetDynamicModules(self):
    # before any import, flush all ZODB caches to force a DB reload
    # otherwise we could have objects trying to get commited while
    # holding reference to a class that is no longer the same one as
    # the class in its import location and pickle doesn't tolerate it.
    # First we do a savepoint to dump dirty objects to temporary
    # storage, so that all references to them can be freed.
    transaction.savepoint(optimistic=True)
    # Then we need to flush from all caches, not only the one from this
    # connection
    portal = self.getPortalObject()
    portal._p_jar.db().cacheMinimize()
    synchronizeDynamicModules(portal, force=True)
    gc.collect()

3372 3373 3374
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3375
    if context.getTemplateFormatVersion() == 1:
3376
      need_reset = isinstance(self, DocumentTemplateItem)
Aurel's avatar
Aurel committed
3377
      for id in self._objects.keys():
3378 3379 3380 3381 3382 3383
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
3384
          path, name = posixpath.split(id)
3385
          try:
3386
            self.local_file_writer_name(name, text, create=0)
3387
          except IOError, error:
3388 3389
            LOG(self.__class__.__name__, WARNING,
                "Cannot install class %r on file system" % name)
3390
            if error.errno:
3391
              raise
3392
            continue
3393 3394 3395
          if self.local_file_importer_name is None:
            continue
          if need_reset:
3396
            self._resetDynamicModules()
3397 3398
            need_reset = False
          self.local_file_importer_name(name)
Aurel's avatar
Aurel committed
3399
    else:
3400 3401 3402
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3403
        # This raises an exception if the file exists.
3404
        self.local_file_writer_name(id, text, create=1)
Aurel's avatar
Aurel committed
3405
        if self.local_file_importer_name is not None:
3406
          self.local_file_importer_name(id)
3407 3408

  def uninstall(self, context, **kw):
3409
    object_path = kw.get('object_path', None)
3410 3411 3412 3413
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
3414 3415 3416 3417 3418
    if object_keys:
      if isinstance(self, DocumentTemplateItem):
        self._resetDynamicModules()
      for key in object_keys:
        self.local_file_remover_name(key)
3419 3420
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3421 3422 3423 3424 3425
  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)
3426 3427 3428 3429 3430 3431 3432
    extra_prefix = self.__class__.__name__ + '/'
    for key in self._objects.keys():
      obj = self._objects[key]
      # BBB the prefix was put into each key in the previous implementation.
      if not key.startswith(extra_prefix):
        key = extra_prefix + key
      bta.addObject(obj=obj, name=key, ext='.py')
Aurel's avatar
Aurel committed
3433

3434
  def _importFile(self, file_name, file):
3435 3436 3437
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3438
    text = file.read()
3439
    self._objects[file_name[:-3]] = text
3440

3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465
class PropertySheetTemplateItem(DocumentTemplateItem,
                                ObjectTemplateItem):
  """
  Property Sheets are now stored in ZODB, rather than the filesystem.
  However, Some Business Template may still have filesystem Property
  Sheets, which need to be migrated to the ZODB.

  This migration is performed in two steps:

  1/ Specify explicitly in the web user interface that the Property
     Sheets should be migrated.

  2/ The Property Sheets will all be migrated when installing the
     Business Template.

  Therefore, this is an all or nothing migration, meaning that only
  methods of DocumentTemplateItem will be called before the migration
  has been performed, then ObjectTemplateItem methods afterwards.
  """
  # If set to False, then the migration of Property Sheets will never
  # be performed, required until the code of ZODB Property Sheets is
  # stable and completely documented
  _perform_migration = False

  # Only meaningful for filesystem Property Sheets
3466 3467 3468 3469
  local_file_reader_name = staticmethod(readLocalPropertySheet)
  local_file_writer_name = staticmethod(writeLocalPropertySheet)
  local_file_importer_name = staticmethod(importLocalPropertySheet)
  local_file_remover_name = staticmethod(removeLocalPropertySheet)
3470

3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 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 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655
  def __init__(self, id_list, tool_id='portal_property_sheets', **kw):
    BaseTemplateItem.__init__(self, id_list, **kw)

  @staticmethod
  def _is_already_migrated(object_key_list):
    """
    The Property Sheets have already been migrated if any keys within
    the given object_key_list (either '_objects.keys()' or
    '_archive.keys()') contains a key starting by 'portal_property_sheets/'
    """
    return len(object_key_list) != 0 and \
        object_key_list[0].startswith('portal_property_sheets/')

  def _filesystemCompatibilityWrapper(method_name, object_dict_name):
    """
    Call ObjectTemplateItem method when the Property Sheets have
    already been migrated, otherwise fallback on DocumentTemplateItem
    method for backward-compatibility
    """
    def inner(self, *args, **kw):
      if self._is_already_migrated(getattr(self, object_dict_name).keys()):
        return getattr(ObjectTemplateItem, method_name)(self, *args, **kw)
      else:
        return getattr(DocumentTemplateItem, method_name)(self, *args, **kw)

    return inner

  export = _filesystemCompatibilityWrapper('export', '_objects')
  build = _filesystemCompatibilityWrapper('build', '_archive')
  preinstall = _filesystemCompatibilityWrapper('preinstall', '_objects')

  def _importFile(self, file_name, *args, **kw):
    if file_name.endswith('.xml'):
      return ObjectTemplateItem._importFile(self, file_name, *args, **kw)
    else:
      return DocumentTemplateItem._importFile(self, file_name, *args, **kw)

  def uninstall(self, *args, **kw):
    # Only for uninstall, the path of objects can be given as a
    # parameter, otherwise it fallbacks on '_archive'
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()

    if self._is_already_migrated(object_keys):
      return ObjectTemplateItem.uninstall(self, *args, **kw)
    else:
      return DocumentTemplateItem.uninstall(self, *args, **kw)

  @staticmethod
  def _getFilesystemPropertySheetPath(class_id):
    """
    From the given class identifier, return the complete path of the
    filesystem Property Sheet class. Only meaningful when the Business
    Template has already been installed previously, otherwise the
    """
    from App.config import getConfiguration
    return os.path.join(getConfiguration().instancehome,
                        "PropertySheet",
                        "%s.py" % class_id)

  @staticmethod
  def _migrateFilesystemPropertySheet(property_sheet_tool,
                                      filesystem_property_sheet_path,
                                      filesystem_property_sheet_file,
                                      class_id):
    """
    Migration of a filesystem Property Sheet involves loading the
    class from 'instancehome/PropertySheet/<class_id>', then create
    the ZODB Property Sheets in portal_property_sheets from its
    filesystem definition
    """
    # The first parameter of 'load_source' is the module name where
    # the class will be stored, thus don't only use the class name as
    # it may clash with already loaded module, such as
    # BusinessTemplate.
    module = imp.load_source(
      'Migrate%sFilesystemPropertySheet' % class_id,
      filesystem_property_sheet_path,
      filesystem_property_sheet_file)

    try:
      klass = getattr(module, class_id)
    except AttributeError:
      raise AttributeError("filesystem Property Sheet '%s' should " \
                           "contain a class with the same name" % \
                           class_id)

    return property_sheet_tool.createPropertySheetFromFilesystemClass(klass)

  def _migrateAllFilesystemPropertySheets(self,
                                          context,
                                          migrate_object_dict,
                                          object_dict,
                                          update_parameter_dict):
    """
    Migrate all Property Sheets from 'migrate_object_dict' and, if
    necessary, remove old references in 'object_dict' too (with format
    version 1 of Business Template, the former would be '_objects' and
    the latter '_archive'), and finally removing the useless Property
    Sheet on the filesystem
    """
    # Migrate all the filesystem Property Sheets of the Business
    # Template if any
    property_sheet_tool = context.getPortalObject().portal_property_sheets

    for class_id in migrate_object_dict:
      # If the Property Sheet already exists in ZODB, then skip it,
      # otherwise it should not be needed anymore once the deletion
      # code of the filesystem Property Sheets is enabled
      if class_id in property_sheet_tool:
        raise RuntimeError('Conflict when migrating Property Sheet %s: ' \
                           'already exists in portal_property_sheets' % \
                           class_id)

      filesystem_property_sheet_path = \
          self._getFilesystemPropertySheetPath(class_id)

      # A filesystem Property Sheet may already exist in the instance
      # home if the Business Template has been previously installed,
      # otherwise it is created
      if os.path.exists(filesystem_property_sheet_path):
        filesystem_property_sheet_file = open(filesystem_property_sheet_path)
      else:
        filesystem_property_sheet_file = open(filesystem_property_sheet_path,
                                              'w+')

        filesystem_property_sheet_file.write(migrate_object_dict[class_id])
        filesystem_property_sheet_file.seek(0)

      try:
        new_property_sheet = self._migrateFilesystemPropertySheet(
          property_sheet_tool,
          filesystem_property_sheet_path,
          filesystem_property_sheet_file,
          class_id)

      finally:
        filesystem_property_sheet_file.close()
        os.remove(filesystem_property_sheet_path)

      # Update 'migrate_object_dict' with the new path
      key = 'portal_property_sheets/%s' % class_id

      migrate_object_dict[key] = new_property_sheet
      del migrate_object_dict[class_id]

      # Remove old reference in 'object_dict' as it does not make
      # sense to keep it anymore
      if class_id in object_dict:
        object_dict[key] = None
        del object_dict[class_id]

      # Skip meaningless backup of the object as it has just been
      # migrated
      update_parameter_dict[key] = 'migrate'

    transaction.commit()

  def install(self, context, **kw):
    if not self._perform_migration:
      return DocumentTemplateItem.install(self, context, **kw)

    # With format 0 of Business Template, the objects are stored in
    # '_archive' whereas they are stored in '_objects' with format
    # version 1
    bt_format_version = context.getTemplateFormatVersion()

    if bt_format_version == 0 and \
       not self._is_already_migrated(self._archive.keys()):
      self._migrateAllFilesystemPropertySheets(context,
                                               self._archive,
                                               self._objects,
                                               kw.get('object_to_update'))
    elif bt_format_version == 1 and \
         not self._is_already_migrated(self._objects.keys()):
      self._migrateAllFilesystemPropertySheets(context,
                                               self._objects,
                                               self._archive,
                                               kw.get('object_to_update'))

    return ObjectTemplateItem.install(self, context, **kw)

3656
class ConstraintTemplateItem(DocumentTemplateItem):
3657 3658 3659 3660
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3661

3662
class ExtensionTemplateItem(DocumentTemplateItem):
3663 3664
  local_file_reader_name = staticmethod(readLocalExtension)
  local_file_writer_name = staticmethod(writeLocalExtension)
3665 3666
  # Extension needs no import
  local_file_importer_name = None
3667
  local_file_remover_name = staticmethod(removeLocalExtension)
3668 3669

class TestTemplateItem(DocumentTemplateItem):
3670 3671
  local_file_reader_name = staticmethod(readLocalTest)
  local_file_writer_name = staticmethod(writeLocalTest)
3672
  # Test needs no import
3673
  local_file_importer_name = None
3674
  local_file_remover_name = staticmethod(removeLocalTest)
3675

Aurel's avatar
Aurel committed
3676

3677 3678 3679
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3680 3681 3682

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3683
  def build(self, context, **kw):
3684 3685
    for key in self._archive.iterkeys():
      self._objects[key] = 1
Aurel's avatar
Aurel committed
3686

3687
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3688 3689
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3690
      new_roles = self._objects.keys()
3691 3692 3693 3694 3695 3696
      # BBB it might be necessary to change the data structure.
      obsolete_key = self.__class__.__name__ + '/role_list'
      if obsolete_key in installed_item._objects:
        for role in installed_item._objects[obsolete_key]:
          installed_item._objects[role] = 1
        del installed_item._objects[obsolete_key]
3697
      for role in new_roles:
3698
        if installed_item._objects.has_key(role):
3699 3700 3701 3702
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
3703
      old_roles = installed_item._objects.keys()
3704 3705 3706 3707 3708 3709
      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):
3710
    p = context.getPortalObject()
3711
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3712
    if context.getTemplateFormatVersion() == 1:
3713
      role_set = set(self._objects)
3714
    else:
3715
      role_set = set(self._archive)
3716 3717 3718 3719
    # 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:
3720 3721
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
3722
    # set roles on portal
3723
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
3724 3725

  def _importFile(self, file_name, file):
3726
    if not file_name.endswith('.xml'):
3727
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3728
      return
3729
    xml = parse(file)
3730 3731 3732
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744

  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)

3745 3746 3747 3748 3749 3750 3751 3752 3753
  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
3754
      if role in roles and role not in new_roles:
3755 3756 3757
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3758
  # Function to generate XML Code Manually
3759 3760
  def generateXml(self):
    role_list = self._objects.keys()
3761
    xml_data = '<role_list>'
3762 3763
    for role in sorted(role_list):
      xml_data += '\n <role>%s</role>' % (role,)
3764
    xml_data += '\n</role_list>'
3765 3766
    return xml_data

Aurel's avatar
Aurel committed
3767
  def export(self, context, bta, **kw):
3768
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
3769 3770 3771
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
3772 3773 3774 3775 3776 3777 3778 3779 3780
    # BBB it might be necessary to change the data structure.
    obsolete_key = self.__class__.__name__ + '/role_list'
    if obsolete_key in self._objects:
      for role in self._objects[obsolete_key]:
        self._objects[role] = 1
      del self._objects[obsolete_key]
    xml_data = self.generateXml()
    path = obsolete_key
    bta.addObject(obj=xml_data, name=path)
3781

3782 3783 3784 3785
class CatalogSearchKeyTemplateItem(BaseTemplateItem):
  key_list_attr = 'sql_catalog_search_keys'
  key_list_title = 'search_key_list'
  key_title = 'Search key'
3786

Aurel's avatar
Aurel committed
3787
  def build(self, context, **kw):
3788
    catalog = _getCatalogValue(self)
3789 3790 3791
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3792
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
3793
    key_list = []
3794
    for key in self._archive.keys():
3795
      if key in catalog_key_list:
3796
        key_list.append(key)
3797
      elif not self.is_bt_for_diff:
3798
        raise NotFound, '%s %r not found in catalog' %(self.key_title, key)
3799
    if len(key_list) > 0:
3800
      self._objects['%s/%s' % (self.__class__.__name__, self.key_list_title)] = key_list
3801 3802

  def _importFile(self, file_name, file):
3803 3804 3805
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3806
    xml = parse(file)
3807 3808
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3809

3810
  def install(self, context, trashbin, **kw):
3811
    catalog = _getCatalogValue(self)
3812 3813 3814
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3815

3816
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3817
    if context.getTemplateFormatVersion() == 1:
3818 3819
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3820 3821 3822
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3823
    else:
3824
      keys = self._archive.keys()
3825 3826
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3827
    # XXX same as related key
3828
    if update_dict.has_key(self.key_list_title) or force:
3829
      if not force:
3830
        action = update_dict[self.key_list_title]
3831
        if action == 'nothing':
Aurel's avatar
Aurel committed
3832
          return
3833
      for key in keys:
3834 3835 3836
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
3837

3838
  def uninstall(self, context, **kw):
3839
    catalog = _getCatalogValue(self)
3840 3841 3842
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3843
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
3844
    object_path = kw.get('object_path', None)
3845 3846 3847 3848 3849
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3850 3851 3852
      if key in catalog_key_list:
        catalog_key_list.remove(key)
    setattr(catalog, self.key_list_attr, catalog_key_list)
3853 3854
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3855
  # Function to generate XML Code Manually
3856
  def generateXml(self, path=None):
3857
    obj = self._objects[path]
3858
    xml_data = '<key_list>'
3859 3860
    obj.sort()
    for key in obj:
3861 3862
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3863 3864
    return xml_data

Aurel's avatar
Aurel committed
3865 3866 3867 3868 3869
  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)
3870
    for path in self._objects.keys():
3871
      xml_data = self.generateXml(path=path)
3872
      bta.addObject(obj=xml_data, name=path, path=None)
3873

3874 3875 3876 3877
class CatalogResultKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_result_keys'
  key_list_title = 'result_key_list'
  key_title = 'Result key'
3878

3879 3880 3881 3882
class CatalogRelatedKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_related_keys'
  key_list_title = 'related_key_list'
  key_title = 'Related key'
3883

3884
  # override this method to support 'key_list' for backward compatibility.
3885
  def install(self, context, trashbin, **kw):
3886
    catalog = _getCatalogValue(self)
3887 3888 3889
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3890

3891
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3892
    if context.getTemplateFormatVersion() == 1:
3893
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3894
        return
3895 3896 3897
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3898
    else:
3899
      keys = self._archive.keys()
3900 3901
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3902
    # XXX must a find a better way to manage related key
3903
    if update_dict.has_key(self.key_list_title) or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3904
      if not force:
3905 3906
        if update_dict.has_key(self.key_list_title):
          action = update_dict[self.key_list_title]
Aurel's avatar
Aurel committed
3907 3908
        else: # XXX for backward compatibility
          action = update_dict['key_list']
Aurel's avatar
Aurel committed
3909 3910 3911
        if action == 'nothing':
          return
      for key in keys:
3912 3913 3914
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
3915

3916 3917 3918 3919
class CatalogResultTableTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_tables'
  key_list_title = 'result_table_list'
  key_title = 'Result table'
3920

3921
# keyword
3922 3923 3924 3925
class CatalogKeywordKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_keyword_search_keys'
  key_list_title = 'keyword_key_list'
  key_title = 'Keyword key'
3926

3927
# datetime
3928 3929 3930 3931
class CatalogDateTimeKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_datetime_search_keys'
  key_list_title = 'datetime_key_list'
  key_title = 'DateTime key'
3932

3933 3934 3935 3936 3937
# full text
class CatalogFullTextKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_full_text_search_keys'
  key_list_title = 'full_text_key_list'
  key_title = 'Fulltext key'
3938

3939 3940 3941 3942 3943
# request
class CatalogRequestKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_request_keys'
  key_list_title = 'request_key_list'
  key_title = 'Request key'
3944

3945 3946 3947 3948 3949
# multivalue
class CatalogMultivalueKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_multivalue_keys'
  key_list_title = 'multivalue_key_list'
  key_title = 'Multivalue key'
3950 3951

# topic
3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970
class CatalogTopicKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_topic_search_keys'
  key_list_title = 'topic_key_list'
  key_title = 'Topic key'

class CatalogScriptableKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_scriptable_keys'
  key_list_title = 'scriptable_key_list'
  key_title = 'Scriptable key'

class CatalogRoleKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_role_keys'
  key_list_title = 'role_key_list'
  key_title = 'Role key'

class CatalogLocalRoleKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_local_role_keys'
  key_list_title = 'local_role_key_list'
  key_title = 'LocalRole key'
3971

3972 3973 3974 3975
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
3976 3977 3978
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
3979
      else: # XXX backward compatibility
3980 3981
        lang = lang_key
        catalog = 'erp5_ui'
3982
      path = posixpath.join(lang, catalog)
3983 3984
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
3985 3986 3987
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
3988

3989
  def preinstall(self, context, installed_item, **kw):
3990 3991 3992 3993
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
3994
        if installed_item._objects.has_key(path):
3995 3996
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3997
          old_obj_code = installed_item._objects[path]
3998 3999 4000 4001 4002
          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
4003
      old_keys = installed_item._objects.keys()
4004 4005 4006 4007 4008
      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

4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036
  def _splitKey(self,key):
    path = key.split('/')
    if len(path) == 1:
      lang = path[0]
      catalog = None
    elif len(path) == 2:
      lang = path[0]
      catalog = path[1]
    else:
      lang = path[-3]
      catalog = path[-2]
    return lang, catalog

  def _importCatalogLanguage(self, localizer, catalog, lang, po):
    if catalog not in localizer.objectIds():
      dispatcher = localizer.manage_addProduct['Localizer']
      dispatcher.manage_addMessageCatalog(id=catalog, 
                                          title='Message Catalog',
                                          languages=['en'])
    mc = localizer._getOb(catalog)
    if lang not in mc.get_languages():
      mc.manage_addLanguage(lang)
    mc.manage_import(lang, po)

  def install(self, context, trashbin, localizer=None, **kw):
    if localizer is None:
      localizer = context.getPortalObject().Localizer
    update_dict = kw.get('object_to_update', {})
4037 4038
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
4039 4040
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4041
          if not force:
4042
            action = update_dict[key]
4043
            if action == 'nothing':
4044
              continue
4045
          lang, catalog = self._splitKey(key)
4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061

          if catalog is None:
            name = self._objects[key]
            for lang_dict in localizer.get_all_languages():
              if lang_dict['code'] == lang:
                # When the Localizer has the language as a user-defined
                # language, make sure that the name is updated.
                old_name = localizer.get_user_defined_language_name(lang)
                if old_name is not None and old_name != name:
                  localizer._del_user_defined_language(lang)
                  localizer._add_user_defined_language(name, lang)
                break
            else:
              # if the Localizer does not know the language code, it must be
              # defined as a user-defined language.
              localizer._add_user_defined_language(name, lang)
4062 4063
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4064 4065 4066 4067
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4068
            self._importCatalogLanguage(localizer, catalog, lang, po)
4069 4070
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4071
      for lang, catalogs in self._archive.iteritems():
4072 4073 4074
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104
          self._importCatalogLanguage(catalog, lang, po)

  def uninstall(self, context, remove_translations=False, **kw):
    if not remove_translations:
      return
    portal = context.getPortalObject()
    localizer = portal.Localizer
    from Products.Localizer.Localizer import Localizer
    fake_localizer = Localizer('Fake Localizer',
                               languages=['en']).__of__(portal)
    # roundabout way of keeping BW compatibility, allow install() to do the
    # heavy lifting so we can extract the original catalogs and messages:
    self.install(context, None, localizer=fake_localizer, force=True, **kw)
    # now scan the actual message_catalog to remove messages present in the
    # fake one.
    for fake_message_catalog in fake_localizer.objectValues():
      message_catalog = localizer._getOb(fake_message_catalog.getId())
      # get list of messages present in both the fake and the real catalog
      # UGH! direct attribute access... but there is no real API to access
      # all messages here.
      messages = set(fake_message_catalog._messages.keys())
      messages.intersection_update(message_catalog._messages.keys())
      for message in messages:
        # delete translations from the real catalog that are present in the
        # fake one
        fake_translations = fake_message_catalog.get_translations(message)
        translations = message_catalog.get_translations(message)
        for lang in fake_translations.keys():
          # XXX: should we check they're still the same before removing?
          translations.pop(lang, None)
4105 4106

  def export(self, context, bta, **kw):
4107
    if len(self._objects) == 0:
4108 4109 4110
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
4111
    for key, obj in self._objects.iteritems():
4112 4113
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
4114 4115 4116 4117 4118 4119 4120 4121
      if '/' in key:
        bta.addObject(obj, os.path.join(path, 'translation'), ext='.po')
      else:
        xml_data = ['<language>']
        xml_data.append(' <code>%s</code>' % (escape(key), ))
        xml_data.append(' <name>%s</name>' % (escape(obj), ))
        xml_data.append('</language>')
        bta.addObject('\n'.join(xml_data), os.path.join(path, 'language'))
4122 4123

  def _importFile(self, file_name, file):
4124 4125
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4126 4127
      text = file.read()
      self._objects[file_name[:-3]] = text
4128 4129
    elif name == 'language.xml':
      xml = parse(file)
4130 4131
      name = xml.find('name').text
      code = xml.find('code').text
4132
      self._objects[code] = name
4133

Aurel's avatar
Aurel committed
4134 4135
class LocalRolesTemplateItem(BaseTemplateItem):

4136
  def __init__(self, id_list, **kw):
4137
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4138 4139
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4140 4141 4142
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4143
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4144 4145
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4146
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4147

Christophe Dumez's avatar
Christophe Dumez committed
4148
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4149
  def generateXml(self, path=None):
4150
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4151 4152
    # local roles
    xml_data = '<local_roles_item>'
4153
    xml_data += '\n <local_roles>'
4154
    for key in sorted(local_roles_dict):
4155
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4156 4157
      tuple = local_roles_dict[key]
      for item in tuple:
4158 4159 4160 4161
        xml_data += "\n   <item>%s</item>" %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </local_roles>'
    xml_data += '\n</local_roles_item>'
Aurel's avatar
Aurel committed
4162
    return xml_data
4163

Aurel's avatar
Aurel committed
4164 4165 4166 4167 4168 4169 4170 4171
  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)

4172
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4173
      encode_folders = []
4174
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4175
        if '%' not in folder:
4176
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4177 4178
        else:
          encode_folders.append(folder)
4179
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4180 4181 4182 4183
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
4184 4185 4186
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4187 4188
    xml = parse(file)
    # local roles
4189
    local_roles_list = xml.findall('//role')
Aurel's avatar
Aurel committed
4190 4191
    local_roles_dict = {}
    for role in local_roles_list:
4192 4193
      id = role.get('id')
      item_type_list = [item.text for item in role]
Aurel's avatar
Aurel committed
4194
      local_roles_dict[id] = item_type_list
4195
    self._objects['local_roles/%s' % (file_name[:-4],)] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206

  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
4207 4208
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4209
        local_roles_dict = self._objects[roles_path][0]
4210
        setattr(obj, '__ac_local_roles__', local_roles_dict)
4211
        obj.reindexObject()
Aurel's avatar
Aurel committed
4212

4213
  def uninstall(self, context, object_path=None, **kw):
Aurel's avatar
Aurel committed
4214
    p = context.getPortalObject()
4215 4216 4217 4218 4219
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
Aurel's avatar
Aurel committed
4220 4221 4222
      path = roles_path.split('/')[1:]
      obj = p.unrestrictedTraverse(path)
      setattr(obj, '__ac_local_roles__', {})
4223
      obj.reindexObject()
4224

4225 4226 4227
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4228
    in part or completely. Each object is separated from its
4229 4230 4231 4232 4233 4234 4235 4236 4237 4238
    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
4239 4240
      - object without optimal actions
      - list of relation between portal type and workflow
4241 4242 4243 4244 4245 4246 4247 4248 4249 4250

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

    - site property definition
      - id
      - type
4251
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4252

4253 4254
    - document/propertysheet/extension/test definition
      - copy of the local file
4255

4256
    - message transalation definition
4257
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4258

4259 4260
    The Business Template properties are exported to the bt folder with
    one property per file
4261

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4262 4263
    Technology:

4264 4265
    - 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
4266

4267
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4268 4269 4270 4271

    Use case:

    - install core ERP5 (the minimum)
4272

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

4275 4276
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4277
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4278 4279 4280 4281 4282
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4283
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4284 4285 4286

    # Declarative security
    security = ClassSecurityInfo()
4287
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4288 4289 4290 4291

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4292
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4293
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4294
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4295
                      , PropertySheet.BusinessTemplate
4296
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4297 4298
                      )

4299 4300 4301 4302 4303 4304
    # 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."""
4305
         , 'icon'           : 'file_icon.gif'
4306 4307 4308 4309 4310 4311 4312 4313 4314
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4315 4316
    # This is a global variable
    # Order is important for installation
4317 4318 4319
    # We want to have:
    #  * path after module, because path can be module content
    #  * path after categories, because path can be categories content
4320 4321
    #  * path before workflow chain, because path can be a portal type
    #         (until chains are set on portal types with categories)
4322 4323 4324
    #  * skin after paths, because we can install a custom connection string as
    #       path and use it with SQLMethods in a skin.
    #    ( and more )
4325 4326
    _item_name_list = [
      '_product_item',
4327
      '_property_sheet_item',
4328
      '_constraint_item',
4329 4330 4331 4332
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4333
      '_tool_item',
4334 4335 4336 4337
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4338
      #'_portal_type_workflow_chain_item',
4339 4340 4341 4342
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4343 4344
      '_category_item',
      '_module_item',
4345
      '_path_item',
4346
      '_skin_item',
4347
      '_registered_skin_selection_item',
4348
      '_preference_item',
4349
      '_action_item',
4350
      '_portal_type_roles_item',
4351
      '_local_roles_item',
4352
      '_portal_type_workflow_chain_item',
4353
      '_catalog_method_item',
4354 4355 4356
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4357
      '_catalog_search_key_item',
4358
      '_catalog_keyword_key_item',
4359
      '_catalog_datetime_key_item',
4360 4361 4362 4363
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4364
      '_catalog_scriptable_key_item',
4365 4366
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4367 4368 4369 4370
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4371 4372 4373 4374 4375 4376
      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
4377
        self._baseGetTemplateFormatVersion()
4378

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4379 4380 4381
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4382

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4383
      return 0
4384

4385
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4386 4387 4388 4389 4390 4391 4392
    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".
4393 4394
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4395
          # XXX Not good to access the attribute directly,
4396 4397 4398
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4399

4400 4401
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4402 4403 4404 4405 4406 4407
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4408
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4409 4410 4411 4412 4413 4414 4415 4416
        """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)
4417

4418 4419
    security.declareProtected(Permissions.ManagePortal, 'storeTemplateItemData')
    def storeTemplateItemData(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4420
      """
4421
        Instanciate and Store Template items into properties.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4422
      """
4423
      # Store all Data
4424 4425
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4426
      self._portal_type_workflow_chain_item = \
4427
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4428 4429 4430 4431
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4432 4433 4434
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4435 4436 4437 4438 4439 4440
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4441
      self._portal_type_roles_item = \
4442
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4443 4444 4445 4446 4447 4448 4449 4450
      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())
4451 4452
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472
      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())
4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484
      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())
4485 4486
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4487 4488
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4489 4490 4491
      self._catalog_search_key_item = \
          CatalogSearchKeyTemplateItem(
               self.getTemplateCatalogSearchKeyList())
4492 4493
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4494
               self.getTemplateCatalogKeywordKeyList())
4495 4496 4497
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4498 4499
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4500
               self.getTemplateCatalogFullTextKeyList())
4501 4502
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4503
               self.getTemplateCatalogRequestKeyList())
4504 4505
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4506
               self.getTemplateCatalogMultivalueKeyList())
4507 4508 4509
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4510 4511
      self._local_roles_item = \
          LocalRolesTemplateItem(
4512
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4513 4514 4515
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4516 4517 4518
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4519 4520 4521 4522 4523 4524
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4525

4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539
    security.declareProtected(Permissions.ManagePortal, 'build')
    def build(self, no_action=0):
      """
        Copy existing portal objects to self
      """
      if no_action: return
        # this is use at import of Business Template to get the status built
      # Make sure that everything is sane.
      self.clean()

      self.updateRevisionNumber()
      self._setTemplateFormatVersion(1)
      self.storeTemplateItemData()

4540 4541
      # Build each part
      for item_name in self._item_name_list:
4542 4543 4544 4545
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4546

4547
    build = WorkflowMethod(build)
4548 4549

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4550
      """
4551
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4552
      """
4553
      return self.portal_templates.publish(self, url, username=username,
4554
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4555

4556
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4557
      """
4558
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4559
      """
4560
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4561

4562 4563 4564 4565 4566
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4567 4568 4569 4570 4571 4572 4573 4574 4575 4576
      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
4577 4578
      return False

4579
    def preinstall(self, check_dependencies=1, **kw):
4580 4581 4582
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4583
      """
4584 4585 4586 4587 4588
      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()
4589

4590 4591
      modified_object_list = {}
      bt_title = self.getTitle()
4592 4593 4594 4595 4596 4597 4598

      #  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)
4599 4600 4601
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4602
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4603

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4621
      new_bt_format = self.getTemplateFormatVersion()
4622 4623 4624 4625 4626 4627
      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:
4628
          item = getattr(self, item_name, None)
4629 4630 4631 4632
          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
4633

4634
      for item_name in self._item_name_list:
4635
        new_item = getattr(self, item_name, None)
4636
        installed_item = getattr(installed_bt, item_name, None)
4637
        if new_item is not None:
4638
          if installed_item is not None and hasattr(installed_item, '_objects'):
4639
            modified_object = new_item.preinstall(context=self, 
4640 4641
                                                  installed_item=installed_item,
                                                  installed_bt=installed_bt)
4642 4643 4644 4645 4646 4647 4648
            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:
4649
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
4650

4651 4652
      return modified_object_list

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

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

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

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

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

4686 4687 4688
      from Products.ERP5.ERP5Site import ERP5Generator
      generator_class = getattr(site, '_generator_class', ERP5Generator)
      gen = generator_class()
4689 4690
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
4691 4692 4693 4694 4695 4696
        if not site.hasObject('portal_activities'):
          create_activities = True
          LOG('Business Template', 0, 'Updating Activity Tool')
        else:
          create_activities = False
        gen.setupLastTools(site, update=1, create_activities=create_activities)
4697 4698
      if not force:
        if len(object_to_update) == 0:
4699 4700 4701 4702 4703
          # check if we have to update tools
          if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
            LOG('Business Template', 0, 'Updating Tools')
            gen.setup(site, 0, update=1)
          if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4704
            LOG('Business Template', 0, 'Updating Business Template Workflows')
4705
            gen.setupWorkflow(site)
4706
          return
4707

4708 4709
      # always created a trash bin because we may to save object already present
      # but not in a previous business templates apart at creation of a new site
4710
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
4711 4712 4713 4714 4715
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

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

4723
      # update catalog if necessary
4724 4725 4726
      if update_catalog is _MARKER and force and self.isCatalogUpdatable():
        # override update_catalog parameter only if value
        # is not explicitely passed.
4727
        update_catalog = 1
4728
      elif update_catalog is _MARKER:
4729
        update_catalog = 0
4730
      if update_catalog:
4731
        catalog = _getCatalogValue(self)
4732
        if (catalog is None) or (not site.isIndexable):
4733 4734 4735 4736 4737
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4738

4739
      # get objects to remove
4740
      # do remove after because we may need backup object from installation
4741
      remove_object_dict = {}
4742 4743
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
4744
          remove_object_dict[path] = action
4745

4746
      # remove object from old business template
4747
      if len(remove_object_dict):
4748
        # XXX: this code assumes that there is an installed_bt
4749
        for item_name in reversed(installed_bt._item_name_list):
4750
          item = getattr(installed_bt, item_name, None)
4751
          if item is not None:
4752
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
4753

4754 4755 4756 4757 4758 4759

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

4760
      # check if we have to update business template workflow
4761
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4762
        LOG('Business Template', 0, 'Updating Business Template Workflows')
4763 4764 4765 4766 4767
        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)

4768 4769
      # remove trashbin if empty
      if trashbin is not None:
4770
        if len(trashbin) == 0:
4771 4772
          trash_tool.manage_delObjects([trashbin.getId(),])

4773 4774
      if update_catalog:
        site.ERP5Site_reindexAll()
4775

4776 4777
      # Update translation table, in case we added new portal types or
      # workflow states.
4778 4779
      if update_translation:
        site.ERP5Site_updateTranslationTable()
4780

4781 4782
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
4783

4784
    security.declareProtected(Permissions.ManagePortal, 'install')
4785 4786 4787
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4788
      """
4789
      return self._install(**kw)
4790

4791
    install = WorkflowMethod(install)
4792

4793
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4794
    def reinstall(self, **kw):
4795 4796 4797 4798
      """Reinstall Business Template.
      """
      return self._install(**kw)

4799
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4800

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

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

4832 4833
    uninstall = WorkflowMethod(uninstall)

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

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

4857
    security.declareProtected(Permissions.AccessContentsInformation,
4858
                              'getBuildingState')
4859
    def getBuildingState(self, default=None, id_only=1):
4860
      """
4861
        Returns the current state in building
4862
      """
4863
      portal_workflow = getToolByName(self, 'portal_workflow')
4864 4865
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4866
      return wf._getWorkflowStateOf(self, id_only=id_only )
4867

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

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

4891
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4892
      """
4893 4894
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4895
      """
4896 4897
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
4898 4899 4900 4901
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4902
        # XXX Why do we need to return a tuple ?
4903 4904
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4905

4906
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4907
      """
4908 4909
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4910
      """
4911
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4912

4913
    def getTemplateBaseCategoryList(self):
4914
      """
4915 4916
      We have to set this method because we want an
      ordered list
4917
      """
4918
      return self._getOrderedList('template_base_category')
4919

4920
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4921
      """
4922 4923
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4924
      """
4925
      return self._getOrderedList('template_workflow_id')
4926

4927
    def getTemplatePortalTypeIdList(self):
4928
      """
4929 4930
      We have to set this method because we want an
      ordered list
4931
      """
4932
      return self._getOrderedList('template_portal_type_id')
4933

4934 4935 4936 4937 4938 4939 4940
    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
4941 4942 4943 4944 4945 4946 4947
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

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

4955 4956 4957 4958 4959 4960
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4961

4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982
    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')

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

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

4997
    def getTemplateLocalRoleList(self):
4998 4999 5000 5001
      """
      We have to set this method because we want an
      ordered list
      """
5002
      return self._getOrderedList('template_local_role')
5003

5004
    def getTemplateSkinIdList(self):
5005
      """
5006 5007
      We have to set this method because we want an
      ordered list
5008
      """
5009
      return self._getOrderedList('template_skin_id')
5010

5011 5012 5013 5014 5015 5016 5017
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

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

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

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

5039
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5040 5041 5042 5043
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5044
      if self.getBuildingState() != 'built':
5045
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5046
              'Business Template must be built before export'
5047

Aurel's avatar
Aurel committed
5048 5049 5050 5051 5052 5053 5054
      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)

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

Aurel's avatar
Aurel committed
5072 5073 5074
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5075

5076
      return bta.finishCreation(self.getTitle())
Aurel's avatar
Aurel committed
5077

5078
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5079 5080
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5081
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5082 5083 5084 5085 5086
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
5087 5088

      self.storeTemplateItemData()
5089

5090 5091
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5092 5093
      # XXX This is not required with portal types as classes.
      #     It is still there for compatibility with non-migrated objects.
5094
      module_id_list = []
5095
      for template_id in self.getTemplateDocumentIdList():
5096 5097 5098
        module_id = 'Products.ERP5Type.Document.' + template_id
        if module_id not in sys.modules:
          module_id_list.append(module_id)
5099
          sys.modules[module_id] = module = imp.new_module(module_id)
5100 5101
          setattr(module, template_id, type(template_id,
            (SimpleItem.SimpleItem,), {'__module__': module_id}))
5102

Aurel's avatar
Aurel committed
5103 5104
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5105

5106 5107
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5108 5109
      for module_id in module_id_list:
        del sys.modules[module_id]
5110

5111 5112 5113 5114 5115
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5116 5117 5118
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5119
      return items_list
5120

5121 5122 5123 5124 5125 5126 5127 5128 5129 5130
    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:
5131
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5132
          dependency = dependency_couple_list[0]
5133 5134
          if dependency in (None, ''):
            continue
5135 5136
          version_restriction = None
          if len(dependency_couple_list) > 1:
5137
            version_restriction = dependency_couple_list[1]
5138 5139 5140
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5141 5142 5143
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5144
                  or (version_restriction not in (None, '') and
5145 5146 5147 5148
                     (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)
5149

5150 5151 5152 5153 5154 5155 5156 5157
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
        This is compatible with ERP5Subversion look and feel but
        it is preferred in future we use more difflib python library.
      """
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

Aurel's avatar
Aurel committed
5158
    def diffObject(self, REQUEST, **kw):
5159 5160
      """
        Make a diff between an object in the Business Template
5161
        and the same in the Business Template installed in the site
5162 5163 5164 5165
      """

      class_name_dict = {
        'Product' : '_product_item',
5166
        'PropertySheet' : '_property_sheet_item',
5167
        'Constraint' : '_constraint_item',
5168 5169 5170 5171 5172 5173 5174 5175 5176
        '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',
5177
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5178 5179 5180 5181
        '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',
5182 5183 5184
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5185
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5186
        'Path' : '_path_item',
5187
        'Preference' : '_preference_item',
5188
        'Action' : '_action_item',
5189
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5190
        'LocalRoles' : '_local_roles_item',
5191 5192 5193
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5194
        'CatalogSearchKey' : '_catalog_search_key_item',
5195
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5196
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5197 5198 5199 5200
        '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
5201
        'Tool': '_tool_item',
5202
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5203 5204
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5205
        }
5206

5207 5208
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5209

Christophe Dumez's avatar
Christophe Dumez committed
5210
      # Get objects
5211
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5212

5213
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
5214
      # Compare with a given business template
5215
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5216 5217
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5218 5219
        if bt2_id == self.getId():
          compare_to_zodb = 1
5220
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5221 5222
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5223 5224 5225
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5226 5227
          compare_to_zodb = 1
      if compare_to_zodb:
5228 5229
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5230
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5231 5232 5233
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5234

5235 5236
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5237
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5238
        # XXX maybe only build for the given object to gain time
5239
        installed_item.build(self)
5240 5241 5242
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5243

Christophe Dumez's avatar
Christophe Dumez committed
5244
      # Real Zope Objects (can be exported into XML directly by Zope)
5245 5246
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5247
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5248
                     '_skin_item', '_action_item', '_tool_item', ]
5249

Christophe Dumez's avatar
Christophe Dumez committed
5250
      # Not considered as objects by Zope (will be exported into XML manually)
5251
      # XXX Bad naming
5252 5253 5254 5255
      item_list_2 = ['_site_property_item',
                     '_module_item',
                     '_catalog_result_key_item', 
                     '_catalog_related_key_item',
5256
                     '_catalog_result_table_item',
5257
                     '_catalog_search_key_item',
5258
                     '_catalog_keyword_key_item',
5259
                     '_catalog_datetime_key_item',
5260 5261 5262 5263
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5264
                     '_catalog_scriptable_key_item',
5265 5266
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5267 5268 5269 5270 5271 5272
                     '_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',
5273
                     '_portal_type_workflow_chain_item',]
5274

Christophe Dumez's avatar
Christophe Dumez committed
5275
      # Text objects (no need to export them into XML)
5276
      # XXX Bad naming
5277 5278
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5279
                     '_test_item', '_message_translation_item',]
5280

5281
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5282 5283 5284
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5285 5286
        new_object = new_item.removeProperties(new_object, 1)
        installed_object = installed_item.removeProperties(installed_object, 1)
5287
        # XML Export in memory
5288
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5289 5290
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5291
        new_obj_xml = f1.getvalue()
5292
        f1.close()
5293 5294 5295 5296
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5297
        # End of XML export
5298

5299
        # Diff between XML objects
5300 5301
        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
5302
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5303 5304 5305
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5306

5307
      elif item_name in item_list_2:
5308
        # Generate XML code manually
5309 5310
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5311 5312
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5313
        # End of XML Code Generation
5314

5315
        # Diff between XML objects
5316 5317
        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
5318
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5319 5320 5321
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5322

5323
      elif item_name in item_list_3:
5324
        # Diff between text objects
5325 5326 5327 5328
        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
5329
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5330 5331
          diff_msg += '\n'.join(diff_list)
        else:
5332
          diff_msg = 'No diff'
5333

5334
      else:
5335
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5336

5337
      if compare_to_zodb:
5338
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5339

5340
      return diff_msg
5341

5342

5343 5344 5345 5346
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5347 5348
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5349 5350 5351 5352 5353 5354 5355
      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 [])
5356 5357
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5358
      p = self.getPortalObject()
5359
      for id in bt_portal_types_id_list:
5360 5361
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5362
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5363
        if portal_type.getRoleInformationList():
5364 5365
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5366

5367 5368 5369 5370
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5371
        action_list = []
5372 5373 5374 5375 5376 5377 5378
        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'):
5379
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5380 5381
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5382

5383 5384 5385 5386
        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)
5387

5388
        for h_id in hidden_content_type_list:
5389 5390 5391
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5392

5393 5394 5395 5396
        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)
5397

5398 5399 5400 5401
        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)
5402

5403 5404 5405 5406
        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)
5407

5408
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5409
                                    if chain != '(Default)']:
5410 5411 5412
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5413

5414 5415 5416 5417
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5418
      bt_action_list.sort()
5419
      bt_wf_chain_list.sort()
5420

5421 5422 5423 5424 5425 5426 5427
      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)
5428 5429 5430 5431 5432 5433 5434 5435 5436
      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:
5437 5438
        raise TemplateConditionError, 'No module defined in business template'

5439 5440 5441 5442 5443 5444 5445 5446
      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:
5447
          return type_list
5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461

        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():
5462
            type_list.update(getChildPortalType(hidden_ptype_id))
5463
        return type_list
5464

5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511
      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

5512 5513 5514
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5515
  setattr(BusinessTemplate, key, None)
5516

5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543
# 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)
5544

5545 5546 5547 5548 5549 5550 5551 5552

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

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