BusinessTemplate.py 234 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 collections import defaultdict
32
from Shared.DC.ZRDB import Aqueduct
33
from Shared.DC.ZRDB.Connection import Connection as RDBConnection
34
from Products.ERP5Type.DiffUtils import DiffFile
35
from Products.ERP5Type.Globals import Persistent, PersistentMapping
36
from Acquisition import Implicit, aq_base, aq_inner, aq_parent
37
from AccessControl import ClassSecurityInfo, Unauthorized, getSecurityManager
38
from AccessControl.SecurityInfo import ModuleSecurityInfo
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39
from Products.CMFCore.utils import getToolByName
40
from Products.PythonScripts.PythonScript import PythonScript
41
from Products.ERP5Type.Accessor.Constant import PropertyGetter as ConstantGetter
42
from Products.ERP5Type.Cache import transactional_cached
43
from Products.ERP5Type.Message import translateString
Nicolas Dumazet's avatar
Nicolas Dumazet committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
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
62
from Products.ERP5Type.Utils import convertToUpperCase
63
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
64
from Products.ERP5Type.XMLObject import XMLObject
65
from Products.ERP5Type.dynamic.portal_type_class import synchronizeDynamicModules
66
from Products.ERP5Type.Core.PropertySheet import PropertySheet as PropertySheetDocument
67
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
Aurel's avatar
Aurel committed
68
from OFS.Traversable import NotFound
69
from OFS import SimpleItem, XMLExportImport
70
from cStringIO import StringIO
Aurel's avatar
Aurel committed
71
from copy import deepcopy
72
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
73
import OFS.XMLExportImport
74
from Products.ERP5Type.patches.ppml import importXML
Aurel's avatar
Aurel committed
75
customImporters={
76
    XMLExportImport.magic: importXML,
Aurel's avatar
Aurel committed
77
    }
78
from Products.ERP5Type.patches.WorkflowTool import WorkflowHistoryList
79
from zLOG import LOG, WARNING, INFO
80
from warnings import warn
81
from lxml.etree import parse
82
from xml.sax.saxutils import escape
83
from Products.CMFCore.Expression import Expression
84
from urllib import quote, unquote
85
from difflib import unified_diff
86
import posixpath
Julien Muchembled's avatar
Julien Muchembled committed
87
import transaction
88

89
import threading
90
from ZODB.broken import Broken
91 92
from Products.ERP5.genbt5list import BusinessTemplateRevision, \
  item_name_list, item_set
93 94 95 96 97

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

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

112 113
catalog_method_filter_list = ('_filter_expression_archive',
                              '_filter_expression_instance_archive',
114
                              '_filter_expression_cache_key_archive',
115
                              '_filter_type_archive',)
116

117
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'
118
_MARKER = []
119

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

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

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

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

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

211 212
def registerSkinFolder(skin_tool, skin_folder):
  request = skin_tool.REQUEST
213 214 215
  # 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)
216 217
  register_skin_selection = request.get('your_register_skin_selection', 1)
  reorder_skin_selection = request.get('your_reorder_skin_selection', 1)
218 219
  skin_layer_list = request.get('your_skin_layer_list',
                                skin_tool.getSkinSelections())
220 221 222 223 224

  skin_folder_id = skin_folder.getId()

  try:
    skin_selection_list = skin_folder.getProperty(
225
                 'business_template_registered_skin_selections',
226 227 228 229 230
                 skin_tool.getSkinSelections()
                 )
  except AttributeError:
    skin_selection_list = skin_tool.getSkinSelections()

231 232 233
  if isinstance(skin_selection_list, basestring):
    skin_selection_list = skin_selection_list.split()

234 235 236 237 238 239 240
  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

241 242 243 244 245
  for skin_name in skin_selection_list:

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

    selection = skin_tool.getSkinPath(skin_name) or ''
250
    selection_list = selection.split(',')
251
    if (skin_folder_id not in selection_list):
252
      selection_list.insert(0, skin_folder_id)
253
    if reorder_skin_selection:
254 255
      # Sort by skin priority and ID
      selection_list.sort(key=skin_sort_key)
256
    if (skin_name in skin_layer_list):
257 258 259 260 261 262 263 264 265 266
      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
267
  #  - they are not registered in the default skin selection
268 269 270 271 272 273 274 275 276 277 278
  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()
279
  # add newly created skins to list of skins we care for
280 281 282 283 284 285 286 287
  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:
288 289
        if skin_name in skin_folder.getProperty(
               'business_template_registered_skin_selections', ()):
290 291 292
          break
      except AttributeError:
        pass
293 294
    else:
      skin_tool.manage_skinLayers(chosen=[skin_name], del_skin=1)
295 296
      skin_tool.getPortalObject().changeSkin(None)

297
def unregisterSkinFolderId(skin_tool, skin_folder_id, skin_selection_list):
298 299 300 301 302 303 304 305 306 307
  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)

308
class BusinessTemplateArchive(object):
Aurel's avatar
Aurel committed
309 310
  """
    This is the base class for all Business Template archives
311
  """
312
  def __init__(self, path, **kw):
313
    self.path = path
314
    self.revision = BusinessTemplateRevision()
Aurel's avatar
Aurel committed
315

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
      write = self._writeFile
    except AttributeError:
      if not isinstance(obj, str):
        obj.seek(0)
        obj = obj.read()
329
      self.revision.hash(path, obj)
330 331 332
      self._writeString(obj, path)
    else:
      if isinstance(obj, str):
333
        self.revision.hash(path, obj)
334
        obj = StringIO(obj)
335 336 337
      else:
        obj.seek(0)
        self.revision.hash(path, obj.read())
338
      write(obj, path)
339

340
  def finishCreation(self):
Aurel's avatar
Aurel committed
341 342
    pass

343 344 345
  def getRevision(self):
    return self.revision.digest()

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

360
  def importFiles(self, item):
Aurel's avatar
Aurel committed
361 362 363
    """
      Import file from a local folder
    """
364
    join = os.path.join
365 366
    item_name = item.__class__.__name__
    root = join(os.path.normpath(self.path), item_name, '')
367
    root_path_len = len(root)
368 369 370 371 372 373
    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:
374 375 376 377
      for root, dirs, files in os.walk(root):
        for file_name in files:
          file_name = join(root, file_name)
          with open(file_name, 'rb') as f:
378
            file_name = posixpath.normpath(file_name[root_path_len:])
379 380
            if '%' in file_name:
              file_name = unquote(file_name)
381 382 383 384
            elif item_name == 'bt' and file_name == 'revision':
              continue
            self.revision.hash(item_name + '/' + file_name, f.read())
            f.seek(0)
385
            item._importFile(file_name, f)
386 387 388 389
    finally:
      if hasattr(cache_database, 'db'):
        cache_database.db.close()
        del cache_database.db
390

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

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
  def __init__(self, path, creation=0, importing=0, **kw):
    super(BusinessTemplateTarball, self).__init__(path, **kw)
    if creation:
      self.fobj = StringIO()
      self.tar = tarfile.open('', 'w:gz', self.fobj)
      self.time = time.time()
    elif importing:
      self.tar = tarfile.open(path, 'r:gz')
      self.item_dict = item_dict = defaultdict(list)
      for info in self.tar.getmembers():
        if info.isreg():
          path = info.name.split('/')
          if path[0] == '.':
            del path[0]
          item_dict[path[1]].append(('/'.join(path[2:]), info))
411 412 413 414 415 416 417 418 419 420 421 422

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

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

426
  def importFiles(self, item):
Aurel's avatar
Aurel committed
427 428
    """
      Import all file from the archive to the site
429
    """
430
    extractfile = self.tar.extractfile
431 432
    item_name = item.__class__.__name__
    for file_name, info in self.item_dict.get(item_name, ()):
433 434
      if '%' in file_name:
        file_name = unquote(file_name)
435 436 437 438 439 440
      elif item_name == 'bt' and file_name == 'revision':
        continue
      f = extractfile(info)
      self.revision.hash(item_name + '/' + file_name, f.read())
      f.seek(0)
      item._importFile(file_name, f)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
441

442
class TemplateConditionError(Exception): pass
443
class TemplateConflictError(Exception): pass
444
class BusinessTemplateMissingDependency(Exception): pass
445

446 447 448
ModuleSecurityInfo(__name__).declarePublic('BusinessTemplateMissingDependency',
  'TemplateConditionError', 'TemplateConflictError')

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

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

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

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

  def install(self, context, trashbin, **kw):
495
    pass
496 497 498

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

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

527

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

535 536
  def getKeys(self):
    return self._objects.keys()
537

Aurel's avatar
Aurel committed
538
  def importFile(self, bta, **kw):
539
    bta.importFiles(self)
540

541
  def _removeAllButLastWorkflowHistory(self, obj):
542 543 544 545 546 547
    workflow_history = getattr(obj, 'workflow_history', None)
    if workflow_history is None:
      return
    for workflow_id in workflow_history.keys():
      workflow_history[workflow_id] = WorkflowHistoryList(
        [workflow_history[workflow_id][-1]])
548 549 550 551 552 553

  def removeProperties(self,
                       obj,
                       export,
                       keep_workflow_history=False,
                       keep_workflow_history_last_history_only=False):
554 555
    """
    Remove unneeded properties for export
556
    """
557
    obj._p_activate()
558 559
    klass = obj.__class__
    classname = klass.__name__
560

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

584 585
    for attr in obj.__dict__.keys():
      if attr in attr_set or attr.startswith('_cache_cookie_'):
586 587
        delattr(obj, attr)

588
    if classname == 'PDFForm':
589
      if not obj.getProperty('business_template_include_content', 1):
590
        obj.deletePdfContent()
591 592
    return obj

593 594
  def getTemplateTypeName(self):
    """
595
     Get a meaningfull class Name without 'TemplateItem'. Used to
596 597 598 599 600 601
     present to the user.

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

602
  def restrictedResolveValue(self, context=None, path='', default=_MARKER):
603 604 605 606
    """
      Get the value with checking the security.
      This method does not acquire the parent.
    """
607 608
    return self.unrestrictedResolveValue(context, path, default=default,
                                         restricted=1)
609

610 611
  def unrestrictedResolveValue(self, context=None, path='', default=_MARKER,
                               restricted=0):
612 613 614 615 616 617 618 619 620 621 622
    """
      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:
623
        portal = aq_inner(self.getPortalObject())
624 625 626 627
        container = portal
      else:
        container = context

628 629 630 631
      if restricted:
        validate = getSecurityManager().validate

      while stack:
632
        key = stack.pop()
633 634 635
        try:
          value = container[key]
        except KeyError:
636
          LOG('BusinessTemplate', WARNING,
637 638 639 640
              'Could not access object %s' % (path,))
          if default is _MARKER:
            raise
          return default
641

642 643 644 645 646 647 648 649 650 651 652 653
        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
654

655 656 657
      return value
    else:
      return context
658

