BusinessTemplate.py 217 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, glob, imp, os, re, shutil, sys, time
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
37
from AccessControl.SecurityInfo import ModuleSecurityInfo
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38
from Products.CMFCore.utils import getToolByName
39
from Products.PythonScripts.PythonScript import PythonScript
40
from Products.ERP5Type.Accessor.Constant import PropertyGetter as ConstantGetter
41
from Products.ERP5Type.Base import WorkflowMethod
42
from Products.ERP5Type.Cache import transactional_cached
Nicolas Dumazet's avatar
Nicolas Dumazet committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
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
61
from Products.ERP5Type.Utils import convertToUpperCase
62
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63
from Products.ERP5Type.XMLObject import XMLObject
64
from Products.ERP5Type.dynamic.portal_type_class import synchronizeDynamicModules
65
from Products.ERP5Type.Core.PropertySheet import PropertySheet as PropertySheetDocument
Aurel's avatar
Aurel committed
66
from OFS.Traversable import NotFound
67
from OFS import SimpleItem, XMLExportImport
68
from cStringIO import StringIO
Aurel's avatar
Aurel committed
69
from copy import deepcopy
70
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
71
import OFS.XMLExportImport
72
from Products.ERP5Type.patches.ppml import importXML
Aurel's avatar
Aurel committed
73
customImporters={
74
    XMLExportImport.magic: importXML,
Aurel's avatar
Aurel committed
75
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
76

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

89 90 91 92 93 94
import threading

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

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

109 110
catalog_method_filter_list = ('_filter_expression_archive',
                              '_filter_expression_instance_archive',
111
                              '_filter_expression_cache_key_archive',
112
                              '_filter_type_archive',)
113

114
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'
115
_MARKER = []
116

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

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

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

161 162 163 164 165 166 167
def getChainByType(context):
  """
  This is used in order to construct the full list
  of mapping between type and list of workflow associated
  This is only useful in order to use
  portal_workflow.manage_changeWorkflows
  """
168
  pw = context.getPortalObject().portal_workflow
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
  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)

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

208 209
def registerSkinFolder(skin_tool, skin_folder):
  request = skin_tool.REQUEST
210 211 212
  # 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)
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
  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()

228 229 230
  if isinstance(skin_selection_list, basestring):
    skin_selection_list = skin_selection_list.split()

231 232 233 234 235 236 237
  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

238 239 240 241 242 243 244 245 246
  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 ''
247
    selection_list = selection.split(',')
248
    if (skin_folder_id not in selection_list):
249
      selection_list.insert(0, skin_folder_id)
250
    if reorder_skin_selection:
251 252
      # Sort by skin priority and ID
      selection_list.sort(key=skin_sort_key)
253
    if (skin_name in skin_layer_list):
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 310 311 312
      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
313 314 315
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
316
  """
317
  def _initCreation(self, path, **kw):
318
    self.path = path
Aurel's avatar
Aurel committed
319 320 321 322 323 324 325

  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)

326
  def addObject(self, obj, name, path=None, ext='.xml'):
327 328 329 330 331 332
    if path:
      name = posixpath.join(path, name)
    # XXX required due to overuse of os.path
    name = name.replace('\\', '/').replace(':', '/')
    name = quote(name + ext)
    path = name.replace('/', os.sep)
333
    try:
334 335 336 337 338 339 340 341 342 343
      write = self._writeFile
    except AttributeError:
      if not isinstance(obj, str):
        obj.seek(0)
        obj = obj.read()
      self._writeString(obj, path)
    else:
      if isinstance(obj, str):
        obj = StringIO(obj)
      write(obj, path)
344

345
  def finishCreation(self):
Aurel's avatar
Aurel committed
346 347 348 349
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
350
    Class archiving business template into a folder tree
351
  """
352 353 354 355 356 357 358 359 360 361 362 363
  def _writeString(self, obj, path):
    object_path = os.path.join(self.path, path)
    path = os.path.dirname(object_path)
    os.path.exists(path) or os.makedirs(path)
    f = open(object_path, 'wb')
    try:
      f.write(obj)
    finally:
      f.close()

  def _initImport(self, file, path, **kw):
    root_path_len = len(os.path.normpath(os.path.join(path, '_'))) - 1
364 365 366 367 368 369 370
    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
371

372
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
373 374 375
    """
      Import file from a local folder
    """
376
    class_name = item.__class__.__name__
377 378
    root_path_len = self.root_path_len
    prefix_len = root_path_len + len(class_name) + len(os.sep)
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
    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
399

Aurel's avatar
Aurel committed
400 401 402 403 404
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

405 406
  def _initCreation(self, **kw):
    BusinessTemplateArchive._initCreation(self, **kw)
Aurel's avatar
Aurel committed
407 408 409
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)
410 411 412 413 414 415 416 417 418 419 420 421 422
    self.time = time.time()

  def _writeFile(self, obj, path):
    if self.path:
      path = posixpath.join(self.path, path)
    info = tarfile.TarInfo(path)
    info.mtime = self.time
    obj.seek(0, 2)
    info.size = obj.tell()
    obj.seek(0)
    self.tar.addfile(info, obj)

  def finishCreation(self):
Aurel's avatar
Aurel committed
423 424 425
    self.tar.close()
    return self.fobj

426
  def _initImport(self, file, **kw):
427 428 429 430 431 432 433 434 435 436 437 438
    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
439

440
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
441 442
    """
      Import all file from the archive to the site
443
    """
444 445 446
    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
447

448
class TemplateConditionError(Exception): pass
449
class TemplateConflictError(Exception): pass
450
class BusinessTemplateMissingDependency(Exception): pass
451

452 453 454
ModuleSecurityInfo(__name__).declarePublic('BusinessTemplateMissingDependency',
  'TemplateConditionError', 'TemplateConflictError')

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

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

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

473
  def preinstall(self, context, installed_item, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
474 475
    """
      Build a list of added/removed/changed files between the BusinessTemplate
476
      being installed (self) and the installed one (installed_item).
Vincent Pelletier's avatar
Vincent Pelletier committed
477 478 479 480 481
      Note : we compare files between BTs, *not* between the installed BT and
      the objects in the DataFS.

      XXX: -12 used here is -len('TemplateItem')
    """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
482 483
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
484
      new_keys = self._objects.keys()
485
      for path in new_keys:
486
        if installed_item._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
487
          # compare objects to see it there are changes
488
          new_obj_xml = self.generateXml(path=path)
489
          old_obj_xml = installed_item.generateXml(path=path)
490 491
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
492
          # else, compared versions are identical, don't overwrite the old one
493 494
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
495
      # list removed objects
496
      old_keys = installed_item._objects.keys()
497 498 499 500 501 502
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
503
    pass
504 505 506

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

508
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
509 510 511 512 513 514
    """
      If 'remove' is chosen on an object containing subobjects, all the
      subobjects will be removed too, even if 'backup' or 'keep' was chosen for
      the subobjects.
      Likewise, for 'save_and_remove' : subobjects will get saved too.
    """
515 516 517
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
518
    keys.reverse()
519 520 521 522 523 524 525 526 527 528 529
    # if you choose remove, the object and all its subobjects will be removed
    # even if you choose backup or keep for subobjects
    # it is same behaviour for backup_and_remove, all we be save
    for path in keys:
      if remove_dict.has_key(path):
        action = remove_dict[path]
        if action == 'save_and_remove':
          # like trash
          self.uninstall(context, trash=1, object_path=path, **kw)
        elif action == 'remove':
          self.uninstall(context, trash=0, object_path=path, **kw)
530 531 532 533
        else:
          # As the list of available actions is not strictly defined,
          # prevent mistake if an action is not handled
          raise ValueError, 'Unknown action "%s"' % action
534

535

536 537 538 539
  def trash(self, context, new_item, **kw):
    # trash is quite similar to uninstall.
    return self.uninstall(context, new_item=new_item, trash=1, **kw)

Aurel's avatar
Aurel committed
540
  def export(self, context, bta, **kw):
541
    pass
Aurel's avatar
Aurel committed
542

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

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

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

557
    attr_set = set(('_dav_writelocks', '_filepath', '_owner', 'uid',
558
                    '__ac_local_roles__'))
559
    if export:
560 561
      if not keep_workflow_history:
        attr_set.add('workflow_history')
562 563
      # PythonScript covers both Zope Python scripts
      # and ERP5 Python Scripts
564
      if isinstance(obj, PythonScript):
565
        attr_set.update(('func_code', 'func_defaults', '_code',
566
                         '_lazy_compilation', 'Python_magic'))
567 568 569
        for attr in 'errors', 'warnings', '_proxy_roles':
          if not obj.__dict__.get(attr, 1):
            delattr(obj, attr)
570 571
      elif classname == 'SQL' and klass.__module__== 'Products.ZSQLMethods.SQL':
        attr_set.update(('_arg', 'template'))
572
      elif interfaces.IIdGenerator.providedBy(obj):
Nicolas Dumazet's avatar
Nicolas Dumazet committed
573
        attr_set.update(('last_max_id_dict', 'last_id_dict'))
574 575
      elif classname == 'Types Tool' and klass.__module__ == 'erp5.portal_type':
        attr_set.add('type_provider_list')
576

577 578
    for attr in obj.__dict__.keys():
      if attr in attr_set or attr.startswith('_cache_cookie_'):
579 580
        delattr(obj, attr)

581
    if classname == 'PDFForm':
582
      if not obj.getProperty('business_template_include_content', 1):
583
        obj.deletePdfContent()
584 585
    return obj

586 587 588 589 590 591 592 593 594
  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]

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

