BusinessTemplate.py 223 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, tarfile
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.Cache import transactional_cached
Nicolas Dumazet's avatar
Nicolas Dumazet committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
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
60
from Products.ERP5Type.Utils import convertToUpperCase
61
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
62
from Products.ERP5Type.XMLObject import XMLObject
63
from Products.ERP5Type.dynamic.portal_type_class import synchronizeDynamicModules
64
from Products.ERP5Type.Core.PropertySheet import PropertySheet as PropertySheetDocument
Aurel's avatar
Aurel committed
65
from OFS.Traversable import NotFound
66
from OFS import SimpleItem, XMLExportImport
67
from cStringIO import StringIO
Aurel's avatar
Aurel committed
68
from copy import deepcopy
69
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
70
import OFS.XMLExportImport
71
from Products.ERP5Type.patches.ppml import importXML
Aurel's avatar
Aurel committed
72
customImporters={
73
    XMLExportImport.magic: importXML,
Aurel's avatar
Aurel committed
74
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
75

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

87 88 89 90 91 92
import threading

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

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

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

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

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

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

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

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

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

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

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

229 230 231 232 233 234 235
  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

236 237 238 239 240 241 242 243 244
  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 ''
245
    selection_list = selection.split(',')
246
    if (skin_folder_id not in selection_list):
247
      selection_list.insert(0, skin_folder_id)
248
    if reorder_skin_selection:
249 250
      # Sort by skin priority and ID
      selection_list.sort(key=skin_sort_key)
251
    if (skin_name in skin_layer_list):
252 253 254 255 256 257 258 259 260 261
      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.
Arnaud Fontaine's avatar
Arnaud Fontaine committed
262
  #  - they are not registered in the default skin selection
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
  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:
    for skin_folder in skin_tool.objectValues():
      try:
283 284
        if skin_name in skin_folder.getProperty(
               'business_template_registered_skin_selections', ()):
285 286 287
          break
      except AttributeError:
        pass
288 289
    else:
      skin_tool.manage_skinLayers(chosen=[skin_name], del_skin=1)
290 291
      skin_tool.getPortalObject().changeSkin(None)

292
def unregisterSkinFolderId(skin_tool, skin_folder_id, skin_selection_list):
293 294 295 296 297 298 299 300 301 302
  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
303 304 305
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
306
  """
307
  def _initCreation(self, path, **kw):
308
    self.path = path
Aurel's avatar
Aurel committed
309 310 311 312 313 314 315

  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)

316
  def addObject(self, obj, name, path=None, ext='.xml'):
317 318 319 320 321 322
    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)
323
    try:
324 325 326 327 328 329 330 331 332 333
      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)
334

335
  def finishCreation(self):
Aurel's avatar
Aurel committed
336 337 338 339
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
340
    Class archiving business template into a folder tree
341
  """
342 343 344 345 346 347 348 349 350 351 352 353
  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
354 355 356 357 358 359 360
    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
361

362
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
363 364 365
    """
      Import file from a local folder
    """
366
    class_name = item.__class__.__name__
367 368
    root_path_len = self.root_path_len
    prefix_len = root_path_len + len(class_name) + len(os.sep)
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    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
389

Aurel's avatar
Aurel committed
390 391 392 393 394
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

395 396
  def _initCreation(self, **kw):
    BusinessTemplateArchive._initCreation(self, **kw)
Aurel's avatar
Aurel committed
397 398 399
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)
400 401 402 403 404 405 406 407 408 409 410 411 412
    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
413 414 415
    self.tar.close()
    return self.fobj

416
  def _initImport(self, file, **kw):
417 418 419 420 421 422 423 424 425 426 427 428
    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
429

430
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
431 432
    """
      Import all file from the archive to the site
433
    """
434 435 436
    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
437

438
class TemplateConditionError(Exception): pass
439
class TemplateConflictError(Exception): pass
440
class BusinessTemplateMissingDependency(Exception): pass
441

442 443 444
ModuleSecurityInfo(__name__).declarePublic('BusinessTemplateMissingDependency',
  'TemplateConditionError', 'TemplateConflictError')

445
class BaseTemplateItem(Implicit, Persistent):
446
  """
447
    This class is the base class for all template items.
448
    is_bt_for_diff means This BT is used to compare self temporary BT with installed BT
449
  """
450
  is_bt_for_diff = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
451

452
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
453
    self.__dict__.update(kw)
454
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
455
    self._objects = PersistentMapping()
456
    for id in id_list:
457 458
      if id is not None and id != '':
        self._archive[id] = None
459 460 461 462

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

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

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

498
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
499 500 501 502 503 504
    """
      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.
    """
505 506 507
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
508
    keys.reverse()
509 510 511 512 513 514 515 516 517 518 519
    # 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)
520 521 522 523
        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
524

525

526 527 528 529
  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
530
  def export(self, context, bta, **kw):
531
    pass
Aurel's avatar
Aurel committed
532

533 534
  def getKeys(self):
    return self._objects.keys()
535

Aurel's avatar
Aurel committed
536
  def importFile(self, bta, **kw):
537
    bta.importFiles(item=self)
538

539
  def removeProperties(self, obj, export, keep_workflow_history=False):
540 541
    """
    Remove unneeded properties for export
542
    """
543
    obj._p_activate()
544 545
    klass = obj.__class__
    classname = klass.__name__
546

547
    attr_set = set(('_dav_writelocks', '_filepath', '_owner', 'last_id', 'uid',
548
                    '__ac_local_roles__'))
549
    if export:
550 551
      if not keep_workflow_history:
        attr_set.add('workflow_history')
552 553
      # PythonScript covers both Zope Python scripts
      # and ERP5 Python Scripts
554
      if isinstance(obj, PythonScript):
555
        attr_set.update(('func_code', 'func_defaults', '_code',
556
                         '_lazy_compilation', 'Python_magic'))
557 558 559
        for attr in 'errors', 'warnings', '_proxy_roles':
          if not obj.__dict__.get(attr, 1):
            delattr(obj, attr)
560 561
      elif classname == 'SQL' and klass.__module__== 'Products.ZSQLMethods.SQL':
        attr_set.update(('_arg', 'template'))
562
      elif interfaces.IIdGenerator.providedBy(obj):
Nicolas Dumazet's avatar
Nicolas Dumazet committed
563
        attr_set.update(('last_max_id_dict', 'last_id_dict'))
564 565
      elif classname == 'Types Tool' and klass.__module__ == 'erp5.portal_type':
        attr_set.add('type_provider_list')
566

567 568
    for attr in obj.__dict__.keys():
      if attr in attr_set or attr.startswith('_cache_cookie_'):
569 570
        delattr(obj, attr)

571
    if classname == 'PDFForm':
572
      if not obj.getProperty('business_template_include_content', 1):
573
        obj.deletePdfContent()
574 575
    return obj

576 577 578 579 580 581 582 583 584
  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]

585
  def restrictedResolveValue(self, context=None, path='', default=_MARKER):
586 587 588 589
    """
      Get the value with checking the security.
      This method does not acquire the parent.
    """
590 591
    return self.unrestrictedResolveValue(context, path, default=default,
                                         restricted=1)
592

593 594
  def unrestrictedResolveValue(self, context=None, path='', default=_MARKER,
                               restricted=0):
595 596 597 598 599 600 601 602 603 604 605
    """
      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:
606
        portal = aq_inner(self.getPortalObject())
607 608 609 610
        container = portal
      else:
        container = context

611 612 613 614
      if restricted:
        validate = getSecurityManager().validate

      while stack:
615
        key = stack.pop()
616 617 618 619 620 621 622 623
        try:
          value = container[key]
        except KeyError:
          LOG('BusinessTemplate', WARNING, 
              'Could not access object %s' % (path,))
          if default is _MARKER:
            raise
          return default
624

625 626 627 628 629 630 631 632 633 634 635 636
        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
637

638 639 640
      return value
    else:
      return context
641

642 643 644
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
645
  """
646

647 648 649 650
  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()
651
      self._archive.clear()
652 653 654
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
655

656
  def export(self, context, bta, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
657 658 659 660
    """
      Export the business template : fill the BusinessTemplateArchive with
      objects exported as XML, hierarchicaly organised.
    """
661 662
    if len(self._objects.keys()) == 0:
      return
663
    path = self.__class__.__name__
Vincent Pelletier's avatar
Vincent Pelletier committed
664
    for key, obj in self._objects.iteritems():
665
      # export object in xml
666
      f = StringIO()
667
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
668
      bta.addObject(f, key, path=path)
669

Aurel's avatar
Aurel committed
670
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
671
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
672 673
    p = context.getPortalObject()
    for id in id_list:
674
      relative_url = '/'.join([url,id])
675 676
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
677 678
      keep_workflow_history = self.isKeepWorkflowObject(relative_url)
      obj = self.removeProperties(obj, 1, keep_workflow_history)
Vincent Pelletier's avatar
Vincent Pelletier committed
679 680 681
      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
682
        groups = deepcopy(obj.groups)
683
      if id_list:
Aurel's avatar
Aurel committed
684
        self.build_sub_objects(context, id_list, relative_url)
685
        for id_ in list(id_list):
686
          obj._delObject(id_)
687
      if hasattr(aq_base(obj), 'groups'):
688 689 690
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
691

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

720
  def _compileXML(self, file):
721 722 723 724 725 726 727 728 729 730 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
    # 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
768
      p.Parse(data)
769 770 771 772 773 774 775 776 777 778 779

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

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

781 782 783 784 785 786 787
  def getConnection(self, obj):
    while True:
      connection = obj._p_jar
      if connection is not None:
        return connection
      obj = obj.aq_parent

788
  def _importFile(self, file_name, file_obj):
789
    # import xml file
790
    if not file_name.endswith('.xml'):
791
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
792
      return
793
    connection = self.getConnection(self.aq_parent)
794
    __traceback_info__ = 'Importing %s' % file_name
795 796
    if hasattr(cache_database, 'db') and isinstance(file_obj, file):
      obj = connection.importFile(self._compileXML(file_obj))
797
    else:
798 799
      # FIXME: Why not use the importXML function directly? Are there any BT5s
      # with actual .zexp files on the wild?
800
      obj = connection.importFile(file_obj, customImporters=customImporters)
801 802
    self._objects[file_name[:-4]] = obj

803
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
804 805
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
806 807
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
808
      for path, obj in self._objects.iteritems():
809
        if installed_item._objects.has_key(path):
810
          upgrade_list.append((path, installed_item._objects[path]))
811
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
812
          modified_object_list[path] = 'New', type_name
813

Julien Muchembled's avatar
Julien Muchembled committed
814 815 816 817 818 819 820 821 822
      # 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()
823 824 825
        try:
          OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
          old_obj_xml = old_io.getvalue()
826 827
        except (ImportError, UnicodeDecodeError), e: # module is already
                                                     # removed etc.
828
          old_obj_xml = '(%s: %s)' % (e.__class__.__name__, e)
Julien Muchembled's avatar
Julien Muchembled committed
829 830 831
        new_io.close()
        old_io.close()
        if new_obj_xml != old_obj_xml:
832 833 834 835
          if context.isKeepObject(path):
            modified_object_list[path] = 'Modified but should be kept', type_name
          else:
            modified_object_list[path] = 'Modified', type_name
836
      # get removed object
837
      for path in set(installed_item._objects) - set(self._objects):
838 839 840 841
        if context.isKeepObject(path):
          modified_object_list[path] = 'Removed but should be kept', type_name
        else:
          modified_object_list[path] = 'Removed', type_name
842 843
    return modified_object_list

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

873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
  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

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

899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
  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

916 917 918 919 920 921
  def _getObjectKeyList(self):
    # sort to add objects before their subobjects
    keys = self._objects.keys()
    keys.sort()
    return keys

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

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

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

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

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

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

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

1292
        container.manage_delObjects([object_id])
1293
        if container.aq_parent.meta_type == 'ERP5 Catalog' and not len(container):
1294
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1295
          container.getParentValue().manage_delObjects([container.id])
1296
      except (NotFound, KeyError, BadRequest, AttributeError):
1297
        # object is already backup and/or removed
1298
        pass
1299 1300
    BaseTemplateItem.uninstall(self, context, **kw)

1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
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

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

1348 1349 1350
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1351

1352 1353 1354 1355 1356 1357 1358 1359 1360
      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.
1361 1362 1363
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1364
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1365 1366
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1367
      if object_id != "":
1368
        path_list.extend(self._resolvePath(
1369
            folder._getOb(object_id),
1370
            relative_url_list + [object_id], id_list[1:]))
1371
    return path_list
Aurel's avatar
Aurel committed
1372

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1403 1404 1405 1406 1407 1408 1409 1410
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)

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