659 660 661
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
662
  """
663

664 665 666 667
  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()
668
      self._archive.clear()
669 670 671
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
672

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

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

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

739
  def _compileXML(self, file):
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
    # 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
787
      p.Parse(data)
788 789 790 791 792 793 794 795 796 797 798

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

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

800 801 802 803 804 805 806
  def getConnection(self, obj):
    while True:
      connection = obj._p_jar
      if connection is not None:
        return connection
      obj = obj.aq_parent

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

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

    # update _p_jar property of objects cleaned by removeProperties
    transaction.savepoint(optimistic=True)
    for path, old_object in upgrade_list:
      # compare object to see it there is changes
      new_object = self._objects[path]
      new_io = StringIO()
      old_io = StringIO()
      OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, new_io)
      new_obj_xml = new_io.getvalue()
      try:
        OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
        old_obj_xml = old_io.getvalue()
      except (ImportError, UnicodeDecodeError), e: # module is already
                                                   # removed etc.
        old_obj_xml = '(%s: %s)' % (e.__class__.__name__, e)
      new_io.close()
      old_io.close()
      if new_obj_xml != old_obj_xml:
850
        if context.isKeepObject(path):
851
          modified_object_list[path] = 'Modified but should be kept', type_name
852
        else:
853 854 855 856 857 858 859
          modified_object_list[path] = 'Modified', type_name
    # get removed object
    for path in set(installed_item._objects) - set(self._objects):
      if context.isKeepObject(path):
        modified_object_list[path] = 'Removed but should be kept', type_name
      else:
        modified_object_list[path] = 'Removed', type_name
860 861
    return modified_object_list

862
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
863 864 865
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
866 867 868 869
    if "portal_integrations" in container_path and "module" in object_id:
      # XXX It is impossible to backup integration module as
      # it will call the request and try to get remote data
      return
870
    p = self.getPortalObject()
871
    if trashbin is None: # must return subobjects
872 873 874 875 876 877 878
      subobject_dict = {}
      obj = p.unrestrictedTraverse(container_path)[object_id]
      for subobject_id in obj.objectIds():
        subobject = obj[subobject_id]
        subobject_dict[subobject_id] = subobject._p_jar.exportFile(
            subobject._p_oid, StringIO())
      return subobject_dict
879
    # XXX btsave is for backward compatibility
880
    if action in ('backup', 'btsave', 'save_and_remove',):
881
      save = 1
882
    elif action in ('install', 'remove'):
883
      save = 0
884 885 886
    else:
      # As the list of available actions is not strictly defined,
      # prevent mistake if an action is not handled
887
      raise NotImplementedError, 'Unknown action "%s"' % action
888 889 890
    return p.portal_trash.backupObject(trashbin, container_path, object_id,
                                       save=save, **kw)

891

892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
  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

908
  def onNewObject(self, obj):
909 910 911 912
    """
      Installation hook.
      Called when installation process determined that object to install is
      new on current site (it's not replacing an existing object).
913
      `obj` parameter is the newly created object in its acquisition context.
914 915 916 917
      Can be overridden by subclasses.
    """
    pass

918 919 920 921 922 923 924 925
  def setSafeReindexationMode(self, context):
    """
      Postpone indexations after unindexations.
      This avoids alarming error messages about a single uid being used
      by "deleted" path and reindexed object. This can happen here for
      objects on which the uid was restored: previous object was deleted,
      hence the "deleted" path, and new object does have the same uid.
    """
926 927 928 929 930 931 932
    kw = context.getPlacelessDefaultReindexParameters()
    if kw is None:
      kw = {}
    context.setPlacelessDefaultReindexParameters(**dict(kw,
      activate_kw=dict(kw.get('activate_kw', ()),
                       after_method_id='unindexObject')))
    return kw
933

934 935 936 937 938 939
  def _getObjectKeyList(self):
    # sort to add objects before their subobjects
    keys = self._objects.keys()
    keys.sort()
    return keys

940
  def unindexBrokenObject(self, item_path):
941 942 943 944 945 946 947 948
    """
      Unindex broken objects.

      Corresponding catalog record is not unindexed even after a broken object
      is removed, since the broken object does not implement 'CopySupport'.
      This situation triggers a FATAL problem on SQLCatalog.catalogObjectList
      when upgrading a broken path by ObjectTemplateItem with BusinessTemplate.
      We often get this problem when we are upgrading a quite old ERP5 site
949
      to new one, as several old classes may be already removed/replaced
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
      in the file system, thus several objects tend to be broken.

      Keyword arguments:
      item_path -- the path specified by the ObjectTemplateItem
    """
    def flushActivity(obj, invoke=0, **kw):
      try:
        activity_tool = self.getPortalObject().portal_activities
      except AttributeError:
        return # Do nothing if no portal_activities
      # flush all activities related to this object
      activity_tool.flush(obj, invoke=invoke, **kw)

    class fakeobject:
       def __init__(self, path):
965
         self._physical_path = tuple(path.split('/'))
966 967
       def getPhysicalPath(self):
         return self._physical_path
968

969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
    def recursiveUnindex(catalog, item_path, root_document_path):
      # search the object + sub-objects
      result = catalog(relative_url=(item_path,
                                     item_path.replace('_', r'\_') + '/%'))
      for x in result:
        uid = x.uid
        path = x.path
        unindex(root_document_path, path, uid)

    def unindex(root_document_path, path, uid):
      LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
          'Unindex Broken object at %r.' % (path,))
      # Make sure there is not activity for this object
      flushActivity(fakeobject(path))
      # Set the path as deleted without lock
      catalog.beforeUnindexObject(None,path=path,uid=uid)
      # Then start activity in order to remove lines in catalog,
      # sql wich generate locks
      catalog.activate(activity='SQLQueue',
                       tag='%s' % uid,
                       group_method_id='portal_catalog/uncatalogObjectList',
                       serialization_tag=root_document_path
                       ).unindexObject(uid=uid)

993 994 995 996 997 998 999 1000 1001 1002
    portal = self.getPortalObject()
    try:
      catalog = portal.portal_catalog
    except AttributeError:
      pass
    else:
      # given item_path is a relative_url in reality
      root_path = "/".join(item_path.split('/')[:2])
      root_document_path = '/%s/%s' % (portal.getId(), root_path)
      recursiveUnindex(catalog, item_path, root_document_path)
1003

1004
  def install(self, context, trashbin, **kw):
1005
    self.beforeInstall()
1006 1007
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1008

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 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
    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):
      uid = getattr(aq_base(document), 'uid', None)
      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
    groups = {}
    old_groups = {}
    portal = context.getPortalObject()
    # set safe activities execution order
    original_reindex_parameters = self.setSafeReindexationMode(context)
    object_key_list = self._getObjectKeyList()
    for path in object_key_list:
      __traceback_info__ = path
      # 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

      if update_dict.has_key(path) or force:
        # get action for the oject
        action = 'backup'
        if not force:
          action = update_dict[path]
          if action == 'nothing':
            continue
        # get subobjects in path
        path_list = path.split('/')
        container_path = path_list[:-1]
        object_id = path_list[-1]
        try:
          container = self.unrestrictedResolveValue(portal, container_path)
        except KeyError:
          # parent object can be set to nothing, in this case just go on
          container_url = '/'.join(container_path)
          if update_dict.get(container_url) == 'nothing':
            continue
          # If container's container is portal_catalog,
          # then automatically create the container.
          elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
            # The id match, but better double check with the meta type
            # while avoiding the impact of systematic check
            container_container = portal.unrestrictedTraverse(container_path[:-1])
            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)
          else:
            raise
        saved_uid_dict = {}
        subobjects_dict = {}
        portal_type_dict = {}
        old_obj = container._getOb(object_id, None)
        object_existed = old_obj is not None
        if object_existed:
          if context.isKeepObject(path) and force:
            # do nothing if the object is specified in keep list in
            # force mode.
            continue
          # Object already exists
          recurse(saveHook, old_obj)
          if getattr(aq_base(old_obj), 'groups', None) is not None:
1085
            # we must keep original order groups
1086 1087 1088 1089
            # 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)
1090 1091
          # we force backup since it was an existing object
          subobjects_dict = self._backupObject('backup', trashbin,
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
                                               container_path, object_id)
          # in case of portal types, we want to keep some properties
          if interfaces.ITypeProvider.providedBy(container):
            for attr in ('allowed_content_types',
                         '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, '')
          container.manage_delObjects([object_id])
          # unindex here when it is a broken object
          if isinstance(old_obj, Broken):
            new_obj = self._objects[path]
            # check isIndexable with new one, because the old one is broken
            if new_obj.isIndexable():
              self.unindexBrokenObject(path)

        # install object
        obj = self._objects[path]
        # 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.
        if getattr(aq_base(obj), 'groups', None) is not None:
          # we must keep original order groups
          # because they change when we add subobjects
          groups[path] = deepcopy(obj.groups)
        # copy the object
        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
1126
          # .objectItems(). In these cases, force the
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
          LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
              'Cleaning corrupted BTreeFolder2 object at %r.' % (path,))
          obj._initBTrees()
        obj = obj._getCopy(container)
        self.removeProperties(obj, 0)
        __traceback_info__ = (container, object_id, obj)
        container._setObject(object_id, obj)
        obj = container._getOb(object_id)

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

        # mark a business template installation so in 'PortalType_afterClone' scripts
        # we can implement logical for reseting or not attributes (i.e reference).
        self.REQUEST.set('is_business_template_installation', 1)
        # 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
        obj.isIndexable = ConstantGetter('isIndexable', value=False)
        # 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
        del obj.isIndexable
        if getattr(aq_base(obj), 'reindexObject', None) is not None:
          obj.reindexObject()
        obj.wl_clearLocks()
        if portal_type_dict:
          # set workflow chain
          wf_chain = portal_type_dict.pop('workflow_chain')
          chain_dict = getChainByType(context)[1]
          default_chain = ''
          chain_dict['chain_%s' % (object_id)] = wf_chain
          context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
          # restore some other properties
          obj.__dict__.update(portal_type_dict)
        # import sub objects if there is
        if subobjects_dict:
          # get a jar
          connection = self.getConnection(obj)
          # import subobjects
          for subobject_id, subobject_data in subobjects_dict.iteritems():
            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))
        if obj.meta_type in ('Z SQL Method',):
          fixZSQLMethod(portal, obj)
        # portal transforms specific initialization
        elif obj.meta_type in ('Transform', 'TransformsChain'):
          assert container.meta_type == 'Portal Transforms'
          # skip transforms that couldn't have been initialized
          if obj.title != 'BROKEN':
            container._mapTransform(obj)
        elif obj.meta_type in ('ERP5 Ram Cache',
                               'ERP5 Distributed Ram Cache',):
          assert container.meta_type in ('ERP5 Cache Factory',
                                         'ERP5 Cache Bag')
          container.getParentValue().updateCache()
        elif (container.meta_type == 'CMF Skins Tool') and \
            (old_obj is not None):
          # Keep compatibility with previous export format of
          # business_template_registered_skin_selections
          # and do not modify exported value
1229
          if obj.getProperty('business_template_registered_skin_selections',
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
                             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')
        # 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)

        recurse(restoreHook, obj)
    # now put original order group
    # we remove object not added in forms
    # we put old objects we have kept
    for path, new_groups_dict in groups.iteritems():
      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
        # excetp the one that had to be removed
        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'):
            continue
          widget_in_form = 0
1270
          for group_id, group_value_list in new_groups_dict.iteritems():
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
            if widget_id in group_value_list:
              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:
            for old_group_id, old_group_values in old_groups_dict.iteritems():
              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
1285
            else:
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
              if new_groups_dict.has_key('not_assigned'):
                new_groups_dict['not_assigned'].append(widget_id)
              else:
                new_groups_dict['not_assigned'] = [widget_id,]
                obj.group_list = list(obj.group_list) + ['not_assigned']
        # second check all widget_id in order are in form
        for group_id, group_value_list in new_groups_dict.iteritems():
          for widget_id in tuple(group_value_list):
            if widget_id not in widget_id_list:
              # if we don't find the widget id in the form
              # remove it fro the group
              group_value_list.remove(widget_id)
        # now set new group object
        obj.groups = new_groups_dict
    # restore previous activities execution order
    context.setPlacelessDefaultReindexParameters(**original_reindex_parameters)
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
    to_delete_dict = {}
    # XXX: it is not clear why update_dict would contain subojects of any
    # element of object_key_list, and not just these objects themselves.
    # XXX: why does update_dict contain the path of documents not managed
    # by current instance ?
    for path, action in update_dict.iteritems():
      if action not in ('remove', 'save_and_remove'):
        continue
      path_match = path + '/'
      for object_key in object_key_list:
        if path_match.startswith(object_key + '/'):
          to_delete_dict[path] = action
1314 1315
    # Sort by path so that, for example, form is created before its fields.
    for path, action in sorted(to_delete_dict.iteritems()):
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
      document = self.unrestrictedResolveValue(portal, path, None)
      if document is None:
        continue
      if getattr(aq_base(document), 'getParentValue', None) is None:
        parent = document.aq_parent
      else:
        parent = document.getParentValue()
      document_id = document.getId()
      self._backupObject(action, trashbin, path.split('/')[:-1],
                         document_id)
      parent.manage_delObjects([document_id])
1327

1328
    self.afterInstall()
1329 1330 1331

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
1332
    trash = kw.get('trash', 0)
1333 1334 1335 1336 1337
    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
1338
      object_keys = self._archive.keys()
1339
    for relative_url in object_keys:
1340 1341
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
1342
      try:
1343
        container = self.unrestrictedResolveValue(portal, container_path)
1344
        container._getOb(object_id) # We force access to the object to be sure
1345 1346
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
1347
        if trash and trashbin is not None:
1348
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
1349
        if container.meta_type == 'CMF Skins Tool':
1350
          # we are removing a skin folder, check and
1351
          # remove if registered skin selection
1352
          unregisterSkinFolderId(container, object_id,
1353 1354
              container.getSkinSelections())

1355
        container.manage_delObjects([object_id])
1356
        if container.aq_parent.meta_type == 'ERP5 Catalog' and not len(container):
1357
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1358
          container.getParentValue().manage_delObjects([container.id])
1359
      except (NotFound, KeyError, BadRequest, AttributeError):
1360
        # object is already backup and/or removed
1361
        pass
1362 1363
    BaseTemplateItem.uninstall(self, context, **kw)

1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
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

1376 1377 1378 1379 1380 1381 1382 1383 1384
  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()
1385 1386
    object_keys.sort()
    object_keys.reverse()
1387 1388
    p = context.getPortalObject()
    for path in object_keys:
1389 1390 1391 1392 1393
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1394 1395 1396
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1397
        try:
Aurel's avatar
Aurel committed
1398 1399
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
1400
          container = self.unrestrictedResolveValue(portal, container_path)
1401
          if trash and trashbin is not None:
1402 1403
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1404
                                           keep_subobjects=1)
1405 1406 1407 1408 1409 1410
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1411 1412 1413
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1414

1415 1416 1417 1418 1419 1420 1421 1422 1423
      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.
1424 1425 1426
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1427
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1428 1429
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1430
      if object_id != "":
1431
        path_list.extend(self._resolvePath(
1432
            folder._getOb(object_id),
1433
            relative_url_list + [object_id], id_list[1:]))
1434
    return path_list
Aurel's avatar
Aurel committed
1435

1436 1437 1438
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1439
    keys = self._path_archive.keys()
1440
    keys.sort()
Aurel's avatar
Aurel committed
1441
    for path in keys:
1442
      include_subobjects = 0
Aurel's avatar
Aurel committed
1443
      if path.endswith("**"):
1444
        include_subobjects = 1
1445
      for relative_url in self._resolvePath(p, [], path.split('/')):
1446 1447
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1448
        obj = obj.__of__(context)
1449
        _recursiveRemoveUid(obj)
1450
        id_list = obj.objectIds()
1451 1452 1453
        obj = self.removeProperties(obj, 1,
                                    self.isKeepWorkflowObject(relative_url),
                                    self.isKeepWorkflowObjectLastHistoryOnly(relative_url))
1454
        if hasattr(aq_base(obj), 'groups'):
1455
          # we must keep groups because it's ereased when we delete subobjects
1456
          groups = deepcopy(obj.groups)
1457
        if len(id_list) > 0:
1458 1459
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1460
          for id_ in list(id_list):
1461
            obj._delObject(id_)
1462
        if hasattr(aq_base(obj), 'groups'):
1463 1464 1465
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1466

1467 1468 1469
  def install(self, context, *args, **kw):
    super(PathTemplateItem, self).install(context, *args, **kw)

1470
    # Regenerate local roles for all paths in this business template
1471 1472
    p = context.getPortalObject()
    portal_type_role_list_len_dict = {}
1473
    update_dict = defaultdict(list)
1474
    for path in self._objects:
1475
      obj = p.unrestrictedTraverse(path, None)
1476
      # Ignore any object without PortalType (non-ERP5 objects)
1477 1478 1479
      try:
        portal_type = aq_base(obj).getPortalType()
      except Exception, e:
1480 1481 1482 1483 1484 1485
        pass
      else:
        if portal_type not in p.portal_types:
          LOG("BusinessTemplate", WARNING,
              "Could not update Local Roles as Portal Type '%s' could not "
              "be found" % portal_type)
1486

1487
          continue
1488

1489 1490 1491
        if portal_type not in portal_type_role_list_len_dict:
          portal_type_role_list_len_dict[portal_type] = \
              len(p.portal_types[portal_type].getRoleInformationList())
1492

1493 1494
        if portal_type_role_list_len_dict[portal_type]:
          update_dict[portal_type].append(obj)
1495

1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
    if update_dict:
      def updateLocalRolesOnDocument():
        for portal_type, obj_list in update_dict.iteritems():
          update = p.portal_types[portal_type].updateLocalRolesOnDocument
          for obj in obj_list:
            update(obj)
            LOG("BusinessTemplate", INFO,
                "Updated Local Roles for '%s' (%s)"
                % (portal_type, obj.getRelativeUrl()))
      transaction.get().addBeforeCommitHook(updateLocalRolesOnDocument)
1506

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1507 1508 1509 1510 1511 1512 1513 1514
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)

1515
  def install(self, context, trashbin, **kw):
1516
    """ When we install a tool that is a type provider not
1517
    registered on types tool, register it into the type provider.
1518
    """
1519 1520 1521 1522
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    for type_container_id, obj in self._objects.iteritems():
1523 1524 1525
      if (interfaces.ITypeProvider.providedBy(obj) and
          type_container_id != types_tool.id and
          type_container_id not in types_tool.type_provider_list):
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
        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()
1547
    types_tool = portal.portal_types
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
    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)
1558

1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
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")
1574
    if len(id_list) != 1:
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
      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():
1587
      pref = portal.unrestrictedTraverse(object_path)
1588
      # XXX getPreferenceState is a bad name
1589
      if pref.getPreferenceState() == 'disabled':
1590 1591
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1592 1593
        portal.portal_workflow.doActionFor(
                      pref,
1594 1595 1596
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1597
        # restore previous activities execution order
1598
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters)
1599

1600 1601
class CategoryTemplateItem(ObjectTemplateItem):

1602 1603
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1604

1605 1606 1607 1608
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1609 1610
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1611 1612 1613
      obj = self.removeProperties(obj, 1,
                                  self.isKeepWorkflowObject(relative_url),
                                  self.isKeepWorkflowObjectLastHistoryOnly(relative_url))
1614
      id_list = obj.objectIds()
1615
      if id_list:
1616
        self.build_sub_objects(context, id_list, relative_url)
1617
        for id_ in list(id_list):
1618
          obj._delObject(id_)
1619 1620
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1621 1622 1623 1624 1625

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1626 1627 1628 1629 1630 1631 1632 1633
      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
1634
      _recursiveRemoveUid(obj)
1635 1636 1637
      obj = self.removeProperties(obj, 1,
                                  self.isKeepWorkflowObject(relative_url),
                                  self.isKeepWorkflowObjectLastHistoryOnly(relative_url))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1638
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1639
      id_list = obj.objectIds()
1640 1641
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1642
        for id_ in list(id_list):
1643
          obj._delObject(id_)
1644
      else:
1645
        for id_ in list(id_list):
1646
          obj._delObject(id_)
1647 1648
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1649

1650 1651 1652
  def beforeInstall(self):
    self._installed_new_category = False

1653
  def onNewObject(self, obj):
1654 1655 1656 1657
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1658
      # reset accessors if we installed a new category
1659
      self.portal_types.resetDynamicDocumentsOnceAtTransactionBoundary()
1660

1661 1662
class SkinTemplateItem(ObjectTemplateItem):

1663 1664
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1665

1666 1667 1668 1669 1670 1671 1672 1673 1674 1675
  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')

1676 1677
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690
    # 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

1691
  def install(self, context, trashbin, **kw):
1692
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1693 1694
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1695
    p = context.getPortalObject()
1696
    skin_tool = p.portal_skins
1697
    for relative_url in self._objects.keys():
1698
      # Do not register skin which were explicitely ask not to be installed
1699 1700
      if not force and update_dict.get(relative_url)  == 'nothing':
        continue
1701
      folder = self.unrestrictedResolveValue(p, relative_url)
1702 1703
      for obj in folder.objectValues(spec=('Z SQL Method',)):
        fixZSQLMethod(p, obj)
1704 1705 1706 1707
      if folder.aq_parent.meta_type == 'CMF Skins Tool':
        registerSkinFolder(skin_tool, folder)

class RegisteredSkinSelectionTemplateItem(BaseTemplateItem):
1708 1709 1710 1711 1712 1713 1714 1715
  # 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.
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727

  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',
          [])
1728 1729 1730
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1731
      if skin_selection_id in selection_list:
1732
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1733
      else:
1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752
        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):
1753
    if not self._objects:
1754 1755
      return
    # export workflow chain
1756 1757 1758
    bta.addObject(self.generateXml(),
                  name='registered_skin_selection',
                  path=self.__class__.__name__)
1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773

  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]
1774 1775 1776
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1777

1778
        if selection_list is default_value:
1779
          create_property = True
1780
          selection_list = self._objects[skin_folder_id]
1781
        else:
1782
          create_property = False
1783 1784 1785 1786 1787
          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])
1788 1789

        # Remove duplicate
1790
        selection_list = list(set(selection_list))
1791 1792 1793
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
1794
              selection_list, type='tokens')
1795 1796 1797
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
1798
              selection_list)
1799

1800 1801
        unregisterSkinFolderId(skin_tool, skin_folder_id,
                               skin_tool.getSkinSelections())
1802
        registerSkinFolder(skin_tool, skin_folder)
1803 1804

  def uninstall(self, context, **kw):
1805 1806
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')
1807 1808
    object_path = kw.get('object_path')
    for skin_folder_id in (object_path,) if object_path else self._objects:
1809
      skin_selection_list = self._objects[skin_folder_id]
1810 1811
      if isinstance(skin_selection_list, str):
        skin_selection_list = skin_selection_list.replace(',', ' ').split(' ')
1812 1813 1814 1815 1816 1817 1818
      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(
1819
            'business_template_registered_skin_selections',
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830
            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)
1831

1832
  def preinstall(self, context, installed_item, **kw):
1833
    modified_object_list = {}
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
    for path in self._objects:
      if installed_item._objects.has_key(path):
        # compare object to see it there is changes
        new_object = self._objects[path]
        old_object = installed_item._objects[path]
        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
    old_keys = installed_item._objects.keys()
    for path in old_keys:
      if path not in self._objects:
        modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
1848 1849 1850 1851
    return modified_object_list

  def _importFile(self, file_name, file):
    if not file_name.endswith('.xml'):
1852
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1853 1854 1855 1856
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
1857 1858 1859
    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
1860 1861
      if not selection_string:
        selection_list = []
1862
      else:
1863 1864
        selection_list = selection_string.split(',')
      skin_selection_dict[skin_folder_id] = selection_list
1865
    self._objects = skin_selection_dict
1866

1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973
class RegisteredVersionPrioritySelectionTemplateItem(BaseTemplateItem):
  def _fillObjectDictFromArchive(self):
    for version_priority in self._archive:
      try:
        version, priority = version_priority.split('|')
        priority = float(priority)
      except ValueError:
        version = version_priority
        priority = 0.

      self._objects[version.strip()] = priority

  def build(self, context, **kw):
    self._fillObjectDictFromArchive()

  def install(self, context, trashbin, **kw):
    if not self._objects:
      return

    portal = context.getPortalObject()
    registered_tuple_list = []
    for value in portal.getVersionPriorityList():
      try:
        version, priority = value.split('|')
        priority = float(priority)
      except ValueError:
        version = value
        priority = 0.

      registered_tuple_list.append((version.strip(), priority))

    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    registered_name_list = set(portal.getVersionPriorityNameList())
    for new_version, new_priority in self._objects.iteritems():
      action = update_dict.get(new_version)
      if (not action or action == 'nothing') and not force:
        continue

      # Merge version and priority defined on this bt and already registered
      # version and priority
      inserted = False
      index = 0
      for (version, priority) in registered_tuple_list:
        if new_version == version:
          if new_priority == priority:
            inserted = True
            break
          else:
            del registered_tuple_list[index]
            continue
        elif not inserted:
          if new_priority > priority:
            registered_tuple_list.insert(index, (new_version, new_priority))
            inserted = True
          elif new_priority == priority and new_version >= version:
            registered_tuple_list.insert(index, (new_version, new_priority))
            inserted = True

        index += 1

      if not inserted:
        registered_tuple_list.append((new_version, new_priority))

    portal.setVersionPriorityList(('%s | %s' % (version, priority)
                                   for version, priority in registered_tuple_list))

  def preinstall(self, context, installed_item, **kw):
    modified_object_list = {}
    class_name_prefix = self.__class__.__name__[:-12]
    for path, new_object in self._objects.iteritems():
      old_object = installed_item._objects.get(path)
      if old_object is not None:
        # Compare object to see it there is any change
        if new_object != old_object:
          modified_object_list.update({path : ['Modified', class_name_prefix]})
      else:
        modified_object_list.update({path : ['New', class_name_prefix]})

    # Get removed objects
    for path in installed_item._objects:
      if path not in self._objects:
        modified_object_list.update({path : ['Removed', class_name_prefix]})

    return modified_object_list

  def importFile(self, bta, **kw):
    super(RegisteredVersionPrioritySelectionTemplateItem,
          self).importFile(bta, **kw)

    self._objects.clear()
    self._fillObjectDictFromArchive()

  def uninstall(self, context, **kw):
    object_path = kw.get('object_path')
    object_list = object_path and (object_path,) or self._objects

    portal = context.getPortalObject()
    registered_list = list(portal.getVersionPriorityList())
    index = 0
    for version in portal.getVersionPriorityNameList():
      if version in object_list:
        del registered_list[index]
      else:
        index += 1

    portal.setVersionPriorityList(registered_list)
1974

1975
class WorkflowTemplateItem(ObjectTemplateItem):
1976

1977 1978
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1979

1980 1981 1982 1983 1984
  # 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.

1985
  def preinstall(self, context, installed_item, installed_bt, **kw):
1986
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
1987
                                                         installed_item, **kw)
1988 1989 1990 1991
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1992
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1993 1994
      else:
        modified_workflow_dict[modified_object] = state
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
    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:
2005 2006 2007 2008 2009 2010
        affected_portal_type_set = {x[6:] for x, y in chain_dict.iteritems()
          if any(workflow_id == y.strip() for y in y.split(','))}
        safe_portal_type_set = {x for x, y in installed_chain_list
                                  if y == workflow_id}
        safe_portal_type_set.difference_update(x for x, y in new_chain_list
                                                 if y == workflow_id)
2011 2012 2013 2014
        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])
2015 2016
    return modified_workflow_dict

2017
  def install(self, context, trashbin, **kw):
2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037
    portal = context.getPortalObject()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # sort to add objects before their subobjects
    for path in sorted(self._objects):
        if force:
          action = 'backup'
        else:
          action = update_dict.get('/'.join(path.split('/')[:2]))
          if action in (None, 'nothing'):
            continue
        container_path = path.split('/')[:-1]
        object_id = path.split('/')[-1]
        try:
          container = self.unrestrictedResolveValue(portal, container_path)
        except KeyError:
          # parent object can be set to nothing, in this case just go on
          container_url = '/'.join(container_path)
          if update_dict.has_key(container_url):
            if update_dict[container_url] == 'nothing':
Julien Muchembled's avatar
Julien Muchembled committed
2038
              continue
2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050
          raise
        container_ids = container.objectIds()
        if object_id in container_ids:    # Object already exists
          self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
          container.manage_delObjects([object_id])
        obj = self._objects[path]
        obj = obj._getCopy(container)
        self.removeProperties(obj, 0)
        container._setObject(object_id, obj)
        obj = container._getOb(object_id)
        obj.manage_afterClone(obj)
        obj.wl_clearLocks()
2051

2052 2053 2054 2055 2056 2057
  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()
2058
    removed_workflow_id_list = {x.split('/', 1)[1] for x in object_keys}
2059 2060
    (default_chain, chain_dict) = getChainByType(context)
    for portal_type, workflow_ids in chain_dict.iteritems():
2061
      workflow_ids = {x.strip() for x in workflow_ids.split(',')} - \
2062 2063 2064 2065 2066
                     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)
2067

2068 2069
class PortalTypeTemplateItem(ObjectTemplateItem):

2070 2071
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2072 2073
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
2074 2075 2076
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
2077 2078
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
2079
      obj = p.unrestrictedTraverse(relative_url)
2080 2081 2082 2083
      # normalize relative_url, not all type informations are stored in
      # "portal_types"
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])

2084
      obj = obj._getCopy(context)
2085
      obj._p_activate()
2086
      for attr in obj.__dict__.keys():
2087 2088 2089 2090 2091 2092
        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',
2093 2094 2095
                                      'last_id', 'uid') or \
            (attr == 'workflow_history' and
             not self.isKeepWorkflowObject(relative_url)):
2096
          delattr(obj, attr)
2097 2098
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
2099

2100 2101 2102 2103 2104 2105 2106 2107 2108 2109
  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__
2110
        if klass.__module__ != 'erp5.portal_type':
2111 2112 2113 2114
          portal_type = obj.portal_type
        else:
          portal_type = klass.__name__
        depend = path_dict.get(portal_type)
2115 2116 2117 2118 2119 2120
        # 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
2121 2122
        cache[path] = score = depend and 1 + solveDependency(depend)[0] or 0
      return score, path
2123
    object_key_list.sort(key=solveDependency)
2124 2125
    return object_key_list

2126 2127
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
2128 2129 2130 2131
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2132 2133
    # We now need to setup the list of workflows corresponding to
    # each portal type
2134
    (default_chain, chain_dict) = getChainByType(context)
2135
    # Set the default chain to the empty string is probably the
2136
    # best solution, by default it is 'default_workflow', which is
2137
    # not very usefull
2138
    default_chain = ''
2139
    for path, obj in self._objects.iteritems():
2140 2141 2142 2143
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2144
            continue
2145
        portal_type = obj.id
2146 2147 2148
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
2149 2150
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2151

2152 2153
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
2154 2155 2156
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
2157
      result_dict = {}
2158
      xml = parse(file)
2159
      chain_list = xml.findall('//chain')
2160
      for chain in chain_list:
2161 2162 2163 2164
        portal_type = chain.find('type').text
        workflow = chain.find('workflow').text or ''
        result_dict[portal_type] = workflow
      self._workflow_chain_archive = result_dict
2165 2166 2167
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

2168
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
2169

2170 2171 2172
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

2173
  def build(self, context, **kw):
2174 2175 2176 2177 2178
    # 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
2179
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
2180
    for key in self._archive.keys():
2181 2182 2183
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
2184
        workflow = wflist[1]
2185
      else:
2186
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
2187
        portal_type = wflist[0][:-2]
2188
        workflow = ''
2189 2190 2191 2192 2193
      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):
2194
          if not self.is_bt_for_diff:
2195 2196 2197
            # 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
2198
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
2199
                       'in chain for portal_type %s' % (workflow_name, portal_type))
2200
        self._objects.setdefault(portal_type, []).append(workflow)
2201
      elif not self.is_bt_for_diff:
2202
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
2203
                        'is probably a sign of a missing dependency.'\
2204
                                                    % portal_type
2205

Christophe Dumez's avatar
Christophe Dumez committed
2206
  # Function to generate XML Code Manually
2207 2208
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
2209 2210 2211
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2212
      workflow_list = self._objects[key]
2213 2214
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
2215 2216
      xml_data += '\n  <workflow>%s</workflow>' %(
        self._chain_string_separator.join(sorted(workflow_list)))
2217 2218
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
2219 2220 2221
    return xml_data

  def export(self, context, bta, **kw):
2222
    if not self._objects:
2223 2224 2225
      return
    # export workflow chain
    xml_data = self.generateXml()
2226 2227
    bta.addObject(xml_data, name='workflow_chain_type',
                  path=self.__class__.__name__)
2228 2229 2230 2231

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2232 2233 2234 2235 2236 2237
    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 = []
2238 2239
    # We now need to setup the list of workflows corresponding to
    # each portal type
2240
    (default_chain, chain_dict) = getChainByType(context)
2241
    # First convert all workflow_ids into list.
2242 2243
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
2244
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
2245
    # best solution, by default it is 'default_workflow', which is
2246 2247
    # not very usefull
    default_chain = ''
2248 2249
    for path in self._objects:
      if path in update_dict or force:
2250 2251 2252
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2253
            continue
Jérome Perrin's avatar
Jérome Perrin committed
2254 2255
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
2256
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
2257
          continue
2258
        portal_type = path_splitted[-1]
2259 2260
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
2261
          # XXX we don't use the chain (Default) in erp5 so don't keep it
2262 2263 2264 2265 2266 2267
          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]
2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287
          # 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)
2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298
          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
2299
              wf_id = wf_id.lstrip('+')
2300
              old_chain_workflow_id_set.add(wf_id)
2301
            # create the new chain
2302 2303
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
2304 2305
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
2306
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
2307 2308 2309
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
2310
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
2311
        else:
2312
          if context.portal_types.getTypeInfo(portal_type) is None:
2313
            raise ValueError('Cannot chain workflow %r to non existing '
2314 2315 2316 2317 2318
                           '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.
2319 2320
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
2321 2322
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2323

2324 2325
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
2326 2327
    object_path = kw.get('object_path', None)
    if object_path is not None:
2328
      object_key_list = [object_path]
2329
    else:
2330 2331 2332
      object_key_list = self._objects.keys()
    for object_key in object_key_list:
      path_splitted = object_key.split('/', 1)
2333 2334 2335
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
2336 2337 2338 2339 2340 2341 2342 2343 2344 2345
      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]
2346
        else:
2347 2348 2349 2350
          chain_dict[path] = self._chain_string_separator.\
                                                  join(workflow_id_list)
    context.getPortalObject().portal_workflow.\
                                   manage_changeWorkflows('', props=chain_dict)
2351

2352
  def preinstall(self, context, installed_item, **kw):
2353
    modified_object_list = {}
2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380
    new_dict = PersistentMapping()
    # Fix key from installed bt if necessary
    for key, value in installed_item._objects.iteritems():
      if not 'portal_type_workflow_chain/' in key:
        key = 'portal_type_workflow_chain/%s' % (key)
      new_dict[key] = value
    if new_dict:
      installed_item._objects = new_dict
    for path in self._objects:
      if path in installed_item._objects:
        # compare object to see it there is changes
        new_object = self._objects[path]
        old_object = installed_item._objects[path]
        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()
        if new_object != old_object:
          modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
      else: # new object
        modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
    # get removed object
    for path in installed_item._objects:
      if path not in self._objects:
        modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2381 2382
    return modified_object_list

2383
  def _importFile(self, file_name, file):
2384
    if not file_name.endswith('.xml'):
2385
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2386
      return
2387
    # import workflow chain for portal_type
2388
    result_dict = {}
2389
    xml = parse(file)
2390
    chain_list = xml.findall('chain')
2391
    for chain in chain_list:
2392
      portal_type = chain.find('type').text
2393
      workflow_chain = chain.find('workflow').text or ''
2394
      if 'portal_type_workflow_chain/' not in portal_type:
2395 2396 2397 2398
        key = 'portal_type_workflow_chain/%s' % (portal_type,)
      else:
        key = portal_type
      result_dict[key] = workflow_chain.split(self._chain_string_separator)
2399
    self._objects = result_dict
2400

2401 2402
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2403

2404
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
2405 2406 2407
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
2408 2409
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
2410
  business_template_class_property = '_portal_type_allowed_content_type_item'
2411 2412

  def build(self, context, **kw):
2413
    types_tool = getToolByName(self.getPortalObject(), 'portal_types')
2414
    for key in self._archive.keys():
2415 2416 2417 2418
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
2419
      ob = types_tool.getTypeInfo(portal_type)
2420
      # check properties corresponds to what is defined in site
2421
      if ob is None:
2422
        raise ValueError, "Portal Type %r not found in site" %(portal_type,)
2423
      prop_value = getattr(ob, self.class_property, ())
2424 2425 2426 2427 2428 2429 2430
      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
2431
        raise ValueError, "%s %s not found in portal type %s" % (
2432 2433
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)
2434

Christophe Dumez's avatar
Christophe Dumez committed
2435
  # Function to generate XML Code Manually
2436 2437
  def generateXml(self, path=None):
    xml_data = '<%s>' %(self.xml_tag,)
2438 2439 2440
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2441
      id_value = key.replace('%s/' % self.class_property, '')
2442
      allowed_item_list = sorted(self._objects[key])
2443
      xml_data += '\n <portal_type id="%s">' % (id_value)
2444
      for allowed_item in allowed_item_list:
2445 2446 2447
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
2448 2449 2450
    return xml_data

  def export(self, context, bta, **kw):
2451
    if not self._objects:
2452 2453
      return
    xml_data = self.generateXml(path=None)
2454 2455
    bta.addObject(xml_data, name=self.class_property,
                  path=self.__class__.__name__)
2456

2457
  def preinstall(self, context, installed_item, **kw):
2458
    modified_object_list = {}
2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481
    new_dict = PersistentMapping()
    # fix key if necessary in installed bt for diff
    for key, value in installed_item._objects.iteritems():
      if self.class_property not in key:
        key = '%s/%s' % (self.class_property, key)
      new_dict[key] = value
    if new_dict:
      installed_item._objects = new_dict
    for path in self._objects:
      if path in installed_item._objects:
        # compare object to see it there is changes
        new_object = self._objects[path]
        old_object = installed_item._objects[path]
        new_object.sort()
        old_object.sort()
        if new_object != old_object:
          modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
      else: # new object
        modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
    # get removed object
    for path in installed_item._objects:
      if path not in self._objects:
        modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2482 2483
    return modified_object_list

2484
  def _importFile(self, file_name, file):
2485
    if not file_name.endswith('.xml'):
2486
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2487
      return
2488
    path, name = posixpath.split(file_name)
2489
    xml = parse(file)
2490
    portal_type_list = xml.findall('portal_type')
2491
    for portal_type in portal_type_list:
2492 2493
      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
2494
      if self.class_property not in id:
2495 2496 2497 2498
        key = '%s/%s' % (self.class_property, id,)
      else:
        key = id
      self._objects[key] = item_type_list
2499 2500

  def install(self, context, trashbin, **kw):
Nicolas Delaby's avatar
Nicolas Delaby committed
2501 2502
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2503 2504
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2505 2506 2507 2508 2509 2510
    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 = {}
2511
    for key in set(self._objects.keys()).union(old_objects.keys()):
Nicolas Delaby's avatar
Nicolas Delaby committed
2512
      if key in update_dict or force:
2513 2514 2515 2516
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2517
        portal_id = key.split('/')[-1]
2518
        property_list = self._objects.get(key, [])
2519 2520
        type_information = types_tool.getTypeInfo(portal_id)
        if type_information is None:
2521 2522
          if not property_list:
            continue
2523 2524
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2525
        old_property_list = old_objects.get(key, ())
2526
        object_property_list = getattr(type_information, self.class_property, ())
Nicolas Delaby's avatar
Nicolas Delaby committed
2527 2528 2529 2530 2531 2532 2533 2534 2535
        # 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)
2536
        setattr(type_information, self.class_property, tuple(property_list))
2537

Aurel's avatar
Aurel committed
2538
  def uninstall(self, context, **kw):
2539
    object_path = kw.get('object_path', None)
Nicolas Delaby's avatar
Nicolas Delaby committed
2540 2541
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2542
    if object_path is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
2543
      object_key_list = [object_path]
2544
    else:
Nicolas Delaby's avatar
Nicolas Delaby committed
2545 2546
      object_key_list = self._objects.keys()
    for key in object_key_list:
2547 2548 2549 2550 2551
      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,))
2552 2553
        continue
      property_list = self._objects[key]
2554
      original_property_list = list(getattr(type_information,
2555
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2556 2557
      for id in property_list:
        if id in original_property_list:
2558
          original_property_list.remove(id)
2559
      setattr(type_information, self.class_property, tuple(original_property_list))
2560

2561

2562 2563
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2564
  name = 'Hidden Content Type'
2565 2566
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2567
  business_template_class_property = '_portal_type_hidden_content_type_item'
2568

2569

2570 2571
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2572
  name = 'Property Sheet'
2573 2574
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2575
  business_template_class_property = '_portal_type_property_sheet_item'
2576

2577

2578 2579
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2580
  name = 'Base Category'
2581 2582
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2583
  business_template_class_property = '_portal_type_base_category_item'
2584

2585

2586
class CatalogMethodTemplateItem(ObjectTemplateItem):
2587
  """Template Item for catalog methods.
2588

2589 2590 2591 2592 2593
    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.
  """
2594

2595 2596
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2597
    # a mapping to store properties of methods.
2598 2599 2600 2601 2602
    # 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()
2603

2604
    self._is_filtered_archive = PersistentMapping()
2605 2606
    for method in catalog_method_filter_list:
      setattr(self, method, PersistentMapping())
2607

2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621
  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

2622 2623
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2624

2625
    catalog = _getCatalogValue(self)
2626
    if catalog is None:
2627
      LOG('BusinessTemplate build', 0, 'catalog not found')
2628
      return
2629

2630 2631 2632
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2633

2634 2635
    for obj in self._objects.values():
      method_id = obj.id
2636 2637
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2638 2639 2640 2641 2642 2643
      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]
2644

2645 2646 2647 2648 2649
  def generateXml(self, path):
    obj = self._objects[path]
    method_id = obj.id
    xml_data = '<catalog_method>'
    if self._method_properties.has_key(method_id):
2650
      for method_property, value in self._method_properties[method_id].items():
2651 2652 2653
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2654

2655
      if self._is_filtered_archive.get(method_id):
2656 2657 2658
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2659 2660
          for method in catalog_method_filter_list:
            if method != '_filter_expression_instance_archive':
2661 2662
              value = getattr(self, method, {}).get(method_id)
              if isinstance(value, basestring):
2663 2664 2665
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2666
              elif value:
2667
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2668
                for item in value:
2669 2670
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2671
    xml_data += '\n</catalog_method>\n'
Christophe Dumez's avatar
Christophe Dumez committed
2672
    return xml_data
2673

2674 2675 2676
  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))
2677 2678 2679 2680 2681 2682 2683 2684 2685 2686
    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
2687
    path = self.__class__.__name__
2688 2689 2690 2691 2692
    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)
2693
      bta.addObject(f, key, path=path)
2694 2695
      # add all datas specific to catalog inside one file
      xml_data = self.generateXml(key)
2696
      bta.addObject(xml_data, key + '.catalog_keys', path=path)
2697

2698 2699
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2700
    catalog = _getCatalogValue(self)
2701 2702 2703 2704 2705 2706 2707
    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)
2708

2709 2710 2711 2712 2713
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []

    if force: # get all objects
2714
      values = self._objects.values()
2715
    else: # get only selected object
2716
      for key, value in self._objects.iteritems():
2717 2718 2719 2720
        if update_dict.has_key(key) or force:
          if not force:
            action = update_dict[key]
            if action == 'nothing':
2721
              continue
2722
          values.append(value)
2723

2724 2725
    for obj in values:
      method_id = obj.id
2726

2727 2728 2729 2730 2731 2732
      # 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
2733
          elif isinstance(old_value, (list, tuple)):
2734 2735 2736 2737
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2738

2739 2740
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2741
        expression = self._filter_expression_archive[method_id]
2742 2743 2744 2745 2746
        if expression and expression.strip():
          # only compile non-empty expressions
          expr_instance = Expression(expression)
        else:
          expr_instance = None
2747 2748 2749
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2750
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2751 2752 2753 2754
        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, ())
2755
      elif method_id in catalog.filter_dict.keys():
2756
        catalog.filter_dict[method_id]['filtered'] = 0
2757

2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783
      # 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)
2784

2785 2786 2787 2788 2789 2790
        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)
2791

2792
  def uninstall(self, context, **kw):
2793
    catalog = _getCatalogValue(self)
2794 2795 2796
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2797

2798 2799 2800 2801
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2802
      values = self._objects.values()
2803
    else:
2804
      try:
2805
        value = self._objects[object_path]
2806 2807
      except KeyError:
        value = None
2808 2809
      if value is not None:
        values.append(value)
2810
    for obj in values:
2811
      method_id = obj.id
2812 2813 2814 2815 2816 2817 2818 2819 2820
      # 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)
2821

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2822
      if catalog.filter_dict.has_key(method_id):
2823
        del catalog.filter_dict[method_id]
2824

2825
    # uninstall objects
2826
    ObjectTemplateItem.uninstall(self, context, **kw)
2827

2828
  def _importFile(self, file_name, file):
2829
    if file_name.endswith('.catalog_keys.xml'):
2830
      # recreate data mapping specific to catalog method
2831 2832
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2833
      xml = parse(file)
2834
      method_list = xml.findall('item')
2835
      for method in method_list:
2836 2837 2838
        key = method.get('key')
        key_type = method.get('type')
        value_node = method.find('value')
2839
        if key_type == "str":
2840
          value = value_node.text or ''
2841
        elif key_type == "int":
2842
          value = int(value_node.text)
2843
        elif key_type == "tuple":
2844
          value = tuple([value_node.text for value_node in method.findall('value')])
2845
        else:
2846
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2847
          continue
2848
        if key in catalog_method_list or key in catalog_method_filter_list:
2849
          getattr(self, key)[id] = value
2850 2851 2852
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2853 2854
    elif file_name.endswith('.xml'):
      # just import xml object
2855
      connection = self.getConnection(self.aq_parent)
2856
      obj = connection.importFile(file, customImporters=customImporters)
2857
      self.removeProperties(obj, 0)
2858 2859 2860
      self._objects[file_name[:-4]] = obj
    else:
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2861

2862
class ActionTemplateItem(ObjectTemplateItem):
2863 2864

  def __init__(self, id_list, **kw):
2865
    # XXX It's look like ObjectTemplateItem __init__
2866 2867 2868 2869 2870 2871
    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

2872 2873
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2874
      Split path tries to split a complex path such as:
2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892

      "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

2893 2894 2895 2896 2897 2898 2899
  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):
2900 2901 2902 2903 2904 2905
    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 '
Jérome Perrin's avatar
typo  
Jérome Perrin committed
2906
          'IActionProvider. Retrieving action from portal_actions instead' %
2907 2908
          (value, obj.getId()))
      obj = context.getPortalObject().portal_actions
2909 2910 2911 2912 2913 2914 2915 2916 2917 2918
    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
2919
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2920 2921 2922 2923
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2924 2925 2926 2927
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2928 2929 2930
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2931
      # normalize url
2932 2933 2934 2935 2936
      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]
2937 2938
      action = self._getActionCopy(obj, context, value)
      if action is None:
2939 2940 2941
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2942
      key = posixpath.join(url[-2], url[-1], value)
2943 2944 2945 2946 2947
      self._objects[key] = self.removeProperties(
        action, 1,
        self.isKeepWorkflowObject(key),
        self.isKeepWorkflowObjectLastHistoryOnly(key))

2948
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2949

2950 2951 2952
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2953 2954 2955 2956 2957 2958 2959
    portal_type_dict = {}
    p = context.getPortalObject()
    for id in self._objects.keys():
      if update_dict.has_key(id) or force:
        if not force:
          action = update_dict[id]
          if action == 'nothing':
2960
            continue
2961 2962
        obj = self._objects[id]
        path, id = id.rsplit('/', 1)
2963
        container = p.unrestrictedTraverse(path)
2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979

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

        # Following code is for actions outside Types Tool.
        # It will be removed when they are also converted to ERP5 actions.
        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 '
Jérome Perrin's avatar
typo  
Jérome Perrin committed
2980
              'IActionProvider. Storing action on portal_actions instead' %
2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021
              (id, path))
          container = p.portal_actions
        obj, action = container, obj
        action_list = obj.listActions()
        for index in range(len(action_list)):
          if action_list[index].id == id:
            # remove previous action
            obj.deleteActions(selections=(index,))
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
        obj.addAction(
                      id = action.id
                    , name = action.title
                    , action = action_text
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
                    , icon = getattr(action, 'icon', None)\
                              and action.icon.text or ''
                    , priority = action.priority
                    , description = action.description
                  )
        # sort action based on the priority define on it
        # 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))
    for path, action_dict in portal_type_dict.iteritems():
      container = p.unrestrictedTraverse(path)
      container.manage_delObjects([obj.id
        for obj in container.getActionInformationList()
        if obj.getReference() in action_dict])
      for name, obj in action_dict.iteritems():
        container._importOldAction(obj).aq_base
3022

3023 3024
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3025 3026
    object_path = kw.get("object_path", None)
    if object_path is not None:
3027 3028 3029 3030 3031 3032 3033 3034
      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]
3035
    else:
3036
      keys = self._archive.keys()
3037
    for id in keys:
3038 3039
      if  '|' in id:
        relative_url, value = id.split(' | ')
3040 3041 3042
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
3043
          is_new_action = interfaces.ITypeProvider.providedBy(obj.getParentValue())
3044
          key = is_new_action and 'reference' or 'id'
3045
      else:
3046
        relative_url, key, value = self._splitPath(id)
3047
        obj = p.unrestrictedTraverse(relative_url, None)
3048 3049 3050
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
3051
          if getattr(action_list[index], key, None) == value:
3052 3053
            obj.deleteActions(selections=(index,))
            break
3054 3055
      LOG('BusinessTemplate', WARNING,
          'Unable to uninstall action at %s, ignoring' % relative_url )
3056 3057
    BaseTemplateItem.uninstall(self, context, **kw)

3058 3059 3060
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
3061
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
3062 3063 3064 3065 3066 3067 3068
    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])
3069 3070
      # normalize url
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])
3071
      self._objects[relative_url] = type_role_list = []
3072
      for role in obj.getRoleInformationList():
3073
        type_role_dict = {}
3074 3075 3076 3077 3078 3079 3080 3081 3082
        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)
3083
          elif k not in ('title', 'description', 'categories'):
3084 3085 3086
            k = {'id': 'object_id', # for stable sort
                 'role_base_category': 'base_category',
                 'role_base_category_script_id': 'base_category_script',
3087 3088
                 'role_category': 'category',
                 'local_roles_group_id': 'local_roles_group_id'}.get(k)
3089 3090 3091
            if not k:
              continue
          type_role_dict[k] = v
3092 3093
        if 'id' in type_role_dict:
          type_role_list.append(type_role_dict)
3094
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
3095

Christophe Dumez's avatar
Christophe Dumez committed
3096
  # Function to generate XML Code Manually
3097 3098 3099 3100
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
3101
      xml_data += "\n  <role id='%s'>" % role['id']
3102
      # uniq
3103
      for property in ('title', 'description', 'condition',
3104 3105 3106
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
3107 3108
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
3109
          xml_data += "\n   <property id='%s'>%s</property>" % \
3110 3111
              (property, prop_value)
      # multi
3112
      for property in ('categories', 'category', 'base_category'):
3113
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
3114 3115
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
3116
          xml_data += "\n   <multi_property "\
3117
          "id='%s'>%s</multi_property>" % (property, prop_value)
3118 3119
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
3120
    return xml_data
3121

3122 3123 3124
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3125
    path = self.__class__.__name__
3126 3127
    for key in self._objects.keys():
      xml_data = self.generateXml(key)
3128 3129
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
3130
      name = key.split('/', 1)[1]
3131
      bta.addObject(xml_data, name=name, path=path)
3132 3133

  def _importFile(self, file_name, file):
3134 3135 3136
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3137 3138
    type_roles_list = []
    xml = parse(file)
3139
    xml_type_roles_list = xml.findall('role')
3140
    for role in xml_type_roles_list:
3141 3142 3143 3144
      id = role.get('id')
      if isinstance(id, unicode):
        id = id.encode('utf_8', 'backslashreplace')
      type_role_property_dict = {'id': id}
3145
      # uniq
3146 3147 3148 3149 3150 3151 3152 3153
      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
3154
      # multi
3155 3156 3157 3158 3159 3160 3161 3162
      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)
3163
      type_roles_list.append(type_role_property_dict)
3164
    self._objects['portal_type_roles/%s' % (file_name[:-4],)] = type_roles_list
3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175

  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
3176 3177 3178
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
3179
          # reset roles before applying
3180
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
3181
          type_roles_list = self._objects[roles_path] or []
3182 3183
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
3184
        else:
3185
          raise AttributeError("Path %r not found while "
3186
                               "installing roles" % (path, ))
3187 3188 3189

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
3190 3191 3192 3193 3194 3195
    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:
3196
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
3197 3198
      try:
        obj = p.unrestrictedTraverse(path)
3199
        obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
3200 3201
      except (NotFound, KeyError):
        pass
3202

3203 3204 3205 3206 3207 3208
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
3209 3210
      for property in p.propertyMap():
        if property['id'] == id:
3211
          obj = p.getProperty(id)
3212
          prop_type = property['type']
3213 3214
          break
      else:
3215
        obj = None
3216
      if obj is None and not self.is_bt_for_diff:
3217
        raise NotFound, 'the property %s is not found' % id
3218
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
3219

3220 3221
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
3222
    if not file_name.endswith('.xml'):
3223
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3224
      return
3225
    xml = parse(file)
3226 3227 3228 3229 3230 3231 3232 3233 3234
    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)
3235

3236 3237 3238
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250
    p = context.getPortalObject()
    for path in self._objects.keys():
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
            continue
        dir, id = posixpath.split(path)
        prop_type, property = self._objects[path]
        if p.hasProperty(id):
          if p.getPropertyType(id) != prop_type:
            p._delProperty(id)
3251
            p._setProperty(id, property, type=prop_type)
3252 3253 3254 3255
          else:
            p._updateProperty(id, property)
        else:
          p._setProperty(id, property, type=prop_type)
3256 3257 3258

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3259 3260 3261 3262 3263 3264
    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:
3265 3266 3267 3268
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3269
  # Function to generate XML Code Manually
3270
  def generateXml(self, path=None):
3271
    xml_data = ''
3272
    prop_type, obj = self._objects[path]
3273
    xml_data += '\n <property>'
3274 3275
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
3276
    if prop_type in ('lines', 'tokens'):
3277
      xml_data += '\n  <value>'
3278
      for item in obj:
3279
        if item != '':
3280
          xml_data += '\n   <item>%s</item>' % escape(str(item))
3281
      xml_data += '\n  </value>'
3282
    else:
3283
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
3284
    xml_data += '\n </property>'
3285 3286
    return xml_data

Aurel's avatar
Aurel committed
3287 3288 3289
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3290 3291 3292 3293
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
3294
      xml_data += self.generateXml(path)
3295
    xml_data += '\n</site_property>'
3296
    bta.addObject(xml_data, name='properties', path=self.__class__.__name__)
3297

3298 3299 3300 3301 3302
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3303 3304 3305 3306 3307 3308 3309
    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()
3310
      mapping['category_list'] = module.getCategoryList()
3311
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3312

Christophe Dumez's avatar
Christophe Dumez committed
3313
  # Function to generate XML Code Manually
3314
  def generateXml(self, path=None):
3315
    mapping = self._objects[path]
3316
    xml_data = ['<module>']
3317
    keys = mapping.keys()
3318 3319
    for key in sorted(keys):
      if key == 'permission_list':
3320
        # separe permission dict into xml
3321
        xml_data.append(' <%s>' % (key, ))
3322
        permission_list = mapping[key]
3323
        for perm in permission_list:
3324
          # the type of the permission defined if we use acquired or not
3325
          if isinstance(perm[1], list):
3326 3327 3328
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
3329
          role_list = list(perm[1])
3330 3331 3332
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
3333
          if (len(role_list) == 0 and ptype == 'list') or \
3334 3335
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
3336
          role_list.sort()
3337 3338
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
3339
          for role in role_list:
3340 3341 3342
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
3343 3344 3345 3346 3347 3348 3349 3350
      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, ))
3351
      else:
3352
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
3353 3354
    xml_data.append('</module>')
    return '\n'.join(xml_data)
3355

3356
  def export(self, context, bta, **kw):
3357
    if len(self._objects) == 0:
3358
      return
3359
    path = self.__class__.__name__
3360 3361
    keys = self._objects.keys()
    keys.sort()
3362
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
3363
      # export modules one by one
3364
      xml_data = self.generateXml(path=key)
3365
      bta.addObject(xml_data, name=key, path=path)
3366

3367
  def install(self, context, trashbin, **kw):
3368
    portal = context.getPortalObject()
3369 3370
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3371 3372
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
3373
    for path, mapping in self._objects.iteritems():
3374
      if update_dict.has_key(path) or force:
3375
        if not force:
3376
          action = update_dict[path]
3377 3378
          if action == 'nothing':
            continue
3379 3380
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
3381
        module = portal._getOb(module_id, None)
3382 3383
        if module is not None:
          module.portal_type = portal_type
3384
        else:
3385
          module = portal.newContent(id=module_id, portal_type=portal_type)
3386
        module.setTitle(str(mapping['title']))
3387 3388
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
3389
          # By default, Manager only without acquire permission
3390 3391
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
3392
          module.manage_permission(name, roles=role_list, acquire=acquire)
3393 3394
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
3395 3396

  def _importFile(self, file_name, file):
3397 3398 3399
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3400
    mapping = {}
3401
    xml = parse(file)
3402
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3403
      key_node = xml.find(key)
3404
      if key == 'permission_list':
3405 3406 3407 3408 3409 3410 3411
        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))
3412
          else:
3413 3414 3415
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3416
      else:
3417
        mapping[key] = key_node.text or ''
3418 3419

    category_list = []
3420 3421 3422 3423
    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'))
3424 3425
    mapping['category_list'] = category_list

3426
    self._objects[file_name[:-4]] = mapping
3427

3428
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3429 3430 3431
    trash = kw.get('trash', 0)
    if trash:
      return
3432 3433 3434 3435 3436 3437
    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]
3438 3439
    p = context.getPortalObject()
    id_list = p.objectIds()
3440 3441
    for key in keys:
      if key in id_list:
3442
        try:
3443
          if trash and trashbin is not None:
3444
            container_path = key.split('/')
3445
            self.portal_trash.backupObject(trashbin, container_path,
3446
                                           key, save=1, keep_subobjects=1)
3447
          p.manage_delObjects([key])
3448
        except NotFound:
3449
          pass
3450 3451
    BaseTemplateItem.uninstall(self, context, **kw)

3452 3453 3454
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3455

3456 3457
# XXX-arnau: when everything has been migrated to Components, this class
# should be renamed to DocumentTemplateItem
3458
class FilesystemDocumentTemplateItem(BaseTemplateItem):
3459 3460 3461 3462
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3463

3464 3465 3466 3467 3468 3469 3470 3471 3472 3473
  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

3474 3475
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
3476 3477
    for key in self._archive.iterkeys():
      self._objects[key] = self.local_file_reader_name(key)
Aurel's avatar
Aurel committed
3478

3479
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3480
    modified_object_list = {}
3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493
    # fix key if necessary in installed bt for diff
    extra_prefix = self.__class__.__name__ + '/'
    for key in installed_item._objects.keys():
      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]
    for path in self._objects:
      if installed_item._objects.has_key(path):
        # compare object to see if there is changes
        new_obj_code = self._objects[path]
        old_obj_code = installed_item._objects[path]
        if new_obj_code != old_obj_code:
3494
          # Note: Magical way to have unique paths
3495
          modified_object_list.update(
3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507
              {self._getKey(path) : ['Modified', self.__class__.__name__[:-12]]})
      else: # new object
        # Note: Magical way to have unique paths
        modified_object_list.update(
              {self._getKey(path) : ['New', self.__class__.__name__[:-12]]})
        # get removed object
    old_keys = installed_item._objects.keys()
    for path in old_keys:
      if path not in self._objects:
        # Note: Magical way to have unique paths
        modified_object_list.update(
              {self._getKey(path) : ['Removed', self.__class__.__name__[:-12]]})
3508 3509
    return modified_object_list

3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524
  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()

3525 3526 3527
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538
    need_reset = isinstance(self, FilesystemDocumentTemplateItem)
    for key in self._objects.keys():
      # 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:
        if not force:
          action = update_dict.get(key, update_dict.get(upgraded_key))
          if action == 'nothing':
3539
            continue
3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555
        text = self._objects[key]
        path, name = posixpath.split(key)
        try:
          self.local_file_writer_name(name, text, create=0)
        except IOError, error:
          LOG(self.__class__.__name__, WARNING,
              "Cannot install class %r on file system" % name)
          if error.errno:
            raise
          continue
        if self.local_file_importer_name is None:
          continue
        if need_reset:
          self._resetDynamicModules()
          need_reset = False
        self.local_file_importer_name(name)
3556

3557 3558 3559
  def remove(self, context, **kw):
    """Conversion of magically uniqued paths to real ones"""
    remove_object_dict = kw.get('remove_object_dict', {})
3560 3561 3562
    kw['remove_object_dict'] = {self._getPath(k): v
      for k, v in remove_object_dict.iteritems()
      if k.startswith(self.getTemplateTypeName()+'/')}
3563 3564
    BaseTemplateItem.remove(self, context, **kw)

3565
  def uninstall(self, context, **kw):
3566
    object_path = kw.get('object_path', None)
3567 3568 3569 3570
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
3571
    if object_keys:
3572
      if isinstance(self, FilesystemDocumentTemplateItem):
3573 3574 3575
        self._resetDynamicModules()
      for key in object_keys:
        self.local_file_remover_name(key)
3576 3577
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3578 3579 3580
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3581 3582 3583 3584 3585 3586
    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
3587
      bta.addObject(obj, name=key, ext='.py')
Aurel's avatar
Aurel committed
3588

3589
  def _importFile(self, file_name, file):
3590 3591 3592
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3593
    text = file.read()
3594
    self._objects[file_name[:-3]] = text
3595

3596
class FilesystemToZodbTemplateItem(FilesystemDocumentTemplateItem,
3597
                                   ObjectTemplateItem):
3598
  """
3599
  Abstract class to allow migration from FilesystemDocumentTemplateItem to
3600 3601
  ObjectTemplateItem, this is useful for migration from filesystem to ZODB for
  PropertySheets and Components
3602
  """
3603 3604
  # If set to False, then the migration from filesystem to ZODB will be
  # performed, meaningful only until the code is stable
3605
  _perform_migration = True
3606

3607 3608 3609 3610 3611 3612 3613 3614 3615
  _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
3616

3617 3618 3619 3620 3621
    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()
3622
      tool = getattr(context.getPortalObject(), self._tool_id, None)
3623
    if tool is not None:
3624
      existing_set = set(tool.objectIds())
3625
      for i, id in enumerate(id_list):
3626 3627 3628
        if id in existing_set:
          # if the object is on ZODB, use it.
          id_list[i] = "%s/%s" % (self._tool_id, self._getZodbObjectId(id))
3629

3630 3631
    BaseTemplateItem.__init__(self, id_list, **kw)

3632
  def _is_already_migrated(self, object_key_list):
3633
    """
3634 3635 3636
    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/'
3637 3638
    """
    return len(object_key_list) != 0 and \
3639
        object_key_list[0].startswith(self._tool_id + '/')
3640 3641 3642

  def _filesystemCompatibilityWrapper(method_name, object_dict_name):
    """
3643
    Call ObjectTemplateItem method when the objects have already been
3644
    migrated, otherwise fallback on FilesystemDocumentTemplateItem method for
3645
    backward-compatibility
3646 3647 3648
    """
    def inner(self, *args, **kw):
      if self._is_already_migrated(getattr(self, object_dict_name).keys()):
3649
        result = getattr(ObjectTemplateItem, method_name)(self, *args, **kw)
3650
      else:
3651 3652
        result = getattr(FilesystemDocumentTemplateItem,
                         method_name)(self, *args, **kw)
3653

3654 3655 3656
      if method_name == 'preinstall':
        old_result = result.copy()
        for k, v in old_result.iteritems():
3657 3658 3659 3660 3661
          # Magical way to have unique path (without duplicating the prefix
          # neither) in case of not yet migrated property sheets available on
          # preinstall list
          if not (k.startswith(self._tool_id + '/') or
                  k.startswith(self.getTemplateTypeName())):
3662 3663 3664
            result.pop(k)
            k = self._getKey(k)
          result[k] = v
3665
      return result
3666 3667 3668 3669 3670 3671 3672
    return inner

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

  def _importFile(self, file_name, *args, **kw):
3673 3674 3675 3676
    """
    Import file by calling the appropriate base class according to the file
    name extensions
    """
3677 3678 3679
    if file_name.endswith('.xml'):
      return ObjectTemplateItem._importFile(self, file_name, *args, **kw)
    else:
3680 3681
      return FilesystemDocumentTemplateItem._importFile(self, file_name,
                                                        *args, **kw)
3682

3683 3684 3685 3686 3687 3688
  def afterUninstall(self, already_migrated=False):
    """
    Hook called after uninstall
    """
    pass

3689 3690 3691 3692 3693 3694 3695 3696 3697
  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()

3698 3699 3700
    already_migrated = self._is_already_migrated(object_keys)
    if already_migrated:
      ObjectTemplateItem.uninstall(self, *args, **kw)
3701
    else:
3702 3703 3704
      FilesystemDocumentTemplateItem.uninstall(self, *args, **kw)

    self.afterUninstall(already_migrated)
3705

3706
  def remove(self, context, **kw):
3707
    """
3708
    Conversion of magically uniqued paths to real ones
3709
    """
3710
    remove_object_dict = kw.get('remove_object_dict', {})
3711 3712 3713
    kw['remove_object_dict'] = {self._getPath(k): v
      for k, v in remove_object_dict.iteritems()
      if k.startswith(self.getTemplateTypeName()+'/')}
3714
    ObjectTemplateItem.remove(self, context, **kw)
3715 3716

  @staticmethod
3717 3718
  def _getFilesystemPath(class_id):
    raise NotImplementedError
3719

3720 3721 3722 3723 3724 3725 3726 3727 3728
  @staticmethod
  def _migrateFromFilesystem(tool, filesystem_path, filesystem_file, class_id):
    raise NotImplementedError

  def _migrateAllFromFilesystem(self,
                                context,
                                migrate_object_dict,
                                object_dict,
                                update_parameter_dict):
3729 3730 3731 3732 3733 3734 3735
    """
    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
    """
3736 3737 3738
    # Migrate all the filesystem classes of the Business Template if any
    tool = getattr(context.getPortalObject(), self._tool_id)
    id_set = set(tool.objectIds())
3739

3740 3741 3742
    # careful, that dictionary will change
    class_id_list = migrate_object_dict.keys()
    for class_id in class_id_list:
3743 3744 3745
      # 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
3746
      if class_id in id_set:
Nicolas Delaby's avatar
Typo  
Nicolas Delaby committed
3747
        # XXX a Conduit must be able to merge modifications
3748
        # from FS PropertySheets into ZODB PropertySheets
3749 3750 3751
        warn('Conflict when migrating classes %s: already exists in %s and '\
               'cannot be updated automatically for now.' % (class_id,
                                                             self._tool_id),
3752
             UserWarning)
3753 3754 3755
        del migrate_object_dict[class_id]
        if class_id in object_dict:
          del object_dict[class_id]
3756
        continue
3757

3758
      filesystem_path = self._getFilesystemPath(class_id)
3759 3760 3761 3762

      # A filesystem Property Sheet may already exist in the instance
      # home if the Business Template has been previously installed,
      # otherwise it is created
3763 3764
      if os.path.exists(filesystem_path):
        filesystem_file = open(filesystem_path)
3765
      else:
Arnaud Fontaine's avatar
Arnaud Fontaine committed
3766
        filesystem_file = open(filesystem_path, 'w+')
3767 3768
        filesystem_file.write(migrate_object_dict[class_id])
        filesystem_file.seek(0)
3769 3770

      try:
3771 3772 3773 3774
        migrated_object = self._migrateFromFilesystem(tool,
                                                      filesystem_path,
                                                      filesystem_file,
                                                      class_id).aq_base
3775
      finally:
3776
        filesystem_file.close()
3777 3778 3779 3780

      # Delete the file only if there was no error encountered during
      # migration
      os.remove(filesystem_path)
3781 3782

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

3785
      migrate_object_dict[key] = migrated_object
3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798
      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):
3799 3800 3801 3802 3803 3804
    """
    Install Business Template items and perform migration
    automatically only if the tool is available
    """
    if (not self._perform_migration or
        getattr(context.getPortalObject(), self._tool_id, None) is None):
3805
      return FilesystemDocumentTemplateItem.install(self, context, **kw)
3806

3807
    if not self._is_already_migrated(self._objects.keys()):
3808 3809 3810 3811
      self._migrateAllFromFilesystem(context,
                                     self._objects,
                                     self._archive,
                                     kw.get('object_to_update'))
3812 3813 3814

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

3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828
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.

3829 3830 3831
  Therefore, this is an all or nothing migration, meaning that only methods of
  FilesystemDocumentTemplateItem will be called before the migration has been
  performed, then ObjectTemplateItem methods afterwards.
3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850
  """
  # 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",
3851
                        class_id + ".py")
