BusinessTemplate.py 220 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
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 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
  def migrateToPortalTypeClass(self, obj):
    klass = obj.__class__
    if klass.__module__ == 'erp5.portal_type':
      return obj
    portal_type = getattr(aq_base(obj), 'portal_type', None)
    if portal_type is None:
      portal_type = getattr(klass, 'portal_type', None)

    if portal_type is None:
      # ugh?
      return obj
    import erp5.portal_type
    newklass = getattr(erp5.portal_type, portal_type)
    assert klass != newklass
    obj.__class__ = newklass
    return obj

566
  def removeProperties(self, obj, export):
567 568
    """
    Remove unneeded properties for export
569
    """
570
    obj._p_activate()
571 572
    klass = obj.__class__
    classname = klass.__name__
573

574 575
    attr_set = set(('_dav_writelocks', '_filepath', '_owner', 'uid',
                    'workflow_history', '__ac_local_roles__'))
576
    if export:
577 578
      # PythonScript covers both Zope Python scripts
      # and ERP5 Python Scripts
579
      if isinstance(obj, PythonScript):
580
        attr_set.update(('func_code', 'func_defaults', '_code',
581
                         '_lazy_compilation', 'Python_magic'))
582 583 584
        for attr in 'errors', 'warnings', '_proxy_roles':
          if not obj.__dict__.get(attr, 1):
            delattr(obj, attr)
585 586
      elif classname == 'SQL' and klass.__module__== 'Products.ZSQLMethods.SQL':
        attr_set.update(('_arg', 'template'))
587
      elif interfaces.IIdGenerator.providedBy(obj):
Nicolas Dumazet's avatar
Nicolas Dumazet committed
588
        attr_set.update(('last_max_id_dict', 'last_id_dict'))
589 590
    else:
      obj = self.migrateToPortalTypeClass(obj)
591

592 593
    for attr in obj.__dict__.keys():
      if attr in attr_set or attr.startswith('_cache_cookie_'):
594 595
        delattr(obj, attr)

596
    if classname == 'PDFForm':
597
      if not obj.getProperty('business_template_include_content', 1):
598
        obj.deletePdfContent()
599 600
    return obj

601 602 603 604 605 606 607 608 609
  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]

610
  def restrictedResolveValue(self, context=None, path='', default=_MARKER):
611 612 613 614
    """
      Get the value with checking the security.
      This method does not acquire the parent.
    """
615 616
    return self.unrestrictedResolveValue(context, path, default=default,
                                         restricted=1)
617

618 619
  def unrestrictedResolveValue(self, context=None, path='', default=_MARKER,
                               restricted=0):
620 621 622 623 624 625 626 627 628 629 630
    """
      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:
631
        portal = aq_inner(self.getPortalObject())
632 633 634 635
        container = portal
      else:
        container = context

636 637 638 639
      if restricted:
        validate = getSecurityManager().validate

      while stack:
640
        key = stack.pop()
641 642 643 644 645 646 647 648
        try:
          value = container[key]
        except KeyError:
          LOG('BusinessTemplate', WARNING, 
              'Could not access object %s' % (path,))
          if default is _MARKER:
            raise
          return default
649

650 651 652 653 654 655 656 657 658 659 660 661
        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
662

663 664 665
      return value
    else:
      return context
666

667 668 669
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
670
  """
671

672 673 674 675
  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()
676
      self._archive.clear()
677 678 679
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
680

681
  def export(self, context, bta, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
682 683 684 685
    """
      Export the business template : fill the BusinessTemplateArchive with
      objects exported as XML, hierarchicaly organised.
    """
686 687 688
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
Vincent Pelletier's avatar
Vincent Pelletier committed
689
    for key, obj in self._objects.iteritems():
690
      # create folder and subfolders
691
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
692 693 694
      encode_folders = []
      for folder in folders.split('/'):
        if '%' not in folder:
695
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
696 697 698
        else:
          encode_folders.append(folder)
      path = os.path.join(root_path, (os.sep).join(encode_folders))
699 700
      bta.addFolder(name=path)
      # export object in xml
701
      f = StringIO()
702 703
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
704

Aurel's avatar
Aurel committed
705
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
706
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
707 708
    p = context.getPortalObject()
    for id in id_list:
709
      relative_url = '/'.join([url,id])
710 711
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
712
      obj = self.removeProperties(obj, 1)
Vincent Pelletier's avatar
Vincent Pelletier committed
713 714 715
      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
716
        groups = deepcopy(obj.groups)
717
      if id_list:
Aurel's avatar
Aurel committed
718
        self.build_sub_objects(context, id_list, relative_url)
719
        for id_ in list(id_list):
720
          obj._delObject(id_)
721
      if hasattr(aq_base(obj), 'groups'):
722 723 724
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
725

726 727 728 729
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
730 731 732 733
      try:
        obj = p.unrestrictedTraverse(relative_url)
      except ValueError:
        raise ValueError, "Can not access to %s" % relative_url
734 735 736 737
      try:
        obj = obj._getCopy(context)
      except AttributeError:
        raise AttributeError, "Could not find object '%s' during business template processing." % relative_url
738
      _recursiveRemoveUid(obj)
739
      obj = self.removeProperties(obj, 1)
740
      id_list = obj.objectIds()
Vincent Pelletier's avatar
Vincent Pelletier committed
741 742
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
743
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
744 745
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
746
        for id_ in list(id_list):
747
          obj._delObject(id_)
748
      if hasattr(aq_base(obj), 'groups'):
749 750 751
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
752

753
  def _compileXML(self, file):
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 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
    # 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
813

814
  def _importFile(self, file_name, file_obj):
815
    # import xml file
816
    if not file_name.endswith('.xml'):
817
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
818
      return
819 820 821 822 823
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
824
    __traceback_info__ = 'Importing %s' % file_name
825 826
    if hasattr(cache_database, 'db') and isinstance(file_obj, file):
      obj = connection.importFile(self._compileXML(file_obj))
827
    else:
828 829
      # FIXME: Why not use the importXML function directly? Are there any BT5s
      # with actual .zexp files on the wild?
830
      obj = connection.importFile(file_obj, customImporters=customImporters)
831 832
    self._objects[file_name[:-4]] = obj

833
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
834 835
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
836 837
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
838
      for path, obj in self._objects.iteritems():
839
        if installed_item._objects.has_key(path):
840
          upgrade_list.append((path, installed_item._objects[path]))
841
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
842
          modified_object_list[path] = 'New', type_name
843 844 845 846 847 848 849

        # if that's an old style class, use a portal type class instead
        migrateme = getattr(obj, '_migrateToPortalTypeClass', None)
        if migrateme is not None:
          migrateme()
        self._objects[path] = obj

Julien Muchembled's avatar
Julien Muchembled committed
850 851 852 853 854 855 856 857 858
      # 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()
859 860 861
        try:
          OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
          old_obj_xml = old_io.getvalue()
862 863
        except (ImportError, UnicodeDecodeError), e: # module is already
                                                     # removed etc.
864
          old_obj_xml = '(%s: %s)' % (e.__class__.__name__, e)
Julien Muchembled's avatar
Julien Muchembled committed
865 866 867
        new_io.close()
        old_io.close()
        if new_obj_xml != old_obj_xml:
868 869 870 871
          if context.isKeepObject(path):
            modified_object_list[path] = 'Modified but should be kept', type_name
          else:
            modified_object_list[path] = 'Modified', type_name
872
      # get removed object
873
      for path in set(installed_item._objects) - set(self._objects):
874 875 876 877
        if context.isKeepObject(path):
          modified_object_list[path] = 'Removed but should be kept', type_name
        else:
          modified_object_list[path] = 'Removed', type_name
878 879
    return modified_object_list

880
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
881 882 883
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
884
    subobjects_dict = {}
885
    if trashbin is None: # must return subobjects
886 887 888 889 890 891
      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)
892
        subobjects_dict[subobject_id] = subobject_copy
893
      return subobjects_dict
894
    # XXX btsave is for backward compatibility
895
    if action == 'backup' or action == 'btsave' or action == 'save_and_remove':
896 897 898
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=1, **kw)
899
    elif action == 'install':
900 901 902
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=0, **kw)
903 904 905 906
    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
907
    return subobjects_dict
908

909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
  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

925
  def onNewObject(self, obj):
926 927 928 929
    """
      Installation hook.
      Called when installation process determined that object to install is
      new on current site (it's not replacing an existing object).
930
      `obj` parameter is the newly created object in its acquisition context.
931 932 933 934
      Can be overridden by subclasses.
    """
    pass

935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
  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

952 953 954 955 956 957
  def _getObjectKeyList(self):
    # sort to add objects before their subobjects
    keys = self._objects.keys()
    keys.sort()
    return keys

958
  def install(self, context, trashbin, **kw):
959
    self.beforeInstall()
960 961
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
962
    if context.getTemplateFormatVersion() == 1:
963 964 965 966 967 968
      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):
969
        uid = getattr(aq_base(document), 'uid', None)
970 971 972 973 974 975 976 977 978 979 980 981
        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
982
      groups = {}
983
      old_groups = {}
984
      portal = context.getPortalObject()
985 986
      # set safe activities execution order
      original_reindex_parameters = self.setSafeReindexationMode(context)
987 988
      object_key_list = self._getObjectKeyList()
      for path in object_key_list:
989 990 991 992 993
        # 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

994 995
        if update_dict.has_key(path) or force:
          # get action for the oject
Yoshinori Okuji's avatar
Yoshinori Okuji committed
996
          action = 'backup'
997 998 999 1000
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
1001 1002 1003 1004
          elif context.isKeepObject(path):
            # do nothing if the object is specified in keep list in
            # force mode.
            continue
1005
          # get subobjects in path
1006 1007 1008
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
1009
          try:
1010
            container = self.unrestrictedResolveValue(portal, container_path)
1011 1012
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1013
            container_url = '/'.join(container_path)
1014 1015 1016 1017
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
1018
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
1019 1020
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
1021
              container_container = portal.unrestrictedTraverse(container_path[:-1])
1022 1023 1024 1025 1026
              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)
1027 1028
            else:
              raise
1029
          saved_uid_dict = {}
1030
          subobjects_dict = {}
Julien Muchembled's avatar
Julien Muchembled committed
1031
          portal_type_dict = {}
1032
          workflow_history = None
1033
          old_obj = container._getOb(object_id, None)
1034
          object_existed = old_obj is not None
1035
          if object_existed:
1036
            # Object already exists
1037
            recurse(saveHook, old_obj)
1038
            if getattr(aq_base(old_obj), 'groups', None) is not None:
1039 1040 1041 1042 1043
              # 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)
1044
            subobjects_dict = self._backupObject(action, trashbin,
1045
                                                 container_path, object_id)
Julien Muchembled's avatar
Julien Muchembled committed
1046
            # in case of portal types, we want to keep some properties
1047
            if interfaces.ITypeProvider.providedBy(container):
1048
              for attr in ('allowed_content_types',
Julien Muchembled's avatar
Julien Muchembled committed
1049 1050 1051 1052 1053 1054
                           '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, '')
1055 1056 1057 1058 1059
            # try to keep workflow history for specified objects.
            workflow_history = getattr(old_obj, 'workflow_history', None)
            if workflow_history is not None \
                   and context.isKeepWorkflowObject(path):
                workflow_history = deepcopy(workflow_history)
1060
            container.manage_delObjects([object_id])
1061

1062
          # install object
1063
          obj = self._objects[path]
1064 1065 1066 1067
          # 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.
1068
          if getattr(aq_base(obj), 'groups', None) is not None:
1069
            # we must keep original order groups
1070
            # because they change when we add subobjects
1071
            groups[path] = deepcopy(obj.groups)
1072
          # copy the object
1073 1074 1075 1076 1077 1078 1079
          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
1080
                'Cleaning corrupted BTreeFolder2 object at %r.' % (path,))
1081
            obj._initBTrees()