1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
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")
1470
    if len(id_list) != 1:
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
      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():
1483
      pref = portal.unrestrictedTraverse(object_path)
1484
      # XXX getPreferenceState is a bad name
1485
      if pref.getPreferenceState() == 'disabled':
1486 1487
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1488 1489
        portal.portal_workflow.doActionFor(
                      pref,
1490 1491 1492
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1493 1494
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1495

1496 1497
class CategoryTemplateItem(ObjectTemplateItem):

1498 1499
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1500

1501 1502 1503 1504
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1505 1506
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1507 1508
      keep_workflow_history = self.isKeepWorkflowObject(relative_url)
      obj = self.removeProperties(obj, 1, keep_workflow_history)
1509
      id_list = obj.objectIds()
1510
      if id_list:
1511
        self.build_sub_objects(context, id_list, relative_url)
1512
        for id_ in list(id_list):
1513
          obj._delObject(id_)
1514 1515
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1516 1517 1518 1519 1520

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1521 1522 1523 1524 1525 1526 1527 1528
      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
1529
      _recursiveRemoveUid(obj)
1530 1531
      keep_workflow_history = self.isKeepWorkflowObject(relative_url)
      obj = self.removeProperties(obj, 1, keep_workflow_history)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1532
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1533
      id_list = obj.objectIds()
1534 1535
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1536
        for id_ in list(id_list):
1537
          obj._delObject(id_)
1538
      else:
1539
        for id_ in list(id_list):
1540
          obj._delObject(id_)
1541 1542
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1543

1544 1545 1546
  def beforeInstall(self):
    self._installed_new_category = False

1547
  def onNewObject(self, obj):
1548 1549 1550 1551
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1552
      # reset accessors if we installed a new category
1553
      self.portal_types.resetDynamicDocumentsOnceAtTransactionBoundary()
1554

1555 1556
class SkinTemplateItem(ObjectTemplateItem):

1557 1558
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1559

1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
  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')

1570 1571
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584
    # 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

1585
  def install(self, context, trashbin, **kw):
1586
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1587 1588
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1589
    p = context.getPortalObject()
1590
    skin_tool = p.portal_skins
1591
    for relative_url in self._objects.keys():
1592
      # Do not register skin which were explicitely ask not to be installed
1593 1594 1595 1596 1597
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1598
      folder = self.unrestrictedResolveValue(p, relative_url)
1599 1600
      for obj in folder.objectValues(spec=('Z SQL Method',)):
        fixZSQLMethod(p, obj)
1601 1602 1603 1604
      if folder.aq_parent.meta_type == 'CMF Skins Tool':
        registerSkinFolder(skin_tool, folder)

class RegisteredSkinSelectionTemplateItem(BaseTemplateItem):
1605 1606 1607 1608 1609 1610 1611 1612
  # BUG: Let's suppose old BT defines
  #         some_skin | Skin1
  #         some_skin | Skin2
  #      and new BT has:
  #         some_skin | Skin1
  #      Because 'some_skin' is still defined, it will be updated (actually
  #      'install') and not removed ('uninstall'). But we don't compare with
  #      old BT so we don't know we must unregister Skin2.
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624

  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',
          [])
1625 1626 1627
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1628
      if skin_selection_id in selection_list:
1629
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1630
      else:
1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
        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):
1650
    if not self._objects:
1651 1652
      return
    # export workflow chain
1653 1654 1655
    bta.addObject(self.generateXml(),
                  name='registered_skin_selection',
                  path=self.__class__.__name__)
1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670

  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]
1671 1672 1673
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1674

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

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

1697 1698
        unregisterSkinFolderId(skin_tool, skin_folder_id,
                               skin_tool.getSkinSelections())
1699
        registerSkinFolder(skin_tool, skin_folder)
1700 1701

  def uninstall(self, context, **kw):
1702 1703
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')
1704 1705
    object_path = kw.get('object_path')
    for skin_folder_id in (object_path,) if object_path else self._objects:
1706
      skin_selection_list = self._objects[skin_folder_id]
1707 1708
      if isinstance(skin_selection_list, str):
        skin_selection_list = skin_selection_list.replace(',', ' ').split(' ')
1709 1710 1711 1712 1713 1714 1715
      skin_folder = skin_tool.get(skin_folder_id)
      if skin_folder is not None:
        current_selection_set = set(skin_folder.getProperty(
          'business_template_registered_skin_selections', ()))
        current_selection_set.difference_update(skin_selection_list)
        if current_selection_set:
          skin_folder._updateProperty(
1716
            'business_template_registered_skin_selections',
1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727
            list(current_selection_set))
          # Unregister skin folder from skin selection
          unregisterSkinFolderId(skin_tool, skin_folder_id, skin_selection_list)
          continue
      # Delete all skin selection
      for skin_selection in skin_selection_list:
        deleteSkinSelection(skin_tool, skin_selection)
      if skin_folder is not None:
        del skin_folder.business_template_registered_skin_selections
        # Register to all other skin selection
        registerSkinFolder(skin_tool, skin_folder)
1728

1729
  def preinstall(self, context, installed_item, **kw):
1730 1731 1732 1733
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
1734
        if installed_item._objects.has_key(path):
1735 1736
          # compare object to see it there is changes
          new_object = self._objects[path]
1737
          old_object = installed_item._objects[path]
1738 1739 1740 1741 1742
          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
1743
      old_keys = installed_item._objects.keys()
1744 1745 1746 1747 1748 1749 1750
      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'):
1751
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1752 1753 1754 1755
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
1756 1757 1758
    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
1759 1760
      if not selection_string:
        selection_list = []
1761
      else:
1762 1763
        selection_list = selection_string.split(',')
      skin_selection_dict[skin_folder_id] = selection_list
1764
    self._objects = skin_selection_dict
1765 1766


1767
class WorkflowTemplateItem(ObjectTemplateItem):
1768

1769 1770
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1771

1772 1773 1774 1775 1776
  # 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.

1777
  def preinstall(self, context, installed_item, installed_bt, **kw):
1778
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
1779
                                                         installed_item, **kw)
1780 1781 1782 1783
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1784
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1785 1786
      else:
        modified_workflow_dict[modified_object] = state
1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
    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])
1809 1810
    return modified_workflow_dict

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

1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
  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)
1864

1865 1866
class PortalTypeTemplateItem(ObjectTemplateItem):

1867 1868
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1869 1870
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1871 1872 1873
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1874 1875
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1876
      obj = p.unrestrictedTraverse(relative_url)
1877 1878 1879 1880
      # normalize relative_url, not all type informations are stored in
      # "portal_types"
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])

1881
      obj = obj._getCopy(context)
1882
      obj._p_activate()
1883
      for attr in obj.__dict__.keys():
1884 1885 1886 1887 1888 1889
        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',
1890 1891 1892
                                      'last_id', 'uid') or \
            (attr == 'workflow_history' and
             not self.isKeepWorkflowObject(relative_url)):
1893
          delattr(obj, attr)
1894 1895
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1896

1897 1898 1899 1900 1901 1902 1903 1904 1905 1906
  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__
1907
        if klass.__module__ != 'erp5.portal_type':
1908 1909 1910 1911
          portal_type = obj.portal_type
        else:
          portal_type = klass.__name__
        depend = path_dict.get(portal_type)
1912 1913 1914 1915 1916 1917
        # 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
1918 1919
        cache[path] = score = depend and 1 + solveDependency(depend)[0] or 0
      return score, path
1920
    object_key_list.sort(key=solveDependency)
1921 1922
    return object_key_list

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

1954 1955
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1956 1957 1958
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
1959
      result_dict = {}
1960
      xml = parse(file)
1961
      chain_list = xml.findall('//chain')
1962
      for chain in chain_list:
1963 1964 1965 1966
        portal_type = chain.find('type').text
        workflow = chain.find('workflow').text or ''
        result_dict[portal_type] = workflow
      self._workflow_chain_archive = result_dict
1967 1968 1969
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1970
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1971

1972 1973 1974
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

1975
  def build(self, context, **kw):
1976 1977 1978 1979 1980
    # 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
1981
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1982
    for key in self._archive.keys():
1983 1984 1985
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1986
        workflow = wflist[1]
1987
      else:
1988
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1989
        portal_type = wflist[0][:-2]
1990
        workflow = ''
1991 1992 1993 1994 1995
      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):
1996
          if not self.is_bt_for_diff:
1997 1998 1999
            # 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
2000
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
2001
                       'in chain for portal_type %s' % (workflow_name, portal_type))
2002
        self._objects.setdefault(portal_type, []).append(workflow)
2003
      elif not self.is_bt_for_diff:
2004
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
2005
                        'is probably a sign of a missing dependency.'\
2006
                                                    % portal_type
2007

Christophe Dumez's avatar
Christophe Dumez committed
2008
  # Function to generate XML Code Manually
2009 2010
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
2011 2012 2013
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2014
      workflow_list = self._objects[key]
2015 2016
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
2017 2018
      xml_data += '\n  <workflow>%s</workflow>' %(
        self._chain_string_separator.join(sorted(workflow_list)))
2019 2020
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
2021 2022 2023
    return xml_data

  def export(self, context, bta, **kw):
2024
    if not self._objects:
2025 2026 2027
      return
    # export workflow chain
    xml_data = self.generateXml()
2028 2029
    bta.addObject(xml_data, name='workflow_chain_type',
                  path=self.__class__.__name__)
2030 2031 2032 2033

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2034 2035 2036 2037 2038 2039
    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 = []
2040 2041
    # We now need to setup the list of workflows corresponding to
    # each portal type
2042
    (default_chain, chain_dict) = getChainByType(context)
2043
    # First convert all workflow_ids into list.
2044 2045
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
2046
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
2047
    # best solution, by default it is 'default_workflow', which is
2048 2049
    # not very usefull
    default_chain = ''
2050 2051
    for path in self._objects:
      if path in update_dict or force:
2052 2053 2054
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2055
            continue
Jérome Perrin's avatar
Jérome Perrin committed
2056 2057
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
2058
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
2059
          continue
2060
        portal_type = path_splitted[-1]
2061 2062
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
2063
          # XXX we don't use the chain (Default) in erp5 so don't keep it
2064 2065 2066 2067 2068 2069
          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]
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089
          # 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)
2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100
          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
2101
              wf_id = wf_id.lstrip('+')
2102
              old_chain_workflow_id_set.add(wf_id)
2103
            # create the new chain
2104 2105
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
2106 2107
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
2108
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
2109 2110 2111
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
2112
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
2113
        else:
2114
          if context.portal_types.getTypeInfo(portal_type) is None:
2115
            raise ValueError('Cannot chain workflow %r to non existing '
2116 2117 2118 2119 2120
                           '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.
2121 2122
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
2123 2124
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2125

2126 2127
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
2128 2129
    object_path = kw.get('object_path', None)
    if object_path is not None:
2130
      object_key_list = [object_path]
2131
    else:
2132 2133 2134
      object_key_list = self._objects.keys()
    for object_key in object_key_list:
      path_splitted = object_key.split('/', 1)
2135 2136 2137
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
2138 2139 2140 2141 2142 2143 2144 2145 2146 2147
      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]
2148
        else:
2149 2150 2151 2152
          chain_dict[path] = self._chain_string_separator.\
                                                  join(workflow_id_list)
    context.getPortalObject().portal_workflow.\
                                   manage_changeWorkflows('', props=chain_dict)
