BusinessTemplate.py 237 KB
Newer Older
Nicolas Delaby's avatar
Nicolas Delaby committed
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3 4
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
5
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

30
import fnmatch, gc, glob, imp, os, re, shutil, sys, time, tarfile
31
from Shared.DC.ZRDB import Aqueduct
32
from Shared.DC.ZRDB.Connection import Connection as RDBConnection
33
from Products.ERP5Type.DiffUtils import DiffFile
34
from Products.ERP5Type.Globals import Persistent, PersistentMapping
35
from Acquisition import Implicit, aq_base, aq_inner, aq_parent
36
from AccessControl import ClassSecurityInfo, Unauthorized, getSecurityManager
37
from AccessControl.SecurityInfo import ModuleSecurityInfo
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38
from Products.CMFCore.utils import getToolByName
39
from Products.PythonScripts.PythonScript import PythonScript
40
from Products.ERP5Type.Accessor.Constant import PropertyGetter as ConstantGetter
41
from Products.ERP5Type.Cache import transactional_cached
Nicolas Dumazet's avatar
Nicolas Dumazet committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
from Products.ERP5Type.Utils import readLocalDocument, \
                                    writeLocalDocument, \
                                    importLocalDocument, \
                                    removeLocalDocument
from Products.ERP5Type.Utils import readLocalPropertySheet, \
                                    writeLocalPropertySheet, \
                                    importLocalPropertySheet, \
                                    removeLocalPropertySheet
from Products.ERP5Type.Utils import readLocalConstraint, \
                                    writeLocalConstraint, \
                                    importLocalConstraint, \
                                    removeLocalConstraint
from Products.ERP5Type.Utils import readLocalExtension, \
                                    writeLocalExtension, \
                                    removeLocalExtension
from Products.ERP5Type.Utils import readLocalTest, \
                                    writeLocalTest, \
                                    removeLocalTest
60
from Products.ERP5Type.Utils import convertToUpperCase
61
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
62
from Products.ERP5Type.XMLObject import XMLObject
63
from Products.ERP5Type.dynamic.portal_type_class import synchronizeDynamicModules
64
from Products.ERP5Type.Core.PropertySheet import PropertySheet as PropertySheetDocument
Aurel's avatar
Aurel committed
65
from OFS.Traversable import NotFound
66
from OFS import SimpleItem, XMLExportImport
67
from cStringIO import StringIO
Aurel's avatar
Aurel committed
68
from copy import deepcopy
69
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
70
import OFS.XMLExportImport
71
from Products.ERP5Type.patches.ppml import importXML
Aurel's avatar
Aurel committed
72
customImporters={
73
    XMLExportImport.magic: importXML,
Aurel's avatar
Aurel committed
74
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
75

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

87 88 89 90 91 92
import threading

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

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

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

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

115 116 117 118 119 120
def _getCatalog(acquisition_context):
  """
    Return the id of the SQLCatalog which correspond to the current BT.
  """
  catalog_method_id_list = acquisition_context.getTemplateCatalogMethodIdList()
  if len(catalog_method_id_list) == 0:
121 122 123 124
    try:
      return acquisition_context.getPortalObject().portal_catalog.objectIds('SQLCatalog')[0]
    except IndexError:
      return None
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
  catalog_method_id = catalog_method_id_list[0]
  return catalog_method_id.split('/')[0]

def _getCatalogValue(acquisition_context):
  """
    Returns the catalog object which correspond to the ZSQLMethods
    stored/to store in the business template.

    NB: acquisition_context must make possible to reach portal object
        and getTemplateCatalogMethodIdList.
  """
  catalog_id = _getCatalog(acquisition_context)
  if catalog_id is None:
    return None
  try:
    return acquisition_context.getPortalObject().portal_catalog[catalog_id]
  except KeyError:
    return None

144 145 146 147 148
def _recursiveRemoveUid(obj):
  """Recusivly set uid to None, to prevent (un)indexing.
  This is used to prevent unindexing real objects when we delete subobjects on
  a copy of this object.
  """
149
  if getattr(aq_base(obj), 'uid', _MARKER) is not _MARKER:
150
    obj.uid = None
151 152 153
  for subobj in obj.objectValues():
    _recursiveRemoveUid(subobj)

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

159 160 161 162 163 164 165
def getChainByType(context):
  """
  This is used in order to construct the full list
  of mapping between type and list of workflow associated
  This is only useful in order to use
  portal_workflow.manage_changeWorkflows
  """
166
  pw = context.getPortalObject().portal_workflow
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
  cbt = pw._chains_by_type
  ti = pw._listTypeInfo()
  types_info = []
  for t in ti:
    id = t.getId()
    title = t.Title()
    if title == id:
      title = None
    if cbt is not None and cbt.has_key(id):
      chain = ', '.join(cbt[id])
    else:
      chain = '(Default)'
    types_info.append({'id': id,
                      'title': title,
                      'chain': chain})
  new_dict = {}
  for item in types_info:
    new_dict['chain_%s' % item['id']] = item['chain']
  default_chain=', '.join(pw._default_chain)
  return (default_chain, new_dict)

188 189 190 191 192 193 194 195 196 197 198 199 200 201
def fixZSQLMethod(portal, method):
  """Make sure the ZSQLMethod uses a valid connection.
  """
  if not isinstance(getattr(portal, method.connection_id, None),
                      RDBConnection):
    # if not valid, we assign to the first valid connection found
    sql_connection_list = portal.objectIds(
                          spec=('Z MySQL Database Connection',))
    if (method.connection_id not in sql_connection_list) and \
       (len(sql_connection_list) != 0):
      LOG('BusinessTemplate', WARNING,
          'connection_id for Z SQL Method %s is invalid, using %s' % (
                    method.getId(), sql_connection_list[0]))
      method.connection_id = sql_connection_list[0]
202 203 204
  # recompile the method
  method._arg = Aqueduct.parse(method.arguments_src)
  method.template = method.template_class(method.src)
205

206 207
def registerSkinFolder(skin_tool, skin_folder):
  request = skin_tool.REQUEST
208 209 210
  # XXX: Getting parameter from request instead of dialog is bad
  # XXX: This is even non consistent with rest of parameters selected by user
  #      (like update_translation or update_catalog)
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
  register_skin_selection = request.get('your_register_skin_selection', 1)
  reorder_skin_selection = request.get('your_reorder_skin_selection', 1)
  skin_layer_list = request.get('your_skin_layer_list', 
                                skin_tool.getSkinSelections()) 

  skin_folder_id = skin_folder.getId()

  try:
    skin_selection_list = skin_folder.getProperty(
                 'business_template_registered_skin_selections', 
                 skin_tool.getSkinSelections()
                 )
  except AttributeError:
    skin_selection_list = skin_tool.getSkinSelections()

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

229 230 231 232 233 234 235
  def skin_sort_key(skin_folder_id):
    obj = skin_tool._getOb(skin_folder_id, None)
    if obj is None:
      return 0, skin_folder_id
    return -obj.getProperty('business_template_skin_layer_priority',
      obj.meta_type == 'Filesystem Directory View' and -1 or 0), skin_folder_id

236 237 238 239 240 241 242 243 244
  for skin_name in skin_selection_list:

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

    selection = skin_tool.getSkinPath(skin_name) or ''
245
    selection_list = selection.split(',')
246
    if (skin_folder_id not in selection_list):
247
      selection_list.insert(0, skin_folder_id)
248
    if reorder_skin_selection:
249 250
      # Sort by skin priority and ID
      selection_list.sort(key=skin_sort_key)
251
    if (skin_name in skin_layer_list):
252 253 254 255 256 257 258 259 260 261
      skin_tool.manage_skinLayers(skinpath=selection_list,
                                  skinname=skin_name, add_skin=1)
      skin_tool.getPortalObject().changeSkin(None)

def createSkinSelection(skin_tool, skin_name):
  # This skin selection does not exist, so we create a new one.
  # We'll initialize it with all skin folders, unless:
  #  - they explictly define a list of
  #    "business_template_registered_skin_selections", and we
  #    are not in this list.
Arnaud Fontaine's avatar
Arnaud Fontaine committed
262
  #  - they are not registered in the default skin selection
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
  skin_path = ''
  for skin_folder in skin_tool.objectValues():
    if skin_name in skin_folder.getProperty(
             'business_template_registered_skin_selections',
             (skin_name, )):
      if skin_folder.getId() in \
          skin_tool.getSkinPath(skin_tool.getDefaultSkin()):
        if skin_path:
          skin_path = '%s,%s' % (skin_path, skin_folder.getId())
        else:
          skin_path= skin_folder.getId()
  # add newly created skins to list of skins we care for 
  skin_tool.addSkinSelection(skin_name, skin_path)
  skin_tool.getPortalObject().changeSkin(None)

def deleteSkinSelection(skin_tool, skin_name):
  # Do not delete default skin
  if skin_tool.getDefaultSkin() != skin_name:
    for skin_folder in skin_tool.objectValues():
      try:
283 284
        if skin_name in skin_folder.getProperty(
               'business_template_registered_skin_selections', ()):
285 286 287
          break
      except AttributeError:
        pass
288 289
    else:
      skin_tool.manage_skinLayers(chosen=[skin_name], del_skin=1)
290 291
      skin_tool.getPortalObject().changeSkin(None)

292
def unregisterSkinFolderId(skin_tool, skin_folder_id, skin_selection_list):
293 294 295 296 297 298 299 300 301 302
  for skin_selection in skin_selection_list:
    selection = skin_tool.getSkinPath(skin_selection)
    selection = selection.split(',')
    if (skin_folder_id in selection):
      selection.remove(skin_folder_id)
      skin_tool.manage_skinLayers(skinpath=tuple(selection),
                                  skinname=skin_selection, add_skin=1)
      deleteSkinSelection(skin_tool, skin_selection)
      skin_tool.getPortalObject().changeSkin(None)

Aurel's avatar
Aurel committed
303 304 305
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
306
  """
307
  def _initCreation(self, path, **kw):
308
    self.path = path
Aurel's avatar
Aurel committed
309 310 311 312 313 314 315

  def __init__(self, creation=0, importing=0, file=None, path=None, **kw):
    if creation:
      self._initCreation(path=path, **kw)
    elif importing:
      self._initImport(file=file, path=path, **kw)

316
  def addObject(self, obj, name, path=None, ext='.xml'):
317 318 319 320 321 322
    if path:
      name = posixpath.join(path, name)
    # XXX required due to overuse of os.path
    name = name.replace('\\', '/').replace(':', '/')
    name = quote(name + ext)
    path = name.replace('/', os.sep)
323
    try:
324 325 326 327 328 329 330 331 332 333
      write = self._writeFile
    except AttributeError:
      if not isinstance(obj, str):
        obj.seek(0)
        obj = obj.read()
      self._writeString(obj, path)
    else:
      if isinstance(obj, str):
        obj = StringIO(obj)
      write(obj, path)
334

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

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
340
    Class archiving business template into a folder tree
341
  """
342 343 344 345 346 347 348 349 350 351 352 353
  def _writeString(self, obj, path):
    object_path = os.path.join(self.path, path)
    path = os.path.dirname(object_path)
    os.path.exists(path) or os.makedirs(path)
    f = open(object_path, 'wb')
    try:
      f.write(obj)
    finally:
      f.close()

  def _initImport(self, file, path, **kw):
    root_path_len = len(os.path.normpath(os.path.join(path, '_'))) - 1
354 355 356 357 358 359 360
    self.root_path_len = root_path_len
    d = {}
    for f in file:
      f = os.path.normpath(f)
      klass = f[root_path_len:].split(os.sep, 1)[0]
      d.setdefault(klass, []).append(f)
    self.file_list_dict = d
Aurel's avatar
Aurel committed
361

362
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
363 364 365
    """
      Import file from a local folder
    """
366
    class_name = item.__class__.__name__
367 368
    root_path_len = self.root_path_len
    prefix_len = root_path_len + len(class_name) + len(os.sep)
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    if CACHE_DATABASE_PATH:
      try:
        cache_database.db = gdbm.open(CACHE_DATABASE_PATH, 'cf')
      except gdbm.error:
        cache_database.db = gdbm.open(CACHE_DATABASE_PATH, 'nf')
    try:
      for file_path in self.file_list_dict.get(class_name, ()):
        if os.path.isfile(file_path):
          file = open(file_path, 'rb')
          try:
            file_name = file_path[prefix_len:]
            if '%' in file_name:
              file_name = unquote(file_name)
            item._importFile(file_name, file)
          finally:
            file.close()
    finally:
      if hasattr(cache_database, 'db'):
        cache_database.db.close()
        del cache_database.db
389

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

395 396
  def _initCreation(self, **kw):
    BusinessTemplateArchive._initCreation(self, **kw)
Aurel's avatar
Aurel committed
397 398 399
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)
400 401 402 403 404 405 406 407 408 409 410 411 412
    self.time = time.time()

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

  def finishCreation(self):
Aurel's avatar
Aurel committed
413 414 415
    self.tar.close()
    return self.fobj

416
  def _initImport(self, file, **kw):
417 418 419 420 421 422 423 424 425 426 427 428
    self.tar = tarfile.TarFile(fileobj=StringIO(GzipFile(fileobj=file).read()))
    self.item_dict = {}
    setdefault = self.item_dict.setdefault
    for info in self.tar.getmembers():
      if info.isreg():
        path = info.name.split('/')
        if path[0] == '.':
          del path[0]
        file_name = '/'.join(path[2:])
        if '%' in file_name:
          file_name = unquote(file_name)
        setdefault(path[1], []).append((file_name, info))
Aurel's avatar
Aurel committed
429

430
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
431 432
    """
      Import all file from the archive to the site
433
    """
434 435 436
    extractfile = self.tar.extractfile
    for file_name, info in self.item_dict.get(item.__class__.__name__, ()):
      item._importFile(file_name, extractfile(info))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
437

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

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

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

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

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