3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880

  @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)

3881
class ConstraintTemplateItem(FilesystemDocumentTemplateItem):
3882 3883 3884 3885
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3886

3887 3888
from Products.ERP5Type.Core.DocumentComponent import DocumentComponent

3889
class DocumentTemplateItem(FilesystemToZodbTemplateItem):
3890
  """
3891 3892 3893
  Documents are now stored in ZODB rather than on the filesystem. However,
  some Business Templates may still have filesystem Documents which need to be
  migrated to the ZODB.
3894 3895 3896

  The migration is performed in two steps:

3897 3898 3899 3900 3901 3902
    1/ Copy the Business Template to be migrated;

    2/ Run the migration script which will update properly the Document IDs in
       the Business Template.

  Upon import or export, two files will be created:
3903

3904 3905 3906 3907 3908
    - XML file: contains metadata
    - Python file: contains the source code itself

  This allows to keep Git history and having readable source code instead of
  being crippled into an XML file
3909 3910 3911
  """
  _tool_id = 'portal_components'

3912 3913
  @staticmethod
  def _getZodbObjectId(id):
3914
    return DocumentComponent._getIdPrefix() + '.' + id
3915 3916 3917 3918 3919 3920

  @staticmethod
  def _getFilesystemPath(class_id):
    from App.config import getConfiguration
    return os.path.join(getConfiguration().instancehome,
                        "Document",
3921
                        class_id + ".py")
