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, imp, os, re, shutil, sys
31
from Shared.DC.ZRDB.Connection import Connection as RDBConnection
32
from Products.ERP5Type.DiffUtils import DiffFile
33
from Products.ERP5Type.Globals import Persistent, PersistentMapping
34
from Acquisition import Implicit, aq_base, aq_inner, aq_parent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35 36
from AccessControl import ClassSecurityInfo
from Products.CMFCore.utils import getToolByName
37
from Products.ERP5Type.Accessor.Constant import PropertyGetter as ConstantGetter
38
from Products.ERP5Type.Base import WorkflowMethod, _aq_reset
Nicolas Dumazet's avatar
Nicolas Dumazet committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
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
57
from Products.ERP5Type.Utils import convertToUpperCase
58
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
59
from Products.ERP5Type.XMLObject import XMLObject
Aurel's avatar
Aurel committed
60
from OFS.Traversable import NotFound
61
from OFS import SimpleItem, XMLExportImport
62
from cStringIO import StringIO
Aurel's avatar
Aurel committed
63
from copy import deepcopy
64
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
65
import OFS.XMLExportImport
66
from Products.ERP5Type.patches.ppml import importXML
Aurel's avatar
Aurel committed
67
customImporters={
68
    XMLExportImport.magic: importXML,
Aurel's avatar
Aurel committed
69
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
70

71
from zLOG import LOG, WARNING
72
from warnings import warn
Aurel's avatar
Aurel committed
73
from gzip import GzipFile
74
from lxml.etree import parse
75
from xml.sax.saxutils import escape
76
from Products.CMFCore.Expression import Expression
77
from Products.ERP5Type import tarfile
78
from urllib import quote, unquote
79
from difflib import unified_diff
80
import posixpath
Julien Muchembled's avatar
Julien Muchembled committed
81
import transaction
82

83 84 85 86 87 88
import threading

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

96 97
# those attributes from CatalogMethodTemplateItem are kept for
# backward compatibility
Aurel's avatar
Aurel committed
98 99
catalog_method_list = ('_is_catalog_list_method_archive',
                       '_is_uncatalog_method_archive',
100 101
                       '_is_clear_method_archive',
                       '_is_filtered_archive',)
102

103 104
catalog_method_filter_list = ('_filter_expression_archive',
                              '_filter_expression_instance_archive',
105
                              '_filter_expression_cache_key_archive',
106
                              '_filter_type_archive',)
107

108
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'
109
_MARKER = []
110

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

140 141 142 143 144
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.
  """
145 146
  if hasattr(aq_base(obj), 'uid'):
    obj.uid = None
147 148 149
  for subobj in obj.objectValues():
    _recursiveRemoveUid(subobj)

150
def removeAll(entry):
151 152 153
  warn('removeAll is deprecated; use shutil.rmtree instead.',
       DeprecationWarning)
  shutil.rmtree(entry, True)
Aurel's avatar
Aurel committed
154

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

184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
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]

199 200
def registerSkinFolder(skin_tool, skin_folder):
  request = skin_tool.REQUEST
201 202 203
  # 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)
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
  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()

219 220 221
  if isinstance(skin_selection_list, basestring):
    skin_selection_list = skin_selection_list.split()

222 223 224 225 226 227 228
  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

229 230 231 232 233 234 235 236 237
  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 ''
238
    selection_list = selection.split(',')
239
    if (skin_folder_id not in selection_list):
240
      selection_list.insert(0, skin_folder_id)
241
    if reorder_skin_selection:
242 243
      # Sort by skin priority and ID
      selection_list.sort(key=skin_sort_key)
244
    if (skin_name in skin_layer_list):
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
      skin_tool.manage_skinLayers(skinpath=selection_list,
                                  skinname=skin_name, add_skin=1)
      skin_tool.getPortalObject().changeSkin(None)

def createSkinSelection(skin_tool, skin_name):
  # This skin selection does not exist, so we create a new one.
  # We'll initialize it with all skin folders, unless:
  #  - they explictly define a list of
  #    "business_template_registered_skin_selections", and we
  #    are not in this list.
  #  - they are not registred in the default skin selection
  skin_path = ''
  for skin_folder in skin_tool.objectValues():
    if skin_name in skin_folder.getProperty(
             'business_template_registered_skin_selections',
             (skin_name, )):
      if skin_folder.getId() in \
          skin_tool.getSkinPath(skin_tool.getDefaultSkin()):
        if skin_path:
          skin_path = '%s,%s' % (skin_path, skin_folder.getId())
        else:
          skin_path= skin_folder.getId()
  # add newly created skins to list of skins we care for 
  skin_tool.addSkinSelection(skin_name, skin_path)
  skin_tool.getPortalObject().changeSkin(None)

def deleteSkinSelection(skin_tool, skin_name):
  # Do not delete default skin
  if skin_tool.getDefaultSkin() != skin_name:

    skin_selection_registered = False
    for skin_folder in skin_tool.objectValues():
      try:
        skin_selection_list = skin_folder.getProperty(
               'business_template_registered_skin_selections', ())
        if skin_name in skin_selection_list:
          skin_selection_registered = True
          break
      except AttributeError:
        pass

    if (not skin_selection_registered):
      skin_tool.manage_skinLayers(chosen=[skin_name], 
                                  del_skin=1)
      skin_tool.getPortalObject().changeSkin(None)

def unregisterSkinFolder(skin_tool, skin_folder, skin_selection_list):
  skin_folder_id = skin_folder.getId()

  for skin_selection in skin_selection_list:
    selection = skin_tool.getSkinPath(skin_selection)
    selection = selection.split(',')
    if (skin_folder_id in selection):
      selection.remove(skin_folder_id)
      skin_tool.manage_skinLayers(skinpath=tuple(selection),
                                  skinname=skin_selection, add_skin=1)
      deleteSkinSelection(skin_tool, skin_selection)
      skin_tool.getPortalObject().changeSkin(None)

Aurel's avatar
Aurel committed
304 305 306
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
307
  """
Aurel's avatar
Aurel committed
308 309 310 311 312 313 314 315 316 317 318 319

  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)

  def addFolder(self, **kw):
    pass

  def addObject(self, *kw):
    pass
320

321
  def finishCreation(self, name=None, **kw):
Aurel's avatar
Aurel committed
322 323 324 325
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
326
    Class archiving business template into a folder tree
327
  """
Aurel's avatar
Aurel committed
328 329 330 331 332 333
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
334
      shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
335 336 337
      os.makedirs(self.path)

  def addFolder(self, name=''):
Jérome Perrin's avatar
Jérome Perrin committed
338
    if name != '':
339
      name = os.path.normpath(name)
Aurel's avatar
Aurel committed
340
      path = os.path.join(self.path, name)
341
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
342 343 344
        os.makedirs(path)
      return path

345
  def addObject(self, obj, name, path=None, ext='.xml'):
346 347 348
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
349 350 351
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
352
      if '%' not in path:
353 354 355 356
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
Aurel's avatar
Aurel committed
357
      object_path = os.path.join(path, name)
358
    f = open(object_path+ext, 'wb')
359 360 361 362
    try:
      f.write(str(obj))
    finally:
      f.close()
Aurel's avatar
Aurel committed
363 364

  def _initImport(self, file=None, path=None, **kw):
365
    # Normalize the paths to eliminate the effect of double-slashes.
366 367 368 369 370 371 372 373
    root_path_len = len(os.path.normpath(path)) + len(os.sep)
    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
374

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

Aurel's avatar
Aurel committed
403 404 405 406 407 408
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
409
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
410 411 412 413 414
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
415
      shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
416 417 418 419 420 421
      os.makedirs(self.path)
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)

  def addFolder(self, name=''):
422
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
423
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
424 425
      os.makedirs(name)

426
  def addObject(self, obj, name, path=None, ext='.xml'):
427 428 429
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
430 431 432
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
433
      if '%' not in path:
434 435 436 437
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
Aurel's avatar
Aurel committed
438
      object_path = os.path.join(path, name)
439
    f = open(object_path+ext, 'wb')
440 441 442 443
    try:
      f.write(str(obj))
    finally:
      f.close()
Aurel's avatar
Aurel committed
444

445 446
  def finishCreation(self, name):
    self.tar.add(name)
Aurel's avatar
Aurel committed
447
    self.tar.close()
448
    shutil.rmtree(name)
Aurel's avatar
Aurel committed
449 450 451 452 453
    return self.fobj

  def _initImport(self, file=None, **kw):
    self.f = file

454
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
455 456
    """
      Import all file from the archive to the site
457
    """
458
    class_name = item.__class__.__name__
Aurel's avatar
Aurel committed
459 460 461 462 463
    self.f.seek(0)
    data = GzipFile(fileobj=self.f).read()
    io = StringIO(data)
    tar = tarfile.TarFile(fileobj=io)
    for info in tar.getmembers():
Yoshinori Okuji's avatar
Yoshinori Okuji committed
464 465
      if 'CVS' in info.name.split('/'):
        continue
Yoshinori Okuji's avatar
Yoshinori Okuji committed
466 467
      if '.svn' in info.name.split('/'):
        continue
468
      if class_name in info.name.split('/'):
Aurel's avatar
Aurel committed
469 470
        if info.isreg():
          file = tar.extractfile(info)
471 472
          tar_file_name = info.name.startswith('./') and info.name[2:] or \
              info.name
473
          folders = tar_file_name.split('/')
474
          file_name = ('/').join(folders[2:])
475
          if '%' in file_name:
476
            file_name = unquote(file_name)
477
          item._importFile(file_name, file)
Aurel's avatar
Aurel committed
478 479 480
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
481

482
class TemplateConditionError(Exception): pass
483
class TemplateConflictError(Exception): pass
484
class BusinessTemplateMissingDependency(Exception): pass
485

486
class BaseTemplateItem(Implicit, Persistent):
487
  """
488
    This class is the base class for all template items.
489
    is_bt_for_diff means This BT is used to compare self temporary BT with installed BT
490
  """
491
  is_bt_for_diff = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
492

493
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
494
    self.__dict__.update(kw)
495
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
496
    self._objects = PersistentMapping()
497
    for id in id_list:
498 499
      if id is not None and id != '':
        self._archive[id] = None
500 501 502 503

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

504
  def preinstall(self, context, installed_item, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
505 506
    """
      Build a list of added/removed/changed files between the BusinessTemplate
507
      being installed (self) and the installed one (installed_item).
Vincent Pelletier's avatar
Vincent Pelletier committed
508 509 510 511 512
      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
513 514
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
515
      new_keys = self._objects.keys()
516
      for path in new_keys:
517
        if installed_item._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
518
          # compare objects to see it there are changes
519
          new_obj_xml = self.generateXml(path=path)
520
          old_obj_xml = installed_item.generateXml(path=path)
521 522
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
523
          # else, compared versions are identical, don't overwrite the old one
524 525
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
526
      # list removed objects
527
      old_keys = installed_item._objects.keys()
528 529 530 531 532 533
      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):
534
    pass
535 536 537

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

539
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
540 541 542 543 544 545
    """
      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.
    """
546 547 548
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
549
    keys.reverse()
550 551 552 553 554 555 556 557 558 559 560
    # 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)
561 562 563 564
        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
565

566

567 568 569 570
  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
571
  def export(self, context, bta, **kw):
572
    pass
Aurel's avatar
Aurel committed
573

574 575
  def getKeys(self):
    return self._objects.keys()
576

Aurel's avatar
Aurel committed
577
  def importFile(self, bta, **kw):
578
    bta.importFiles(item=self)
579

580 581 582
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
583
    """
584 585 586 587 588 589 590 591 592 593 594 595 596 597
    meta_type = getattr(aq_base(obj), 'meta_type', None)

    attr_list = [ '_dav_writelocks', '_filepath', '_owner', 'uid',
                  'workflow_history', '__ac_local_roles__' ]
    attr_list += {
        'Script (Python)': ('_lazy_compilation', 'Python_magic'),
      }.get(meta_type, ())

    for attr in attr_list:
      if attr in obj.__dict__:
        delattr(obj, attr)

    if meta_type == 'ERP5 PDF Form':
      if not obj.getProperty('business_template_include_content', 1):
598
        obj.deletePdfContent()
599 600
    elif meta_type == 'Script (Python)':
      obj._code = None
601 602 603 604
    elif  interfaces.IIdGenerator.providedBy(obj):
      for dict_name in ('last_max_id_dict', 'last_id_dict'):
        if getattr(obj, dict_name, None) is not None:
          setattr(obj, dict_name, None)
605 606
    return obj

607 608 609 610 611 612 613 614 615
  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]

616 617 618
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
619
  """
620

621 622 623 624
  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()
625
      self._archive.clear()
626 627 628
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
629

630
  def export(self, context, bta, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
631 632 633 634
    """
      Export the business template : fill the BusinessTemplateArchive with
      objects exported as XML, hierarchicaly organised.
    """
635 636 637
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
Vincent Pelletier's avatar
Vincent Pelletier committed
638
    for key, obj in self._objects.iteritems():
639
      # create folder and subfolders
640
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
641 642 643
      encode_folders = []
      for folder in folders.split('/'):
        if '%' not in folder:
644
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
645 646 647
        else:
          encode_folders.append(folder)
      path = os.path.join(root_path, (os.sep).join(encode_folders))
648 649
      bta.addFolder(name=path)
      # export object in xml
650
      f = StringIO()
651 652
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
653

Aurel's avatar
Aurel committed
654
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
655
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
656 657 658
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
659
      relative_url = '/'.join([url,id])
660 661
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
662
      obj = self.removeProperties(obj)
Vincent Pelletier's avatar
Vincent Pelletier committed
663 664 665
      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
666
        groups = deepcopy(obj.groups)
667
      if id_list:
Aurel's avatar
Aurel committed
668
        self.build_sub_objects(context, id_list, relative_url)
669
        for id_ in list(id_list):
670
          obj._delObject(id_)
671
      if hasattr(aq_base(obj), 'groups'):
672 673 674
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
675 676
    return sub_list

677 678 679 680
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
681 682 683 684
      try:
        obj = p.unrestrictedTraverse(relative_url)
      except ValueError:
        raise ValueError, "Can not access to %s" % relative_url
685 686 687 688
      try:
        obj = obj._getCopy(context)
      except AttributeError:
        raise AttributeError, "Could not find object '%s' during business template processing." % relative_url
689
      _recursiveRemoveUid(obj)
690
      obj = self.removeProperties(obj)
691
      id_list = obj.objectIds()
Vincent Pelletier's avatar
Vincent Pelletier committed
692 693
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
694
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
695 696
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
697
        for id_ in list(id_list):
698
          obj._delObject(id_)
699
      if hasattr(aq_base(obj), 'groups'):
700 701 702
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
703

704
  def _compileXML(self, file):
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 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
    # This method converts XML to ZEXP. Because the conversion
    # is quite heavy, a persistent cache database is used to
    # store ZEXP, so the second run wouldn't have to re-generate
    # identical data again.
    #
    # For now, a pair of the path to an XML file and its modification time
    # are used as a unique key. In theory, a checksum of the content could
    # be used instead, and it could be more reliable, as modification time
    # might not be updated in some insane filesystems correctly. However,
    # in practice, checksums consume a lot of CPU time, so when the cache
    # does not hit, the increased overhead is significant. In addition, it
    # does rarely happen that two XML files in Business Templates contain
    # the same data, so it may not be expected to have more cache hits
    # with this approach.
    #
    # The disadvantage is that this wouldn't work with the archive format,
    # because each entry in an archive does not have a mtime in itself.
    # However, the plan is to have an archive to retain ZEXP directly
    # instead of XML, so the idea of caching would be completely useless
    # with the archive format.
    name = file.name
    mtime = os.path.getmtime(file.name)
    key = '%s:%s' % (name, mtime)

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

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

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

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

765
  def _importFile(self, file_name, file_obj):
766
    # import xml file
767
    if not file_name.endswith('.xml'):
768
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
769
      return
770 771 772 773 774
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
775
    __traceback_info__ = 'Importing %s' % file_name
776 777
    if hasattr(cache_database, 'db') and isinstance(file_obj, file):
      obj = connection.importFile(self._compileXML(file_obj))
778
    else:
779 780
      # FIXME: Why not use the importXML function directly? Are there any BT5s
      # with actual .zexp files on the wild?
781
      obj = connection.importFile(file_obj, customImporters=customImporters)
782
    self.removeProperties(obj)
783 784
    self._objects[file_name[:-4]] = obj

785
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
786 787
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
788 789 790
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
      for path in self._objects:
791
        if installed_item._objects.has_key(path):
Julien Muchembled's avatar
Julien Muchembled committed
792
          upgrade_list.append((path,
793
            self.removeProperties(installed_item._objects[path])))
794
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
795 796 797 798 799 800 801 802 803 804
          modified_object_list[path] = 'New', type_name
      # update _p_jar property of objects cleaned by removeProperties
      transaction.savepoint(optimistic=True)
      for path, old_object in upgrade_list:
        # compare object to see it there is changes
        new_object = self._objects[path]
        new_io = StringIO()
        old_io = StringIO()
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, new_io)
        new_obj_xml = new_io.getvalue()