2153

2154
  def preinstall(self, context, installed_item, **kw):
2155 2156
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2157
      new_key_list = self._objects.keys()
2158 2159
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
2160
      for key, value in installed_item._objects.iteritems():
2161 2162
        if not 'portal_type_workflow_chain/' in key:
          key = 'portal_type_workflow_chain/%s' % (key)
2163
        new_dict[key] = value
2164
      if new_dict:
2165
        installed_item._objects = new_dict
2166 2167
      for path in new_key_list:
        if path in installed_item._objects:
2168 2169
          # compare object to see it there is changes
          new_object = self._objects[path]
2170
          old_object = installed_item._objects[path]
2171 2172 2173 2174 2175 2176
          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()
2177
          if new_object != old_object:
2178
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2179
        else: # new object
2180
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2181
      # get removed object
2182 2183 2184
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2185 2186
    return modified_object_list

2187
  def _importFile(self, file_name, file):
2188
    if not file_name.endswith('.xml'):
2189
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2190
      return
2191
    # import workflow chain for portal_type
2192
    result_dict = {}
2193
    xml = parse(file)
2194
    chain_list = xml.findall('chain')
2195
    for chain in chain_list:
2196
      portal_type = chain.find('type').text
2197
      workflow_chain = chain.find('workflow').text or ''
2198
      if 'portal_type_workflow_chain/' not in portal_type:
2199 2200 2201 2202
        key = 'portal_type_workflow_chain/%s' % (portal_type,)
      else:
        key = portal_type
      result_dict[key] = workflow_chain.split(self._chain_string_separator)
2203
    self._objects = result_dict
2204

2205 2206
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2207

2208
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
2209 2210 2211
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
2212 2213
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
2214
  business_template_class_property = '_portal_type_allowed_content_type_item'
2215 2216

  def build(self, context, **kw):
2217
    types_tool = getToolByName(self.getPortalObject(), 'portal_types')
2218
    for key in self._archive.keys():
2219 2220 2221 2222
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
2223
      ob = types_tool.getTypeInfo(portal_type)
2224
      # check properties corresponds to what is defined in site
2225
      if ob is None:
2226
        raise ValueError, "Portal Type %r not found in site" %(portal_type,)
2227
      prop_value = getattr(ob, self.class_property, ())
2228 2229 2230 2231 2232 2233 2234
      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
2235
        raise ValueError, "%s %s not found in portal type %s" % (
2236 2237
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)
2238

Christophe Dumez's avatar
Christophe Dumez committed
2239
  # Function to generate XML Code Manually
2240 2241
  def generateXml(self, path=None):
    xml_data = '<%s>' %(self.xml_tag,)
2242 2243 2244
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2245
      id_value = key.replace('%s/' % self.class_property, '')
2246
      allowed_item_list = sorted(self._objects[key])
2247
      xml_data += '\n <portal_type id="%s">' % (id_value)
2248
      for allowed_item in allowed_item_list:
2249 2250 2251
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
2252 2253 2254
    return xml_data

  def export(self, context, bta, **kw):
2255
    if not self._objects:
2256 2257
      return
    xml_data = self.generateXml(path=None)
2258 2259
    bta.addObject(xml_data, name=self.class_property,
                  path=self.__class__.__name__)
2260

2261
  def preinstall(self, context, installed_item, **kw):
2262 2263
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2264
      new_key_list = self._objects.keys()
2265 2266
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
Nicolas Delaby's avatar
Nicolas Delaby committed
2267
      for key, value in installed_item._objects.iteritems():
2268
        if self.class_property not in key:
2269
          key = '%s/%s' % (self.class_property, key)
Nicolas Delaby's avatar
Nicolas Delaby committed
2270
        new_dict[key] = value
2271
      if new_dict:
2272
        installed_item._objects = new_dict
2273 2274
      for path in new_key_list:
        if path in installed_item._objects:
2275 2276
          # compare object to see it there is changes
          new_object = self._objects[path]
2277
          old_object = installed_item._objects[path]
2278 2279
          new_object.sort()
          old_object.sort()
2280
          if new_object != old_object:
2281
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2282
        else: # new object
2283
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2284
      # get removed object
2285 2286 2287
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2288 2289
    return modified_object_list

2290
  def _importFile(self, file_name, file):
2291
    if not file_name.endswith('.xml'):
2292
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2293
      return
2294
    path, name = posixpath.split(file_name)
2295
    xml = parse(file)
2296
    portal_type_list = xml.findall('portal_type')
2297
    for portal_type in portal_type_list:
2298 2299
      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
2300
      if self.class_property not in id:
2301 2302 2303 2304
        key = '%s/%s' % (self.class_property, id,)
      else:
        key = id
      self._objects[key] = item_type_list
2305 2306

  def install(self, context, trashbin, **kw):
Nicolas Delaby's avatar
Nicolas Delaby committed
2307 2308
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2309 2310
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2311 2312 2313 2314 2315 2316 2317
    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
2318
      if key in update_dict or force:
2319 2320 2321 2322
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2323
        portal_id = key.split('/')[-1]
2324
        property_list = self._objects.get(key, [])
2325 2326
        type_information = types_tool.getTypeInfo(portal_id)
        if type_information is None:
2327 2328
          if not property_list:
            continue
2329 2330
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2331
        old_property_list = old_objects.get(key, ())
2332
        object_property_list = getattr(type_information, self.class_property, ())
Nicolas Delaby's avatar
Nicolas Delaby committed
2333 2334 2335 2336 2337 2338 2339 2340 2341
        # 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)
2342
        setattr(type_information, self.class_property, tuple(property_list))
2343

Aurel's avatar
Aurel committed
2344
  def uninstall(self, context, **kw):
2345
    object_path = kw.get('object_path', None)
Nicolas Delaby's avatar
Nicolas Delaby committed
2346 2347
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2348
    if object_path is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
2349
      object_key_list = [object_path]
2350
    else:
Nicolas Delaby's avatar
Nicolas Delaby committed
2351 2352
      object_key_list = self._objects.keys()
    for key in object_key_list:
2353 2354 2355 2356 2357
      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,))
2358 2359
        continue
      property_list = self._objects[key]
2360
      original_property_list = list(getattr(type_information,
2361
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2362 2363
      for id in property_list:
        if id in original_property_list:
2364
          original_property_list.remove(id)
2365
      setattr(type_information, self.class_property, tuple(original_property_list))
2366

2367

2368 2369
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2370
  name = 'Hidden Content Type'
2371 2372
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2373
  business_template_class_property = '_portal_type_hidden_content_type_item'
2374

2375

2376 2377
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2378
  name = 'Property Sheet'
2379 2380
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2381
  business_template_class_property = '_portal_type_property_sheet_item'
2382

2383

2384 2385
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2386
  name = 'Base Category'
2387 2388
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2389
  business_template_class_property = '_portal_type_base_category_item'
2390

2391

2392
class CatalogMethodTemplateItem(ObjectTemplateItem):
2393
  """Template Item for catalog methods.
2394

2395 2396 2397 2398 2399
    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.
  """
2400

2401 2402
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2403
    # a mapping to store properties of methods.
2404 2405 2406 2407 2408
    # 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()
2409

2410
    self._is_filtered_archive = PersistentMapping()
2411 2412
    for method in catalog_method_filter_list:
      setattr(self, method, PersistentMapping())
2413

2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
  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

2428 2429
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2430

2431
    catalog = _getCatalogValue(self)
2432
    if catalog is None:
2433
      LOG('BusinessTemplate build', 0, 'catalog not found')
2434
      return
2435

2436 2437 2438
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2439

2440 2441
    for obj in self._objects.values():
      method_id = obj.id
2442 2443
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2444 2445 2446 2447 2448 2449
      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]
2450

2451 2452 2453 2454 2455
  def generateXml(self, path):
    obj = self._objects[path]
    method_id = obj.id
    xml_data = '<catalog_method>'
    if self._method_properties.has_key(method_id):
2456
      for method_property, value in self._method_properties[method_id].items():
2457 2458 2459
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2460

2461
      if self._is_filtered_archive.get(method_id):
2462 2463 2464
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2465 2466
          for method in catalog_method_filter_list:
            if method != '_filter_expression_instance_archive':
2467 2468
              value = getattr(self, method, {}).get(method_id)
              if isinstance(value, basestring):
2469 2470 2471
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2472
              elif value:
2473
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2474
                for item in value:
2475 2476
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2477
    xml_data += '\n</catalog_method>\n'
Christophe Dumez's avatar
Christophe Dumez committed
2478
    return xml_data
2479

2480 2481 2482
  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))
2483 2484 2485 2486 2487 2488 2489 2490 2491 2492
    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
2493
    path = self.__class__.__name__
2494 2495 2496 2497 2498
    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)
2499
      bta.addObject(f, key, path=path)
2500 2501
      # add all datas specific to catalog inside one file
      xml_data = self.generateXml(key)
2502
      bta.addObject(xml_data, key + '.catalog_keys', path=path)
2503

2504 2505
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2506
    catalog = _getCatalogValue(self)
2507 2508 2509 2510 2511 2512 2513
    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)
2514

2515 2516 2517
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2518
    new_bt_format = context.getTemplateFormatVersion()
2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534

    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':
2535
              continue
2536 2537 2538 2539
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2540

2541 2542
    for obj in values:
      method_id = obj.id
2543

2544 2545 2546 2547 2548 2549
      # 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
2550
          elif isinstance(old_value, (list, tuple)):
2551 2552 2553 2554
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2555

2556 2557
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2558
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2559
        if context.getTemplateFormatVersion() == 1:
2560 2561 2562 2563 2564
          if expression and expression.strip():
            # only compile non-empty expressions
            expr_instance = Expression(expression)
          else:
            expr_instance = None
2565 2566
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2567 2568 2569
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2570
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2571 2572 2573 2574
        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, ())
2575
      elif method_id in catalog.filter_dict.keys():
2576
        catalog.filter_dict[method_id]['filtered'] = 0
2577

2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603
      # 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)
2604

2605 2606 2607 2608 2609 2610
        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)
2611

2612
  def uninstall(self, context, **kw):
2613
    catalog = _getCatalogValue(self)
2614 2615 2616
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2617

2618 2619 2620 2621
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2622 2623 2624 2625
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2626
    else:
2627
      try:
2628 2629 2630 2631
        if context.getTemplateFormatVersion() == 1:
          value = self._objects[object_path]
        else:
          value = self._archive[object_path]
2632 2633
      except KeyError:
        value = None
2634 2635
      if value is not None:
        values.append(value)
2636
    for obj in values:
2637
      method_id = obj.id
2638 2639 2640 2641 2642 2643 2644 2645 2646
      # 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)
2647

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2648
      if catalog.filter_dict.has_key(method_id):
2649
        del catalog.filter_dict[method_id]
2650

2651
    # uninstall objects
2652
    ObjectTemplateItem.uninstall(self, context, **kw)
2653

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

2688
class ActionTemplateItem(ObjectTemplateItem):
2689 2690

  def __init__(self, id_list, **kw):
2691
    # XXX It's look like ObjectTemplateItem __init__
2692 2693 2694 2695 2696 2697
    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

2698 2699
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2700
      Split path tries to split a complex path such as:
2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718

      "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

2719 2720 2721 2722 2723 2724 2725
  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):
2726 2727 2728 2729 2730 2731 2732 2733 2734
    from Products.CMFCore.interfaces import IActionProvider
    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
2735 2736 2737 2738 2739 2740 2741 2742 2743 2744
    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
2745
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2746 2747 2748 2749
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2750 2751 2752 2753
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2754 2755 2756
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2757
      # normalize url
2758 2759 2760 2761 2762
      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]
2763 2764
      action = self._getActionCopy(obj, context, value)
      if action is None:
2765 2766 2767
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2768
      key = posixpath.join(url[-2], url[-1], value)
2769 2770
      keep_workflow_history = self.isKeepWorkflowObject(key)
      self._objects[key] = self.removeProperties(action, 1, keep_workflow_history)
2771
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2772