3922

3923 3924 3925 3926 3927 3928 3929 3930
  def isKeepWorkflowObjectLastHistoryOnly(self, path):
    """
    Component Validation Workflow last History of ZODB Components must always be
    kept, without explicitly adding them to the field which requires an extra
    action for developers
    """
    return path.startswith(self._tool_id + '/')

3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941
  def _removeAllButLastWorkflowHistory(self, obj):
    """
    Only export the last state of component_validation_workflow, because only
    the source code and its state to load it is necessary for ZODB Components
    and too much history would be exported (edit_workflow)
    """
    for wf_id in obj.workflow_history.keys():
      if wf_id != 'component_validation_workflow':
        del obj.workflow_history[wf_id]
        continue

3942 3943
      wf_history = obj.workflow_history[wf_id][-1]
      # Remove useless modifcation 'time' and 'actor' (conflicts with VCSs)
3944 3945 3946
      wf_history.pop('time', None)
      wf_history.pop('actor', None)
      wf_history.pop('comment', None)
3947 3948

      obj.workflow_history[wf_id] = WorkflowHistoryList([wf_history])
3949

3950
  def _importFile(self, file_name, file_obj):
3951
    """
3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964
    This will be called once for non-migrated Document and twice for ZODB
    Components (for .xml (metadata) and .py (source code)). This code MUST
    consider both bt5 folder (everything is on the FS) and tarball (where in
    case of ZODB Components, .xml may have been processed before .py and vice
    versa.
    """
    tv = getTransactionalVariable()
    obj_key, file_ext = os.path.splitext(file_name)
    # id() for installing several bt5 in the same transaction
    tv_obj_key = "%s-%s" % (id(self), obj_key)
    if file_ext == '.py':
      # If this Document has not been migrated yet (eg not matching
      # "portal_components/XXX.py"), use legacy importer