805 806 807 808 809
        try:
          OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
          old_obj_xml = old_io.getvalue()
        except ImportError, e: # module is already removed etc.
          old_obj_xml = '(%s: %s)' % (e.__class__.__name__, e)
Julien Muchembled's avatar
Julien Muchembled committed
810 811 812 813
        new_io.close()
        old_io.close()
        if new_obj_xml != old_obj_xml:
          modified_object_list[path] = 'Modified', type_name
814
      # get removed object
815
      for path in set(installed_item._objects) - set(self._objects):
Julien Muchembled's avatar
Julien Muchembled committed
816
        modified_object_list[path] = 'Removed', type_name
817 818
    return modified_object_list

819
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
820 821 822
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
823
    subobjects_dict = {}
824
    if trashbin is None: # must return subobjects
825 826 827 828 829 830
      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)
831
        subobjects_dict[subobject_id] = subobject_copy
832
      return subobjects_dict
833
    # XXX btsave is for backward compatibility
834
    if action == 'backup' or action == 'btsave' or action == 'save_and_remove':
835 836 837
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=1, **kw)
838
    elif action == 'install':
839 840 841
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=0, **kw)
842 843 844 845
    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
846
    return subobjects_dict
847

848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
  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

864
  def onNewObject(self, obj):
865 866 867 868
    """
      Installation hook.
      Called when installation process determined that object to install is
      new on current site (it's not replacing an existing object).
869
      `obj` parameter is the newly created object in its acquisition context.
870 871 872 873
      Can be overridden by subclasses.
    """
    pass

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

891
  def install(self, context, trashbin, **kw):
892
    self.beforeInstall()
893 894
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
895
    if context.getTemplateFormatVersion() == 1:
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
      def recurse(hook, document, prefix=''):
        my_prefix = '%s/%s' % (prefix, document.id)
        if (hook(document, my_prefix)):
          for subdocument in document.objectValues():
            recurse(hook, subdocument, my_prefix)
      def saveHook(document, prefix):
        uid = getattr(document, 'uid', None)
        if uid is None:
          return 0
        else:
          saved_uid_dict[prefix] = uid
          return 1
      def restoreHook(document, prefix):
        uid = saved_uid_dict.get(prefix)
        if uid is None:
          return 0
        else:
          document.uid = uid
          return 1
915
      groups = {}
916
      old_groups = {}
917 918 919 920
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
921 922
      # set safe activities execution order
      original_reindex_parameters = self.setSafeReindexationMode(context)
923
      for path in keys:
924 925
        if update_dict.has_key(path) or force:
          # get action for the oject
Yoshinori Okuji's avatar
Yoshinori Okuji committed
926
          action = 'backup'
927 928 929 930 931
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          # get subobjects in path
932 933 934
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
935 936 937 938
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
939
            container_url = '/'.join(container_path)
940 941 942 943
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
944
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
945 946
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
947
              container_container = portal.unrestrictedTraverse(container_path[:-1])
948 949 950 951 952
              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)
953 954
            else:
              raise
955
          saved_uid_dict = {}
956
          subobjects_dict = {}
Julien Muchembled's avatar
Julien Muchembled committed
957
          portal_type_dict = {}
958
          old_obj = container._getOb(object_id, None)
959
          object_existed = old_obj is not None
960
          if old_obj is not None:
961
            # Object already exists
962
            recurse(saveHook, old_obj)
963
            if getattr(aq_base(old_obj), 'groups', None) is not None:
964 965 966 967 968
              # 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)
969
            subobjects_dict = self._backupObject(action, trashbin,
970
                                                 container_path, object_id)
Julien Muchembled's avatar
Julien Muchembled committed
971
            # in case of portal types, we want to keep some properties
972
            if getattr(old_obj, 'meta_type', None) == 'ERP5 Base Type':
973
              for attr in ('allowed_content_types',
Julien Muchembled's avatar
Julien Muchembled committed
974 975 976 977 978 979
                           '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, '')
980
            container.manage_delObjects([object_id])
981

982
          # install object
983
          obj = self._objects[path]
984 985 986
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
987
          if getattr(aq_base(obj), 'groups', None) is not None:
988
            # we must keep original order groups
989
            # because they change when we add subobjects
990
            groups[path] = deepcopy(obj.groups)
991
          # copy the object
992 993 994 995 996 997 998
          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
999
                'Cleaning corrupted BTreeFolder2 object at %r.' % (path,))
1000
            obj._initBTrees()
1001
          obj = obj._getCopy(container)
1002 1003 1004 1005 1006
          try:
            container._setObject(object_id, obj)
          except AttributeError:
            LOG("BT, install", 0, object_id)
            raise
1007
          obj = container._getOb(object_id)
1008 1009 1010 1011 1012

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

1013 1014
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
1015
          self.REQUEST.set('is_business_template_installation', 1)
1016 1017 1018 1019
          # 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
1020
          obj.isIndexable = ConstantGetter('isIndexable', value=False)
1021
          obj.manage_afterClone(obj)
1022 1023 1024
          del obj.isIndexable
          if getattr(aq_base(obj), 'reindexObject', None) is not None:
            obj.reindexObject()
1025
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
1026
          if portal_type_dict:
1027
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
1028
            wf_chain = portal_type_dict.pop('workflow_chain')
1029 1030
            chain_dict = getChainByType(context)[1]
            default_chain = ''
1031
            chain_dict['chain_%s' % (object_id)] = wf_chain
1032
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
1033 1034
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
1035
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
1036
          if subobjects_dict:
1037
            # get a jar
1038 1039
            connection = obj._p_jar
            o = obj
1040
            while connection is None:
1041 1042
              o = o.aq_parent
              connection = o._p_jar
1043
            # import subobjects
1044
            for subobject_id, subobject_data in subobjects_dict.iteritems():
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
              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))
1056
          if obj.meta_type in ('Z SQL Method',):
1057
            fixZSQLMethod(portal, obj)
1058 1059 1060
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
1061 1062 1063
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
1064
          elif obj.meta_type in ('ERP5 Ram Cache',
1065
                                 'ERP5 Distributed Ram Cache',):
1066 1067
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
1068 1069
          elif (container.meta_type == 'CMF Skins Tool') and \
              (old_obj is not None):
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
            # 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')
1084 1085 1086 1087 1088 1089 1090 1091
          # 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)
1092

1093
          recurse(restoreHook, obj)
1094
      # now put original order group
1095 1096
      # we remove object not added in forms
      # we put old objects we have kept
1097
      for path, new_groups_dict in groups.iteritems():
1098 1099 1100 1101 1102 1103 1104 1105 1106
        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
1107
          # excetp the one that had to be removed
1108 1109 1110 1111
          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'):
1112 1113
              continue
            widget_in_form = 0
1114 1115
            for group_id, group_value_list in new_groups_dict.iteritems():
              if widget_id in group_value_list:
1116 1117 1118 1119 1120 1121
                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:
1122
              for old_group_id, old_group_values in old_groups_dict.iteritems():
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
                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,]
1134
                  obj.group_list = list(obj.group_list) + ['not_assigned']
1135
          # second check all widget_id in order are in form
1136 1137
          for group_id, group_value_list in new_groups_dict.iteritems():
            for widget_id in tuple(group_value_list):
1138 1139 1140
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
1141
                group_value_list.remove(widget_id)
1142
          # now set new group object
1143
          obj.groups = new_groups_dict
1144
      # restore previous activities execution order
1145
      context.setPlacelessDefaultReindexParameters(**original_reindex_parameters)
1146
      # Do not forget to delete all remaining objects if asked by user
1147 1148 1149 1150 1151 1152
      # 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:
1153 1154
            if from_path in recursive_path_list:
              continue
1155 1156 1157 1158 1159 1160
            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()])
      fillRecursivePathList(self._objects.keys())
1161
      for recursive_path in recursive_path_list:
1162
        remove_action_tuple = ('remove', 'save_and_remove')
1163 1164
        if recursive_path in update_dict:
          action = update_dict[recursive_path]
1165
          if action in remove_action_tuple:
1166 1167 1168 1169
            document = portal.restrictedTraverse(recursive_path, None)
            if document is None:
              # It happens if the parent of target path is removed before
              continue
1170 1171 1172 1173 1174 1175 1176 1177 1178
            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)
1179 1180 1181 1182 1183
            container_path = os.path.dirname(recursive_path)
            if container_path in update_dict and \
              update_dict[container_path] in remove_action_tuple:
              # If parent is removed, no need to remove the sub directory.
              continue
1184
            parent.manage_delObjects([document_id])
Aurel's avatar
Aurel committed
1185
    else:
1186 1187
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1188
      portal = context.getPortalObject()
1189
      for relative_url in self._archive.keys():
1190
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
1191 1192 1193 1194
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
1195
        if object_id in container_ids:    # Object already exists
1196
          self._backupObject('backup', trashbin, container_path, object_id)
1197
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
1198
        # Set a hard link
1199 1200 1201 1202 1203 1204
        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',):
1205
          fixZSQLMethod(portal, obj)
1206
    self.afterInstall()
1207 1208 1209

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
1210
    trash = kw.get('trash', 0)
1211 1212 1213 1214 1215
    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
1216
      object_keys = self._archive.keys()
1217
    for relative_url in object_keys:
1218 1219
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
1220
      try:
1221
        container = portal.unrestrictedTraverse(container_path)
1222
        object = container._getOb(object_id) # We force access to the object to be sure
1223 1224
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
1225
        if trash and trashbin is not None:
1226
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
1227
        if container.meta_type == 'CMF Skins Tool':
1228 1229
          # we are removing a skin folder, check and 
          # remove if registered skin selection
1230
          skin_folder = container[object_id]
1231 1232 1233
          unregisterSkinFolder(container, skin_folder,
              container.getSkinSelections())

1234 1235 1236 1237 1238 1239
        remove_dict = kw.get('remove_object_dict', {})
        container_path_name = os.path.dirname(relative_url)
        if container_path_name in remove_dict and \
          remove_dict[container_path_name] in ('remove', 'save_and_remove'):
          # If parent is removed, no need to remove the sub directory.
          continue
1240
        container.manage_delObjects([object_id])
1241
        if container.aq_parent.meta_type == 'ERP5 Catalog' and not len(container):
1242
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1243
          container.getParentValue().manage_delObjects([container.id])
1244
      except (NotFound, KeyError, BadRequest, AttributeError):
1245
        # object is already backup and/or removed
1246
        pass
1247 1248
    BaseTemplateItem.uninstall(self, context, **kw)

1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
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

1261 1262 1263 1264 1265 1266 1267 1268 1269
  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()
1270 1271
    object_keys.sort()
    object_keys.reverse()
1272 1273
    p = context.getPortalObject()
    for path in object_keys:
1274 1275 1276 1277 1278
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1279 1280 1281
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1282
        try:
Aurel's avatar
Aurel committed
1283 1284
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
1285 1286
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
1287 1288
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1289
                                           keep_subobjects=1)
1290 1291 1292 1293 1294 1295
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1296 1297 1298
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1299

1300 1301 1302 1303 1304 1305 1306 1307 1308
      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.
1309 1310 1311
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1312
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1313 1314
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1315
      if object_id != "":
1316
        path_list.extend(self._resolvePath(
1317
            folder._getOb(object_id),
1318
            relative_url_list + [object_id], id_list[1:]))
1319
    return path_list
Aurel's avatar
Aurel committed
1320

1321 1322 1323
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1324
    keys = self._path_archive.keys()
1325
    keys.sort()
Aurel's avatar
Aurel committed
1326
    for path in keys:
1327 1328 1329
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
1330
      for relative_url in self._resolvePath(p, [], path.split('/')):
1331 1332
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1333
        obj = obj.__of__(context)
1334
        _recursiveRemoveUid(obj)
1335
        id_list = obj.objectIds()
1336
        obj = self.removeProperties(obj)
1337
        if hasattr(aq_base(obj), 'groups'):
1338
          # we must keep groups because it's ereased when we delete subobjects
1339
          groups = deepcopy(obj.groups)
1340
        if len(id_list) > 0:
1341 1342
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1343
          for id_ in list(id_list):
1344
            obj._delObject(id_)
1345
        if hasattr(aq_base(obj), 'groups'):
1346 1347 1348
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1349

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1350 1351 1352 1353 1354 1355 1356 1357
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)

1358
  def install(self, context, trashbin, **kw):
1359
    """ When we install a tool that is a type provider not
1360
    registered on types tool, register it into the type provider.
1361
    """
1362 1363 1364 1365
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    for type_container_id, obj in self._objects.iteritems():
1366
      if interfaces.ITypeProvider.providedBy(obj) and \
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
          type_container_id not in types_tool.type_provider_list:
        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()
1389
    types_tool = portal.portal_types
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
    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)
1400

1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
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")
1416
    if len(id_list) != 1:
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428
      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():
1429
      pref = portal.unrestrictedTraverse(object_path)
1430
      # XXX getPreferenceState is a bad name
1431
      if pref.getPreferenceState() == 'disabled':
