BusinessTemplate.py 221 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
    # 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
778
      p.Parse(data)
779 780 781 782 783 784 785 786 787 788 789

      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 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
          # START:part of ERP5Type.CopySupport.manage_afterClone
          # * reset uid
          # * reset owner
          # * do not reset workflow
          # * do not call recursively
          # * do not call type-based afterClone script
          #
          # Change uid attribute so that Catalog thinks object was not yet catalogued
          aq_base(obj).uid = portal.portal_catalog.newUid()
          # Give the Owner local role to the current user, zope only does this if no
          # local role has been defined on the object, which breaks ERP5Security
          if getattr(aq_base(obj), '__ac_local_roles__', None) is not None:
            user=getSecurityManager().getUser()
            if user is not None:
              userid=user.getId()
              if userid is not None:
                #remove previous owners
                local_role_dict = obj.__ac_local_roles__
                removable_role_key_list = []
                for key, value in local_role_dict.items():
                  if 'Owner' in value:
                    value.remove('Owner')
                  if len(value) == 0:
                    removable_role_key_list.append(key)
                # there is no need to keep emptied keys after cloning, it makes
                # unstable local roles -- if object is cloned it can be different when
                # after being just added
                for key in removable_role_key_list:
                  local_role_dict.pop(key)
                #add new owner
                l=local_role_dict.setdefault(userid, [])
                l.append('Owner')
          # END:part of ERP5Type.CopySupport.manage_afterClone
1101 1102 1103
          del obj.isIndexable
          if getattr(aq_base(obj), 'reindexObject', None) is not None:
            obj.reindexObject()
1104
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
1105
          if portal_type_dict:
1106
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
1107
            wf_chain = portal_type_dict.pop('workflow_chain')
1108 1109
            chain_dict = getChainByType(context)[1]
            default_chain = ''
1110
            chain_dict['chain_%s' % (object_id)] = wf_chain
1111
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
1112 1113
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
1114
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
1115
          if subobjects_dict:
1116
            # get a jar
1117
            connection = self.getConnection(obj)
1118
            # import subobjects
1119
            for subobject_id, subobject_data in subobjects_dict.iteritems():
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
              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))
1131
          if obj.meta_type in ('Z SQL Method',):
1132
            fixZSQLMethod(portal, obj)
1133 1134 1135
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
1136 1137 1138
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
1139
          elif obj.meta_type in ('ERP5 Ram Cache',
1140
                                 'ERP5 Distributed Ram Cache',):
1141 1142
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
1143 1144
          elif (container.meta_type == 'CMF Skins Tool') and \
              (old_obj is not None):
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
            # 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')
1159 1160 1161 1162 1163 1164 1165 1166
          # 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)
1167

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

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

1303
        container.manage_delObjects([object_id])
1304
        if container.aq_parent.meta_type == 'ERP5 Catalog' and not len(container):
1305
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1306
          container.getParentValue().manage_delObjects([container.id])
1307
      except (NotFound, KeyError, BadRequest, AttributeError):
1308
        # object is already backup and/or removed
1309
        pass
1310 1311
    BaseTemplateItem.uninstall(self, context, **kw)

1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
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

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

1359 1360 1361
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1362

1363 1364 1365 1366 1367 1368 1369 1370 1371
      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.
1372 1373 1374
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1375
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1376 1377
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1378
      if object_id != "":
1379
        path_list.extend(self._resolvePath(
1380
            folder._getOb(object_id),
1381
            relative_url_list + [object_id], id_list[1:]))
1382
    return path_list
Aurel's avatar
Aurel committed
1383

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1414 1415 1416 1417 1418 1419 1420 1421
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)

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

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

1507 1508
class CategoryTemplateItem(ObjectTemplateItem):

1509 1510
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1511

1512 1513 1514 1515
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1516 1517
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1518 1519
      keep_workflow_history = self.isKeepWorkflowObject(relative_url)
      obj = self.removeProperties(obj, 1, keep_workflow_history)
1520
      id_list = obj.objectIds()
1521
      if id_list:
1522
        self.build_sub_objects(context, id_list, relative_url)
1523
        for id_ in list(id_list):
1524
          obj._delObject(id_)
1525 1526
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1527 1528 1529 1530 1531

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

1555 1556 1557
  def beforeInstall(self):
    self._installed_new_category = False

1558
  def onNewObject(self, obj):
1559 1560 1561 1562
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1563
      # reset accessors if we installed a new category
1564
      self.portal_types.resetDynamicDocumentsOnceAtTransactionBoundary()
1565

1566 1567
class SkinTemplateItem(ObjectTemplateItem):

1568 1569
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1570

1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
  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')

1581 1582
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595
    # 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

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

  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]
1674 1675 1676
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1677

1678
        if selection_list is default_value:
1679
          create_property = True
1680
          selection_list = self._objects[skin_folder_id]
1681
        else:
1682
          create_property = False
1683 1684 1685 1686 1687
          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])
1688 1689

        # Remove duplicate
1690
        selection_list = list(set(selection_list))
1691 1692 1693
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
1694
              selection_list, type='tokens')
1695 1696 1697
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
1698
              selection_list)
1699 1700

        unregisterSkinFolder(skin_tool, skin_folder,
1701
                             skin_tool.getSkinSelections())
1702
        registerSkinFolder(skin_tool, skin_folder)
1703 1704

  def uninstall(self, context, **kw):
1705 1706 1707
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1708 1709 1710 1711
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1712 1713 1714 1715
      object_keys = self._objects.keys()

    for skin_folder_id in object_keys:
      skin_folder = skin_tool[skin_folder_id]
1716
      current_selection_list = skin_folder.getProperty(
1717
        'business_template_registered_skin_selections', [])
1718
      current_selection_set = set(current_selection_list)
1719

1720
      skin_selection_list = self._objects[skin_folder_id]
1721 1722
      if isinstance(skin_selection_list, str):
        skin_selection_list = skin_selection_list.replace(',', ' ').split(' ')
1723 1724 1725 1726 1727
      for skin_selection in skin_selection_list:
        current_selection_set.remove(skin_selection)

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1728
        skin_folder._updateProperty(
1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742
            '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)

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


1781
class WorkflowTemplateItem(ObjectTemplateItem):
1782

1783 1784
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1785

1786 1787 1788 1789 1790
  # 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.

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

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

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

1879 1880
class PortalTypeTemplateItem(ObjectTemplateItem):

1881 1882
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1883 1884
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1885 1886 1887
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1888 1889
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1890
      obj = p.unrestrictedTraverse(relative_url)
1891 1892 1893 1894
      # normalize relative_url, not all type informations are stored in
      # "portal_types"
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])

1895
      obj = obj._getCopy(context)
1896
      obj._p_activate()
1897
      for attr in obj.__dict__.keys():
1898 1899 1900 1901 1902 1903
        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',
1904 1905 1906
                                      'last_id', 'uid') or \
            (attr == 'workflow_history' and
             not self.isKeepWorkflowObject(relative_url)):
1907
          delattr(obj, attr)
1908 1909
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1910

1911 1912 1913 1914 1915 1916 1917 1918 1919 1920
  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__
1921
        if klass.__module__ != 'erp5.portal_type':