1082
          obj = obj._getCopy(container)
1083
          self.removeProperties(obj, 0)
1084 1085 1086 1087 1088
          try:
            container._setObject(object_id, obj)
          except AttributeError:
            LOG("BT, install", 0, object_id)
            raise
1089
          obj = container._getOb(object_id)
1090 1091 1092 1093 1094

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

1095 1096
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
1097
          self.REQUEST.set('is_business_template_installation', 1)
1098 1099 1100 1101
          # 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
1102
          obj.isIndexable = ConstantGetter('isIndexable', value=False)
1103
          obj.manage_afterClone(obj)
1104 1105 1106
          del obj.isIndexable
          if getattr(aq_base(obj), 'reindexObject', None) is not None:
            obj.reindexObject()
1107
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
1108
          if portal_type_dict:
1109
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
1110
            wf_chain = portal_type_dict.pop('workflow_chain')
1111 1112
            chain_dict = getChainByType(context)[1]
            default_chain = ''
1113
            chain_dict['chain_%s' % (object_id)] = wf_chain
1114
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
1115 1116
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
1117
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
1118
          if subobjects_dict:
1119
            # get a jar
1120 1121
            connection = obj._p_jar
            o = obj
1122
            while connection is None:
1123 1124
              o = o.aq_parent
              connection = o._p_jar
1125
            # import subobjects
1126
            for subobject_id, subobject_data in subobjects_dict.iteritems():
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
              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))
1138 1139 1140
          # copy workflow history if required
          if workflow_history is not None:
            setattr(obj, 'workflow_history', workflow_history)
1141
          if obj.meta_type in ('Z SQL Method',):
1142
            fixZSQLMethod(portal, obj)
1143 1144 1145
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
1146 1147 1148
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
1149
          elif obj.meta_type in ('ERP5 Ram Cache',
1150
                                 'ERP5 Distributed Ram Cache',):
1151 1152
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
1153 1154
          elif (container.meta_type == 'CMF Skins Tool') and \
              (old_obj is not None):
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
            # 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')
1169 1170 1171 1172 1173 1174 1175 1176
          # 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)
1177

1178
          recurse(restoreHook, obj)
1179
      # now put original order group
1180 1181
      # we remove object not added in forms
      # we put old objects we have kept
1182
      for path, new_groups_dict in groups.iteritems():
1183 1184 1185 1186 1187 1188 1189 1190 1191
        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
1192
          # excetp the one that had to be removed
1193 1194 1195 1196
          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'):
1197 1198
              continue
            widget_in_form = 0
1199 1200
            for group_id, group_value_list in new_groups_dict.iteritems():
              if widget_id in group_value_list:
1201 1202 1203 1204 1205 1206
                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:
1207
              for old_group_id, old_group_values in old_groups_dict.iteritems():
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
                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,]
1219
                  obj.group_list = list(obj.group_list) + ['not_assigned']
1220
          # second check all widget_id in order are in form
1221 1222
          for group_id, group_value_list in new_groups_dict.iteritems():
            for widget_id in tuple(group_value_list):
1223 1224 1225
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
1226
                group_value_list.remove(widget_id)
1227
          # now set new group object
1228
          obj.groups = new_groups_dict
1229
      # restore previous activities execution order
1230
      context.setPlacelessDefaultReindexParameters(**original_reindex_parameters)
1231
      # Do not forget to delete all remaining objects if asked by user
1232 1233 1234 1235 1236 1237
      # 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:
1238 1239
            if from_path in recursive_path_list:
              continue
1240 1241 1242 1243 1244
            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()])
1245
      fillRecursivePathList(object_key_list)
1246 1247 1248
      for recursive_path in recursive_path_list:
        if recursive_path in update_dict:
          action = update_dict[recursive_path]
1249
          if action in ('remove', 'save_and_remove'):
1250
            document = self.unrestrictedResolveValue(portal, recursive_path, None)
1251 1252 1253
            if document is None:
              # It happens if the parent of target path is removed before
              continue
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
            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
1264
    else:
1265 1266
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1267
      portal = context.getPortalObject()
1268
      for relative_url in self._archive.keys():
1269
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
1270 1271 1272 1273
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
1274
        if object_id in container_ids:    # Object already exists
1275
          self._backupObject('backup', trashbin, container_path, object_id)
1276
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
1277
        # Set a hard link
1278 1279 1280 1281 1282 1283
        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',):
1284
          fixZSQLMethod(portal, obj)
1285
    self.afterInstall()
1286 1287 1288

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
1289
    trash = kw.get('trash', 0)
1290 1291 1292 1293 1294
    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
1295
      object_keys = self._archive.keys()
1296
    for relative_url in object_keys:
1297 1298
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
1299
      try:
1300
        container = self.unrestrictedResolveValue(portal, container_path)
1301
        object = container._getOb(object_id) # We force access to the object to be sure
1302 1303
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
1304
        if trash and trashbin is not None:
1305
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
1306
        if container.meta_type == 'CMF Skins Tool':
1307 1308
          # we are removing a skin folder, check and 
          # remove if registered skin selection
1309
          skin_folder = container[object_id]
1310 1311 1312
          unregisterSkinFolder(container, skin_folder,
              container.getSkinSelections())

1313
        container.manage_delObjects([object_id])
1314
        if container.aq_parent.meta_type == 'ERP5 Catalog' and not len(container):
1315
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1316
          container.getParentValue().manage_delObjects([container.id])
1317
      except (NotFound, KeyError, BadRequest, AttributeError):
1318
        # object is already backup and/or removed
1319
        pass
1320 1321
    BaseTemplateItem.uninstall(self, context, **kw)

1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
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

1334 1335 1336 1337 1338 1339 1340 1341 1342
  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()
1343 1344
    object_keys.sort()
    object_keys.reverse()
1345 1346
    p = context.getPortalObject()
    for path in object_keys:
1347 1348 1349 1350 1351
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1352 1353 1354
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1355
        try:
Aurel's avatar
Aurel committed
1356 1357
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
1358
          container = self.unrestrictedResolveValue(portal, container_path)
1359
          if trash and trashbin is not None:
1360 1361
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1362
                                           keep_subobjects=1)
1363 1364 1365 1366 1367 1368
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1369 1370 1371
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1372

1373 1374 1375 1376 1377 1378 1379 1380 1381
      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.
1382 1383 1384
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1385
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1386 1387
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1388
      if object_id != "":
1389
        path_list.extend(self._resolvePath(
1390
            folder._getOb(object_id),
1391
            relative_url_list + [object_id], id_list[1:]))
1392
    return path_list
Aurel's avatar
Aurel committed
1393

1394 1395 1396
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1397
    keys = self._path_archive.keys()
1398
    keys.sort()
Aurel's avatar
Aurel committed
1399
    for path in keys:
1400
      include_subobjects = 0
Aurel's avatar
Aurel committed
1401
      if path.endswith("**"):
1402
        include_subobjects = 1
1403
      for relative_url in self._resolvePath(p, [], path.split('/')):
1404 1405
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1406
        obj = obj.__of__(context)
1407
        _recursiveRemoveUid(obj)
1408
        id_list = obj.objectIds()
1409
        obj = self.removeProperties(obj, 1)
1410
        if hasattr(aq_base(obj), 'groups'):
1411
          # we must keep groups because it's ereased when we delete subobjects
1412
          groups = deepcopy(obj.groups)
1413
        if len(id_list) > 0:
1414 1415
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1416
          for id_ in list(id_list):
1417
            obj._delObject(id_)
1418
        if hasattr(aq_base(obj), 'groups'):
1419 1420 1421
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1422

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1423 1424 1425 1426 1427 1428 1429 1430
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)

1431
  def install(self, context, trashbin, **kw):
1432
    """ When we install a tool that is a type provider not
1433
    registered on types tool, register it into the type provider.
1434
    """
1435 1436 1437 1438
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    for type_container_id, obj in self._objects.iteritems():
1439
      if interfaces.ITypeProvider.providedBy(obj) and \
1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461
          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()
1462
    types_tool = portal.portal_types
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
    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)
1473

1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
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")
1489
    if len(id_list) != 1:
1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
      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():
1502
      pref = portal.unrestrictedTraverse(object_path)
1503
      # XXX getPreferenceState is a bad name
1504
      if pref.getPreferenceState() == 'disabled':
1505 1506
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1507 1508
        portal.portal_workflow.doActionFor(
                      pref,
1509 1510 1511
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1512 1513
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1514

1515 1516
class CategoryTemplateItem(ObjectTemplateItem):

1517 1518
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1519

1520 1521 1522 1523
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1524 1525
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1526
      obj = self.removeProperties(obj, 1)
1527
      id_list = obj.objectIds()
1528
      if id_list:
1529
        self.build_sub_objects(context, id_list, relative_url)
1530
        for id_ in list(id_list):
1531
          obj._delObject(id_)
1532 1533
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1534 1535 1536 1537 1538

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1539 1540 1541 1542 1543 1544 1545 1546
      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
1547
      _recursiveRemoveUid(obj)
1548
      obj = self.removeProperties(obj, 1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1549
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1550
      id_list = obj.objectIds()
1551 1552
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1553
        for id_ in list(id_list):
1554
          obj._delObject(id_)
1555
      else:
1556
        for id_ in list(id_list):
1557
          obj._delObject(id_)
1558 1559
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1560

1561 1562 1563
  def beforeInstall(self):
    self._installed_new_category = False

1564
  def onNewObject(self, obj):
1565 1566 1567 1568
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1569
      # reset accessors if we installed a new category
1570
      self.portal_types.resetDynamicDocumentsOnceAtTransactionBoundary()
1571

1572 1573
class SkinTemplateItem(ObjectTemplateItem):

1574 1575
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1576

1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
  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')

1587 1588
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601
    # 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

1602
  def install(self, context, trashbin, **kw):
1603
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1604 1605
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1606
    p = context.getPortalObject()
1607
    skin_tool = p.portal_skins
1608
    for relative_url in self._objects.keys():
1609
      # Do not register skin which were explicitely ask not to be installed
1610 1611 1612 1613 1614
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1615 1616 1617
      folder = p.unrestrictedTraverse(relative_url)
      for obj in folder.objectValues(spec=('Z SQL Method',)):
        fixZSQLMethod(p, obj)
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
      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',
          [])
1634 1635 1636
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1637
      if skin_selection_id in selection_list:
1638
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1639
      else:
1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658
        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):
1659
    if not self._objects:
1660 1661 1662 1663
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
1664 1665 1666
    bta.addObject(obj=self.generateXml(), 
                  name='registered_skin_selection',  
                  path=root_path)
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681

  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]
1682 1683 1684
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1685

1686
        if selection_list is default_value:
1687
          create_property = True
1688
          selection_list = self._objects[skin_folder_id]
1689
        else:
1690
          create_property = False
1691 1692 1693 1694 1695
          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])
1696 1697

        # Remove duplicate
1698
        selection_list = list(set(selection_list))
1699 1700 1701
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
1702
              selection_list, type='tokens')
1703 1704 1705
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
1706
              selection_list)
1707 1708

        unregisterSkinFolder(skin_tool, skin_folder,
1709
                             skin_tool.getSkinSelections())
1710
        registerSkinFolder(skin_tool, skin_folder)
1711 1712

  def uninstall(self, context, **kw):
1713 1714 1715
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1716 1717 1718 1719
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1720 1721 1722 1723
      object_keys = self._objects.keys()

    for skin_folder_id in object_keys:
      skin_folder = skin_tool[skin_folder_id]
1724
      current_selection_list = skin_folder.getProperty(
1725
        'business_template_registered_skin_selections', [])
1726
      current_selection_set = set(current_selection_list)
1727

1728 1729 1730
      skin_selection_list = workflow_id = self._objects[skin_folder_id]
      if isinstance(skin_selection_list, str):
        skin_selection_list = skin_selection_list.replace(',', ' ').split(' ')