603 604
  def unrestrictedResolveValue(self, context=None, path='', default=_MARKER,
                               restricted=0):
605 606 607 608 609 610 611 612 613 614 615
    """
      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:
616
        portal = aq_inner(self.getPortalObject())
617 618 619 620
        container = portal
      else:
        container = context

621 622 623 624
      if restricted:
        validate = getSecurityManager().validate

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

635 636 637 638 639 640 641 642 643 644 645 646
        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
647

648 649 650
      return value
    else:
      return context
651

652 653 654
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
655
  """
656

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

666
  def export(self, context, bta, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
667 668 669 670
    """
      Export the business template : fill the BusinessTemplateArchive with
      objects exported as XML, hierarchicaly organised.
    """
671 672
    if len(self._objects.keys()) == 0:
      return
673
    path = self.__class__.__name__
Vincent Pelletier's avatar
Vincent Pelletier committed
674
    for key, obj in self._objects.iteritems():
675
      # export object in xml
676
      f = StringIO()
677
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
678
      bta.addObject(f, key, path=path)
679

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

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

730
  def _compileXML(self, file):
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
    # 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
790

791 792 793 794 795 796 797
  def getConnection(self, obj):
    while True:
      connection = obj._p_jar
      if connection is not None:
        return connection
      obj = obj.aq_parent

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

813
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
814 815
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
816 817
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
818
      for path, obj in self._objects.iteritems():
819
        if installed_item._objects.has_key(path):
820
          upgrade_list.append((path, installed_item._objects[path]))
821
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
822
          modified_object_list[path] = 'New', type_name
823

Julien Muchembled's avatar
Julien Muchembled committed
824 825 826 827 828 829 830 831 832
      # update _p_jar property of objects cleaned by removeProperties
      transaction.savepoint(optimistic=True)
      for path, old_object in upgrade_list:
        # compare object to see it there is changes
        new_object = self._objects[path]
        new_io = StringIO()
        old_io = StringIO()
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, new_io)
        new_obj_xml = new_io.getvalue()
833 834 835
        try:
          OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
          old_obj_xml = old_io.getvalue()
836 837
        except (ImportError, UnicodeDecodeError), e: # module is already
                                                     # removed etc.
838
          old_obj_xml = '(%s: %s)' % (e.__class__.__name__, e)
Julien Muchembled's avatar
Julien Muchembled committed
839 840 841
        new_io.close()
        old_io.close()
        if new_obj_xml != old_obj_xml:
842 843 844 845
          if context.isKeepObject(path):
            modified_object_list[path] = 'Modified but should be kept', type_name
          else:
            modified_object_list[path] = 'Modified', type_name
846
      # get removed object
847
      for path in set(installed_item._objects) - set(self._objects):
848 849 850 851
        if context.isKeepObject(path):
          modified_object_list[path] = 'Removed but should be kept', type_name
        else:
          modified_object_list[path] = 'Removed', type_name
852 853
    return modified_object_list

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

883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
  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

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

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

926 927 928 929 930 931
  def _getObjectKeyList(self):
    # sort to add objects before their subobjects
    keys = self._objects.keys()
    keys.sort()
    return keys

932
  def install(self, context, trashbin, **kw):
933
    self.beforeInstall()
934 935
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
936
    if context.getTemplateFormatVersion() == 1:
937 938 939 940 941 942
      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):
943
        uid = getattr(aq_base(document), 'uid', None)
944 945 946 947 948 949 950 951 952 953 954 955
        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
956
      groups = {}
957
      old_groups = {}
958
      portal = context.getPortalObject()
959 960
      # set safe activities execution order
      original_reindex_parameters = self.setSafeReindexationMode(context)
961 962
      object_key_list = self._getObjectKeyList()
      for path in object_key_list:
963 964 965 966 967
        # 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

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

1030
          # install object
1031
          obj = self._objects[path]
1032 1033 1034 1035
          # 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.
1036
          if getattr(aq_base(obj), 'groups', None) is not None:
1037
            # we must keep original order groups
1038
            # because they change when we add subobjects
1039
            groups[path] = deepcopy(obj.groups)
1040
          # copy the object
1041 1042 1043 1044 1045 1046 1047
          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
1048
                'Cleaning corrupted BTreeFolder2 object at %r.' % (path,))
1049
            obj._initBTrees()
1050
          obj = obj._getCopy(container)
1051
          self.removeProperties(obj, 0)
1052 1053
          __traceback_info__ = (container, object_id, obj)
          container._setObject(object_id, obj)
1054
          obj = container._getOb(object_id)
1055 1056 1057 1058 1059

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

1060 1061
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
1062
          self.REQUEST.set('is_business_template_installation', 1)
1063 1064 1065 1066
          # 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
1067
          obj.isIndexable = ConstantGetter('isIndexable', value=False)
1068 1069
          # keep workflow history if exists
          workflow_history = getattr(obj, 'workflow_history', None)
1070
          obj.manage_afterClone(obj)
1071 1072
          if workflow_history is not None:
            setattr(obj, 'workflow_history', workflow_history)
1073 1074 1075
          del obj.isIndexable
          if getattr(aq_base(obj), 'reindexObject', None) is not None:
            obj.reindexObject()
1076
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
1077
          if portal_type_dict:
1078
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
1079
            wf_chain = portal_type_dict.pop('workflow_chain')
1080 1081
            chain_dict = getChainByType(context)[1]
            default_chain = ''
1082
            chain_dict['chain_%s' % (object_id)] = wf_chain
1083
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
1084 1085
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
1086
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
1087
          if subobjects_dict:
1088
            # get a jar
1089
            connection = self.getConnection(obj)
1090
            # import subobjects
1091
            for subobject_id, subobject_data in subobjects_dict.iteritems():
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
              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))
1103
          if obj.meta_type in ('Z SQL Method',):
1104
            fixZSQLMethod(portal, obj)
1105 1106 1107
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
1108 1109 1110
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
1111
          elif obj.meta_type in ('ERP5 Ram Cache',
1112
                                 'ERP5 Distributed Ram Cache',):
1113 1114
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
1115 1116
          elif (container.meta_type == 'CMF Skins Tool') and \
              (old_obj is not None):
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
            # 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')
1131 1132 1133 1134 1135 1136 1137 1138
          # 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)
1139

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

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

1275
        container.manage_delObjects([object_id])
1276
        if container.aq_parent.meta_type == 'ERP5 Catalog' and not len(container):
1277
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1278
          container.getParentValue().manage_delObjects([container.id])
1279
      except (NotFound, KeyError, BadRequest, AttributeError):
1280
        # object is already backup and/or removed
1281
        pass
1282 1283
    BaseTemplateItem.uninstall(self, context, **kw)

1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
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

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

1331 1332 1333
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1334

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

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1386 1387 1388 1389 1390 1391 1392 1393
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)

1394
  def install(self, context, trashbin, **kw):
1395
    """ When we install a tool that is a type provider not
1396
    registered on types tool, register it into the type provider.
1397
    """
1398 1399 1400 1401
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    for type_container_id, obj in self._objects.iteritems():
1402 1403 1404
      if (interfaces.ITypeProvider.providedBy(obj) and
          type_container_id != types_tool.id and
          type_container_id not in types_tool.type_provider_list):