463
  def preinstall(self, context, installed_item, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
464 465
    """
      Build a list of added/removed/changed files between the BusinessTemplate
466
      being installed (self) and the installed one (installed_item).
Vincent Pelletier's avatar
Vincent Pelletier committed
467 468 469 470 471
      Note : we compare files between BTs, *not* between the installed BT and
      the objects in the DataFS.

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

  def install(self, context, trashbin, **kw):
493
    pass
494 495 496

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

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

525

526 527 528 529
  def trash(self, context, new_item, **kw):
    # trash is quite similar to uninstall.
    return self.uninstall(context, new_item=new_item, trash=1, **kw)

Aurel's avatar
Aurel committed
530
  def export(self, context, bta, **kw):
531
    pass
Aurel's avatar
Aurel committed
532

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

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

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

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

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

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

576 577 578 579 580 581 582 583 584
  def getTemplateTypeName(self):
    """
     Get a meaningfull class Name without 'TemplateItem'. Used to 
     present to the user.

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

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

593 594
  def unrestrictedResolveValue(self, context=None, path='', default=_MARKER,
                               restricted=0):
595 596 597 598 599 600 601 602 603 604 605
    """
      Get the value without checking the security.
      This method does not acquire the parent.
    """
    if isinstance(path, basestring):
      stack = path.split('/')
    else:
      stack = list(path)
    stack.reverse()
    if stack:
      if context is None:
606
        portal = aq_inner(self.getPortalObject())
607 608 609 610
        container = portal
      else:
        container = context

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

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

625 626 627 628 629 630 631 632 633 634 635 636
        if restricted:
          try:
            if not validate(container, container, key, value):
              raise Unauthorized('unauthorized access to element %s' % key)
          except Unauthorized:
            LOG('BusinessTemplate', WARNING,
                'access to %s is forbidden' % (path,))
          if default is _MARKER:
            raise
          return default

        container = value
637

638 639 640
      return value
    else:
      return context
641

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

647 648 649 650
  def __init__(self, id_list, tool_id=None, **kw):
    BaseTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
    if tool_id is not None:
      id_list = self._archive.keys()
651
      self._archive.clear()
652 653 654
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
655

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

Aurel's avatar
Aurel committed
670
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
671
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
672 673
    p = context.getPortalObject()
    for id in id_list:
674
      relative_url = '/'.join([url,id])
675 676
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
677 678
      keep_workflow_history = self.isKeepWorkflowObject(relative_url)
      obj = self.removeProperties(obj, 1, keep_workflow_history)
Vincent Pelletier's avatar
Vincent Pelletier committed
679 680 681
      id_list = obj.objectIds() # FIXME duplicated variable name
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
682
        groups = deepcopy(obj.groups)
683
      if id_list:
Aurel's avatar
Aurel committed
684
        self.build_sub_objects(context, id_list, relative_url)
685
        for id_ in list(id_list):
686
          obj._delObject(id_)
687
      if hasattr(aq_base(obj), 'groups'):
688 689 690
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
691

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

720
  def _compileXML(self, file):
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
    # This method converts XML to ZEXP. Because the conversion
    # is quite heavy, a persistent cache database is used to
    # store ZEXP, so the second run wouldn't have to re-generate
    # identical data again.
    #
    # For now, a pair of the path to an XML file and its modification time
    # are used as a unique key. In theory, a checksum of the content could
    # be used instead, and it could be more reliable, as modification time
    # might not be updated in some insane filesystems correctly. However,
    # in practice, checksums consume a lot of CPU time, so when the cache
    # does not hit, the increased overhead is significant. In addition, it
    # does rarely happen that two XML files in Business Templates contain
    # the same data, so it may not be expected to have more cache hits
    # with this approach.
    #
    # The disadvantage is that this wouldn't work with the archive format,
    # because each entry in an archive does not have a mtime in itself.
    # However, the plan is to have an archive to retain ZEXP directly
    # instead of XML, so the idea of caching would be completely useless
    # with the archive format.
    name = file.name
    mtime = os.path.getmtime(file.name)
    key = '%s:%s' % (name, mtime)

    try:
      return StringIO(cache_database.db[key])
    except:
      pass

    #LOG('Business Template', 0, 'Compiling %s...' % (name,))
    from Shared.DC.xml import ppml
    from OFS.XMLExportImport import start_zopedata, save_record, save_zopedata
    import xml.parsers.expat
    outfile=StringIO()
    try:
      data=file.read()
      F=ppml.xmlPickler()
      F.end_handlers['record'] = save_record
      F.end_handlers['ZopeData'] = save_zopedata
      F.start_handlers['ZopeData'] = start_zopedata
      F.binary=1
      F.file=outfile
      p=xml.parsers.expat.ParserCreate('utf-8')
      p.returns_unicode = False
      p.CharacterDataHandler=F.handle_data
      p.StartElementHandler=F.unknown_starttag
      p.EndElementHandler=F.unknown_endtag
768
      p.Parse(data)
769 770 771 772 773 774 775 776 777 778 779

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

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

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

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

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

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

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

873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
  def beforeInstall(self):
    """
      Installation hook.
      Called right at the begining of "install" method.
      Can be overridden by subclasses.
    """
    pass

  def afterInstall(self):
    """
      Installation hook.
      Called right before returning in "install" method.
      Can be overridden by subclasses.
    """
    pass

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

899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
  def setSafeReindexationMode(self, context):
    """
      Postpone indexations after unindexations.
      This avoids alarming error messages about a single uid being used
      by "deleted" path and reindexed object. This can happen here for
      objects on which the uid was restored: previous object was deleted,
      hence the "deleted" path, and new object does have the same uid.
    """
    original_reindex_parameters = context.getPlacelessDefaultReindexParameters()
    if original_reindex_parameters is None:
      original_reindex_parameters = {}
    activate_kw = original_reindex_parameters.get('activate_kw', {}).copy()
    activate_kw['after_method_id'] = 'unindexObject'
    context.setPlacelessDefaultReindexParameters(activate_kw=activate_kw, \
                                                 **original_reindex_parameters)
    return original_reindex_parameters

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

922
  def install(self, context, trashbin, **kw):
923
    self.beforeInstall()
924 925
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
926
    if context.getTemplateFormatVersion() == 1:
927 928 929 930 931 932
      def recurse(hook, document, prefix=''):
        my_prefix = '%s/%s' % (prefix, document.id)
        if (hook(document, my_prefix)):
          for subdocument in document.objectValues():
            recurse(hook, subdocument, my_prefix)
      def saveHook(document, prefix):
933
        uid = getattr(aq_base(document), 'uid', None)
934 935 936 937 938 939 940 941 942 943 944 945
        if uid is None:
          return 0
        else:
          saved_uid_dict[prefix] = uid
          return 1
      def restoreHook(document, prefix):
        uid = saved_uid_dict.get(prefix)
        if uid is None:
          return 0
        else:
          document.uid = uid
          return 1
946
      groups = {}
947
      old_groups = {}
948
      portal = context.getPortalObject()
949 950
      # set safe activities execution order
      original_reindex_parameters = self.setSafeReindexationMode(context)
951 952
      object_key_list = self._getObjectKeyList()
      for path in object_key_list:
953 954 955 956 957
        # We do not need to perform any backup because the object was
        # created during the Business Template installation
        if update_dict.get(path) == 'migrate':
          continue

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

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

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

1050 1051
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
1052
          self.REQUEST.set('is_business_template_installation', 1)
1053 1054 1055 1056
          # We set isIndexable to 0 before calling
          # manage_afterClone in order to not call recursiveReindex, this is
          # useless because we will already reindex every created object, so
          # we avoid duplication of reindexation
1057
          obj.isIndexable = ConstantGetter('isIndexable', value=False)
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
          # START:part of ERP5Type.CopySupport.manage_afterClone
          # * reset uid
          # * reset owner
          # * do not reset workflow
          # * do not call recursively
          # * do not call type-based afterClone script
          #
          # Change uid attribute so that Catalog thinks object was not yet catalogued
          aq_base(obj).uid = portal.portal_catalog.newUid()
          # Give the Owner local role to the current user, zope only does this if no
          # local role has been defined on the object, which breaks ERP5Security
          if getattr(aq_base(obj), '__ac_local_roles__', None) is not None:
            user=getSecurityManager().getUser()
            if user is not None:
              userid=user.getId()
              if userid is not None:
                #remove previous owners
                local_role_dict = obj.__ac_local_roles__
                removable_role_key_list = []
                for key, value in local_role_dict.items():
                  if 'Owner' in value:
                    value.remove('Owner')
                  if len(value) == 0:
                    removable_role_key_list.append(key)
                # there is no need to keep emptied keys after cloning, it makes
                # unstable local roles -- if object is cloned it can be different when
                # after being just added
                for key in removable_role_key_list:
                  local_role_dict.pop(key)
                #add new owner
                l=local_role_dict.setdefault(userid, [])
                l.append('Owner')
          # END:part of ERP5Type.CopySupport.manage_afterClone
1091 1092 1093
          del obj.isIndexable
          if getattr(aq_base(obj), 'reindexObject', None) is not None:
            obj.reindexObject()
1094
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
1095
          if portal_type_dict:
1096
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
1097
            wf_chain = portal_type_dict.pop('workflow_chain')
1098 1099
            chain_dict = getChainByType(context)[1]
            default_chain = ''
1100
            chain_dict['chain_%s' % (object_id)] = wf_chain
1101
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
1102 1103
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
1104
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
1105
          if subobjects_dict:
1106
            # get a jar
1107
            connection = self.getConnection(obj)
1108
            # import subobjects
1109
            for subobject_id, subobject_data in subobjects_dict.iteritems():
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
              try:
                if obj._getOb(subobject_id, None) is None:
                  subobject_data.seek(0)
                  subobject = connection.importFile(subobject_data)
                  obj._setObject(subobject_id, subobject)
              except AttributeError:
                # XXX this may happen when an object which can contain
                # sub-objects (e.g. ERP5 Form) has been replaced with
                # an object which cannot (e.g. External Method).
                LOG('BusinessTemplate', WARNING,
                    'could not restore %r in %r' % (subobject_id, obj))
1121
          if obj.meta_type in ('Z SQL Method',):
1122
            fixZSQLMethod(portal, obj)
1123 1124 1125
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
1126 1127 1128
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
1129
          elif obj.meta_type in ('ERP5 Ram Cache',
1130
                                 'ERP5 Distributed Ram Cache',):
1131 1132
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
1133 1134
          elif (container.meta_type == 'CMF Skins Tool') and \
              (old_obj is not None):
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
            # Keep compatibility with previous export format of
            # business_template_registered_skin_selections
            # and do not modify exported value
            if obj.getProperty('business_template_registered_skin_selections', 
                               None) is None:
              # Keep previous value of register skin selection for skin folder
              skin_selection_list = old_obj.getProperty(
                  'business_template_registered_skin_selections', None)
              if skin_selection_list is not None:
                if isinstance(skin_selection_list, basestring):
                  skin_selection_list = skin_selection_list.split(' ')
                obj._setProperty(
                    'business_template_registered_skin_selections',
                    skin_selection_list, type='tokens')
1149 1150 1151 1152 1153 1154 1155 1156
          # in case the portal ids, we want keep the property dict
          elif interfaces.IIdGenerator.providedBy(obj) and \
            old_obj is not None:
            for dict_name in ('last_max_id_dict', 'last_id_dict'):
              # Keep previous last id dict
              if getattr(old_obj, dict_name, None) is not None:
                old_dict = getattr(old_obj, dict_name, None)
                setattr(obj, dict_name, old_dict)
1157

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

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

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

1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
class PathTemplateItem(ObjectTemplateItem):
  """
    This class is used to store objects with wildcards supported.
  """
  def __init__(self, id_list, tool_id=None, **kw):
    BaseTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
    id_list = self._archive.keys()
    self._archive.clear()
    self._path_archive = PersistentMapping()
    for id in id_list:
      self._path_archive[id] = None

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

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

1352 1353 1354 1355 1356 1357 1358 1359 1360
      The folder is the current object which contains sub-objects.
      The list of ids are path components. If the list is empty,
      the current folder is valid.
    """
    if len(id_list) == 0:
      return ['/'.join(relative_url_list)]
    id = id_list[0]
    if re.search('[\*\?\[\]]', id) is None:
      # If the id has no meta character, do not have to check all objects.
1361 1362 1363
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1364
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1365 1366
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1367
      if object_id != "":
1368
        path_list.extend(self._resolvePath(
1369
            folder._getOb(object_id),
1370
            relative_url_list + [object_id], id_list[1:]))
1371
    return path_list
Aurel's avatar
Aurel committed
1372

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1403 1404 1405 1406 1407 1408 1409 1410
class ToolTemplateItem(PathTemplateItem):
  """This class is used only for making a distinction between other objects
  and tools, because tools may not be backed up."""
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
    """Fake as if a trashbin is not available."""
    return PathTemplateItem._backupObject(self, action, None, container_path,
                                          object_id, **kw)

1411
  def install(self, context, trashbin, **kw):
1412
    """ When we install a tool that is a type provider not
1413
    registered on types tool, register it into the type provider.
1414
    """
1415 1416 1417 1418
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    for type_container_id, obj in self._objects.iteritems():
1419 1420 1421
      if (interfaces.ITypeProvider.providedBy(obj) and
          type_container_id != types_tool.id and
          type_container_id not in types_tool.type_provider_list):
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
        types_tool.type_provider_list = tuple(types_tool.type_provider_list) + \
                                        (type_container_id,)

  def uninstall(self, context, **kw):
    """ When we uninstall a tool, unregister it from the type provider. """
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._path_archive.keys()
    for tool_id in object_keys:
      types_tool.type_provider_list = tuple([ \
        x for x in types_tool.type_provider_list \
        if x != tool_id])
    PathTemplateItem.uninstall(self, context, **kw)

  def remove(self, context, **kw):
    """ When we remove a tool, unregister it from the type provider. """
    portal = context.getPortalObject()
1443
    types_tool = portal.portal_types
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    for tool_id in keys:
      if remove_dict.has_key(tool_id):
        action = remove_dict[tool_id]
        if 'remove' in action:
          types_tool.type_provider_list = tuple([ \
            x for x in types_tool.type_provider_list \
            if x != tool_id])
    PathTemplateItem.remove(self, context, **kw)
1454

1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
class PreferenceTemplateItem(PathTemplateItem):
  """
  This class is used to store preference objects
  """
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
    This method calls itself recursively.

    The folder is the current object which contains sub-objects.
    The list of ids are path components. If the list is empty,
    the current folder is valid.
    """
    if relative_url_list != []:
      LOG("PreferenceTemplateItem, _resolvePath", WARNING,
          "Should be empty")
1470
    if len(id_list) != 1:
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
      LOG("PreferenceTemplateItem, _resolvePath", WARNING,
          "Should contain only one element")
    # XXX hardcoded
    return ['portal_preferences/%s' % id_list[0]]

  def install(self, context, trashbin, **kw):
    """
    Enable Preference
    """
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    for object_path in self._objects.keys():
1483
      pref = portal.unrestrictedTraverse(object_path)
1484
      # XXX getPreferenceState is a bad name
1485
      if pref.getPreferenceState() == 'disabled':
1486 1487
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1488 1489
        portal.portal_workflow.doActionFor(
                      pref,
1490 1491 1492
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1493 1494
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1495

1496 1497
class CategoryTemplateItem(ObjectTemplateItem):

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

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

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1521 1522 1523 1524 1525 1526 1527 1528
      try:
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
      except (KeyError, AttributeError):
        if self.is_bt_for_diff:
          continue
        else:
          raise ValueError, "%s not found" % relative_url
1529
      _recursiveRemoveUid(obj)
1530 1531
      keep_workflow_history = self.isKeepWorkflowObject(relative_url)
      obj = self.removeProperties(obj, 1, keep_workflow_history)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1532
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1533
      id_list = obj.objectIds()
1534 1535
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1536
        for id_ in list(id_list):
1537
          obj._delObject(id_)
1538
      else:
1539
        for id_ in list(id_list):
1540
          obj._delObject(id_)
1541 1542
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1543

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

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

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

1555 1556
class SkinTemplateItem(ObjectTemplateItem):

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

1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
    for relative_url in self._objects.keys():
      obj = self._objects[relative_url]
      if (getattr(obj, 'meta_type', None) == 'Folder') and \
        (obj.getProperty('business_template_registered_skin_selections', None) \
            is not None):
          obj._delProperty(
              'business_template_registered_skin_selections')

1570 1571
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584
    # We must install/update an ERP5 Form if one of its widget is modified.
    # This allow to keep the widget order and the form layout after an update
    #   from a BT to another one.
    for (bt_obj_path, bt_obj) in self._objects.items():
      if getattr(bt_obj, 'meta_type', None) == 'ERP5 Form':
        # search sub-objects of ERP5 Forms that are marked as "modified"
        for upd_obj_path in modified_object_list.keys():
          if upd_obj_path.startswith(bt_obj_path):
            # a child of the ERP5 Form must be updated, so the form too
            if not modified_object_list.has_key(bt_obj_path):
              modified_object_list.update({bt_obj_path: ['Modified', self.__class__.__name__[:-12]]})
    return modified_object_list

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

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

  def build(self, context, **kw):
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

    for key in self._archive.keys():
      skin_folder_id, skin_selection_id = key.split(' | ')

      skin_folder = skin_tool[skin_folder_id]
      selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections',
          [])
1625 1626 1627
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1628
      if skin_selection_id in selection_list:
1629
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1630
      else:
1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
        raise NotFound, 'No skin selection %s found for skin folder %s.' \
                          % (skin_selection_id, skin_folder_id)

  # Function to generate XML Code Manually
  def generateXml(self, path=None):
    xml_data = '<registered_skin_selection>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
      skin_selection_list = self._objects[key]
      xml_data += '\n <skin_folder_selection>'
      xml_data += '\n  <skin_folder>%s</skin_folder>' % key
      xml_data += '\n  <skin_selection>%s</skin_selection>' \
                      % ','.join(skin_selection_list)
      xml_data += '\n </skin_folder_selection>'
    xml_data += '\n</registered_skin_selection>'
    return xml_data

  def export(self, context, bta, **kw):
1650
    if not self._objects:
1651 1652
      return
    # export workflow chain
1653 1654 1655
    bta.addObject(self.generateXml(),
                  name='registered_skin_selection',
                  path=self.__class__.__name__)
1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

    for skin_folder_id in self._objects.keys():

      if update_dict.has_key(skin_folder_id) or force:
        if not force:
          action = update_dict[skin_folder_id]
          if action == 'nothing':
            continue
        skin_folder = skin_tool[skin_folder_id]
1671 1672 1673
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1674

1675
        if selection_list is default_value:
1676
          create_property = True
1677
          selection_list = self._objects[skin_folder_id]
1678
        else:
1679
          create_property = False
1680 1681 1682 1683 1684
          if isinstance(selection_list, basestring):
            selection_list = selection_list.replace(',', ' ').split(' ')
          elif isinstance(selection_list, tuple):
            selection_list = list(selection_list)
          selection_list.extend(self._objects[skin_folder_id])
1685 1686

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

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

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

1729
  def preinstall(self, context, installed_item, **kw):
1730 1731 1732 1733
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
1734
        if installed_item._objects.has_key(path):
1735 1736
          # compare object to see it there is changes
          new_object = self._objects[path]
1737
          old_object = installed_item._objects[path]
1738 1739 1740 1741 1742
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
1743
      old_keys = installed_item._objects.keys()
1744 1745 1746 1747 1748 1749 1750
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def _importFile(self, file_name, file):
    if not file_name.endswith('.xml'):
1751
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1752 1753 1754 1755
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
1756 1757 1758
    for skin_folder_selection in xml.getroot():
      skin_folder_id = skin_folder_selection.find('skin_folder').text
      selection_string = skin_folder_selection.find('skin_selection').text
1759 1760
      if not selection_string:
        selection_list = []
1761
      else:
1762 1763
        selection_list = selection_string.split(',')
      skin_selection_dict[skin_folder_id] = selection_list
1764
    self._objects = skin_selection_dict
1765

1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875
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):
    if context.getTemplateFormatVersion() != 1:
      return {}

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