1922 1923 1924 1925
          portal_type = obj.portal_type
        else:
          portal_type = klass.__name__
        depend = path_dict.get(portal_type)
1926 1927 1928 1929 1930 1931
        # 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
1932 1933
        cache[path] = score = depend and 1 + solveDependency(depend)[0] or 0
      return score, path
1934
    object_key_list.sort(key=solveDependency)
1935 1936
    return object_key_list

1937 1938
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1939 1940 1941 1942
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1943 1944
    # We now need to setup the list of workflows corresponding to
    # each portal type
1945
    (default_chain, chain_dict) = getChainByType(context)
1946
    # Set the default chain to the empty string is probably the
1947
    # best solution, by default it is 'default_workflow', which is
1948
    # not very usefull
1949
    default_chain = ''
1950 1951 1952 1953
    if context.getTemplateFormatVersion() == 1:
      object_list = self._objects
    else:
      object_list = self._archive
1954
    for path in object_list.keys():
1955 1956 1957 1958
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1959
            continue
1960 1961
        obj = object_list[path]
        portal_type = obj.id
1962 1963 1964
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1965 1966
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1967

1968 1969
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1970 1971 1972
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
1973
      result_dict = {}
1974
      xml = parse(file)
1975
      chain_list = xml.findall('//chain')
1976
      for chain in chain_list:
1977 1978 1979 1980
        portal_type = chain.find('type').text
        workflow = chain.find('workflow').text or ''
        result_dict[portal_type] = workflow
      self._workflow_chain_archive = result_dict
1981 1982 1983
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1984
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1985

1986 1987 1988
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

1989
  def build(self, context, **kw):
1990 1991 1992 1993 1994
    # 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
1995
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1996
    for key in self._archive.keys():
1997 1998 1999
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
2000
        workflow = wflist[1]
2001
      else:
2002
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
2003
        portal_type = wflist[0][:-2]
2004
        workflow = ''
2005 2006 2007 2008 2009
      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):
2010
          if not self.is_bt_for_diff:
2011 2012 2013
            # 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
2014
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
2015
                       'in chain for portal_type %s' % (workflow_name, portal_type))
2016
        self._objects.setdefault(portal_type, []).append(workflow)
2017
      elif not self.is_bt_for_diff:
2018
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
2019
                        'is probably a sign of a missing dependency.'\
2020
                                                    % portal_type
2021

Christophe Dumez's avatar
Christophe Dumez committed
2022
  # Function to generate XML Code Manually
2023 2024
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
2025 2026 2027
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2028
      workflow_list = self._objects[key]
2029 2030
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
2031 2032
      xml_data += '\n  <workflow>%s</workflow>' %(
        self._chain_string_separator.join(sorted(workflow_list)))
2033 2034
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
2035 2036 2037
    return xml_data

  def export(self, context, bta, **kw):
2038
    if not self._objects:
2039 2040 2041
      return
    # export workflow chain
    xml_data = self.generateXml()
2042 2043
    bta.addObject(xml_data, name='workflow_chain_type',
                  path=self.__class__.__name__)
2044 2045 2046 2047

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2048 2049 2050 2051 2052 2053
    installed_bt = kw.get('installed_bt')
    if installed_bt is not None:
      previous_portal_type_workflow_chain_list = list(installed_bt\
          .getTemplatePortalTypeWorkflowChainList())
    else:
      previous_portal_type_workflow_chain_list = []
2054 2055
    # We now need to setup the list of workflows corresponding to
    # each portal type
2056
    (default_chain, chain_dict) = getChainByType(context)
2057
    # First convert all workflow_ids into list.
2058 2059
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
2060
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
2061
    # best solution, by default it is 'default_workflow', which is
2062 2063
    # not very usefull
    default_chain = ''
2064 2065
    for path in self._objects:
      if path in update_dict or force:
2066 2067 2068
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2069
            continue
Jérome Perrin's avatar
Jérome Perrin committed
2070 2071
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
2072
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
2073
          continue
2074
        portal_type = path_splitted[-1]
2075 2076
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
2077
          # XXX we don't use the chain (Default) in erp5 so don't keep it
2078 2079 2080 2081 2082 2083
          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]
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103
          # fetch list of new workflows which shall be added to chains
          addative_workflow_id_list = [q.lstrip('+') for q in workflow_id_list\
              if not q.startswith('-') and not q.startswith('=')]
          for previous_line in [q for q in \
              previous_portal_type_workflow_chain_list \
              if q.startswith(portal_type)]:
            previous_portal_type, previous_workflow_id = previous_line.split(
                '|')
            previous_portal_type = previous_portal_type.strip()
            previous_workflow_id = previous_workflow_id.strip()
            if not previous_workflow_id.startswith('-') \
                and not previous_workflow_id.startswith('='):
              # else: nothing can be done if previously workflow was removed
              # or replaced as this requires introspection on global system
              previous_workflow_id = previous_workflow_id.lstrip('+')
              if previous_workflow_id not in addative_workflow_id_list:
                # In previous Business Template workflow was chained with
                # portal type, but current Business Template cancels this
                # so it shall be removed
                workflow_id_list.append('-%s' % previous_workflow_id)
2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114
          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
            else:
Łukasz Nowak's avatar
Łukasz Nowak committed
2115
              wf_id = wf_id.lstrip('+')
2116
              old_chain_workflow_id_set.add(wf_id)
2117
            # create the new chain
2118 2119
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
2120 2121
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
2122
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
2123 2124 2125
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
2126
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
2127
        else:
2128
          if context.portal_types.getTypeInfo(portal_type) is None:
2129
            raise ValueError('Cannot chain workflow %r to non existing '
2130 2131 2132 2133 2134
                           '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.
2135 2136
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
2137 2138
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2139

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

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

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

2219 2220
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2221

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

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

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

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

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

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

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

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

2379

2380 2381
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2382
  name = 'Hidden Content Type'
2383 2384
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2385
  business_template_class_property = '_portal_type_hidden_content_type_item'
2386

2387

2388 2389
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2390
  name = 'Property Sheet'
2391 2392
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2393
  business_template_class_property = '_portal_type_property_sheet_item'
2394

2395

2396 2397
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2398
  name = 'Base Category'
2399 2400
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2401
  business_template_class_property = '_portal_type_base_category_item'
2402

2403

2404
class CatalogMethodTemplateItem(ObjectTemplateItem):
2405
  """Template Item for catalog methods.
2406

2407 2408 2409 2410 2411
    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.
  """
2412

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

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

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

2440 2441
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2442

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

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

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

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

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

2492 2493 2494
  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))
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504
    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
2505
    path = self.__class__.__name__
2506 2507 2508 2509 2510
    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)
2511
      bta.addObject(f, key, path=path)
2512 2513
      # add all datas specific to catalog inside one file
      xml_data = self.generateXml(key)
2514
      bta.addObject(xml_data, key + '.catalog_keys', path=path)
2515

2516 2517
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2518
    catalog = _getCatalogValue(self)
2519 2520 2521 2522 2523 2524 2525
    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)
2526

2527 2528 2529
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2530
    new_bt_format = context.getTemplateFormatVersion()
2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546

    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':