1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
        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()
1426
    types_tool = portal.portal_types
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436
    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)
1437

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

1479 1480
class CategoryTemplateItem(ObjectTemplateItem):

1481 1482
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1483

1484 1485 1486 1487
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1488 1489
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1490 1491
      keep_workflow_history = self.isKeepWorkflowObject(relative_url)
      obj = self.removeProperties(obj, 1, keep_workflow_history)
1492
      id_list = obj.objectIds()
1493
      if id_list:
1494
        self.build_sub_objects(context, id_list, relative_url)
1495
        for id_ in list(id_list):
1496
          obj._delObject(id_)
1497 1498
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1499 1500 1501 1502 1503

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1504 1505 1506 1507 1508 1509 1510 1511
      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
1512
      _recursiveRemoveUid(obj)
1513 1514
      keep_workflow_history = self.isKeepWorkflowObject(relative_url)
      obj = self.removeProperties(obj, 1, keep_workflow_history)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1515
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1516
      id_list = obj.objectIds()
1517 1518
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1519
        for id_ in list(id_list):
1520
          obj._delObject(id_)
1521
      else:
1522
        for id_ in list(id_list):
1523
          obj._delObject(id_)
1524 1525
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1526

1527 1528 1529
  def beforeInstall(self):
    self._installed_new_category = False

1530
  def onNewObject(self, obj):
1531 1532 1533 1534
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1535
      # reset accessors if we installed a new category
1536
      self.portal_types.resetDynamicDocumentsOnceAtTransactionBoundary()
1537

1538 1539
class SkinTemplateItem(ObjectTemplateItem):

1540 1541
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1542

1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
  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')

1553 1554
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
    # 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

1568
  def install(self, context, trashbin, **kw):
1569
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1570 1571
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1572
    p = context.getPortalObject()
1573
    skin_tool = p.portal_skins
1574
    for relative_url in self._objects.keys():
1575
      # Do not register skin which were explicitely ask not to be installed
1576 1577 1578 1579 1580
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1581 1582 1583
      folder = p.unrestrictedTraverse(relative_url)
      for obj in folder.objectValues(spec=('Z SQL Method',)):
        fixZSQLMethod(p, obj)
1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
      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',
          [])
1600 1601 1602
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1603
      if skin_selection_id in selection_list:
1604
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1605
      else:
1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
        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):
1625
    if not self._objects:
1626 1627
      return
    # export workflow chain
1628 1629 1630
    bta.addObject(self.generateXml(),
                  name='registered_skin_selection',
                  path=self.__class__.__name__)
1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645

  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]
1646 1647 1648
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1649

1650
        if selection_list is default_value:
1651
          create_property = True
1652
          selection_list = self._objects[skin_folder_id]
1653
        else:
1654
          create_property = False
1655 1656 1657 1658 1659
          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])
1660 1661

        # Remove duplicate
1662
        selection_list = list(set(selection_list))
1663 1664 1665
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
1666
              selection_list, type='tokens')
1667 1668 1669
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
1670
              selection_list)
1671 1672

        unregisterSkinFolder(skin_tool, skin_folder,
1673
                             skin_tool.getSkinSelections())
1674
        registerSkinFolder(skin_tool, skin_folder)
1675 1676

  def uninstall(self, context, **kw):
1677 1678 1679
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1680 1681 1682 1683
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1684 1685 1686 1687
      object_keys = self._objects.keys()

    for skin_folder_id in object_keys:
      skin_folder = skin_tool[skin_folder_id]
1688
      current_selection_list = skin_folder.getProperty(
1689
        'business_template_registered_skin_selections', [])
1690
      current_selection_set = set(current_selection_list)
1691

1692 1693 1694
      skin_selection_list = workflow_id = self._objects[skin_folder_id]
      if isinstance(skin_selection_list, str):
        skin_selection_list = skin_selection_list.replace(',', ' ').split(' ')
1695 1696 1697 1698 1699
      for skin_selection in skin_selection_list:
        current_selection_set.remove(skin_selection)

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1700
        skin_folder._updateProperty(
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
            '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)

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


1754
class WorkflowTemplateItem(ObjectTemplateItem):
1755

1756 1757
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1758

1759 1760 1761 1762 1763
  # 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.

1764
  def preinstall(self, context, installed_item, installed_bt, **kw):
1765
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
1766
                                                         installed_item, **kw)
1767 1768 1769 1770
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1771
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1772 1773
      else:
        modified_workflow_dict[modified_object] = state
1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
    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])
1796 1797
    return modified_workflow_dict

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

1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
  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)
1851

1852 1853
class PortalTypeTemplateItem(ObjectTemplateItem):

1854 1855
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1856 1857
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1858 1859 1860
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1861 1862
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1863
      obj = p.unrestrictedTraverse(relative_url)
1864 1865 1866 1867
      # normalize relative_url, not all type informations are stored in
      # "portal_types"
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])

1868
      obj = obj._getCopy(context)
1869
      obj._p_activate()
1870
      for attr in obj.__dict__.keys():
1871 1872 1873 1874 1875 1876
        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',
1877 1878 1879
                                      'last_id', 'uid') or \
            (attr == 'workflow_history' and
             not self.isKeepWorkflowObject(relative_url)):
1880
          delattr(obj, attr)
1881 1882
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1883

1884 1885 1886 1887 1888 1889 1890 1891 1892 1893
  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__
1894
        if klass.__module__ != 'erp5.portal_type':
1895 1896 1897 1898
          portal_type = obj.portal_type
        else:
          portal_type = klass.__name__
        depend = path_dict.get(portal_type)
1899 1900 1901 1902 1903 1904
        # 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
1905 1906
        cache[path] = score = depend and 1 + solveDependency(depend)[0] or 0
      return score, path
1907
    object_key_list.sort(key=solveDependency)
1908 1909
    return object_key_list

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

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

1957
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1958

1959 1960 1961
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

1962
  def build(self, context, **kw):
1963 1964 1965 1966 1967
    # 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
1968
    p = context.getPortalObject()
1969
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1970
    for key in self._archive.keys():
1971 1972 1973
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1974
        workflow = wflist[1]
1975
      else:
1976
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1977
        portal_type = wflist[0][:-2]
1978
        workflow = ''
1979 1980 1981 1982 1983
      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):
1984
          if not self.is_bt_for_diff:
1985 1986 1987
            # 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
1988
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
1989
                       'in chain for portal_type %s' % (workflow_name, portal_type))
1990
        self._objects.setdefault(portal_type, []).append(workflow)
1991
      elif not self.is_bt_for_diff:
1992
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1993
                        'is probably a sign of a missing dependency.'\
1994
                                                    % portal_type
1995

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

  def export(self, context, bta, **kw):
2012
    if not self._objects:
2013 2014 2015
      return
    # export workflow chain
    xml_data = self.generateXml()
2016 2017
    bta.addObject(xml_data, name='workflow_chain_type',
                  path=self.__class__.__name__)
2018 2019 2020 2021 2022 2023

  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
2024
    (default_chain, chain_dict) = getChainByType(context)
2025
    # First convert all workflow_ids into list.
2026 2027
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
2028
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
2029
    # best solution, by default it is 'default_workflow', which is
2030 2031
    # not very usefull
    default_chain = ''
2032 2033
    for path in self._objects:
      if path in update_dict or force:
2034 2035 2036
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2037
            continue
Jérome Perrin's avatar
Jérome Perrin committed
2038 2039
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
2040
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
2041
          continue
2042
        portal_type = path_splitted[-1]
2043 2044
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
2045
          # XXX we don't use the chain (Default) in erp5 so don't keep it
2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065
          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)
2066
            # create the new chain
2067 2068
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
2069 2070
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
2071
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
2072 2073 2074
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
2075
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
2076
        else:
2077
          if context.portal_types.getTypeInfo(portal_type) is None:
2078
            raise ValueError('Cannot chain workflow %r to non existing '
2079 2080 2081 2082 2083
                           '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.
2084 2085
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
2086 2087
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2088

2089 2090
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
2091 2092
    object_path = kw.get('object_path', None)
    if object_path is not None:
2093
      object_key_list = [object_path]
2094
    else:
2095 2096 2097
      object_key_list = self._objects.keys()
    for object_key in object_key_list:
      path_splitted = object_key.split('/', 1)
2098 2099 2100
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
2101 2102 2103 2104 2105 2106 2107 2108 2109 2110
      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]