1432 1433
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1434 1435
        portal.portal_workflow.doActionFor(
                      pref,
1436 1437 1438
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1439 1440
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1441

1442 1443
class CategoryTemplateItem(ObjectTemplateItem):

1444 1445
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1446

1447 1448 1449 1450
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1451 1452
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1453
      obj = self.removeProperties(obj)
1454
      id_list = obj.objectIds()
1455
      if id_list:
1456
        self.build_sub_objects(context, id_list, relative_url)
1457
        for id_ in list(id_list):
1458
          obj._delObject(id_)
1459 1460
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1461 1462 1463 1464 1465

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1466 1467
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1468
      _recursiveRemoveUid(obj)
1469
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1470
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1471
      id_list = obj.objectIds()
1472 1473
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1474
        for id_ in list(id_list):
1475
          obj._delObject(id_)
1476
      else:
1477
        for id_ in list(id_list):
1478
          obj._delObject(id_)
1479 1480
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1481

1482 1483 1484
  def beforeInstall(self):
    self._installed_new_category = False

1485
  def onNewObject(self, obj):
1486 1487 1488 1489
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1490 1491
      # reset accessors if we installed a new category
      _aq_reset()
1492

1493 1494
class SkinTemplateItem(ObjectTemplateItem):

1495 1496
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1497

1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
  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')

1508 1509
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
    # 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

1523
  def install(self, context, trashbin, **kw):
1524
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1525 1526
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1527
    p = context.getPortalObject()
1528
    skin_tool = p.portal_skins
1529 1530
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1531
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1532 1533
        fixZSQLMethod(p, obj)

1534
      # Do not register skin which were explicitely ask not to be installed
1535 1536 1537 1538 1539
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
      if folder.aq_parent.meta_type == 'CMF Skins Tool':
        registerSkinFolder(skin_tool, folder)

class RegisteredSkinSelectionTemplateItem(BaseTemplateItem):

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

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

      skin_folder = skin_tool[skin_folder_id]
      selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections',
          [])
1556 1557 1558
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1559
      if skin_selection_id in selection_list:
1560
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1561
      else:
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
        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):
1581
    if not self._objects:
1582 1583 1584 1585
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
1586 1587 1588
    bta.addObject(obj=self.generateXml(), 
                  name='registered_skin_selection',  
                  path=root_path)
1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603

  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]
1604 1605 1606
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1607

1608
        if selection_list is default_value:
1609
          create_property = True
1610
          selection_list = self._objects[skin_folder_id]
1611
        else:
1612
          create_property = False
1613 1614 1615 1616 1617
          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])
1618 1619

        # Remove duplicate
1620
        selection_list = list(set(selection_list))
1621 1622 1623
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
1624
              selection_list, type='tokens')
1625 1626 1627
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
1628
              selection_list)
1629 1630

        unregisterSkinFolder(skin_tool, skin_folder,
1631
                             skin_tool.getSkinSelections())
1632
        registerSkinFolder(skin_tool, skin_folder)
1633 1634

  def uninstall(self, context, **kw):
1635 1636 1637
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1638 1639 1640 1641
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1642 1643 1644 1645
      object_keys = self._objects.keys()

    for skin_folder_id in object_keys:
      skin_folder = skin_tool[skin_folder_id]
1646
      current_selection_list = skin_folder.getProperty(
1647
        'business_template_registered_skin_selections', [])
1648
      current_selection_set = set(current_selection_list)
1649

1650 1651 1652
      skin_selection_list = workflow_id = self._objects[skin_folder_id]
      if isinstance(skin_selection_list, str):
        skin_selection_list = skin_selection_list.replace(',', ' ').split(' ')
1653 1654 1655 1656 1657
      for skin_selection in skin_selection_list:
        current_selection_set.remove(skin_selection)

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1658
        skin_folder._updateProperty(
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672
            'business_template_registered_skin_selections',
            current_selection_list)

        # Unregister skin folder from skin selection
        unregisterSkinFolder(skin_tool, skin_folder, skin_selection_list)
      else:
        delattr(skin_folder, 'business_template_registered_skin_selections')

        # Delete all skin selection
        for skin_selection in skin_selection_list:
          deleteSkinSelection(skin_tool, skin_selection)
        # Register to all other skin selection
        registerSkinFolder(skin_tool, skin_folder)

1673
  def preinstall(self, context, installed_item, **kw):
1674 1675 1676 1677 1678
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      for path in new_keys:
1679
        if installed_item._objects.has_key(path):
1680 1681
          # compare object to see it there is changes
          new_object = self._objects[path]
1682
          old_object = installed_item._objects[path]
1683 1684 1685 1686 1687
          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
1688
      old_keys = installed_item._objects.keys()
1689 1690 1691 1692 1693 1694 1695
      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'):
1696
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1697 1698 1699 1700
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
1701 1702 1703
    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
1704 1705
      if not selection_string:
        selection_list = []
1706
      else:
1707 1708
        selection_list = selection_string.split(',')
      skin_selection_dict[skin_folder_id] = selection_list
1709
    self._objects = skin_selection_dict
1710 1711


1712
class WorkflowTemplateItem(ObjectTemplateItem):
1713

1714 1715
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1716

1717 1718 1719 1720 1721
  # 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.

1722
  def preinstall(self, context, installed_item, installed_bt, **kw):
1723
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
1724
                                                         installed_item, **kw)
1725 1726 1727 1728
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1729
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1730 1731
      else:
        modified_workflow_dict[modified_object] = state
1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753
    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])
1754 1755
    return modified_workflow_dict

1756
  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1757
    if context.getTemplateFormatVersion() == 1:
1758 1759 1760
      portal = context.getPortalObject()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
Julien Muchembled's avatar
Julien Muchembled committed
1761 1762 1763
      # sort to add objects before their subobjects
      for path in sorted(self._objects):
          if force:
1764
            action = 'backup'
Julien Muchembled's avatar
Julien Muchembled committed
1765
          else:
1766
            action = update_dict.get('/'.join(path.split('/')[:2]))
Julien Muchembled's avatar
Julien Muchembled committed
1767 1768
            if action in (None, 'nothing'):
              continue
1769 1770 1771 1772 1773 1774
          container_path = path.split('/')[:-1]
          object_id = path.split('/')[-1]
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1775
            container_url = '/'.join(container_path)
1776 1777 1778 1779 1780 1781
            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
1782
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1783
            container.manage_delObjects([object_id])
1784
          obj = self._objects[path]
1785 1786 1787
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1788 1789 1790 1791 1792
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1793 1794 1795
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)

1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
  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)
1811

1812 1813
class PortalTypeTemplateItem(ObjectTemplateItem):

1814 1815
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1816 1817
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1818 1819 1820
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1821 1822
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1823
      obj = p.unrestrictedTraverse(relative_url)
1824 1825 1826 1827
      # normalize relative_url, not all type informations are stored in
      # "portal_types"
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])

1828
      obj = obj._getCopy(context)
1829 1830
      # obj is in ghost state and an attribute must be accessed
      # so that obj.__dict__ does not return an empty dict
1831
      obj.meta_type
1832
      for attr in obj.__dict__.keys():
1833 1834 1835 1836 1837 1838 1839 1840
        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',
                                      'last_id', 'uid', 'workflow_history'):
          delattr(obj, attr)
1841 1842
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1843

1844 1845
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1846 1847 1848 1849
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1850 1851
    # We now need to setup the list of workflows corresponding to
    # each portal type
1852
    (default_chain, chain_dict) = getChainByType(context)
1853
    # Set the default chain to the empty string is probably the
1854
    # best solution, by default it is 'default_workflow', which is
1855
    # not very usefull
1856
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1857
    if context.getTemplateFormatVersion() == 1:
1858
      object_list = self._objects
1859
    else:
1860 1861
      object_list = self._archive
    for path in object_list.keys():
1862 1863 1864 1865
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1866
            continue
1867 1868
        obj = object_list[path]
        portal_type = obj.id
1869 1870 1871
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1872 1873
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1874

1875 1876
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1877 1878 1879
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
1880
      result_dict = {}
1881
      xml = parse(file)
1882
      chain_list = xml.findall('//chain')
1883
      for chain in chain_list:
1884 1885 1886 1887
        portal_type = chain.find('type').text
        workflow = chain.find('workflow').text or ''
        result_dict[portal_type] = workflow
      self._workflow_chain_archive = result_dict
1888 1889 1890
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1891
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1892

1893 1894 1895
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

1896
  def build(self, context, **kw):
1897 1898 1899 1900 1901
    # 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
1902
    p = context.getPortalObject()
1903
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1904
    for key in self._archive.keys():
1905 1906 1907
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1908
        workflow = wflist[1]
1909
      else:
1910
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1911
        portal_type = wflist[0][:-2]
1912
        workflow = ''
1913 1914 1915 1916 1917
      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):
1918
          if not self.is_bt_for_diff:
1919 1920 1921
            # 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
1922
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
1923
                       'in chain for portal_type %s' % (workflow_name, portal_type))
1924
        self._objects.setdefault(portal_type, []).append(workflow)
1925
      elif not self.is_bt_for_diff:
1926
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1927
                        'is probably a sign of a missing dependency.'\
1928
                                                    % portal_type
1929

Christophe Dumez's avatar
Christophe Dumez committed
1930
  # Function to generate XML Code Manually
1931 1932
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
1933 1934 1935
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
1936
      workflow_list = self._objects[key]
1937 1938
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
1939 1940
      xml_data += '\n  <workflow>%s</workflow>' %(
        self._chain_string_separator.join(sorted(workflow_list)))
1941 1942
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
1943 1944 1945
    return xml_data

  def export(self, context, bta, **kw):
1946
    if not self._objects:
1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
    xml_data = self.generateXml()
    bta.addObject(obj=xml_data, name='workflow_chain_type',  path=root_path)

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # We now need to setup the list of workflows corresponding to
    # each portal type
1959
    (default_chain, chain_dict) = getChainByType(context)
1960
    # First convert all workflow_ids into list.
1961 1962
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
1963
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1964
    # best solution, by default it is 'default_workflow', which is
1965 1966
    # not very usefull
    default_chain = ''
1967 1968
    for path in self._objects:
      if path in update_dict or force:
1969 1970 1971
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1972
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1973 1974
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
1975
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
1976
          continue
1977
        portal_type = path_splitted[-1]
1978 1979
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
1980
          # XXX we don't use the chain (Default) in erp5 so don't keep it
1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000
          old_chain_list = [workflow_id for workflow_id in\
                            chain_dict[chain_key] if workflow_id not in\
                            ('(Default)', '',)]
          old_chain_workflow_id_set = set(old_chain_list)
          # get new workflow id list
          workflow_id_list = self._objects[path]
          for wf_id in workflow_id_list:
            if wf_id[0] == '-':
              # remove wf id if already present
              if wf_id[1:] in old_chain_workflow_id_set:
                old_chain_workflow_id_set.remove(wf_id[1:])
            elif wf_id[0] == '=':
              # replace existing chain by this one
              old_chain_workflow_id_set = set()
              old_chain_workflow_id_set.add(wf_id[1:])
            # then either '+' or nothing, add wf id to the list
            elif wf_id[0] == '+':
              old_chain_workflow_id_set.add(wf_id[1:])
            else:
              old_chain_workflow_id_set.add(wf_id)
2001
            # create the new chain
2002 2003
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
2004 2005
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
2006
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
2007 2008 2009
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
2010
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
2011
        else:
2012
          if context.portal_types.getTypeInfo(portal_type) is None:
2013
            raise ValueError('Cannot chain workflow %r to non existing '
2014 2015 2016 2017 2018
                           '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.
2019 2020
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
2021 2022
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2023

2024 2025
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
2026 2027
    object_path = kw.get('object_path', None)
    if object_path is not None:
2028
      object_key_list = [object_path]
2029
    else:
2030 2031 2032
      object_key_list = self._objects.keys()
    for object_key in object_key_list:
      path_splitted = object_key.split('/', 1)
2033 2034 2035
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
2036 2037 2038 2039 2040 2041 2042 2043 2044 2045
      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]
2046
        else:
2047 2048 2049 2050
          chain_dict[path] = self._chain_string_separator.\
                                                  join(workflow_id_list)
    context.getPortalObject().portal_workflow.\
                                   manage_changeWorkflows('', props=chain_dict)
2051

2052
  def preinstall(self, context, installed_item, **kw):
2053 2054
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2055
      new_key_list = self._objects.keys()
2056 2057
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
2058
      for key, value in installed_item._objects.iteritems():
2059 2060
        if not 'portal_type_workflow_chain/' in key:
          key = 'portal_type_workflow_chain/%s' % (key)
2061
        new_dict[key] = value
2062
      if new_dict:
2063
        installed_item._objects = new_dict
2064 2065
      for path in new_key_list:
        if path in installed_item._objects:
2066 2067
          # compare object to see it there is changes
          new_object = self._objects[path]
2068
          old_object = installed_item._objects[path]
2069 2070 2071 2072 2073 2074
          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()
2075
          if new_object != old_object:
2076
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2077
        else: # new object
2078
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2079
      # get removed object
2080 2081 2082
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2083 2084
    return modified_object_list

2085
  def _importFile(self, file_name, file):
2086
    if not file_name.endswith('.xml'):
2087
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2088
      return
2089
    # import workflow chain for portal_type
2090
    result_dict = {}
2091
    xml = parse(file)
2092
    chain_list = xml.findall('chain')
2093
    for chain in chain_list:
2094
      portal_type = chain.find('type').text
2095
      workflow_chain = chain.find('workflow').text or ''
2096
      if 'portal_type_workflow_chain/' not in portal_type:
2097 2098 2099 2100
        key = 'portal_type_workflow_chain/%s' % (portal_type,)
      else:
        key = portal_type
      result_dict[key] = workflow_chain.split(self._chain_string_separator)
2101
    self._objects = result_dict
2102

2103 2104
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2105

2106
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
2107 2108 2109
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
2110 2111
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
2112
  business_template_class_property = '_portal_type_allowed_content_type_item'
2113 2114

  def build(self, context, **kw):
2115
    types_tool = getToolByName(self.getPortalObject(), 'portal_types')
2116
    for key in self._archive.keys():
2117 2118 2119 2120
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
2121
      ob = types_tool.getTypeInfo(portal_type)
2122
      # check properties corresponds to what is defined in site
2123
      if ob is None:
2124 2125
        raise ValueError, "Portal Type %s not found in site" %(portal_type,)
      prop_value = getattr(ob, self.class_property, ())
2126
      if not allowed_type in prop_value and not self.is_bt_for_diff:
Jérome Perrin's avatar
Jérome Perrin committed
2127
        raise ValueError, "%s %s not found in portal type %s" % (
2128 2129
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)
2130 2131
      if self.class_property not in portal_type:
        key = '%s/%s' % (self.class_property, portal_type)
2132
      else:
2133 2134
        key = portal_type
      self._objects.setdefault(key, []).append(allowed_type)
2135

Christophe Dumez's avatar
Christophe Dumez committed
2136
  # Function to generate XML Code Manually
2137 2138
  def generateXml(self, path=None):
    xml_data = '<%s>' %(self.xml_tag,)
2139 2140 2141
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2142
      id_value = key.replace('%s/' % self.class_property, '')
2143
      allowed_item_list = sorted(self._objects[key])
2144
      xml_data += '\n <portal_type id="%s">' % (id_value)
2145
      for allowed_item in allowed_item_list:
2146 2147 2148
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
2149 2150 2151
    return xml_data

  def export(self, context, bta, **kw):
2152
    if not self._objects:
2153 2154 2155
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
2156
    path = os.sep.join((self.__class__.__name__, self.class_property,))
2157 2158 2159
    xml_data = self.generateXml(path=None)
    bta.addObject(obj=xml_data, name=path, path=None)

2160
  def preinstall(self, context, installed_item, **kw):
2161 2162 2163
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
2164
      new_key_list = self._objects.keys()
2165 2166
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
Nicolas Delaby's avatar
Nicolas Delaby committed
2167
      for key, value in installed_item._objects.iteritems():
2168
        if self.class_property not in key:
2169
          key = '%s/%s' % (self.class_property, key)
Nicolas Delaby's avatar
Nicolas Delaby committed
2170
        new_dict[key] = value
2171
      if new_dict:
2172
        installed_item._objects = new_dict
2173 2174
      for path in new_key_list:
        if path in installed_item._objects:
2175 2176
          # compare object to see it there is changes
          new_object = self._objects[path]