1877
class WorkflowTemplateItem(ObjectTemplateItem):
1878

1879 1880
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1881

1882 1883 1884 1885 1886
  # 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.

1887
  def preinstall(self, context, installed_item, installed_bt, **kw):
1888
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
1889
                                                         installed_item, **kw)
1890 1891 1892 1893
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1894
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1895 1896
      else:
        modified_workflow_dict[modified_object] = state
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918
    removed_workflow_id_list = [x[0].split('/', 1)[1] \
                                for x in modified_workflow_dict.iteritems() \
                                if x[1][0] == 'Removed']
    if len(removed_workflow_id_list) > 0:
      installed_chain_list = [[y.strip() for y in x.split('|')] for x in \
                                installed_bt.getTemplatePortalTypeWorkflowChainList()]
      new_chain_list = [[y.strip() for y in x.split('|')] for x in \
                          context.getTemplatePortalTypeWorkflowChainList()]
      chain_dict = getChainByType(context)[1]
      for workflow_id in removed_workflow_id_list:
        affected_portal_type_set = set([x[0][6:] for x in \
                                        chain_dict.iteritems() \
                                        if workflow_id in \
                                        [y.strip() for y in x[1].split(',')]])
        safe_portal_type_set = set([x[0] for x in installed_chain_list \
                                    if x[1] == workflow_id]) - \
                               set([x[0] for x in new_chain_list \
                                    if x[1] == workflow_id])
        if affected_portal_type_set - safe_portal_type_set:
          value = modified_workflow_dict['portal_workflow/%s' % workflow_id]
          modified_workflow_dict['portal_workflow/%s' % workflow_id] = \
              ('Removed but used', value[1])
1919 1920
    return modified_workflow_dict

1921
  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1922
    if context.getTemplateFormatVersion() == 1:
1923 1924 1925
      portal = context.getPortalObject()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
Julien Muchembled's avatar
Julien Muchembled committed
1926 1927 1928
      # sort to add objects before their subobjects
      for path in sorted(self._objects):
          if force:
1929
            action = 'backup'
Julien Muchembled's avatar
Julien Muchembled committed
1930
          else:
1931
            action = update_dict.get('/'.join(path.split('/')[:2]))
Julien Muchembled's avatar
Julien Muchembled committed
1932 1933
            if action in (None, 'nothing'):
              continue
1934 1935 1936
          container_path = path.split('/')[:-1]
          object_id = path.split('/')[-1]
          try:
1937
            container = self.unrestrictedResolveValue(portal, container_path)
1938 1939
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1940
            container_url = '/'.join(container_path)
1941 1942 1943 1944 1945 1946
            if update_dict.has_key(container_url):
              if update_dict[container_url] == 'nothing':
                continue
            raise
          container_ids = container.objectIds()
          if object_id in container_ids:    # Object already exists
1947
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1948
            container.manage_delObjects([object_id])
1949 1950
          obj = self._objects[path]
          obj = obj._getCopy(container)
1951
          self.removeProperties(obj, 0)
1952 1953 1954 1955
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1956 1957 1958
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)

1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973
  def uninstall(self, context, **kw):
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    removed_workflow_id_list = set([x.split('/', 1)[1] for x in object_keys])
    (default_chain, chain_dict) = getChainByType(context)
    for portal_type, workflow_ids in chain_dict.iteritems():
      workflow_ids = set([x.strip() for x in workflow_ids.split(',')]) - \
                     removed_workflow_id_list
      chain_dict[portal_type] = ', '.join(workflow_ids)
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
    ObjectTemplateItem.uninstall(self, context, **kw)
1974

1975 1976
class PortalTypeTemplateItem(ObjectTemplateItem):

1977 1978
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1979 1980
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1981 1982 1983
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1984 1985
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1986
      obj = p.unrestrictedTraverse(relative_url)
1987 1988 1989 1990
      # normalize relative_url, not all type informations are stored in
      # "portal_types"
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])

1991
      obj = obj._getCopy(context)
1992
      obj._p_activate()
1993
      for attr in obj.__dict__.keys():
1994 1995 1996 1997 1998 1999
        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',
2000 2001 2002
                                      'last_id', 'uid') or \
            (attr == 'workflow_history' and
             not self.isKeepWorkflowObject(relative_url)):
2003
          delattr(obj, attr)
2004 2005
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
2006

2007 2008 2009 2010 2011 2012 2013 2014 2015 2016
  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__
2017
        if klass.__module__ != 'erp5.portal_type':
2018 2019 2020 2021
          portal_type = obj.portal_type
        else:
          portal_type = klass.__name__
        depend = path_dict.get(portal_type)
2022 2023 2024 2025 2026 2027
        # 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
2028 2029
        cache[path] = score = depend and 1 + solveDependency(depend)[0] or 0
      return score, path
2030
    object_key_list.sort(key=solveDependency)
2031 2032
    return object_key_list

2033 2034
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
2035 2036 2037 2038
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2039 2040
    # We now need to setup the list of workflows corresponding to
    # each portal type
2041
    (default_chain, chain_dict) = getChainByType(context)
2042
    # Set the default chain to the empty string is probably the
2043
    # best solution, by default it is 'default_workflow', which is
2044
    # not very usefull
2045
    default_chain = ''
2046 2047 2048 2049
    if context.getTemplateFormatVersion() == 1:
      object_list = self._objects
    else:
      object_list = self._archive
2050
    for path in object_list.keys():
2051 2052 2053 2054
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2055
            continue
2056 2057
        obj = object_list[path]
        portal_type = obj.id
2058 2059 2060
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
2061 2062
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2063

2064 2065
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
2066 2067 2068
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
2069
      result_dict = {}
2070
      xml = parse(file)
2071
      chain_list = xml.findall('//chain')
2072
      for chain in chain_list:
2073 2074 2075 2076
        portal_type = chain.find('type').text
        workflow = chain.find('workflow').text or ''
        result_dict[portal_type] = workflow
      self._workflow_chain_archive = result_dict
2077 2078 2079
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

2080
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
2081

2082 2083 2084
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

2085
  def build(self, context, **kw):
2086 2087 2088 2089 2090
    # 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
2091
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
2092
    for key in self._archive.keys():
2093 2094 2095
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
2096
        workflow = wflist[1]
2097
      else:
2098
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
2099
        portal_type = wflist[0][:-2]
2100
        workflow = ''
2101 2102 2103 2104 2105
      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):
2106
          if not self.is_bt_for_diff:
2107 2108 2109
            # 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
2110
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
2111
                       'in chain for portal_type %s' % (workflow_name, portal_type))
2112
        self._objects.setdefault(portal_type, []).append(workflow)
2113
      elif not self.is_bt_for_diff:
2114
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
2115
                        'is probably a sign of a missing dependency.'\
2116
                                                    % portal_type
2117

Christophe Dumez's avatar
Christophe Dumez committed
2118
  # Function to generate XML Code Manually
2119 2120
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
2121 2122 2123
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2124
      workflow_list = self._objects[key]
2125 2126
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
2127 2128
      xml_data += '\n  <workflow>%s</workflow>' %(
        self._chain_string_separator.join(sorted(workflow_list)))
2129 2130
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
2131 2132 2133
    return xml_data

  def export(self, context, bta, **kw):
2134
    if not self._objects:
2135 2136 2137
      return
    # export workflow chain
    xml_data = self.generateXml()
2138 2139
    bta.addObject(xml_data, name='workflow_chain_type',
                  path=self.__class__.__name__)
2140 2141 2142 2143

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2144 2145 2146 2147 2148 2149
    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 = []
2150 2151
    # We now need to setup the list of workflows corresponding to
    # each portal type
2152
    (default_chain, chain_dict) = getChainByType(context)
2153
    # First convert all workflow_ids into list.
2154 2155
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
2156
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
2157
    # best solution, by default it is 'default_workflow', which is
2158 2159
    # not very usefull
    default_chain = ''
2160 2161
    for path in self._objects:
      if path in update_dict or force:
2162 2163 2164
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2165
            continue
Jérome Perrin's avatar
Jérome Perrin committed
2166 2167
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
2168
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
2169
          continue
2170
        portal_type = path_splitted[-1]
2171 2172
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
2173
          # XXX we don't use the chain (Default) in erp5 so don't keep it
2174 2175 2176 2177 2178 2179
          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]
2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199
          # 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)
2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210
          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
2211
              wf_id = wf_id.lstrip('+')
2212
              old_chain_workflow_id_set.add(wf_id)
2213
            # create the new chain
2214 2215
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
2216 2217
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
2218
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
2219 2220 2221
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
2222
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
2223
        else:
2224
          if context.portal_types.getTypeInfo(portal_type) is None:
2225
            raise ValueError('Cannot chain workflow %r to non existing '
2226 2227 2228 2229 2230
                           '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.
2231 2232
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
2233 2234
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2235

2236 2237
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
2238 2239
    object_path = kw.get('object_path', None)
    if object_path is not None:
2240
      object_key_list = [object_path]
2241
    else:
2242 2243 2244
      object_key_list = self._objects.keys()
    for object_key in object_key_list:
      path_splitted = object_key.split('/', 1)
2245 2246 2247
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
2248 2249 2250 2251 2252 2253 2254 2255 2256 2257
      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]
2258
        else:
2259 2260 2261 2262
          chain_dict[path] = self._chain_string_separator.\
                                                  join(workflow_id_list)
    context.getPortalObject().portal_workflow.\
                                   manage_changeWorkflows('', props=chain_dict)
2263

2264
  def preinstall(self, context, installed_item, **kw):
2265 2266
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2267
      new_key_list = self._objects.keys()
2268 2269
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
2270
      for key, value in installed_item._objects.iteritems():
2271 2272
        if not 'portal_type_workflow_chain/' in key:
          key = 'portal_type_workflow_chain/%s' % (key)
2273
        new_dict[key] = value
2274
      if new_dict:
2275
        installed_item._objects = new_dict
2276 2277
      for path in new_key_list:
        if path in installed_item._objects:
2278 2279
          # compare object to see it there is changes
          new_object = self._objects[path]
2280
          old_object = installed_item._objects[path]
2281 2282 2283 2284 2285 2286
          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()
2287
          if new_object != old_object:
2288
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2289
        else: # new object
2290
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2291
      # get removed object
2292 2293 2294
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2295 2296
    return modified_object_list

2297
  def _importFile(self, file_name, file):
2298
    if not file_name.endswith('.xml'):
2299
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2300
      return
2301
    # import workflow chain for portal_type
2302
    result_dict = {}
2303
    xml = parse(file)
2304
    chain_list = xml.findall('chain')
2305
    for chain in chain_list:
2306
      portal_type = chain.find('type').text
2307
      workflow_chain = chain.find('workflow').text or ''
2308
      if 'portal_type_workflow_chain/' not in portal_type:
2309 2310 2311 2312
        key = 'portal_type_workflow_chain/%s' % (portal_type,)
      else:
        key = portal_type
      result_dict[key] = workflow_chain.split(self._chain_string_separator)
2313
    self._objects = result_dict
2314

2315 2316
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2317

2318
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
2319 2320 2321
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
2322 2323
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
2324
  business_template_class_property = '_portal_type_allowed_content_type_item'
2325 2326

  def build(self, context, **kw):
2327
    types_tool = getToolByName(self.getPortalObject(), 'portal_types')
2328
    for key in self._archive.keys():
2329 2330 2331 2332
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
2333
      ob = types_tool.getTypeInfo(portal_type)
2334
      # check properties corresponds to what is defined in site
2335
      if ob is None:
2336
        raise ValueError, "Portal Type %r not found in site" %(portal_type,)
2337
      prop_value = getattr(ob, self.class_property, ())
2338 2339 2340 2341 2342 2343 2344
      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
2345
        raise ValueError, "%s %s not found in portal type %s" % (
2346 2347
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)
2348

Christophe Dumez's avatar
Christophe Dumez committed
2349
  # Function to generate XML Code Manually
2350 2351
  def generateXml(self, path=None):
    xml_data = '<%s>' %(self.xml_tag,)
2352 2353 2354
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2355
      id_value = key.replace('%s/' % self.class_property, '')
2356
      allowed_item_list = sorted(self._objects[key])
2357
      xml_data += '\n <portal_type id="%s">' % (id_value)
2358
      for allowed_item in allowed_item_list:
2359 2360 2361
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
2362 2363 2364
    return xml_data

  def export(self, context, bta, **kw):
2365
    if not self._objects:
2366 2367
      return
    xml_data = self.generateXml(path=None)
2368 2369
    bta.addObject(xml_data, name=self.class_property,
                  path=self.__class__.__name__)
2370

2371
  def preinstall(self, context, installed_item, **kw):
2372 2373
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2374
      new_key_list = self._objects.keys()
2375 2376
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
Nicolas Delaby's avatar
Nicolas Delaby committed
2377
      for key, value in installed_item._objects.iteritems():
2378
        if self.class_property not in key:
2379
          key = '%s/%s' % (self.class_property, key)
Nicolas Delaby's avatar
Nicolas Delaby committed
2380
        new_dict[key] = value
2381
      if new_dict:
2382
        installed_item._objects = new_dict
2383 2384
      for path in new_key_list:
        if path in installed_item._objects:
2385 2386
          # compare object to see it there is changes
          new_object = self._objects[path]
2387
          old_object = installed_item._objects[path]
2388 2389
          new_object.sort()
          old_object.sort()
2390
          if new_object != old_object:
2391
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2392
        else: # new object
2393
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2394
      # get removed object
2395 2396 2397
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2398 2399
    return modified_object_list

2400
  def _importFile(self, file_name, file):
2401
    if not file_name.endswith('.xml'):