2111
        else:
2112 2113 2114 2115
          chain_dict[path] = self._chain_string_separator.\
                                                  join(workflow_id_list)
    context.getPortalObject().portal_workflow.\
                                   manage_changeWorkflows('', props=chain_dict)
2116

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

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

2168 2169
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2170

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

  def build(self, context, **kw):
2180
    types_tool = getToolByName(self.getPortalObject(), 'portal_types')
2181
    for key in self._archive.keys():
2182 2183 2184 2185
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
2186
      ob = types_tool.getTypeInfo(portal_type)
2187
      # check properties corresponds to what is defined in site
2188
      if ob is None:
2189 2190
        raise ValueError, "Portal Type %s not found in site" %(portal_type,)
      prop_value = getattr(ob, self.class_property, ())
2191 2192 2193 2194 2195 2196 2197
      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
2198
        raise ValueError, "%s %s not found in portal type %s" % (
2199 2200
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)
2201

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

  def export(self, context, bta, **kw):
2218
    if not self._objects:
2219 2220
      return
    xml_data = self.generateXml(path=None)
2221 2222
    bta.addObject(xml_data, name=self.class_property,
                  path=self.__class__.__name__)
2223

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

2254
  def _importFile(self, file_name, file):
2255
    if not file_name.endswith('.xml'):
2256
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2257
      return
2258
    path, name = posixpath.split(file_name)
2259
    xml = parse(file)
2260
    portal_type_list = xml.findall('portal_type')
2261
    for portal_type in portal_type_list:
2262 2263
      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
2264
      if self.class_property not in id:
2265 2266 2267 2268
        key = '%s/%s' % (self.class_property, id,)
      else:
        key = id
      self._objects[key] = item_type_list
2269 2270

  def install(self, context, trashbin, **kw):
Nicolas Delaby's avatar
Nicolas Delaby committed
2271 2272
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2273 2274
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2275 2276 2277 2278 2279 2280 2281
    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
2282
      if key in update_dict or force:
2283 2284 2285 2286
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2287 2288 2289
        portal_id = key.split('/')[-1]
        type_information = types_tool.getTypeInfo(portal_id)
        if type_information is None:
2290 2291
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2292 2293
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
2294
        object_property_list = getattr(type_information, self.class_property, ())
Nicolas Delaby's avatar
Nicolas Delaby committed
2295 2296 2297 2298 2299 2300 2301 2302 2303
        # 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)
2304
        setattr(type_information, self.class_property, tuple(property_list))
2305

Aurel's avatar
Aurel committed
2306
  def uninstall(self, context, **kw):
2307
    object_path = kw.get('object_path', None)
Nicolas Delaby's avatar
Nicolas Delaby committed
2308 2309
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2310
    if object_path is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
2311
      object_key_list = [object_path]
2312
    else:
Nicolas Delaby's avatar
Nicolas Delaby committed
2313 2314
      object_key_list = self._objects.keys()
    for key in object_key_list:
2315 2316 2317 2318 2319
      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,))
2320 2321
        continue
      property_list = self._objects[key]
2322
      original_property_list = list(getattr(type_information,
2323
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2324 2325
      for id in property_list:
        if id in original_property_list:
2326
          original_property_list.remove(id)
2327
      setattr(type_information, self.class_property, tuple(original_property_list))
2328

2329

2330 2331
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2332
  name = 'Hidden Content Type'
2333 2334
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2335
  business_template_class_property = '_portal_type_hidden_content_type_item'
2336

2337

2338 2339
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2340
  name = 'Property Sheet'
2341 2342
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2343
  business_template_class_property = '_portal_type_property_sheet_item'
2344

2345

2346 2347
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2348
  name = 'Base Category'
2349 2350
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2351
  business_template_class_property = '_portal_type_base_category_item'
2352

2353

2354
class CatalogMethodTemplateItem(ObjectTemplateItem):
2355
  """Template Item for catalog methods.
2356

2357 2358 2359 2360 2361
    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.
  """
2362

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

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

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

2390 2391
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2392

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

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

2402 2403
    for obj in self._objects.values():
      method_id = obj.id
2404 2405
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2406 2407 2408 2409 2410 2411
      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]
2412

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

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

2442 2443 2444
  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))
2445 2446 2447 2448 2449 2450 2451 2452 2453 2454
    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
2455
    path = self.__class__.__name__
2456 2457 2458 2459 2460
    for key in self._objects.keys():
      obj = self._objects[key]
      # export object in xml
      f=StringIO()
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
2461
      bta.addObject(f, key, path=path)
2462 2463
      # add all datas specific to catalog inside one file
      xml_data = self.generateXml(key)
2464
      bta.addObject(xml_data, key + '.catalog_keys', path=path)
2465

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

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

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

2503 2504
    for obj in values:
      method_id = obj.id
2505

2506 2507 2508 2509 2510 2511
      # 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
2512
          elif isinstance(old_value, (list, tuple)):
2513 2514 2515 2516
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2517

2518 2519
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2520
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2521
        if context.getTemplateFormatVersion() == 1:
2522 2523 2524 2525 2526
          if expression and expression.strip():
            # only compile non-empty expressions
            expr_instance = Expression(expression)
          else:
            expr_instance = None
2527 2528
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2529 2530 2531
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2532
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2533 2534 2535 2536
        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, ())
2537
      elif method_id in catalog.filter_dict.keys():
2538
        catalog.filter_dict[method_id]['filtered'] = 0
2539

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

2567 2568 2569 2570 2571 2572
        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)
2573

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

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2610
      if catalog.filter_dict.has_key(method_id):
2611
        del catalog.filter_dict[method_id]
2612

2613
    # uninstall objects
2614
    ObjectTemplateItem.uninstall(self, context, **kw)
2615

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

2650
class ActionTemplateItem(ObjectTemplateItem):
2651 2652

  def __init__(self, id_list, **kw):
2653
    # XXX It's look like ObjectTemplateItem __init__
2654 2655 2656 2657 2658 2659
    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

2660 2661
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2662
      Split path tries to split a complex path such as:
2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680

      "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

2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713
  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
2714
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2715 2716 2717 2718
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2719 2720 2721 2722
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2723 2724 2725
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2726
      # normalize url
2727 2728 2729 2730 2731
      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]
2732 2733
      action = self._getActionCopy(obj, context, value)
      if action is None:
2734 2735 2736
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2737
      key = posixpath.join(url[-2], url[-1], value)
2738 2739
      keep_workflow_history = self.isKeepWorkflowObject(key)
      self._objects[key] = self.removeProperties(action, 1, keep_workflow_history)
2740
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2741

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

2758
          if interfaces.ITypeProvider.providedBy(aq_parent(aq_inner(container))):
2759 2760 2761
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2762 2763
            continue

Julien Muchembled's avatar
Julien Muchembled committed
2764 2765
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2766 2767 2768
          try:
            from Products.CMFCore.interfaces import IActionProvider
          except ImportError:
2769
              # BACK:
2770 2771 2772 2773 2774 2775 2776 2777
              # 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,
2778
                  'Redirected action import',
2779 2780 2781 2782
                  '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
2783
          obj, action = container, obj
2784
          action_list = obj.listActions()
2785
          for index in range(len(action_list)):
2786
            if action_list[index].id == id:
2787
              # remove previous action
2788
              obj.deleteActions(selections=(index,))
2789 2790 2791
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2792
          obj.addAction(
2793
                        id = action.id
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2794
                      , name = action.title
2795
                      , action = action_text
2796 2797 2798 2799
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2800 2801
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2802
                      , priority = action.priority
2803
                      , description = action.description
Aurel's avatar
Aurel committed
2804
                    )
2805
          # sort action based on the priority define on it
2806 2807 2808 2809 2810 2811 2812 2813 2814
          # 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))
2815 2816
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2817
        container.manage_delObjects([obj.id
2818
          for obj in container.getActionInformationList()
2819
          if obj.getReference() in action_dict])
2820 2821 2822
        for name, obj in action_dict.iteritems():
          imported_action = container._importOldAction(obj).aq_base

Aurel's avatar
Aurel committed
2823
    else:
2824
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2825
      p = context.getPortalObject()
2826 2827
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2828
        relative_url, key, value = self._splitPath(id)
2829 2830
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2831
          if getattr(ai, key) == value:
2832
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2833 2834 2835
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2836
        obj.addAction(
Aurel's avatar
Aurel committed
2837 2838
                      id = action.id
                    , name = action.title
2839
                    , action = action_text
Aurel's avatar
Aurel committed
2840 2841 2842 2843
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2844 2845
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2846
                    )
Aurel's avatar
Aurel committed
2847 2848 2849 2850 2851 2852 2853
        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))
2854 2855
          obj.moveDownActions(selections=tuple(move_down_list))

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

2891 2892 2893
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2894
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2895 2896 2897 2898 2899 2900 2901
    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])
2902 2903
      # normalize url
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])
2904
      self._objects[relative_url] = type_role_list = []
2905
      for role in obj.getRoleInformationList():
2906
        type_role_dict = {}
2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923
        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
2924
        type_role_list.append(type_role_dict)
2925
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2926

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

2953 2954 2955
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
2956
    path = self.__class__.__name__
2957 2958
    for key in self._objects.keys():
      xml_data = self.generateXml(key)
2959 2960
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2961
      name = key.split('/', 1)[1]
2962
      bta.addObject(xml_data, name=name, path=path)
2963 2964

  def _importFile(self, file_name, file):
2965 2966 2967
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2968 2969
    type_roles_list = []
    xml = parse(file)
2970
    xml_type_roles_list = xml.findall('role')
2971
    for role in xml_type_roles_list:
2972 2973 2974 2975
      id = role.get('id')
      if isinstance(id, unicode):
        id = id.encode('utf_8', 'backslashreplace')
      type_role_property_dict = {'id': id}
2976
      # uniq
2977 2978 2979 2980 2981 2982 2983 2984
      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
2985
      # multi
2986 2987 2988 2989 2990 2991 2992 2993
      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)
2994
      type_roles_list.append(type_role_property_dict)
2995
    self._objects['portal_type_roles/%s' % (file_name[:-4],)] = type_roles_list
2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006

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

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

3034 3035 3036 3037 3038 3039
class SitePropertyTemplateItem(BaseTemplateItem):

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

3051 3052
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
3053
    if not file_name.endswith('.xml'):
3054
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3055
      return
3056
    xml = parse(file)
3057 3058 3059 3060 3061 3062 3063 3064 3065
    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)
3066

3067 3068 3069
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3070
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3071 3072
      p = context.getPortalObject()
      for path in self._objects.keys():
3073 3074 3075 3076
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
3077
              continue
3078
          dir, id = posixpath.split(path)
3079
          prop_type, property = self._objects[path]
3080 3081 3082 3083 3084 3085 3086 3087
          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
3088
    else:
3089
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
3090
      p = context.getPortalObject()
3091
      for id, property in self._archive.keys():
3092
        property = self._archive[id]
Aurel's avatar
Aurel committed
3093
        if p.hasProperty(id):
3094 3095 3096 3097 3098 3099 3100
          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'])
3101 3102 3103

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3104 3105 3106 3107 3108 3109
    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:
3110 3111 3112 3113
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

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

Aurel's avatar
Aurel committed
3132 3133 3134
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3135 3136 3137 3138
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
3139
      xml_data += self.generateXml(path)
3140
    xml_data += '\n</site_property>'
3141
    bta.addObject(xml_data, name='properties', path=self.__class__.__name__)
3142

3143 3144 3145 3146 3147
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3148 3149 3150 3151 3152 3153
    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()
3154
      permission_list = []
3155
      mapping['permission_list'] = module.showPermissions()
3156
      mapping['category_list'] = module.getCategoryList()
3157
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3158

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

3202
  def export(self, context, bta, **kw):
3203
    if len(self._objects) == 0:
3204
      return
3205
    path = self.__class__.__name__
3206 3207
    keys = self._objects.keys()
    keys.sort()
3208
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
3209
      # export modules one by one
3210
      xml_data = self.generateXml(path=key)
3211
      bta.addObject(xml_data, name=key, path=path)
3212

3213
  def install(self, context, trashbin, **kw):
3214
    portal = context.getPortalObject()
3215 3216
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3217
    if context.getTemplateFormatVersion() == 1:
3218
      items = self._objects
3219
    else:
3220 3221
      items = self._archive

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

  def _importFile(self, file_name, file):
3248 3249 3250
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3251
    mapping = {}
3252
    xml = parse(file)
3253
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3254
      key_node = xml.find(key)
3255
      if key == 'permission_list':
3256 3257 3258 3259 3260 3261 3262
        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))
3263
          else:
3264 3265 3266
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3267
      else:
3268
        mapping[key] = key_node.text or ''
3269 3270

    category_list = []
3271 3272 3273 3274
    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'))
3275 3276
    mapping['category_list'] = category_list

3277
    self._objects[file_name[:-4]] = mapping
3278

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

3303 3304 3305
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3306 3307

class DocumentTemplateItem(BaseTemplateItem):
3308 3309 3310 3311
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3312 3313 3314

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

3318
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3319 3320
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3321
      new_keys = self._objects.keys()
3322
      # fix key if necessary in installed bt for diff
3323
      extra_prefix = self.__class__.__name__ + '/'
3324
      for key in installed_item._objects.keys():
3325 3326 3327 3328
        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]
3329
      for path in new_keys:
3330
        if installed_item._objects.has_key(path):
3331 3332
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3333
          old_obj_code = installed_item._objects[path]
3334
          if new_obj_code != old_obj_code:
3335 3336
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3337
        else: # new object
3338 3339
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3340
          # get removed object
3341
      old_keys = installed_item._objects.keys()
3342 3343
      for path in old_keys:
        if path not in new_keys:
3344 3345
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3346 3347
    return modified_object_list

3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362
  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()

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

  def uninstall(self, context, **kw):
3400
    object_path = kw.get('object_path', None)
3401 3402 3403 3404
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
3405 3406 3407 3408 3409
    if object_keys:
      if isinstance(self, DocumentTemplateItem):
        self._resetDynamicModules()
      for key in object_keys:
        self.local_file_remover_name(key)
3410 3411
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3412 3413 3414
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3415 3416 3417 3418 3419 3420
    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
3421
      bta.addObject(obj, name=key, ext='.py')
Aurel's avatar
Aurel committed
3422

3423
  def _importFile(self, file_name, file):
3424 3425 3426
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3427
    text = file.read()
3428
    self._objects[file_name[:-3]] = text
3429

3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451
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
3452
  _perform_migration = True
3453 3454

  # Only meaningful for filesystem Property Sheets
3455 3456 3457 3458
  local_file_reader_name = staticmethod(readLocalPropertySheet)
  local_file_writer_name = staticmethod(writeLocalPropertySheet)
  local_file_importer_name = staticmethod(importLocalPropertySheet)
  local_file_remover_name = staticmethod(removeLocalPropertySheet)
3459

3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473
  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)

3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562
    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)

3563 3564
    return PropertySheetDocument.importFromFilesystemDefinition(
        property_sheet_tool, klass)
3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580

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

3583 3584 3585
    # careful, that dictionary will change
    class_id_list = migrate_object_dict.keys()
    for class_id in class_id_list:
3586 3587 3588
      # 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
3589
      if class_id in property_sheet_id_set:
Nicolas Delaby's avatar
Typo  
Nicolas Delaby committed
3590
        # XXX a Conduit must be able to merge modifications
3591
        # from FS PropertySheets into ZODB PropertySheets
3592
        warn('Conflict when migrating Property Sheet %s: ' \
3593 3594
             'already exists in portal_property_sheets and '\
             'cannot be updated automatically for now. ' % class_id,
3595
             UserWarning)
3596 3597 3598
        del migrate_object_dict[class_id]
        if class_id in object_dict:
          del object_dict[class_id]
3599
        continue
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

      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

3630
      migrate_object_dict[key] = new_property_sheet.aq_base
3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646
      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)

3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663
    # 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'))
3664 3665 3666

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

3667
class ConstraintTemplateItem(DocumentTemplateItem):
3668 3669 3670 3671
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3672

3673
class ExtensionTemplateItem(DocumentTemplateItem):
3674 3675
  local_file_reader_name = staticmethod(readLocalExtension)
  local_file_writer_name = staticmethod(writeLocalExtension)
3676 3677
  # Extension needs no import
  local_file_importer_name = None
3678
  local_file_remover_name = staticmethod(removeLocalExtension)
3679 3680