2547
              continue
2548 2549 2550 2551
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2552

2553 2554
    for obj in values:
      method_id = obj.id
2555

2556 2557 2558 2559 2560 2561
      # 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
2562
          elif isinstance(old_value, (list, tuple)):
2563 2564 2565 2566
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2567

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

2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615
      # 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)
2616

2617 2618 2619 2620 2621 2622
        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)
2623

2624
  def uninstall(self, context, **kw):
2625
    catalog = _getCatalogValue(self)
2626 2627 2628
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2629

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2660
      if catalog.filter_dict.has_key(method_id):
2661
        del catalog.filter_dict[method_id]
2662

2663
    # uninstall objects
2664
    ObjectTemplateItem.uninstall(self, context, **kw)
2665

2666
  def _importFile(self, file_name, file):
2667
    if file_name.endswith('.catalog_keys.xml'):
2668
      # recreate data mapping specific to catalog method
2669 2670
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2671
      xml = parse(file)
2672
      method_list = xml.findall('item')
2673
      for method in method_list:
2674 2675 2676
        key = method.get('key')
        key_type = method.get('type')
        value_node = method.find('value')
2677
        if key_type == "str":
2678
          value = value_node.text or ''
2679
        elif key_type == "int":
2680
          value = int(value_node.text)
2681
        elif key_type == "tuple":
2682
          value = tuple([value_node.text for value_node in method.findall('value')])
2683
        else:
2684
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2685
          continue
2686
        if key in catalog_method_list or key in catalog_method_filter_list:
2687
          getattr(self, key)[id] = value
2688 2689 2690
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2691 2692
    elif file_name.endswith('.xml'):
      # just import xml object
2693
      connection = self.getConnection(self.aq_parent)
2694
      obj = connection.importFile(file, customImporters=customImporters)
2695
      self.removeProperties(obj, 0)
2696 2697 2698
      self._objects[file_name[:-4]] = obj
    else:
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2699

2700
class ActionTemplateItem(ObjectTemplateItem):
2701 2702

  def __init__(self, id_list, **kw):
2703
    # XXX It's look like ObjectTemplateItem __init__
2704 2705 2706 2707 2708 2709
    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

2710 2711
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2712
      Split path tries to split a complex path such as:
2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730

      "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

2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763
  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
2764
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2765 2766 2767 2768
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2769 2770 2771 2772
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2773 2774 2775
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2776
      # normalize url
2777 2778 2779 2780 2781
      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]
2782 2783
      action = self._getActionCopy(obj, context, value)
      if action is None:
2784 2785 2786
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2787
      key = posixpath.join(url[-2], url[-1], value)
2788 2789
      keep_workflow_history = self.isKeepWorkflowObject(key)
      self._objects[key] = self.removeProperties(action, 1, keep_workflow_history)
2790
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2791

2792 2793 2794
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2795
    if context.getTemplateFormatVersion() == 1:
2796
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2797 2798
      p = context.getPortalObject()
      for id in self._objects.keys():
2799 2800 2801 2802 2803
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2804 2805 2806
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2807

2808
          if interfaces.ITypeProvider.providedBy(aq_parent(aq_inner(container))):
2809 2810 2811
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2812 2813
            continue

Julien Muchembled's avatar
Julien Muchembled committed
2814 2815
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2816 2817 2818
          try:
            from Products.CMFCore.interfaces import IActionProvider
          except ImportError:
2819
              # BACK:
2820 2821 2822 2823 2824 2825 2826 2827
              # 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,
2828
                  'Redirected action import',
2829 2830 2831 2832
                  '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
2833
          obj, action = container, obj
2834
          action_list = obj.listActions()
2835
          for index in range(len(action_list)):
2836
            if action_list[index].id == id:
2837
              # remove previous action
2838
              obj.deleteActions(selections=(index,))
2839 2840 2841
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2842
          obj.addAction(
2843
                        id = action.id
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2844
                      , name = action.title
2845
                      , action = action_text
2846 2847 2848 2849
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2850 2851
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2852
                      , priority = action.priority
2853
                      , description = action.description
Aurel's avatar
Aurel committed
2854
                    )
2855
          # sort action based on the priority define on it
2856 2857 2858 2859 2860 2861 2862 2863 2864
          # 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))
2865 2866
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2867
        container.manage_delObjects([obj.id
2868
          for obj in container.getActionInformationList()
2869
          if obj.getReference() in action_dict])
2870
        for name, obj in action_dict.iteritems():
2871
          container._importOldAction(obj).aq_base
2872

Aurel's avatar
Aurel committed
2873
    else:
2874
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2875
      p = context.getPortalObject()
2876 2877
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2878
        relative_url, key, value = self._splitPath(id)
2879 2880
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2881
          if getattr(ai, key) == value:
2882
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2883 2884 2885
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2886
        obj.addAction(
Aurel's avatar
Aurel committed
2887 2888
                      id = action.id
                    , name = action.title
2889
                    , action = action_text
Aurel's avatar
Aurel committed
2890 2891 2892 2893
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2894 2895
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2896
                    )
Aurel's avatar
Aurel committed
2897 2898 2899 2900 2901 2902 2903
        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))
2904 2905
          obj.moveDownActions(selections=tuple(move_down_list))

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

2941 2942 2943
class PortalTypeRolesTemplateItem(BaseTemplateItem):

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

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

3003 3004 3005
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3006
    path = self.__class__.__name__
3007 3008
    for key in self._objects.keys():
      xml_data = self.generateXml(key)
3009 3010
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
3011
      name = key.split('/', 1)[1]
3012
      bta.addObject(xml_data, name=name, path=path)
3013 3014

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

  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
3057 3058 3059
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
3060
          # reset roles before applying
3061
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
3062
          type_roles_list = self._objects[roles_path] or []
3063 3064
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
3065 3066 3067
        else:
          raise AttributeError("Path '%r' not found while "
                               "installing roles" % (path, ))
3068 3069 3070

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
3071 3072 3073 3074 3075 3076
    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:
3077
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
3078 3079 3080 3081 3082
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
3083

3084 3085 3086 3087 3088 3089
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
3090 3091
      for property in p.propertyMap():
        if property['id'] == id:
3092
          obj = p.getProperty(id)
3093
          prop_type = property['type']
3094 3095
          break
      else:
3096
        obj = None
3097
      if obj is None and not self.is_bt_for_diff:
3098
        raise NotFound, 'the property %s is not found' % id
3099
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
3100

3101 3102
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
3103
    if not file_name.endswith('.xml'):
3104
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3105
      return
3106
    xml = parse(file)
3107 3108 3109 3110 3111 3112 3113 3114 3115
    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)
3116

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

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3154 3155 3156 3157 3158 3159
    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:
3160 3161 3162 3163
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3164
  # Function to generate XML Code Manually
3165
  def generateXml(self, path=None):
3166
    xml_data = ''
3167
    prop_type, obj = self._objects[path]
3168
    xml_data += '\n <property>'
3169 3170
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
3171
    if prop_type in ('lines', 'tokens'):
3172
      xml_data += '\n  <value>'
3173
      for item in obj:
3174
        if item != '':
3175
          xml_data += '\n   <item>%s</item>' % escape(str(item))