2177
          old_object = installed_item._objects[path]
2178 2179
          new_object.sort()
          old_object.sort()
2180
          if new_object != old_object:
2181
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2182
        else: # new object
2183
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2184
      # get removed object
2185 2186 2187
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2188 2189
    return modified_object_list

2190
  def _importFile(self, file_name, file):
2191
    if not file_name.endswith('.xml'):
2192
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2193
      return
2194
    path, name = posixpath.split(file_name)
2195
    xml = parse(file)
2196
    portal_type_list = xml.findall('portal_type')
2197
    for portal_type in portal_type_list:
2198 2199
      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
2200
      if self.class_property not in id:
2201 2202 2203 2204
        key = '%s/%s' % (self.class_property, id,)
      else:
        key = id
      self._objects[key] = item_type_list
2205 2206

  def install(self, context, trashbin, **kw):
Nicolas Delaby's avatar
Nicolas Delaby committed
2207 2208
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2209 2210
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2211 2212 2213 2214 2215 2216 2217
    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
2218
      if key in update_dict or force:
2219 2220 2221 2222
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2223 2224 2225
        portal_id = key.split('/')[-1]
        type_information = types_tool.getTypeInfo(portal_id)
        if type_information is None:
2226 2227
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2228 2229
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
2230
        object_property_list = getattr(type_information, self.class_property, ())
Nicolas Delaby's avatar
Nicolas Delaby committed
2231 2232 2233 2234 2235 2236 2237 2238 2239
        # 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)
2240
        setattr(type_information, self.class_property, tuple(property_list))
2241

Aurel's avatar
Aurel committed
2242
  def uninstall(self, context, **kw):
2243
    object_path = kw.get('object_path', None)
Nicolas Delaby's avatar
Nicolas Delaby committed
2244 2245
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2246
    if object_path is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
2247
      object_key_list = [object_path]
2248
    else:
Nicolas Delaby's avatar
Nicolas Delaby committed
2249 2250
      object_key_list = self._objects.keys()
    for key in object_key_list:
2251 2252 2253 2254 2255
      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,))
2256 2257
        continue
      property_list = self._objects[key]
2258
      original_property_list = list(getattr(type_information,
2259
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2260 2261
      for id in property_list:
        if id in original_property_list:
2262
          original_property_list.remove(id)
2263
      setattr(type_information, self.class_property, tuple(original_property_list))
2264

2265

2266 2267
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2268
  name = 'Hidden Content Type'
2269 2270
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2271
  business_template_class_property = '_portal_type_hidden_content_type_item'
2272

2273

2274 2275
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2276
  name = 'Property Sheet'
2277 2278
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2279
  business_template_class_property = '_portal_type_property_sheet_item'
2280

2281

2282 2283
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2284
  name = 'Base Category'
2285 2286
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2287
  business_template_class_property = '_portal_type_base_category_item'
2288

2289

2290
class CatalogMethodTemplateItem(ObjectTemplateItem):
2291
  """Template Item for catalog methods.
2292

2293 2294 2295 2296 2297
    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.
  """
2298

2299 2300
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2301
    # a mapping to store properties of methods.
2302 2303 2304 2305 2306
    # 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()
2307

2308
    self._is_filtered_archive = PersistentMapping()
2309 2310
    for method in catalog_method_filter_list:
      setattr(self, method, PersistentMapping())
2311

2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325
  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

2326 2327
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2328

2329
    catalog = _getCatalogValue(self)
2330
    if catalog is None:
2331
      LOG('BusinessTemplate build', 0, 'catalog not found')
2332
      return
2333

2334 2335 2336
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2337

2338 2339
    for obj in self._objects.values():
      method_id = obj.id
2340 2341
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2342 2343 2344 2345 2346 2347
      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]
2348

2349 2350 2351 2352 2353
  def generateXml(self, path):
    obj = self._objects[path]
    method_id = obj.id
    xml_data = '<catalog_method>'
    if self._method_properties.has_key(method_id):
2354
      for method_property, value in self._method_properties[method_id].items():
2355 2356 2357
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2358

2359
      if self._is_filtered_archive.get(method_id):
2360 2361 2362
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2363 2364
          for method in catalog_method_filter_list:
            if method != '_filter_expression_instance_archive':
2365 2366
              value = getattr(self, method, {}).get(method_id)
              if isinstance(value, basestring):
2367 2368 2369
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2370
              elif value:
2371
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2372
                for item in value:
2373 2374
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2375
    xml_data += '\n</catalog_method>\n'
Christophe Dumez's avatar
Christophe Dumez committed
2376
    return xml_data
2377

2378 2379 2380
  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))
2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406
    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
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
      obj = self._objects[key]
      # create folder and subfolders
      folders, id = posixpath.split(key)
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
      # add all datas specific to catalog inside one file
      key_name = os.path.join(obj.id+'.catalog_keys')
      xml_data = self.generateXml(key)
      bta.addObject(obj=xml_data, name=key_name, path=path)

2407 2408
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2409
    catalog = _getCatalogValue(self)
2410 2411 2412 2413 2414 2415 2416
    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)
2417

2418 2419 2420
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2421
    new_bt_format = context.getTemplateFormatVersion()
2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437

    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':
2438
              continue
2439 2440 2441 2442
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2443

2444 2445
    for obj in values:
      method_id = obj.id
2446

2447 2448 2449 2450 2451 2452
      # 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
2453
          elif isinstance(old_value, (list, tuple)):
2454 2455 2456 2457
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2458

2459 2460
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2461
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2462
        if context.getTemplateFormatVersion() == 1:
2463 2464 2465 2466 2467
          if expression and expression.strip():
            # only compile non-empty expressions
            expr_instance = Expression(expression)
          else:
            expr_instance = None
2468 2469
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2470 2471 2472
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2473
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2474 2475 2476 2477
        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, ())
2478
      elif method_id in catalog.filter_dict.keys():
2479
        catalog.filter_dict[method_id]['filtered'] = 0
2480

2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506
      # 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)
2507

2508 2509 2510 2511 2512 2513
        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)
2514

2515
  def uninstall(self, context, **kw):
2516
    catalog = _getCatalogValue(self)
2517 2518 2519
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2520

2521 2522 2523 2524
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2525 2526 2527 2528
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2529
    else:
2530
      try:
2531 2532 2533 2534
        if context.getTemplateFormatVersion() == 1:
          value = self._objects[object_path]
        else:
          value = self._archive[object_path]
2535 2536
      except KeyError:
        value = None
2537 2538
      if value is not None:
        values.append(value)
2539
    for obj in values:
2540
      method_id = obj.id
2541 2542 2543 2544 2545 2546 2547 2548 2549
      # 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)
2550

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2551
      if catalog.filter_dict.has_key(method_id):
2552
        del catalog.filter_dict[method_id]
2553

2554
    # uninstall objects
2555
    ObjectTemplateItem.uninstall(self, context, **kw)
2556

2557
  def _importFile(self, file_name, file):
2558
    if file_name.endswith('.catalog_keys.xml'):
2559
      # recreate data mapping specific to catalog method
2560 2561
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2562
      xml = parse(file)
2563
      method_list = xml.findall('item')
2564
      for method in method_list:
2565 2566 2567
        key = method.get('key')
        key_type = method.get('type')
        value_node = method.find('value')
2568
        if key_type == "str":
2569
          value = value_node.text or ''
2570
        elif key_type == "int":
2571
          value = int(value_node.text)
2572
        elif key_type == "tuple":
2573
          value = tuple([value_node.text for value_node in method.findall('value')])
2574
        else:
2575
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2576
          continue
2577
        if key in catalog_method_list or key in catalog_method_filter_list:
2578
          getattr(self, key)[id] = value
2579 2580 2581
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593
    elif file_name.endswith('.xml'):
      # just import xml object
      obj = self
      connection = None
      while connection is None:
        obj=obj.aq_parent
        connection=obj._p_jar
      obj = connection.importFile(file, customImporters=customImporters)
      self.removeProperties(obj)
      self._objects[file_name[:-4]] = obj
    else:
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2594

2595
class ActionTemplateItem(ObjectTemplateItem):
2596 2597

  def __init__(self, id_list, **kw):
2598
    # XXX It's look like ObjectTemplateItem __init__
2599 2600 2601 2602 2603 2604
    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

2605 2606
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2607
      Split path tries to split a complex path such as:
2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625

      "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

2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658
  def _getPortalTypeActionCopy(self, obj, value):
    id_id = 'reference'
    for action in obj.getActionInformationList():
      if getattr(action, id_id, None) == value:
        return obj._exportOldAction(action)

  def _getPortalToolActionCopy(self, obj, context, value):
    try:
      from Products.CMFCore.interfaces import IActionProvider
    except ImportError:
      # BACK:
      # we still don't load ZCML on tests on 2.8, but on 2.8 actions from other
      # tools are not redirected to portal_actions
      pass
    else:
      if not IActionProvider.providedBy(obj):
        # look for the action in portal_actions, instead of the original object
        LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
            'Redirected action export',
            'Attempted to retrieve action %r from %r which is no longer an '
            'IActionProvided. Retrieving action from portal_actions instead' %
            (value, obj.getId()))
        obj = context.getPortalObject().portal_actions
    id_id = 'id'
    for action in obj.listActions():
      if getattr(action, id_id, None) == value:
        return action._getCopy(context)

  def _getActionCopy(self, obj, context, value):
    """
    Gets action copy from action provider given the action id or reference
    """
    # Several tools still use CMF actions
2659
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2660 2661 2662 2663
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2664 2665 2666 2667
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2668 2669 2670
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2671
      # normalize url
2672 2673 2674 2675 2676
      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]
2677 2678
      action = self._getActionCopy(obj, context, value)
      if action is None:
2679 2680 2681
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2682
      key = posixpath.join(url[-2], url[-1], value)
2683
      self._objects[key] = self.removeProperties(action)
2684
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2685

2686 2687 2688
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2689
    if context.getTemplateFormatVersion() == 1:
2690
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2691 2692
      p = context.getPortalObject()
      for id in self._objects.keys():
2693 2694 2695 2696 2697
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2698 2699 2700
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2701

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

Julien Muchembled's avatar
Julien Muchembled committed
2708 2709
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2710 2711 2712
          try:
            from Products.CMFCore.interfaces import IActionProvider
          except ImportError:
2713
              # BACK:
2714 2715 2716 2717 2718 2719 2720 2721
              # we still don't load ZCML on tests on 2.8, but on 2.8 we don't
              # need to redirect actions to portal_actions.
              pass
          else:
            if not IActionProvider.providedBy(container):
              # some tools stopped being ActionProviders in CMF 2.x. Drop the
              # action into portal_actions.
              LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
2722
                  'Redirected action import',
2723 2724 2725 2726
                  '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
2727
          obj, action = container, obj
2728
          action_list = obj.listActions()
2729
          for index in range(len(action_list)):
2730
            if action_list[index].id == id:
2731
              # remove previous action
2732
              obj.deleteActions(selections=(index,))
2733 2734 2735
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2736
          obj.addAction(
2737 2738
                        id = action.id
                      , name = action.title
2739
                      , action = action_text
2740 2741 2742 2743
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2744 2745
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2746
                      , priority = action.priority
2747
                      , description = action.description
Aurel's avatar
Aurel committed
2748
                    )
2749
          # sort action based on the priority define on it
2750 2751 2752 2753 2754 2755 2756 2757 2758
          # 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))
2759 2760
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2761
        container.manage_delObjects([obj.id
2762
          for obj in container.getActionInformationList()
2763
          if obj.getReference() in action_dict])
2764 2765
        for obj in action_dict.itervalues():
          container._importOldAction(obj)
Aurel's avatar
Aurel committed
2766
    else:
2767
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2768
      p = context.getPortalObject()
2769 2770
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2771
        relative_url, key, value = self._splitPath(id)
2772 2773
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2774
          if getattr(ai, key) == value:
2775
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2776 2777 2778
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2779
        obj.addAction(
Aurel's avatar
Aurel committed
2780 2781
                      id = action.id
                    , name = action.title
2782
                    , action = action_text
Aurel's avatar
Aurel committed
2783 2784 2785 2786
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2787 2788
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2789
                    )
Aurel's avatar
Aurel committed
2790 2791 2792 2793 2794 2795 2796
        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))
2797 2798
          obj.moveDownActions(selections=tuple(move_down_list))

2799 2800
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2801 2802
    object_path = kw.get("object_path", None)
    if object_path is not None:
2803 2804 2805 2806 2807 2808 2809 2810
      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]
2811
    else:
2812
      keys = self._archive.keys()
2813
    for id in keys:
2814 2815
      if  '|' in id:
        relative_url, value = id.split(' | ')
2816 2817 2818
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
2819
          is_new_action = interfaces.ITypeProvider.providedBy(obj.getParentValue())
2820
          key = is_new_action and 'reference' or 'id'
2821
      else:
2822
        relative_url, key, value = self._splitPath(id)
2823
        obj = p.unrestrictedTraverse(relative_url, None)
2824 2825 2826
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2827
          if getattr(action_list[index], key, None) == value:
2828 2829
            obj.deleteActions(selections=(index,))
            break
2830 2831
      LOG('BusinessTemplate', WARNING,
          'Unable to uninstall action at %s, ignoring' % relative_url )
2832 2833
    BaseTemplateItem.uninstall(self, context, **kw)

2834 2835 2836
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2837
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2838 2839 2840 2841 2842 2843 2844
    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])
2845 2846
      # normalize url
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])
2847
      self._objects[relative_url] = type_role_list = []
2848
      for role in obj.getRoleInformationList():
2849
        type_role_dict = {}
2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866
        for k, v in aq_base(role).__getstate__().iteritems():
          if k == 'condition':
            if not v:
              continue
            v = v.text
          elif k in ('role_base_category', 'role_category'):
            k = k[5:]
          elif k == 'role_name':
            k, v = 'id', '; '.join(v)
          elif k not in ('title', 'description'):
            k = {'id': 'object_id', # for stable sort
                 'role_base_category': 'base_category',
                 'role_base_category_script_id': 'base_category_script',
                 'role_category': 'category'}.get(k)
            if not k:
              continue
          type_role_dict[k] = v
2867
        type_role_list.append(type_role_dict)
2868
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2869

Christophe Dumez's avatar
Christophe Dumez committed
2870
  # Function to generate XML Code Manually
2871 2872 2873 2874
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2875
      xml_data += "\n  <role id='%s'>" % role['id']
2876
      # uniq
2877
      for property in ('title', 'description', 'condition',
2878 2879 2880
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2881 2882
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2883
          xml_data += "\n   <property id='%s'>%s</property>" % \
2884 2885 2886
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2887
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2888 2889
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2890
          xml_data += "\n   <multi_property "\
2891
          "id='%s'>%s</multi_property>" % (property, prop_value)
2892 2893
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2894
    return xml_data
2895

2896 2897 2898 2899 2900 2901 2902
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      xml_data = self.generateXml(key)
2903 2904
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2905 2906 2907 2908
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
2909 2910 2911
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2912 2913
    type_roles_list = []
    xml = parse(file)
2914
    xml_type_roles_list = xml.findall('role')
2915
    for role in xml_type_roles_list:
2916 2917 2918 2919
      id = role.get('id')
      if isinstance(id, unicode):
        id = id.encode('utf_8', 'backslashreplace')
      type_role_property_dict = {'id': id}
2920
      # uniq
2921 2922 2923 2924 2925 2926 2927 2928
      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
2929
      # multi
2930 2931 2932 2933 2934 2935 2936 2937
      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)
2938
      type_roles_list.append(type_role_property_dict)