class TestTemplateItem(DocumentTemplateItem):
3681 3682
  local_file_reader_name = staticmethod(readLocalTest)
  local_file_writer_name = staticmethod(writeLocalTest)
3683
  # Test needs no import
3684
  local_file_importer_name = None
3685
  local_file_remover_name = staticmethod(removeLocalTest)
3686

Aurel's avatar
Aurel committed
3687

3688 3689 3690
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3691 3692 3693

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3694
  def build(self, context, **kw):
3695 3696
    for key in self._archive.iterkeys():
      self._objects[key] = 1
Aurel's avatar
Aurel committed
3697

3698
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3699 3700
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3701
      new_roles = self._objects.keys()
3702 3703 3704 3705 3706 3707
      # 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]
3708
      for role in new_roles:
3709
        if installed_item._objects.has_key(role):
3710 3711 3712 3713
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
3714
      old_roles = installed_item._objects.keys()
3715 3716 3717 3718 3719 3720
      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):
3721
    p = context.getPortalObject()
3722
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3723
    if context.getTemplateFormatVersion() == 1:
3724
      role_set = set(self._objects)
3725
    else:
3726
      role_set = set(self._archive)
3727 3728 3729 3730
    # 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:
3731 3732
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
3733
    # set roles on portal
3734
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
3735 3736

  def _importFile(self, file_name, file):
3737
    if not file_name.endswith('.xml'):
3738
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3739
      return
3740
    xml = parse(file)
3741 3742 3743
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755

  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)

3756 3757 3758 3759 3760 3761 3762 3763 3764
  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
3765
      if role in roles and role not in new_roles:
3766 3767 3768
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3769
  # Function to generate XML Code Manually
3770 3771
  def generateXml(self):
    role_list = self._objects.keys()
3772
    xml_data = '<role_list>'
3773 3774
    for role in sorted(role_list):
      xml_data += '\n <role>%s</role>' % (role,)
3775
    xml_data += '\n</role_list>'
3776 3777
    return xml_data

Aurel's avatar
Aurel committed
3778
  def export(self, context, bta, **kw):
3779
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
3780
      return
3781 3782 3783 3784 3785 3786 3787 3788
    # 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
3789
    bta.addObject(xml_data, name=path)
3790

3791 3792 3793 3794
class CatalogSearchKeyTemplateItem(BaseTemplateItem):
  key_list_attr = 'sql_catalog_search_keys'
  key_list_title = 'search_key_list'
  key_title = 'Search key'
3795

Aurel's avatar
Aurel committed
3796
  def build(self, context, **kw):
3797
    catalog = _getCatalogValue(self)
3798 3799 3800
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3801
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
3802
    key_list = []
3803
    for key in self._archive.keys():
3804
      if key in catalog_key_list:
3805
        key_list.append(key)
3806
      elif not self.is_bt_for_diff:
3807
        raise NotFound, '%s %r not found in catalog' %(self.key_title, key)
3808
    if len(key_list) > 0:
3809
      self._objects['%s/%s' % (self.__class__.__name__, self.key_list_title)] = key_list
3810 3811

  def _importFile(self, file_name, file):
3812 3813 3814
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3815
    xml = parse(file)
3816 3817
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3818

3819
  def install(self, context, trashbin, **kw):
3820
    catalog = _getCatalogValue(self)
3821 3822 3823
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3824

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

3847
  def uninstall(self, context, **kw):
3848
    catalog = _getCatalogValue(self)
3849 3850 3851
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3852
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
3853
    object_path = kw.get('object_path', None)
3854 3855 3856 3857 3858
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3859 3860 3861
      if key in catalog_key_list:
        catalog_key_list.remove(key)
    setattr(catalog, self.key_list_attr, catalog_key_list)
3862 3863
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3864
  # Function to generate XML Code Manually
3865
  def generateXml(self, path=None):
3866
    obj = self._objects[path]
3867
    xml_data = '<key_list>'
3868 3869
    obj.sort()
    for key in obj:
3870 3871
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3872 3873
    return xml_data

Aurel's avatar
Aurel committed
3874 3875 3876
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3877
    for path in self._objects.keys():
3878
      xml_data = self.generateXml(path=path)
3879
      bta.addObject(xml_data, name=path)
3880

3881 3882 3883 3884
class CatalogResultKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_result_keys'
  key_list_title = 'result_key_list'
  key_title = 'Result key'
3885

3886 3887 3888 3889
class CatalogRelatedKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_related_keys'
  key_list_title = 'related_key_list'
  key_title = 'Related key'
3890

3891
  # override this method to support 'key_list' for backward compatibility.
3892
  def install(self, context, trashbin, **kw):
3893
    catalog = _getCatalogValue(self)
3894 3895 3896
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3897

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

3923 3924 3925 3926
class CatalogResultTableTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_tables'
  key_list_title = 'result_table_list'
  key_title = 'Result table'
3927

3928
# keyword
3929 3930 3931 3932
class CatalogKeywordKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_keyword_search_keys'
  key_list_title = 'keyword_key_list'
  key_title = 'Keyword key'
3933

3934
# datetime
3935 3936 3937 3938
class CatalogDateTimeKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_datetime_search_keys'
  key_list_title = 'datetime_key_list'
  key_title = 'DateTime key'
3939

3940 3941 3942 3943 3944
# 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'
3945

3946 3947 3948 3949 3950
# request
class CatalogRequestKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_request_keys'
  key_list_title = 'request_key_list'
  key_title = 'Request key'
3951

3952 3953 3954 3955 3956
# multivalue
class CatalogMultivalueKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_multivalue_keys'
  key_list_title = 'multivalue_key_list'
  key_title = 'Multivalue key'
3957 3958

# topic
3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977
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'
3978

3979 3980 3981 3982
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
3983 3984 3985
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
3986
      else: # XXX backward compatibility
3987 3988
        lang = lang_key
        catalog = 'erp5_ui'
3989
      path = posixpath.join(lang, catalog)
3990 3991
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
3992 3993 3994
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
3995

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

4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043
  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', {})
4044 4045
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
4046 4047
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4048
          if not force:
4049
            action = update_dict[key]
4050
            if action == 'nothing':
4051
              continue
4052
          lang, catalog = self._splitKey(key)
4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068

          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)
4069 4070
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4071 4072 4073 4074
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4075
            self._importCatalogLanguage(localizer, catalog, lang, po)
4076 4077
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4078
      for lang, catalogs in self._archive.iteritems():
4079 4080 4081
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
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 4109 4110 4111
          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)
4112 4113

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

  def _importFile(self, file_name, file):
4129 4130
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4131 4132
      text = file.read()
      self._objects[file_name[:-3]] = text
4133 4134
    elif name == 'language.xml':
      xml = parse(file)
4135 4136
      name = xml.find('name').text
      code = xml.find('code').text
4137
      self._objects[code] = name
4138

Aurel's avatar
Aurel committed
4139 4140
class LocalRolesTemplateItem(BaseTemplateItem):

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

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

Christophe Dumez's avatar
Christophe Dumez committed
4153
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4154
  def generateXml(self, path=None):
4155
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4156 4157
    # local roles
    xml_data = '<local_roles_item>'
4158
    xml_data += '\n <local_roles>'
4159
    for key in sorted(local_roles_dict):
4160
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4161 4162
      tuple = local_roles_dict[key]
      for item in tuple:
4163 4164 4165 4166
        xml_data += "\n   <item>%s</item>" %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </local_roles>'
    xml_data += '\n</local_roles_item>'
Vincent Pelletier's avatar
Vincent Pelletier committed
4167
    if isinstance(xml_data, unicode):
4168
      xml_data = xml_data.encode('utf8')
Aurel's avatar
Aurel committed
4169
    return xml_data
4170

Aurel's avatar
Aurel committed
4171
  def export(self, context, bta, **kw):
4172 4173
    path = self.__class__.__name__
    for key in self._objects:
Aurel's avatar
Aurel committed
4174
      xml_data = self.generateXml(key)
4175 4176
      assert key[:12] == 'local_roles/'
      bta.addObject(xml_data, key[12:], path=path)
Aurel's avatar
Aurel committed
4177 4178

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

  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
4202 4203
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4204
        local_roles_dict = self._objects[roles_path][0]
4205
        setattr(obj, '__ac_local_roles__', local_roles_dict)
4206
        obj.reindexObject()
Aurel's avatar
Aurel committed
4207

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

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

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

    - site property definition
      - id
      - type
4246
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4247