2773 2774 2775
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2776
    if context.getTemplateFormatVersion() == 1:
2777
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2778 2779
      p = context.getPortalObject()
      for id in self._objects.keys():
2780 2781 2782 2783 2784
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2785 2786 2787
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2788

2789
          if interfaces.ITypeProvider.providedBy(aq_parent(aq_inner(container))):
2790 2791 2792
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2793 2794
            continue

Julien Muchembled's avatar
Julien Muchembled committed
2795 2796
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2797 2798 2799 2800 2801 2802 2803 2804 2805 2806
          from Products.CMFCore.interfaces import IActionProvider
          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,
                'Redirected action import',
                '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
2807
          obj, action = container, obj
2808
          action_list = obj.listActions()
2809
          for index in range(len(action_list)):
2810
            if action_list[index].id == id:
2811
              # remove previous action
2812
              obj.deleteActions(selections=(index,))
2813 2814 2815
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2816
          obj.addAction(
2817
                        id = action.id
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2818
                      , name = action.title
2819
                      , action = action_text
2820 2821 2822 2823
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2824 2825
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2826
                      , priority = action.priority
2827
                      , description = action.description
Aurel's avatar
Aurel committed
2828
                    )
2829
          # sort action based on the priority define on it
2830 2831 2832 2833 2834 2835 2836 2837 2838
          # 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))
2839 2840
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2841
        container.manage_delObjects([obj.id
2842
          for obj in container.getActionInformationList()
2843
          if obj.getReference() in action_dict])
2844
        for name, obj in action_dict.iteritems():
2845
          container._importOldAction(obj).aq_base
2846

Aurel's avatar
Aurel committed
2847
    else:
2848
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2849
      p = context.getPortalObject()
2850 2851
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2852
        relative_url, key, value = self._splitPath(id)
2853 2854
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2855
          if getattr(ai, key) == value:
2856
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2857 2858 2859
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2860
        obj.addAction(
Aurel's avatar
Aurel committed
2861 2862
                      id = action.id
                    , name = action.title
2863
                    , action = action_text
Aurel's avatar
Aurel committed
2864 2865 2866 2867
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2868 2869
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2870
                    )
Aurel's avatar
Aurel committed
2871 2872 2873 2874 2875 2876 2877
        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))
2878 2879
          obj.moveDownActions(selections=tuple(move_down_list))

2880 2881
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2882 2883
    object_path = kw.get("object_path", None)
    if object_path is not None:
2884 2885 2886 2887 2888 2889 2890 2891
      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]
2892
    else:
2893
      keys = self._archive.keys()
2894
    for id in keys:
2895 2896
      if  '|' in id:
        relative_url, value = id.split(' | ')
2897 2898 2899
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
2900
          is_new_action = interfaces.ITypeProvider.providedBy(obj.getParentValue())
2901
          key = is_new_action and 'reference' or 'id'
2902
      else:
2903
        relative_url, key, value = self._splitPath(id)
2904
        obj = p.unrestrictedTraverse(relative_url, None)
2905 2906 2907
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2908
          if getattr(action_list[index], key, None) == value:
2909 2910
            obj.deleteActions(selections=(index,))
            break
2911 2912
      LOG('BusinessTemplate', WARNING,
          'Unable to uninstall action at %s, ignoring' % relative_url )
2913 2914
    BaseTemplateItem.uninstall(self, context, **kw)

2915 2916 2917
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2918
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2919 2920 2921 2922 2923 2924 2925
    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])
2926 2927
      # normalize url
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])
2928
      self._objects[relative_url] = type_role_list = []
2929
      for role in obj.getRoleInformationList():
2930
        type_role_dict = {}
2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947
        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
2948
        type_role_list.append(type_role_dict)
2949
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2950

Christophe Dumez's avatar
Christophe Dumez committed
2951
  # Function to generate XML Code Manually
2952 2953 2954 2955
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2956
      xml_data += "\n  <role id='%s'>" % role['id']
2957
      # uniq
2958
      for property in ('title', 'description', 'condition',
2959 2960 2961
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2962 2963
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2964
          xml_data += "\n   <property id='%s'>%s</property>" % \
2965 2966 2967
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2968
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2969 2970
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2971
          xml_data += "\n   <multi_property "\
2972
          "id='%s'>%s</multi_property>" % (property, prop_value)
2973 2974
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2975
    return xml_data
2976

2977 2978 2979
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
2980
    path = self.__class__.__name__
2981 2982
    for key in self._objects.keys():
      xml_data = self.generateXml(key)
2983 2984
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2985
      name = key.split('/', 1)[1]
2986
      bta.addObject(xml_data, name=name, path=path)
2987 2988

  def _importFile(self, file_name, file):
2989 2990 2991
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2992 2993
    type_roles_list = []
    xml = parse(file)
2994
    xml_type_roles_list = xml.findall('role')
2995
    for role in xml_type_roles_list:
2996 2997 2998 2999
      id = role.get('id')
      if isinstance(id, unicode):
        id = id.encode('utf_8', 'backslashreplace')
      type_role_property_dict = {'id': id}
3000
      # uniq
3001 3002 3003 3004 3005 3006 3007 3008
      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
3009
      # multi
3010 3011 3012 3013 3014 3015 3016 3017
      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)
3018
      type_roles_list.append(type_role_property_dict)
3019
    self._objects['portal_type_roles/%s' % (file_name[:-4],)] = type_roles_list
3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030

  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
3031 3032 3033
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
3034
          # reset roles before applying
3035
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
3036
          type_roles_list = self._objects[roles_path] or []
3037 3038
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
3039 3040 3041
        else:
          raise AttributeError("Path '%r' not found while "
                               "installing roles" % (path, ))
3042 3043 3044

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
3045 3046 3047 3048 3049 3050
    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:
3051
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
3052 3053 3054 3055 3056
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
3057

3058 3059 3060 3061 3062 3063
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
3064 3065
      for property in p.propertyMap():
        if property['id'] == id:
3066
          obj = p.getProperty(id)
3067
          prop_type = property['type']
3068 3069
          break
      else:
3070
        obj = None
3071
      if obj is None and not self.is_bt_for_diff:
3072
        raise NotFound, 'the property %s is not found' % id
3073
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
3074

3075 3076
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
3077
    if not file_name.endswith('.xml'):
3078
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3079
      return
3080
    xml = parse(file)
3081 3082 3083 3084 3085 3086 3087 3088 3089
    for property_node in xml.getroot().findall('property'):
      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)
3090

3091 3092 3093
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3094
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3095 3096
      p = context.getPortalObject()
      for path in self._objects.keys():
3097 3098 3099 3100
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
3101
              continue
3102
          dir, id = posixpath.split(path)
3103
          prop_type, property = self._objects[path]
3104 3105 3106 3107 3108 3109 3110 3111
          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
3112
    else:
3113
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
3114
      p = context.getPortalObject()
3115
      for id, property in self._archive.keys():
3116
        property = self._archive[id]
Aurel's avatar
Aurel committed
3117
        if p.hasProperty(id):
3118 3119 3120 3121 3122 3123 3124
          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'])
3125 3126 3127

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3128 3129 3130 3131 3132 3133
    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:
3134 3135 3136 3137
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3138
  # Function to generate XML Code Manually
3139
  def generateXml(self, path=None):
3140
    xml_data = ''
3141
    prop_type, obj = self._objects[path]
3142
    xml_data += '\n <property>'
3143 3144
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
3145
    if prop_type in ('lines', 'tokens'):
3146
      xml_data += '\n  <value>'
3147
      for item in obj:
3148
        if item != '':
3149
          xml_data += '\n   <item>%s</item>' % escape(str(item))
3150
      xml_data += '\n  </value>'
3151
    else:
3152
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
3153
    xml_data += '\n </property>'
3154 3155
    return xml_data

Aurel's avatar
Aurel committed
3156 3157 3158
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3159 3160 3161 3162
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
3163
      xml_data += self.generateXml(path)
3164
    xml_data += '\n</site_property>'
3165
    bta.addObject(xml_data, name='properties', path=self.__class__.__name__)
3166

3167 3168 3169 3170 3171
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3172 3173 3174 3175 3176 3177 3178
    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()
3179
      mapping['category_list'] = module.getCategoryList()
3180
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3181

Christophe Dumez's avatar
Christophe Dumez committed
3182
  # Function to generate XML Code Manually
3183
  def generateXml(self, path=None):
3184
    mapping = self._objects[path]
3185
    xml_data = ['<module>']
3186
    keys = mapping.keys()
3187 3188
    for key in sorted(keys):
      if key == 'permission_list':
3189
        # separe permission dict into xml
3190
        xml_data.append(' <%s>' % (key, ))
3191
        permission_list = mapping[key]
3192
        for perm in permission_list:
3193
          # the type of the permission defined if we use acquired or not
3194
          if isinstance(perm[1], list):
3195 3196 3197
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
3198
          role_list = list(perm[1])
3199 3200 3201
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
3202
          if (len(role_list) == 0 and ptype == 'list') or \
3203 3204
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
3205
          role_list.sort()
3206 3207
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
3208
          for role in role_list:
3209 3210 3211
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
3212 3213 3214 3215 3216 3217 3218 3219
      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, ))
3220
      else:
3221
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
3222 3223
    xml_data.append('</module>')
    return '\n'.join(xml_data)
3224

3225
  def export(self, context, bta, **kw):
3226
    if len(self._objects) == 0:
3227
      return
3228
    path = self.__class__.__name__
3229 3230
    keys = self._objects.keys()
    keys.sort()
3231
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
3232
      # export modules one by one
3233
      xml_data = self.generateXml(path=key)
3234
      bta.addObject(xml_data, name=key, path=path)
3235

3236
  def install(self, context, trashbin, **kw):
3237
    portal = context.getPortalObject()
3238 3239
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3240
    if context.getTemplateFormatVersion() == 1:
3241
      items = self._objects
3242
    else:
3243 3244
      items = self._archive

3245 3246
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
3247 3248
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
3249
        if not force:
3250
          action = update_dict[path]
3251 3252
          if action == 'nothing':
            continue
3253 3254
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
3255
        module = portal._getOb(module_id, None)
3256 3257
        if module is not None:
          module.portal_type = portal_type
3258
        else:
3259
          module = portal.newContent(id=module_id, portal_type=portal_type)
3260
        module.setTitle(str(mapping['title']))
3261 3262
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
3263
          # By default, Manager only without acquire permission
3264 3265
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
3266
          module.manage_permission(name, roles=role_list, acquire=acquire)
3267 3268
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
3269 3270

  def _importFile(self, file_name, file):
3271 3272 3273
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3274
    mapping = {}
3275
    xml = parse(file)
3276
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3277
      key_node = xml.find(key)
3278
      if key == 'permission_list':
3279 3280 3281 3282 3283 3284 3285
        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))
3286
          else:
3287 3288 3289
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3290
      else:
3291
        mapping[key] = key_node.text or ''
3292 3293

    category_list = []
3294 3295 3296 3297
    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'))
3298 3299
    mapping['category_list'] = category_list

3300
    self._objects[file_name[:-4]] = mapping
3301

3302
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3303 3304 3305
    trash = kw.get('trash', 0)
    if trash:
      return
3306 3307 3308 3309 3310 3311
    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]
3312 3313
    p = context.getPortalObject()
    id_list = p.objectIds()
3314 3315
    for key in keys:
      if key in id_list:
3316
        try:
3317
          if trash and trashbin is not None:
3318
            container_path = key.split('/')
3319 3320
            self.portal_trash.backupObject(trashbin, container_path, 
                                           key, save=1, keep_subobjects=1)
3321
          p.manage_delObjects([key])
3322
        except NotFound:
3323
          pass
3324 3325
    BaseTemplateItem.uninstall(self, context, **kw)

3326 3327 3328
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3329 3330

class DocumentTemplateItem(BaseTemplateItem):
3331 3332 3333 3334
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3335

3336 3337 3338 3339 3340 3341 3342 3343 3344 3345
  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

3346 3347
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
3348 3349
    for key in self._archive.iterkeys():
      self._objects[key] = self.local_file_reader_name(key)