3965
      if file_obj.name.rsplit(os.path.sep, 2)[-2] != 'portal_components':
3966
        FilesystemDocumentTemplateItem._importFile(self, file_name, file_obj)
3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978
      # For ZODB Components: if .xml have been processed before, set the
      # source code property, otherwise store it in a transactional variable
      # so that it can be set once the .xml has been processed
      else:
        text_content = file_obj.read()
        try:
          obj = self._objects[obj_key]
        except KeyError:
          tv[tv_obj_key] = text_content
        else:
          obj.text_content = text_content
    elif file_ext == '.xml':
3979
      ObjectTemplateItem._importFile(self, file_name, file_obj)
3980
      self._objects[obj_key].text_content = tv.get(tv_obj_key, None)
3981

3982 3983 3984 3985 3986
      # When importing a Business Template, there is no way to determine if it
      # has been already migrated or not in __init__() when it does not
      # already exist, therefore BaseTemplateItem.__init__() is called which
      # does not set _archive with portal_components/ like
      # ObjectTemplateItem.__init__()
3987 3988
      self._archive[obj_key] = None
      del self._archive[obj_key[len('portal_components/'):]]
3989 3990
    else:
      LOG('Business Template', 0, 'Skipping file "%s"' % file_name)
3991

3992
  def export(self, context, bta, **kw):
3993 3994 3995 3996
    """
    Export a Document as two files for ZODB Components, one for metadata
    (.xml) and the other for the Python source code (.py)
    """
3997
    path = self.__class__.__name__ + '/'
3998
    for key, obj in self._objects.iteritems():
3999
      # Back compatibility with filesystem Documents
4000 4001 4002 4003 4004 4005
      if isinstance(obj, str):
        if not key.startswith(path):
          key = path + key
        bta.addObject(obj, name=key, ext='.py')
      else:
        obj = obj._getCopy(context)
4006

4007 4008
        f = StringIO(obj.text_content)
        bta.addObject(f, key, path=path, ext='.py')
4009

4010
        del obj.text_content
4011
        transaction.savepoint(optimistic=True)
4012

4013 4014 4015 4016
        # export object in xml
        f = StringIO()
        XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
        bta.addObject(f, key, path=path)
4017

4018
  def getTemplateIdList(self):
4019 4020 4021 4022
    """
    Getter for Document property on the Business Template, must be overriden
    in children classes (e.g. ExtensionDocumentTemplateItem for example)
    """
4023 4024 4025 4026 4027 4028 4029 4030
    return self.getTemplateDocumentIdList()

  def build(self, context, **kw):
    if not self._archive:
      return

    if not self._is_already_migrated(self._archive.keys()):
      document_id_list = self.getTemplateIdList()
4031 4032
      if document_id_list[0] not in getattr(context.getPortalObject(),
                                            'portal_components', ()):