1731 1732 1733 1734 1735
      for skin_selection in skin_selection_list:
        current_selection_set.remove(skin_selection)

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1736
        skin_folder._updateProperty(
1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750
            '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)

1751
  def preinstall(self, context, installed_item, **kw):
1752 1753 1754 1755 1756
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      for path in new_keys:
1757
        if installed_item._objects.has_key(path):
1758 1759
          # compare object to see it there is changes
          new_object = self._objects[path]
1760
          old_object = installed_item._objects[path]
1761 1762 1763 1764 1765
          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
1766
      old_keys = installed_item._objects.keys()
1767 1768 1769 1770 1771 1772 1773
      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'):
1774
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1775 1776 1777 1778
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
1779 1780 1781
    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
1782 1783
      if not selection_string:
        selection_list = []
1784
      else:
1785 1786
        selection_list = selection_string.split(',')
      skin_selection_dict[skin_folder_id] = selection_list
1787
    self._objects = skin_selection_dict
1788 1789


1790
class WorkflowTemplateItem(ObjectTemplateItem):
1791

1792 1793
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1794

1795 1796 1797 1798 1799
  # 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.

1800
  def preinstall(self, context, installed_item, installed_bt, **kw):
1801
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
1802
                                                         installed_item, **kw)
1803 1804 1805 1806
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1807
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1808 1809
      else:
        modified_workflow_dict[modified_object] = state
1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831
    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])
1832 1833
    return modified_workflow_dict

1834
  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1835
    if context.getTemplateFormatVersion() == 1:
1836 1837 1838
      portal = context.getPortalObject()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
Julien Muchembled's avatar
Julien Muchembled committed
1839 1840 1841
      # sort to add objects before their subobjects
      for path in sorted(self._objects):
          if force:
1842
            action = 'backup'
Julien Muchembled's avatar
Julien Muchembled committed
1843
          else:
1844
            action = update_dict.get('/'.join(path.split('/')[:2]))
Julien Muchembled's avatar
Julien Muchembled committed
1845 1846
            if action in (None, 'nothing'):
              continue
1847 1848 1849
          container_path = path.split('/')[:-1]
          object_id = path.split('/')[-1]
          try:
1850
            container = self.unrestrictedResolveValue(portal, container_path)
1851 1852
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1853
            container_url = '/'.join(container_path)
1854 1855 1856 1857 1858 1859
            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
1860
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1861
            container.manage_delObjects([object_id])
1862 1863
          obj = self._objects[path]
          obj = obj._getCopy(container)
1864
          self.removeProperties(obj, 0)
1865 1866 1867 1868
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1869 1870 1871
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)

1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
  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)
1887

1888 1889
class PortalTypeTemplateItem(ObjectTemplateItem):

1890 1891
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1892 1893
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1894 1895 1896
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1897 1898
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1899
      obj = p.unrestrictedTraverse(relative_url)
1900 1901 1902 1903
      # normalize relative_url, not all type informations are stored in
      # "portal_types"
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])

1904
      obj = obj._getCopy(context)
1905
      obj._p_activate()
1906
      for attr in obj.__dict__.keys():
1907 1908 1909 1910 1911 1912 1913 1914
        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)
1915 1916
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1917

1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933
  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)
1934 1935 1936 1937 1938 1939
        # 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
1940 1941 1942 1943 1944 1945 1946 1947 1948
        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

1949
  def install(self, context, trashbin, **kw):
1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962
    if context.getTemplateFormatVersion() == 1:
      object_list = self._objects
    else:
      object_list = self._archive

    for path, obj in object_list.iteritems():
        # if that's an old style class, use a portal type class instead
        # XXX PortalTypeTemplateItem-specific
        migrateme = getattr(obj, '_migrateToPortalTypeClass', None)
        if migrateme is not None:
          migrateme()
        object_list[path] = obj

1963
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1964 1965 1966

    # XXX : following be removed once all bt5 are
    # re-exported with separated workflow-chain information
1967 1968
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1969 1970
    # We now need to setup the list of workflows corresponding to
    # each portal type
1971
    (default_chain, chain_dict) = getChainByType(context)
1972
    # Set the default chain to the empty string is probably the
1973
    # best solution, by default it is 'default_workflow', which is
1974
    # not very usefull
1975
    default_chain = ''
1976
    for path in object_list.keys():
1977 1978 1979 1980
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1981
            continue
1982 1983
        obj = object_list[path]
        portal_type = obj.id
1984 1985 1986
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1987 1988
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1989

1990 1991
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1992 1993 1994
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
1995
      result_dict = {}
1996
      xml = parse(file)
1997
      chain_list = xml.findall('//chain')
1998
      for chain in chain_list:
1999 2000 2001 2002
        portal_type = chain.find('type').text
        workflow = chain.find('workflow').text or ''
        result_dict[portal_type] = workflow
      self._workflow_chain_archive = result_dict
2003 2004 2005
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

2006
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
2007

2008 2009 2010
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

2011
  def build(self, context, **kw):
2012 2013 2014 2015 2016
    # 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
2017
    p = context.getPortalObject()
2018
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
2019
    for key in self._archive.keys():
2020 2021 2022
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
2023
        workflow = wflist[1]
2024
      else:
2025
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
2026
        portal_type = wflist[0][:-2]
2027
        workflow = ''
2028 2029 2030 2031 2032
      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):
2033
          if not self.is_bt_for_diff:
2034 2035 2036
            # 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
2037
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
2038
                       'in chain for portal_type %s' % (workflow_name, portal_type))
2039
        self._objects.setdefault(portal_type, []).append(workflow)
2040
      elif not self.is_bt_for_diff:
2041
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
2042
                        'is probably a sign of a missing dependency.'\
2043
                                                    % portal_type
2044

Christophe Dumez's avatar
Christophe Dumez committed
2045
  # Function to generate XML Code Manually
2046 2047
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
2048 2049 2050
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2051
      workflow_list = self._objects[key]
2052 2053
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
2054 2055
      xml_data += '\n  <workflow>%s</workflow>' %(
        self._chain_string_separator.join(sorted(workflow_list)))
2056 2057
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
2058 2059 2060
    return xml_data

  def export(self, context, bta, **kw):
2061
    if not self._objects:
2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073
      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
2074
    (default_chain, chain_dict) = getChainByType(context)
2075
    # First convert all workflow_ids into list.
2076 2077
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
2078
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
2079
    # best solution, by default it is 'default_workflow', which is
2080 2081
    # not very usefull
    default_chain = ''
2082 2083
    for path in self._objects:
      if path in update_dict or force:
2084 2085 2086
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2087
            continue
Jérome Perrin's avatar
Jérome Perrin committed
2088 2089
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
2090
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
2091
          continue
2092
        portal_type = path_splitted[-1]
2093 2094
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
2095
          # XXX we don't use the chain (Default) in erp5 so don't keep it
2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115
          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)
2116
            # create the new chain
2117 2118
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
2119 2120
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
2121
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
2122 2123 2124
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
2125
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
2126
        else:
2127
          if context.portal_types.getTypeInfo(portal_type) is None:
2128
            raise ValueError('Cannot chain workflow %r to non existing '
2129 2130 2131 2132 2133
                           '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.
2134 2135
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
2136 2137
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2138

2139 2140
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
2141 2142
    object_path = kw.get('object_path', None)
    if object_path is not None:
2143
      object_key_list = [object_path]
2144
    else:
2145 2146 2147
      object_key_list = self._objects.keys()
    for object_key in object_key_list:
      path_splitted = object_key.split('/', 1)
2148 2149 2150
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
2151 2152 2153 2154 2155 2156 2157 2158 2159 2160
      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]
2161
        else:
2162 2163 2164 2165
          chain_dict[path] = self._chain_string_separator.\
                                                  join(workflow_id_list)
    context.getPortalObject().portal_workflow.\
                                   manage_changeWorkflows('', props=chain_dict)
2166

2167
  def preinstall(self, context, installed_item, **kw):
2168 2169
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2170
      new_key_list = self._objects.keys()
2171 2172
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
2173
      for key, value in installed_item._objects.iteritems():
2174 2175
        if not 'portal_type_workflow_chain/' in key:
          key = 'portal_type_workflow_chain/%s' % (key)
2176
        new_dict[key] = value
2177
      if new_dict:
2178
        installed_item._objects = new_dict
2179 2180
      for path in new_key_list:
        if path in installed_item._objects:
2181 2182
          # compare object to see it there is changes
          new_object = self._objects[path]
2183
          old_object = installed_item._objects[path]
2184 2185 2186 2187 2188 2189
          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()
2190
          if new_object != old_object:
2191
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2192
        else: # new object
2193
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2194
      # get removed object
2195 2196 2197
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2198 2199
    return modified_object_list

2200
  def _importFile(self, file_name, file):
2201
    if not file_name.endswith('.xml'):
2202
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2203
      return
2204
    # import workflow chain for portal_type
2205
    result_dict = {}
2206
    xml = parse(file)
2207
    chain_list = xml.findall('chain')
2208
    for chain in chain_list:
2209
      portal_type = chain.find('type').text
2210
      workflow_chain = chain.find('workflow').text or ''
2211
      if 'portal_type_workflow_chain/' not in portal_type:
2212 2213 2214 2215
        key = 'portal_type_workflow_chain/%s' % (portal_type,)
      else:
        key = portal_type
      result_dict[key] = workflow_chain.split(self._chain_string_separator)
2216
    self._objects = result_dict
2217

2218 2219
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2220

2221
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
2222 2223 2224
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
2225 2226
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
2227
  business_template_class_property = '_portal_type_allowed_content_type_item'
2228 2229

  def build(self, context, **kw):
2230
    types_tool = getToolByName(self.getPortalObject(), 'portal_types')
2231
    for key in self._archive.keys():
2232 2233 2234 2235
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
2236
      ob = types_tool.getTypeInfo(portal_type)
2237
      # check properties corresponds to what is defined in site
2238
      if ob is None:
2239 2240
        raise ValueError, "Portal Type %s not found in site" %(portal_type,)
      prop_value = getattr(ob, self.class_property, ())
2241 2242 2243 2244 2245 2246 2247
      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
2248
        raise ValueError, "%s %s not found in portal type %s" % (
2249 2250
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)
2251

Christophe Dumez's avatar
Christophe Dumez committed
2252
  # Function to generate XML Code Manually
2253 2254
  def generateXml(self, path=None):
    xml_data = '<%s>' %(self.xml_tag,)
2255 2256 2257
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2258
      id_value = key.replace('%s/' % self.class_property, '')
2259
      allowed_item_list = sorted(self._objects[key])
2260
      xml_data += '\n <portal_type id="%s">' % (id_value)
2261
      for allowed_item in allowed_item_list:
2262 2263 2264
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
2265 2266 2267
    return xml_data

  def export(self, context, bta, **kw):
2268
    if not self._objects:
2269 2270 2271
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
2272
    path = os.sep.join((self.__class__.__name__, self.class_property,))
2273 2274 2275
    xml_data = self.generateXml(path=None)
    bta.addObject(obj=xml_data, name=path, path=None)

2276
  def preinstall(self, context, installed_item, **kw):
2277 2278 2279
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
2280
      new_key_list = self._objects.keys()
2281 2282
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
Nicolas Delaby's avatar
Nicolas Delaby committed
2283
      for key, value in installed_item._objects.iteritems():
2284
        if self.class_property not in key:
2285
          key = '%s/%s' % (self.class_property, key)
Nicolas Delaby's avatar
Nicolas Delaby committed
2286
        new_dict[key] = value
2287
      if new_dict:
2288
        installed_item._objects = new_dict
2289 2290
      for path in new_key_list:
        if path in installed_item._objects:
2291 2292
          # compare object to see it there is changes
          new_object = self._objects[path]
2293
          old_object = installed_item._objects[path]
2294 2295
          new_object.sort()
          old_object.sort()
2296
          if new_object != old_object:
2297
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2298
        else: # new object
2299
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2300
      # get removed object
2301 2302 2303
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2304 2305
    return modified_object_list

2306
  def _importFile(self, file_name, file):
2307
    if not file_name.endswith('.xml'):
2308
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2309
      return
2310
    path, name = posixpath.split(file_name)
2311
    xml = parse(file)
2312
    portal_type_list = xml.findall('portal_type')
2313
    for portal_type in portal_type_list:
2314 2315
      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
2316
      if self.class_property not in id:
2317 2318 2319 2320
        key = '%s/%s' % (self.class_property, id,)
      else:
        key = id
      self._objects[key] = item_type_list
2321 2322

  def install(self, context, trashbin, **kw):
Nicolas Delaby's avatar
Nicolas Delaby committed
2323 2324
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2325 2326
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2327 2328 2329 2330 2331 2332 2333
    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
2334
      if key in update_dict or force:
2335 2336 2337 2338
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2339 2340 2341
        portal_id = key.split('/')[-1]
        type_information = types_tool.getTypeInfo(portal_id)
        if type_information is None:
2342 2343
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2344 2345
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
2346
        object_property_list = getattr(type_information, self.class_property, ())
Nicolas Delaby's avatar
Nicolas Delaby committed
2347 2348 2349 2350 2351 2352 2353 2354 2355
        # 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)
2356
        setattr(type_information, self.class_property, tuple(property_list))
2357

Aurel's avatar
Aurel committed
2358
  def uninstall(self, context, **kw):
2359
    object_path = kw.get('object_path', None)
Nicolas Delaby's avatar
Nicolas Delaby committed
2360 2361
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2362
    if object_path is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
2363
      object_key_list = [object_path]
2364
    else:
Nicolas Delaby's avatar
Nicolas Delaby committed
2365 2366
      object_key_list = self._objects.keys()
    for key in object_key_list:
2367 2368 2369 2370 2371
      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,))
2372 2373
        continue
      property_list = self._objects[key]
2374
      original_property_list = list(getattr(type_information,
2375
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2376 2377
      for id in property_list:
        if id in original_property_list:
2378
          original_property_list.remove(id)
2379
      setattr(type_information, self.class_property, tuple(original_property_list))
2380

2381

2382 2383
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2384
  name = 'Hidden Content Type'
2385 2386
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2387
  business_template_class_property = '_portal_type_hidden_content_type_item'
2388

2389

2390 2391
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2392
  name = 'Property Sheet'
2393 2394
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2395
  business_template_class_property = '_portal_type_property_sheet_item'
2396

2397

2398 2399
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2400
  name = 'Base Category'
2401 2402
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2403
  business_template_class_property = '_portal_type_base_category_item'
2404

2405

2406
class CatalogMethodTemplateItem(ObjectTemplateItem):
2407
  """Template Item for catalog methods.
2408

2409 2410 2411 2412 2413
    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.
  """
2414

2415 2416
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2417
    # a mapping to store properties of methods.
2418 2419 2420 2421 2422
    # 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()
2423

2424
    self._is_filtered_archive = PersistentMapping()
2425 2426
    for method in catalog_method_filter_list:
      setattr(self, method, PersistentMapping())
2427

2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441
  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

2442 2443
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2444

2445
    catalog = _getCatalogValue(self)
2446
    if catalog is None:
2447
      LOG('BusinessTemplate build', 0, 'catalog not found')
2448
      return
2449

2450 2451 2452
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2453

2454 2455
    for obj in self._objects.values():
      method_id = obj.id
2456 2457
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2458 2459 2460 2461 2462 2463
      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]
2464

2465 2466 2467 2468 2469
  def generateXml(self, path):
    obj = self._objects[path]
    method_id = obj.id
    xml_data = '<catalog_method>'
    if self._method_properties.has_key(method_id):
2470
      for method_property, value in self._method_properties[method_id].items():
2471 2472 2473
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2474

2475
      if self._is_filtered_archive.get(method_id):
2476 2477 2478
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2479 2480
          for method in catalog_method_filter_list:
            if method != '_filter_expression_instance_archive':
2481 2482
              value = getattr(self, method, {}).get(method_id)
              if isinstance(value, basestring):
2483 2484 2485
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2486
              elif value:
2487
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2488
                for item in value:
2489 2490
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2491
    xml_data += '\n</catalog_method>\n'
Christophe Dumez's avatar
Christophe Dumez committed
2492
    return xml_data
2493

2494 2495 2496
  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))
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522
    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)

2523 2524
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2525
    catalog = _getCatalogValue(self)
2526 2527 2528 2529 2530 2531 2532
    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)
2533

2534 2535 2536
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2537
    new_bt_format = context.getTemplateFormatVersion()
2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553

    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':
2554
              continue
2555 2556 2557 2558
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2559

2560 2561
    for obj in values:
      method_id = obj.id
2562

2563 2564 2565 2566 2567 2568
      # 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
2569
          elif isinstance(old_value, (list, tuple)):
2570 2571 2572 2573
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2574

2575 2576
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2577
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2578
        if context.getTemplateFormatVersion() == 1:
2579 2580 2581 2582 2583
          if expression and expression.strip():
            # only compile non-empty expressions
            expr_instance = Expression(expression)
          else:
            expr_instance = None
2584 2585
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2586 2587 2588
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2589
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2590 2591 2592 2593
        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, ())
2594
      elif method_id in catalog.filter_dict.keys():
2595
        catalog.filter_dict[method_id]['filtered'] = 0
2596

2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622
      # 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)
2623

2624 2625 2626 2627 2628 2629
        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)
2630

2631
  def uninstall(self, context, **kw):
2632
    catalog = _getCatalogValue(self)
2633 2634 2635
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2636

2637 2638 2639 2640
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2641 2642 2643 2644
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2645
    else:
2646
      try:
2647 2648 2649 2650
        if context.getTemplateFormatVersion() == 1:
          value = self._objects[object_path]
        else:
          value = self._archive[object_path]
2651 2652
      except KeyError:
        value = None
2653 2654
      if value is not None:
        values.append(value)
2655
    for obj in values:
2656
      method_id = obj.id
2657 2658 2659 2660 2661 2662 2663 2664 2665
      # 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)
2666

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2667
      if catalog.filter_dict.has_key(method_id):
2668
        del catalog.filter_dict[method_id]
2669

2670
    # uninstall objects
2671
    ObjectTemplateItem.uninstall(self, context, **kw)
2672

2673
  def _importFile(self, file_name, file):
2674
    if file_name.endswith('.catalog_keys.xml'):
2675
      # recreate data mapping specific to catalog method
2676 2677
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2678
      xml = parse(file)
2679
      method_list = xml.findall('item')
2680
      for method in method_list:
2681 2682 2683
        key = method.get('key')
        key_type = method.get('type')
        value_node = method.find('value')
2684
        if key_type == "str":
2685
          value = value_node.text or ''
2686
        elif key_type == "int":
2687
          value = int(value_node.text)
2688
        elif key_type == "tuple":
2689
          value = tuple([value_node.text for value_node in method.findall('value')])
2690
        else:
2691
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2692
          continue
2693
        if key in catalog_method_list or key in catalog_method_filter_list:
2694
          getattr(self, key)[id] = value
2695 2696 2697
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2698 2699 2700 2701 2702 2703 2704 2705
    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)
2706
      self.removeProperties(obj, 0)
2707 2708 2709
      self._objects[file_name[:-4]] = obj
    else:
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2710

2711
class ActionTemplateItem(ObjectTemplateItem):
2712 2713

  def __init__(self, id_list, **kw):
2714
    # XXX It's look like ObjectTemplateItem __init__
2715 2716 2717 2718 2719 2720
    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

2721 2722
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2723
      Split path tries to split a complex path such as:
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741

      "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

2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774
  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
2775
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2776 2777 2778 2779
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2780 2781 2782 2783
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2784 2785 2786
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2787
      # normalize url
2788 2789 2790 2791 2792
      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]
2793 2794
      action = self._getActionCopy(obj, context, value)
      if action is None:
2795 2796 2797
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2798
      key = posixpath.join(url[-2], url[-1], value)
2799
      self._objects[key] = self.removeProperties(action, 1)
2800
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2801

2802 2803 2804
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2805
    if context.getTemplateFormatVersion() == 1:
2806
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2807 2808
      p = context.getPortalObject()
      for id in self._objects.keys():
2809 2810 2811 2812 2813
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2814 2815 2816
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2817

2818
          if interfaces.ITypeProvider.providedBy(aq_parent(aq_inner(container))):
2819 2820 2821
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2822 2823
            continue

Julien Muchembled's avatar
Julien Muchembled committed
2824 2825
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2826 2827 2828
          try:
            from Products.CMFCore.interfaces import IActionProvider
          except ImportError:
2829
              # BACK:
2830 2831 2832 2833 2834 2835 2836 2837
              # 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,
2838
                  'Redirected action import',
2839 2840 2841 2842
                  '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
2843
          obj, action = container, obj
2844
          action_list = obj.listActions()
2845
          for index in range(len(action_list)):
2846
            if action_list[index].id == id:
2847
              # remove previous action
2848
              obj.deleteActions(selections=(index,))
2849 2850 2851
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2852
          obj.addAction(
2853
                        id = action.id
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2854
                      , name = action.title
2855
                      , action = action_text
2856 2857 2858 2859
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2860 2861
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2862
                      , priority = action.priority
2863
                      , description = action.description
Aurel's avatar
Aurel committed
2864
                    )
2865
          # sort action based on the priority define on it
2866 2867 2868 2869 2870 2871 2872 2873 2874
          # 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))
2875 2876
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2877
        container.manage_delObjects([obj.id
2878
          for obj in container.getActionInformationList()
2879
          if obj.getReference() in action_dict])
2880 2881
        for obj in action_dict.itervalues():
          container._importOldAction(obj)
Aurel's avatar
Aurel committed
2882
    else:
2883
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2884
      p = context.getPortalObject()
2885 2886
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2887
        relative_url, key, value = self._splitPath(id)
2888 2889
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2890
          if getattr(ai, key) == value:
2891
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2892 2893 2894
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2895
        obj.addAction(
Aurel's avatar
Aurel committed
2896 2897
                      id = action.id
                    , name = action.title
2898
                    , action = action_text
Aurel's avatar
Aurel committed
2899 2900 2901 2902
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2903 2904
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2905
                    )
Aurel's avatar
Aurel committed
2906 2907 2908 2909 2910 2911 2912
        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))
2913 2914
          obj.moveDownActions(selections=tuple(move_down_list))

2915 2916
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2917 2918
    object_path = kw.get("object_path", None)
    if object_path is not None:
2919 2920 2921 2922 2923 2924 2925 2926
      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]
2927
    else:
2928
      keys = self._archive.keys()
2929
    for id in keys:
2930 2931
      if  '|' in id:
        relative_url, value = id.split(' | ')
2932 2933 2934
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
2935
          is_new_action = interfaces.ITypeProvider.providedBy(obj.getParentValue())
2936
          key = is_new_action and 'reference' or 'id'
2937
      else:
2938
        relative_url, key, value = self._splitPath(id)
2939
        obj = p.unrestrictedTraverse(relative_url, None)
2940 2941 2942
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2943
          if getattr(action_list[index], key, None) == value:
2944 2945
            obj.deleteActions(selections=(index,))
            break
2946 2947
      LOG('BusinessTemplate', WARNING,
          'Unable to uninstall action at %s, ignoring' % relative_url )
2948 2949
    BaseTemplateItem.uninstall(self, context, **kw)

2950 2951 2952
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2953
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2954 2955 2956 2957 2958 2959 2960
    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])
2961 2962
      # normalize url
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])
2963
      self._objects[relative_url] = type_role_list = []
2964
      for role in obj.getRoleInformationList():
2965
        type_role_dict = {}
2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982
        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
2983
        type_role_list.append(type_role_dict)