Aurel's avatar
Aurel committed
3350

3351
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3352 3353
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3354
      new_keys = self._objects.keys()
3355
      # fix key if necessary in installed bt for diff
3356
      extra_prefix = self.__class__.__name__ + '/'
3357
      for key in installed_item._objects.keys():
3358 3359 3360 3361
        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]
3362
      for path in new_keys:
3363
        if installed_item._objects.has_key(path):
3364 3365
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3366
          old_obj_code = installed_item._objects[path]
3367
          if new_obj_code != old_obj_code:
3368
            # Note: Magical way to have unique paths
3369
            modified_object_list.update(
3370
                {self._getKey(path) : ['Modified', self.__class__.__name__[:-12]]})
3371
        else: # new object
3372
          # Note: Magical way to have unique paths
3373
          modified_object_list.update(
3374
                {self._getKey(path) : ['New', self.__class__.__name__[:-12]]})
3375
          # get removed object
3376
      old_keys = installed_item._objects.keys()
3377 3378
      for path in old_keys:
        if path not in new_keys:
3379
          # Note: Magical way to have unique paths
3380
          modified_object_list.update(
3381
                {self._getKey(path) : ['Removed', self.__class__.__name__[:-12]]})
3382 3383
    return modified_object_list

3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398
  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()

3399 3400 3401
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3402
    if context.getTemplateFormatVersion() == 1:
3403
      need_reset = isinstance(self, DocumentTemplateItem)
3404
      for key in self._objects.keys():
3405 3406 3407 3408 3409 3410
        # to achieve non data migration fresh installation parameters
        # differ from upgrade parameteres, so here the check have to be
        # care of both cases
        upgraded_key = self._getKey(key)
        if update_dict.has_key(key) or update_dict.has_key(upgraded_key) \
            or force:
3411
          if not force:
3412
            action = update_dict.get(key, update_dict.get(upgraded_key))
3413 3414
            if action == 'nothing':
              continue
3415 3416
          text = self._objects[key]
          path, name = posixpath.split(key)
3417
          try:
3418
            self.local_file_writer_name(name, text, create=0)
3419
          except IOError, error:
3420 3421
            LOG(self.__class__.__name__, WARNING,
                "Cannot install class %r on file system" % name)
3422
            if error.errno:
3423
              raise
3424
            continue
3425 3426 3427
          if self.local_file_importer_name is None:
            continue
          if need_reset:
3428
            self._resetDynamicModules()
3429 3430
            need_reset = False
          self.local_file_importer_name(name)
Aurel's avatar
Aurel committed
3431
    else:
3432
      BaseTemplateItem.install(self, context, trashbin, **kw)
3433 3434
      for key in self._archive.keys():
        text = self._archive[key]
Aurel's avatar
Aurel committed
3435
        # This raises an exception if the file exists.
3436
        self.local_file_writer_name(key, text, create=1)
Aurel's avatar
Aurel committed
3437
        if self.local_file_importer_name is not None:
3438
          self.local_file_importer_name(key)
3439

3440 3441 3442 3443 3444 3445 3446 3447 3448 3449
  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)

3450
  def uninstall(self, context, **kw):
3451
    object_path = kw.get('object_path', None)
3452 3453 3454 3455
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
3456 3457 3458 3459 3460
    if object_keys:
      if isinstance(self, DocumentTemplateItem):
        self._resetDynamicModules()
      for key in object_keys:
        self.local_file_remover_name(key)
3461 3462
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3463 3464 3465
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3466 3467 3468 3469 3470 3471
    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
3472
      bta.addObject(obj, name=key, ext='.py')
Aurel's avatar
Aurel committed
3473

3474
  def _importFile(self, file_name, file):
3475 3476 3477
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3478
    text = file.read()
3479
    self._objects[file_name[:-3]] = text
3480

3481 3482
class FilesystemToZodbTemplateItem(DocumentTemplateItem,
                                   ObjectTemplateItem):
3483
  """
3484 3485 3486
  Abstract class to allow migration from DocumentTemplateItem to
  ObjectTemplateItem, this is useful for migration from filesystem to ZODB for
  PropertySheets and Components
3487
  """
3488 3489
  # If set to False, then the migration from filesystem to ZODB will be
  # performed, meaningful only until the code is stable
3490
  _perform_migration = True
3491

3492 3493 3494 3495 3496 3497 3498 3499 3500
  _tool_id = None

  @staticmethod
  def _getZodbObjectId(id):
    return id

  def __init__(self, id_list, tool_id=None, context=None, **kw):
    if tool_id is None:
      tool_id = self._tool_id
3501

3502 3503 3504 3505 3506
    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()
3507
      tool = getattr(context.getPortalObject(), self._tool_id, None)
3508
    if tool is not None:
3509
      existing_set = set(tool.objectIds())
3510
      for i, id in enumerate(id_list):
3511 3512 3513
        if id in existing_set:
          # if the object is on ZODB, use it.
          id_list[i] = "%s/%s" % (self._tool_id, self._getZodbObjectId(id))
3514

3515 3516
    BaseTemplateItem.__init__(self, id_list, **kw)

3517
  def _is_already_migrated(self, object_key_list):
3518
    """
3519 3520 3521
    Objects have already been migrated if any keys within the given
    object_key_list (either '_objects.keys()' or '_archive.keys()') contains a
    key starting by 'tool_id/'
3522 3523
    """
    return len(object_key_list) != 0 and \
3524
        object_key_list[0].startswith(self._tool_id + '/')
3525 3526 3527

  def _filesystemCompatibilityWrapper(method_name, object_dict_name):
    """
3528 3529 3530
    Call ObjectTemplateItem method when the objects have already been
    migrated, otherwise fallback on DocumentTemplateItem method for
    backward-compatibility
3531 3532 3533
    """
    def inner(self, *args, **kw):
      if self._is_already_migrated(getattr(self, object_dict_name).keys()):
3534
        result = getattr(ObjectTemplateItem, method_name)(self, *args, **kw)
3535
      else:
3536
        result = getattr(DocumentTemplateItem, method_name)(self, *args, **kw)
3537

3538
      return result
3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564
    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)

3565
  def remove(self, context, **kw):
3566
    """
3567
    Conversion of magically uniqued paths to real ones
3568
    """
3569 3570 3571 3572 3573 3574 3575
    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)
3576 3577

  @staticmethod
3578 3579
  def _getFilesystemPath(class_id):
    raise NotImplementedError
3580

3581 3582 3583 3584 3585 3586 3587 3588 3589
  @staticmethod
  def _migrateFromFilesystem(tool, filesystem_path, filesystem_file, class_id):
    raise NotImplementedError

  def _migrateAllFromFilesystem(self,
                                context,
                                migrate_object_dict,
                                object_dict,
                                update_parameter_dict):
3590 3591 3592 3593 3594 3595 3596
    """
    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
    """
3597 3598 3599
    # Migrate all the filesystem classes of the Business Template if any
    tool = getattr(context.getPortalObject(), self._tool_id)
    id_set = set(tool.objectIds())
3600

3601 3602 3603
    # careful, that dictionary will change
    class_id_list = migrate_object_dict.keys()
    for class_id in class_id_list:
3604 3605 3606
      # 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
3607
      if class_id in id_set:
Nicolas Delaby's avatar
Typo  
Nicolas Delaby committed
3608
        # XXX a Conduit must be able to merge modifications
3609
        # from FS PropertySheets into ZODB PropertySheets
3610 3611 3612
        warn('Conflict when migrating classes %s: already exists in %s and '\
               'cannot be updated automatically for now.' % (class_id,
                                                             self._tool_id),
3613
             UserWarning)
3614 3615 3616
        del migrate_object_dict[class_id]
        if class_id in object_dict:
          del object_dict[class_id]
3617
        continue
3618

3619
      filesystem_path = self._getFilesystemPath(class_id)
3620 3621 3622 3623

      # A filesystem Property Sheet may already exist in the instance
      # home if the Business Template has been previously installed,
      # otherwise it is created
3624 3625
      if os.path.exists(filesystem_path):
        filesystem_file = open(filesystem_path)
3626
      else:
Arnaud Fontaine's avatar
Arnaud Fontaine committed
3627
        filesystem_file = open(filesystem_path, 'w+')
3628 3629
        filesystem_file.write(migrate_object_dict[class_id])
        filesystem_file.seek(0)
3630 3631

      try:
3632 3633 3634 3635
        migrated_object = self._migrateFromFilesystem(tool,
                                                      filesystem_path,
                                                      filesystem_file,
                                                      class_id).aq_base
3636 3637

      finally:
3638 3639
        filesystem_file.close()
        os.remove(filesystem_path)
3640 3641

      # Update 'migrate_object_dict' with the new path
3642
      key = '%s/%s' % (self._tool_id, migrated_object.getId())
3643

3644
      migrate_object_dict[key] = migrated_object
3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660
      del migrate_object_dict[class_id]

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

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

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

3661 3662 3663 3664 3665 3666 3667
    # 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()):
3668 3669 3670 3671
      self._migrateAllFromFilesystem(context,
                                     self._archive,
                                     self._objects,
                                     kw.get('object_to_update'))
3672 3673
    elif bt_format_version == 1 and \
         not self._is_already_migrated(self._objects.keys()):
3674 3675 3676 3677
      self._migrateAllFromFilesystem(context,
                                     self._objects,
                                     self._archive,
                                     kw.get('object_to_update'))
3678 3679 3680

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

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 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746
class PropertySheetTemplateItem(FilesystemToZodbTemplateItem):
  """
  Property Sheets are now stored in ZODB rather than the filesystem.
  However, some Business Templates 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.
  """
  # Only meaningful for filesystem Property Sheets
  local_file_reader_name = staticmethod(readLocalPropertySheet)
  local_file_writer_name = staticmethod(writeLocalPropertySheet)
  local_file_importer_name = staticmethod(importLocalPropertySheet)
  local_file_remover_name = staticmethod(removeLocalPropertySheet)

  _tool_id = 'portal_property_sheets'

  @staticmethod
  def _getFilesystemPath(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 _migrateFromFilesystem(tool,
                             filesystem_path,
                             filesystem_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_path,
                             filesystem_file)

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

    return PropertySheetDocument.importFromFilesystemDefinition(tool, klass)

3747
class ConstraintTemplateItem(DocumentTemplateItem):
3748 3749 3750 3751
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3752

3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767
from Products.ERP5Type.Core.ExtensionComponent import ExtensionComponent as \
    ExtensionComponentDocument

class ExtensionTemplateItem(FilesystemToZodbTemplateItem):
  """
  Extensions are now stored in ZODB rather than on the filesystem. However,
  some Business Templates may still have filesystem Extensions which need to
  be migrated to the ZODB.
  """
  # XXX-arnau: the code is far from being stable
  _perform_migration = False

  _tool_id = 'portal_components'

  # Only meaningful for filesystem Extensions
3768 3769
  local_file_reader_name = staticmethod(readLocalExtension)
  local_file_writer_name = staticmethod(writeLocalExtension)
3770 3771
  # Extension needs no import
  local_file_importer_name = None
3772
  local_file_remover_name = staticmethod(removeLocalExtension)
3773

3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786
  def _importFile(self, file_name, file_obj):
    if (file_name.endswith('.py') and 
        file_obj.name.rsplit(os.path.sep, 2)[-2] == 'portal_components'):
      return

    FilesystemToZodbTemplateItem._importFile(self, file_name, file_obj)

    if file_name.endswith('.xml'):
      obj = self._objects[file_name[:-4]]
      with open("%s.py" % file_obj.name[:-4]) as f:
        obj.text_content = f.read()

  def export(self, context, bta, **kw):
3787
    path = self.__class__.__name__ + '/'
3788
    for key, obj in self._objects.iteritems():
3789 3790 3791 3792 3793 3794 3795
      # Back compatibility with filesystem Extensions
      if isinstance(obj, str):
        if not key.startswith(path):
          key = path + key
        bta.addObject(obj, name=key, ext='.py')
      else:
        obj = obj._getCopy(context)
3796

3797 3798
        f = StringIO(obj.text_content)
        bta.addObject(f, key, path=path, ext='.py')
3799

3800 3801
        del obj.text_content
        transaction.commit()
3802

3803 3804 3805 3806
        # export object in xml
        f = StringIO()
        XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
        bta.addObject(f, key, path=path)
3807

3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826
  @staticmethod
  def _getZodbObjectId(id):
    return 'erp5.component.extension.%s' % id

  @staticmethod
  def _getFilesystemPath(class_id):
    from App.config import getConfiguration
    return os.path.join(getConfiguration().instancehome,
                        "Extensions",
                        "%s.py" % class_id)

  @staticmethod
  def _migrateFromFilesystem(tool,
                             filesystem_path,
                             filesystem_file,
                             class_id):
    return ExtensionComponentDocument.importFromFilesystem(tool,
                                                           filesystem_path)

3827
class TestTemplateItem(DocumentTemplateItem):
3828 3829
  local_file_reader_name = staticmethod(readLocalTest)
  local_file_writer_name = staticmethod(writeLocalTest)
3830
  # Test needs no import
3831
  local_file_importer_name = None
3832
  local_file_remover_name = staticmethod(removeLocalTest)
3833

Aurel's avatar
Aurel committed
3834

3835 3836 3837
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3838 3839 3840

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3841
  def build(self, context, **kw):
3842 3843
    for key in self._archive.iterkeys():
      self._objects[key] = 1
Aurel's avatar
Aurel committed
3844

3845
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3846 3847
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3848
      new_roles = self._objects.keys()
3849 3850 3851 3852 3853 3854
      # 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]
3855
      for role in new_roles:
3856
        if installed_item._objects.has_key(role):
3857 3858 3859 3860
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
3861
      old_roles = installed_item._objects.keys()
3862 3863 3864 3865 3866 3867
      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):