3176
      xml_data += '\n  </value>'
3177
    else:
3178
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
3179
    xml_data += '\n </property>'
3180 3181
    return xml_data

Aurel's avatar
Aurel committed
3182 3183 3184
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3185 3186 3187 3188
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
3189
      xml_data += self.generateXml(path)
3190
    xml_data += '\n</site_property>'
3191
    bta.addObject(xml_data, name='properties', path=self.__class__.__name__)
3192

3193 3194 3195 3196 3197
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3198 3199 3200 3201 3202 3203 3204
    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()
      mapping['permission_list'] = module.showPermissions()
3205
      mapping['category_list'] = module.getCategoryList()
3206
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3207

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

3251
  def export(self, context, bta, **kw):
3252
    if len(self._objects) == 0:
3253
      return
3254
    path = self.__class__.__name__
3255 3256
    keys = self._objects.keys()
    keys.sort()
3257
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
3258
      # export modules one by one
3259
      xml_data = self.generateXml(path=key)
3260
      bta.addObject(xml_data, name=key, path=path)
3261

3262
  def install(self, context, trashbin, **kw):
3263
    portal = context.getPortalObject()
3264 3265
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3266
    if context.getTemplateFormatVersion() == 1:
3267
      items = self._objects
3268
    else:
3269 3270
      items = self._archive

3271 3272
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
3273 3274
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
3275
        if not force:
3276
          action = update_dict[path]
3277 3278
          if action == 'nothing':
            continue
3279 3280
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
3281
        module = portal._getOb(module_id, None)
3282 3283
        if module is not None:
          module.portal_type = portal_type
3284
        else:
3285
          module = portal.newContent(id=module_id, portal_type=portal_type)
3286
        module.setTitle(str(mapping['title']))
3287 3288
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
3289
          # By default, Manager only without acquire permission
3290 3291
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
3292
          module.manage_permission(name, roles=role_list, acquire=acquire)
3293 3294
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
3295 3296

  def _importFile(self, file_name, file):
3297 3298 3299
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3300
    mapping = {}
3301
    xml = parse(file)
3302
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3303
      key_node = xml.find(key)
3304
      if key == 'permission_list':
3305 3306 3307 3308 3309 3310 3311
        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))
3312
          else:
3313 3314 3315
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3316
      else:
3317
        mapping[key] = key_node.text or ''
3318 3319

    category_list = []
3320 3321 3322 3323
    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'))
3324 3325
    mapping['category_list'] = category_list

3326
    self._objects[file_name[:-4]] = mapping
3327

3328
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3329 3330 3331
    trash = kw.get('trash', 0)
    if trash:
      return
3332 3333 3334 3335 3336 3337
    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]
3338 3339
    p = context.getPortalObject()
    id_list = p.objectIds()
3340 3341
    for key in keys:
      if key in id_list:
3342
        try:
3343
          if trash and trashbin is not None:
3344
            container_path = key.split('/')
3345 3346
            self.portal_trash.backupObject(trashbin, container_path, 
                                           key, save=1, keep_subobjects=1)
3347
          p.manage_delObjects([key])
3348
        except NotFound:
3349
          pass
3350 3351
    BaseTemplateItem.uninstall(self, context, **kw)

3352 3353 3354
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3355 3356

class DocumentTemplateItem(BaseTemplateItem):
3357 3358 3359 3360
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3361

3362 3363 3364 3365 3366 3367 3368 3369 3370 3371
  def _getKey(self, path):
    """Magical method to generate dynamic unique path"""
    return '/'.join((self.getTemplateTypeName(), path))

  def _getPath(self, key):
    """Magical method to extract real path"""
    if '/' in key:
      return key.split('/')[1]
    return key

3372 3373
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
3374 3375
    for key in self._archive.iterkeys():
      self._objects[key] = self.local_file_reader_name(key)
Aurel's avatar
Aurel committed
3376

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

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

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

3461 3462 3463 3464 3465 3466 3467 3468 3469 3470
  def remove(self, context, **kw):
    """Conversion of magically uniqued paths to real ones"""
    remove_object_dict = kw.get('remove_object_dict', {})
    new_remove_dict = dict()
    for k,v in remove_object_dict.iteritems():
      if k.startswith(self.getTemplateTypeName()+'/'):
        new_remove_dict[self._getPath(k)] = v
    kw['remove_object_dict'] = new_remove_dict
    BaseTemplateItem.remove(self, context, **kw)

3471
  def uninstall(self, context, **kw):
3472
    object_path = kw.get('object_path', None)
3473 3474 3475 3476
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
3477 3478 3479 3480 3481
    if object_keys:
      if isinstance(self, DocumentTemplateItem):
        self._resetDynamicModules()
      for key in object_keys:
        self.local_file_remover_name(key)
3482 3483
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3484 3485 3486
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3487 3488 3489 3490 3491 3492
    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
3493
      bta.addObject(obj, name=key, ext='.py')
Aurel's avatar
Aurel committed
3494

3495
  def _importFile(self, file_name, file):
3496 3497 3498
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3499
    text = file.read()
3500
    self._objects[file_name[:-3]] = text
3501

3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523
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
3524
  _perform_migration = True
3525 3526

  # Only meaningful for filesystem Property Sheets
3527 3528 3529 3530
  local_file_reader_name = staticmethod(readLocalPropertySheet)
  local_file_writer_name = staticmethod(writeLocalPropertySheet)
  local_file_importer_name = staticmethod(importLocalPropertySheet)
  local_file_remover_name = staticmethod(removeLocalPropertySheet)
3531

3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545
  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)

3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565
    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()):
3566
        result = getattr(ObjectTemplateItem, method_name)(self, *args, **kw)
3567
      else:
3568 3569 3570 3571 3572
        result = getattr(DocumentTemplateItem, method_name)(self, *args, **kw)
      if method_name == 'preinstall':
        old_result = result.copy()
        for k, v in old_result.iteritems():
          if not k.startswith('portal_property_sheets/'):
3573
            result.pop(k)
3574 3575 3576 3577 3578
            # Magical way to have unique path in case of not yet migrated property
            # sheets available on preinstall list
            k = self._getKey(k)
          result[k] = v
      return result
3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643
    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)

3644 3645
    return PropertySheetDocument.importFromFilesystemDefinition(
        property_sheet_tool, klass)
3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661

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

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

      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

3711
      migrate_object_dict[key] = new_property_sheet.aq_base
3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723
      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'

3724 3725 3726 3727 3728 3729 3730 3731 3732 3733
  def remove(self, context, **kw):
    """Conversion of magically uniqued paths to real ones"""
    remove_object_dict = kw.get('remove_object_dict', {})
    new_remove_dict = dict()
    for k,v in remove_object_dict.iteritems():
      if k.startswith(self.getTemplateTypeName()+'/'):
        new_remove_dict[self._getPath(k)] = v
    kw['remove_object_dict'] = new_remove_dict
    ObjectTemplateItem.remove(self, context, **kw)

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

3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754
    # 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'))
3755 3756 3757

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

3758
class ConstraintTemplateItem(DocumentTemplateItem):
3759 3760 3761 3762
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3763