2402
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2403
      return
2404
    path, name = posixpath.split(file_name)
2405
    xml = parse(file)
2406
    portal_type_list = xml.findall('portal_type')
2407
    for portal_type in portal_type_list:
2408 2409
      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
2410
      if self.class_property not in id:
2411 2412 2413 2414
        key = '%s/%s' % (self.class_property, id,)
      else:
        key = id
      self._objects[key] = item_type_list
2415 2416

  def install(self, context, trashbin, **kw):
Nicolas Delaby's avatar
Nicolas Delaby committed
2417 2418
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2419 2420
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2421 2422 2423 2424 2425 2426 2427
    installed_bt = kw.get('installed_bt')
    if installed_bt is not None:
      old_objects = getattr(installed_bt,
                            self.business_template_class_property)._objects
    else:
      old_objects = {}
    for key in set(self._objects.keys()).union(set(old_objects.keys())):
Nicolas Delaby's avatar
Nicolas Delaby committed
2428
      if key in update_dict or force:
2429 2430 2431 2432
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2433
        portal_id = key.split('/')[-1]
2434
        property_list = self._objects.get(key, [])
2435 2436
        type_information = types_tool.getTypeInfo(portal_id)
        if type_information is None:
2437 2438
          if not property_list:
            continue
2439 2440
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2441
        old_property_list = old_objects.get(key, ())
2442
        object_property_list = getattr(type_information, self.class_property, ())
Nicolas Delaby's avatar
Nicolas Delaby committed
2443 2444 2445 2446 2447 2448 2449 2450 2451
        # 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)
2452
        setattr(type_information, self.class_property, tuple(property_list))
2453

Aurel's avatar
Aurel committed
2454
  def uninstall(self, context, **kw):
2455
    object_path = kw.get('object_path', None)
Nicolas Delaby's avatar
Nicolas Delaby committed
2456 2457
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2458
    if object_path is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
2459
      object_key_list = [object_path]
2460
    else:
Nicolas Delaby's avatar
Nicolas Delaby committed
2461 2462
      object_key_list = self._objects.keys()
    for key in object_key_list:
2463 2464 2465 2466 2467
      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,))
2468 2469
        continue
      property_list = self._objects[key]
2470
      original_property_list = list(getattr(type_information,
2471
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2472 2473
      for id in property_list:
        if id in original_property_list:
2474
          original_property_list.remove(id)
2475
      setattr(type_information, self.class_property, tuple(original_property_list))
2476

2477

2478 2479
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2480
  name = 'Hidden Content Type'
2481 2482
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2483
  business_template_class_property = '_portal_type_hidden_content_type_item'
2484

2485

2486 2487
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2488
  name = 'Property Sheet'
2489 2490
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2491
  business_template_class_property = '_portal_type_property_sheet_item'
2492

2493

2494 2495
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2496
  name = 'Base Category'
2497 2498
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2499
  business_template_class_property = '_portal_type_base_category_item'
2500

2501

2502
class CatalogMethodTemplateItem(ObjectTemplateItem):
2503
  """Template Item for catalog methods.
2504

2505 2506 2507 2508 2509
    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.
  """
2510

2511 2512
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2513
    # a mapping to store properties of methods.
2514 2515 2516 2517 2518
    # 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()
2519

2520
    self._is_filtered_archive = PersistentMapping()
2521 2522
    for method in catalog_method_filter_list:
      setattr(self, method, PersistentMapping())
2523

2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537
  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

2538 2539
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2540

2541
    catalog = _getCatalogValue(self)
2542
    if catalog is None:
2543
      LOG('BusinessTemplate build', 0, 'catalog not found')
2544
      return
2545

2546 2547 2548
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2549

2550 2551
    for obj in self._objects.values():
      method_id = obj.id
2552 2553
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2554 2555 2556 2557 2558 2559
      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]
2560

2561 2562 2563 2564 2565
  def generateXml(self, path):
    obj = self._objects[path]
    method_id = obj.id
    xml_data = '<catalog_method>'
    if self._method_properties.has_key(method_id):
2566
      for method_property, value in self._method_properties[method_id].items():
2567 2568 2569
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2570

2571
      if self._is_filtered_archive.get(method_id):
2572 2573 2574
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2575 2576
          for method in catalog_method_filter_list:
            if method != '_filter_expression_instance_archive':
2577 2578
              value = getattr(self, method, {}).get(method_id)
              if isinstance(value, basestring):
2579 2580 2581
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2582
              elif value:
2583
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2584
                for item in value:
2585 2586
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2587
    xml_data += '\n</catalog_method>\n'
Christophe Dumez's avatar
Christophe Dumez committed
2588
    return xml_data
2589

2590 2591 2592
  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))
2593 2594 2595 2596 2597 2598 2599 2600 2601 2602
    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
2603
    path = self.__class__.__name__
2604 2605 2606 2607 2608
    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)
2609
      bta.addObject(f, key, path=path)
2610 2611
      # add all datas specific to catalog inside one file
      xml_data = self.generateXml(key)
2612
      bta.addObject(xml_data, key + '.catalog_keys', path=path)
2613

2614 2615
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2616
    catalog = _getCatalogValue(self)
2617 2618 2619 2620 2621 2622 2623
    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)
2624

2625 2626 2627
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2628
    new_bt_format = context.getTemplateFormatVersion()
2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644

    if force: # get all objects
      if new_bt_format:
        values = self._objects.values()
      else:
        values = self._archive.values()
    else: # get only selected object
      if new_bt_format == 1:
        keys = self._objects.keys()
      else:
        keys = self._archive.keys()
      for key in keys:
        if update_dict.has_key(key) or force:
          if not force:
            action = update_dict[key]
            if action == 'nothing':
2645
              continue
2646 2647 2648 2649
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2650

2651 2652
    for obj in values:
      method_id = obj.id
2653

2654 2655 2656 2657 2658 2659
      # 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
2660
          elif isinstance(old_value, (list, tuple)):
2661 2662 2663 2664
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2665

2666 2667
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2668
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2669
        if context.getTemplateFormatVersion() == 1:
2670 2671 2672 2673 2674
          if expression and expression.strip():
            # only compile non-empty expressions
            expr_instance = Expression(expression)
          else:
            expr_instance = None
2675 2676
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2677 2678 2679
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2680
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2681 2682 2683 2684
        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, ())
2685
      elif method_id in catalog.filter_dict.keys():
2686
        catalog.filter_dict[method_id]['filtered'] = 0
2687

2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713
      # 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)
2714

2715 2716 2717 2718 2719 2720
        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)
2721

2722
  def uninstall(self, context, **kw):
2723
    catalog = _getCatalogValue(self)
2724 2725 2726
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2727

2728 2729 2730 2731
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2732 2733 2734 2735
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2736
    else:
2737
      try:
2738 2739 2740 2741
        if context.getTemplateFormatVersion() == 1:
          value = self._objects[object_path]
        else:
          value = self._archive[object_path]
2742 2743
      except KeyError:
        value = None
2744 2745
      if value is not None:
        values.append(value)
2746
    for obj in values:
2747
      method_id = obj.id
2748 2749 2750 2751 2752 2753 2754 2755 2756
      # 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)
2757

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2758
      if catalog.filter_dict.has_key(method_id):
2759
        del catalog.filter_dict[method_id]
2760

2761
    # uninstall objects
2762
    ObjectTemplateItem.uninstall(self, context, **kw)
2763

2764
  def _importFile(self, file_name, file):
2765
    if file_name.endswith('.catalog_keys.xml'):
2766
      # recreate data mapping specific to catalog method
2767 2768
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2769
      xml = parse(file)
2770
      method_list = xml.findall('item')
2771
      for method in method_list:
2772 2773 2774
        key = method.get('key')
        key_type = method.get('type')
        value_node = method.find('value')
2775
        if key_type == "str":
2776
          value = value_node.text or ''
2777
        elif key_type == "int":
2778
          value = int(value_node.text)
2779
        elif key_type == "tuple":
2780
          value = tuple([value_node.text for value_node in method.findall('value')])
2781
        else:
2782
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2783
          continue
2784
        if key in catalog_method_list or key in catalog_method_filter_list:
2785
          getattr(self, key)[id] = value
2786 2787 2788
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2789 2790
    elif file_name.endswith('.xml'):
      # just import xml object
2791
      connection = self.getConnection(self.aq_parent)
2792
      obj = connection.importFile(file, customImporters=customImporters)
2793
      self.removeProperties(obj, 0)
2794 2795 2796
      self._objects[file_name[:-4]] = obj
    else:
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2797

2798
class ActionTemplateItem(ObjectTemplateItem):
2799 2800

  def __init__(self, id_list, **kw):
2801
    # XXX It's look like ObjectTemplateItem __init__
2802 2803 2804 2805 2806 2807
    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

2808 2809
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2810
      Split path tries to split a complex path such as:
2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828

      "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

2829 2830 2831 2832 2833 2834 2835
  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):
2836 2837 2838 2839 2840 2841 2842 2843 2844
    from Products.CMFCore.interfaces import IActionProvider
    if not IActionProvider.providedBy(obj):
      # look for the action in portal_actions, instead of the original object
      LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
          'Redirected action export',
          'Attempted to retrieve action %r from %r which is no longer an '
          'IActionProvided. Retrieving action from portal_actions instead' %
          (value, obj.getId()))
      obj = context.getPortalObject().portal_actions
2845 2846 2847 2848 2849 2850 2851 2852 2853 2854
    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
2855
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2856 2857 2858 2859
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2860 2861 2862 2863
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2864 2865 2866
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2867
      # normalize url
2868 2869 2870 2871 2872
      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]
2873 2874
      action = self._getActionCopy(obj, context, value)
      if action is None:
2875 2876 2877
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2878
      key = posixpath.join(url[-2], url[-1], value)
2879 2880
      keep_workflow_history = self.isKeepWorkflowObject(key)
      self._objects[key] = self.removeProperties(action, 1, keep_workflow_history)
2881
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2882

2883 2884 2885
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2886
    if context.getTemplateFormatVersion() == 1:
2887
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2888 2889
      p = context.getPortalObject()
      for id in self._objects.keys():
2890 2891 2892 2893 2894
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2895 2896 2897
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2898

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

Julien Muchembled's avatar
Julien Muchembled committed
2905 2906
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2907 2908 2909 2910 2911 2912 2913 2914 2915 2916
          from Products.CMFCore.interfaces import IActionProvider
          if not IActionProvider.providedBy(container):
            # some tools stopped being ActionProviders in CMF 2.x. Drop the
            # action into portal_actions.
            LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
                'Redirected action import',
                'Attempted to store action %r in %r which is no longer an '
                'IActionProvided. Storing action on portal_actions instead' %
                (id, path))
            container = p.portal_actions
2917
          obj, action = container, obj
2918
          action_list = obj.listActions()
2919
          for index in range(len(action_list)):
2920
            if action_list[index].id == id:
2921
              # remove previous action
2922
              obj.deleteActions(selections=(index,))
2923 2924 2925
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2926
          obj.addAction(
2927
                        id = action.id
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2928
                      , name = action.title
2929
                      , action = action_text
2930 2931 2932 2933
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2934 2935
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2936
                      , priority = action.priority
2937
                      , description = action.description
Aurel's avatar
Aurel committed
2938
                    )
2939
          # sort action based on the priority define on it
2940 2941 2942 2943 2944 2945 2946 2947 2948
          # 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))
2949 2950
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2951
        container.manage_delObjects([obj.id
2952
          for obj in container.getActionInformationList()
2953
          if obj.getReference() in action_dict])
2954
        for name, obj in action_dict.iteritems():
2955
          container._importOldAction(obj).aq_base
2956

Aurel's avatar
Aurel committed
2957
    else:
2958
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2959
      p = context.getPortalObject()
2960 2961
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2962
        relative_url, key, value = self._splitPath(id)
2963 2964
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2965
          if getattr(ai, key) == value:
2966
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2967 2968 2969
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2970
        obj.addAction(
Aurel's avatar
Aurel committed
2971 2972
                      id = action.id
                    , name = action.title
2973
                    , action = action_text
Aurel's avatar
Aurel committed
2974 2975 2976 2977
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2978 2979
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2980
                    )
Aurel's avatar
Aurel committed
2981 2982 2983 2984 2985 2986 2987
        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))
2988 2989
          obj.moveDownActions(selections=tuple(move_down_list))

2990 2991
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2992 2993
    object_path = kw.get("object_path", None)
    if object_path is not None:
2994 2995 2996 2997 2998 2999 3000 3001
      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]
3002
    else:
3003
      keys = self._archive.keys()
3004
    for id in keys:
3005 3006
      if  '|' in id:
        relative_url, value = id.split(' | ')
3007 3008 3009
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
3010
          is_new_action = interfaces.ITypeProvider.providedBy(obj.getParentValue())
3011
          key = is_new_action and 'reference' or 'id'
3012
      else:
3013
        relative_url, key, value = self._splitPath(id)
3014
        obj = p.unrestrictedTraverse(relative_url, None)
3015 3016 3017
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
3018
          if getattr(action_list[index], key, None) == value:
3019 3020
            obj.deleteActions(selections=(index,))
            break
3021 3022
      LOG('BusinessTemplate', WARNING,
          'Unable to uninstall action at %s, ignoring' % relative_url )
3023 3024
    BaseTemplateItem.uninstall(self, context, **kw)

3025 3026 3027
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
3028
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
3029 3030 3031 3032 3033 3034 3035
    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])
3036 3037
      # normalize url
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])
3038
      self._objects[relative_url] = type_role_list = []
3039
      for role in obj.getRoleInformationList():
3040
        type_role_dict = {}
3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053
        for k, v in aq_base(role).__getstate__().iteritems():
          if k == 'condition':
            if not v:
              continue
            v = v.text
          elif k in ('role_base_category', 'role_category'):
            k = k[5:]
          elif k == 'role_name':
            k, v = 'id', '; '.join(v)
          elif k not in ('title', 'description'):
            k = {'id': 'object_id', # for stable sort
                 'role_base_category': 'base_category',
                 'role_base_category_script_id': 'base_category_script',
3054 3055
                 'role_category': 'category',
                 'local_roles_group_id': 'local_roles_group_id'}.get(k)
3056 3057 3058
            if not k:
              continue
          type_role_dict[k] = v
3059
        type_role_list.append(type_role_dict)
3060
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
3061

Christophe Dumez's avatar
Christophe Dumez committed
3062
  # Function to generate XML Code Manually
3063 3064 3065 3066
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
3067
      xml_data += "\n  <role id='%s'>" % role['id']
3068
      # uniq
3069
      for property in ('title', 'description', 'condition',
3070
          'base_category_script', 'local_roles_group_id'):
3071 3072
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
3073 3074
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
3075
          xml_data += "\n   <property id='%s'>%s</property>" % \
3076 3077 3078
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
3079
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
3080 3081
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
3082
          xml_data += "\n   <multi_property "\
3083
          "id='%s'>%s</multi_property>" % (property, prop_value)
3084 3085
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
3086
    return xml_data
3087

3088 3089 3090
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3091
    path = self.__class__.__name__
3092 3093
    for key in self._objects.keys():
      xml_data = self.generateXml(key)
3094 3095
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
3096
      name = key.split('/', 1)[1]
3097
      bta.addObject(xml_data, name=name, path=path)
3098 3099

  def _importFile(self, file_name, file):
3100 3101 3102
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3103 3104
    type_roles_list = []
    xml = parse(file)
3105
    xml_type_roles_list = xml.findall('role')
3106
    for role in xml_type_roles_list:
3107 3108 3109 3110
      id = role.get('id')
      if isinstance(id, unicode):
        id = id.encode('utf_8', 'backslashreplace')
      type_role_property_dict = {'id': id}
3111
      # uniq
3112 3113 3114 3115 3116 3117 3118 3119
      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
3120
      # multi
3121 3122 3123 3124 3125 3126 3127 3128
      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)