3868
    p = context.getPortalObject()
3869
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3870
    if context.getTemplateFormatVersion() == 1:
3871
      role_set = set(self._objects)
3872
    else:
3873
      role_set = set(self._archive)
3874 3875 3876 3877
    # 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:
3878 3879
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
3880
    # set roles on portal
3881
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
3882 3883

  def _importFile(self, file_name, file):
3884
    if not file_name.endswith('.xml'):
3885
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3886
      return
3887
    xml = parse(file)
3888 3889 3890
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902

  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)

3903 3904 3905 3906 3907 3908 3909 3910 3911
  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
3912
      if role in roles and role not in new_roles:
3913 3914 3915
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3916
  # Function to generate XML Code Manually
3917 3918
  def generateXml(self):
    role_list = self._objects.keys()
3919
    xml_data = '<role_list>'
3920 3921
    for role in sorted(role_list):
      xml_data += '\n <role>%s</role>' % (role,)
3922
    xml_data += '\n</role_list>'
3923 3924
    return xml_data

Aurel's avatar
Aurel committed
3925
  def export(self, context, bta, **kw):
3926
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
3927
      return
3928 3929 3930 3931 3932 3933 3934 3935
    # 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
3936
    bta.addObject(xml_data, name=path)
3937

3938 3939 3940 3941
class CatalogSearchKeyTemplateItem(BaseTemplateItem):
  key_list_attr = 'sql_catalog_search_keys'
  key_list_title = 'search_key_list'
  key_title = 'Search key'
3942

Aurel's avatar
Aurel committed
3943
  def build(self, context, **kw):
3944
    catalog = _getCatalogValue(self)
3945 3946 3947
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3948
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
3949
    key_list = []
3950
    for key in self._archive.keys():
3951
      if key in catalog_key_list:
3952
        key_list.append(key)
3953
      elif not self.is_bt_for_diff:
3954
        raise NotFound, '%s %r not found in catalog' %(self.key_title, key)
3955
    if len(key_list) > 0:
3956
      self._objects['%s/%s' % (self.__class__.__name__, self.key_list_title)] = key_list
3957 3958

  def _importFile(self, file_name, file):
3959 3960 3961
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3962
    xml = parse(file)
3963 3964
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3965

3966
  def install(self, context, trashbin, **kw):
3967
    catalog = _getCatalogValue(self)
3968 3969 3970
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3971

3972
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3973
    if context.getTemplateFormatVersion() == 1:
3974 3975
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3976 3977 3978
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3979
    else:
3980
      keys = self._archive.keys()
3981 3982
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3983
    # XXX same as related key
3984
    if update_dict.has_key(self.key_list_title) or force:
3985
      if not force:
3986
        action = update_dict[self.key_list_title]
3987
        if action == 'nothing':
Aurel's avatar
Aurel committed
3988
          return
3989
      for key in keys:
3990 3991 3992
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
3993

3994
  def uninstall(self, context, **kw):
3995
    catalog = _getCatalogValue(self)
3996 3997 3998
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3999
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
4000
    object_path = kw.get('object_path', None)
4001 4002 4003 4004 4005
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
4006 4007 4008
      if key in catalog_key_list:
        catalog_key_list.remove(key)
    setattr(catalog, self.key_list_attr, catalog_key_list)
4009 4010
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
4011
  # Function to generate XML Code Manually
4012
  def generateXml(self, path=None):
4013
    obj = self._objects[path]
4014
    xml_data = '<key_list>'
4015 4016
    obj.sort()
    for key in obj:
4017 4018
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4019 4020
    return xml_data

Aurel's avatar
Aurel committed
4021 4022 4023
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
4024
    for path in self._objects.keys():
4025
      xml_data = self.generateXml(path=path)
4026
      bta.addObject(xml_data, name=path)
4027

4028 4029 4030 4031
class CatalogResultKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_result_keys'
  key_list_title = 'result_key_list'
  key_title = 'Result key'
4032

4033 4034 4035 4036
class CatalogRelatedKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_related_keys'
  key_list_title = 'related_key_list'
  key_title = 'Related key'
4037

4038
  # override this method to support 'key_list' for backward compatibility.
4039
  def install(self, context, trashbin, **kw):
4040
    catalog = _getCatalogValue(self)
4041 4042 4043
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
4044

4045
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4046
    if context.getTemplateFormatVersion() == 1:
4047
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
4048
        return
4049 4050 4051
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
4052
    else:
4053
      keys = self._archive.keys()
4054 4055
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
4056
    # XXX must a find a better way to manage related key
4057
    if update_dict.has_key(self.key_list_title) or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
4058
      if not force:
4059 4060
        if update_dict.has_key(self.key_list_title):
          action = update_dict[self.key_list_title]
Aurel's avatar
Aurel committed
4061 4062
        else: # XXX for backward compatibility
          action = update_dict['key_list']
Aurel's avatar
Aurel committed
4063 4064 4065
        if action == 'nothing':
          return
      for key in keys:
4066 4067 4068
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
4069

4070 4071 4072 4073
class CatalogResultTableTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_tables'
  key_list_title = 'result_table_list'
  key_title = 'Result table'
4074

4075
# keyword
4076 4077 4078 4079
class CatalogKeywordKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_keyword_search_keys'
  key_list_title = 'keyword_key_list'
  key_title = 'Keyword key'
4080

4081
# datetime
4082 4083 4084 4085
class CatalogDateTimeKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_datetime_search_keys'
  key_list_title = 'datetime_key_list'
  key_title = 'DateTime key'
4086

4087 4088 4089 4090 4091
# 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'
4092

4093 4094 4095 4096 4097
# request
class CatalogRequestKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_request_keys'
  key_list_title = 'request_key_list'
  key_title = 'Request key'
4098

4099 4100 4101 4102 4103
# multivalue
class CatalogMultivalueKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_multivalue_keys'
  key_list_title = 'multivalue_key_list'
  key_title = 'Multivalue key'
4104 4105

# topic
4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124
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'
4125

4126 4127 4128 4129
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4130 4131 4132
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4133
      else: # XXX backward compatibility
4134 4135
        lang = lang_key
        catalog = 'erp5_ui'
4136
      path = posixpath.join(lang, catalog)
4137 4138
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4139 4140 4141
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4142

4143
  def preinstall(self, context, installed_item, **kw):
4144 4145 4146 4147
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
4148
        if installed_item._objects.has_key(path):
4149 4150
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
4151
          old_obj_code = installed_item._objects[path]
4152 4153 4154 4155 4156
          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
4157
      old_keys = installed_item._objects.keys()
4158 4159 4160 4161 4162
      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

4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190
  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', {})
4191 4192
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
4193 4194
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4195
          if not force:
4196
            action = update_dict[key]
4197
            if action == 'nothing':
4198
              continue
4199
          lang, catalog = self._splitKey(key)
4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215

          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)
4216 4217
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4218 4219 4220 4221
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4222
            self._importCatalogLanguage(localizer, catalog, lang, po)
4223 4224
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4225
      for lang, catalogs in self._archive.iteritems():
4226 4227 4228
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258
          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)
4259 4260

  def export(self, context, bta, **kw):
4261
    if len(self._objects) == 0:
4262
      return
4263
    root_path = self.__class__.__name__
4264
    for key, obj in self._objects.iteritems():
4265
      path = os.path.join(root_path, key)
4266
      if '/' in key:
4267
        bta.addObject(obj, 'translation', ext='.po', path=path)
4268 4269 4270 4271 4272
      else:
        xml_data = ['<language>']
        xml_data.append(' <code>%s</code>' % (escape(key), ))
        xml_data.append(' <name>%s</name>' % (escape(obj), ))
        xml_data.append('</language>')
4273
        bta.addObject('\n'.join(xml_data), 'language', path=path)
4274 4275

  def _importFile(self, file_name, file):
4276 4277
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4278 4279
      text = file.read()
      self._objects[file_name[:-3]] = text
4280 4281
    elif name == 'language.xml':
      xml = parse(file)
4282 4283
      name = xml.find('name').text
      code = xml.find('code').text
4284
      self._objects[code] = name
4285

Aurel's avatar
Aurel committed
4286 4287
class LocalRolesTemplateItem(BaseTemplateItem):

4288
  def __init__(self, id_list, **kw):
4289
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4290 4291
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4292 4293 4294
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4295
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4296 4297
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4298
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4299

Christophe Dumez's avatar
Christophe Dumez committed
4300
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4301
  def generateXml(self, path=None):
4302
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4303 4304
    # local roles
    xml_data = '<local_roles_item>'
4305
    xml_data += '\n <local_roles>'
4306
    for key in sorted(local_roles_dict):
4307
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4308 4309
      tuple = local_roles_dict[key]
      for item in tuple:
4310 4311 4312 4313
        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
4314
    if isinstance(xml_data, unicode):
4315
      xml_data = xml_data.encode('utf8')
Aurel's avatar
Aurel committed
4316
    return xml_data
4317

Aurel's avatar
Aurel committed
4318
  def export(self, context, bta, **kw):
4319 4320
    path = self.__class__.__name__
    for key in self._objects:
Aurel's avatar
Aurel committed
4321
      xml_data = self.generateXml(key)
4322 4323
      assert key[:12] == 'local_roles/'
      bta.addObject(xml_data, key[12:], path=path)
Aurel's avatar
Aurel committed
4324 4325

  def _importFile(self, file_name, file):
4326 4327 4328
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4329 4330
    xml = parse(file)
    # local roles
4331
    local_roles_list = xml.findall('//role')
Aurel's avatar
Aurel committed
4332 4333
    local_roles_dict = {}
    for role in local_roles_list:
4334 4335
      id = role.get('id')
      item_type_list = [item.text for item in role]
Aurel's avatar
Aurel committed
4336
      local_roles_dict[id] = item_type_list
4337
    self._objects['local_roles/%s' % (file_name[:-4],)] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348

  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
4349 4350
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4351
        local_roles_dict = self._objects[roles_path][0]
4352
        setattr(obj, '__ac_local_roles__', local_roles_dict)
4353
        obj.reindexObject()
Aurel's avatar
Aurel committed
4354

4355
  def uninstall(self, context, object_path=None, **kw):