4248 4249
    - document/propertysheet/extension/test definition
      - copy of the local file
4250

4251
    - message transalation definition
4252
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4253

4254 4255
    The Business Template properties are exported to the bt folder with
    one property per file
4256

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4257 4258
    Technology:

4259 4260
    - 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
4261

4262
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4263 4264 4265 4266

    Use case:

    - install core ERP5 (the minimum)
4267

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

4270 4271
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4272
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4273 4274 4275 4276 4277
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4278
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4279 4280 4281

    # Declarative security
    security = ClassSecurityInfo()
4282
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4283 4284 4285 4286

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4287
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4288
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4289
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4290
                      , PropertySheet.BusinessTemplate
4291
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4292 4293
                      )

4294 4295 4296 4297 4298 4299
    # 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."""
4300
         , 'icon'           : 'file_icon.gif'
4301 4302
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
4303
         , 'type_class'     : 'BusinessTemplate'
4304 4305 4306 4307 4308 4309 4310
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

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

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4367 4368 4369 4370 4371 4372
      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
4373
        self._baseGetTemplateFormatVersion()
4374

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4375 4376 4377
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4378

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4379
      return 0
4380

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

4396 4397
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4398 4399 4400 4401 4402 4403
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4404
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4405 4406 4407 4408 4409 4410 4411 4412
        """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)
4413

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

4523 4524 4525 4526 4527 4528 4529 4530 4531 4532
    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()

4533
      try:
Julien Muchembled's avatar
Julien Muchembled committed
4534 4535 4536 4537 4538 4539
        from Products.ERP5VCS.WorkingCopy import NotAWorkingCopyError
        try:
          self.setRevision(self.getVcsTool().newRevision())
        except NotAWorkingCopyError:
          raise ImportError
      except ImportError:
4540
        self.updateRevisionNumber()
4541 4542 4543
      self._setTemplateFormatVersion(1)
      self.storeTemplateItemData()

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

4551
    build = WorkflowMethod(build)
4552 4553

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

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

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

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

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

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

4608
      # if reinstall business template, must compare to object in ZODB
4609
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4610
      # same if we make a diff and select only one business template
4611
      reinstall = 0
4612 4613
      if installed_bt == self:
        reinstall = 1
4614
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
4615 4616
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                   id=INSTALLED_BT_FOR_DIFF)
4617 4618 4619 4620 4621 4622 4623
          # 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)
4624

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

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

4655 4656
      return modified_object_list

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

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

4679
      trash_tool = getToolByName(site, 'portal_trash', None)
4680 4681 4682
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4683 4684 4685
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4686

4687 4688 4689
      if not force:
        self.checkDependencies()

4690 4691
      # 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
4692
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 2):
4693 4694 4695 4696 4697
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
4698
      if len(object_to_update) or force:
4699 4700 4701
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
4702 4703
            item.install(self, force=force, object_to_update=object_to_update, 
                               trashbin=trashbin, installed_bt=installed_bt)
4704

4705
      # update catalog if necessary
4706 4707 4708
      if update_catalog is _MARKER and force and self.isCatalogUpdatable():
        # override update_catalog parameter only if value
        # is not explicitely passed.
4709
        update_catalog = 1
4710
      elif update_catalog is _MARKER:
4711
        update_catalog = 0
4712
      if update_catalog:
4713
        catalog = _getCatalogValue(self)
4714
        if (catalog is None) or (not site.isIndexable):
4715 4716 4717 4718 4719
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4720

4721
      # get objects to remove
4722
      # do remove after because we may need backup object from installation
4723
      remove_object_dict = {}
4724 4725
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
4726
          remove_object_dict[path] = action
4727

4728
      # remove object from old business template
4729
      if len(remove_object_dict):
4730
        # XXX: this code assumes that there is an installed_bt
4731
        for item_name in reversed(installed_bt._item_name_list):
4732
          item = getattr(installed_bt, item_name, None)
4733
          if item is not None:
4734
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
4735

4736 4737

      # update tools if necessary
4738 4739 4740 4741 4742
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        from Products.ERP5.ERP5Site import ERP5Generator
        gen = getattr(site, '_generator_class', ERP5Generator)()
        LOG('Business Template', 0, 'Updating Tools')
        gen.setup(site, 0, update=1)
4743

4744 4745
      # remove trashbin if empty
      if trashbin is not None:
4746
        if len(trashbin) == 0:
4747 4748
          trash_tool.manage_delObjects([trashbin.getId(),])

4749 4750
      if update_catalog:
        site.ERP5Site_reindexAll()
4751

4752 4753
      # Update translation table, in case we added new portal types or
      # workflow states.
4754 4755
      if update_translation:
        site.ERP5Site_updateTranslationTable()
4756

4757 4758
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
4759

4760
    security.declareProtected(Permissions.ManagePortal, 'install')
4761 4762 4763
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4764
      """
4765
      return self._install(**kw)
4766

4767
    install = WorkflowMethod(install)
4768

4769
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4770
    def reinstall(self, **kw):
4771 4772 4773 4774
      """Reinstall Business Template.
      """
      return self._install(**kw)

4775
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4776

4777
    security.declareProtected(Permissions.ManagePortal, 'trash')
4778 4779
    def trash(self, new_bt, **kw):
      """
4780
        Trash unnecessary items before upgrading to a new business
4781
        template.
4782
        This is similar to uninstall, but different in that this does
4783
        not remove all items.
4784
      """
4785 4786
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4787
        item = getattr(self, item_name, None)
4788 4789
        if item is not None:
          item.trash(
4790
                self,
4791
                getattr(new_bt, item_name))
4792

4793
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
4794
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4795
      """
4796
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4797
      """
4798 4799 4800
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4801
        item = getattr(self, item_name, None)
4802
        if item is not None:
4803
          item.uninstall(self, **kw)
4804
      # It is better to clear cache because the uninstallation of a
4805
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
4806
      self.getPortalObject().portal_caches.clearAllCache()
4807

4808 4809
    uninstall = WorkflowMethod(uninstall)

4810
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4811
    def _clean(self):
4812
      """
4813
        Clean built information.
4814
      """
4815
      # First, remove obsolete attributes if present.
4816 4817 4818 4819
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4820
                    '_module_archive',
4821 4822 4823
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4824
                    '_property_sheet_archive'):
4825 4826 4827
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4828 4829
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4830

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

4833
    security.declareProtected(Permissions.AccessContentsInformation,
4834
                              'getBuildingState')
4835
    def getBuildingState(self, default=None, id_only=1):
4836
      """
4837
        Returns the current state in building
4838
      """
4839
      portal_workflow = getToolByName(self, 'portal_workflow')
4840 4841
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4842
      return wf._getWorkflowStateOf(self, id_only=id_only )
4843

4844
    security.declareProtected(Permissions.AccessContentsInformation,
4845
                              'getInstallationState')
4846
    def getInstallationState(self, default=None, id_only=1):
4847
      """
4848
        Returns the current state in installation
4849
      """