3129
      type_roles_list.append(type_role_property_dict)
3130
    self._objects['portal_type_roles/%s' % (file_name[:-4],)] = type_roles_list
3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141

  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
3142 3143 3144
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
3145
          # reset roles before applying
3146
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
3147
          type_roles_list = self._objects[roles_path] or []
3148 3149
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
3150 3151 3152
        else:
          raise AttributeError("Path '%r' not found while "
                               "installing roles" % (path, ))
3153 3154 3155

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
3156 3157 3158 3159 3160 3161
    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:
3162
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
3163 3164
      try:
        obj = p.unrestrictedTraverse(path)
3165
        obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
3166 3167
      except (NotFound, KeyError):
        pass
3168

3169 3170 3171 3172 3173 3174
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
3175 3176
      for property in p.propertyMap():
        if property['id'] == id:
3177
          obj = p.getProperty(id)
3178
          prop_type = property['type']
3179 3180
          break
      else:
3181
        obj = None
3182
      if obj is None and not self.is_bt_for_diff:
3183
        raise NotFound, 'the property %s is not found' % id
3184
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
3185

3186 3187
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
3188
    if not file_name.endswith('.xml'):
3189
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3190
      return
3191
    xml = parse(file)
3192 3193 3194 3195 3196 3197 3198 3199 3200
    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)
3201

3202 3203 3204
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3205
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3206 3207
      p = context.getPortalObject()
      for path in self._objects.keys():
3208 3209 3210 3211
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
3212
              continue
3213
          dir, id = posixpath.split(path)
3214
          prop_type, property = self._objects[path]
3215 3216 3217 3218 3219 3220 3221 3222
          if p.hasProperty(id):
            if p.getPropertyType(id) != prop_type:
              p._delProperty(id)
              p._setProperty(id, property, type=prop_type)
            else:
              p._updateProperty(id, property)
          else:
            p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
3223
    else:
3224
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
3225
      p = context.getPortalObject()
3226
      for id, property in self._archive.keys():
3227
        property = self._archive[id]
Aurel's avatar
Aurel committed
3228
        if p.hasProperty(id):
3229 3230 3231 3232 3233 3234 3235
          if p.getPropertyType(id) != property['type']:
            p._delProperty(id)
            p._setProperty(id, property['value'], type=property['type'])
          else:
            p._updateProperty(id, property['value'])
        else:
          p._setProperty(id, property['value'], type=property['type'])
3236 3237 3238

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3239 3240 3241 3242 3243 3244
    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:
3245 3246 3247 3248
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3249
  # Function to generate XML Code Manually
3250
  def generateXml(self, path=None):
3251
    xml_data = ''
3252
    prop_type, obj = self._objects[path]
3253
    xml_data += '\n <property>'
3254 3255
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
3256
    if prop_type in ('lines', 'tokens'):
3257
      xml_data += '\n  <value>'
3258
      for item in obj:
3259
        if item != '':
3260
          xml_data += '\n   <item>%s</item>' % escape(str(item))
3261
      xml_data += '\n  </value>'
3262
    else:
3263
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
3264
    xml_data += '\n </property>'
3265 3266
    return xml_data

Aurel's avatar
Aurel committed
3267 3268 3269
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3270 3271 3272 3273
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
3274
      xml_data += self.generateXml(path)
3275
    xml_data += '\n</site_property>'
3276
    bta.addObject(xml_data, name='properties', path=self.__class__.__name__)
3277

3278 3279 3280 3281 3282
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3283 3284 3285 3286 3287 3288 3289
    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()
3290
      mapping['category_list'] = module.getCategoryList()
3291
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3292

Christophe Dumez's avatar
Christophe Dumez committed
3293
  # Function to generate XML Code Manually
3294
  def generateXml(self, path=None):
3295
    mapping = self._objects[path]
3296
    xml_data = ['<module>']
3297
    keys = mapping.keys()
3298 3299
    for key in sorted(keys):
      if key == 'permission_list':
3300
        # separe permission dict into xml
3301
        xml_data.append(' <%s>' % (key, ))
3302
        permission_list = mapping[key]
3303
        for perm in permission_list:
3304
          # the type of the permission defined if we use acquired or not
3305
          if isinstance(perm[1], list):
3306 3307 3308
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
3309
          role_list = list(perm[1])
3310 3311 3312
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
3313
          if (len(role_list) == 0 and ptype == 'list') or \
3314 3315
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
3316
          role_list.sort()
3317 3318
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
3319
          for role in role_list:
3320 3321 3322
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
3323 3324 3325 3326 3327 3328 3329 3330
      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, ))
3331
      else:
3332
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
3333 3334
    xml_data.append('</module>')
    return '\n'.join(xml_data)
3335

3336
  def export(self, context, bta, **kw):
3337
    if len(self._objects) == 0:
3338
      return
3339
    path = self.__class__.__name__
3340 3341
    keys = self._objects.keys()
    keys.sort()
3342
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
3343
      # export modules one by one
3344
      xml_data = self.generateXml(path=key)
3345
      bta.addObject(xml_data, name=key, path=path)
3346

3347
  def install(self, context, trashbin, **kw):
3348
    portal = context.getPortalObject()
3349 3350
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3351
    if context.getTemplateFormatVersion() == 1:
3352
      items = self._objects
3353
    else:
3354 3355
      items = self._archive

3356 3357
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
3358 3359
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
3360
        if not force:
3361
          action = update_dict[path]
3362 3363
          if action == 'nothing':
            continue
3364 3365
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
3366
        module = portal._getOb(module_id, None)
3367 3368
        if module is not None:
          module.portal_type = portal_type
3369
        else:
3370
          module = portal.newContent(id=module_id, portal_type=portal_type)
3371
        module.setTitle(str(mapping['title']))
3372 3373
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
3374
          # By default, Manager only without acquire permission
3375 3376
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
3377
          module.manage_permission(name, roles=role_list, acquire=acquire)
3378 3379
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
3380 3381

  def _importFile(self, file_name, file):
3382 3383 3384
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3385
    mapping = {}
3386
    xml = parse(file)
3387
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3388
      key_node = xml.find(key)
3389
      if key == 'permission_list':
3390 3391 3392 3393 3394 3395 3396
        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))
3397
          else:
3398 3399 3400
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3401
      else:
3402
        mapping[key] = key_node.text or ''
3403 3404

    category_list = []
3405 3406 3407 3408
    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'))
3409 3410
    mapping['category_list'] = category_list

3411
    self._objects[file_name[:-4]] = mapping
3412

3413
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3414 3415 3416
    trash = kw.get('trash', 0)
    if trash:
      return
3417 3418 3419 3420 3421 3422
    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]
3423 3424
    p = context.getPortalObject()
    id_list = p.objectIds()
3425 3426
    for key in keys:
      if key in id_list:
3427
        try:
3428
          if trash and trashbin is not None:
3429
            container_path = key.split('/')
3430 3431
            self.portal_trash.backupObject(trashbin, container_path, 
                                           key, save=1, keep_subobjects=1)
3432
          p.manage_delObjects([key])
3433
        except NotFound:
3434
          pass
3435 3436
    BaseTemplateItem.uninstall(self, context, **kw)

3437 3438 3439
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3440

3441 3442
# XXX-arnau: when everything has been migrated to Components, this class
# should be renamed to DocumentTemplateItem
3443
class FilesystemDocumentTemplateItem(BaseTemplateItem):
3444 3445 3446 3447
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3448

3449 3450 3451 3452 3453 3454 3455 3456 3457 3458
  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

3459 3460
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
3461 3462
    for key in self._archive.iterkeys():
      self._objects[key] = self.local_file_reader_name(key)
Aurel's avatar
Aurel committed
3463

3464
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3465 3466
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3467
      new_keys = self._objects.keys()
3468
      # fix key if necessary in installed bt for diff
3469
      extra_prefix = self.__class__.__name__ + '/'
3470
      for key in installed_item._objects.keys():
3471 3472 3473 3474
        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]
3475
      for path in new_keys:
3476
        if installed_item._objects.has_key(path):
3477 3478
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3479
          old_obj_code = installed_item._objects[path]
3480
          if new_obj_code != old_obj_code:
3481
            # Note: Magical way to have unique paths
3482
            modified_object_list.update(
3483
                {self._getKey(path) : ['Modified', self.__class__.__name__[:-12]]})
3484
        else: # new object
3485
          # Note: Magical way to have unique paths
3486
          modified_object_list.update(
3487
                {self._getKey(path) : ['New', self.__class__.__name__[:-12]]})
3488
          # get removed object
3489
      old_keys = installed_item._objects.keys()
3490 3491
      for path in old_keys:
        if path not in new_keys:
3492
          # Note: Magical way to have unique paths
3493
          modified_object_list.update(
3494
                {self._getKey(path) : ['Removed', self.__class__.__name__[:-12]]})
3495 3496
    return modified_object_list

3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511
  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()

3512 3513 3514
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3515
    if context.getTemplateFormatVersion() == 1:
3516
      need_reset = isinstance(self, FilesystemDocumentTemplateItem)
3517
      for key in self._objects.keys():
3518 3519 3520 3521 3522 3523
        # 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:
3524
          if not force:
3525
            action = update_dict.get(key, update_dict.get(upgraded_key))
3526 3527
            if action == 'nothing':
              continue
3528 3529
          text = self._objects[key]
          path, name = posixpath.split(key)
3530
          try:
3531
            self.local_file_writer_name(name, text, create=0)
3532
          except IOError, error:
3533 3534
            LOG(self.__class__.__name__, WARNING,
                "Cannot install class %r on file system" % name)
3535
            if error.errno:
3536
              raise
3537
            continue
3538 3539 3540
          if self.local_file_importer_name is None:
            continue
          if need_reset:
3541
            self._resetDynamicModules()
3542 3543
            need_reset = False
          self.local_file_importer_name(name)
Aurel's avatar
Aurel committed
3544
    else:
3545
      BaseTemplateItem.install(self, context, trashbin, **kw)
3546 3547
      for key in self._archive.keys():
        text = self._archive[key]
Aurel's avatar
Aurel committed
3548
        # This raises an exception if the file exists.
3549
        self.local_file_writer_name(key, text, create=1)
Aurel's avatar
Aurel committed
3550
        if self.local_file_importer_name is not None:
3551
          self.local_file_importer_name(key)
3552

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

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

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

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

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

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

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

3628 3629
    BaseTemplateItem.__init__(self, id_list, **kw)

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

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

3652 3653 3654
      if method_name == 'preinstall':
        old_result = result.copy()
        for k, v in old_result.iteritems():
3655 3656 3657 3658 3659
          # 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())):
3660 3661 3662
            result.pop(k)
            k = self._getKey(k)
          result[k] = v
3663
      return result
3664 3665 3666 3667 3668 3669 3670
    return inner

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

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

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

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

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

    self.afterUninstall(already_migrated)
3703

3704
  def remove(self, context, **kw):
3705
    """
3706
    Conversion of magically uniqued paths to real ones
3707
    """
3708 3709 3710 3711 3712 3713 3714
    remove_object_dict = kw.get('remove_object_dict', {})
    new_remove_dict = dict()
    for k,v in remove_object_dict.iteritems():
      if k.startswith(self.getTemplateTypeName()+'/'):
        new_remove_dict[self._getPath(k)] = v
    kw['remove_object_dict'] = new_remove_dict
    ObjectTemplateItem.remove(self, context, **kw)
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 3808 3809 3810 3811 3812 3813
    # With format 0 of Business Template, the objects are stored in
    # '_archive' whereas they are stored in '_objects' with format
    # version 1
    bt_format_version = context.getTemplateFormatVersion()

    if bt_format_version == 0 and \
       not self._is_already_migrated(self._archive.keys()):
3814 3815 3816 3817
      self._migrateAllFromFilesystem(context,
                                     self._archive,
                                     self._objects,
                                     kw.get('object_to_update'))
3818 3819
    elif bt_format_version == 1 and \
         not self._is_already_migrated(self._objects.keys()):
3820 3821 3822 3823
      self._migrateAllFromFilesystem(context,
                                     self._objects,
                                     self._archive,
                                     kw.get('object_to_update'))
3824 3825 3826

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

3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840
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.

3841 3842 3843
  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.
3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862
  """
  # 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",
3863
                        class_id + ".py")
3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892

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

3893
class ConstraintTemplateItem(FilesystemDocumentTemplateItem):
3894 3895 3896 3897
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3898

3899
class DocumentTemplateItem(FilesystemToZodbTemplateItem):
3900
  """
3901 3902 3903
  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.
3904 3905 3906

  The migration is performed in two steps:

3907 3908 3909 3910 3911 3912
    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:
3913

3914 3915 3916 3917 3918
    - 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
3919 3920 3921
  """
  _tool_id = 'portal_components'

3922 3923
  @staticmethod
  def _getZodbObjectId(id):
3924
    return 'erp5.component.document.' + id
3925 3926 3927 3928 3929 3930

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

3933
  def _importFile(self, file_name, file_obj):
3934 3935 3936 3937 3938 3939
    """
    Upon import, only consider XML file for ZODB Components (as the Python
    source file will be read and set to text_content property on the new
    object when the XML will be processed) and for backward compatibility,
    handle non-migrated Document as well
    """
3940 3941 3942 3943
    if file_name.endswith('.py'):
      # If portal_components/XXX.py, then ignore it as it will be handled when
      # the .xml file will be processed
      if file_obj.name.rsplit(os.path.sep, 2)[-2] != 'portal_components':
3944 3945
        FilesystemDocumentTemplateItem._importFile(self, file_name, file_obj)
    elif file_name.endswith('.xml'):
3946
      ObjectTemplateItem._importFile(self, file_name, file_obj)
3947

3948 3949
      name = file_name[:-4]
      obj = self._objects[name]
3950
      with open(file_obj.name[:-4] + ".py") as f:
3951 3952
        obj.text_content = f.read()

3953 3954 3955 3956 3957 3958
      # 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__()
      self._archive[name] = None
3959
      del self._archive[name[len('portal_components/'):]]
3960 3961
    else:
      LOG('Business Template', 0, 'Skipping file "%s"' % file_name)
3962

3963
  def export(self, context, bta, **kw):
3964 3965 3966 3967
    """
    Export a Document as two files for ZODB Components, one for metadata
    (.xml) and the other for the Python source code (.py)
    """
3968
    path = self.__class__.__name__ + '/'
3969
    for key, obj in self._objects.iteritems():
3970
      # Back compatibility with filesystem Documents
3971 3972 3973 3974 3975 3976
      if isinstance(obj, str):
        if not key.startswith(path):
          key = path + key
        bta.addObject(obj, name=key, ext='.py')
      else:
        obj = obj._getCopy(context)
3977

3978 3979
        f = StringIO(obj.text_content)
        bta.addObject(f, key, path=path, ext='.py')
3980

3981
        del obj.text_content
3982
        transaction.savepoint(optimistic=True)
3983

3984 3985 3986 3987
        # export object in xml
        f = StringIO()
        XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
        bta.addObject(f, key, path=path)
3988

3989
  def getTemplateIdList(self):
3990 3991 3992 3993
    """
    Getter for Document property on the Business Template, must be overriden
    in children classes (e.g. ExtensionDocumentTemplateItem for example)
    """
3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020
    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()

      try:
        context.getPortalObject().unrestrictedTraverse(
          'portal_components/' + document_id_list[0])
      except (IndexError, KeyError):
        return FilesystemDocumentTemplateItem.build(self, context, **kw)
      else:
        self._archive.clear()
        for name in document_id_list:
          self._archive['portal_components/' + name] = None

    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...
    """
Arnaud Fontaine's avatar
Arnaud Fontaine committed
4021 4022
    object_list = list(self._objects if context.getTemplateFormatVersion() == 1
                                     else self._archive)
4023 4024

    if self._is_already_migrated(object_list):
4025 4026
      ObjectTemplateItem.install(self, context, **kw)
      self.portal_components.reset(force=True, reset_portal_type=True)