Aurel's avatar
Aurel committed
4356
    p = context.getPortalObject()
4357 4358 4359 4360 4361
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
Aurel's avatar
Aurel committed
4362
      path = roles_path.split('/')[1:]
4363 4364 4365 4366 4367 4368
      # 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()
4369

4370 4371 4372
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4373
    in part or completely. Each object is separated from its
4374 4375 4376 4377 4378 4379 4380 4381 4382 4383
    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
4384 4385
      - object without optimal actions
      - list of relation between portal type and workflow
4386 4387 4388 4389 4390 4391 4392 4393 4394 4395

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

    - site property definition
      - id
      - type
4396
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4397

4398 4399
    - document/propertysheet/extension/test definition
      - copy of the local file
4400

4401
    - message transalation definition
4402
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4403

4404 4405
    The Business Template properties are exported to the bt folder with
    one property per file
4406

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4407 4408
    Technology:

4409 4410
    - 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
4411

4412
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4413 4414 4415 4416

    Use case:

    - install core ERP5 (the minimum)
4417

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

4420 4421
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4422
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4423 4424 4425 4426 4427
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4428
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4429 4430 4431

    # Declarative security
    security = ClassSecurityInfo()
4432
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4433 4434 4435 4436

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4437
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4438
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4439
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4440
                      , PropertySheet.BusinessTemplate
4441
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4442 4443
                      )

4444 4445 4446 4447 4448 4449
    # 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."""
4450
         , 'icon'           : 'file_icon.gif'
4451 4452
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
4453
         , 'type_class'     : 'BusinessTemplate'
4454 4455 4456 4457 4458 4459 4460
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4461 4462
    # This is a global variable
    # Order is important for installation
4463 4464 4465
    # We want to have:
    #  * path after module, because path can be module content
    #  * path after categories, because path can be categories content
4466 4467
    #  * path before workflow chain, because path can be a portal type
    #         (until chains are set on portal types with categories)
4468 4469 4470
    #  * skin after paths, because we can install a custom connection string as
    #       path and use it with SQLMethods in a skin.
    #    ( and more )
4471 4472
    _item_name_list = [
      '_product_item',
4473
      '_document_item',
4474
      '_property_sheet_item',
4475
      '_constraint_item',
4476 4477 4478
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4479
      '_tool_item',
4480 4481 4482 4483
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4484
      #'_portal_type_workflow_chain_item',
4485 4486 4487 4488
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4489 4490
      '_category_item',
      '_module_item',
4491
      '_path_item',
4492
      '_skin_item',
4493
      '_registered_skin_selection_item',
4494
      '_preference_item',
4495
      '_action_item',
4496
      '_portal_type_roles_item',
4497
      '_local_roles_item',
4498
      '_portal_type_workflow_chain_item',
4499
      '_catalog_method_item',
4500 4501 4502
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4503
      '_catalog_search_key_item',
4504
      '_catalog_keyword_key_item',
4505
      '_catalog_datetime_key_item',
4506 4507 4508 4509
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4510
      '_catalog_scriptable_key_item',
4511 4512
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4513 4514 4515 4516
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4517 4518 4519 4520 4521 4522
      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
4523
        self._baseGetTemplateFormatVersion()
4524

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4525 4526 4527
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4528

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4529
      return 0
4530

4531
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4532 4533 4534 4535 4536 4537 4538
    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".
4539 4540
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4541
          # XXX Not good to access the attribute directly,
4542 4543 4544
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4545

4546 4547
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4548 4549 4550 4551 4552 4553
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4554
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4555 4556 4557 4558 4559 4560 4561 4562
        """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)
4563

4564 4565
    security.declareProtected(Permissions.ManagePortal, 'storeTemplateItemData')
    def storeTemplateItemData(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4566
      """
4567
        Instanciate and Store Template items into properties.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4568
      """
4569
      # Store all Data
4570 4571
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4572
      self._portal_type_workflow_chain_item = \
4573
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4574 4575 4576 4577
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4578 4579 4580
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4581 4582 4583 4584 4585 4586
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4587
      self._portal_type_roles_item = \
4588
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4589 4590 4591 4592 4593 4594 4595
      self._site_property_item = \
          SitePropertyTemplateItem(self.getTemplateSitePropertyIdList())
      self._module_item = \
          ModuleTemplateItem(self.getTemplateModuleIdList())
      self._document_item = \
          DocumentTemplateItem(self.getTemplateDocumentIdList())
      self._property_sheet_item = \
4596 4597
          PropertySheetTemplateItem(self.getTemplatePropertySheetIdList(),
                                    context=self)
4598 4599
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619
      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())
4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631
      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())
4632 4633
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4634 4635
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4636 4637 4638
      self._catalog_search_key_item = \
          CatalogSearchKeyTemplateItem(
               self.getTemplateCatalogSearchKeyList())
4639 4640
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4641
               self.getTemplateCatalogKeywordKeyList())
4642 4643 4644
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4645 4646
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4647
               self.getTemplateCatalogFullTextKeyList())
4648 4649
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4650
               self.getTemplateCatalogRequestKeyList())
4651 4652
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4653
               self.getTemplateCatalogMultivalueKeyList())
4654 4655 4656
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4657 4658
      self._local_roles_item = \
          LocalRolesTemplateItem(
4659
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4660 4661 4662
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4663 4664 4665
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4666 4667 4668 4669 4670 4671
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4672

4673 4674 4675 4676 4677 4678 4679 4680 4681 4682
    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()

4683
      try:
Julien Muchembled's avatar
Julien Muchembled committed
4684 4685 4686 4687 4688 4689
        from Products.ERP5VCS.WorkingCopy import NotAWorkingCopyError
        try:
          self.setRevision(self.getVcsTool().newRevision())
        except NotAWorkingCopyError:
          raise ImportError
      except ImportError:
4690
        self.updateRevisionNumber()
4691 4692 4693
      self._setTemplateFormatVersion(1)
      self.storeTemplateItemData()

4694 4695
      # Build each part
      for item_name in self._item_name_list:
4696 4697 4698 4699
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4700 4701

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4702
      """
4703
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4704
      """
4705
      return self.portal_templates.publish(self, url, username=username,
4706
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4707

4708
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4709
      """
4710
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4711
      """
4712
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4713

4714 4715 4716 4717 4718
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4719 4720 4721 4722 4723 4724 4725 4726 4727 4728
      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
4729 4730
      return False

4731
    def preinstall(self, check_dependencies=1, **kw):
4732 4733 4734
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4735
      """
4736 4737 4738 4739 4740
      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()
4741

4742 4743
      modified_object_list = {}
      bt_title = self.getTitle()
4744 4745 4746 4747 4748 4749 4750

      #  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)
4751 4752 4753
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4754
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4755

4756
      # if reinstall business template, must compare to object in ZODB
4757
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4758
      # same if we make a diff and select only one business template
4759
      reinstall = 0
4760 4761
      if installed_bt == self:
        reinstall = 1
4762
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
4763 4764
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                   id=INSTALLED_BT_FOR_DIFF)
4765 4766 4767 4768 4769 4770 4771
          # 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)
4772

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4773
      new_bt_format = self.getTemplateFormatVersion()
4774 4775 4776 4777 4778 4779
      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:
4780
          item = getattr(self, item_name, None)
4781 4782 4783 4784
          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
4785

4786
      for item_name in self._item_name_list:
4787
        new_item = getattr(self, item_name, None)
4788
        installed_item = getattr(installed_bt, item_name, None)
4789
        if new_item is not None:
4790
          if installed_item is not None and hasattr(installed_item, '_objects'):
4791
            modified_object = new_item.preinstall(context=self, 
4792 4793
                                                  installed_item=installed_item,
                                                  installed_bt=installed_bt)
4794 4795 4796 4797 4798 4799 4800
            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:
4801
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
4802

4803 4804
      return modified_object_list

4805
    def _install(self, force=1, object_to_update=None, update_translation=0,
4806
                 update_catalog=_MARKER, **kw):
4807
      """
Christophe Dumez's avatar
Christophe Dumez committed
4808
        Install a new Business Template, if force, all will be upgraded or installed
4809 4810
        otherwise depends of dict object_to_update
      """
4811 4812 4813 4814
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4815

4816 4817
      site = self.getPortalObject()
      installed_bt = site.portal_templates.getInstalledBusinessTemplate(
4818
                                                           self.getTitle())
4819 4820
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4821
        if installed_bt.getTemplateFormatVersion() == 0:
4822
          force = 1
4823 4824 4825
        if site.portal_workflow.isTransitionPossible(
            installed_bt, 'replace'):
          installed_bt.replace(self)
4826

4827
      trash_tool = getToolByName(site, 'portal_trash', None)
4828 4829 4830
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4831 4832 4833
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4834

4835 4836 4837
      if not force:
        self.checkDependencies()

4838 4839
      # 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
4840
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 2):
4841 4842 4843 4844 4845
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
4846
      if len(object_to_update) or force:
4847 4848 4849
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
4850 4851
            item.install(self, force=force, object_to_update=object_to_update, 
                               trashbin=trashbin, installed_bt=installed_bt)
4852

4853
      # update catalog if necessary
4854 4855 4856
      if update_catalog is _MARKER and force and self.isCatalogUpdatable():
        # override update_catalog parameter only if value
        # is not explicitely passed.
4857
        update_catalog = 1
4858
      elif update_catalog is _MARKER:
4859
        update_catalog = 0
4860
      if update_catalog:
4861
        catalog = _getCatalogValue(self)
4862
        if (catalog is None) or (not site.isIndexable):
4863 4864 4865 4866 4867
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4868

4869
      # get objects to remove
4870
      # do remove after because we may need backup object from installation
4871
      remove_object_dict = {}
4872 4873
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
4874
          remove_object_dict[path] = action
4875

4876
      # remove object from old business template
4877
      if len(remove_object_dict):
4878
        # XXX: this code assumes that there is an installed_bt
4879
        for item_name in reversed(installed_bt._item_name_list):
4880
          item = getattr(installed_bt, item_name, None)
4881
          if item is not None:
4882
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
4883

4884 4885

      # update tools if necessary
4886 4887 4888 4889 4890
      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)
4891

4892 4893
      # remove trashbin if empty
      if trashbin is not None:
4894
        if len(trashbin) == 0:
4895 4896
          trash_tool.manage_delObjects([trashbin.getId(),])

4897 4898
      if update_catalog:
        site.ERP5Site_reindexAll()
4899

4900 4901
      # Update translation table, in case we added new portal types or
      # workflow states.
4902 4903
      if update_translation:
        site.ERP5Site_updateTranslationTable()
4904

4905 4906
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
4907

4908
    security.declareProtected(Permissions.ManagePortal, 'install')
4909
    install = _install
4910

4911
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4912
    reinstall = _install
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4913

4914
    security.declareProtected(Permissions.ManagePortal, 'trash')
4915 4916
    def trash(self, new_bt, **kw):
      """
4917
        Trash unnecessary items before upgrading to a new business
4918
        template.
4919
        This is similar to uninstall, but different in that this does
4920
        not remove all items.
4921
      """
4922 4923
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4924
        item = getattr(self, item_name, None)
4925 4926
        if item is not None:
          item.trash(
4927
                self,
4928
                getattr(new_bt, item_name))
4929

4930
    def _uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4931
      """
4932
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4933
      """
4934 4935 4936
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4937
        item = getattr(self, item_name, None)
4938
        if item is not None:
4939
          item.uninstall(self, **kw)
4940
      # It is better to clear cache because the uninstallation of a
4941
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
4942
      self.getPortalObject().portal_caches.clearAllCache()
4943

4944 4945
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
    uninstall = _uninstall
4946

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4947
    def _clean(self):
4948
      """
4949
        Clean built information.
4950
      """
4951
      # First, remove obsolete attributes if present.
4952 4953 4954 4955
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4956
                    '_module_archive',
4957 4958 4959
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4960
                    '_property_sheet_archive'):
4961 4962 4963
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4964
      for item_name in self._item_name_list:
4965
        setattr(self, item_name, None)
4966