4033
        return FilesystemDocumentTemplateItem.build(self, context, **kw)
4034 4035 4036
      self._archive.clear()
      for name in document_id_list:
        self._archive['portal_components/' + name] = None
4037 4038 4039 4040 4041 4042 4043 4044 4045

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

  def install(self, context, **kw):
    """
    In contrary to ZODB Property Sheets, Components are not migrated
    automatically as the version must be set manually. This should not be an
    issue as there are not so many Documents in bt5...
    """
4046
    if self._is_already_migrated(self._objects.keys()):
4047
      ObjectTemplateItem.install(self, context, **kw)
4048 4049
      self.portal_components.reset(force=True,
                                   reset_portal_type_at_transaction_boundary=True)
4050
    else:
4051 4052 4053 4054
      FilesystemDocumentTemplateItem.install(self, context, **kw)

  def afterUninstall(self, already_migrated=False):
    if already_migrated:
4055 4056
      self.portal_components.reset(force=True,
                                   reset_portal_type_at_transaction_boundary=True)
4057

4058 4059
from Products.ERP5Type.Core.ExtensionComponent import ExtensionComponent

4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072
class ExtensionTemplateItem(DocumentTemplateItem):
  """
  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.
  """
  # Only meaningful for filesystem Extensions
  local_file_reader_name = staticmethod(readLocalExtension)
  local_file_writer_name = staticmethod(writeLocalExtension)
  # Extension needs no import
  local_file_importer_name = None
  local_file_remover_name = staticmethod(removeLocalExtension)

4073 4074
  @staticmethod
  def _getZodbObjectId(id):
4075
    return ExtensionComponent._getIdPrefix() + '.' + id
4076

4077 4078
  def getTemplateIdList(self):
    return self.getTemplateExtensionIdList()
4079

4080 4081
from Products.ERP5Type.Core.TestComponent import TestComponent

4082
class TestTemplateItem(DocumentTemplateItem):
4083 4084 4085 4086 4087
  """
  Live Tests are now stored in ZODB rather than on the filesystem. However,
  some Business Templates may still have filesystem Live Tests which need to
  be migrated to the ZODB.
  """
4088 4089
  local_file_reader_name = staticmethod(readLocalTest)
  local_file_writer_name = staticmethod(writeLocalTest)
4090
  # Test needs no import
4091
  local_file_importer_name = None
4092
  local_file_remover_name = staticmethod(removeLocalTest)
4093

4094 4095
  @staticmethod
  def _getZodbObjectId(id):
4096
    return TestComponent._getIdPrefix() + '.' + id
4097 4098 4099

  def getTemplateIdList(self):
    return self.getTemplateTestIdList()
Aurel's avatar
Aurel committed
4100

4101 4102 4103
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
4104 4105 4106

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
4107
  def build(self, context, **kw):
4108 4109
    for key in self._archive.iterkeys():
      self._objects[key] = 1
Aurel's avatar
Aurel committed
4110

4111
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4112
    modified_object_list = {}
4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128
    # 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]
    for role in self._objects:
      if installed_item._objects.has_key(role):
        continue
      else: # only show new roles
        modified_object_list.update({role : ['New', 'Role']})
    # get removed roles
    old_roles = installed_item._objects.keys()
    for role in old_roles:
      if role not in self._objects:
        modified_object_list.update({role : ['Removed', self.__class__.__name__[:-12]]})
4129 4130 4131
    return modified_object_list

  def install(self, context, trashbin, **kw):
4132
    p = context.getPortalObject()
4133
    # get roles
4134
    role_set = set(self._objects)
4135 4136 4137 4138
    # 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:
4139 4140
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
4141
    # set roles on portal
4142
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
4143 4144

  def _importFile(self, file_name, file):
4145
    if not file_name.endswith('.xml'):
4146
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
4147
      return
4148
    xml = parse(file)
4149 4150 4151
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163

  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)

4164 4165 4166 4167 4168 4169 4170 4171 4172
  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
4173
      if role in roles and role not in new_roles:
4174 4175 4176
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
4177
  # Function to generate XML Code Manually
4178 4179
  def generateXml(self):
    role_list = self._objects.keys()
4180
    xml_data = '<role_list>'
4181 4182
    for role in sorted(role_list):
      xml_data += '\n <role>%s</role>' % (role,)
4183
    xml_data += '\n</role_list>'
4184 4185
    return xml_data

Aurel's avatar
Aurel committed
4186
  def export(self, context, bta, **kw):
4187
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
4188
      return
4189 4190 4191 4192 4193 4194 4195 4196
    # 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
4197
    bta.addObject(xml_data, name=path)
4198

4199
class CatalogKeyTemplateItemBase(BaseTemplateItem):
4200

Aurel's avatar
Aurel committed
4201
  def build(self, context, **kw):
4202
    catalog = _getCatalogValue(self)
4203 4204 4205
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
4206
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
4207
    key_list = []
4208
    for key in self._archive.keys():
4209
      if key in catalog_key_list:
4210
        key_list.append(key)
4211
      elif not self.is_bt_for_diff:
4212
        raise NotFound, '%s %r not found in catalog' %(self.key_title, key)
4213
    if len(key_list) > 0:
4214
      self._objects['%s/%s' % (self.__class__.__name__, self.key_list_title)] = key_list
4215 4216

  def _importFile(self, file_name, file):
4217 4218 4219
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4220
    xml = parse(file)
4221 4222
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4223

4224 4225 4226 4227
  def _getUpdateDictAction(self, update_dict):
    action = update_dict.get(self.key_list_title, 'nothing')
    return action

4228
  def install(self, context, trashbin, **kw):
4229
    catalog = _getCatalogValue(self)
4230 4231 4232
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
4233

4234
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
4235 4236 4237 4238 4239
    if len(self._objects.keys()) == 0: # needed because of pop()
      return
    keys = []
    for k in self._objects.values().pop(): # because of list of list
      keys.append(k)
4240 4241
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
4242 4243
    if force or self._getUpdateDictAction(update_dict) != 'nothing':
      catalog_key_list = self._getUpdatedCatalogKeyList(catalog_key_list, keys)
4244
      setattr(catalog, self.key_list_attr, catalog_key_list)
4245

4246
  def _getUpdatedCatalogKeyList(self, catalog_key_list, new_key_list):
4247 4248 4249
    catalog_key_set = set(catalog_key_list) # copy
    catalog_key_set.update(new_key_list)
    return sorted(catalog_key_set)
4250

4251
  def uninstall(self, context, **kw):
4252
    catalog = _getCatalogValue(self)
4253 4254 4255
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
4256
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
4257
    object_path = kw.get('object_path', None)
4258 4259 4260 4261 4262
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
4263 4264 4265
      if key in catalog_key_list:
        catalog_key_list.remove(key)
    setattr(catalog, self.key_list_attr, catalog_key_list)
4266 4267
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
4268
  # Function to generate XML Code Manually
4269
  def generateXml(self, path=None):
4270
    obj = self._objects[path]
4271
    xml_data = '<key_list>'
4272 4273
    obj.sort()
    for key in obj:
4274 4275
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4276 4277
    return xml_data

Aurel's avatar
Aurel committed
4278 4279 4280
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
4281
    for path in self._objects.keys():
4282
      xml_data = self.generateXml(path=path)
4283
      bta.addObject(xml_data, name=path)
4284

4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304
class CatalogUniqueKeyTemplateItemBase(CatalogKeyTemplateItemBase):
  # like CatalogKeyTemplateItemBase, but for keys which use
  # "key | value" syntax to configure dictionaries.
  # The keys (part before the pipe) must be unique.

  def _getMapFromKeyList(self, key_list):
    # in case of duplicates, only the last installed entry will survive
    return dict(tuple(part.strip() for part in key.split('|', 1))
                for key in key_list)

  def _getListFromKeyMap(self, key_map):
    return [" | ".join(item) for item in sorted(key_map.items())]

  def _getUpdatedCatalogKeyList(self, catalog_key_list, new_key_list):
    # treat key lists as dictionaries, parse and update:
    catalog_key_map = self._getMapFromKeyList(catalog_key_list)
    catalog_key_map.update(self._getMapFromKeyList(new_key_list))
    return self._getListFromKeyMap(catalog_key_map)

class CatalogSearchKeyTemplateItem(CatalogUniqueKeyTemplateItemBase):
4305 4306 4307 4308 4309
  key_list_attr = 'sql_catalog_search_keys'
  key_list_title = 'search_key_list'
  key_title = 'Search key'

class CatalogResultKeyTemplateItem(CatalogKeyTemplateItemBase):
4310 4311 4312
  key_list_attr = 'sql_search_result_keys'
  key_list_title = 'result_key_list'
  key_title = 'Result key'
4313

4314
class CatalogRelatedKeyTemplateItem(CatalogUniqueKeyTemplateItemBase):
4315 4316 4317
  key_list_attr = 'sql_catalog_related_keys'
  key_list_title = 'related_key_list'
  key_title = 'Related key'
4318

4319
  # override this method to support 'key_list' for backward compatibility.
4320 4321 4322 4323 4324
  def _getUpdateDictAction(self, update_dict):
    action = update_dict.get(self.key_list_title, _MARKER)
    if action is _MARKER:
      action = update_dict.get('key_list', 'nothing')
    return action
4325

4326
class CatalogResultTableTemplateItem(CatalogKeyTemplateItemBase):
4327 4328 4329
  key_list_attr = 'sql_search_tables'
  key_list_title = 'result_table_list'
  key_title = 'Result table'
4330

4331
# keyword
4332
class CatalogKeywordKeyTemplateItem(CatalogKeyTemplateItemBase):
4333 4334 4335
  key_list_attr = 'sql_catalog_keyword_search_keys'
  key_list_title = 'keyword_key_list'
  key_title = 'Keyword key'
4336

4337
# datetime
4338
class CatalogDateTimeKeyTemplateItem(CatalogKeyTemplateItemBase):
4339 4340 4341
  key_list_attr = 'sql_catalog_datetime_search_keys'
  key_list_title = 'datetime_key_list'
  key_title = 'DateTime key'
4342

4343
# full text
4344
class CatalogFullTextKeyTemplateItem(CatalogKeyTemplateItemBase):
4345 4346 4347
  key_list_attr = 'sql_catalog_full_text_search_keys'
  key_list_title = 'full_text_key_list'
  key_title = 'Fulltext key'
4348

4349
# request
4350
class CatalogRequestKeyTemplateItem(CatalogKeyTemplateItemBase):
4351 4352 4353
  key_list_attr = 'sql_catalog_request_keys'
  key_list_title = 'request_key_list'
  key_title = 'Request key'
4354

4355
# multivalue
4356
class CatalogMultivalueKeyTemplateItem(CatalogKeyTemplateItemBase):
4357 4358 4359
  key_list_attr = 'sql_catalog_multivalue_keys'
  key_list_title = 'multivalue_key_list'
  key_title = 'Multivalue key'
4360 4361

# topic
4362
class CatalogTopicKeyTemplateItem(CatalogKeyTemplateItemBase):
4363 4364 4365 4366
  key_list_attr = 'sql_catalog_topic_search_keys'
  key_list_title = 'topic_key_list'
  key_title = 'Topic key'

4367
class CatalogScriptableKeyTemplateItem(CatalogUniqueKeyTemplateItemBase):
4368 4369 4370 4371
  key_list_attr = 'sql_catalog_scriptable_keys'
  key_list_title = 'scriptable_key_list'
  key_title = 'Scriptable key'

4372
class CatalogRoleKeyTemplateItem(CatalogUniqueKeyTemplateItemBase):
4373 4374 4375 4376
  key_list_attr = 'sql_catalog_role_keys'
  key_list_title = 'role_key_list'
  key_title = 'Role key'

4377
class CatalogLocalRoleKeyTemplateItem(CatalogUniqueKeyTemplateItemBase):
4378 4379 4380
  key_list_attr = 'sql_catalog_local_role_keys'
  key_list_title = 'local_role_key_list'
  key_title = 'LocalRole key'
4381

4382 4383 4384 4385 4386 4387
class CatalogSecurityUidColumnTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_security_uid_columns'
  key_list_title = 'security_uid_column_list'
  key_title = 'Security Uid Columns'


4388 4389 4390 4391
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4392 4393 4394
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4395
      else: # XXX backward compatibility
4396 4397
        lang = lang_key
        catalog = 'erp5_ui'
4398
      path = posixpath.join(lang, catalog)
4399 4400
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4401 4402 4403
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4404

4405
  def preinstall(self, context, installed_item, **kw):
4406
    modified_object_list = {}
4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420
    for path in self._objects:
      if installed_item._objects.has_key(path):
        # compare object to see if there is changes
        new_obj_code = self._objects[path]
        old_obj_code = installed_item._objects[path]
        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
    old_keys = installed_item._objects.keys()
    for path in old_keys:
      if path not in self._objects:
        modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
4421 4422
    return modified_object_list

4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438
  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']
4439
      dispatcher.manage_addMessageCatalog(id=catalog,
4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450
                                          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', {})
4451
    force = kw.get('force')
4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470
    for key in sorted(self._objects.keys()):
      if update_dict.has_key(key) or force:
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
        lang, catalog = self._splitKey(key)

        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
4471
          else:
4472 4473 4474 4475 4476 4477 4478 4479 4480 4481
            # 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)
          if lang not in localizer.get_languages():
            localizer.manage_addLanguage(lang)
        else:
          po = self._objects[key]
          if lang not in localizer.get_languages():
            localizer.manage_addLanguage(lang)
          self._importCatalogLanguage(localizer, catalog, lang, po)
4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510

  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)
4511 4512

  def export(self, context, bta, **kw):
4513
    if len(self._objects) == 0:
4514
      return
4515
    root_path = self.__class__.__name__
4516
    for key, obj in self._objects.iteritems():
4517
      path = os.path.join(root_path, key)
4518
      if '/' in key:
4519
        bta.addObject(obj, 'translation', ext='.po', path=path)
4520 4521 4522 4523 4524
      else:
        xml_data = ['<language>']
        xml_data.append(' <code>%s</code>' % (escape(key), ))
        xml_data.append(' <name>%s</name>' % (escape(obj), ))
        xml_data.append('</language>')
4525
        bta.addObject('\n'.join(xml_data), 'language', path=path)
4526 4527

  def _importFile(self, file_name, file):
4528 4529
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4530 4531
      text = file.read()
      self._objects[file_name[:-3]] = text
4532 4533
    elif name == 'language.xml':
      xml = parse(file)
4534 4535
      name = xml.find('name').text
      code = xml.find('code').text
4536
      self._objects[code] = name
4537

Aurel's avatar
Aurel committed
4538 4539
class LocalRolesTemplateItem(BaseTemplateItem):

4540
  def __init__(self, id_list, **kw):
4541
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4542 4543
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4544 4545 4546
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4547
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4548 4549
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4550 4551 4552
      local_roles_group_id_dict = getattr(
        obj, '__ac_local_roles_group_id_dict__', {}) or {}
      self._objects[path] = (local_roles_dict, local_roles_group_id_dict)
Aurel's avatar
Aurel committed
4553

Christophe Dumez's avatar
Christophe Dumez committed
4554
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4555
  def generateXml(self, path=None):
4556 4557 4558 4559 4560 4561 4562 4563 4564 4565
    # With local roles groups id, self._object contains for each path a tuple
    # containing the dict of local roles and the dict of local roles group ids.
    # Before it was only containing the dict of local roles. This method is
    # also used on installed business templates to show a diff during
    # installation, so it might be called on old format objects.
    if len(self._objects[path]) == 2:
      # new format
      local_roles_dict, local_roles_group_id_dict = self._objects[path]
    else:
      # old format, before local roles group id
4566
      local_roles_group_id_dict = None
4567 4568
      local_roles_dict, = self._objects[path]

Aurel's avatar
Aurel committed
4569
    xml_data = '<local_roles_item>'
4570
    # local roles
4571
    xml_data += '\n <local_roles>'
4572
    for key in sorted(local_roles_dict):
4573
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4574 4575
      tuple = local_roles_dict[key]
      for item in tuple:
4576 4577 4578
        xml_data += "\n   <item>%s</item>" %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </local_roles>'
4579 4580 4581 4582

    if local_roles_group_id_dict:
      # local roles group id dict (not included by default to be stable with
      # old bts)
4583 4584 4585 4586 4587 4588 4589 4590
      xml_data += '\n <local_role_group_ids>'
      for local_role_group_id, local_roles_group_id_list in sorted(local_roles_group_id_dict.items()):
        xml_data += "\n  <local_role_group_id id='%s'>" % escape(local_role_group_id)
        for principal, role in sorted(local_roles_group_id_list):
          xml_data += "\n    <principal id='%s'>%s</principal>" % \
                (escape(principal), escape(role))
        xml_data += "\n  </local_role_group_id>"
      xml_data += '\n </local_role_group_ids>'
4591

4592
    xml_data += '\n</local_roles_item>'
Vincent Pelletier's avatar
Vincent Pelletier committed
4593
    if isinstance(xml_data, unicode):
4594
      xml_data = xml_data.encode('utf8')
Aurel's avatar
Aurel committed
4595
    return xml_data
4596

Aurel's avatar
Aurel committed
4597
  def export(self, context, bta, **kw):
4598 4599
    path = self.__class__.__name__
    for key in self._objects:
Aurel's avatar
Aurel committed
4600
      xml_data = self.generateXml(key)
4601 4602
      assert key[:12] == 'local_roles/'
      bta.addObject(xml_data, key[12:], path=path)