3764
class ExtensionTemplateItem(DocumentTemplateItem):
3765 3766
  local_file_reader_name = staticmethod(readLocalExtension)
  local_file_writer_name = staticmethod(writeLocalExtension)
3767 3768
  # Extension needs no import
  local_file_importer_name = None
3769
  local_file_remover_name = staticmethod(removeLocalExtension)
3770 3771

class TestTemplateItem(DocumentTemplateItem):
3772 3773
  local_file_reader_name = staticmethod(readLocalTest)
  local_file_writer_name = staticmethod(writeLocalTest)
3774
  # Test needs no import
3775
  local_file_importer_name = None
3776
  local_file_remover_name = staticmethod(removeLocalTest)
3777

Aurel's avatar
Aurel committed
3778

3779 3780 3781
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3782 3783 3784

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3785
  def build(self, context, **kw):
3786 3787
    for key in self._archive.iterkeys():
      self._objects[key] = 1
Aurel's avatar
Aurel committed
3788

3789
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3790 3791
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3792
      new_roles = self._objects.keys()
3793 3794 3795 3796 3797 3798
      # 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]
3799
      for role in new_roles:
3800
        if installed_item._objects.has_key(role):
3801 3802 3803 3804
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
3805
      old_roles = installed_item._objects.keys()
3806 3807 3808 3809 3810 3811
      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):
3812
    p = context.getPortalObject()
3813
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3814
    if context.getTemplateFormatVersion() == 1:
3815
      role_set = set(self._objects)
3816
    else:
3817
      role_set = set(self._archive)
3818 3819 3820 3821
    # 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:
3822 3823
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
3824
    # set roles on portal
3825
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
3826 3827

  def _importFile(self, file_name, file):
3828
    if not file_name.endswith('.xml'):
3829
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3830
      return
3831
    xml = parse(file)
3832 3833 3834
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846

  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)

3847 3848 3849 3850 3851 3852 3853 3854 3855
  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
3856
      if role in roles and role not in new_roles:
3857 3858 3859
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3860
  # Function to generate XML Code Manually
3861 3862
  def generateXml(self):
    role_list = self._objects.keys()
3863
    xml_data = '<role_list>'
3864 3865
    for role in sorted(role_list):
      xml_data += '\n <role>%s</role>' % (role,)
3866
    xml_data += '\n</role_list>'
3867 3868
    return xml_data

Aurel's avatar
Aurel committed
3869
  def export(self, context, bta, **kw):
3870
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
3871
      return
3872 3873 3874 3875 3876 3877 3878 3879
    # 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
3880
    bta.addObject(xml_data, name=path)
3881

3882 3883 3884 3885
class CatalogSearchKeyTemplateItem(BaseTemplateItem):
  key_list_attr = 'sql_catalog_search_keys'
  key_list_title = 'search_key_list'
  key_title = 'Search key'
3886

Aurel's avatar
Aurel committed
3887
  def build(self, context, **kw):
3888
    catalog = _getCatalogValue(self)
3889 3890 3891
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3892
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
3893
    key_list = []
3894
    for key in self._archive.keys():
3895
      if key in catalog_key_list:
3896
        key_list.append(key)
3897
      elif not self.is_bt_for_diff:
3898
        raise NotFound, '%s %r not found in catalog' %(self.key_title, key)
3899
    if len(key_list) > 0:
3900
      self._objects['%s/%s' % (self.__class__.__name__, self.key_list_title)] = key_list
3901 3902

  def _importFile(self, file_name, file):
3903 3904 3905
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3906
    xml = parse(file)
3907 3908
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3909

3910
  def install(self, context, trashbin, **kw):
3911
    catalog = _getCatalogValue(self)
3912 3913 3914
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3915

3916
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3917
    if context.getTemplateFormatVersion() == 1:
3918 3919
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3920 3921 3922
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3923
    else:
3924
      keys = self._archive.keys()
3925 3926
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3927
    # XXX same as related key
3928
    if update_dict.has_key(self.key_list_title) or force:
3929
      if not force:
3930
        action = update_dict[self.key_list_title]
3931
        if action == 'nothing':
Aurel's avatar
Aurel committed
3932
          return
3933
      for key in keys:
3934 3935 3936
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
3937

3938
  def uninstall(self, context, **kw):
3939
    catalog = _getCatalogValue(self)
3940 3941 3942
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3943
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
3944
    object_path = kw.get('object_path', None)
3945 3946 3947 3948 3949
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3950 3951 3952
      if key in catalog_key_list:
        catalog_key_list.remove(key)
    setattr(catalog, self.key_list_attr, catalog_key_list)
3953 3954
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3955
  # Function to generate XML Code Manually
3956
  def generateXml(self, path=None):
3957
    obj = self._objects[path]
3958
    xml_data = '<key_list>'
3959 3960
    obj.sort()
    for key in obj:
3961 3962
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3963 3964
    return xml_data

Aurel's avatar
Aurel committed
3965 3966 3967
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3968
    for path in self._objects.keys():
3969
      xml_data = self.generateXml(path=path)
3970
      bta.addObject(xml_data, name=path)
3971

3972 3973 3974 3975
class CatalogResultKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_result_keys'
  key_list_title = 'result_key_list'
  key_title = 'Result key'
3976

3977 3978 3979 3980
class CatalogRelatedKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_related_keys'
  key_list_title = 'related_key_list'
  key_title = 'Related key'
3981

3982
  # override this method to support 'key_list' for backward compatibility.
3983
  def install(self, context, trashbin, **kw):
3984
    catalog = _getCatalogValue(self)
3985 3986 3987
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3988

3989
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3990
    if context.getTemplateFormatVersion() == 1:
3991
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3992
        return
3993 3994 3995
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3996
    else:
3997
      keys = self._archive.keys()
3998 3999
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
4000
    # XXX must a find a better way to manage related key
4001
    if update_dict.has_key(self.key_list_title) or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
4002
      if not force:
4003 4004
        if update_dict.has_key(self.key_list_title):
          action = update_dict[self.key_list_title]
Aurel's avatar
Aurel committed
4005 4006
        else: # XXX for backward compatibility
          action = update_dict['key_list']
Aurel's avatar
Aurel committed
4007 4008 4009
        if action == 'nothing':
          return
      for key in keys:
4010 4011 4012
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
4013

4014 4015 4016 4017
class CatalogResultTableTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_tables'
  key_list_title = 'result_table_list'
  key_title = 'Result table'
4018

4019
# keyword
4020 4021 4022 4023
class CatalogKeywordKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_keyword_search_keys'
  key_list_title = 'keyword_key_list'
  key_title = 'Keyword key'
4024

4025
# datetime
4026 4027 4028 4029
class CatalogDateTimeKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_datetime_search_keys'
  key_list_title = 'datetime_key_list'
  key_title = 'DateTime key'
4030

4031 4032 4033 4034 4035
# 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'
4036

4037 4038 4039 4040 4041
# request
class CatalogRequestKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_request_keys'
  key_list_title = 'request_key_list'
  key_title = 'Request key'
4042

4043 4044 4045 4046 4047
# multivalue
class CatalogMultivalueKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_multivalue_keys'
  key_list_title = 'multivalue_key_list'
  key_title = 'Multivalue key'