2984
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2985

Christophe Dumez's avatar
Christophe Dumez committed
2986
  # Function to generate XML Code Manually
2987 2988 2989 2990
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2991
      xml_data += "\n  <role id='%s'>" % role['id']
2992
      # uniq
2993
      for property in ('title', 'description', 'condition',
2994 2995 2996
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2997 2998
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2999
          xml_data += "\n   <property id='%s'>%s</property>" % \
3000 3001 3002
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
3003
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
3004 3005
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
3006
          xml_data += "\n   <multi_property "\
3007
          "id='%s'>%s</multi_property>" % (property, prop_value)
3008 3009
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
3010
    return xml_data
3011

3012 3013 3014 3015 3016 3017 3018
  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)
3019 3020
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
3021 3022 3023 3024
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
3025 3026 3027
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3028 3029
    type_roles_list = []
    xml = parse(file)
3030
    xml_type_roles_list = xml.findall('role')
3031
    for role in xml_type_roles_list:
3032 3033 3034 3035
      id = role.get('id')
      if isinstance(id, unicode):
        id = id.encode('utf_8', 'backslashreplace')
      type_role_property_dict = {'id': id}
3036
      # uniq
3037 3038 3039 3040 3041 3042 3043 3044
      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
3045
      # multi
3046 3047 3048 3049 3050 3051 3052 3053
      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)
3054
      type_roles_list.append(type_role_property_dict)
3055
    self._objects['portal_type_roles/%s' % (file_name[:-4],)] = type_roles_list
3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066

  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
3067 3068 3069
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
3070
          # reset roles before applying
3071
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
3072
          type_roles_list = self._objects[roles_path] or []
3073 3074
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
3075 3076 3077
        else:
          raise AttributeError("Path '%r' not found while "
                               "installing roles" % (path, ))
3078 3079 3080

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
3081 3082 3083 3084 3085 3086
    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:
3087
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
3088 3089 3090 3091 3092
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
3093

3094 3095 3096 3097 3098 3099
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
3100 3101
      for property in p.propertyMap():
        if property['id'] == id:
3102
          obj = p.getProperty(id)
3103
          prop_type = property['type']
3104 3105
          break
      else:
3106
        obj = None
3107
      if obj is None and not self.is_bt_for_diff:
3108
        raise NotFound, 'the property %s is not found' % id
3109
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
3110

3111 3112
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
3113
    if not file_name.endswith('.xml'):
3114
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3115
      return
3116
    xml = parse(file)
3117 3118 3119 3120 3121 3122 3123 3124 3125
    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)
3126

3127 3128 3129
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3130
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3131 3132
      p = context.getPortalObject()
      for path in self._objects.keys():
3133 3134 3135 3136
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
3137
              continue
3138
          dir, id = posixpath.split(path)
3139
          prop_type, property = self._objects[path]
3140 3141 3142 3143 3144 3145 3146 3147
          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
3148
    else:
3149
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
3150
      p = context.getPortalObject()
3151
      for id, property in self._archive.keys():
3152
        property = self._archive[id]
Aurel's avatar
Aurel committed
3153
        if p.hasProperty(id):
3154 3155 3156 3157 3158 3159 3160
          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'])
3161 3162 3163

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3164 3165 3166 3167 3168 3169
    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:
3170 3171 3172 3173
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3174
  # Function to generate XML Code Manually
3175
  def generateXml(self, path=None):
3176
    xml_data = ''
3177
    prop_type, obj = self._objects[path]
3178
    xml_data += '\n <property>'
3179 3180
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
3181
    if prop_type in ('lines', 'tokens'):
3182
      xml_data += '\n  <value>'
3183
      for item in obj:
3184
        if item != '':
3185
          xml_data += '\n   <item>%s</item>' % escape(str(item))
3186
      xml_data += '\n  </value>'
3187
    else:
3188
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
3189
    xml_data += '\n </property>'
3190 3191
    return xml_data

Aurel's avatar
Aurel committed
3192 3193 3194 3195 3196
  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)
3197 3198 3199 3200
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
3201
      xml_data += self.generateXml(path)
3202
    xml_data += '\n</site_property>'
3203
    bta.addObject(obj=xml_data, name='properties', path=root_path)
3204

3205 3206 3207 3208 3209
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3210 3211 3212 3213 3214 3215
    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()
3216
      permission_list = []
3217
      mapping['permission_list'] = module.showPermissions()
3218
      mapping['category_list'] = module.getCategoryList()
3219
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3220

Christophe Dumez's avatar
Christophe Dumez committed
3221
  # Function to generate XML Code Manually
3222
  def generateXml(self, path=None):
3223
    mapping = self._objects[path]
3224
    xml_data = ['<module>']
3225
    keys = mapping.keys()
3226 3227
    for key in sorted(keys):
      if key == 'permission_list':
3228
        # separe permission dict into xml
3229
        xml_data.append(' <%s>' % (key, ))
3230
        permission_list = mapping[key]
3231
        for perm in permission_list:
3232
          # the type of the permission defined if we use acquired or not
3233
          if isinstance(perm[1], list):
3234 3235 3236
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
3237
          role_list = list(perm[1])
3238 3239 3240
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
3241
          if (len(role_list) == 0 and ptype == 'list') or \
3242 3243
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
3244
          role_list.sort()
3245 3246
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
3247
          for role in role_list:
3248 3249 3250
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
3251 3252 3253 3254 3255 3256 3257 3258
      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, ))
3259
      else:
3260
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
3261 3262
    xml_data.append('</module>')
    return '\n'.join(xml_data)
3263

3264
  def export(self, context, bta, **kw):
3265
    if len(self._objects) == 0:
3266 3267 3268
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
3269 3270
    keys = self._objects.keys()
    keys.sort()
3271
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
3272
      # export modules one by one
3273 3274
      xml_data = self.generateXml(path=key)
      bta.addObject(obj=xml_data, name=key, path=path)
3275

3276
  def install(self, context, trashbin, **kw):
3277
    portal = context.getPortalObject()
3278 3279
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3280
    if context.getTemplateFormatVersion() == 1:
3281
      items = self._objects
3282
    else:
3283 3284
      items = self._archive

3285 3286
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
3287 3288
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
3289
        if not force:
3290
          action = update_dict[path]
3291 3292
          if action == 'nothing':
            continue
3293 3294
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
3295
        module = portal._getOb(module_id, None)
3296 3297
        if module is not None:
          module.portal_type = portal_type
3298
        else:
3299
          module = portal.newContent(id=module_id, portal_type=portal_type)
3300
        module.setTitle(str(mapping['title']))
3301 3302
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
3303
          # By default, Manager only without acquire permission
3304 3305
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
3306
          module.manage_permission(name, roles=role_list, acquire=acquire)
3307 3308
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
3309 3310

  def _importFile(self, file_name, file):
3311 3312 3313
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3314
    mapping = {}
3315
    xml = parse(file)
3316
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3317
      key_node = xml.find(key)
3318
      if key == 'permission_list':
3319 3320 3321 3322 3323 3324 3325
        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))
3326
          else:
3327 3328 3329
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3330
      else:
3331
        mapping[key] = key_node.text or ''
3332 3333

    category_list = []
3334 3335 3336 3337
    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'))
3338 3339
    mapping['category_list'] = category_list

3340
    self._objects[file_name[:-4]] = mapping
3341

3342
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3343 3344 3345
    trash = kw.get('trash', 0)
    if trash:
      return
3346 3347 3348 3349 3350 3351
    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]
3352 3353
    p = context.getPortalObject()
    id_list = p.objectIds()
3354 3355
    for key in keys:
      if key in id_list:
3356
        try:
3357
          if trash and trashbin is not None:
3358
            container_path = key.split('/')
3359 3360
            self.portal_trash.backupObject(trashbin, container_path, 
                                           key, save=1, keep_subobjects=1)
3361
          p.manage_delObjects([key])
3362
        except NotFound:
3363
          pass
3364 3365
    BaseTemplateItem.uninstall(self, context, **kw)

3366 3367 3368
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3369 3370

class DocumentTemplateItem(BaseTemplateItem):
3371 3372 3373 3374
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3375 3376 3377

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

3381
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3382 3383
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3384
      new_keys = self._objects.keys()
3385
      # fix key if necessary in installed bt for diff
3386
      extra_prefix = self.__class__.__name__ + '/'
3387
      for key in installed_item._objects.keys():
3388 3389 3390 3391
        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]
3392
      for path in new_keys:
3393
        if installed_item._objects.has_key(path):
3394 3395
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3396
          old_obj_code = installed_item._objects[path]
3397
          if new_obj_code != old_obj_code:
3398 3399
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3400
        else: # new object
3401 3402
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3403
          # get removed object
3404
      old_keys = installed_item._objects.keys()
3405 3406
      for path in old_keys:
        if path not in new_keys:
3407 3408
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3409 3410
    return modified_object_list

3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425
  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()

3426 3427 3428
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3429
    if context.getTemplateFormatVersion() == 1:
3430
      need_reset = isinstance(self, DocumentTemplateItem)
Aurel's avatar
Aurel committed
3431
      for id in self._objects.keys():
3432 3433 3434 3435 3436 3437
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
3438
          path, name = posixpath.split(id)
3439
          try:
3440
            self.local_file_writer_name(name, text, create=0)
3441
          except IOError, error:
3442 3443
            LOG(self.__class__.__name__, WARNING,
                "Cannot install class %r on file system" % name)
3444
            if error.errno:
3445
              raise
3446
            continue
3447 3448 3449
          if self.local_file_importer_name is None:
            continue
          if need_reset:
3450
            self._resetDynamicModules()
3451 3452
            need_reset = False
          self.local_file_importer_name(name)
Aurel's avatar
Aurel committed
3453
    else:
3454 3455 3456
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3457
        # This raises an exception if the file exists.
3458
        self.local_file_writer_name(id, text, create=1)
Aurel's avatar
Aurel committed
3459
        if self.local_file_importer_name is not None:
3460
          self.local_file_importer_name(id)
3461 3462

  def uninstall(self, context, **kw):
3463
    object_path = kw.get('object_path', None)
3464 3465 3466 3467
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
3468 3469 3470 3471 3472
    if object_keys:
      if isinstance(self, DocumentTemplateItem):
        self._resetDynamicModules()
      for key in object_keys:
        self.local_file_remover_name(key)
3473 3474
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3475 3476 3477 3478 3479
  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)
3480 3481 3482 3483 3484 3485 3486
    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
3487

3488
  def _importFile(self, file_name, file):
3489 3490 3491
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3492
    text = file.read()
3493
    self._objects[file_name[:-3]] = text
3494

3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516
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
3517
  _perform_migration = True
3518 3519

  # Only meaningful for filesystem Property Sheets
3520 3521 3522 3523
  local_file_reader_name = staticmethod(readLocalPropertySheet)
  local_file_writer_name = staticmethod(writeLocalPropertySheet)
  local_file_importer_name = staticmethod(importLocalPropertySheet)
  local_file_remover_name = staticmethod(removeLocalPropertySheet)
3524

3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538
  def __init__(self, id_list, tool_id='portal_property_sheets', context=None, **kw):
    tool = None
    if context is not None and len(id_list):
      # XXX looking up a tool early in the install process might
      # cause issues. If it does, we'll have to consider moving this
      # to build()
      tool = getattr(context.getPortalObject(), tool_id, None)
    if tool is not None:
      existing_property_sheet_set = set(tool.objectIds())
      for i, id in enumerate(id_list):
        if id in existing_property_sheet_set:
          # if the property sheet is on ZODB, use it.
          id_list[i] = "%s/%s" % (tool_id, id)

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
    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
3645
    property_sheet_id_set = set(property_sheet_tool.objectIds())
3646

3647 3648 3649
    # careful, that dictionary will change
    class_id_list = migrate_object_dict.keys()
    for class_id in class_id_list:
3650 3651 3652
      # 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