4027
    else:
4028 4029 4030 4031 4032
      FilesystemDocumentTemplateItem.install(self, context, **kw)

  def afterUninstall(self, already_migrated=False):
    if already_migrated:
      self.portal_components.reset(force=True, reset_portal_type=True)
4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046

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)

4047 4048
  @staticmethod
  def _getZodbObjectId(id):
4049
    return 'erp5.component.extension.' + id
4050

4051 4052
  def getTemplateIdList(self):
    return self.getTemplateExtensionIdList()
4053

4054
class TestTemplateItem(DocumentTemplateItem):
4055 4056 4057 4058 4059
  """
  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.
  """
4060 4061
  local_file_reader_name = staticmethod(readLocalTest)
  local_file_writer_name = staticmethod(writeLocalTest)
4062
  # Test needs no import
4063
  local_file_importer_name = None
4064
  local_file_remover_name = staticmethod(removeLocalTest)
4065

4066 4067 4068 4069 4070 4071
  @staticmethod
  def _getZodbObjectId(id):
    return 'erp5.component.test.' + id

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

4073 4074 4075
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
4076 4077 4078

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
4079
  def build(self, context, **kw):
4080 4081
    for key in self._archive.iterkeys():
      self._objects[key] = 1
Aurel's avatar
Aurel committed
4082

4083
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4084 4085
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
4086
      new_roles = self._objects.keys()
4087 4088 4089 4090 4091 4092
      # 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]
4093
      for role in new_roles:
4094
        if installed_item._objects.has_key(role):
4095 4096 4097 4098
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
4099
      old_roles = installed_item._objects.keys()
4100 4101 4102 4103 4104 4105
      for role in old_roles:
        if role not in new_roles:
          modified_object_list.update({role : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
4106
    p = context.getPortalObject()
4107
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4108
    if context.getTemplateFormatVersion() == 1:
4109
      role_set = set(self._objects)
4110
    else:
4111
      role_set = set(self._archive)
4112 4113 4114 4115
    # 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:
4116 4117
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
4118
    # set roles on portal
4119
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
4120 4121

  def _importFile(self, file_name, file):
4122
    if not file_name.endswith('.xml'):
4123
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
4124
      return
4125
    xml = parse(file)
4126 4127 4128
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140

  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)

4141 4142 4143 4144 4145 4146 4147 4148 4149
  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
4150
      if role in roles and role not in new_roles:
4151 4152 4153
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
4154
  # Function to generate XML Code Manually
4155 4156
  def generateXml(self):
    role_list = self._objects.keys()
4157
    xml_data = '<role_list>'
4158 4159
    for role in sorted(role_list):
      xml_data += '\n <role>%s</role>' % (role,)
4160
    xml_data += '\n</role_list>'
4161 4162
    return xml_data

Aurel's avatar
Aurel committed
4163
  def export(self, context, bta, **kw):
4164
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
4165
      return
4166 4167 4168 4169 4170 4171 4172 4173
    # 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
4174
    bta.addObject(xml_data, name=path)
4175

4176 4177 4178 4179
class CatalogSearchKeyTemplateItem(BaseTemplateItem):
  key_list_attr = 'sql_catalog_search_keys'
  key_list_title = 'search_key_list'
  key_title = 'Search key'
4180

Aurel's avatar
Aurel committed
4181
  def build(self, context, **kw):
4182
    catalog = _getCatalogValue(self)
4183 4184 4185
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
4186
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
4187
    key_list = []
4188
    for key in self._archive.keys():
4189
      if key in catalog_key_list:
4190
        key_list.append(key)
4191
      elif not self.is_bt_for_diff:
4192
        raise NotFound, '%s %r not found in catalog' %(self.key_title, key)
4193
    if len(key_list) > 0:
4194
      self._objects['%s/%s' % (self.__class__.__name__, self.key_list_title)] = key_list
4195 4196

  def _importFile(self, file_name, file):
4197 4198 4199
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4200
    xml = parse(file)
4201 4202
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4203

4204
  def install(self, context, trashbin, **kw):
4205
    catalog = _getCatalogValue(self)
4206 4207 4208
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
4209

4210
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4211
    if context.getTemplateFormatVersion() == 1:
4212 4213
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
4214 4215 4216
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
4217
    else:
4218
      keys = self._archive.keys()
4219 4220
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
4221
    # XXX same as related key
4222
    if update_dict.has_key(self.key_list_title) or force:
4223
      if not force:
4224
        action = update_dict[self.key_list_title]
4225
        if action == 'nothing':
Aurel's avatar
Aurel committed
4226
          return
4227
      for key in keys:
4228 4229 4230
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
4231

4232
  def uninstall(self, context, **kw):
4233
    catalog = _getCatalogValue(self)
4234 4235 4236
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
4237
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
4238
    object_path = kw.get('object_path', None)
4239 4240 4241 4242 4243
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
4244 4245 4246
      if key in catalog_key_list:
        catalog_key_list.remove(key)
    setattr(catalog, self.key_list_attr, catalog_key_list)
4247 4248
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
4249
  # Function to generate XML Code Manually
4250
  def generateXml(self, path=None):
4251
    obj = self._objects[path]
4252
    xml_data = '<key_list>'
4253 4254
    obj.sort()
    for key in obj:
4255 4256
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4257 4258
    return xml_data

Aurel's avatar
Aurel committed
4259 4260 4261
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
4262
    for path in self._objects.keys():
4263
      xml_data = self.generateXml(path=path)
4264
      bta.addObject(xml_data, name=path)
4265

4266 4267 4268 4269
class CatalogResultKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_result_keys'
  key_list_title = 'result_key_list'
  key_title = 'Result key'
4270

4271 4272 4273 4274
class CatalogRelatedKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_related_keys'
  key_list_title = 'related_key_list'
  key_title = 'Related key'
4275

4276
  # override this method to support 'key_list' for backward compatibility.
4277
  def install(self, context, trashbin, **kw):
4278
    catalog = _getCatalogValue(self)
4279 4280 4281
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
4282

4283
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4284
    if context.getTemplateFormatVersion() == 1:
4285
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
4286
        return
4287 4288 4289
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
4290
    else:
4291
      keys = self._archive.keys()
4292 4293
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
4294
    # XXX must a find a better way to manage related key
4295
    if update_dict.has_key(self.key_list_title) or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
4296
      if not force:
4297 4298
        if update_dict.has_key(self.key_list_title):
          action = update_dict[self.key_list_title]
Aurel's avatar
Aurel committed
4299 4300
        else: # XXX for backward compatibility
          action = update_dict['key_list']
Aurel's avatar
Aurel committed
4301 4302 4303
        if action == 'nothing':
          return
      for key in keys:
4304 4305 4306
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
4307

4308 4309 4310 4311
class CatalogResultTableTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_tables'
  key_list_title = 'result_table_list'
  key_title = 'Result table'
4312

4313
# keyword
4314 4315 4316 4317
class CatalogKeywordKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_keyword_search_keys'
  key_list_title = 'keyword_key_list'
  key_title = 'Keyword key'
4318

4319
# datetime
4320 4321 4322 4323
class CatalogDateTimeKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_datetime_search_keys'
  key_list_title = 'datetime_key_list'
  key_title = 'DateTime key'
4324

4325 4326 4327 4328 4329
# full text
class CatalogFullTextKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_full_text_search_keys'
  key_list_title = 'full_text_key_list'
  key_title = 'Fulltext key'
4330

4331 4332 4333 4334 4335
# request
class CatalogRequestKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_request_keys'
  key_list_title = 'request_key_list'
  key_title = 'Request key'
4336

4337 4338 4339 4340 4341
# multivalue
class CatalogMultivalueKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_multivalue_keys'
  key_list_title = 'multivalue_key_list'
  key_title = 'Multivalue key'
4342 4343

# topic
4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362
class CatalogTopicKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_topic_search_keys'
  key_list_title = 'topic_key_list'
  key_title = 'Topic key'

class CatalogScriptableKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_scriptable_keys'
  key_list_title = 'scriptable_key_list'
  key_title = 'Scriptable key'

class CatalogRoleKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_role_keys'
  key_list_title = 'role_key_list'
  key_title = 'Role key'

class CatalogLocalRoleKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_local_role_keys'
  key_list_title = 'local_role_key_list'
  key_title = 'LocalRole key'
4363

4364 4365 4366 4367 4368 4369
class CatalogSecurityUidColumnTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_security_uid_columns'
  key_list_title = 'security_uid_column_list'
  key_title = 'Security Uid Columns'


4370 4371 4372 4373
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4374 4375 4376
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4377
      else: # XXX backward compatibility
4378 4379
        lang = lang_key
        catalog = 'erp5_ui'
4380
      path = posixpath.join(lang, catalog)
4381 4382
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4383 4384 4385
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4386

4387
  def preinstall(self, context, installed_item, **kw):
4388 4389 4390 4391
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
4392
        if installed_item._objects.has_key(path):
4393 4394
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
4395
          old_obj_code = installed_item._objects[path]
4396 4397 4398 4399 4400
          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
4401
      old_keys = installed_item._objects.keys()
4402 4403 4404 4405 4406
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434
  def _splitKey(self,key):
    path = key.split('/')
    if len(path) == 1:
      lang = path[0]
      catalog = None
    elif len(path) == 2:
      lang = path[0]
      catalog = path[1]
    else:
      lang = path[-3]
      catalog = path[-2]
    return lang, catalog

  def _importCatalogLanguage(self, localizer, catalog, lang, po):
    if catalog not in localizer.objectIds():
      dispatcher = localizer.manage_addProduct['Localizer']
      dispatcher.manage_addMessageCatalog(id=catalog, 
                                          title='Message Catalog',
                                          languages=['en'])
    mc = localizer._getOb(catalog)
    if lang not in mc.get_languages():
      mc.manage_addLanguage(lang)
    mc.manage_import(lang, po)

  def install(self, context, trashbin, localizer=None, **kw):
    if localizer is None:
      localizer = context.getPortalObject().Localizer
    update_dict = kw.get('object_to_update', {})
4435 4436
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
4437 4438
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4439
          if not force:
4440
            action = update_dict[key]
4441
            if action == 'nothing':
4442
              continue
4443
          lang, catalog = self._splitKey(key)
4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459

          if catalog is None:
            name = self._objects[key]
            for lang_dict in localizer.get_all_languages():
              if lang_dict['code'] == lang:
                # When the Localizer has the language as a user-defined
                # language, make sure that the name is updated.
                old_name = localizer.get_user_defined_language_name(lang)
                if old_name is not None and old_name != name:
                  localizer._del_user_defined_language(lang)
                  localizer._add_user_defined_language(name, lang)
                break
            else:
              # if the Localizer does not know the language code, it must be
              # defined as a user-defined language.
              localizer._add_user_defined_language(name, lang)
4460 4461
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4462 4463 4464 4465
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4466
            self._importCatalogLanguage(localizer, catalog, lang, po)
4467 4468
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4469
      for lang, catalogs in self._archive.iteritems():
4470 4471 4472
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502
          self._importCatalogLanguage(catalog, lang, po)

  def uninstall(self, context, remove_translations=False, **kw):
    if not remove_translations:
      return
    portal = context.getPortalObject()
    localizer = portal.Localizer
    from Products.Localizer.Localizer import Localizer
    fake_localizer = Localizer('Fake Localizer',
                               languages=['en']).__of__(portal)
    # roundabout way of keeping BW compatibility, allow install() to do the
    # heavy lifting so we can extract the original catalogs and messages:
    self.install(context, None, localizer=fake_localizer, force=True, **kw)
    # now scan the actual message_catalog to remove messages present in the
    # fake one.
    for fake_message_catalog in fake_localizer.objectValues():
      message_catalog = localizer._getOb(fake_message_catalog.getId())
      # get list of messages present in both the fake and the real catalog
      # UGH! direct attribute access... but there is no real API to access
      # all messages here.
      messages = set(fake_message_catalog._messages.keys())
      messages.intersection_update(message_catalog._messages.keys())
      for message in messages:
        # delete translations from the real catalog that are present in the
        # fake one
        fake_translations = fake_message_catalog.get_translations(message)
        translations = message_catalog.get_translations(message)
        for lang in fake_translations.keys():
          # XXX: should we check they're still the same before removing?
          translations.pop(lang, None)
4503 4504

  def export(self, context, bta, **kw):
4505
    if len(self._objects) == 0:
4506
      return
4507
    root_path = self.__class__.__name__
4508
    for key, obj in self._objects.iteritems():
4509
      path = os.path.join(root_path, key)
4510
      if '/' in key:
4511
        bta.addObject(obj, 'translation', ext='.po', path=path)
4512 4513 4514 4515 4516
      else:
        xml_data = ['<language>']
        xml_data.append(' <code>%s</code>' % (escape(key), ))
        xml_data.append(' <name>%s</name>' % (escape(obj), ))
        xml_data.append('</language>')
4517
        bta.addObject('\n'.join(xml_data), 'language', path=path)
4518 4519

  def _importFile(self, file_name, file):
4520 4521
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4522 4523
      text = file.read()
      self._objects[file_name[:-3]] = text
4524 4525
    elif name == 'language.xml':
      xml = parse(file)
4526 4527
      name = xml.find('name').text
      code = xml.find('code').text
4528
      self._objects[code] = name
4529

Aurel's avatar
Aurel committed
4530 4531
class LocalRolesTemplateItem(BaseTemplateItem):

4532
  def __init__(self, id_list, **kw):
4533
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4534 4535
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4536 4537 4538
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4539
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4540 4541
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4542 4543 4544
      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
4545

Christophe Dumez's avatar
Christophe Dumez committed
4546
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4547
  def generateXml(self, path=None):
4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560
    # 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
      local_roles_group_id_dict = dict()
      local_roles_dict, = self._objects[path]

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

    if local_roles_group_id_dict:
      # local roles group id dict (not included by default to be stable with
      # old bts)
      xml_data += '\n <local_roles_group_id>'
      for principal, local_roles_group_id_list in sorted(local_roles_group_id_dict.items()):
        xml_data += "\n  <principal id='%s'>" % escape(principal)
        for local_roles_group_id in local_roles_group_id_list:
          xml_data += "\n    <local_roles_group_id>%s</local_roles_group_id>" % \
                escape(local_roles_group_id)
        xml_data += "\n  </principal>"
      xml_data += '\n </local_roles_group_id>'

4584
    xml_data += '\n</local_roles_item>'
Vincent Pelletier's avatar
Vincent Pelletier committed
4585
    if isinstance(xml_data, unicode):
4586
      xml_data = xml_data.encode('utf8')
Aurel's avatar
Aurel committed
4587
    return xml_data
4588

Aurel's avatar
Aurel committed
4589
  def export(self, context, bta, **kw):
4590 4591
    path = self.__class__.__name__
    for key in self._objects:
Aurel's avatar
Aurel committed
4592
      xml_data = self.generateXml(key)
4593 4594
      assert key[:12] == 'local_roles/'
      bta.addObject(xml_data, key[12:], path=path)
Aurel's avatar
Aurel committed
4595 4596

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

    # local roles group id
    local_roles_group_id_dict = {}
    for principal in xml.findall('//principal'):
      local_roles_group_id_dict[principal.get('id')] = tuple(
        [group_id.text for group_id in
            principal.findall('./local_roles_group_id')])

    self._objects['local_roles/%s' % (file_name[:-4],)] = (
      local_roles_dict, local_roles_group_id_dict)
Aurel's avatar
Aurel committed
4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628

  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
4629 4630
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4631 4632 4633 4634 4635 4636 4637
        # 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:
          local_roles_group_id_dict = dict()
          local_roles_dict, = self._objects[roles_path]
4638
        setattr(obj, '__ac_local_roles__', local_roles_dict)
4639 4640 4641 4642 4643 4644 4645 4646
        if local_roles_group_id_dict:
          setattr(obj, '__ac_local_roles_group_id_dict__',
                  local_roles_group_id_dict)
          # we try to have __ac_local_roles_group_id_dict__ set only if
          # it is actually defining something else than default
        elif getattr(aq_base(obj), '__ac_local_roles_group_id_dict__',
                    None) is not None:
          delattr(obj, '__ac_local_roles_group_id_dict__')
4647
        obj.reindexObject()
Aurel's avatar
Aurel committed
4648

4649
  def uninstall(self, context, object_path=None, **kw):
Aurel's avatar
Aurel committed
4650
    p = context.getPortalObject()
4651 4652 4653 4654 4655
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
Aurel's avatar
Aurel committed
4656
      path = roles_path.split('/')[1:]
4657 4658 4659 4660 4661 4662
      # if document does not exists anymore longer,
      # there is no needs to fail
      obj = p.unrestrictedTraverse(path, None)
      if obj is not None:
        setattr(obj, '__ac_local_roles__', {})
        obj.reindexObject()
4663

4664 4665 4666
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4667
    in part or completely. Each object is separated from its
4668 4669 4670 4671 4672 4673 4674 4675 4676 4677
    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
4678 4679
      - object without optimal actions
      - list of relation between portal type and workflow
4680 4681 4682 4683 4684 4685 4686 4687 4688 4689

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

    - site property definition
      - id
      - type
4690
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4691

4692 4693
    - document/propertysheet/extension/test definition
      - copy of the local file
4694

4695
    - message transalation definition
4696
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4697

4698 4699
    The Business Template properties are exported to the bt folder with
    one property per file
4700

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4701 4702
    Technology:

4703 4704
    - 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
4705

4706
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4707 4708 4709 4710

    Use case:

    - install core ERP5 (the minimum)
4711

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

4714 4715
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4716
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4717 4718 4719 4720 4721
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4722
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4723 4724 4725

    # Declarative security
    security = ClassSecurityInfo()
4726
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4727 4728 4729 4730

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4731
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4732
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4733
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4734
                      , PropertySheet.BusinessTemplate
4735
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4736 4737
                      )