4048 4049

# topic
4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068
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'
4069

4070 4071 4072 4073
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4074 4075 4076
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4077
      else: # XXX backward compatibility
4078 4079
        lang = lang_key
        catalog = 'erp5_ui'
4080
      path = posixpath.join(lang, catalog)
4081 4082
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4083 4084 4085
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4086

4087
  def preinstall(self, context, installed_item, **kw):
4088 4089 4090 4091
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
4092
        if installed_item._objects.has_key(path):
4093 4094
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
4095
          old_obj_code = installed_item._objects[path]
4096 4097 4098 4099 4100
          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
4101
      old_keys = installed_item._objects.keys()
4102 4103 4104 4105 4106
      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

4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134
  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', {})
4135 4136
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
4137 4138
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4139
          if not force:
4140
            action = update_dict[key]
4141
            if action == 'nothing':
4142
              continue
4143
          lang, catalog = self._splitKey(key)
4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159

          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)
4160 4161
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4162 4163 4164 4165
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4166
            self._importCatalogLanguage(localizer, catalog, lang, po)
4167 4168
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4169
      for lang, catalogs in self._archive.iteritems():
4170 4171 4172
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202
          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)
4203 4204

  def export(self, context, bta, **kw):
4205
    if len(self._objects) == 0:
4206
      return
4207
    root_path = self.__class__.__name__
4208
    for key, obj in self._objects.iteritems():
4209
      path = os.path.join(root_path, key)
4210
      if '/' in key:
4211
        bta.addObject(obj, 'translation', ext='.po', path=path)
4212 4213 4214 4215 4216
      else:
        xml_data = ['<language>']
        xml_data.append(' <code>%s</code>' % (escape(key), ))
        xml_data.append(' <name>%s</name>' % (escape(obj), ))
        xml_data.append('</language>')
4217
        bta.addObject('\n'.join(xml_data), 'language', path=path)
4218 4219

  def _importFile(self, file_name, file):
4220 4221
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4222 4223
      text = file.read()
      self._objects[file_name[:-3]] = text
4224 4225
    elif name == 'language.xml':
      xml = parse(file)
4226 4227
      name = xml.find('name').text
      code = xml.find('code').text
4228
      self._objects[code] = name
4229

Aurel's avatar
Aurel committed
4230 4231
class LocalRolesTemplateItem(BaseTemplateItem):

4232
  def __init__(self, id_list, **kw):
4233
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4234 4235
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4236 4237 4238
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4239
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4240 4241
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4242
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4243

Christophe Dumez's avatar
Christophe Dumez committed
4244
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4245
  def generateXml(self, path=None):
4246
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4247 4248
    # local roles
    xml_data = '<local_roles_item>'
4249
    xml_data += '\n <local_roles>'
4250
    for key in sorted(local_roles_dict):
4251
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4252 4253
      tuple = local_roles_dict[key]
      for item in tuple:
4254 4255 4256 4257
        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
4258
    if isinstance(xml_data, unicode):
4259
      xml_data = xml_data.encode('utf8')
Aurel's avatar
Aurel committed
4260
    return xml_data
4261

Aurel's avatar
Aurel committed
4262
  def export(self, context, bta, **kw):
4263 4264
    path = self.__class__.__name__
    for key in self._objects:
Aurel's avatar
Aurel committed
4265
      xml_data = self.generateXml(key)
4266 4267
      assert key[:12] == 'local_roles/'
      bta.addObject(xml_data, key[12:], path=path)
Aurel's avatar
Aurel committed
4268 4269

  def _importFile(self, file_name, file):
4270 4271 4272
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4273 4274
    xml = parse(file)
    # local roles
4275
    local_roles_list = xml.findall('//role')
Aurel's avatar
Aurel committed
4276 4277
    local_roles_dict = {}
    for role in local_roles_list:
4278 4279
      id = role.get('id')
      item_type_list = [item.text for item in role]
Aurel's avatar
Aurel committed
4280
      local_roles_dict[id] = item_type_list
4281
    self._objects['local_roles/%s' % (file_name[:-4],)] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292

  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
4293 4294
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4295
        local_roles_dict = self._objects[roles_path][0]
4296
        setattr(obj, '__ac_local_roles__', local_roles_dict)
4297
        obj.reindexObject()
Aurel's avatar
Aurel committed
4298

4299
  def uninstall(self, context, object_path=None, **kw):
Aurel's avatar
Aurel committed
4300
    p = context.getPortalObject()
4301 4302 4303 4304 4305
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
Aurel's avatar
Aurel committed
4306
      path = roles_path.split('/')[1:]
4307 4308 4309 4310 4311 4312
      # if document does not exists anymore longer,
      # there is no needs to fail
      obj = p.unrestrictedTraverse(path, None)
      if obj is not None:
        setattr(obj, '__ac_local_roles__', {})
        obj.reindexObject()
4313

4314 4315 4316
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4317
    in part or completely. Each object is separated from its
4318 4319 4320 4321 4322 4323 4324 4325 4326 4327
    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
4328 4329
      - object without optimal actions
      - list of relation between portal type and workflow
4330 4331 4332 4333 4334 4335 4336 4337 4338 4339

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

    - site property definition
      - id
      - type
4340
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4341

4342 4343
    - document/propertysheet/extension/test definition
      - copy of the local file
4344

4345
    - message transalation definition
4346
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4347

4348 4349
    The Business Template properties are exported to the bt folder with
    one property per file
4350

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4351 4352
    Technology:

4353 4354
    - 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
4355

4356
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4357 4358 4359 4360

    Use case:

    - install core ERP5 (the minimum)
4361

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

4364 4365
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4366
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4367 4368 4369 4370 4371
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4372
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4373 4374 4375

    # Declarative security
    security = ClassSecurityInfo()
4376
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4377 4378 4379 4380

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4381
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4382
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4383
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4384
                      , PropertySheet.BusinessTemplate
4385
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4386 4387
                      )

4388 4389 4390 4391 4392 4393
    # 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."""
4394
         , 'icon'           : 'file_icon.gif'
4395 4396
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
4397
         , 'type_class'     : 'BusinessTemplate'
4398 4399 4400 4401 4402 4403 4404
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

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

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4461 4462 4463 4464 4465 4466
      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
4467
        self._baseGetTemplateFormatVersion()
4468

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4469 4470 4471
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4472

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4473
      return 0
4474

4475
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4476 4477 4478 4479 4480 4481 4482
    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".
4483 4484
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4485
          # XXX Not good to access the attribute directly,
4486 4487 4488
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4489

4490 4491
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4492 4493 4494 4495 4496 4497
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4498
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4499 4500 4501 4502 4503 4504 4505 4506
        """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)
4507

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

4617 4618 4619 4620 4621 4622 4623 4624 4625 4626
    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()

4627
      try:
Julien Muchembled's avatar
Julien Muchembled committed
4628 4629 4630 4631 4632 4633
        from Products.ERP5VCS.WorkingCopy import NotAWorkingCopyError
        try:
          self.setRevision(self.getVcsTool().newRevision())
        except NotAWorkingCopyError:
          raise ImportError
      except ImportError:
4634
        self.updateRevisionNumber()
4635 4636 4637
      self._setTemplateFormatVersion(1)
      self.storeTemplateItemData()

4638 4639
      # Build each part
      for item_name in self._item_name_list:
4640 4641 4642 4643
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4644

4645
    build = WorkflowMethod(build)
4646 4647

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4648
      """