3653
      if class_id in property_sheet_id_set:
Nicolas Delaby's avatar
Typo  
Nicolas Delaby committed
3654
        # XXX a Conduit must be able to merge modifications
3655
        # from FS PropertySheets into ZODB PropertySheets
3656
        warn('Conflict when migrating Property Sheet %s: ' \
3657 3658
             'already exists in portal_property_sheets and '\
             'cannot be updated automatically for now. ' % class_id,
3659 3660
             UserWarning)
        continue
3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707

      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'

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

3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724
    # 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'))
3725 3726 3727

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

3728
class ConstraintTemplateItem(DocumentTemplateItem):
3729 3730 3731 3732
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3733

3734
class ExtensionTemplateItem(DocumentTemplateItem):
3735 3736
  local_file_reader_name = staticmethod(readLocalExtension)
  local_file_writer_name = staticmethod(writeLocalExtension)
3737 3738
  # Extension needs no import
  local_file_importer_name = None
3739
  local_file_remover_name = staticmethod(removeLocalExtension)
3740 3741

class TestTemplateItem(DocumentTemplateItem):
3742 3743
  local_file_reader_name = staticmethod(readLocalTest)
  local_file_writer_name = staticmethod(writeLocalTest)
3744
  # Test needs no import
3745
  local_file_importer_name = None
3746
  local_file_remover_name = staticmethod(removeLocalTest)
3747

Aurel's avatar
Aurel committed
3748

3749 3750 3751
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3752 3753 3754

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3755
  def build(self, context, **kw):
3756 3757
    for key in self._archive.iterkeys():
      self._objects[key] = 1
Aurel's avatar
Aurel committed
3758

3759
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3760 3761
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3762
      new_roles = self._objects.keys()
3763 3764 3765 3766 3767 3768
      # 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]
3769
      for role in new_roles:
3770
        if installed_item._objects.has_key(role):
3771 3772 3773 3774
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
3775
      old_roles = installed_item._objects.keys()
3776 3777 3778 3779 3780 3781
      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):
3782
    p = context.getPortalObject()
3783
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3784
    if context.getTemplateFormatVersion() == 1:
3785
      role_set = set(self._objects)
3786
    else:
3787
      role_set = set(self._archive)
3788 3789 3790 3791
    # 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:
3792 3793
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
3794
    # set roles on portal
3795
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
3796 3797

  def _importFile(self, file_name, file):
3798
    if not file_name.endswith('.xml'):
3799
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3800
      return
3801
    xml = parse(file)
3802 3803 3804
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816

  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)

3817 3818 3819 3820 3821 3822 3823 3824 3825
  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
3826
      if role in roles and role not in new_roles:
3827 3828 3829
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3830
  # Function to generate XML Code Manually
3831 3832
  def generateXml(self):
    role_list = self._objects.keys()
3833
    xml_data = '<role_list>'
3834 3835
    for role in sorted(role_list):
      xml_data += '\n <role>%s</role>' % (role,)
3836
    xml_data += '\n</role_list>'
3837 3838
    return xml_data

Aurel's avatar
Aurel committed
3839
  def export(self, context, bta, **kw):
3840
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
3841 3842 3843
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
3844 3845 3846 3847 3848 3849 3850 3851 3852
    # 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)
3853

3854 3855 3856 3857
class CatalogSearchKeyTemplateItem(BaseTemplateItem):
  key_list_attr = 'sql_catalog_search_keys'
  key_list_title = 'search_key_list'
  key_title = 'Search key'
3858

Aurel's avatar
Aurel committed
3859
  def build(self, context, **kw):
3860
    catalog = _getCatalogValue(self)
3861 3862 3863
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3864
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
3865
    key_list = []
3866
    for key in self._archive.keys():
3867
      if key in catalog_key_list:
3868
        key_list.append(key)
3869
      elif not self.is_bt_for_diff:
3870
        raise NotFound, '%s %r not found in catalog' %(self.key_title, key)
3871
    if len(key_list) > 0:
3872
      self._objects['%s/%s' % (self.__class__.__name__, self.key_list_title)] = key_list
3873 3874

  def _importFile(self, file_name, file):
3875 3876 3877
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3878
    xml = parse(file)
3879 3880
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3881

3882
  def install(self, context, trashbin, **kw):
3883
    catalog = _getCatalogValue(self)
3884 3885 3886
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3887

3888
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3889
    if context.getTemplateFormatVersion() == 1:
3890 3891
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3892 3893 3894
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3895
    else:
3896
      keys = self._archive.keys()
3897 3898
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3899
    # XXX same as related key
3900
    if update_dict.has_key(self.key_list_title) or force:
3901
      if not force:
3902
        action = update_dict[self.key_list_title]
3903
        if action == 'nothing':
Aurel's avatar
Aurel committed
3904
          return
3905
      for key in keys:
3906 3907 3908
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
3909

3910
  def uninstall(self, context, **kw):
3911
    catalog = _getCatalogValue(self)
3912 3913 3914
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3915
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
3916
    object_path = kw.get('object_path', None)
3917 3918 3919 3920 3921
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3922 3923 3924
      if key in catalog_key_list:
        catalog_key_list.remove(key)
    setattr(catalog, self.key_list_attr, catalog_key_list)
3925 3926
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3927
  # Function to generate XML Code Manually
3928
  def generateXml(self, path=None):
3929
    obj = self._objects[path]
3930
    xml_data = '<key_list>'
3931 3932
    obj.sort()
    for key in obj:
3933 3934
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3935 3936
    return xml_data

Aurel's avatar
Aurel committed
3937 3938 3939 3940 3941
  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)
3942
    for path in self._objects.keys():
3943
      xml_data = self.generateXml(path=path)
3944
      bta.addObject(obj=xml_data, name=path, path=None)
3945

3946 3947 3948 3949
class CatalogResultKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_result_keys'
  key_list_title = 'result_key_list'
  key_title = 'Result key'
3950

3951 3952 3953 3954
class CatalogRelatedKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_related_keys'
  key_list_title = 'related_key_list'
  key_title = 'Related key'
3955

3956
  # override this method to support 'key_list' for backward compatibility.
3957
  def install(self, context, trashbin, **kw):
3958
    catalog = _getCatalogValue(self)
3959 3960 3961
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3962

3963
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3964
    if context.getTemplateFormatVersion() == 1:
3965
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3966
        return
3967 3968 3969
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3970
    else:
3971
      keys = self._archive.keys()
3972 3973
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3974
    # XXX must a find a better way to manage related key
3975
    if update_dict.has_key(self.key_list_title) or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3976
      if not force:
3977 3978
        if update_dict.has_key(self.key_list_title):
          action = update_dict[self.key_list_title]
Aurel's avatar
Aurel committed
3979 3980
        else: # XXX for backward compatibility
          action = update_dict['key_list']
Aurel's avatar
Aurel committed
3981 3982 3983
        if action == 'nothing':
          return
      for key in keys:
3984 3985 3986
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
3987

3988 3989 3990 3991
class CatalogResultTableTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_tables'
  key_list_title = 'result_table_list'
  key_title = 'Result table'
3992

3993
# keyword
3994 3995 3996 3997
class CatalogKeywordKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_keyword_search_keys'
  key_list_title = 'keyword_key_list'
  key_title = 'Keyword key'
3998

3999
# datetime
4000 4001 4002 4003
class CatalogDateTimeKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_datetime_search_keys'
  key_list_title = 'datetime_key_list'
  key_title = 'DateTime key'
4004

4005 4006 4007 4008 4009
# 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'
4010

4011 4012 4013 4014 4015
# request
class CatalogRequestKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_request_keys'
  key_list_title = 'request_key_list'
  key_title = 'Request key'
4016

4017 4018 4019 4020 4021
# multivalue
class CatalogMultivalueKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_multivalue_keys'
  key_list_title = 'multivalue_key_list'
  key_title = 'Multivalue key'
4022 4023

# topic
4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042
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'
4043

4044 4045 4046 4047
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4048 4049 4050
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4051
      else: # XXX backward compatibility
4052 4053
        lang = lang_key
        catalog = 'erp5_ui'
4054
      path = posixpath.join(lang, catalog)
4055 4056
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4057 4058 4059
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4060

4061
  def preinstall(self, context, installed_item, **kw):
4062 4063 4064 4065
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
4066
        if installed_item._objects.has_key(path):
4067 4068
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
4069
          old_obj_code = installed_item._objects[path]
4070 4071 4072 4073 4074
          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
4075
      old_keys = installed_item._objects.keys()
4076 4077 4078 4079 4080
      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

4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108
  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', {})
4109 4110
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
4111 4112
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4113
          if not force:
4114
            action = update_dict[key]
4115
            if action == 'nothing':
4116
              continue
4117
          lang, catalog = self._splitKey(key)
4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133

          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)
4134 4135
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4136 4137 4138 4139
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4140
            self._importCatalogLanguage(localizer, catalog, lang, po)
4141 4142
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4143
      for lang, catalogs in self._archive.iteritems():
4144 4145 4146
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176
          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)
4177 4178

  def export(self, context, bta, **kw):
4179
    if len(self._objects) == 0:
4180 4181 4182
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
4183
    for key, obj in self._objects.iteritems():
4184 4185
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
4186 4187 4188 4189 4190 4191 4192 4193
      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'))
4194 4195

  def _importFile(self, file_name, file):
4196 4197
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4198 4199
      text = file.read()
      self._objects[file_name[:-3]] = text
4200 4201
    elif name == 'language.xml':
      xml = parse(file)
4202 4203
      name = xml.find('name').text
      code = xml.find('code').text
4204
      self._objects[code] = name
4205

Aurel's avatar
Aurel committed
4206 4207
class LocalRolesTemplateItem(BaseTemplateItem):

4208
  def __init__(self, id_list, **kw):
4209
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4210 4211
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4212 4213 4214
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4215
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4216 4217
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4218
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4219

Christophe Dumez's avatar
Christophe Dumez committed
4220
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4221
  def generateXml(self, path=None):
4222
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4223 4224
    # local roles
    xml_data = '<local_roles_item>'
4225
    xml_data += '\n <local_roles>'
4226
    for key in sorted(local_roles_dict):
4227
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4228 4229
      tuple = local_roles_dict[key]
      for item in tuple:
4230 4231 4232 4233
        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
4234
    return xml_data
4235

Aurel's avatar
Aurel committed
4236 4237 4238 4239 4240 4241 4242 4243
  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)

4244
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4245
      encode_folders = []
4246
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4247
        if '%' not in folder:
4248
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4249 4250
        else:
          encode_folders.append(folder)
4251
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4252 4253 4254 4255
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
4256 4257 4258
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4259 4260
    xml = parse(file)
    # local roles
4261
    local_roles_list = xml.findall('//role')
Aurel's avatar
Aurel committed
4262 4263
    local_roles_dict = {}
    for role in local_roles_list:
4264 4265
      id = role.get('id')
      item_type_list = [item.text for item in role]
Aurel's avatar
Aurel committed
4266
      local_roles_dict[id] = item_type_list
4267
    self._objects['local_roles/%s' % (file_name[:-4],)] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278

  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
4279 4280
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4281
        local_roles_dict = self._objects[roles_path][0]
4282
        setattr(obj, '__ac_local_roles__', local_roles_dict)
4283
        obj.reindexObject()
Aurel's avatar
Aurel committed
4284

4285
  def uninstall(self, context, object_path=None, **kw):
Aurel's avatar
Aurel committed
4286
    p = context.getPortalObject()
4287 4288 4289 4290 4291
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
Aurel's avatar
Aurel committed
4292 4293 4294
      path = roles_path.split('/')[1:]
      obj = p.unrestrictedTraverse(path)
      setattr(obj, '__ac_local_roles__', {})
4295
      obj.reindexObject()
4296

4297 4298 4299
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4300
    in part or completely. Each object is separated from its
4301 4302 4303 4304 4305 4306 4307 4308 4309 4310
    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