4738 4739 4740 4741 4742 4743
    # 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."""
4744
         , 'icon'           : 'file_icon.gif'
4745 4746
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
4747
         , 'type_class'     : 'BusinessTemplate'
4748 4749 4750 4751 4752 4753 4754
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4755 4756
    # This is a global variable
    # Order is important for installation
4757 4758 4759
    # We want to have:
    #  * path after module, because path can be module content
    #  * path after categories, because path can be categories content
4760 4761
    #  * path before workflow chain, because path can be a portal type
    #         (until chains are set on portal types with categories)
4762 4763 4764
    #  * skin after paths, because we can install a custom connection string as
    #       path and use it with SQLMethods in a skin.
    #    ( and more )
4765
    _item_name_list = [
4766
      '_registered_version_priority_selection_item',
4767
      '_product_item',
4768
      '_document_item',
4769
      '_property_sheet_item',
4770
      '_constraint_item',
4771 4772 4773
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4774
      '_tool_item',
4775 4776 4777 4778
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4779
      #'_portal_type_workflow_chain_item',
4780 4781 4782 4783
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4784 4785
      '_category_item',
      '_module_item',
4786
      '_path_item',
4787
      '_skin_item',
4788
      '_registered_skin_selection_item',
4789
      '_preference_item',
4790
      '_action_item',
4791
      '_portal_type_roles_item',
4792
      '_local_roles_item',
4793
      '_portal_type_workflow_chain_item',
4794
      '_catalog_method_item',
4795 4796 4797
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4798
      '_catalog_search_key_item',
4799
      '_catalog_keyword_key_item',
4800
      '_catalog_datetime_key_item',
4801 4802 4803 4804
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4805
      '_catalog_scriptable_key_item',
4806 4807
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4808
      '_catalog_security_uid_column_item',
4809 4810 4811 4812
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4813 4814 4815 4816 4817 4818
      self._clean()

    def getTemplateFormatVersion(self, **kw):
      """This is a workaround, because template_format_version was not set even for the new format.
      """
      if self.hasProperty('template_format_version'):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4819
        self._baseGetTemplateFormatVersion()
4820

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4821 4822 4823
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4824

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4825
      return 0
4826

4827
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4828 4829 4830 4831 4832 4833 4834
    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".
4835 4836
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4837
          # XXX Not good to access the attribute directly,
4838 4839 4840
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4841

4842 4843
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4844 4845 4846 4847 4848 4849
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4850
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4851 4852 4853 4854 4855 4856 4857 4858
        """Increment bt revision number.
        """
        revision_number = self.getRevision()
        if revision_number is None or revision_number.strip() == '':
          revision_number = 1
        else:
          revision_number = int(revision_number)+1
        self.setRevision(revision_number)
4859

4860 4861
    security.declareProtected(Permissions.ManagePortal, 'storeTemplateItemData')
    def storeTemplateItemData(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4862
      """
4863
        Instanciate and Store Template items into properties.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4864
      """
4865
      # Store all Data
4866 4867
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4868
      self._portal_type_workflow_chain_item = \
4869
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4870 4871 4872 4873
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4874 4875 4876
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4877 4878 4879
      self._registered_version_priority_selection_item = \
          RegisteredVersionPrioritySelectionTemplateItem(
              self.getTemplateRegisteredVersionPrioritySelectionList())
4880 4881 4882 4883 4884 4885
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4886
      self._portal_type_roles_item = \
4887
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4888 4889 4890 4891 4892 4893 4894
      self._site_property_item = \
          SitePropertyTemplateItem(self.getTemplateSitePropertyIdList())
      self._module_item = \
          ModuleTemplateItem(self.getTemplateModuleIdList())
      self._document_item = \
          DocumentTemplateItem(self.getTemplateDocumentIdList())
      self._property_sheet_item = \
4895 4896
          PropertySheetTemplateItem(self.getTemplatePropertySheetIdList(),
                                    context=self)
4897 4898
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918
      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())
4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930
      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())
4931 4932
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4933 4934
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4935 4936 4937
      self._catalog_search_key_item = \
          CatalogSearchKeyTemplateItem(
               self.getTemplateCatalogSearchKeyList())
4938 4939
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4940
               self.getTemplateCatalogKeywordKeyList())
4941 4942 4943
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4944 4945
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4946
               self.getTemplateCatalogFullTextKeyList())
4947 4948
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4949
               self.getTemplateCatalogRequestKeyList())
4950 4951
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4952
               self.getTemplateCatalogMultivalueKeyList())