2939
    self._objects['portal_type_roles/%s' % (file_name[:-4],)] = type_roles_list
2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950

  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
2951 2952 2953
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
2954
          # reset roles before applying
2955
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
2956
          type_roles_list = self._objects[roles_path] or []
2957 2958
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
2959 2960 2961
        else:
          raise AttributeError("Path '%r' not found while "
                               "installing roles" % (path, ))
2962 2963 2964

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2965 2966 2967 2968 2969 2970
    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:
2971
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2972 2973 2974 2975 2976
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2977

2978 2979 2980 2981 2982 2983
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2984 2985
      for property in p.propertyMap():
        if property['id'] == id:
2986
          obj = p.getProperty(id)
2987
          prop_type = property['type']
2988 2989
          break
      else:
2990
        obj = None
2991
      if obj is None and not self.is_bt_for_diff:
2992
        raise NotFound, 'the property %s is not found' % id
2993
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2994

2995 2996
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
2997
    if not file_name.endswith('.xml'):
2998
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2999
      return
3000
    xml = parse(file)
3001 3002 3003 3004 3005 3006 3007 3008 3009
    property_node = xml.getroot()[0]
    property_id = property_node.find('id').text
    prop_type = property_node.find('type').text
    value_node = property_node.find('value')
    if prop_type in ('lines', 'tokens'):
      value = [item.text for item in value_node.findall('item')]
    else:
      value = value_node.text
    self._objects[property_id] = (prop_type, value)
3010

3011 3012 3013
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3014
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3015 3016
      p = context.getPortalObject()
      for path in self._objects.keys():
3017 3018 3019 3020
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
3021
              continue
3022
          dir, id = posixpath.split(path)
3023
          prop_type, property = self._objects[path]
3024 3025 3026 3027 3028 3029 3030 3031
          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
3032
    else:
3033
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
3034
      p = context.getPortalObject()
3035
      for id, property in self._archive.keys():
3036
        property = self._archive[id]
Aurel's avatar
Aurel committed
3037
        if p.hasProperty(id):
3038 3039 3040 3041 3042 3043 3044
          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'])
3045 3046 3047

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3048 3049 3050 3051 3052 3053
    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:
3054 3055 3056 3057
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3058
  # Function to generate XML Code Manually
3059
  def generateXml(self, path=None):
3060
    xml_data = ''
3061
    prop_type, obj = self._objects[path]
3062
    xml_data += '\n <property>'
3063 3064
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
3065
    if prop_type in ('lines', 'tokens'):
3066
      xml_data += '\n  <value>'
3067
      for item in obj:
3068
        if item != '':
3069
          xml_data += '\n   <item>%s</item>' % escape(str(item))
3070
      xml_data += '\n  </value>'
3071
    else:
3072
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
3073
    xml_data += '\n </property>'
3074 3075
    return xml_data

Aurel's avatar
Aurel committed
3076 3077 3078 3079 3080
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
3081 3082 3083 3084
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
3085
      xml_data += self.generateXml(path)
3086
    xml_data += '\n</site_property>'
3087
    bta.addObject(obj=xml_data, name='properties', path=root_path)
3088

3089 3090 3091 3092 3093
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3094 3095 3096 3097 3098 3099
    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()
3100
      permission_list = []
3101
      mapping['permission_list'] = module.showPermissions()
3102
      mapping['category_list'] = module.getCategoryList()
3103
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3104

Christophe Dumez's avatar
Christophe Dumez committed
3105
  # Function to generate XML Code Manually
3106
  def generateXml(self, path=None):
3107
    mapping = self._objects[path]
3108
    xml_data = ['<module>']
3109
    keys = mapping.keys()
3110 3111
    for key in sorted(keys):
      if key == 'permission_list':
3112
        # separe permission dict into xml
3113
        xml_data.append(' <%s>' % (key, ))
3114
        permission_list = mapping[key]
3115
        for perm in permission_list:
3116
          # the type of the permission defined if we use acquired or not
3117
          if isinstance(perm[1], list):
3118 3119 3120
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
3121
          role_list = list(perm[1])
3122 3123 3124
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
3125
          if (len(role_list) == 0 and ptype == 'list') or \
3126 3127
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
3128
          role_list.sort()
3129 3130
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
3131
          for role in role_list:
3132 3133 3134
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
3135 3136 3137 3138 3139 3140 3141 3142
      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, ))
3143
      else:
3144
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
3145 3146
    xml_data.append('</module>')
    return '\n'.join(xml_data)
3147

3148
  def export(self, context, bta, **kw):
3149
    if len(self._objects) == 0:
3150 3151 3152
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
3153 3154
    keys = self._objects.keys()
    keys.sort()
3155
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
3156
      # export modules one by one
3157 3158
      xml_data = self.generateXml(path=key)
      bta.addObject(obj=xml_data, name=key, path=path)
3159

3160
  def install(self, context, trashbin, **kw):
3161
    portal = context.getPortalObject()
3162 3163
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3164
    if context.getTemplateFormatVersion() == 1:
3165
      items = self._objects
3166
    else:
3167 3168
      items = self._archive

3169 3170
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
3171 3172
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
3173
        if not force:
3174
          action = update_dict[path]
3175 3176
          if action == 'nothing':
            continue
3177 3178
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
3179
        module = portal._getOb(module_id, None)
3180 3181
        if module is not None:
          module.portal_type = portal_type
3182
        else:
3183
          module = portal.newContent(id=module_id, portal_type=portal_type)
3184
        module.setTitle(str(mapping['title']))
3185 3186
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
3187
          # By default, Manager only without acquire permission
3188 3189
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
3190
          module.manage_permission(name, roles=role_list, acquire=acquire)
3191 3192
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
3193 3194

  def _importFile(self, file_name, file):
3195 3196 3197
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3198
    mapping = {}
3199
    xml = parse(file)
3200
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3201
      key_node = xml.find(key)
3202
      if key == 'permission_list':
3203 3204 3205 3206 3207 3208 3209
        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))
3210
          else:
3211 3212 3213
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3214
      else:
3215
        mapping[key] = key_node.text or ''
3216 3217

    category_list = []
3218 3219 3220 3221
    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'))
3222 3223
    mapping['category_list'] = category_list

3224
    self._objects[file_name[:-4]] = mapping
3225

3226
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3227 3228 3229
    trash = kw.get('trash', 0)
    if trash:
      return
3230 3231 3232 3233 3234 3235
    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]
3236 3237
    p = context.getPortalObject()
    id_list = p.objectIds()
3238 3239
    for key in keys:
      if key in id_list:
3240
        try:
3241
          if trash and trashbin is not None:
3242
            container_path = key.split('/')
3243 3244
            self.portal_trash.backupObject(trashbin, container_path, 
                                           key, save=1, keep_subobjects=1)
3245
          p.manage_delObjects([key])
3246
        except NotFound:
3247
          pass
3248 3249
    BaseTemplateItem.uninstall(self, context, **kw)

3250 3251 3252
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3253 3254

class DocumentTemplateItem(BaseTemplateItem):
3255 3256 3257 3258
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3259 3260 3261

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

3265
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3266 3267
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3268
      new_keys = self._objects.keys()
3269
      # fix key if necessary in installed bt for diff
3270
      extra_prefix = self.__class__.__name__ + '/'
3271
      for key in installed_item._objects.keys():
3272 3273 3274 3275
        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]
3276
      for path in new_keys:
3277
        if installed_item._objects.has_key(path):
3278 3279
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3280
          old_obj_code = installed_item._objects[path]
3281
          if new_obj_code != old_obj_code:
3282 3283
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3284
        else: # new object
3285 3286
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3287
          # get removed object
3288
      old_keys = installed_item._objects.keys()
3289 3290
      for path in old_keys:
        if path not in new_keys:
3291 3292
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3293 3294 3295 3296 3297
    return modified_object_list

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3298
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3299
      for id in self._objects.keys():
3300 3301 3302 3303 3304 3305
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
3306
          path, name = posixpath.split(id)
3307 3308
          # This raises an exception if the file already exists.
          try:
3309
            self.local_file_writer_name(name, text, create=0)
3310
          except IOError, error:
3311
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
3312
            if error.errno:
3313
              raise
3314 3315
            continue
          if self.local_file_importer_name is not None:
3316
            self.local_file_importer_name(name)
3317 3318 3319 3320 3321 3322 3323 3324 3325 3326
            # after 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
            self.getPortalObject()._p_jar.db().cacheMinimize()
Aurel's avatar
Aurel committed
3327
    else:
3328 3329 3330
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3331
        # This raises an exception if the file exists.
3332
        self.local_file_writer_name(id, text, create=1)
Aurel's avatar
Aurel committed
3333
        if self.local_file_importer_name is not None:
3334
          self.local_file_importer_name(id)
3335 3336

  def uninstall(self, context, **kw):
3337
    object_path = kw.get('object_path', None)
3338 3339 3340 3341
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
3342 3343
    for key in object_keys:
      self.local_file_remover_name(key)
3344 3345
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3346 3347 3348 3349 3350
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
3351 3352 3353 3354 3355 3356 3357
    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
      bta.addObject(obj=obj, name=key, ext='.py')
Aurel's avatar
Aurel committed
3358

3359
  def _importFile(self, file_name, file):
3360 3361 3362
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3363
    text = file.read()
3364
    self._objects[file_name[:-3]] = text
3365

3366
class PropertySheetTemplateItem(DocumentTemplateItem):
3367 3368 3369 3370
  local_file_reader_name = staticmethod(readLocalPropertySheet)
  local_file_writer_name = staticmethod(writeLocalPropertySheet)
  local_file_importer_name = staticmethod(importLocalPropertySheet)
  local_file_remover_name = staticmethod(removeLocalPropertySheet)
3371

3372
class ConstraintTemplateItem(DocumentTemplateItem):
3373 3374 3375 3376
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3377

3378
class ExtensionTemplateItem(DocumentTemplateItem):
3379 3380
  local_file_reader_name = staticmethod(readLocalExtension)
  local_file_writer_name = staticmethod(writeLocalExtension)
3381 3382
  # Extension needs no import
  local_file_importer_name = None
3383
  local_file_remover_name = staticmethod(removeLocalExtension)
3384 3385

class TestTemplateItem(DocumentTemplateItem):
3386 3387
  local_file_reader_name = staticmethod(readLocalTest)
  local_file_writer_name = staticmethod(writeLocalTest)
3388
  # Test needs no import
3389
  local_file_importer_name = None
3390
  local_file_remover_name = staticmethod(removeLocalTest)
3391

Aurel's avatar
Aurel committed
3392

3393 3394 3395
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3396 3397 3398

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3399
  def build(self, context, **kw):
3400 3401
    for key in self._archive.iterkeys():
      self._objects[key] = 1
Aurel's avatar
Aurel committed
3402

3403
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3404 3405
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3406
      new_roles = self._objects.keys()
3407 3408 3409 3410 3411 3412
      # 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]
3413
      for role in new_roles:
3414
        if installed_item._objects.has_key(role):
3415 3416 3417 3418
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
3419
      old_roles = installed_item._objects.keys()
3420 3421 3422 3423 3424 3425
      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):
3426
    p = context.getPortalObject()
3427
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3428
    if context.getTemplateFormatVersion() == 1:
3429
      role_set = set(self._objects)
3430
    else:
3431
      role_set = set(self._archive)
3432 3433 3434 3435
    # 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:
3436 3437
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
3438
    # set roles on portal
3439
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
3440 3441

  def _importFile(self, file_name, file):
3442
    if not file_name.endswith('.xml'):
3443
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3444
      return
3445
    xml = parse(file)
3446 3447 3448
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460

  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)

3461 3462 3463 3464 3465 3466 3467 3468 3469
  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
3470
      if role in roles and role not in new_roles:
3471 3472 3473
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3474
  # Function to generate XML Code Manually
3475 3476
  def generateXml(self):
    role_list = self._objects.keys()
3477
    xml_data = '<role_list>'
3478 3479
    for role in sorted(role_list):
      xml_data += '\n <role>%s</role>' % (role,)
3480
    xml_data += '\n</role_list>'
3481 3482
    return xml_data

Aurel's avatar
Aurel committed
3483
  def export(self, context, bta, **kw):
3484
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
3485 3486 3487
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
3488 3489 3490 3491 3492 3493 3494 3495 3496
    # 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
    bta.addObject(obj=xml_data, name=path)
3497

3498 3499
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3500
  def build(self, context, **kw):
3501
    catalog = _getCatalogValue(self)
3502 3503 3504
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3505
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3506
    key_list = []
3507
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3508
      if key in sql_search_result_keys:
3509
        key_list.append(key)
3510
      elif not self.is_bt_for_diff:
3511
        raise NotFound, 'Result key "%r" not found in catalog' %(key,)
3512
    if len(key_list) > 0:
3513
      self._objects[self.__class__.__name__+'/'+'result_key_list'] = key_list
3514 3515

  def _importFile(self, file_name, file):
3516 3517 3518
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3519
    xml = parse(file)
3520 3521
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3522

3523
  def install(self, context, trashbin, **kw):
3524
    catalog = _getCatalogValue(self)
3525 3526 3527
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3528

3529
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3530
    if context.getTemplateFormatVersion() == 1:
3531 3532
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3533 3534 3535
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3536
    else:
3537
      keys = self._archive.keys()
3538 3539
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3540
    # XXX same as related key
Aurel's avatar
Aurel committed
3541
    if update_dict.has_key('result_key_list') or force:
3542
      if not force:
Aurel's avatar
Aurel committed
3543
        action = update_dict['result_key_list']
3544
        if action == 'nothing':
Aurel's avatar
Aurel committed
3545
          return
3546
      for key in keys:
3547 3548
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
3549
      catalog.sql_search_result_keys = sql_search_result_keys
3550

3551
  def uninstall(self, context, **kw):
3552
    catalog = _getCatalogValue(self)
3553 3554 3555 3556
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3557
    object_path = kw.get('object_path', None)
3558 3559 3560 3561 3562
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3563 3564
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
3565
    catalog.sql_search_result_keys = sql_search_result_keys
3566 3567
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3568
  # Function to generate XML Code Manually
3569
  def generateXml(self, path=None):
3570
    obj = self._objects[path]
3571
    xml_data = '<key_list>'
3572 3573
    obj.sort()
    for key in obj:
3574 3575
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3576 3577
    return xml_data

Aurel's avatar
Aurel committed
3578 3579 3580 3581 3582
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
3583
    for path in self._objects.keys():
3584
      xml_data = self.generateXml(path=path)
3585
      bta.addObject(obj=xml_data, name=path, path=None)
3586

3587 3588
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3589
  def build(self, context, **kw):
3590
    catalog = _getCatalogValue(self)
3591 3592 3593
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3594
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
3595
    key_list = []
3596
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3597
      if key in sql_search_related_keys:
3598
        key_list.append(key)
3599
      elif not self.is_bt_for_diff:
3600
        raise NotFound, 'Related key "%r" not found in catalog' %(key,)
3601
    if len(key_list) > 0:
3602
      self._objects[self.__class__.__name__+'/'+'related_key_list'] = key_list
3603 3604

  def _importFile(self, file_name, file):
3605 3606 3607
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3608
    xml = parse(file)
3609 3610
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3611

3612
  def install(self, context, trashbin, **kw):
3613
    catalog = _getCatalogValue(self)
3614 3615 3616
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3617

3618
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3619
    if context.getTemplateFormatVersion() == 1:
3620
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3621
        return
3622 3623 3624
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3625
    else:
3626
      keys = self._archive.keys()