4649
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4650
      """
4651
      return self.portal_templates.publish(self, url, username=username,
4652
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4653

4654
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4655
      """
4656
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4657
      """
4658
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4659

4660 4661 4662 4663 4664
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4665 4666 4667 4668 4669 4670 4671 4672 4673 4674
      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
4675 4676
      return False

4677
    def preinstall(self, check_dependencies=1, **kw):
4678 4679 4680
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4681
      """
4682 4683 4684 4685 4686
      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()
4687

4688 4689
      modified_object_list = {}
      bt_title = self.getTitle()
4690 4691 4692 4693 4694 4695 4696

      #  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)
4697 4698 4699
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4700
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4701

4702
      # if reinstall business template, must compare to object in ZODB
4703
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4704
      # same if we make a diff and select only one business template
4705
      reinstall = 0
4706 4707
      if installed_bt == self:
        reinstall = 1
4708
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
4709 4710
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                   id=INSTALLED_BT_FOR_DIFF)
4711 4712 4713 4714 4715 4716 4717
          # 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)
4718

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4719
      new_bt_format = self.getTemplateFormatVersion()
4720 4721 4722 4723 4724 4725
      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:
4726
          item = getattr(self, item_name, None)
4727 4728 4729 4730
          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
4731

4732
      for item_name in self._item_name_list:
4733
        new_item = getattr(self, item_name, None)
4734
        installed_item = getattr(installed_bt, item_name, None)
4735
        if new_item is not None:
4736
          if installed_item is not None and hasattr(installed_item, '_objects'):
4737
            modified_object = new_item.preinstall(context=self, 
4738 4739
                                                  installed_item=installed_item,
                                                  installed_bt=installed_bt)
4740 4741 4742 4743 4744 4745 4746
            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:
4747
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
4748

4749 4750
      return modified_object_list

4751
    def _install(self, force=1, object_to_update=None, update_translation=0,
4752
                 update_catalog=_MARKER, **kw):
4753
      """
Christophe Dumez's avatar
Christophe Dumez committed
4754
        Install a new Business Template, if force, all will be upgraded or installed
4755 4756
        otherwise depends of dict object_to_update
      """
4757 4758 4759 4760
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4761

4762 4763
      site = self.getPortalObject()
      installed_bt = site.portal_templates.getInstalledBusinessTemplate(
4764
                                                           self.getTitle())
4765 4766
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4767
        if installed_bt.getTemplateFormatVersion() == 0:
4768
          force = 1
4769 4770 4771
        if site.portal_workflow.isTransitionPossible(
            installed_bt, 'replace'):
          installed_bt.replace(self)
4772

4773
      trash_tool = getToolByName(site, 'portal_trash', None)
4774 4775 4776
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4777 4778 4779
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4780

4781 4782 4783
      if not force:
        self.checkDependencies()

4784 4785
      # 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
4786
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 2):
4787 4788 4789 4790 4791
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
4792
      if len(object_to_update) or force:
4793 4794 4795
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
4796 4797
            item.install(self, force=force, object_to_update=object_to_update, 
                               trashbin=trashbin, installed_bt=installed_bt)
4798

4799
      # update catalog if necessary
4800 4801 4802
      if update_catalog is _MARKER and force and self.isCatalogUpdatable():
        # override update_catalog parameter only if value
        # is not explicitely passed.
4803
        update_catalog = 1
4804
      elif update_catalog is _MARKER:
4805
        update_catalog = 0
4806
      if update_catalog:
4807
        catalog = _getCatalogValue(self)
4808
        if (catalog is None) or (not site.isIndexable):
4809 4810 4811 4812 4813
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4814

4815
      # get objects to remove
4816
      # do remove after because we may need backup object from installation
4817
      remove_object_dict = {}
4818 4819
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
4820
          remove_object_dict[path] = action
4821

4822
      # remove object from old business template
4823
      if len(remove_object_dict):
4824
        # XXX: this code assumes that there is an installed_bt
4825
        for item_name in reversed(installed_bt._item_name_list):
4826
          item = getattr(installed_bt, item_name, None)
4827
          if item is not None:
4828
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
4829

4830 4831

      # update tools if necessary
4832 4833 4834 4835 4836
      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)
4837

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

4843 4844
      if update_catalog:
        site.ERP5Site_reindexAll()
4845

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

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

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

4861
    install = WorkflowMethod(install)
4862

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

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

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

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

4902 4903
    uninstall = WorkflowMethod(uninstall)

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

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

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

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

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

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

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

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

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

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

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

Alexandre Boeglin's avatar
Alexandre Boeglin committed
5011 5012 5013 5014 5015 5016 5017
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

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

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

5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052
    def getTemplatePortalTypeHiddenContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_hidden_content_type')

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

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

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

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

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

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

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

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

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

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

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

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

5133 5134 5135 5136 5137 5138
    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
5139
                   preferences.getPreferredSubversionWorkingCopyList() or ['bt5']):
5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150
        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):
5151
      from Products.ERP5VCS.WorkingCopy import getVcsTool
5152 5153 5154 5155 5156 5157
      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
5158
      from Products.ERP5VCS.WorkingCopy import NotAWorkingCopyError
5159 5160 5161 5162 5163
      try:
        return self.getVcsTool().reference in vcs
      except NotAWorkingCopyError:
        return None in vcs

5164
    security.declareProtected(Permissions.ManagePortal, 'export')
5165
    def export(self, path=None, local=0, bta=None, **kw):
Aurel's avatar
Aurel committed
5166 5167 5168
      """
        Export this Business Template
      """
5169
      if self.getBuildingState() != 'built':
5170
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5171
              'Business Template must be built before export'
5172

5173 5174 5175 5176 5177 5178 5179 5180 5181
      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
5182

5183
      # export bt
Aurel's avatar
Aurel committed
5184
      for prop in self.propertyMap():
5185
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5186
        id = prop['id']
5187
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5188
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5189
          continue
Aurel's avatar
Aurel committed
5190
        value = self.getProperty(id)
5191
        if not value:
5192
          continue
5193
        if prop_type in ('text', 'string', 'int', 'boolean'):
5194
          bta.addObject(str(value), name=id, path='bt', ext='')
5195
        elif prop_type in ('lines', 'tokens'):
5196
          bta.addObject('\n'.join(value), name=id, path='bt', ext='')
5197

Aurel's avatar
Aurel committed
5198 5199 5200
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5201

5202
      return bta.finishCreation()
Aurel's avatar
Aurel committed
5203

5204
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5205 5206
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5207
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5208 5209 5210 5211 5212
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
5213 5214

      self.storeTemplateItemData()
5215

5216 5217
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5218 5219
      # XXX This is not required with portal types as classes.
      #     It is still there for compatibility with non-migrated objects.
5220
      module_id_list = []
5221
      for template_id in self.getTemplateDocumentIdList():