Aurel's avatar
Aurel committed
4603 4604

  def _importFile(self, file_name, file):
4605 4606 4607
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4608 4609
    xml = parse(file)
    # local roles
4610
    local_roles_list = xml.findall('//role')
Aurel's avatar
Aurel committed
4611 4612
    local_roles_dict = {}
    for role in local_roles_list:
4613 4614
      id = role.get('id')
      item_type_list = [item.text for item in role]
Aurel's avatar
Aurel committed
4615
      local_roles_dict[id] = item_type_list
4616 4617 4618

    # local roles group id
    local_roles_group_id_dict = {}
4619 4620 4621 4622 4623
    for local_role_group_id in xml.findall('//local_role_group_id'):
      role_set = set()
      for principal in local_role_group_id.findall('./principal'):
        role_set.add((principal.get('id'), principal.text))
      local_roles_group_id_dict[local_role_group_id.get('id')] = role_set
4624 4625
    self._objects['local_roles/%s' % (file_name[:-4],)] = (
      local_roles_dict, local_roles_group_id_dict)
Aurel's avatar
Aurel committed
4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636

  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
4637 4638
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4639 4640 4641 4642 4643
        # again we might be installing an business template in format before
        # existance of local roles group id.
        if len(self._objects[roles_path]) == 2:
          local_roles_dict, local_roles_group_id_dict = self._objects[roles_path]
        else:
4644
          local_roles_group_id_dict = None
4645
          local_roles_dict, = self._objects[roles_path]
4646
        obj.__ac_local_roles__ = local_roles_dict
4647
        if local_roles_group_id_dict:
4648
          obj.__ac_local_roles_group_id_dict__ = local_roles_group_id_dict
4649 4650
          # we try to have __ac_local_roles_group_id_dict__ set only if
          # it is actually defining something else than default
4651 4652 4653 4654 4655
        else:
          try:
            del obj.__ac_local_roles_group_id_dict__
          except AttributeError:
            pass
4656
        obj.reindexObject()
Aurel's avatar
Aurel committed
4657

4658
  def uninstall(self, context, object_path=None, **kw):
Aurel's avatar
Aurel committed
4659
    p = context.getPortalObject()
4660 4661 4662 4663 4664
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
Aurel's avatar
Aurel committed
4665
      path = roles_path.split('/')[1:]
4666 4667 4668 4669 4670
      # 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__', {})
4671 4672 4673
        if getattr(aq_base(obj), '__ac_local_roles_group_id_dict__',
                    None) is not None:
          delattr(obj, '__ac_local_roles_group_id_dict__')
4674
        obj.reindexObject()
4675

4676 4677 4678 4679 4680 4681 4682
class bt(dict):
  """Fake 'bt' item to read bt/* files through BusinessTemplateArchive"""

  def _importFile(self, file_name, file):
    self[file_name] = file.read()


4683 4684 4685
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4686
    in part or completely. Each object is separated from its
4687 4688 4689 4690 4691 4692 4693 4694 4695 4696
    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
4697 4698
      - object without optimal actions
      - list of relation between portal type and workflow
4699 4700 4701 4702 4703 4704 4705 4706 4707 4708

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

    - site property definition
      - id
      - type
4709
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4710

4711 4712
    - document/propertysheet/extension/test definition
      - copy of the local file
4713

4714
    - message transalation definition
4715
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4716

4717 4718
    The Business Template properties are exported to the bt folder with
    one property per file
4719

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4720 4721
    Technology:

4722 4723
    - 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
4724

4725
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4726 4727 4728 4729

    Use case:

    - install core ERP5 (the minimum)
4730

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

4733 4734
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4735
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4736 4737 4738 4739 4740
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4741
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4742 4743 4744

    # Declarative security
    security = ClassSecurityInfo()
4745
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4746 4747 4748 4749

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4750
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4751
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4752
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4753
                      , PropertySheet.BusinessTemplate
4754
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4755 4756
                      )

4757 4758 4759 4760 4761 4762
    # 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."""
4763
         , 'icon'           : 'file_icon.gif'
4764 4765
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
4766
         , 'type_class'     : 'BusinessTemplate'
4767 4768 4769 4770 4771 4772 4773
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4774 4775
    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4776 4777
      self._clean()

4778
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4779 4780 4781 4782 4783 4784 4785
    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".
4786 4787
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4788
          # XXX Not good to access the attribute directly,
4789 4790 4791
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4792

4793 4794 4795 4796
    def getShortRevision(self):
      """Returned a shortened revision"""
      r = self.getRevision()
      return r and r[:5]
4797

4798 4799
    security.declareProtected(Permissions.ManagePortal, 'storeTemplateItemData')
    def storeTemplateItemData(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4800
      """
4801
        Instanciate and Store Template items into properties.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4802
      """
4803
      # Store all Data
4804 4805
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4806
      self._portal_type_workflow_chain_item = \
4807
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4808 4809 4810 4811
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4812 4813 4814
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4815 4816 4817
      self._registered_version_priority_selection_item = \
          RegisteredVersionPrioritySelectionTemplateItem(
              self.getTemplateRegisteredVersionPrioritySelectionList())
4818 4819 4820 4821 4822 4823
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4824
      self._portal_type_roles_item = \
4825
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4826 4827 4828 4829 4830 4831 4832
      self._site_property_item = \
          SitePropertyTemplateItem(self.getTemplateSitePropertyIdList())
      self._module_item = \
          ModuleTemplateItem(self.getTemplateModuleIdList())
      self._document_item = \
          DocumentTemplateItem(self.getTemplateDocumentIdList())
      self._property_sheet_item = \
4833 4834
          PropertySheetTemplateItem(self.getTemplatePropertySheetIdList(),
                                    context=self)
4835 4836
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856
      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())
4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868
      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())
4869 4870
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4871 4872
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4873 4874 4875
      self._catalog_search_key_item = \
          CatalogSearchKeyTemplateItem(
               self.getTemplateCatalogSearchKeyList())
4876 4877
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4878
               self.getTemplateCatalogKeywordKeyList())
4879 4880 4881
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4882 4883
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4884
               self.getTemplateCatalogFullTextKeyList())
4885 4886
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4887
               self.getTemplateCatalogRequestKeyList())
4888 4889
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4890
               self.getTemplateCatalogMultivalueKeyList())