4967 4968
    security.declareProtected(Permissions.ManagePortal, 'clean')
    clean = _clean
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4969

4970
    security.declareProtected(Permissions.AccessContentsInformation,
4971
                              'getBuildingState')
4972
    def getBuildingState(self, default=None, id_only=1):
4973
      """
4974
        Returns the current state in building
4975
      """
4976
      portal_workflow = getToolByName(self, 'portal_workflow')
4977 4978
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4979
      return wf._getWorkflowStateOf(self, id_only=id_only )
4980

4981
    security.declareProtected(Permissions.AccessContentsInformation,
4982
                              'getInstallationState')
4983
    def getInstallationState(self, default=None, id_only=1):
4984
      """
4985
        Returns the current state in installation
4986
      """
4987
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
4988 4989
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4990
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4991

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4992 4993 4994 4995 4996 4997
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4998
      export_string = portal_templates.manage_exportObject(
4999 5000
                                               id=self.getId(),
                                               toxml=1,
5001
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5002
      return export_string
5003

5004
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5005
      """
5006 5007
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5008
      """
5009 5010
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
5011 5012 5013 5014
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
5015
        # XXX Why do we need to return a tuple ?
5016 5017
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5018

5019
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5020
      """
5021 5022
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5023
      """
5024
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5025

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

5033
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5034
      """
5035 5036
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5037
      """
5038
      return self._getOrderedList('template_workflow_id')
5039

5040
    def getTemplatePortalTypeIdList(self):
5041
      """
5042 5043
      We have to set this method because we want an
      ordered list
5044
      """
5045
      return self._getOrderedList('template_portal_type_id')
5046

5047 5048 5049 5050 5051 5052 5053
    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
5054 5055 5056 5057 5058 5059 5060
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

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

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

5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095
    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')

5096
    def getTemplateActionPathList(self):
5097
      """
5098 5099
      We have to set this method because we want an
      ordered list
5100
      """
5101
      return self._getOrderedList('template_action_path')
5102

5103
    def getTemplatePortalTypeRoleList(self):
5104 5105 5106 5107
      """
      We have to set this method because we want an
      ordered list
      """
5108
      return self._getOrderedList('template_portal_type_role')
5109

5110
    def getTemplateLocalRoleList(self):
5111 5112 5113 5114
      """
      We have to set this method because we want an
      ordered list
      """
5115
      return self._getOrderedList('template_local_role')
5116

5117
    def getTemplateSkinIdList(self):
5118
      """
5119 5120
      We have to set this method because we want an
      ordered list
5121
      """
5122
      return self._getOrderedList('template_skin_id')
5123

5124 5125 5126 5127 5128 5129 5130
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

5131
    def getTemplateModuleIdList(self):
5132
      """
5133 5134
      We have to set this method because we want an
      ordered list
5135
      """
5136
      return self._getOrderedList('template_module_id')
5137 5138 5139 5140 5141 5142 5143

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5145 5146 5147 5148 5149 5150 5151
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175
    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

5176 5177 5178 5179 5180 5181
    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
5182
                   preferences.getPreferredSubversionWorkingCopyList() or ['bt5']):
5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193
        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):
5194
      from Products.ERP5VCS.WorkingCopy import getVcsTool
5195 5196 5197 5198 5199 5200
      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
5201
      from Products.ERP5VCS.WorkingCopy import NotAWorkingCopyError
5202 5203 5204 5205 5206
      try:
        return self.getVcsTool().reference in vcs
      except NotAWorkingCopyError:
        return None in vcs

5207
    security.declareProtected(Permissions.ManagePortal, 'export')
5208
    def export(self, path=None, local=0, bta=None, **kw):
Aurel's avatar
Aurel committed
5209 5210 5211
      """
        Export this Business Template
      """
5212
      if self.getBuildingState() != 'built':
5213
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5214
              'Business Template must be built before export'
5215

5216 5217 5218 5219 5220 5221 5222 5223 5224
      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
5225

5226
      # export bt
Aurel's avatar
Aurel committed
5227
      for prop in self.propertyMap():
5228
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5229
        id = prop['id']
5230
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5231
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5232
          continue
Aurel's avatar
Aurel committed
5233
        value = self.getProperty(id)
5234
        if not value:
5235
          continue
5236
        if prop_type in ('text', 'string', 'int', 'boolean'):
5237
          bta.addObject(str(value), name=id, path='bt', ext='')
5238
        elif prop_type in ('lines', 'tokens'):
5239
          bta.addObject('\n'.join(value), name=id, path='bt', ext='')
5240

Aurel's avatar
Aurel committed
5241 5242 5243
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5244

5245
      return bta.finishCreation()
Aurel's avatar
Aurel committed
5246

5247
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5248 5249
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5250
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5251 5252 5253 5254 5255
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
5256 5257

      self.storeTemplateItemData()
5258

5259 5260
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5261 5262
      # XXX This is not required with portal types as classes.
      #     It is still there for compatibility with non-migrated objects.
5263
      module_id_list = []
5264
      for template_id in self.getTemplateDocumentIdList():
5265 5266 5267
        module_id = 'Products.ERP5Type.Document.' + template_id
        if module_id not in sys.modules:
          module_id_list.append(module_id)
5268
          sys.modules[module_id] = module = imp.new_module(module_id)
5269 5270
          setattr(module, template_id, type(template_id,
            (SimpleItem.SimpleItem,), {'__module__': module_id}))
5271

Aurel's avatar
Aurel committed
5272 5273
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5274

5275 5276
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5277 5278
      for module_id in module_id_list:
        del sys.modules[module_id]
5279

5280 5281 5282 5283 5284
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5285 5286 5287
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5288
      return items_list
5289

5290 5291 5292 5293 5294 5295
    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
      """
5296 5297 5298 5299 5300 5301 5302 5303
      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.
      """
5304 5305
      missing_dep_list = []
      dependency_list = self.getDependencyList()
5306
      if len(dependency_list) > 0:
5307
        for dependency_couple in dependency_list:
5308
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5309
          dependency = dependency_couple_list[0]
5310 5311
          if dependency in (None, ''):
            continue
5312 5313
          version_restriction = None
          if len(dependency_couple_list) > 1:
5314
            version_restriction = dependency_couple_list[1]
5315 5316 5317
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5318 5319 5320
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5321
                  or (version_restriction not in (None, '') and
5322 5323
                     (not self.portal_templates.compareVersionStrings(installed_bt.getVersion(), version_restriction)))):
            missing_dep_list.append((dependency, version_restriction or ''))
5324
      return [' '.join([y for y in x if y]) for x in missing_dep_list]
5325

5326 5327 5328
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
5329
        This is compatible with ERP5VCS look and feel but
5330 5331 5332 5333
        it is preferred in future we use more difflib python library.
      """
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

Aurel's avatar
Aurel committed
5334
    def diffObject(self, REQUEST, **kw):
5335 5336
      """
        Make a diff between an object in the Business Template
5337
        and the same in the Business Template installed in the site
5338 5339 5340 5341
      """

      class_name_dict = {
        'Product' : '_product_item',
5342
        'PropertySheet' : '_property_sheet_item',
5343
        'Constraint' : '_constraint_item',
5344 5345 5346 5347 5348 5349 5350 5351 5352
        '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',
5353
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5354 5355 5356 5357
        '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',
5358 5359 5360
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5361
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5362
        'Path' : '_path_item',
5363
        'Preference' : '_preference_item',
5364
        'Action' : '_action_item',
5365
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5366
        'LocalRoles' : '_local_roles_item',
5367 5368 5369
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5370
        'CatalogSearchKey' : '_catalog_search_key_item',
5371
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5372
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5373 5374 5375 5376
        '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
5377
        'Tool': '_tool_item',
5378
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5379 5380
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5381
        }
5382

5383 5384
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5385

Christophe Dumez's avatar
Christophe Dumez committed
5386
      # Get objects
5387
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5388

5389
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
5390
      # Compare with a given business template
5391
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5392 5393
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5394 5395
        if bt2_id == self.getId():
          compare_to_zodb = 1
5396
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5397 5398
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5399 5400 5401
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5402 5403
          compare_to_zodb = 1
      if compare_to_zodb:
5404 5405
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5406
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5407 5408 5409
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5410

5411 5412
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5413
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5414
        # XXX maybe only build for the given object to gain time
5415
        installed_item.build(self)
5416 5417 5418
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5419

Christophe Dumez's avatar
Christophe Dumez committed
5420
      # Real Zope Objects (can be exported into XML directly by Zope)
5421 5422
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5423
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5424
                     '_skin_item', '_action_item', '_tool_item', ]
5425

Christophe Dumez's avatar
Christophe Dumez committed
5426
      # Not considered as objects by Zope (will be exported into XML manually)
5427
      # XXX Bad naming
5428 5429 5430 5431
      item_list_2 = ['_site_property_item',
                     '_module_item',
                     '_catalog_result_key_item', 
                     '_catalog_related_key_item',
5432
                     '_catalog_result_table_item',
5433
                     '_catalog_search_key_item',
5434
                     '_catalog_keyword_key_item',
5435
                     '_catalog_datetime_key_item',
5436 5437 5438 5439
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5440
                     '_catalog_scriptable_key_item',
5441 5442
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5443 5444 5445 5446 5447 5448
                     '_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',
5449
                     '_portal_type_workflow_chain_item',]
5450

Christophe Dumez's avatar
Christophe Dumez committed
5451
      # Text objects (no need to export them into XML)
5452
      # XXX Bad naming
5453 5454
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5455
                     '_test_item', '_message_translation_item',]
5456

5457
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5458 5459 5460
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5461 5462
        new_object = new_item.removeProperties(new_object, 1)
        installed_object = installed_item.removeProperties(installed_object, 1)
5463
        # XML Export in memory
5464
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5465 5466
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5467
        new_obj_xml = f1.getvalue()
5468
        f1.close()
5469 5470 5471 5472
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5473
        # End of XML export
5474

5475
        # Diff between XML objects
5476 5477
        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
5478
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5479 5480 5481
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5482

5483
      elif item_name in item_list_2:
5484
        # Generate XML code manually
5485 5486
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5487 5488
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5489
        # End of XML Code Generation
5490

5491
        # Diff between XML objects
5492 5493
        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
5494
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5495 5496 5497
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5498

5499
      elif item_name in item_list_3:
5500
        # Diff between text objects
5501 5502 5503 5504
        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
5505
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5506 5507
          diff_msg += '\n'.join(diff_list)
        else:
5508
          diff_msg = 'No diff'
5509

5510
      else:
5511
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5512

5513
      if compare_to_zodb:
5514
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5515

5516
      return diff_msg
5517

5518

5519 5520 5521 5522
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5523 5524
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5525 5526 5527 5528 5529 5530 5531
      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 [])
5532 5533
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5534
      for id in bt_portal_types_id_list:
5535 5536
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5537
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5538
        if portal_type.getRoleInformationList():
5539 5540
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5541

5542 5543 5544 5545
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5546
        action_list = []
5547 5548 5549 5550 5551 5552 5553
        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'):
5554
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5555 5556
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5557

5558 5559 5560 5561
        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)
5562

5563
        for h_id in hidden_content_type_list:
5564 5565 5566
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5567

5568 5569 5570 5571
        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)
5572

5573 5574 5575 5576
        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)
5577

5578 5579 5580 5581
        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)
5582

5583
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5584
                                    if chain != '(Default)']:
5585 5586 5587
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5588

5589 5590 5591 5592
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5593
      bt_action_list.sort()
5594
      bt_wf_chain_list.sort()
5595

5596 5597 5598 5599 5600 5601 5602
      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)
5603 5604 5605 5606 5607 5608 5609 5610 5611
      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:
5612 5613
        raise TemplateConditionError, 'No module defined in business template'

5614 5615 5616 5617 5618 5619 5620 5621
      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:
5622
          return type_list
5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636

        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():
5637
            type_list.update(getChildPortalType(hidden_ptype_id))
5638
        return type_list
5639

5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686
      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

5687 5688 5689
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5690
  setattr(BusinessTemplate, key, None)