5222 5223 5224
        module_id = 'Products.ERP5Type.Document.' + template_id
        if module_id not in sys.modules:
          module_id_list.append(module_id)
5225
          sys.modules[module_id] = module = imp.new_module(module_id)
5226 5227
          setattr(module, template_id, type(template_id,
            (SimpleItem.SimpleItem,), {'__module__': module_id}))
5228

Aurel's avatar
Aurel committed
5229 5230
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5231

5232 5233
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5234 5235
      for module_id in module_id_list:
        del sys.modules[module_id]
5236

5237 5238 5239 5240 5241
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5242 5243 5244
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5245
      return items_list
5246

5247 5248 5249 5250 5251 5252
    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
      """
5253 5254 5255 5256 5257 5258 5259 5260
      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.
      """
5261 5262
      missing_dep_list = []
      dependency_list = self.getDependencyList()
5263
      if len(dependency_list) > 0:
5264
        for dependency_couple in dependency_list:
5265
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5266
          dependency = dependency_couple_list[0]
5267 5268
          if dependency in (None, ''):
            continue
5269 5270
          version_restriction = None
          if len(dependency_couple_list) > 1:
5271
            version_restriction = dependency_couple_list[1]
5272 5273 5274
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5275 5276 5277
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5278
                  or (version_restriction not in (None, '') and
5279 5280
                     (not self.portal_templates.compareVersionStrings(installed_bt.getVersion(), version_restriction)))):
            missing_dep_list.append((dependency, version_restriction or ''))
5281
      return [' '.join([y for y in x if y]) for x in missing_dep_list]
5282

5283 5284 5285
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
5286
        This is compatible with ERP5VCS look and feel but
5287 5288 5289 5290
        it is preferred in future we use more difflib python library.
      """
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

Aurel's avatar
Aurel committed
5291
    def diffObject(self, REQUEST, **kw):
5292 5293
      """
        Make a diff between an object in the Business Template
5294
        and the same in the Business Template installed in the site
5295 5296 5297 5298
      """

      class_name_dict = {
        'Product' : '_product_item',
5299
        'PropertySheet' : '_property_sheet_item',
5300
        'Constraint' : '_constraint_item',
5301 5302 5303 5304 5305 5306 5307 5308 5309
        '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',
5310
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5311 5312 5313 5314
        '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',
5315 5316 5317
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5318
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5319
        'Path' : '_path_item',
5320
        'Preference' : '_preference_item',
5321
        'Action' : '_action_item',
5322
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5323
        'LocalRoles' : '_local_roles_item',
5324 5325 5326
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5327
        'CatalogSearchKey' : '_catalog_search_key_item',
5328
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5329
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5330 5331 5332 5333
        '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
5334
        'Tool': '_tool_item',
5335
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5336 5337
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5338
        }
5339

5340 5341
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5342

Christophe Dumez's avatar
Christophe Dumez committed
5343
      # Get objects
5344
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5345

5346
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
5347
      # Compare with a given business template
5348
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5349 5350
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5351 5352
        if bt2_id == self.getId():
          compare_to_zodb = 1
5353
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5354 5355
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5356 5357 5358
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5359 5360
          compare_to_zodb = 1
      if compare_to_zodb:
5361 5362
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5363
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5364 5365 5366
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5367

5368 5369
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5370
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5371
        # XXX maybe only build for the given object to gain time
5372
        installed_item.build(self)
5373 5374 5375
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5376

Christophe Dumez's avatar
Christophe Dumez committed
5377
      # Real Zope Objects (can be exported into XML directly by Zope)
5378 5379
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5380
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5381
                     '_skin_item', '_action_item', '_tool_item', ]
5382

Christophe Dumez's avatar
Christophe Dumez committed
5383
      # Not considered as objects by Zope (will be exported into XML manually)
5384
      # XXX Bad naming
5385 5386 5387 5388
      item_list_2 = ['_site_property_item',
                     '_module_item',
                     '_catalog_result_key_item', 
                     '_catalog_related_key_item',
5389
                     '_catalog_result_table_item',
5390
                     '_catalog_search_key_item',
5391
                     '_catalog_keyword_key_item',
5392
                     '_catalog_datetime_key_item',
5393 5394 5395 5396
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5397
                     '_catalog_scriptable_key_item',
5398 5399
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5400 5401 5402 5403 5404 5405
                     '_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',
5406
                     '_portal_type_workflow_chain_item',]
5407

Christophe Dumez's avatar
Christophe Dumez committed
5408
      # Text objects (no need to export them into XML)
5409
      # XXX Bad naming
5410 5411
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5412
                     '_test_item', '_message_translation_item',]
5413

5414
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5415 5416 5417
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5418 5419
        new_object = new_item.removeProperties(new_object, 1)
        installed_object = installed_item.removeProperties(installed_object, 1)
5420
        # XML Export in memory
5421
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5422 5423
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5424
        new_obj_xml = f1.getvalue()
5425
        f1.close()
5426 5427 5428 5429
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5430
        # End of XML export
5431

5432
        # Diff between XML objects
5433 5434
        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
5435
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5436 5437 5438
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5439

5440
      elif item_name in item_list_2:
5441
        # Generate XML code manually
5442 5443
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5444 5445
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5446
        # End of XML Code Generation
5447

5448
        # Diff between XML objects
5449 5450
        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
5451
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5452 5453 5454
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5455

5456
      elif item_name in item_list_3:
5457
        # Diff between text objects
5458 5459 5460 5461
        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
5462
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5463 5464
          diff_msg += '\n'.join(diff_list)
        else:
5465
          diff_msg = 'No diff'
5466

5467
      else:
5468
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5469

5470
      if compare_to_zodb:
5471
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5472

5473
      return diff_msg
5474

5475

5476 5477 5478 5479
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5480 5481
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5482 5483 5484 5485 5486 5487 5488
      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 [])
5489 5490
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5491
      for id in bt_portal_types_id_list:
5492 5493
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5494
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5495
        if portal_type.getRoleInformationList():
5496 5497
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5498

5499 5500 5501 5502
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5503
        action_list = []
5504 5505 5506 5507 5508 5509 5510
        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'):
5511
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5512 5513
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5514

5515 5516 5517 5518
        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)
5519

5520
        for h_id in hidden_content_type_list:
5521 5522 5523
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5524

5525 5526 5527 5528
        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)
5529

5530 5531 5532 5533
        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)
5534

5535 5536 5537 5538
        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)
5539

5540
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5541
                                    if chain != '(Default)']:
5542 5543 5544
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5545

5546 5547 5548 5549
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5550
      bt_action_list.sort()
5551
      bt_wf_chain_list.sort()
5552

5553 5554 5555 5556 5557 5558 5559
      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)
5560 5561 5562 5563 5564 5565 5566 5567 5568
      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:
5569 5570
        raise TemplateConditionError, 'No module defined in business template'

5571 5572 5573 5574 5575 5576 5577 5578
      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:
5579
          return type_list
5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593

        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():
5594
            type_list.update(getChildPortalType(hidden_ptype_id))
5595
        return type_list
5596

5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643
      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

5644 5645 5646
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5647
  setattr(BusinessTemplate, key, None)