4311 4312
      - object without optimal actions
      - list of relation between portal type and workflow
4313 4314 4315 4316 4317 4318 4319 4320 4321 4322

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

    - site property definition
      - id
      - type
4323
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4324

4325 4326
    - document/propertysheet/extension/test definition
      - copy of the local file
4327

4328
    - message transalation definition
4329
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4330

4331 4332
    The Business Template properties are exported to the bt folder with
    one property per file
4333

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4334 4335
    Technology:

4336 4337
    - 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
4338

4339
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4340 4341 4342 4343

    Use case:

    - install core ERP5 (the minimum)
4344

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

4347 4348
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4349
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4350 4351 4352 4353 4354
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4355
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4356 4357 4358

    # Declarative security
    security = ClassSecurityInfo()
4359
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4360 4361 4362 4363

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4364
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4365
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4366
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4367
                      , PropertySheet.BusinessTemplate
4368
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4369 4370
                      )

4371 4372 4373 4374 4375 4376
    # 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."""
4377
         , 'icon'           : 'file_icon.gif'
4378 4379
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
4380
         , 'type_class'     : 'BusinessTemplate'
4381 4382 4383 4384 4385 4386 4387
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4388 4389
    # This is a global variable
    # Order is important for installation
4390 4391 4392
    # We want to have:
    #  * path after module, because path can be module content
    #  * path after categories, because path can be categories content
4393 4394
    #  * path before workflow chain, because path can be a portal type
    #         (until chains are set on portal types with categories)
4395 4396 4397
    #  * skin after paths, because we can install a custom connection string as
    #       path and use it with SQLMethods in a skin.
    #    ( and more )
4398 4399
    _item_name_list = [
      '_product_item',
4400
      '_property_sheet_item',
4401
      '_constraint_item',
4402 4403 4404 4405
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4406
      '_tool_item',
4407 4408 4409 4410
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4411
      #'_portal_type_workflow_chain_item',
4412 4413 4414 4415
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4416 4417
      '_category_item',
      '_module_item',
4418
      '_path_item',
4419
      '_skin_item',
4420
      '_registered_skin_selection_item',
4421
      '_preference_item',
4422
      '_action_item',
4423
      '_portal_type_roles_item',
4424
      '_local_roles_item',
4425
      '_portal_type_workflow_chain_item',
4426
      '_catalog_method_item',
4427 4428 4429
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4430
      '_catalog_search_key_item',
4431
      '_catalog_keyword_key_item',
4432
      '_catalog_datetime_key_item',
4433 4434 4435 4436
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4437
      '_catalog_scriptable_key_item',
4438 4439
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4440 4441 4442 4443
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4444 4445 4446 4447 4448 4449
      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
4450
        self._baseGetTemplateFormatVersion()
4451

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4452 4453 4454
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4455

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4456
      return 0
4457

4458
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4459 4460 4461 4462 4463 4464 4465
    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".
4466 4467
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4468
          # XXX Not good to access the attribute directly,
4469 4470 4471
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4472

4473 4474
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4475 4476 4477 4478 4479 4480
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4481
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4482 4483 4484 4485 4486 4487 4488 4489
        """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)
4490

4491 4492
    security.declareProtected(Permissions.ManagePortal, 'storeTemplateItemData')
    def storeTemplateItemData(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4493
      """
4494
        Instanciate and Store Template items into properties.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4495
      """
4496
      # Store all Data
4497 4498
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4499
      self._portal_type_workflow_chain_item = \
4500
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4501 4502 4503 4504
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4505 4506 4507
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4508 4509 4510 4511 4512 4513
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4514
      self._portal_type_roles_item = \
4515
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4516 4517 4518 4519 4520 4521 4522
      self._site_property_item = \
          SitePropertyTemplateItem(self.getTemplateSitePropertyIdList())
      self._module_item = \
          ModuleTemplateItem(self.getTemplateModuleIdList())
      self._document_item = \
          DocumentTemplateItem(self.getTemplateDocumentIdList())
      self._property_sheet_item = \
4523 4524
          PropertySheetTemplateItem(self.getTemplatePropertySheetIdList(),
                                    context=self)
4525 4526
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546
      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())
4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558
      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())
4559 4560
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4561 4562
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4563 4564 4565
      self._catalog_search_key_item = \
          CatalogSearchKeyTemplateItem(
               self.getTemplateCatalogSearchKeyList())
4566 4567
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4568
               self.getTemplateCatalogKeywordKeyList())
4569 4570 4571
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4572 4573
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4574
               self.getTemplateCatalogFullTextKeyList())
4575 4576
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4577
               self.getTemplateCatalogRequestKeyList())
4578 4579
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4580
               self.getTemplateCatalogMultivalueKeyList())
4581 4582 4583
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4584 4585
      self._local_roles_item = \
          LocalRolesTemplateItem(
4586
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4587 4588 4589
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4590 4591 4592
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4593 4594 4595 4596 4597 4598
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4599

4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613
    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()

4614 4615
      # Build each part
      for item_name in self._item_name_list:
4616 4617 4618 4619
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4620

4621
    build = WorkflowMethod(build)
4622 4623

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4624
      """
4625
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4626
      """
4627
      return self.portal_templates.publish(self, url, username=username,
4628
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4629

4630
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4631
      """
4632
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4633
      """
4634
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4635

4636 4637 4638 4639 4640
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4641 4642 4643 4644 4645 4646 4647 4648 4649 4650
      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
4651 4652
      return False

4653
    def preinstall(self, check_dependencies=1, **kw):
4654 4655 4656
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4657
      """
4658 4659 4660 4661 4662
      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()
4663

4664 4665
      modified_object_list = {}
      bt_title = self.getTitle()
4666 4667 4668 4669 4670 4671 4672

      #  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)
4673 4674 4675
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4676
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4677

4678
      # if reinstall business template, must compare to object in ZODB
4679
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4680
      # same if we make a diff and select only one business template
4681
      reinstall = 0
4682 4683
      if installed_bt == self:
        reinstall = 1
4684
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
4685 4686
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                   id=INSTALLED_BT_FOR_DIFF)
4687 4688 4689 4690 4691 4692 4693
          # 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)
4694

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4695
      new_bt_format = self.getTemplateFormatVersion()
4696 4697 4698 4699 4700 4701
      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:
4702
          item = getattr(self, item_name, None)
4703 4704 4705 4706
          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
4707

4708
      for item_name in self._item_name_list:
4709
        new_item = getattr(self, item_name, None)
4710
        installed_item = getattr(installed_bt, item_name, None)
4711
        if new_item is not None:
4712
          if installed_item is not None and hasattr(installed_item, '_objects'):
4713
            modified_object = new_item.preinstall(context=self, 
4714 4715
                                                  installed_item=installed_item,
                                                  installed_bt=installed_bt)
4716 4717 4718 4719 4720 4721 4722
            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:
4723
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
4724

4725 4726
      return modified_object_list

4727
    def _install(self, force=1, object_to_update=None, update_translation=0,
4728
                 update_catalog=_MARKER, **kw):
4729
      """
Christophe Dumez's avatar
Christophe Dumez committed
4730
        Install a new Business Template, if force, all will be upgraded or installed
4731 4732
        otherwise depends of dict object_to_update
      """
4733 4734 4735 4736
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4737

4738 4739
      site = self.getPortalObject()
      installed_bt = site.portal_templates.getInstalledBusinessTemplate(
4740
                                                           self.getTitle())
4741 4742
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4743
        if installed_bt.getTemplateFormatVersion() == 0:
4744
          force = 1
4745 4746 4747
        if site.portal_workflow.isTransitionPossible(
            installed_bt, 'replace'):
          installed_bt.replace(self)
4748

4749
      trash_tool = getToolByName(site, 'portal_trash', None)
4750 4751 4752
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4753 4754 4755
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4756

4757 4758 4759
      if not force:
        self.checkDependencies()

4760 4761 4762
      from Products.ERP5.ERP5Site import ERP5Generator
      generator_class = getattr(site, '_generator_class', ERP5Generator)
      gen = generator_class()
4763
      # update activity tool first if necessary
4764 4765 4766 4767
      if self.getTitle() == 'erp5_core':
        if self.getTemplateUpdateTool():
          gen.setupLastTools(site)
        if not force and len(object_to_update) == 0:
4768
          # check if we have to update tools
4769
          if self.getTemplateUpdateTool():
4770 4771
            LOG('Business Template', 0, 'Updating Tools')
            gen.setup(site, 0, update=1)
4772
          if self.getTemplateUpdateBusinessTemplateWorkflow():
4773
            LOG('Business Template', 0, 'Updating Business Template Workflows')
4774
            gen.setupWorkflow(site)
4775
          return
4776

4777 4778
      # 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
4779
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
4780 4781 4782 4783 4784
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
4785
      if len(object_to_update) or force:
4786 4787 4788
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
4789 4790
            item.install(self, force=force, object_to_update=object_to_update, 
                               trashbin=trashbin, installed_bt=installed_bt)
4791

4792
      # update catalog if necessary
4793 4794 4795
      if update_catalog is _MARKER and force and self.isCatalogUpdatable():
        # override update_catalog parameter only if value
        # is not explicitely passed.
4796
        update_catalog = 1
4797
      elif update_catalog is _MARKER:
4798
        update_catalog = 0
4799
      if update_catalog:
4800
        catalog = _getCatalogValue(self)
4801
        if (catalog is None) or (not site.isIndexable):
4802 4803 4804 4805 4806
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4807

4808
      # get objects to remove
4809
      # do remove after because we may need backup object from installation
4810
      remove_object_dict = {}
4811 4812
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
4813
          remove_object_dict[path] = action
4814

4815
      # remove object from old business template
4816
      if len(remove_object_dict):
4817
        # XXX: this code assumes that there is an installed_bt
4818
        for item_name in reversed(installed_bt._item_name_list):
4819
          item = getattr(installed_bt, item_name, None)
4820
          if item is not None:
4821
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
4822

4823 4824

      # update tools if necessary
4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836
      if self.getTitle() == 'erp5_core':
        if self.getTemplateUpdateTool():
          LOG('Business Template', 0, 'Updating Tools')
          gen.setup(site, 0, update=1)

        # check if we have to update business template workflow
        if self.getTemplateUpdateBusinessTemplateWorkflow():
          LOG('Business Template', 0, 'Updating Business Template Workflows')
          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)
4837

4838 4839
      # remove trashbin if empty
      if trashbin is not None:
4840
        if len(trashbin) == 0:
4841 4842
          trash_tool.manage_delObjects([trashbin.getId(),])

4843 4844
      if update_catalog:
        site.ERP5Site_reindexAll()
4845

4846 4847
      # Update translation table, in case we added new portal types or
      # workflow states.
4848 4849
      if update_translation:
        site.ERP5Site_updateTranslationTable()
4850

4851 4852
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
4853

4854
    security.declareProtected(Permissions.ManagePortal, 'install')
4855 4856 4857
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4858
      """
4859
      return self._install(**kw)
4860

4861
    install = WorkflowMethod(install)
4862

4863
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4864
    def reinstall(self, **kw):
4865 4866 4867 4868
      """Reinstall Business Template.
      """
      return self._install(**kw)

4869
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4870

4871
    security.declareProtected(Permissions.ManagePortal, 'trash')
4872 4873
    def trash(self, new_bt, **kw):
      """
4874
        Trash unnecessary items before upgrading to a new business
4875
        template.
4876
        This is similar to uninstall, but different in that this does
4877
        not remove all items.
4878
      """
4879 4880
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4881
        item = getattr(self, item_name, None)
4882 4883
        if item is not None:
          item.trash(
4884
                self,
4885
                getattr(new_bt, item_name))
4886

4887
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
4888
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4889
      """