4850
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
4851 4852
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4853
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4854

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4855 4856 4857 4858 4859 4860
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4861
      export_string = portal_templates.manage_exportObject(
4862 4863
                                               id=self.getId(),
                                               toxml=1,
4864
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4865
      return export_string
4866

4867
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4868
      """
4869 4870
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4871
      """
4872 4873
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
4874 4875 4876 4877
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4878
        # XXX Why do we need to return a tuple ?
4879 4880
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4881

4882
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4883
      """
4884 4885
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4886
      """
4887
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4888

4889
    def getTemplateBaseCategoryList(self):
4890
      """
4891 4892
      We have to set this method because we want an
      ordered list
4893
      """
4894
      return self._getOrderedList('template_base_category')
4895

4896
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4897
      """
4898 4899
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4900
      """
4901
      return self._getOrderedList('template_workflow_id')
4902

4903
    def getTemplatePortalTypeIdList(self):
4904
      """
4905 4906
      We have to set this method because we want an
      ordered list
4907
      """
4908
      return self._getOrderedList('template_portal_type_id')
4909

4910 4911 4912 4913 4914 4915 4916
    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
4917 4918 4919 4920 4921 4922 4923
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

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

4931 4932 4933 4934 4935 4936
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4937

4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958
    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')

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

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

4973
    def getTemplateLocalRoleList(self):
4974 4975 4976 4977
      """
      We have to set this method because we want an
      ordered list
      """
4978
      return self._getOrderedList('template_local_role')
4979

4980
    def getTemplateSkinIdList(self):
4981
      """
4982 4983
      We have to set this method because we want an
      ordered list
4984
      """
4985
      return self._getOrderedList('template_skin_id')
4986

4987 4988 4989 4990 4991 4992 4993
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

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

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

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

5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038
    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

5039 5040 5041 5042 5043 5044
    def getExportPath(self):
      preferences = self.getPortalObject().portal_preferences
      bt_name = self.getTitle()
      from App.config import getConfiguration
      instance_home = getConfiguration().instancehome
      for path in (preferences.getPreferredWorkingCopyList() or # BBB
5045
                   preferences.getPreferredSubversionWorkingCopyList() or ['bt5']):
5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056
        if not os.path.isabs(path):
          path = os.path.join(instance_home, path)
        bt_path = os.path.join(path, bt_name)
        if os.path.isdir(bt_path):
          return bt_path
        for bt_path in glob.glob(os.path.join(path, '*', bt_name)):
          if os.path.isdir(bt_path):
            return bt_path

    @transactional_cached(lambda self, vcs=None, path=None: (self, vcs, path))
    def getVcsTool(self, vcs=None, path=None):
5057
      from Products.ERP5VCS.WorkingCopy import getVcsTool
5058 5059 5060 5061 5062 5063
      if not (path or vcs):
        path = self.getExportPath()
      return getVcsTool(vcs=vcs, path=path).__of__(self)

    def isVcsType(self, *vcs):
      # could be moved to Products.ERP5.Base.Base
5064
      from Products.ERP5VCS.WorkingCopy import NotAWorkingCopyError
5065 5066 5067 5068 5069
      try:
        return self.getVcsTool().reference in vcs
      except NotAWorkingCopyError:
        return None in vcs

5070
    security.declareProtected(Permissions.ManagePortal, 'export')
5071
    def export(self, path=None, local=0, bta=None, **kw):
Aurel's avatar
Aurel committed
5072 5073 5074
      """
        Export this Business Template
      """
5075
      if self.getBuildingState() != 'built':
5076
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5077
              'Business Template must be built before export'
5078

5079 5080 5081 5082 5083 5084 5085 5086 5087
      if bta is None:
        if local:
          # we export into a folder tree
          bta = BusinessTemplateFolder(creation=1, path=path)
        else:
          # We export BT into a tarball file
          if path is None:
            path = self.getTitle()
          bta = BusinessTemplateTarball(creation=1, path=path)
Aurel's avatar
Aurel committed
5088

5089
      # export bt
Aurel's avatar
Aurel committed
5090
      for prop in self.propertyMap():
5091
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5092
        id = prop['id']
5093
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5094
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5095
          continue
Aurel's avatar
Aurel committed
5096
        value = self.getProperty(id)
5097
        if not value:
5098
          continue
5099
        if prop_type in ('text', 'string', 'int', 'boolean'):
5100
          bta.addObject(str(value), name=id, path='bt', ext='')
5101
        elif prop_type in ('lines', 'tokens'):
5102
          bta.addObject('\n'.join(value), name=id, path='bt', ext='')
5103

Aurel's avatar
Aurel committed
5104 5105 5106
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5107

5108
      return bta.finishCreation()
Aurel's avatar
Aurel committed
5109

5110
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5111 5112
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5113
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5114 5115 5116 5117 5118
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
5119 5120

      self.storeTemplateItemData()
5121

5122 5123
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5124 5125
      # XXX This is not required with portal types as classes.
      #     It is still there for compatibility with non-migrated objects.
5126
      module_id_list = []
5127
      for template_id in self.getTemplateDocumentIdList():
5128 5129 5130
        module_id = 'Products.ERP5Type.Document.' + template_id
        if module_id not in sys.modules:
          module_id_list.append(module_id)
5131
          sys.modules[module_id] = module = imp.new_module(module_id)
5132 5133
          setattr(module, template_id, type(template_id,
            (SimpleItem.SimpleItem,), {'__module__': module_id}))
5134

Aurel's avatar
Aurel committed
5135 5136
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5137

5138 5139
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5140 5141
      for module_id in module_id_list:
        del sys.modules[module_id]
5142

5143 5144 5145 5146 5147
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5148 5149 5150
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5151
      return items_list
5152

5153 5154 5155 5156 5157 5158
    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
      """
5159 5160 5161 5162 5163 5164 5165 5166
      missing_dep_list = self.getMissingDependencyList()
      if len(missing_dep_list) != 0:
        raise BusinessTemplateMissingDependency, 'Impossible to install, please install the following dependencies before: %s'%repr(missing_dep_list)

    def getMissingDependencyList(self):
      """
      Retuns a list of missing dependencies.
      """
5167 5168
      missing_dep_list = []
      dependency_list = self.getDependencyList()
5169
      if len(dependency_list) > 0:
5170
        for dependency_couple in dependency_list:
5171
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5172
          dependency = dependency_couple_list[0]
5173 5174
          if dependency in (None, ''):
            continue
5175 5176
          version_restriction = None
          if len(dependency_couple_list) > 1:
5177
            version_restriction = dependency_couple_list[1]
5178 5179 5180
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5181 5182 5183
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5184
                  or (version_restriction not in (None, '') and
5185 5186
                     (not self.portal_templates.compareVersionStrings(installed_bt.getVersion(), version_restriction)))):
            missing_dep_list.append((dependency, version_restriction or ''))
5187
      return [' '.join([y for y in x if y]) for x in missing_dep_list]
5188

5189 5190 5191
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
5192
        This is compatible with ERP5VCS look and feel but
5193 5194 5195 5196
        it is preferred in future we use more difflib python library.
      """
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

Aurel's avatar
Aurel committed
5197
    def diffObject(self, REQUEST, **kw):
5198 5199
      """
        Make a diff between an object in the Business Template
5200
        and the same in the Business Template installed in the site
5201 5202 5203 5204
      """

      class_name_dict = {
        'Product' : '_product_item',
5205
        'PropertySheet' : '_property_sheet_item',
5206
        'Constraint' : '_constraint_item',
5207 5208 5209 5210 5211 5212 5213 5214 5215
        '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',
5216
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5217 5218 5219 5220
        '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',
5221 5222 5223
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5224
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5225
        'Path' : '_path_item',
5226
        'Preference' : '_preference_item',
5227
        'Action' : '_action_item',
5228
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5229
        'LocalRoles' : '_local_roles_item',
5230 5231 5232
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5233
        'CatalogSearchKey' : '_catalog_search_key_item',
5234
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5235
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5236 5237 5238 5239
        '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
5240
        'Tool': '_tool_item',
5241
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5242 5243
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5244
        }
5245

5246 5247
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5248

Christophe Dumez's avatar
Christophe Dumez committed
5249
      # Get objects
5250
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5251

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

5274 5275
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5276
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5277
        # XXX maybe only build for the given object to gain time
5278
        installed_item.build(self)
5279 5280 5281
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5282

Christophe Dumez's avatar
Christophe Dumez committed
5283
      # Real Zope Objects (can be exported into XML directly by Zope)
5284 5285
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5286
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5287
                     '_skin_item', '_action_item', '_tool_item', ]
5288

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

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

5320
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5321 5322 5323
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5324 5325
        new_object = new_item.removeProperties(new_object, 1)
        installed_object = installed_item.removeProperties(installed_object, 1)
5326
        # XML Export in memory
5327
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5328 5329
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5330
        new_obj_xml = f1.getvalue()
5331
        f1.close()
5332 5333 5334 5335
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5336
        # End of XML export
5337

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

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

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

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

5373
      else:
5374
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5375

5376
      if compare_to_zodb:
5377
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5378

5379
      return diff_msg
5380

5381

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

5397
      p = self.getPortalObject()
5398
      for id in bt_portal_types_id_list:
5399 5400
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5401
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5402
        if portal_type.getRoleInformationList():
5403 5404
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5405

5406 5407 5408 5409
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5410
        action_list = []
5411 5412 5413 5414 5415 5416 5417
        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'):
5418
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5419 5420
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5421

5422 5423 5424 5425
        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)
5426

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

5432 5433 5434 5435
        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)
5436

5437 5438 5439 5440
        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)
5441

5442 5443 5444 5445
        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)
5446

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

5453 5454 5455 5456
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5457
      bt_action_list.sort()
5458
      bt_wf_chain_list.sort()
5459

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

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

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

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

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