3627 3628
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3629
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
3630
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3631
      if not force:
Aurel's avatar
Aurel committed
3632 3633 3634 3635
        if update_dict.has_key('related_key_list'):
          action = update_dict['related_key_list']
        else: # XXX for backward compatibility
          action = update_dict['key_list']
Aurel's avatar
Aurel committed
3636 3637 3638
        if action == 'nothing':
          return
      for key in keys:
3639 3640
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
3641
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
3642

3643
  def uninstall(self, context, **kw):
3644
    catalog = _getCatalogValue(self)
3645 3646 3647
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3648
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
3649
    object_path = kw.get('object_path', None)
3650 3651 3652 3653 3654
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3655 3656 3657 3658 3659
      if key in sql_catalog_related_keys:
        sql_catalog_related_keys.remove(key)
    catalog.sql_catalog_related_keys = sql_catalog_related_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3660
  # Function to generate XML Code Manually
3661
  def generateXml(self, path=None):
3662
    obj = self._objects[path]
3663
    xml_data = '<key_list>'
3664 3665
    obj.sort()
    for key in obj:
3666 3667
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3668 3669
    return xml_data

Aurel's avatar
Aurel committed
3670 3671 3672 3673 3674 3675
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
3676
      xml_data = self.generateXml(path=path)
3677
      bta.addObject(obj=xml_data, name=path, path=None)
3678

3679 3680
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3681
  def build(self, context, **kw):
3682
    catalog = _getCatalogValue(self)
3683 3684 3685
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3686
    sql_search_result_tables = list(catalog.sql_search_tables)
3687
    key_list = []
3688
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3689
      if key in sql_search_result_tables:
3690
        key_list.append(key)
3691
      elif not self.is_bt_for_diff:
3692
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
3693
    if len(key_list) > 0:
3694
      self._objects[self.__class__.__name__+'/'+'result_table_list'] = key_list
3695 3696

  def _importFile(self, file_name, file):
3697 3698 3699
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3700
    xml = parse(file)
3701 3702
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
Aurel's avatar
Aurel committed
3703

3704
  def install(self, context, trashbin, **kw):
3705
    catalog = _getCatalogValue(self)
3706 3707 3708
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3709

3710
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3711
    if context.getTemplateFormatVersion() == 1:
3712
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3713
        return
3714 3715 3716
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3717
    else:
3718
      keys = self._archive.keys()
3719 3720
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3721
    # XXX same as related keys
Aurel's avatar
Aurel committed
3722
    if update_dict.has_key('result_table_list') or force:
3723
      if not force:
Aurel's avatar
Aurel committed
3724
        action = update_dict['result_table_list']
3725
        if action == 'nothing':
Aurel's avatar
Aurel committed
3726
          return
3727
      for key in keys:
3728 3729
        if key not in sql_search_tables:
          sql_search_tables.append(key)
3730
      catalog.sql_search_tables = tuple(sql_search_tables)
3731 3732

  def uninstall(self, context, **kw):
3733
    catalog = _getCatalogValue(self)
3734 3735 3736 3737
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
3738
    object_path = kw.get('object_path', None)
3739 3740 3741 3742 3743
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3744 3745
      if key in sql_search_tables:
        sql_search_tables.remove(key)
3746
    catalog.sql_search_tables = sql_search_tables
3747 3748
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3749
  # Function to generate XML Code Manually
3750
  def generateXml(self, path=None):
3751
    obj = self._objects[path]
3752
    xml_data = '<key_list>'
3753 3754
    obj.sort()
    for key in obj:
3755 3756
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3757 3758
    return xml_data

Aurel's avatar
Aurel committed
3759 3760 3761 3762 3763 3764
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
3765
      xml_data = self.generateXml(path=path)
3766
      bta.addObject(obj=xml_data, name=path, path=None)
3767

3768 3769
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3770 3771

  def build(self, context, **kw):
3772
    catalog = _getCatalogValue(self)
3773 3774 3775 3776 3777 3778 3779 3780
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_keyword_keys:
        key_list.append(key)
3781
      elif not self.is_bt_for_diff:
3782
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3783
    if len(key_list) > 0:
3784
      self._objects[self.__class__.__name__+'/'+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3785

3786
  def _importFile(self, file_name, file):
3787 3788 3789
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3790
    xml = parse(file)
3791 3792
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3793 3794

  def install(self, context, trashbin, **kw):
3795
    catalog = _getCatalogValue(self)
3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
3809 3810
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822
    # XXX same as related key
    if update_dict.has_key('keyword_key_list') or force:
      if not force:
        action = update_dict['keyword_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_keyword_keys:
          sql_keyword_keys.append(key)
      catalog.sql_catalog_keyword_search_keys = sql_keyword_keys

  def uninstall(self, context, **kw):
3823
    catalog = _getCatalogValue(self)
3824 3825 3826 3827
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3828
    object_path = kw.get('object_path', None)
3829 3830
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3831
    else:
3832 3833 3834 3835 3836 3837 3838
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_keyword_keys:
        sql_keyword_keys.remove(key)
    catalog.sql_catalog_keyword_search_keys = sql_keyword_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3839
  # Function to generate XML Code Manually
3840 3841 3842 3843 3844
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3845 3846
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3847
    return xml_data
Aurel's avatar
Aurel committed
3848 3849 3850 3851

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3852 3853 3854 3855 3856
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)
3857

3858 3859 3860 3861 3862 3863 3864 3865
# datetime
class CatalogDateTimeKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3866
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3867 3868 3869 3870
    key_list = []
    for key in self._archive.keys():
      if key in sql_datetime_keys:
        key_list.append(key)
3871
      elif not self.is_bt_for_diff:
3872 3873 3874 3875 3876
        raise NotFound, 'DateTime key "%r" not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+'/'+'datetime_key_list'] = key_list

  def _importFile(self, file_name, file):
3877 3878 3879
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3880
    xml = parse(file)
3881 3882
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3883 3884 3885 3886 3887 3888 3889

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

3890
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX same as related key
    if update_dict.has_key('datetime_key_list') or force:
      if not force:
        action = update_dict['datetime_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_datetime_keys:
          sql_datetime_keys.append(key)
      catalog.sql_catalog_datetime_search_keys = sql_datetime_keys

  def uninstall(self, context, **kw):
    catalog = _getCatalogValue(context)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available - uninstall')
      return
3917
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_datetime_keys:
        sql_datetime_keys.remove(key)
    catalog.sql_catalog_datetime_search_keys = sql_datetime_keys
    BaseTemplateItem.uninstall(self, context, **kw)

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

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)      
      
3948 3949
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3950

3951
  def build(self, context, **kw):
3952
    catalog = _getCatalogValue(self)
3953 3954 3955 3956 3957 3958 3959 3960
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_full_text_keys = list(catalog.sql_catalog_full_text_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_full_text_keys:
        key_list.append(key)
3961
      elif not self.is_bt_for_diff:
3962
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
3963
    if len(key_list) > 0:
3964
      self._objects[self.__class__.__name__+'/'+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3965

3966
  def _importFile(self, file_name, file):
3967 3968 3969
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3970
    xml = parse(file)
3971 3972
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3973

3974
  def install(self, context, trashbin, **kw):
3975
    catalog = _getCatalogValue(self)
3976 3977 3978
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3979

3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000
    sql_full_text_keys = list(catalog.sql_catalog_full_text_search_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX same as related key
    if update_dict.has_key('full_text_key_list') or force:
      if not force:
        action = update_dict['full_text_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_full_text_keys:
          sql_full_text_keys.append(key)
      catalog.sql_catalog_full_text_search_keys = sql_full_text_keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4001

4002
  def uninstall(self, context, **kw):
4003
    catalog = _getCatalogValue(self)
4004 4005 4006 4007
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_full_text_keys = list(catalog.sql_catalog_full_text_search_keys)
4008
    object_path = kw.get('object_path', None)
4009 4010 4011 4012 4013 4014 4015 4016 4017 4018
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_full_text_keys:
        sql_full_text_keys.remove(key)
    catalog.sql_catalog_full_text_search_keys = sql_full_text_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
4019
  # Function to generate XML Code Manually
4020 4021 4022 4023 4024
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4025 4026
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)


# request
class CatalogRequestKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
4043
    catalog = _getCatalogValue(self)
4044 4045 4046 4047 4048 4049 4050 4051
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_request_keys = list(catalog.sql_catalog_request_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_request_keys:
        key_list.append(key)
4052
      elif not self.is_bt_for_diff:
4053
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
4054
    if len(key_list) > 0:
4055
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
4056 4057

  def _importFile(self, file_name, file):
4058 4059 4060
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4061
    xml = parse(file)
4062 4063
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4064 4065

  def install(self, context, trashbin, **kw):
4066
    catalog = _getCatalogValue(self)
4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX must a find a better way to manage related key
    if update_dict.has_key('request_key_list') or force:
      if not force:
        action = update_dict['request_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_request_keys:
          sql_catalog_request_keys.append(key)
      catalog.sql_catalog_request_keys = tuple(sql_catalog_request_keys)

  def uninstall(self, context, **kw):
4094
    catalog = _getCatalogValue(self)
4095 4096 4097 4098
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
4099
    object_path = kw.get('object_path', None)
4100 4101 4102 4103 4104 4105 4106 4107 4108 4109
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_request_keys:
        sql_catalog_request_keys.remove(key)
    catalog.sql_catalog_request_keys = sql_catalog_request_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
4110
  # Function to generate XML Code Manually
4111 4112 4113 4114 4115
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4116 4117
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)

# multivalue
class CatalogMultivalueKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
4133
    catalog = _getCatalogValue(self)
4134 4135 4136 4137 4138 4139 4140 4141
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_multivalue_keys:
        key_list.append(key)
4142
      elif not self.is_bt_for_diff:
4143
        raise NotFound, 'Multivalue key "%r" not found in catalog' %(key,)
4144
    if len(key_list) > 0:
4145
      self._objects[self.__class__.__name__+'/'+'multivalue_key_list'] = key_list
4146 4147

  def _importFile(self, file_name, file):
4148 4149 4150
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4151
    xml = parse(file)
4152 4153
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4154 4155

  def install(self, context, trashbin, **kw):
4156
    catalog = _getCatalogValue(self)
4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    if update_dict.has_key('multivalue_key_list') or force:
      if not force:
        action = update_dict['multivalue_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_multivalue_keys:
          sql_catalog_multivalue_keys.append(key)
      catalog.sql_catalog_multivalue_keys = tuple(sql_catalog_multivalue_keys)

  def uninstall(self, context, **kw):
4183
    catalog = _getCatalogValue(self)
4184 4185 4186 4187
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
4188
    object_path = kw.get('object_path', None)
4189 4190 4191 4192 4193 4194 4195 4196 4197 4198
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_multivalue_keys:
        sql_catalog_multivalue_keys.remove(key)
    catalog.sql_catalog_multivalue_keys = sql_catalog_multivalue_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
4199
  # Function to generate XML Code Manually
4200 4201 4202 4203 4204
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4205 4206
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)

# topic
class CatalogTopicKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
4222
    catalog = _getCatalogValue(self)
4223 4224 4225 4226 4227 4228 4229 4230
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_catalog_topic_search_keys:
        key_list.append(key)
4231
      elif not self.is_bt_for_diff:
4232
        raise NotFound, 'Topic key "%r" not found in catalog' %(key,)
4233
    if len(key_list) > 0:
4234
      self._objects[self.__class__.__name__+'/'+'topic_key_list'] = key_list
4235 4236

  def _importFile(self, file_name, file):
4237 4238 4239
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4240
    xml = parse(file)
4241 4242
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4243 4244

  def install(self, context, trashbin, **kw):
4245
    catalog = _getCatalogValue(self)
4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX same as related key
    if update_dict.has_key('topic_key_list') or force:
      if not force:
        action = update_dict['topic_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_topic_search_keys:
          sql_catalog_topic_search_keys.append(key)
      catalog.sql_catalog_topic_search_keys = sql_catalog_topic_search_keys

  def uninstall(self, context, **kw):
4273
    catalog = _getCatalogValue(self)
4274 4275 4276 4277
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
4278
    object_path = kw.get('object_path', None)
4279 4280 4281 4282 4283 4284 4285 4286 4287 4288
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_topic_search_keys:
        sql_catalog_topic_search_keys.remove(key)
    catalog.sql_catalog_topic_search_keys = sql_catalog_topic_search_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
4289
  # Function to generate XML Code Manually
4290 4291 4292 4293 4294
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4295 4296
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)

4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319
class CatalogScriptableKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_scriptable_keys = list(catalog.sql_catalog_scriptable_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_catalog_scriptable_keys:
        key_list.append(key)
4320
      elif not self.is_bt_for_diff:
4321 4322 4323 4324 4325
        raise NotFound, 'Scriptable key "%r" not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+'/'+'scriptable_key_list'] = key_list

  def _importFile(self, file_name, file):
4326 4327 4328
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4329
    xml = parse(file)
4330 4331
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397

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

    sql_catalog_scriptable_keys = list(catalog.sql_catalog_scriptable_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX must a find a better way to manage scriptable key
    if update_dict.has_key('scriptable_key_list') or force:
      if not force:
        if update_dict.has_key('scriptable_key_list'):
          action = update_dict['scriptable_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_scriptable_keys:
          sql_catalog_scriptable_keys.append(key)
      catalog.sql_catalog_scriptable_keys = tuple(sql_catalog_scriptable_keys)

  def uninstall(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_scriptable_keys = list(catalog.sql_catalog_scriptable_keys)
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_scriptable_keys:
        sql_catalog_scriptable_keys.remove(key)
    catalog.sql_catalog_scriptable_keys = tuple(sql_catalog_scriptable_keys)
    BaseTemplateItem.uninstall(self, context, **kw)

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

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)

4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410
class CatalogRoleKeyTemplateItem(BaseTemplateItem):
  # XXX Copy/paste from CatalogScriptableKeyTemplateItem

  def build(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_role_keys = list(catalog.sql_catalog_role_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_catalog_role_keys:
        key_list.append(key)
4411
      elif not self.is_bt_for_diff:
4412 4413 4414 4415 4416
        raise NotFound, 'Role key "%r" not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+'/'+'role_key_list'] = key_list

  def _importFile(self, file_name, file):
4417 4418 4419
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4420
    xml = parse(file)
4421 4422
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 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

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

    sql_catalog_role_keys = list(catalog.sql_catalog_role_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX must a find a better way to manage scriptable key
    if update_dict.has_key('role_key_list') or force:
      if not force:
        if update_dict.has_key('role_key_list'):
          action = update_dict['role_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_role_keys:
          sql_catalog_role_keys.append(key)
      catalog.sql_catalog_role_keys = tuple(sql_catalog_role_keys)

  def uninstall(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_role_keys = list(catalog.sql_catalog_role_keys)
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_role_keys:
        sql_catalog_role_keys.remove(key)
    catalog.sql_catalog_role_keys = tuple(sql_catalog_role_keys)
    BaseTemplateItem.uninstall(self, context, **kw)

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

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)

class CatalogLocalRoleKeyTemplateItem(BaseTemplateItem):
  # XXX Copy/paste from CatalogScriptableKeyTemplateItem

  def build(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_local_role_keys = list(catalog.sql_catalog_local_role_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_catalog_local_role_keys:
        key_list.append(key)
4502
      elif not self.is_bt_for_diff:
4503 4504 4505 4506 4507
        raise NotFound, 'LocalRole key "%r" not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+'/'+'local_role_key_list'] = key_list

  def _importFile(self, file_name, file):
4508 4509 4510
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4511
    xml = parse(file)
4512 4513
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579

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

    sql_catalog_local_role_keys = list(catalog.sql_catalog_local_role_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX must a find a better way to manage scriptable key
    if update_dict.has_key('local_role_key_list') or force:
      if not force:
        if update_dict.has_key('local_role_key_list'):
          action = update_dict['local_role_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_local_role_keys:
          sql_catalog_local_role_keys.append(key)
      catalog.sql_catalog_local_role_keys = tuple(sql_catalog_local_role_keys)

  def uninstall(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_local_role_keys = list(catalog.sql_catalog_local_role_keys)
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_local_role_keys:
        sql_catalog_local_role_keys.remove(key)
    catalog.sql_catalog_local_role_keys = tuple(sql_catalog_local_role_keys)
    BaseTemplateItem.uninstall(self, context, **kw)

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

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)

4580 4581 4582 4583
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4584 4585 4586
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4587
      else: # XXX backward compatibility
4588 4589
        lang = lang_key
        catalog = 'erp5_ui'
4590
      path = posixpath.join(lang, catalog)
4591 4592
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4593 4594 4595
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4596

4597
  def preinstall(self, context, installed_item, **kw):
4598 4599 4600 4601
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
4602
        if installed_item._objects.has_key(path):
4603 4604
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
4605
          old_obj_code = installed_item._objects[path]
4606 4607 4608 4609 4610
          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
4611
      old_keys = installed_item._objects.keys()
4612 4613 4614 4615 4616
      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

4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644
  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', {})
4645 4646
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
4647 4648
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4649
          if not force:
4650
            action = update_dict[key]
4651
            if action == 'nothing':
4652
              continue
4653
          lang, catalog = self._splitKey(key)
4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669

          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)
4670 4671
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4672 4673 4674 4675
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4676
            self._importCatalogLanguage(localizer, catalog, lang, po)
4677 4678
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4679
      for lang, catalogs in self._archive.iteritems():
4680 4681 4682
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712
          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)
4713 4714

  def export(self, context, bta, **kw):
4715
    if len(self._objects) == 0:
4716 4717 4718
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
4719
    for key, obj in self._objects.iteritems():
4720 4721
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
4722 4723 4724 4725 4726 4727 4728 4729
      if '/' in key:
        bta.addObject(obj, os.path.join(path, 'translation'), ext='.po')
      else:
        xml_data = ['<language>']
        xml_data.append(' <code>%s</code>' % (escape(key), ))
        xml_data.append(' <name>%s</name>' % (escape(obj), ))
        xml_data.append('</language>')
        bta.addObject('\n'.join(xml_data), os.path.join(path, 'language'))
4730 4731

  def _importFile(self, file_name, file):
4732 4733
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4734 4735
      text = file.read()
      self._objects[file_name[:-3]] = text
4736 4737
    elif name == 'language.xml':
      xml = parse(file)
4738 4739
      name = xml.find('name').text
      code = xml.find('code').text
4740
      self._objects[code] = name
4741

Aurel's avatar
Aurel committed
4742 4743
class LocalRolesTemplateItem(BaseTemplateItem):

4744
  def __init__(self, id_list, **kw):
4745
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4746 4747
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4748 4749 4750
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4751
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4752 4753
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4754
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4755

Christophe Dumez's avatar
Christophe Dumez committed
4756
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4757
  def generateXml(self, path=None):
4758
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4759 4760
    # local roles
    xml_data = '<local_roles_item>'
4761
    xml_data += '\n <local_roles>'
4762
    for key in sorted(local_roles_dict):
4763
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4764 4765
      tuple = local_roles_dict[key]
      for item in tuple:
4766 4767 4768 4769
        xml_data += "\n   <item>%s</item>" %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </local_roles>'
    xml_data += '\n</local_roles_item>'
Aurel's avatar
Aurel committed
4770
    return xml_data
4771

Aurel's avatar
Aurel committed
4772 4773 4774 4775 4776 4777 4778 4779
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      xml_data = self.generateXml(key)

4780
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4781
      encode_folders = []
4782
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4783
        if '%' not in folder:
4784
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4785 4786
        else:
          encode_folders.append(folder)
4787
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4788 4789 4790 4791
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
4792 4793 4794
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4795 4796
    xml = parse(file)
    # local roles
4797
    local_roles_list = xml.findall('//role')
Aurel's avatar
Aurel committed
4798 4799
    local_roles_dict = {}
    for role in local_roles_list:
4800 4801
      id = role.get('id')
      item_type_list = [item.text for item in role]
Aurel's avatar
Aurel committed
4802
      local_roles_dict[id] = item_type_list
4803
    self._objects['local_roles/%s' % (file_name[:-4],)] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814

  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
4815 4816
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4817
        local_roles_dict = self._objects[roles_path][0]
4818
        setattr(obj, '__ac_local_roles__', local_roles_dict)
4819
        obj.reindexObject()
Aurel's avatar
Aurel committed
4820

4821
  def uninstall(self, context, object_path=None, **kw):
Aurel's avatar
Aurel committed
4822
    p = context.getPortalObject()
4823 4824 4825 4826 4827
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
Aurel's avatar
Aurel committed
4828 4829 4830
      path = roles_path.split('/')[1:]
      obj = p.unrestrictedTraverse(path)
      setattr(obj, '__ac_local_roles__', {})
4831
      obj.reindexObject()
4832

4833 4834 4835
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4836
    in part or completely. Each object is separated from its
4837 4838 4839 4840 4841 4842 4843 4844 4845 4846
    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
4847 4848
      - object without optimal actions
      - list of relation between portal type and workflow
4849 4850 4851 4852 4853 4854 4855 4856 4857 4858

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

    - site property definition
      - id
      - type
4859
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4860

4861 4862
    - document/propertysheet/extension/test definition
      - copy of the local file
4863

4864
    - message transalation definition
4865
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4866

4867 4868
    The Business Template properties are exported to the bt folder with
    one property per file
4869

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4870 4871
    Technology:

4872 4873
    - 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
4874

4875
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4876 4877 4878 4879

    Use case:

    - install core ERP5 (the minimum)
4880

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

4883 4884
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4885
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4886 4887 4888 4889 4890
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4891
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4892 4893 4894

    # Declarative security
    security = ClassSecurityInfo()
4895
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4896 4897 4898 4899

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4900
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4901
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4902
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4903
                      , PropertySheet.BusinessTemplate
4904
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4905 4906
                      )

4907 4908 4909 4910 4911 4912
    # 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."""
4913
         , 'icon'           : 'file_icon.gif'
4914 4915 4916 4917 4918 4919 4920 4921 4922
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4923 4924
    # This is a global variable
    # Order is important for installation
4925 4926 4927 4928 4929 4930
    # We want to have:
    #  * path after module, because path can be module content
    #  * path after categories, because path can be categories content
    #  * skin after paths, because we can install a custom connection string as
    #       path and use it with SQLMethods in a skin.
    #    ( and more )
4931 4932
    _item_name_list = [
      '_product_item',
4933
      '_property_sheet_item',
4934
      '_constraint_item',
4935 4936 4937 4938
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4939
      '_tool_item',
4940 4941 4942 4943
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4944
      '_portal_type_workflow_chain_item',
4945 4946 4947 4948
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4949 4950
      '_category_item',
      '_module_item',
4951
      '_path_item',
4952
      '_skin_item',
4953
      '_registered_skin_selection_item',
4954
      '_preference_item',
4955
      '_action_item',
4956
      '_portal_type_roles_item',
4957
      '_local_roles_item',
4958
      '_catalog_method_item',
4959 4960 4961
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4962
      '_catalog_keyword_key_item',
4963
      '_catalog_datetime_key_item',
4964 4965 4966 4967
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4968
      '_catalog_scriptable_key_item',
4969 4970
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4971 4972 4973 4974
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4975 4976 4977 4978 4979 4980
      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
4981
        self._baseGetTemplateFormatVersion()
4982

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4983 4984 4985
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4986

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4987
      return 0
4988

4989
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4990 4991 4992 4993 4994 4995 4996
    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".
4997 4998
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4999
          # XXX Not good to access the attribute directly,
5000 5001 5002
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
5003

5004 5005
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
5006 5007 5008 5009 5010 5011
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

5012
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
5013 5014 5015 5016 5017 5018 5019 5020
        """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)
5021

5022 5023
    security.declareProtected(Permissions.ManagePortal, 'storeTemplateItemData')
    def storeTemplateItemData(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5024
      """
5025
        Instanciate and Store Template items into properties.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5026
      """
5027
      # Store all Data
5028 5029
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
5030
      self._portal_type_workflow_chain_item = \
5031
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
5032 5033 5034 5035
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
5036 5037 5038
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
5039 5040 5041 5042 5043 5044
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
5045
      self._portal_type_roles_item = \
5046
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
5047 5048 5049 5050 5051 5052 5053 5054
      self._site_property_item = \
          SitePropertyTemplateItem(self.getTemplateSitePropertyIdList())
      self._module_item = \
          ModuleTemplateItem(self.getTemplateModuleIdList())
      self._document_item = \
          DocumentTemplateItem(self.getTemplateDocumentIdList())
      self._property_sheet_item = \
          PropertySheetTemplateItem(self.getTemplatePropertySheetIdList())
5055 5056
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076
      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())
5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088
      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())
5089 5090
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
5091 5092
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
5093 5094
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
5095
               self.getTemplateCatalogKeywordKeyList())
5096 5097 5098
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
5099 5100
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
5101
               self.getTemplateCatalogFullTextKeyList())
5102 5103
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
5104
               self.getTemplateCatalogRequestKeyList())
5105 5106
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
5107
               self.getTemplateCatalogMultivalueKeyList())
5108 5109 5110
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
5111 5112
      self._local_roles_item = \
          LocalRolesTemplateItem(
5113
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5114 5115 5116
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
5117 5118 5119
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
5120 5121 5122 5123 5124 5125
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
5126

5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140
    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()

      self.updateRevisionNumber()
      self._setTemplateFormatVersion(1)
      self.storeTemplateItemData()

5141 5142
      # Build each part
      for item_name in self._item_name_list:
5143 5144 5145 5146
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
5147

5148
    build = WorkflowMethod(build)
5149 5150

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5151
      """
5152
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5153
      """
5154
      return self.portal_templates.publish(self, url, username=username,
5155
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5156

5157
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5158
      """
5159
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5160
      """
5161
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5162

5163 5164 5165 5166 5167
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
5168 5169 5170 5171 5172 5173 5174 5175 5176 5177
      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
5178 5179
      return False

5180
    def preinstall(self, check_dependencies=1, **kw):
5181 5182 5183
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
5184
      """
5185 5186 5187 5188 5189
      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()
5190

5191 5192
      modified_object_list = {}
      bt_title = self.getTitle()
5193 5194 5195 5196 5197 5198 5199

      #  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)
5200 5201 5202
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5203
        installed_bt_format = installed_bt.getTemplateFormatVersion()
5204

5205
      # if reinstall business template, must compare to object in ZODB
5206
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
5207
      # same if we make a diff and select only one business template
5208
      reinstall = 0
5209 5210
      if installed_bt == self:
        reinstall = 1
5211
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
5212 5213
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                   id=INSTALLED_BT_FOR_DIFF)
5214 5215 5216 5217 5218 5219 5220
          # 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)
5221

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5222
      new_bt_format = self.getTemplateFormatVersion()
5223 5224 5225 5226 5227 5228
      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:
5229
          item = getattr(self, item_name, None)
5230 5231 5232 5233
          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
5234

5235
      for item_name in self._item_name_list:
5236
        new_item = getattr(self, item_name, None)
5237
        installed_item = getattr(installed_bt, item_name, None)
5238
        if new_item is not None:
5239
          if installed_item is not None and hasattr(installed_item, '_objects'):
5240
            modified_object = new_item.preinstall(context=self, 
5241 5242
                                                  installed_item=installed_item,
                                                  installed_bt=installed_bt)
5243 5244 5245 5246 5247 5248 5249
            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:
5250
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5251

5252 5253
      return modified_object_list

5254
    def _install(self, force=1, object_to_update=None, update_translation=0,
5255
                 update_catalog=_MARKER, **kw):
5256
      """
Christophe Dumez's avatar
Christophe Dumez committed
5257
        Install a new Business Template, if force, all will be upgraded or installed
5258 5259
        otherwise depends of dict object_to_update
      """
5260 5261 5262 5263
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
5264

5265 5266
      site = self.getPortalObject()
      installed_bt = site.portal_templates.getInstalledBusinessTemplate(
5267
                                                           self.getTitle())
5268 5269
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5270
        if installed_bt.getTemplateFormatVersion() == 0:
5271
          force = 1
5272 5273 5274
        if site.portal_workflow.isTransitionPossible(
            installed_bt, 'replace'):
          installed_bt.replace(self)
5275

5276
      trash_tool = getToolByName(site, 'portal_trash', None)
5277 5278 5279
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

5280 5281 5282
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
5283

5284 5285 5286
      if not force:
        self.checkDependencies()

5287 5288 5289
      from Products.ERP5.ERP5Site import ERP5Generator
      generator_class = getattr(site, '_generator_class', ERP5Generator)
      gen = generator_class()
5290 5291
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
5292 5293 5294 5295 5296 5297
        if not site.hasObject('portal_activities'):
          create_activities = True
          LOG('Business Template', 0, 'Updating Activity Tool')
        else:
          create_activities = False
        gen.setupLastTools(site, update=1, create_activities=create_activities)
5298 5299
      if not force:
        if len(object_to_update) == 0:
5300 5301 5302 5303 5304
          # check if we have to update tools
          if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
            LOG('Business Template', 0, 'Updating Tools')
            gen.setup(site, 0, update=1)
          if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
5305
            LOG('Business Template', 0, 'Updating Business Template Workflows')
5306
            gen.setupWorkflow(site)
5307
          return
5308

5309 5310
      # 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
5311
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
5312 5313 5314 5315 5316
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
5317
      if len(object_to_update) or force:
5318 5319 5320
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
5321 5322
            item.install(self, force=force, object_to_update=object_to_update, 
                               trashbin=trashbin, installed_bt=installed_bt)
5323

5324
      # update catalog if necessary
5325 5326 5327
      if update_catalog is _MARKER and force and self.isCatalogUpdatable():
        # override update_catalog parameter only if value
        # is not explicitely passed.
5328
        update_catalog = 1
5329
      elif update_catalog is _MARKER:
5330
        update_catalog = 0
5331
      if update_catalog:
5332
        catalog = _getCatalogValue(self)
5333
        if (catalog is None) or (not site.isIndexable):
5334 5335 5336 5337 5338
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
5339

5340
      # get objects to remove
5341
      # do remove after because we may need backup object from installation
5342
      remove_object_dict = {}
5343 5344
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
5345
          remove_object_dict[path] = action
5346

5347
      # remove object from old business template
5348
      if len(remove_object_dict):
5349
        # XXX: this code assumes that there is an installed_bt
5350
        for item_name in reversed(installed_bt._item_name_list):
5351
          item = getattr(installed_bt, item_name, None)
5352
          if item is not None:
5353
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
5354

5355 5356 5357 5358 5359 5360

      # update tools if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Tools')
        gen.setup(site, 0, update=1)

5361
      # check if we have to update business template workflow
5362
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
5363
        LOG('Business Template', 0, 'Updating Business Template Workflows')
5364 5365 5366 5367 5368
        gen.setupWorkflow(site)
        # XXX keep TM in case update of workflow doesn't work
        #         self._v_txn = WorkflowUpdateTM()
        #         self._v_txn.register(update=1, gen=gen, site=site)

5369 5370
      # remove trashbin if empty
      if trashbin is not None:
5371
        if len(trashbin) == 0:
5372 5373
          trash_tool.manage_delObjects([trashbin.getId(),])

5374 5375
      if update_catalog:
        site.ERP5Site_reindexAll()
5376

5377 5378
      # Update translation table, in case we added new portal types or
      # workflow states.
5379 5380
      if update_translation:
        site.ERP5Site_updateTranslationTable()
5381

5382 5383
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
5384

5385
    security.declareProtected(Permissions.ManagePortal, 'install')
5386 5387 5388
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
5389
      """
5390
      return self._install(**kw)
5391

5392
    install = WorkflowMethod(install)
5393

5394
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
5395
    def reinstall(self, **kw):
5396 5397 5398 5399
      """Reinstall Business Template.
      """
      return self._install(**kw)

5400
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5401

5402
    security.declareProtected(Permissions.ManagePortal, 'trash')
5403 5404
    def trash(self, new_bt, **kw):
      """
5405
        Trash unnecessary items before upgrading to a new business
5406
        template.
5407
        This is similar to uninstall, but different in that this does
5408
        not remove all items.
5409
      """
5410 5411
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5412
        item = getattr(self, item_name, None)
5413 5414
        if item is not None:
          item.trash(
5415
                self,
5416
                getattr(new_bt, item_name))
5417

5418
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
5419
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5420
      """
5421
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5422
      """
5423 5424 5425
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5426
        item = getattr(self, item_name, None)
5427
        if item is not None:
5428
          item.uninstall(self, **kw)
5429
      # It is better to clear cache because the uninstallation of a
5430
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
5431
      self.getPortalObject().portal_caches.clearAllCache()
5432

5433 5434
    uninstall = WorkflowMethod(uninstall)

5435
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5436
    def _clean(self):
5437
      """
5438
        Clean built information.
5439
      """
5440
      # First, remove obsolete attributes if present.
5441 5442 5443 5444
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
5445
                    '_module_archive',
5446 5447 5448
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
5449
                    '_property_sheet_archive'):
5450 5451 5452
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
5453 5454
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
5455

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

5458
    security.declareProtected(Permissions.AccessContentsInformation,
5459
                              'getBuildingState')
5460
    def getBuildingState(self, default=None, id_only=1):
5461
      """
5462
        Returns the current state in building
5463
      """
5464
      portal_workflow = getToolByName(self, 'portal_workflow')
5465 5466
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
5467
      return wf._getWorkflowStateOf(self, id_only=id_only )
5468

5469
    security.declareProtected(Permissions.AccessContentsInformation,
5470
                              'getInstallationState')
5471
    def getInstallationState(self, default=None, id_only=1):
5472
      """
5473
        Returns the current state in installation
5474
      """
5475
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
5476 5477
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
5478
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5479

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5480 5481 5482 5483 5484 5485
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
5486
      export_string = portal_templates.manage_exportObject(
5487 5488
                                               id=self.getId(),
                                               toxml=1,
5489
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5490
      return export_string
5491

5492
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5493
      """
5494 5495
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5496
      """
5497 5498
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
5499 5500 5501 5502
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
5503
        # XXX Why do we need to return a tuple ?
5504 5505
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5506

5507
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5508
      """
5509 5510
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5511
      """
5512
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5513

5514
    def getTemplateBaseCategoryList(self):
5515
      """
5516 5517
      We have to set this method because we want an
      ordered list
5518
      """
5519
      return self._getOrderedList('template_base_category')
5520

5521
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5522
      """
5523 5524
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5525
      """
5526
      return self._getOrderedList('template_workflow_id')
5527

5528
    def getTemplatePortalTypeIdList(self):
5529
      """
5530 5531
      We have to set this method because we want an
      ordered list
5532
      """
5533
      return self._getOrderedList('template_portal_type_id')
5534

5535 5536 5537 5538 5539 5540 5541
    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
5542 5543 5544 5545 5546 5547 5548
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

5549 5550 5551 5552 5553 5554 5555
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

5556 5557 5558 5559 5560 5561
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
5562

5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583
    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')

5584
    def getTemplateActionPathList(self):
5585
      """
5586 5587
      We have to set this method because we want an
      ordered list
5588
      """
5589
      return self._getOrderedList('template_action_path')
5590

5591
    def getTemplatePortalTypeRoleList(self):
5592 5593 5594 5595
      """
      We have to set this method because we want an
      ordered list
      """
5596
      return self._getOrderedList('template_portal_type_role')
5597

5598
    def getTemplateLocalRoleList(self):
5599 5600 5601 5602
      """
      We have to set this method because we want an
      ordered list
      """
5603
      return self._getOrderedList('template_local_role')
5604

5605
    def getTemplateSkinIdList(self):
5606
      """
5607 5608
      We have to set this method because we want an
      ordered list
5609
      """
5610
      return self._getOrderedList('template_skin_id')
5611

5612 5613 5614 5615 5616 5617 5618
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

5619
    def getTemplateModuleIdList(self):
5620
      """
5621 5622
      We have to set this method because we want an
      ordered list
5623
      """
5624
      return self._getOrderedList('template_module_id')
5625 5626 5627 5628 5629 5630 5631

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5633 5634 5635 5636 5637 5638 5639
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5640
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5641 5642 5643 5644
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5645
      if self.getBuildingState() != 'built':
5646
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5647
              'Business Template must be built before export'
5648

Aurel's avatar
Aurel committed
5649 5650 5651 5652 5653 5654 5655
      if local:
        # we export into a folder tree
        bta = BusinessTemplateFolder(creation=1, path=path)
      else:
        # We export BT into a tarball file
        bta = BusinessTemplateTarball(creation=1, path=path)

5656
      # export bt
5657
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
5658
      for prop in self.propertyMap():
5659
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5660
        id = prop['id']
5661
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5662
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5663
          continue
Aurel's avatar
Aurel committed
5664
        value = self.getProperty(id)
5665 5666
        if value is None:
          continue
5667
        if prop_type in ('text', 'string', 'int', 'boolean'):
5668
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
5669
        elif prop_type in ('lines', 'tokens'):
5670
          bta.addObject(obj=str('\n').join(value), name=id,
5671
                        path=path+os.sep+'bt', ext='')
5672

Aurel's avatar
Aurel committed
5673 5674 5675
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5676

5677
      return bta.finishCreation(self.getTitle())
Aurel's avatar
Aurel committed
5678

5679
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5680 5681
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5682
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5683 5684 5685 5686 5687
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
5688 5689

      self.storeTemplateItemData()
5690

5691 5692
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5693
      orig_module_dict = {}
5694
      instance_oid_list = []
5695 5696
      for template_id in self.getTemplateDocumentIdList():
          module_id = 'Products.ERP5Type.Document.' + template_id
5697
          orig_module_dict[module_id] = sys.modules.get(module_id)
5698 5699 5700 5701 5702 5703 5704 5705 5706 5707
          # Always redefine the module, so that 'instance_oid_list' contains
          # the full list of oid to remove from pickle cache.
          sys.modules[module_id] = module = imp.new_module(module_id)
          module.SimpleItem = SimpleItem.SimpleItem
          module.instance_oid_list = instance_oid_list
          exec """class %s(SimpleItem):
            def __setstate__(self, state):
              instance_oid_list.append(self._p_oid)
              return SimpleItem.__setstate__(self, state)""" % template_id \
            in module.__dict__
5708

Aurel's avatar
Aurel committed
5709 5710
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5711

5712 5713 5714 5715 5716 5717
      if instance_oid_list:
        # If a temporary class was used, we must force all instances using it
        # to be reloaded (i.e. unpickle) on next access (at installation).
        # Doing a savepoint will pickle them to a temporary storage so that all
        # references to it can be freed.
        transaction.savepoint(optimistic=True)
5718 5719
        self._p_jar.cacheMinimize()
        gc.collect()
5720

5721 5722
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5723 5724 5725 5726 5727 5728
      # Restore original module if any, in case the new one is not installed.
      for module_id, module in orig_module_dict.iteritems():
        if module is None:
          del sys.modules[module_id]
        else:
          sys.modules[module_id] = module
5729

5730 5731 5732 5733 5734
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5735 5736 5737
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5738
      return items_list
5739

5740 5741 5742 5743 5744 5745 5746 5747 5748 5749
    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
      """
      missing_dep_list = []
      dependency_list = self.getDependencyList()
      if len(dependency_list)!=0:
        for dependency_couple in dependency_list:
5750
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5751
          dependency = dependency_couple_list[0]
5752 5753
          if dependency in (None, ''):
            continue
5754 5755
          version_restriction = None
          if len(dependency_couple_list) > 1:
5756
            version_restriction = dependency_couple_list[1]
5757 5758 5759
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5760 5761 5762
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5763
                  or (version_restriction not in (None, '') and
5764 5765 5766 5767
                     (not self.portal_templates.compareVersionStrings(installed_bt.getVersion(), version_restriction)))):
            missing_dep_list.append((dependency, version_restriction or ''))
      if len(missing_dep_list) != 0:
        raise BusinessTemplateMissingDependency, 'Impossible to install, please install the following dependencies before: %s'%repr(missing_dep_list)
5768

5769 5770 5771 5772 5773 5774 5775 5776
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
        This is compatible with ERP5Subversion look and feel but
        it is preferred in future we use more difflib python library.
      """
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

Aurel's avatar
Aurel committed
5777
    def diffObject(self, REQUEST, **kw):
5778 5779
      """
        Make a diff between an object in the Business Template
5780
        and the same in the Business Template installed in the site
5781 5782 5783 5784
      """

      class_name_dict = {
        'Product' : '_product_item',
5785
        'PropertySheet' : '_property_sheet_item',
5786
        'Constraint' : '_constraint_item',
5787 5788 5789 5790 5791 5792 5793 5794 5795
        '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',
5796
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5797 5798 5799 5800
        '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',
5801 5802 5803
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5804
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5805
        'Path' : '_path_item',
5806
        'Preference' : '_preference_item',
5807
        'Action' : '_action_item',
5808
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5809
        'LocalRoles' : '_local_roles_item',
5810 5811 5812
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5813
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5814
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5815 5816 5817 5818
        '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
5819
        'Tool': '_tool_item',
5820
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5821 5822
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5823
        }
5824

5825 5826
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5827

Christophe Dumez's avatar
Christophe Dumez committed
5828
      # Get objects
5829
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5830

5831
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
5832
      # Compare with a given business template
5833
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5834 5835
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5836 5837
        if bt2_id == self.getId():
          compare_to_zodb = 1
5838
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5839 5840
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5841 5842 5843
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5844 5845
          compare_to_zodb = 1
      if compare_to_zodb:
5846 5847
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5848
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5849 5850 5851
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5852

5853 5854
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5855
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5856
        # XXX maybe only build for the given object to gain time
5857
        installed_item.build(self)
5858 5859 5860
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5861

Christophe Dumez's avatar
Christophe Dumez committed
5862
      # Real Zope Objects (can be exported into XML directly by Zope)
5863 5864
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5865
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5866
                     '_skin_item', '_action_item', '_tool_item', ]
5867

Christophe Dumez's avatar
Christophe Dumez committed
5868
      # Not considered as objects by Zope (will be exported into XML manually)
5869
      # XXX Bad naming
5870 5871 5872 5873
      item_list_2 = ['_site_property_item',
                     '_module_item',
                     '_catalog_result_key_item', 
                     '_catalog_related_key_item',
5874 5875
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
5876
                     '_catalog_datetime_key_item',
5877 5878 5879 5880
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5881
                     '_catalog_scriptable_key_item',
5882 5883
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5884 5885 5886 5887 5888 5889
                     '_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',
5890
                     '_portal_type_workflow_chain_item',]
5891

Christophe Dumez's avatar
Christophe Dumez committed
5892
      # Text objects (no need to export them into XML)
5893
      # XXX Bad naming
5894 5895
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5896
                     '_test_item', '_message_translation_item',]
5897

5898
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5899 5900 5901
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5902 5903
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
5904
        # XML Export in memory
5905
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5906 5907
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5908
        new_obj_xml = f1.getvalue()
5909
        f1.close()
5910 5911 5912 5913
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5914
        # End of XML export
5915

5916
        # Diff between XML objects
5917 5918
        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
5919
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5920 5921 5922
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5923

5924
      elif item_name in item_list_2:
5925
        # Generate XML code manually
5926 5927
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5928 5929
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5930
        # End of XML Code Generation
5931

5932
        # Diff between XML objects
5933 5934
        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
5935
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5936 5937 5938
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5939

5940
      elif item_name in item_list_3:
5941
        # Diff between text objects
5942 5943 5944 5945
        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
5946
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5947 5948
          diff_msg += '\n'.join(diff_list)
        else:
5949
          diff_msg = 'No diff'
5950

5951
      else:
5952
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5953

5954
      if compare_to_zodb:
5955
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5956

5957
      return diff_msg
5958

5959

5960 5961 5962 5963
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5964 5965
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5966 5967 5968 5969 5970 5971 5972
      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 [])
5973 5974
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5975
      p = self.getPortalObject()
5976
      for id in bt_portal_types_id_list:
5977 5978
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5979
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5980
        if portal_type.getRoleInformationList():
5981 5982
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5983

5984 5985 5986 5987
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5988
        action_list = []
5989 5990 5991 5992 5993 5994 5995
        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'):
5996
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5997 5998
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5999

6000 6001 6002 6003
        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)
6004

6005
        for h_id in hidden_content_type_list:
6006 6007 6008
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
6009

6010 6011 6012 6013
        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)
6014

6015 6016 6017 6018
        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)
6019

6020 6021 6022 6023
        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)
6024

6025
        for workflow_id in [chain for chain in wtool.getChainFor(id)
6026
                                    if chain != '(Default)']:
6027 6028 6029
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
6030

6031 6032 6033 6034
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
6035
      bt_action_list.sort()
6036
      bt_wf_chain_list.sort()
6037

6038 6039 6040 6041 6042 6043 6044
      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)
6045 6046 6047 6048 6049 6050 6051 6052 6053
      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:
6054 6055
        raise TemplateConditionError, 'No module defined in business template'

6056 6057 6058 6059 6060 6061 6062 6063
      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:
6064
          return type_list
6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078

        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():
6079
            type_list.update(getChildPortalType(hidden_ptype_id))
6080
        return type_list
6081

6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128
      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

6129 6130 6131
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
6132
  setattr(BusinessTemplate, key, None)
6133

6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160
# Transaction Manager used for update of business template workflow
# XXX update seems to works without it

# from Shared.DC.ZRDB.TM import TM

# class WorkflowUpdateTM(TM):

#   _p_oid=_p_changed=_registered=None
#   _update = 0

#   def __init__(self, ):
#     LOG('init TM', 0, '')

#   def register(self, update=0, gen=None, site=None):
#     LOG('register TM', 0, update)
#     self._gen = gen
#     self._site = site
#     self._update = update
#     self._register()

#   def tpc_prepare(self, *d, **kw):
#     LOG("tpc_prepare", 0, self._update)
#     if self._update:
#       # do it one time
#       self._update = 0
#       LOG('call update of wf', 0, '')
#       self._gen.setupWorkflow(self._site)
6161

6162 6163 6164 6165 6166 6167 6168 6169

#   def _finish(self, **kw):
#     LOG('finish TM', 0, '')
#     pass

#   def _abort(self, **kw):
#     LOG('abort TM', 0, '')
#     pass
6170