4891 4892 4893
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4894 4895
      self._local_roles_item = \
          LocalRolesTemplateItem(
4896
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4897 4898 4899
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4900 4901 4902
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4903 4904 4905 4906 4907 4908
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4909 4910
      try:
        self._catalog_security_uid_column_item = \
4911 4912
          CatalogSecurityUidColumnTemplateItem(
               self.getTemplateCatalogSecurityUidColumnList())
4913 4914 4915 4916
      except AttributeError:
        # be backwards compatible with old zope instances which
        # do not contain recent version of erp5_property_sheets
        pass
4917

4918
    security.declareProtected(Permissions.ManagePortal, 'build')
4919
    def build(self, no_action=0, update_revision=True):
4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930
      """
        Copy existing portal objects to self
      """
      if no_action: return
        # this is use at import of Business Template to get the status built
      # Make sure that everything is sane.
      self.clean()

      self._setTemplateFormatVersion(1)
      self.storeTemplateItemData()

4931
      # Build each part
4932
      for item_name in item_name_list:
4933
        item = getattr(self, item_name)
4934 4935
        if item is None:
          continue
4936 4937 4938
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4939 4940
      # update _p_jar property of objects cleaned by removeProperties
      transaction.savepoint(optimistic=True)
4941 4942
      if update_revision:
        self._export()
4943 4944

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4945
      """
4946
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4947
      """
4948
      return self.portal_templates.publish(self, url, username=username,
4949
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4950

4951
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4952
      """
4953
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4954
      """
4955
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4956

4957 4958 4959 4960 4961
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4962 4963 4964
      default_catalog = self.getPortalObject().portal_catalog.getSQLCatalog()
      my_catalog = _getCatalogValue(self)
      if default_catalog is not None and my_catalog is not None \
4965
             and catalog_method is not None:
4966 4967 4968 4969 4970 4971
        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
4972 4973
      return False

4974
    def preinstall(self, check_dependencies=1, **kw):
4975 4976 4977
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4978
      """
4979 4980 4981 4982 4983
      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()
4984

4985 4986
      modified_object_list = {}
      bt_title = self.getTitle()
4987 4988 4989 4990 4991 4992 4993

      #  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)
4994

4995
      # if reinstall business template, must compare to object in ZODB
4996
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4997
      # same if we make a diff and select only one business template
4998
      reinstall = 0
4999 5000
      if installed_bt == self:
        reinstall = 1
5001
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
5002
          bt2 = self.portal_templates.manage_clone(ob=installed_bt,
5003
                                                   id=INSTALLED_BT_FOR_DIFF)
5004 5005 5006 5007 5008 5009 5010
          # 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)
5011

5012
      for item_name in item_name_list:
5013
        new_item = getattr(self, item_name, None)
5014
        installed_item = getattr(installed_bt, item_name, None)
5015
        if new_item is not None:
5016
          if installed_item is not None and hasattr(installed_item, '_objects'):
5017
            modified_object = new_item.preinstall(context=self,
5018 5019
                                                  installed_item=installed_item,
                                                  installed_bt=installed_bt)
5020 5021 5022 5023 5024 5025 5026
            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:
5027
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5028

5029 5030
      return modified_object_list

5031
    def _install(self, force=1, object_to_update=None, update_translation=0,
5032
                 update_catalog=False, **kw):
5033
      """
Christophe Dumez's avatar
Christophe Dumez committed
5034
        Install a new Business Template, if force, all will be upgraded or installed
5035 5036
        otherwise depends of dict object_to_update
      """
5037 5038 5039 5040
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
5041

5042 5043
      site = self.getPortalObject()
      installed_bt = site.portal_templates.getInstalledBusinessTemplate(
5044
                                                           self.getTitle())
5045 5046
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
5047 5048 5049
        if site.portal_workflow.isTransitionPossible(
            installed_bt, 'replace'):
          installed_bt.replace(self)
5050

5051
      trash_tool = getToolByName(site, 'portal_trash', None)
5052
      if trash_tool is None:
5053 5054
        raise AttributeError, 'Trash Tool is not installed'

5055 5056 5057
      if not force:
        self.checkDependencies()

5058 5059
      # 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
5060
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 2):
5061 5062 5063 5064 5065
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
5066
      if len(object_to_update) or force:
5067
        for item_name in item_name_list:
5068 5069
          item = getattr(self, item_name, None)
          if item is not None:
5070
            item.install(self, force=force, object_to_update=object_to_update,
5071
                               trashbin=trashbin, installed_bt=installed_bt)
5072

5073
      if update_catalog:
5074
        catalog = _getCatalogValue(self)
5075
        if (catalog is None) or (not site.isIndexable):
5076 5077 5078 5079 5080
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
5081

5082
      # get objects to remove
5083
      # do remove after because we may need backup object from installation
5084
      remove_object_dict = {}
5085 5086
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
5087
          remove_object_dict[path] = action
5088

5089
      # remove object from old business template
5090
      if len(remove_object_dict):
5091
        # XXX: this code assumes that there is an installed_bt
5092
        for item_name in reversed(item_name_list):
5093
          item = getattr(installed_bt, item_name, None)
5094
          if item is not None:
5095
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
5096

5097 5098

      # update tools if necessary
5099 5100 5101 5102 5103
      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)
5104

5105 5106
      # remove trashbin if empty
      if trashbin is not None:
5107
        if len(trashbin) == 0:
5108 5109
          trash_tool.manage_delObjects([trashbin.getId(),])

5110 5111
      if update_catalog:
        site.ERP5Site_reindexAll()
5112

5113 5114
      # Update translation table, in case we added new portal types or
      # workflow states.
5115 5116
      if update_translation:
        site.ERP5Site_updateTranslationTable()
5117

5118 5119
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
5120

5121
    security.declareProtected(Permissions.ManagePortal, 'install')
5122
    install = _install
5123

5124
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
5125
    reinstall = _install
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5126

5127
    security.declareProtected(Permissions.ManagePortal, 'trash')
5128 5129
    def trash(self, new_bt, **kw):
      """
5130
        Trash unnecessary items before upgrading to a new business
5131
        template.
5132
        This is similar to uninstall, but different in that this does
5133
        not remove all items.
5134
      """
5135
      # Trash everything
5136
      for item_name in reversed(item_name_list):
5137
        item = getattr(self, item_name, None)
5138 5139
        if item is not None:
          item.trash(
5140
                self,
5141
                getattr(new_bt, item_name))
5142

5143
    def _uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5144
      """
5145
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5146
      """
5147 5148
      # Uninstall everything
      # Trash everything
5149
      for item_name in reversed(item_name_list):
5150
        item = getattr(self, item_name, None)
5151
        if item is not None:
5152
          item.uninstall(self, **kw)
5153
      # It is better to clear cache because the uninstallation of a
5154
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
5155
      self.getPortalObject().portal_caches.clearAllCache()
5156

5157 5158
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
    uninstall = _uninstall
5159

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5160
    def _clean(self):
5161
      """
5162
        Clean built information.
5163
      """
5164
      # First, remove obsolete attributes if present.
5165 5166 5167 5168
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
5169
                    '_module_archive',
5170 5171 5172
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
5173
                    '_property_sheet_archive'):
5174 5175 5176
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
5177
      for item_name in item_name_list:
5178
        setattr(self, item_name, None)
5179

5180 5181
    security.declareProtected(Permissions.ManagePortal, 'clean')
    clean = _clean
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5182

5183
    security.declareProtected(Permissions.AccessContentsInformation,
5184
                              'getBuildingState')
5185
    def getBuildingState(self, default=None, id_only=1):
5186
      """
5187
        Returns the current state in building
5188
      """
5189
      portal_workflow = getToolByName(self, 'portal_workflow')
5190 5191
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
5192
      return wf._getWorkflowStateOf(self, id_only=id_only )
5193

5194
    security.declareProtected(Permissions.AccessContentsInformation,
5195
                              'getInstallationState')
5196
    def getInstallationState(self, default=None, id_only=1):
5197
      """
5198
        Returns the current state in installation
5199
      """
5200
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
5201 5202
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
5203
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5204

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5205 5206 5207 5208 5209 5210
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
5211
      export_string = portal_templates.manage_exportObject(
5212 5213
                                               id=self.getId(),
                                               toxml=1,
5214
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5215
      return export_string
5216

5217
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5218
      """
5219 5220
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5221
      """
5222 5223
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
5224 5225 5226 5227
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
5228
        # XXX Why do we need to return a tuple ?
5229 5230
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5231

5232
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5233
      """
5234 5235
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5236
      """
5237
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5238

5239
    def getTemplateBaseCategoryList(self):
5240
      """
5241 5242
      We have to set this method because we want an
      ordered list
5243
      """
5244
      return self._getOrderedList('template_base_category')
5245

5246
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5247
      """
5248 5249
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5250
      """
5251
      return self._getOrderedList('template_workflow_id')
5252

5253
    def getTemplatePortalTypeIdList(self):
5254
      """
5255 5256
      We have to set this method because we want an
      ordered list
5257
      """
5258
      return self._getOrderedList('template_portal_type_id')
5259

5260 5261 5262 5263 5264 5265 5266
    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
5267 5268 5269 5270 5271 5272 5273
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

5274 5275 5276 5277 5278 5279 5280
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

5281 5282 5283 5284 5285 5286
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
5287

5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308
    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')

5309
    def getTemplateActionPathList(self):
5310
      """
5311 5312
      We have to set this method because we want an
      ordered list
5313
      """
5314
      return self._getOrderedList('template_action_path')
5315

5316
    def getTemplatePortalTypeRoleList(self):
5317 5318 5319 5320
      """
      We have to set this method because we want an
      ordered list
      """
5321
      return self._getOrderedList('template_portal_type_role')
5322

5323
    def getTemplateLocalRoleList(self):
5324 5325 5326 5327
      """
      We have to set this method because we want an
      ordered list
      """
5328
      return self._getOrderedList('template_local_role')
5329

5330
    def getTemplateSkinIdList(self):
5331
      """
5332 5333
      We have to set this method because we want an
      ordered list
5334
      """
5335
      return self._getOrderedList('template_skin_id')
5336

5337 5338 5339 5340 5341 5342 5343
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

5344 5345 5346 5347 5348
    def getTemplateRegisteredVersionPrioritySelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
5349 5350 5351 5352 5353 5354
      try:
        return self._getOrderedList('template_registered_version_priority_selection')
      # This property may not be defined if erp5_property_sheets has not been
      # upgraded yet
      except AttributeError:
        return ()
5355

5356
    def getTemplateModuleIdList(self):
5357
      """
5358 5359
      We have to set this method because we want an
      ordered list
5360
      """
5361
      return self._getOrderedList('template_module_id')
5362 5363 5364 5365 5366 5367 5368

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5370 5371 5372 5373 5374 5375 5376
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5377
    def _isInKeepList(self, keep_list, path):
5378 5379 5380
      for keep_path in keep_list:
        if keep_path.endswith('**') and path.startswith(keep_path[:-2]):
          return True
5381 5382 5383
        elif keep_path.endswith('*') and path.startswith(keep_path[:-1])\
            and len(keep_path.split('/')) == len(path.split('/')):
          return True
5384 5385 5386 5387
        elif path == keep_path:
          return True
      return False

5388 5389 5390 5391 5392 5393
    def isKeepObject(self, path):
      """
      Return True if path is included in keep object list.
      """
      return self._isInKeepList(self.getTemplateKeepPathList(), path)

5394 5395 5396 5397
    def isKeepWorkflowObject(self, path):
      """
      Return True if path is included in keep workflow object list.
      """
5398 5399 5400 5401 5402 5403 5404 5405
      return self._isInKeepList(self.getTemplateKeepWorkflowPathList(), path)

    def isKeepWorkflowObjectLastHistoryOnly(self, path):
      """
      Return True if path is included in keep workflow last state only list
      """
      return self._isInKeepList(self.getTemplateKeepLastWorkflowHistoryOnlyPathList(),
                                path)
5406

5407 5408 5409 5410 5411
    def getExportPath(self):
      preferences = self.getPortalObject().portal_preferences
      bt_name = self.getTitle()
      from App.config import getConfiguration
      instance_home = getConfiguration().instancehome
5412
      for path in (preferences.getPreferredWorkingCopyList() or ['bt5']):
5413 5414 5415 5416 5417 5418 5419 5420 5421
        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

5422 5423 5424
    @transactional_cached(lambda self, vcs=None, path=None, restricted=False:
                          (self, vcs, path, restricted))
    def _getVcsTool(self, vcs=None, path=None, restricted=False):
5425
      from Products.ERP5VCS.WorkingCopy import getVcsTool
5426 5427
      if not (path or vcs):
        path = self.getExportPath()
5428 5429 5430 5431
      return getVcsTool(vcs, path, restricted).__of__(self)

    def getVcsTool(self, vcs=None, path=None):
      return self._getVcsTool(vcs, path, True)
5432 5433 5434

    def isVcsType(self, *vcs):
      # could be moved to Products.ERP5.Base.Base
5435
      from Products.ERP5VCS.WorkingCopy import NotAWorkingCopyError
5436 5437 5438 5439 5440
      try:
        return self.getVcsTool().reference in vcs
      except NotAWorkingCopyError:
        return None in vcs

5441
    security.declareProtected(Permissions.ManagePortal, 'export')
5442
    def export(self, path=None, local=0, bta=None, **kw):
Aurel's avatar
Aurel committed
5443 5444 5445
      """
        Export this Business Template
      """
5446
      if self.getBuildingState() != 'built':
5447
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5448
              'Business Template must be built before export'
5449
      return self._export(path, local, bta)
5450

5451
    def _export(self, path=None, local=0, bta=None):
5452 5453 5454
      if bta is None:
        if local:
          # we export into a folder tree
5455
          bta = BusinessTemplateFolder(path, creation=1)
5456 5457 5458 5459
        else:
          # We export BT into a tarball file
          if path is None:
            path = self.getTitle()
5460
          bta = BusinessTemplateTarball(path, creation=1)
Aurel's avatar
Aurel committed
5461

5462
      # export bt
Aurel's avatar
Aurel committed
5463
      for prop in self.propertyMap():
5464
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5465
        id = prop['id']
5466
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id', 'revision',
5467
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5468
          continue
Aurel's avatar
Aurel committed
5469
        value = self.getProperty(id)
5470
        if not value:
5471
          continue
5472
        if prop_type in ('text', 'string', 'int', 'boolean'):
5473
          bta.addObject(str(value), name=id, path='bt', ext='')
5474
        elif prop_type in ('lines', 'tokens'):
5475
          bta.addObject('\n'.join(value), name=id, path='bt', ext='')
5476

Aurel's avatar
Aurel committed
5477
      # Export each part
5478
      for item_name in item_name_list:
5479 5480 5481
        item = getattr(self, item_name, None)
        if item is not None:
          item.export(context=self, bta=bta)
5482

5483
      self._setRevision(bta.getRevision())
5484
      return bta.finishCreation()
Aurel's avatar
Aurel committed
5485

5486
    security.declareProtected(Permissions.ManagePortal, 'importFile')
5487
    def importFile(self, path):
Aurel's avatar
Aurel committed
5488
      """
5489
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5490
      """
5491 5492
      bta = (BusinessTemplateFolder if os.path.isdir(path) else
             BusinessTemplateTarball)(path, importing=1)
5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508
      bt_item = bt()
      bta.importFiles(bt_item)
      prop_dict = {}
      for prop in self.propertyMap():
        pid = prop['id']
        if pid != 'id':
          prop_type = prop['type']
          value = bt_item.get(pid)
          if prop_type in ('text', 'string'):
            prop_dict[pid] = value or ''
          elif prop_type in ('int', 'boolean'):
            prop_dict[pid] = value or 0
          elif prop_type in ('lines', 'tokens'):
            prop_dict[pid[:-5]] = (value or '').splitlines()
      self._edit(**prop_dict)

5509 5510 5511 5512 5513
      from Products.ERP5VCS.WorkingCopy import NotAWorkingCopyError
      try:
        vcs_tool = self._getVcsTool(path=path)
      except NotAWorkingCopyError:
        pass
Aurel's avatar
Aurel committed
5514
      else:
5515 5516 5517 5518 5519 5520 5521
        comment = translateString(
          'Downloaded from ${type} repository at revision ${revision}',
          mapping={'type': vcs_tool.title,
                   'revision': vcs_tool.getRevision(True)})
        workflow_tool = self.getPortalObject().portal_workflow
        workflow_tool.business_template_building_workflow.notifyWorkflowMethod(
          self, 'edit', kw={'comment': comment})
5522 5523

      self.storeTemplateItemData()
5524

5525 5526
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5527 5528
      # XXX This is not required with portal types as classes.
      #     It is still there for compatibility with non-migrated objects.
5529
      module_id_list = []
5530
      for template_id in self.getTemplateDocumentIdList():
5531 5532 5533
        module_id = 'Products.ERP5Type.Document.' + template_id
        if module_id not in sys.modules:
          module_id_list.append(module_id)
5534
          sys.modules[module_id] = module = imp.new_module(module_id)
5535 5536
          setattr(module, template_id, type(template_id,
            (SimpleItem.SimpleItem,), {'__module__': module_id}))
5537

5538
      for item_name in item_name_list:
Ivan Tyagov's avatar
Ivan Tyagov committed
5539
        item_object = getattr(self, item_name, None)
5540 5541
        # this check is due to backwards compatability when there can be a
        # difference between install erp5_property_sheets (esp. BusinessTemplate
5542
        # property sheet)
5543 5544
        if item_object is not None:
          item_object.importFile(bta)
5545

5546 5547
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5548 5549
      for module_id in module_id_list:
        del sys.modules[module_id]
5550

5551 5552
      self._setRevision(bta.getRevision())

5553 5554 5555 5556
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
5557
      for item_name in item_name_list:
5558 5559 5560
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5561
      return items_list
5562

5563 5564 5565 5566 5567 5568
    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
      """
5569 5570
      missing_dep_list = self.getMissingDependencyList()
      if len(missing_dep_list) != 0:
5571 5572 5573
        raise BusinessTemplateMissingDependency, \
          'Impossible to install %s, please install the following dependencies before: %s' \
          %(self.getTitle(), repr(missing_dep_list))
5574 5575 5576 5577 5578

    def getMissingDependencyList(self):
      """
      Retuns a list of missing dependencies.
      """
5579 5580
      missing_dep_list = []
      dependency_list = self.getDependencyList()
5581
      if len(dependency_list) > 0:
5582
        for dependency_couple in dependency_list:
5583
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5584
          dependency = dependency_couple_list[0]
5585 5586
          if dependency in (None, ''):
            continue
5587 5588
          version_restriction = None
          if len(dependency_couple_list) > 1:
5589
            version_restriction = dependency_couple_list[1]
5590 5591 5592
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5593 5594 5595
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5596
                  or (version_restriction not in (None, '') and
5597 5598
                     (not self.portal_templates.compareVersionStrings(installed_bt.getVersion(), version_restriction)))):
            missing_dep_list.append((dependency, version_restriction or ''))
5599
      return [' '.join([y for y in x if y]) for x in missing_dep_list]
5600

5601 5602 5603
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
5604
        This is compatible with ERP5VCS look and feel but
5605 5606 5607 5608
        it is preferred in future we use more difflib python library.
      """
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

Aurel's avatar
Aurel committed
5609
    def diffObject(self, REQUEST, **kw):
5610 5611
      """
        Make a diff between an object in the Business Template
5612
        and the same in the Business Template installed in the site
5613 5614 5615 5616
      """

      class_name_dict = {
        'Product' : '_product_item',
5617
        'PropertySheet' : '_property_sheet_item',
5618
        'Constraint' : '_constraint_item',
5619 5620 5621 5622 5623 5624 5625 5626 5627
        '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',
5628
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5629 5630 5631 5632
        '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',
5633 5634 5635
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5636
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5637
        'Path' : '_path_item',
5638
        'Preference' : '_preference_item',
5639
        'Action' : '_action_item',
5640
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5641
        'LocalRoles' : '_local_roles_item',
5642 5643 5644
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5645
        'CatalogSearchKey' : '_catalog_search_key_item',
5646
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5647
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5648 5649 5650 5651
        '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
5652
        'Tool': '_tool_item',
5653
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5654 5655
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5656
        'CatalogSecurityUidColumn' : '_catalog_security_uid_column_item',
5657
        }
5658

5659 5660
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5661

Christophe Dumez's avatar
Christophe Dumez committed
5662
      # Get objects
5663
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5664

5665
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
5666
      # Compare with a given business template
5667
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5668 5669
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5670 5671
        if bt2_id == self.getId():
          compare_to_zodb = 1
5672
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5673 5674
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5675 5676 5677
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5678 5679
          compare_to_zodb = 1
      if compare_to_zodb:
5680
        bt2 = self.portal_templates.manage_clone(ob=installed_bt,
5681
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5682
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5683 5684 5685
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5686

5687 5688
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5689
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5690
        # XXX maybe only build for the given object to gain time
5691
        installed_item.build(self)
5692 5693 5694
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5695

Christophe Dumez's avatar
Christophe Dumez committed
5696
      # Real Zope Objects (can be exported into XML directly by Zope)
5697 5698
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5699
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5700
                     '_skin_item', '_action_item', '_tool_item', ]
5701

Christophe Dumez's avatar
Christophe Dumez committed
5702
      # Not considered as objects by Zope (will be exported into XML manually)
5703
      # XXX Bad naming
5704 5705
      item_list_2 = ['_site_property_item',
                     '_module_item',
5706
                     '_catalog_result_key_item',
5707
                     '_catalog_related_key_item',
5708
                     '_catalog_result_table_item',
5709
                     '_catalog_search_key_item',
5710
                     '_catalog_keyword_key_item',
5711
                     '_catalog_datetime_key_item',
5712 5713 5714 5715
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5716
                     '_catalog_scriptable_key_item',
5717 5718
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5719
                     '_catalog_security_uid_column_item',
5720 5721 5722 5723 5724 5725
                     '_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',
5726
                     '_portal_type_workflow_chain_item',]
5727

Christophe Dumez's avatar
Christophe Dumez committed
5728
      # Text objects (no need to export them into XML)
5729
      # XXX Bad naming
5730 5731
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5732
                     '_test_item', '_message_translation_item',]
5733

5734
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5735 5736 5737
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5738 5739
        new_object = new_item.removeProperties(new_object, 1)
        installed_object = installed_item.removeProperties(installed_object, 1)
5740
        # XML Export in memory
5741
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5742
        OFS.XMLExportImport.exportXML(installed_object._p_jar,
5743
                                      installed_object._p_oid, f2)
5744
        new_obj_xml = f1.getvalue()
5745
        f1.close()
5746 5747 5748 5749
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5750
        # End of XML export
5751

5752
        # Diff between XML objects
5753 5754
        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
5755
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5756 5757 5758
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5759

5760
      elif item_name in item_list_2:
5761
        # Generate XML code manually
5762 5763
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5764 5765
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5766
        # End of XML Code Generation
5767

5768
        # Diff between XML objects
5769 5770
        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
5771
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5772 5773 5774
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5775

5776
      elif item_name in item_list_3:
5777
        # Diff between text objects
5778 5779
        if hasattr(new_object, 'getTextContent'): # ZODB component
          new_object = new_object.getTextContent()
5780
        new_obj_lines = new_object.splitlines()
5781 5782
        if hasattr(installed_object, 'getTextContent'):
          installed_object = installed_object.getTextContent()
5783 5784 5785
        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
5786
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5787 5788
          diff_msg += '\n'.join(diff_list)
        else:
5789
          diff_msg = 'No diff'
5790

5791
      else:
5792
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5793

5794
      if compare_to_zodb:
5795
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5796

5797
      return diff_msg
5798

5799

5800 5801 5802 5803
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5804 5805
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5806 5807 5808 5809 5810 5811 5812 5813 5814
      bt_allowed_content_type_list = list(
        self.getTemplatePortalTypeAllowedContentTypeList())
      bt_hidden_content_type_list = list(
        self.getTemplatePortalTypeHiddenContentTypeList())
      bt_property_sheet_list = list(
        self.getTemplatePortalTypePropertySheetList())
      bt_base_category_list = list(
        self.getTemplatePortalTypeBaseCategoryList())
      bt_action_list = list(self.getTemplateActionPathList())
5815
      bt_portal_types_id_list = list(self.getTemplatePortalTypeIdList())
5816 5817
      bt_portal_type_roles_list = list(self.getTemplatePortalTypeRoleList())
      bt_wf_chain_list = list(self.getTemplatePortalTypeWorkflowChainList())
5818

5819
      for id in bt_portal_types_id_list:
5820 5821
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5822
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5823
        if portal_type.getRoleInformationList():
5824 5825
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5826

5827 5828 5829 5830
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5831
        action_list = []
5832 5833 5834 5835 5836 5837 5838
        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'):
5839
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5840 5841
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5842

5843 5844 5845 5846
        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)
5847

5848
        for h_id in hidden_content_type_list:
5849 5850 5851
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5852

5853 5854 5855 5856
        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)
5857

5858 5859 5860 5861
        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)
5862

5863 5864 5865 5866
        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)
5867

5868
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5869
                                    if chain != '(Default)']:
5870 5871 5872
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5873

5874 5875 5876 5877
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5878
      bt_action_list.sort()
5879
      bt_wf_chain_list.sort()
5880

5881 5882 5883 5884 5885 5886 5887
      self.setTemplatePortalTypeWorkflowChainList(bt_wf_chain_list)
      self.setTemplatePortalTypeRoleList(bt_portal_type_roles_list)
      self.setTemplatePortalTypeAllowedContentTypeList(bt_allowed_content_type_list)
      self.setTemplatePortalTypeHiddenContentTypeList(bt_hidden_content_type_list)
      self.setTemplatePortalTypePropertySheetList(bt_property_sheet_list)
      self.setTemplatePortalTypeBaseCategoryList(bt_base_category_list)
      self.setTemplateActionPathList(bt_action_list)
5888 5889 5890 5891 5892 5893 5894 5895


    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:
5896 5897
        raise TemplateConditionError, 'No module defined in business template'

5898 5899 5900 5901 5902 5903 5904 5905
      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:
5906
          return type_list
5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920

        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():
5921
            type_list.update(getChildPortalType(hidden_ptype_id))
5922
        return type_list
5923

5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970
      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

5971 5972 5973
    security.declareProtected(Permissions.ManagePortal,
                              'migrateSourceCodeFromFilesystem')
    def migrateSourceCodeFromFilesystem(self,
5974
                                        component_portal_type_dict,
5975 5976
                                        erase_existing=False,
                                        **kw):
5977 5978 5979 5980 5981
      """
      Migrate the given components from filesystem to ZODB by calling the
      appropriate importFromFilesystem according to the destination Portal
      Type and then update the Business Template property with migrated IDs
      """
5982 5983 5984
      if not component_portal_type_dict:
        return {}

5985 5986
      component_tool = self.getPortalObject().portal_components
      failed_import_dict = {}
5987 5988 5989 5990 5991
      def migrate(component_dict, component_class, template_id_list_method):
        migrated_id_list = []
        for reference, version in component_dict.iteritems():
          try:
            obj = component_class.importFromFilesystem(component_tool,
5992
                                                       reference,
5993
                                                       version,
5994
                                                       erase_existing)
5995 5996 5997 5998
          except Exception, e:
            failed_import_dict[reference] = str(e)
          else:
            migrated_id_list.append(obj.getId())
5999

6000 6001
        if migrated_id_list:
          template_id_list_method(migrated_id_list)
6002

6003 6004 6005 6006
      component_dict = component_portal_type_dict.get('Document Component')
      if component_dict:
        from Products.ERP5Type.Core.DocumentComponent import DocumentComponent
        migrate(component_dict, DocumentComponent, self.setTemplateDocumentIdList)
6007

6008 6009 6010 6011
      component_dict = component_portal_type_dict.get('Extension Component')
      if component_dict:
        from Products.ERP5Type.Core.ExtensionComponent import ExtensionComponent
        migrate(component_dict, ExtensionComponent, self.setTemplateExtensionIdList)
6012

6013 6014 6015 6016
      component_dict = component_portal_type_dict.get('Test Component')
      if component_dict:
        from Products.ERP5Type.Core.TestComponent import TestComponent
        migrate(component_dict, TestComponent, self.setTemplateTestIdList)
6017

6018
      return failed_import_dict
6019

6020 6021
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
6022
for key in item_name_list:
6023
  setattr(BusinessTemplate, key, None)
6024 6025
# Check naming convention of items.
assert item_set.issubset(globals()), item_set.difference(globals())