4953 4954 4955
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4956 4957
      self._local_roles_item = \
          LocalRolesTemplateItem(
4958
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4959 4960 4961
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4962 4963 4964
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4965 4966 4967 4968 4969 4970
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4971 4972 4973
      self._catalog_security_uid_column_item = \
          CatalogSecurityUidColumnTemplateItem(
               self.getTemplateCatalogSecurityUidColumnList())
4974

4975 4976 4977 4978 4979 4980 4981 4982 4983 4984
    security.declareProtected(Permissions.ManagePortal, 'build')
    def build(self, no_action=0):
      """
        Copy existing portal objects to self
      """
      if no_action: return
        # this is use at import of Business Template to get the status built
      # Make sure that everything is sane.
      self.clean()

4985
      try:
Julien Muchembled's avatar
Julien Muchembled committed
4986 4987 4988 4989 4990 4991
        from Products.ERP5VCS.WorkingCopy import NotAWorkingCopyError
        try:
          self.setRevision(self.getVcsTool().newRevision())
        except NotAWorkingCopyError:
          raise ImportError
      except ImportError:
4992
        self.updateRevisionNumber()
4993 4994 4995
      self._setTemplateFormatVersion(1)
      self.storeTemplateItemData()

4996 4997
      # Build each part
      for item_name in self._item_name_list:
4998 4999 5000 5001
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
5002 5003

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5004
      """
5005
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5006
      """
5007
      return self.portal_templates.publish(self, url, username=username,
5008
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5009

5010
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5011
      """
5012
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5013
      """
5014
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5015

5016 5017 5018 5019 5020
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
5021 5022 5023 5024 5025 5026 5027 5028 5029 5030
      default_catalog = self.getPortalObject().portal_catalog.getSQLCatalog()
      my_catalog = _getCatalogValue(self)
      if default_catalog is not None and my_catalog is not None \
             and catalog_method is not None and self.getTemplateFormatVersion() == 1:
        if default_catalog.getId() == my_catalog.getId():
          # It is needed to update the catalog only if the default SQLCatalog is modified.
          for method_id in catalog_method._objects.keys():
            if 'related' not in method_id:
              # must update catalog
              return True
5031 5032
      return False

5033
    def preinstall(self, check_dependencies=1, **kw):
5034 5035 5036
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
5037
      """
5038 5039 5040 5041 5042
      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()
5043

5044 5045
      modified_object_list = {}
      bt_title = self.getTitle()
5046 5047 5048 5049 5050 5051 5052

      #  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)
5053 5054 5055
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5056
        installed_bt_format = installed_bt.getTemplateFormatVersion()
5057

5058
      # if reinstall business template, must compare to object in ZODB
5059
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
5060
      # same if we make a diff and select only one business template
5061
      reinstall = 0
5062 5063
      if installed_bt == self:
        reinstall = 1
5064
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
5065 5066
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                   id=INSTALLED_BT_FOR_DIFF)
5067 5068 5069 5070 5071 5072 5073
          # 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)
5074

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5075
      new_bt_format = self.getTemplateFormatVersion()
5076 5077 5078 5079 5080 5081
      if installed_bt_format == 0 and new_bt_format == 0:
        # still use old format, so install everything, no choice
        return modified_object_list
      elif installed_bt_format == 0 and new_bt_format == 1:
        # return list of all object in bt
        for item_name in self._item_name_list:
5082
          item = getattr(self, item_name, None)
5083 5084 5085 5086
          if item is not None:
            for path in item._objects.keys():
              modified_object_list.update({path : ['New', item.__class__.__name__[:-12]]})
        return modified_object_list
5087

5088
      for item_name in self._item_name_list:
5089
        new_item = getattr(self, item_name, None)
5090
        installed_item = getattr(installed_bt, item_name, None)
5091
        if new_item is not None:
5092
          if installed_item is not None and hasattr(installed_item, '_objects'):
5093
            modified_object = new_item.preinstall(context=self, 
5094 5095
                                                  installed_item=installed_item,
                                                  installed_bt=installed_bt)
5096 5097 5098 5099 5100 5101 5102
            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:
5103
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5104

5105 5106
      return modified_object_list

5107
    def _install(self, force=1, object_to_update=None, update_translation=0,
5108
                 update_catalog=_MARKER, **kw):
5109
      """
Christophe Dumez's avatar
Christophe Dumez committed
5110
        Install a new Business Template, if force, all will be upgraded or installed
5111 5112
        otherwise depends of dict object_to_update
      """
5113 5114 5115 5116
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
5117

5118 5119
      site = self.getPortalObject()
      installed_bt = site.portal_templates.getInstalledBusinessTemplate(
5120
                                                           self.getTitle())
5121 5122
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5123
        if installed_bt.getTemplateFormatVersion() == 0:
5124
          force = 1
5125 5126 5127
        if site.portal_workflow.isTransitionPossible(
            installed_bt, 'replace'):
          installed_bt.replace(self)
5128

5129
      trash_tool = getToolByName(site, 'portal_trash', None)
5130 5131 5132
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

5133 5134 5135
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
5136

5137 5138 5139
      if not force:
        self.checkDependencies()

5140 5141
      # 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
5142
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 2):
5143 5144 5145 5146 5147
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
5148
      if len(object_to_update) or force:
5149 5150 5151
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
5152 5153
            item.install(self, force=force, object_to_update=object_to_update, 
                               trashbin=trashbin, installed_bt=installed_bt)
5154

5155
      # update catalog if necessary
5156 5157 5158
      if update_catalog is _MARKER and force and self.isCatalogUpdatable():
        # override update_catalog parameter only if value
        # is not explicitely passed.
5159
        update_catalog = 1
5160
      elif update_catalog is _MARKER:
5161
        update_catalog = 0
5162
      if update_catalog:
5163
        catalog = _getCatalogValue(self)
5164
        if (catalog is None) or (not site.isIndexable):
5165 5166 5167 5168 5169
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
5170

5171
      # get objects to remove
5172
      # do remove after because we may need backup object from installation
5173
      remove_object_dict = {}
5174 5175
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
5176
          remove_object_dict[path] = action
5177

5178
      # remove object from old business template
5179
      if len(remove_object_dict):
5180
        # XXX: this code assumes that there is an installed_bt
5181
        for item_name in reversed(installed_bt._item_name_list):
5182
          item = getattr(installed_bt, item_name, None)
5183
          if item is not None:
5184
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
5185

5186 5187

      # update tools if necessary
5188 5189 5190 5191 5192
      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)
5193

5194 5195
      # remove trashbin if empty
      if trashbin is not None:
5196
        if len(trashbin) == 0:
5197 5198
          trash_tool.manage_delObjects([trashbin.getId(),])

5199 5200
      if update_catalog:
        site.ERP5Site_reindexAll()
5201

5202 5203
      # Update translation table, in case we added new portal types or
      # workflow states.
5204 5205
      if update_translation:
        site.ERP5Site_updateTranslationTable()
5206

5207 5208
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
5209

5210
    security.declareProtected(Permissions.ManagePortal, 'install')
5211
    install = _install
5212

5213
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
5214
    reinstall = _install
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5215

5216
    security.declareProtected(Permissions.ManagePortal, 'trash')
5217 5218
    def trash(self, new_bt, **kw):
      """
5219
        Trash unnecessary items before upgrading to a new business
5220
        template.
5221
        This is similar to uninstall, but different in that this does
5222
        not remove all items.
5223
      """
5224 5225
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5226
        item = getattr(self, item_name, None)
5227 5228
        if item is not None:
          item.trash(
5229
                self,
5230
                getattr(new_bt, item_name))
5231

5232
    def _uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5233
      """
5234
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5235
      """
5236 5237 5238
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5239
        item = getattr(self, item_name, None)
5240
        if item is not None:
5241
          item.uninstall(self, **kw)
5242
      # It is better to clear cache because the uninstallation of a
5243
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
5244
      self.getPortalObject().portal_caches.clearAllCache()
5245

5246 5247
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
    uninstall = _uninstall
5248

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5249
    def _clean(self):
5250
      """
5251
        Clean built information.
5252
      """
5253
      # First, remove obsolete attributes if present.
5254 5255 5256 5257
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
5258
                    '_module_archive',
5259 5260 5261
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
5262
                    '_property_sheet_archive'):
5263 5264 5265
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
5266
      for item_name in self._item_name_list:
5267
        setattr(self, item_name, None)
5268

5269 5270
    security.declareProtected(Permissions.ManagePortal, 'clean')
    clean = _clean
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5271

5272
    security.declareProtected(Permissions.AccessContentsInformation,
5273
                              'getBuildingState')
5274
    def getBuildingState(self, default=None, id_only=1):
5275
      """
5276
        Returns the current state in building
5277
      """
5278
      portal_workflow = getToolByName(self, 'portal_workflow')
5279 5280
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
5281
      return wf._getWorkflowStateOf(self, id_only=id_only )
5282

5283
    security.declareProtected(Permissions.AccessContentsInformation,
5284
                              'getInstallationState')
5285
    def getInstallationState(self, default=None, id_only=1):
5286
      """
5287
        Returns the current state in installation
5288
      """
5289
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
5290 5291
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
5292
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5293

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5294 5295 5296 5297 5298 5299
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
5300
      export_string = portal_templates.manage_exportObject(
5301 5302
                                               id=self.getId(),
                                               toxml=1,
5303
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5304
      return export_string
5305

5306
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5307
      """
5308 5309
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5310
      """
5311 5312
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
5313 5314 5315 5316
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
5317
        # XXX Why do we need to return a tuple ?
5318 5319
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5320

5321
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5322
      """
5323 5324
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5325
      """
5326
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5327

5328
    def getTemplateBaseCategoryList(self):
5329
      """
5330 5331
      We have to set this method because we want an
      ordered list
5332
      """
5333
      return self._getOrderedList('template_base_category')
5334

5335
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5336
      """
5337 5338
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5339
      """
5340
      return self._getOrderedList('template_workflow_id')
5341

5342
    def getTemplatePortalTypeIdList(self):
5343
      """
5344 5345
      We have to set this method because we want an
      ordered list
5346
      """
5347
      return self._getOrderedList('template_portal_type_id')
5348

5349 5350 5351 5352 5353 5354 5355
    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
5356 5357 5358 5359 5360 5361 5362
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

5363 5364 5365 5366 5367 5368 5369
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

5370 5371 5372 5373 5374 5375
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
5376

5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397
    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')

5398
    def getTemplateActionPathList(self):
5399
      """
5400 5401
      We have to set this method because we want an
      ordered list
5402
      """
5403
      return self._getOrderedList('template_action_path')
5404

5405
    def getTemplatePortalTypeRoleList(self):
5406 5407 5408 5409
      """
      We have to set this method because we want an
      ordered list
      """
5410
      return self._getOrderedList('template_portal_type_role')
5411

5412
    def getTemplateLocalRoleList(self):
5413 5414 5415 5416
      """
      We have to set this method because we want an
      ordered list
      """
5417
      return self._getOrderedList('template_local_role')
5418

5419
    def getTemplateSkinIdList(self):
5420
      """
5421 5422
      We have to set this method because we want an
      ordered list
5423
      """
5424
      return self._getOrderedList('template_skin_id')
5425

5426 5427 5428 5429 5430 5431 5432
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

5433 5434 5435 5436 5437
    def getTemplateRegisteredVersionPrioritySelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
5438 5439 5440 5441 5442 5443
      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 ()
5444

5445
    def getTemplateModuleIdList(self):
5446
      """
5447 5448
      We have to set this method because we want an
      ordered list
5449
      """
5450
      return self._getOrderedList('template_module_id')
5451 5452 5453 5454 5455 5456 5457

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5459 5460 5461 5462 5463 5464 5465
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489
    def isKeepObject(self, path):
      """
      Return True if path is included in keep object list.
      """
      keep_list = self.getTemplateKeepPathList()
      for keep_path in keep_list:
        if keep_path.endswith('**') and path.startswith(keep_path[:-2]):
          return True
        elif path == keep_path:
          return True
      return False

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

5490 5491 5492 5493 5494 5495
    def getExportPath(self):
      preferences = self.getPortalObject().portal_preferences
      bt_name = self.getTitle()
      from App.config import getConfiguration
      instance_home = getConfiguration().instancehome
      for path in (preferences.getPreferredWorkingCopyList() or # BBB
5496
                   preferences.getPreferredSubversionWorkingCopyList() or ['bt5']):
5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507
        if not os.path.isabs(path):
          path = os.path.join(instance_home, path)
        bt_path = os.path.join(path, bt_name)
        if os.path.isdir(bt_path):
          return bt_path
        for bt_path in glob.glob(os.path.join(path, '*', bt_name)):
          if os.path.isdir(bt_path):
            return bt_path

    @transactional_cached(lambda self, vcs=None, path=None: (self, vcs, path))
    def getVcsTool(self, vcs=None, path=None):
5508
      from Products.ERP5VCS.WorkingCopy import getVcsTool
5509 5510 5511 5512 5513 5514
      if not (path or vcs):
        path = self.getExportPath()
      return getVcsTool(vcs=vcs, path=path).__of__(self)

    def isVcsType(self, *vcs):
      # could be moved to Products.ERP5.Base.Base
5515
      from Products.ERP5VCS.WorkingCopy import NotAWorkingCopyError
5516 5517 5518 5519 5520
      try:
        return self.getVcsTool().reference in vcs
      except NotAWorkingCopyError:
        return None in vcs

5521
    security.declareProtected(Permissions.ManagePortal, 'export')
5522
    def export(self, path=None, local=0, bta=None, **kw):
Aurel's avatar
Aurel committed
5523 5524 5525
      """
        Export this Business Template
      """
5526
      if self.getBuildingState() != 'built':
5527
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5528
              'Business Template must be built before export'
5529

5530 5531 5532 5533 5534 5535 5536 5537 5538
      if bta is None:
        if local:
          # we export into a folder tree
          bta = BusinessTemplateFolder(creation=1, path=path)
        else:
          # We export BT into a tarball file
          if path is None:
            path = self.getTitle()
          bta = BusinessTemplateTarball(creation=1, path=path)
Aurel's avatar
Aurel committed
5539

5540
      # export bt
Aurel's avatar
Aurel committed
5541
      for prop in self.propertyMap():
5542
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5543
        id = prop['id']
5544
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5545
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5546
          continue
Aurel's avatar
Aurel committed
5547
        value = self.getProperty(id)
5548
        if not value:
5549
          continue
5550
        if prop_type in ('text', 'string', 'int', 'boolean'):
5551
          bta.addObject(str(value), name=id, path='bt', ext='')
5552
        elif prop_type in ('lines', 'tokens'):
5553
          bta.addObject('\n'.join(value), name=id, path='bt', ext='')
5554

Aurel's avatar
Aurel committed
5555 5556 5557
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5558

5559
      return bta.finishCreation()
Aurel's avatar
Aurel committed
5560

5561
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5562 5563
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5564
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5565 5566 5567 5568 5569
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
5570 5571

      self.storeTemplateItemData()
5572

5573 5574
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5575 5576
      # XXX This is not required with portal types as classes.
      #     It is still there for compatibility with non-migrated objects.
5577
      module_id_list = []
5578
      for template_id in self.getTemplateDocumentIdList():
5579 5580 5581
        module_id = 'Products.ERP5Type.Document.' + template_id
        if module_id not in sys.modules:
          module_id_list.append(module_id)
5582
          sys.modules[module_id] = module = imp.new_module(module_id)
5583 5584
          setattr(module, template_id, type(template_id,
            (SimpleItem.SimpleItem,), {'__module__': module_id}))
5585

Aurel's avatar
Aurel committed
5586 5587
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5588

5589 5590
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5591 5592
      for module_id in module_id_list:
        del sys.modules[module_id]
5593

5594 5595 5596 5597 5598
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5599 5600 5601
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5602
      return items_list
5603

5604 5605 5606 5607 5608 5609
    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
      """
5610 5611 5612 5613 5614 5615 5616 5617
      missing_dep_list = self.getMissingDependencyList()
      if len(missing_dep_list) != 0:
        raise BusinessTemplateMissingDependency, 'Impossible to install, please install the following dependencies before: %s'%repr(missing_dep_list)

    def getMissingDependencyList(self):
      """
      Retuns a list of missing dependencies.
      """
5618 5619
      missing_dep_list = []
      dependency_list = self.getDependencyList()
5620
      if len(dependency_list) > 0:
5621
        for dependency_couple in dependency_list:
5622
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5623
          dependency = dependency_couple_list[0]
5624 5625
          if dependency in (None, ''):
            continue
5626 5627
          version_restriction = None
          if len(dependency_couple_list) > 1:
5628
            version_restriction = dependency_couple_list[1]
5629 5630 5631
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5632 5633 5634
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5635
                  or (version_restriction not in (None, '') and
5636 5637
                     (not self.portal_templates.compareVersionStrings(installed_bt.getVersion(), version_restriction)))):
            missing_dep_list.append((dependency, version_restriction or ''))
5638
      return [' '.join([y for y in x if y]) for x in missing_dep_list]
5639

5640 5641 5642
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
5643
        This is compatible with ERP5VCS look and feel but
5644 5645 5646 5647
        it is preferred in future we use more difflib python library.
      """
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

Aurel's avatar
Aurel committed
5648
    def diffObject(self, REQUEST, **kw):
5649 5650
      """
        Make a diff between an object in the Business Template
5651
        and the same in the Business Template installed in the site
5652 5653 5654 5655
      """

      class_name_dict = {
        'Product' : '_product_item',
5656
        'PropertySheet' : '_property_sheet_item',
5657
        'Constraint' : '_constraint_item',
5658 5659 5660 5661 5662 5663 5664 5665 5666
        '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',
5667
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5668 5669 5670 5671
        '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',
5672 5673 5674
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5675
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5676
        'Path' : '_path_item',
5677
        'Preference' : '_preference_item',
5678
        'Action' : '_action_item',
5679
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5680
        'LocalRoles' : '_local_roles_item',
5681 5682 5683
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5684
        'CatalogSearchKey' : '_catalog_search_key_item',
5685
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5686
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5687 5688 5689 5690
        '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
5691
        'Tool': '_tool_item',
5692
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5693 5694
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5695
        'CatalogSecurityUidColumn' : '_catalog_security_uid_column_item',
5696
        }
5697

5698 5699
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5700

Christophe Dumez's avatar
Christophe Dumez committed
5701
      # Get objects
5702
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5703

5704
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
5705
      # Compare with a given business template
5706
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5707 5708
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5709 5710
        if bt2_id == self.getId():
          compare_to_zodb = 1
5711
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5712 5713
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5714 5715 5716
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5717 5718
          compare_to_zodb = 1
      if compare_to_zodb:
5719 5720
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5721
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5722 5723 5724
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5725

5726 5727
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5728
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5729
        # XXX maybe only build for the given object to gain time
5730
        installed_item.build(self)
5731 5732 5733
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5734

Christophe Dumez's avatar
Christophe Dumez committed
5735
      # Real Zope Objects (can be exported into XML directly by Zope)
5736 5737
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5738
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5739
                     '_skin_item', '_action_item', '_tool_item', ]
5740

Christophe Dumez's avatar
Christophe Dumez committed
5741
      # Not considered as objects by Zope (will be exported into XML manually)
5742
      # XXX Bad naming
5743 5744 5745 5746
      item_list_2 = ['_site_property_item',
                     '_module_item',
                     '_catalog_result_key_item', 
                     '_catalog_related_key_item',
5747
                     '_catalog_result_table_item',
5748
                     '_catalog_search_key_item',
5749
                     '_catalog_keyword_key_item',
5750
                     '_catalog_datetime_key_item',
5751 5752 5753 5754
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5755
                     '_catalog_scriptable_key_item',
5756 5757
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5758
                     '_catalog_security_uid_column_item',
5759 5760 5761 5762 5763 5764
                     '_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',
5765
                     '_portal_type_workflow_chain_item',]
5766

Christophe Dumez's avatar
Christophe Dumez committed
5767
      # Text objects (no need to export them into XML)
5768
      # XXX Bad naming
5769 5770
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5771
                     '_test_item', '_message_translation_item',]
5772

5773
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5774 5775 5776
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5777 5778
        new_object = new_item.removeProperties(new_object, 1)
        installed_object = installed_item.removeProperties(installed_object, 1)
5779
        # XML Export in memory
5780
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5781 5782
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5783
        new_obj_xml = f1.getvalue()
5784
        f1.close()
5785 5786 5787 5788
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5789
        # End of XML export
5790

5791
        # Diff between XML objects
5792 5793
        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
5794
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5795 5796 5797
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5798

5799
      elif item_name in item_list_2:
5800
        # Generate XML code manually
5801 5802
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5803 5804
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5805
        # End of XML Code Generation
5806

5807
        # Diff between XML objects
5808 5809
        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
5810
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5811 5812 5813
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5814

5815
      elif item_name in item_list_3:
5816
        # Diff between text objects
5817 5818 5819 5820
        new_obj_lines = new_object.splitlines()
        installed_obj_lines = installed_object.splitlines()
        diff_list = list(unified_diff(installed_obj_lines, new_obj_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
Christophe Dumez's avatar
Christophe Dumez committed
5821
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5822 5823
          diff_msg += '\n'.join(diff_list)
        else:
5824
          diff_msg = 'No diff'
5825

5826
      else:
5827
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5828

5829
      if compare_to_zodb:
5830
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5831

5832
      return diff_msg
5833

5834

5835 5836 5837 5838
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5839 5840
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5841 5842 5843 5844 5845 5846 5847
      bt_allowed_content_type_list = list(getattr(self, 'template_portal_type_allowed_content_type', []) or [])
      bt_hidden_content_type_list = list(getattr(self, 'template_portal_type_hidden_content_type', []) or [])
      bt_property_sheet_list = list(getattr(self, 'template_portal_type_property_sheet', []) or [])
      bt_base_category_list = list(getattr(self, 'template_portal_type_base_category', []) or [])
      bt_action_list = list(getattr(self, 'template_action_path', []) or [])
      bt_portal_types_id_list = list(self.getTemplatePortalTypeIdList())
      bt_portal_type_roles_list =  list(getattr(self, 'template_portal_type_roles', []) or [])
5848 5849
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5850
      for id in bt_portal_types_id_list:
5851 5852
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5853
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5854
        if portal_type.getRoleInformationList():
5855 5856
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5857

5858 5859 5860 5861
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5862
        action_list = []
5863 5864 5865 5866 5867 5868 5869
        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'):
5870
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5871 5872
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5873

5874 5875 5876 5877
        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)
5878

5879
        for h_id in hidden_content_type_list:
5880 5881 5882
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5883

5884 5885 5886 5887
        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)
5888

5889 5890 5891 5892
        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)
5893

5894 5895 5896 5897
        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)
5898

5899
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5900
                                    if chain != '(Default)']:
5901 5902 5903
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5904

5905 5906 5907 5908
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5909
      bt_action_list.sort()
5910
      bt_wf_chain_list.sort()
5911

5912 5913 5914 5915 5916 5917 5918
      self.setProperty('template_portal_type_workflow_chain', bt_wf_chain_list)
      self.setProperty('template_portal_type_roles', bt_portal_type_roles_list)
      self.setProperty('template_portal_type_allowed_content_type', bt_allowed_content_type_list)
      self.setProperty('template_portal_type_hidden_content_type', bt_hidden_content_type_list)
      self.setProperty('template_portal_type_property_sheet', bt_property_sheet_list)
      self.setProperty('template_portal_type_base_category', bt_base_category_list)
      self.setProperty('template_action_path', bt_action_list)
5919 5920 5921 5922 5923 5924 5925 5926 5927
      return


    def guessPortalTypes(self, **kw):
      """
      This method guesses portal types based on modules define in the Business Template
      """
      bt_module_id_list = list(self.getTemplateModuleIdList())
      if len(bt_module_id_list) == 0:
5928 5929
        raise TemplateConditionError, 'No module defined in business template'

5930 5931 5932 5933 5934 5935 5936 5937
      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:
5938
          return type_list
5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952

        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():
5953
            type_list.update(getChildPortalType(hidden_ptype_id))
5954
        return type_list
5955

5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002
      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

6003 6004 6005
    security.declareProtected(Permissions.ManagePortal,
                              'migrateSourceCodeFromFilesystem')
    def migrateSourceCodeFromFilesystem(self,
6006
                                        component_portal_type_dict,
6007 6008
                                        erase_existing=False,
                                        **kw):
6009 6010 6011 6012 6013
      """
      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
      """
6014 6015 6016
      if not component_portal_type_dict:
        return {}

6017 6018
      component_tool = self.getPortalObject().portal_components
      failed_import_dict = {}
6019 6020 6021 6022 6023
      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,
6024
                                                       reference,
6025
                                                       version,
6026
                                                       erase_existing)
6027 6028 6029 6030
          except Exception, e:
            failed_import_dict[reference] = str(e)
          else:
            migrated_id_list.append(obj.getId())
6031

6032 6033
        if migrated_id_list:
          template_id_list_method(migrated_id_list)
6034

6035 6036 6037 6038
      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)
6039

6040 6041 6042 6043
      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)
6044

6045 6046 6047 6048
      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)
6049

6050
      return failed_import_dict
6051

6052 6053 6054
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
6055
  setattr(BusinessTemplate, key, None)