4890
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4891
      """
4892 4893 4894
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4895
        item = getattr(self, item_name, None)
4896
        if item is not None:
4897
          item.uninstall(self, **kw)
4898
      # It is better to clear cache because the uninstallation of a
4899
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
4900
      self.getPortalObject().portal_caches.clearAllCache()
4901

4902 4903
    uninstall = WorkflowMethod(uninstall)

4904
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4905
    def _clean(self):
4906
      """
4907
        Clean built information.
4908
      """
4909
      # First, remove obsolete attributes if present.
4910 4911 4912 4913
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4914
                    '_module_archive',
4915 4916 4917
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4918
                    '_property_sheet_archive'):
4919 4920 4921
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4922 4923
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4924

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

4927
    security.declareProtected(Permissions.AccessContentsInformation,
4928
                              'getBuildingState')
4929
    def getBuildingState(self, default=None, id_only=1):
4930
      """
4931
        Returns the current state in building
4932
      """
4933
      portal_workflow = getToolByName(self, 'portal_workflow')
4934 4935
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4936
      return wf._getWorkflowStateOf(self, id_only=id_only )
4937

4938
    security.declareProtected(Permissions.AccessContentsInformation,
4939
                              'getInstallationState')
4940
    def getInstallationState(self, default=None, id_only=1):
4941
      """
4942
        Returns the current state in installation
4943
      """
4944
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
4945 4946
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4947
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4948

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4949 4950 4951 4952 4953 4954
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4955
      export_string = portal_templates.manage_exportObject(
4956 4957
                                               id=self.getId(),
                                               toxml=1,
4958
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4959
      return export_string
4960

4961
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4962
      """
4963 4964
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4965
      """
4966 4967
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
4968 4969 4970 4971
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4972
        # XXX Why do we need to return a tuple ?
4973 4974
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4975

4976
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4977
      """
4978 4979
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4980
      """
4981
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4982

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

4990
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4991
      """
4992 4993
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4994
      """
4995
      return self._getOrderedList('template_workflow_id')
4996

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

5004 5005 5006 5007 5008 5009 5010
    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
5011 5012 5013 5014 5015 5016 5017
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

5018 5019 5020 5021 5022 5023 5024
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

5025 5026 5027 5028 5029 5030
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
5031

5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052
    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')

5053
    def getTemplateActionPathList(self):
5054
      """
5055 5056
      We have to set this method because we want an
      ordered list
5057
      """
5058
      return self._getOrderedList('template_action_path')
5059

5060
    def getTemplatePortalTypeRoleList(self):
5061 5062 5063 5064
      """
      We have to set this method because we want an
      ordered list
      """
5065
      return self._getOrderedList('template_portal_type_role')
5066

5067
    def getTemplateLocalRoleList(self):
5068 5069 5070 5071
      """
      We have to set this method because we want an
      ordered list
      """
5072
      return self._getOrderedList('template_local_role')
5073

5074
    def getTemplateSkinIdList(self):
5075
      """
5076 5077
      We have to set this method because we want an
      ordered list
5078
      """
5079
      return self._getOrderedList('template_skin_id')
5080

5081 5082 5083 5084 5085 5086 5087
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

5088
    def getTemplateModuleIdList(self):
5089
      """
5090 5091
      We have to set this method because we want an
      ordered list
5092
      """
5093
      return self._getOrderedList('template_module_id')
5094 5095 5096 5097 5098 5099 5100

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5102 5103 5104 5105 5106 5107 5108
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132
    def isKeepObject(self, path):
      """
      Return True if path is included in keep object list.
      """
      keep_list = self.getTemplateKeepPathList()
      for keep_path in keep_list:
        if keep_path.endswith('**') and path.startswith(keep_path[:-2]):
          return True
        elif path == keep_path:
          return True
      return False

    def isKeepWorkflowObject(self, path):
      """
      Return True if path is included in keep workflow object list.
      """
      keep_list = self.getTemplateKeepWorkflowPathList()
      for keep_path in keep_list:
        if keep_path.endswith('**') and path.startswith(keep_path[:-2]):
          return True
        elif path == keep_path:
          return True
      return False

5133
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5134 5135 5136 5137
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5138
      if self.getBuildingState() != 'built':
5139
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5140
              'Business Template must be built before export'
5141

Aurel's avatar
Aurel committed
5142 5143 5144 5145 5146 5147 5148
      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)

5149
      # export bt
5150
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
5151
      for prop in self.propertyMap():
5152
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5153
        id = prop['id']
5154
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5155
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5156
          continue
Aurel's avatar
Aurel committed
5157
        value = self.getProperty(id)
5158
        if not value:
5159
          continue
5160
        if prop_type in ('text', 'string', 'int', 'boolean'):
5161
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
5162
        elif prop_type in ('lines', 'tokens'):
5163
          bta.addObject(obj=str('\n').join(value), name=id,
5164
                        path=path+os.sep+'bt', ext='')
5165

Aurel's avatar
Aurel committed
5166 5167 5168
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5169

5170
      return bta.finishCreation(self.getTitle())
Aurel's avatar
Aurel committed
5171

5172
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5173 5174
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5175
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5176 5177 5178 5179 5180
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
5181 5182

      self.storeTemplateItemData()
5183

5184 5185
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5186 5187
      # XXX This is not required with portal types as classes.
      #     It is still there for compatibility with non-migrated objects.
5188
      module_id_list = []
5189
      for template_id in self.getTemplateDocumentIdList():
5190 5191 5192
        module_id = 'Products.ERP5Type.Document.' + template_id
        if module_id not in sys.modules:
          module_id_list.append(module_id)
5193
          sys.modules[module_id] = module = imp.new_module(module_id)
5194 5195
          setattr(module, template_id, type(template_id,
            (SimpleItem.SimpleItem,), {'__module__': module_id}))
5196

Aurel's avatar
Aurel committed
5197 5198
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5199

5200 5201
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5202 5203
      for module_id in module_id_list:
        del sys.modules[module_id]
5204

5205 5206 5207 5208 5209
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5210 5211 5212
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5213
      return items_list
5214

5215 5216 5217 5218 5219 5220 5221 5222 5223 5224
    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:
5225
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5226
          dependency = dependency_couple_list[0]
5227 5228
          if dependency in (None, ''):
            continue
5229 5230
          version_restriction = None
          if len(dependency_couple_list) > 1:
5231
            version_restriction = dependency_couple_list[1]
5232 5233 5234
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5235 5236 5237
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5238
                  or (version_restriction not in (None, '') and
5239 5240 5241 5242
                     (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)
5243

5244 5245 5246 5247 5248 5249 5250 5251
    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
5252
    def diffObject(self, REQUEST, **kw):
5253 5254
      """
        Make a diff between an object in the Business Template
5255
        and the same in the Business Template installed in the site
5256 5257 5258 5259
      """

      class_name_dict = {
        'Product' : '_product_item',
5260
        'PropertySheet' : '_property_sheet_item',
5261
        'Constraint' : '_constraint_item',
5262 5263 5264 5265 5266 5267 5268 5269 5270
        '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',
5271
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5272 5273 5274 5275
        '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',
5276 5277 5278
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5279
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5280
        'Path' : '_path_item',
5281
        'Preference' : '_preference_item',
5282
        'Action' : '_action_item',
5283
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5284
        'LocalRoles' : '_local_roles_item',
5285 5286 5287
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5288
        'CatalogSearchKey' : '_catalog_search_key_item',
5289
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5290
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5291 5292 5293 5294
        '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
5295
        'Tool': '_tool_item',
5296
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5297 5298
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5299
        }
5300

5301 5302
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5303

Christophe Dumez's avatar
Christophe Dumez committed
5304
      # Get objects
5305
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5306

5307
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
5308
      # Compare with a given business template
5309
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5310 5311
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5312 5313
        if bt2_id == self.getId():
          compare_to_zodb = 1
5314
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5315 5316
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5317 5318 5319
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5320 5321
          compare_to_zodb = 1
      if compare_to_zodb:
5322 5323
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5324
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5325 5326 5327
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5328

5329 5330
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5331
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5332
        # XXX maybe only build for the given object to gain time
5333
        installed_item.build(self)
5334 5335 5336
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5337

Christophe Dumez's avatar
Christophe Dumez committed
5338
      # Real Zope Objects (can be exported into XML directly by Zope)
5339 5340
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5341
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5342
                     '_skin_item', '_action_item', '_tool_item', ]
5343

Christophe Dumez's avatar
Christophe Dumez committed
5344
      # Not considered as objects by Zope (will be exported into XML manually)
5345
      # XXX Bad naming
5346 5347 5348 5349
      item_list_2 = ['_site_property_item',
                     '_module_item',
                     '_catalog_result_key_item', 
                     '_catalog_related_key_item',
5350
                     '_catalog_result_table_item',
5351
                     '_catalog_search_key_item',
5352
                     '_catalog_keyword_key_item',
5353
                     '_catalog_datetime_key_item',
5354 5355 5356 5357
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5358
                     '_catalog_scriptable_key_item',
5359 5360
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5361 5362 5363 5364 5365 5366
                     '_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',
5367
                     '_portal_type_workflow_chain_item',]
5368

Christophe Dumez's avatar
Christophe Dumez committed
5369
      # Text objects (no need to export them into XML)
5370
      # XXX Bad naming
5371 5372
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5373
                     '_test_item', '_message_translation_item',]
5374

5375
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5376 5377 5378
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5379 5380
        new_object = new_item.removeProperties(new_object, 1)
        installed_object = installed_item.removeProperties(installed_object, 1)
5381
        # XML Export in memory
5382
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5383 5384
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5385
        new_obj_xml = f1.getvalue()
5386
        f1.close()
5387 5388 5389 5390
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5391
        # End of XML export
5392

5393
        # Diff between XML objects
5394 5395
        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
5396
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5397 5398 5399
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5400

5401
      elif item_name in item_list_2:
5402
        # Generate XML code manually
5403 5404
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5405 5406
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5407
        # End of XML Code Generation
5408

5409
        # Diff between XML objects
5410 5411
        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
5412
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5413 5414 5415
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5416

5417
      elif item_name in item_list_3:
5418
        # Diff between text objects
5419 5420 5421 5422
        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
5423
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5424 5425
          diff_msg += '\n'.join(diff_list)
        else:
5426
          diff_msg = 'No diff'
5427

5428
      else:
5429
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5430

5431
      if compare_to_zodb:
5432
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5433

5434
      return diff_msg
5435

5436

5437 5438 5439 5440
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5441 5442
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5443 5444 5445 5446 5447 5448 5449
      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 [])
5450 5451
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5452
      p = self.getPortalObject()
5453
      for id in bt_portal_types_id_list:
5454 5455
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5456
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5457
        if portal_type.getRoleInformationList():
5458 5459
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5460

5461 5462 5463 5464
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5465
        action_list = []
5466 5467 5468 5469 5470 5471 5472
        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'):
5473
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5474 5475
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5476

5477 5478 5479 5480
        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)
5481

5482
        for h_id in hidden_content_type_list:
5483 5484 5485
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5486

5487 5488 5489 5490
        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)
5491

5492 5493 5494 5495
        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)
5496

5497 5498 5499 5500
        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)
5501

5502
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5503
                                    if chain != '(Default)']:
5504 5505 5506
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5507

5508 5509 5510 5511
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5512
      bt_action_list.sort()
5513
      bt_wf_chain_list.sort()
5514

5515 5516 5517 5518 5519 5520 5521
      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)
5522 5523 5524 5525 5526 5527 5528 5529 5530
      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:
5531 5532
        raise TemplateConditionError, 'No module defined in business template'

5533 5534 5535 5536 5537 5538 5539 5540
      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:
5541
          return type_list
5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555

        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():
5556
            type_list.update(getChildPortalType(hidden_ptype_id))
5557
        return type_list
5558

5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605
      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

5606 5607 5608
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5609
  setattr(BusinessTemplate, key, None)
5610

5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637
# 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)
5638

5639 5640 5641 5642 5643 5644 5645 5646

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

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