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

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

82 83 84 85 86 87 88 89 90 91 92 93 94
import gdbm
import threading

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

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

102 103 104
catalog_method_filter_list = ('_filter_expression_archive',
                              '_filter_expression_instance_archive',
                              '_filter_type_archive',)
105

106 107
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'

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

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

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

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

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
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]

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
def registerSkinFolder(skin_tool, skin_folder):
  request = skin_tool.REQUEST
  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()

213 214 215
  if isinstance(skin_selection_list, basestring):
    skin_selection_list = skin_selection_list.split()

216 217 218 219 220 221 222 223 224
  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 ''
225
    selection_list = selection.split(',')
226
    if (skin_folder_id not in selection_list):
227
      selection_list.insert(0, skin_folder_id)
228 229
    if reorder_skin_selection:
      selection_list.sort(
230 231
        key=lambda x: x in skin_tool.objectIds() and skin_tool[x].getProperty(
        'business_template_skin_layer_priority', skin_tool[x].meta_type == 'Filesystem Directory View' and -1 or 0) or 0, reverse=True)
232
    if (skin_name in skin_layer_list):
233 234 235 236 237 238 239 240 241 242 243 244 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
      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
292 293 294
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
295
  """
Aurel's avatar
Aurel committed
296 297 298 299 300 301 302 303 304 305 306 307

  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
308

Aurel's avatar
Aurel committed
309 310 311 312 313
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
314
    Class archiving business template into a folder tree
315
  """
Aurel's avatar
Aurel committed
316 317 318 319 320 321
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
322
      shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
323 324 325
      os.makedirs(self.path)

  def addFolder(self, name=''):
Jérome Perrin's avatar
Jérome Perrin committed
326
    if name != '':
327
      name = os.path.normpath(name)
Aurel's avatar
Aurel committed
328
      path = os.path.join(self.path, name)
329
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
330 331 332
        os.makedirs(path)
      return path

333
  def addObject(self, obj, name, path=None, ext='.xml'):
334 335 336
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
337 338 339
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
340
      if '%' not in path:
341 342 343 344
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
Aurel's avatar
Aurel committed
345
      object_path = os.path.join(path, name)
346
    f = open(object_path+ext, 'wb')
347
    f.write(str(obj))
Aurel's avatar
Aurel committed
348 349 350
    f.close()

  def _initImport(self, file=None, path=None, **kw):
351
    # Normalize the paths to eliminate the effect of double-slashes.
352 353 354 355 356 357 358 359
    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
360

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

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

  def _initCreation(self, path):
395
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
396 397 398 399 400
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
401
      shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
402 403 404 405 406 407
      os.makedirs(self.path)
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)

  def addFolder(self, name=''):
408
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
409
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
410 411
      os.makedirs(name)

412
  def addObject(self, obj, name, path=None, ext='.xml'):
413 414 415
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
416 417 418
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
419
      if '%' not in path:
420 421 422 423
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
Aurel's avatar
Aurel committed
424
      object_path = os.path.join(path, name)
425
    f = open(object_path+ext, 'wb')
426
    f.write(str(obj))
Aurel's avatar
Aurel committed
427 428 429 430 431
    f.close()

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
432
    shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
433 434 435 436 437
    return self.fobj

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

438
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
439 440
    """
      Import all file from the archive to the site
441
    """
442
    class_name = item.__class__.__name__
Aurel's avatar
Aurel committed
443 444 445 446 447
    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
448 449
      if 'CVS' in info.name.split('/'):
        continue
Yoshinori Okuji's avatar
Yoshinori Okuji committed
450 451
      if '.svn' in info.name.split('/'):
        continue
452
      if class_name in info.name.split('/'):
Aurel's avatar
Aurel committed
453 454
        if info.isreg():
          file = tar.extractfile(info)
455 456
          tar_file_name = info.name.startswith('./') and info.name[2:] or \
              info.name
457
          folders = tar_file_name.split('/')
458
          file_name = ('/').join(folders[2:])
459
          if '%' in file_name:
460
            file_name = unquote(file_name)
461
          item._importFile(file_name, file)
Aurel's avatar
Aurel committed
462 463 464
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
465

466
class TemplateConditionError(Exception): pass
467
class TemplateConflictError(Exception): pass
468
class BusinessTemplateMissingDependency(Exception): pass
469

470
class BaseTemplateItem(Implicit, Persistent):
471
  """
472
    This class is the base class for all template items.
473
    is_bt_for_diff means This BT is used to compare self temporary BT with installed BT
474
  """
475
  is_bt_for_diff = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
476

477
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
478
    self.__dict__.update(kw)
479
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
480
    self._objects = PersistentMapping()
481
    for id in id_list:
482 483
      if id is not None and id != '':
        self._archive[id] = None
484 485 486 487

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

488
  def preinstall(self, context, installed_bt, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
489 490 491 492 493 494 495 496
    """
      Build a list of added/removed/changed files between the BusinessTemplate
      being installed (self) and the installed one (installed_bt).
      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
497 498
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
499
      new_keys = self._objects.keys()
500
      for path in new_keys:
501
        if installed_bt._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
502
          # compare objects to see it there are changes
503 504
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
505 506
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
507
          # else, compared versions are identical, don't overwrite the old one
508 509
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
510
      # list removed objects
511 512 513 514 515 516 517
      old_keys = installed_bt._objects.keys()
      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):
518
    pass
519 520 521

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

523
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
524 525 526 527 528 529
    """
      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.
    """
530 531 532
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
533
    keys.reverse()
534 535 536 537 538 539 540 541 542 543 544
    # 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)
545 546 547 548
        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
549

550

551 552 553 554
  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
555
  def export(self, context, bta, **kw):
556
    pass
Aurel's avatar
Aurel committed
557

558 559
  def getKeys(self):
    return self._objects.keys()
560

Aurel's avatar
Aurel committed
561
  def importFile(self, bta, **kw):
562
    bta.importFiles(item=self)
563

564 565 566
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
567
    """
568 569 570 571 572 573 574 575 576 577 578 579 580 581
    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):
582
        obj.deletePdfContent()
583 584
    elif meta_type == 'Script (Python)':
      obj._code = None
585 586
    return obj

587 588 589
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
590
  """
591

592 593 594 595
  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()
596
      self._archive.clear()
597 598 599
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
600

601
  def export(self, context, bta, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
602 603 604 605
    """
      Export the business template : fill the BusinessTemplateArchive with
      objects exported as XML, hierarchicaly organised.
    """
606 607 608
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
Vincent Pelletier's avatar
Vincent Pelletier committed
609
    for key, obj in self._objects.iteritems():
610
      # create folder and subfolders
611
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
612 613 614
      encode_folders = []
      for folder in folders.split('/'):
        if '%' not in folder:
615
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
616 617 618
        else:
          encode_folders.append(folder)
      path = os.path.join(root_path, (os.sep).join(encode_folders))
619 620 621
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
622 623
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
624

Aurel's avatar
Aurel committed
625
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
626
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
627 628 629
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
630
      relative_url = '/'.join([url,id])
631 632
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
633
      obj = self.removeProperties(obj)
Vincent Pelletier's avatar
Vincent Pelletier committed
634 635 636
      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
637
        groups = deepcopy(obj.groups)
638
      if id_list:
Aurel's avatar
Aurel committed
639
        self.build_sub_objects(context, id_list, relative_url)
640
        for id_ in list(id_list):
641
          obj._delObject(id_)
642
      if hasattr(aq_base(obj), 'groups'):
643 644 645
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
646 647
    return sub_list

648 649 650 651
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
652 653 654 655
      try:
        obj = p.unrestrictedTraverse(relative_url)
      except ValueError:
        raise ValueError, "Can not access to %s" % relative_url
656 657 658 659
      try:
        obj = obj._getCopy(context)
      except AttributeError:
        raise AttributeError, "Could not find object '%s' during business template processing." % relative_url
660
      _recursiveRemoveUid(obj)
661
      obj = self.removeProperties(obj)
662
      id_list = obj.objectIds()
Vincent Pelletier's avatar
Vincent Pelletier committed
663 664
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
665
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
666 667
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
668
        for id_ in list(id_list):
669
          obj._delObject(id_)
670
      if hasattr(aq_base(obj), 'groups'):
671 672 673
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
674

675
  def _compileXML(self, file):
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 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
    # 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
735

736
  def _importFile(self, file_name, file_obj):
737
    # import xml file
738
    if not file_name.endswith('.xml'):
739
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
740
      return
741 742 743 744 745
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
746
    __traceback_info__ = 'Importing %s' % file_name
747 748
    if hasattr(cache_database, 'db') and isinstance(file_obj, file):
      obj = connection.importFile(self._compileXML(file_obj))
749
    else:
750 751
      # FIXME: Why not use the importXML function directly? Are there any BT5s
      # with actual .zexp files on the wild?
752
      obj = connection.importFile(file_obj, customImporters=customImporters)
753
    self.removeProperties(obj)
754 755
    self._objects[file_name[:-4]] = obj

756
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
757 758
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
759 760 761
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
      for path in self._objects:
762
        if installed_bt._objects.has_key(path):
Julien Muchembled's avatar
Julien Muchembled committed
763 764
          upgrade_list.append((path,
            self.removeProperties(installed_bt._objects[path])))
765
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
          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)
        OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
        new_obj_xml = new_io.getvalue()
        old_obj_xml = old_io.getvalue()
        new_io.close()
        old_io.close()
        if new_obj_xml != old_obj_xml:
          modified_object_list[path] = 'Modified', type_name
782
      # get removed object
Julien Muchembled's avatar
Julien Muchembled committed
783 784
      for path in set(installed_bt._objects) - set(self._objects):
        modified_object_list[path] = 'Removed', type_name
785 786
    return modified_object_list

787
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
788 789 790
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
791
    subobjects_dict = {}
792
    if trashbin is None: # must return subobjects
793 794 795 796 797 798
      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)
799
        subobjects_dict[subobject_id] = subobject_copy
800
      return subobjects_dict
801
    # XXX btsave is for backward compatibility
802
    if action == 'backup' or action == 'btsave' or action == 'save_and_remove':
803
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, **kw)
804
    elif action == 'install':
805
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0, **kw)
806 807 808 809
    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
810
    return subobjects_dict
811

812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
  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

  def onNewObject(self):
    """
      Installation hook.
      Called when installation process determined that object to install is
      new on current site (it's not replacing an existing object).
      Can be overridden by subclasses.
    """
    pass

837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
  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

854
  def install(self, context, trashbin, **kw):
855
    self.beforeInstall()
856 857
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
858
    if context.getTemplateFormatVersion() == 1:
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
      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
878
      groups = {}
879
      old_groups = {}
880 881 882 883
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
884 885
      # set safe activities execution order
      original_reindex_parameters = self.setSafeReindexationMode(context)
886
      for path in keys:
887 888
        if update_dict.has_key(path) or force:
          # get action for the oject
Yoshinori Okuji's avatar
Yoshinori Okuji committed
889
          action = 'backup'
890 891 892 893 894
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          # get subobjects in path
895 896 897
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
898 899 900 901
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
902
            container_url = '/'.join(container_path)
903 904 905 906
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
907
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
908 909
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
910
              container_container = portal.unrestrictedTraverse(container_path[:-1])
911 912 913 914 915
              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)
916 917
            else:
              raise
918
          saved_uid_dict = {}
919
          subobjects_dict = {}
Julien Muchembled's avatar
Julien Muchembled committed
920
          portal_type_dict = {}
921
          # Object already exists
922 923
          old_obj = container._getOb(object_id, None)
          if old_obj is not None:
924
            recurse(saveHook, old_obj)
925
            if getattr(aq_base(old_obj), 'groups', None) is not None:
926 927 928 929 930
              # 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)
931
            subobjects_dict = self._backupObject(action, trashbin,
932
                                                 container_path, object_id)
Julien Muchembled's avatar
Julien Muchembled committed
933
            # in case of portal types, we want to keep some properties
934
            if getattr(old_obj, 'meta_type', None) == 'ERP5 Base Type':
935
              for attr in ('allowed_content_types',
Julien Muchembled's avatar
Julien Muchembled committed
936 937 938 939 940 941
                           '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, '')
942
            container.manage_delObjects([object_id])
943 944
          else:
            self.onNewObject()
945
          # install object
946
          obj = self._objects[path]
947 948 949
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
950
          if getattr(aq_base(obj), 'groups', None) is not None:
951
            # we must keep original order groups
952
            # because they change when we add subobjects
953
            groups[path] = deepcopy(obj.groups)
954
          # copy the object
955 956 957 958 959 960 961
          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
962
                'Cleaning corrupted BTreeFolder2 object at %r.' % (path,))
963
            obj._initBTrees()
964
          obj = obj._getCopy(container)
965 966 967 968 969
          try:
            container._setObject(object_id, obj)
          except AttributeError:
            LOG("BT, install", 0, object_id)
            raise
970
          obj = container._getOb(object_id)
971 972
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
973
          self.REQUEST.set('is_business_template_installation', 1)
974 975 976 977
          # 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
978
          obj.isIndexable = ConstantGetter('isIndexable', value=False)
979
          obj.manage_afterClone(obj)
980 981 982
          del obj.isIndexable
          if getattr(aq_base(obj), 'reindexObject', None) is not None:
            obj.reindexObject()
983
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
984
          if portal_type_dict:
985
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
986
            wf_chain = portal_type_dict.pop('workflow_chain')
987 988
            chain_dict = getChainByType(context)[1]
            default_chain = ''
989
            chain_dict['chain_%s' % (object_id)] = wf_chain
990
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
991 992
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
993
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
994
          if subobjects_dict:
995
            # get a jar
996 997
            connection = obj._p_jar
            o = obj
998
            while connection is None:
999 1000
              o = o.aq_parent
              connection = o._p_jar
1001
            # import subobjects
1002
            for subobject_id, subobject_data in subobjects_dict.iteritems():
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
              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))
1014
          if obj.meta_type in ('Z SQL Method',):
1015
            fixZSQLMethod(portal, obj)
1016 1017 1018
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
1019 1020 1021
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
1022
          elif obj.meta_type in ('ERP5 Ram Cache',
1023
                                 'ERP5 Distributed Ram Cache',):
1024 1025
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
1026 1027
          elif (container.meta_type == 'CMF Skins Tool') and \
              (old_obj is not None):
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
            # 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')
1042
           
1043
          recurse(restoreHook, obj)
1044
      # now put original order group
1045 1046
      # we remove object not added in forms
      # we put old objects we have kept
1047
      for path, new_groups_dict in groups.iteritems():
1048 1049 1050 1051 1052 1053 1054 1055 1056
        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
1057
          # excetp the one that had to be removed
1058 1059 1060 1061
          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'):
1062 1063
              continue
            widget_in_form = 0
1064 1065
            for group_id, group_value_list in new_groups_dict.iteritems():
              if widget_id in group_value_list:
1066 1067 1068 1069 1070 1071
                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:
1072
              for old_group_id, old_group_values in old_groups_dict.iteritems():
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
                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,]
1084
                  obj.group_list = list(obj.group_list) + ['not_assigned']
1085
          # second check all widget_id in order are in form
1086 1087
          for group_id, group_value_list in new_groups_dict.iteritems():
            for widget_id in tuple(group_value_list):
1088 1089 1090
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
1091
                group_value_list.remove(widget_id)
1092
          # now set new group object
1093
          obj.groups = new_groups_dict
1094
      # restore previous activities execution order
1095
      context.setPlacelessDefaultReindexParameters(**original_reindex_parameters)
Aurel's avatar
Aurel committed
1096
    else:
1097 1098
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1099
      portal = context.getPortalObject()
1100
      for relative_url in self._archive.keys():
1101
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
1102 1103 1104 1105
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
1106
        if object_id in container_ids:    # Object already exists
1107
          self._backupObject('backup', trashbin, container_path, object_id)
1108
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
1109
        # Set a hard link
1110 1111 1112 1113 1114 1115
        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',):
1116
          fixZSQLMethod(portal, obj)
1117
    self.afterInstall()
1118 1119 1120

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
1121
    trash = kw.get('trash', 0)
1122 1123 1124 1125 1126
    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
1127
      object_keys = self._archive.keys()
1128
    for relative_url in object_keys:
1129 1130
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
1131
      try:
1132
        container = portal.unrestrictedTraverse(container_path)
1133
        object = container._getOb(object_id) # We force access to the object to be sure
1134 1135
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
1136
        if trash and trashbin is not None:
1137
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
1138
        if container.meta_type == 'CMF Skins Tool':
1139 1140
          # we are removing a skin folder, check and 
          # remove if registered skin selection
1141
          skin_folder = container[object_id]
1142 1143 1144
          unregisterSkinFolder(container, skin_folder,
              container.getSkinSelections())

1145
        container.manage_delObjects([object_id])
1146 1147
        if container.aq_parent.meta_type == 'ERP5 Catalog' and len(container.objectIds()) == 0:
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1148
          container.getParentValue().manage_delObjects([container.id])
1149
      except (NotFound, KeyError, BadRequest, AttributeError):
1150
        # object is already backup and/or removed
1151
        pass
1152 1153
    BaseTemplateItem.uninstall(self, context, **kw)

1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
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

1166 1167 1168 1169 1170 1171 1172 1173 1174
  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()
1175 1176
    object_keys.sort()
    object_keys.reverse()
1177 1178
    p = context.getPortalObject()
    for path in object_keys:
1179 1180 1181 1182 1183
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1184 1185 1186
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1187
        try:
Aurel's avatar
Aurel committed
1188 1189
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
1190 1191
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
1192 1193
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1194
                                           keep_subobjects=1)
1195 1196 1197 1198 1199 1200
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1201 1202 1203
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1204

1205 1206 1207 1208 1209 1210 1211 1212 1213
      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.
1214 1215 1216
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1217
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1218 1219
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1220
      if object_id != "":
1221
        path_list.extend(self._resolvePath(
1222
            folder._getOb(object_id),
1223
            relative_url_list + [object_id], id_list[1:]))
1224
    return path_list
Aurel's avatar
Aurel committed
1225

1226 1227 1228
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1229
    keys = self._path_archive.keys()
1230
    keys.sort()
Aurel's avatar
Aurel committed
1231
    for path in keys:
1232 1233 1234
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
1235
      for relative_url in self._resolvePath(p, [], path.split('/')):
1236 1237
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1238
        obj = obj.__of__(context)
1239
        _recursiveRemoveUid(obj)
1240
        id_list = obj.objectIds()
1241
        obj = self.removeProperties(obj)
1242
        if hasattr(aq_base(obj), 'groups'):
1243
          # we must keep groups because it's ereased when we delete subobjects
1244
          groups = deepcopy(obj.groups)
1245
        if len(id_list) > 0:
1246 1247
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1248
          for id_ in list(id_list):
1249
            obj._delObject(id_)
1250
        if hasattr(aq_base(obj), 'groups'):
1251 1252 1253
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1254

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1255 1256 1257 1258 1259 1260 1261 1262
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)

1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
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")
1278
    if len(id_list) != 1:
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
      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():
1291
      pref = portal.unrestrictedTraverse(object_path)
1292
      # XXX getPreferenceState is a bad name
1293
      if pref.getPreferenceState() == 'disabled':
1294 1295
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1296 1297
        portal.portal_workflow.doActionFor(
                      pref,
1298 1299 1300
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1301 1302
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1303

1304 1305
class CategoryTemplateItem(ObjectTemplateItem):

1306 1307
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1308

1309 1310 1311 1312
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1313 1314
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1315
      obj = self.removeProperties(obj)
1316
      id_list = obj.objectIds()
1317
      if id_list:
1318
        self.build_sub_objects(context, id_list, relative_url)
1319
        for id_ in list(id_list):
1320
          obj._delObject(id_)
1321 1322
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1323 1324 1325 1326 1327

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1328 1329
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1330
      _recursiveRemoveUid(obj)
1331
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1332
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1333
      id_list = obj.objectIds()
1334 1335
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1336
        for id_ in list(id_list):
1337
          obj._delObject(id_)
1338
      else:
1339
        for id_ in list(id_list):
1340
          obj._delObject(id_)
1341 1342
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1343

1344 1345 1346 1347 1348 1349 1350 1351
  def beforeInstall(self):
    self._installed_new_category = False

  def onNewObject(self):
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1352 1353
      # reset accessors if we installed a new category
      _aq_reset()
1354

1355 1356
class SkinTemplateItem(ObjectTemplateItem):

1357 1358
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1359

1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
  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')

1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_bt, **kw)
    # 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

1385
  def install(self, context, trashbin, **kw):
1386
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1387 1388
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1389
    p = context.getPortalObject()
1390
    skin_tool = p.portal_skins
1391 1392
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1393
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1394 1395
        fixZSQLMethod(p, obj)

1396
      # Do not register skin which were explicitely ask not to be installed
1397 1398 1399 1400 1401
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
      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',
          [])
      if skin_selection_id in selection_list:
        if self._objects.has_key(skin_folder_id):
          self._objects[skin_folder_id].append(skin_selection_id)
        else:
          self._objects[skin_folder_id] = [skin_selection_id]
1423
      else:
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
        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):
    if len(self._objects.keys()) == 0:
      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='registered_skin_selection',  path=root_path)

  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]
        selection_string = skin_folder.getProperty(
          'business_template_registered_skin_selections', None)

        if selection_string is None:
1469
          create_property = True
1470 1471
          selection_string = self._objects[skin_folder_id].replace(',', ' ')
        else:
1472 1473 1474
          create_property = False
          if not isinstance(selection_string, basestring):
            selection_string = ' '.join(selection_string)
1475 1476 1477 1478 1479 1480
          selection_string += ' %s' % \
            self._objects[skin_folder_id].replace(',', ' ')

        # Remove duplicate
        selection_string = \
            ' '.join(dict([(x, 0) for x in selection_string.split(' ')]).keys())
1481 1482 1483 1484 1485 1486 1487 1488
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
              selection_string.split(' '), type='tokens')
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
              selection_string.split(' '))
1489 1490 1491 1492 1493

        selection_list = selection_string.split(' ')
        unregisterSkinFolder(skin_tool, skin_folder,
            skin_tool.getSkinSelections())
        registerSkinFolder(skin_tool, skin_folder)
1494 1495

  def uninstall(self, context, **kw):
1496 1497 1498
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1499 1500 1501 1502
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
      object_keys = self._objects.keys()

    for skin_folder_id in object_keys:
      skin_folder = skin_tool[skin_folder_id]
      current_selection_string = skin_folder.getProperty(
        'business_template_registered_skin_selections', [])
      current_selection_set = set(current_selection_string)

      skin_selection = workflow_id = self._objects[skin_folder_id]
      skin_selection_list = skin_selection.split(',')
      for skin_selection in skin_selection_list:
        current_selection_set.remove(skin_selection)

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1518
        skin_folder._updateProperty(
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
            '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)

  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
          new_object = self._objects[path]
          old_object = installed_bt._objects[path]
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      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'):
1556
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
    skin_folder_selection_list = xml.getElementsByTagName('skin_folder_selection')
    for skin_folder_selection in skin_folder_selection_list:
      skin_folder_id = skin_folder_selection.getElementsByTagName(
          'skin_folder')[0].childNodes[0].data
      selection_list = skin_folder_selection.getElementsByTagName(
          'skin_selection')[0].childNodes
      if len(selection_list) == 0:
        selection = ''
      else:
        selection = selection_list[0].data
      skin_selection_dict[str(skin_folder_id)] = str(selection)
    self._objects = skin_selection_dict
1573 1574


1575
class WorkflowTemplateItem(ObjectTemplateItem):
1576

1577 1578
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1579

1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
  # 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.

  def preinstall(self, context, installed_bt, **kw):
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
                                                         installed_bt, **kw)
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1592
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1593 1594 1595 1596
      else:
        modified_workflow_dict[modified_object] = state
    return modified_workflow_dict

1597
  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1598
    if context.getTemplateFormatVersion() == 1:
1599 1600 1601
      portal = context.getPortalObject()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
Julien Muchembled's avatar
Julien Muchembled committed
1602 1603 1604
      # sort to add objects before their subobjects
      for path in sorted(self._objects):
          if force:
1605
            action = 'backup'
Julien Muchembled's avatar
Julien Muchembled committed
1606
          else:
1607
            action = update_dict.get('/'.join(path.split('/')[:2]))
Julien Muchembled's avatar
Julien Muchembled committed
1608 1609
            if action in (None, 'nothing'):
              continue
1610 1611 1612 1613 1614 1615
          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
1616
            container_url = '/'.join(container_path)
1617 1618 1619 1620 1621 1622
            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
1623
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1624
            container.manage_delObjects([object_id])
1625
          obj = self._objects[path]
1626 1627 1628
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1629 1630 1631 1632 1633
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1634 1635 1636 1637
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1638 1639
class PortalTypeTemplateItem(ObjectTemplateItem):

1640 1641
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1642 1643
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1644 1645 1646
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1647 1648
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1649 1650
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1651 1652
      # obj is in ghost state and an attribute must be accessed
      # so that obj.__dict__ does not return an empty dict
1653
      obj.meta_type
1654
      for attr in obj.__dict__.keys():
1655 1656 1657 1658 1659 1660 1661 1662
        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)
1663 1664
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1665

1666 1667
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1668 1669 1670 1671
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1672 1673
    # We now need to setup the list of workflows corresponding to
    # each portal type
1674
    (default_chain, chain_dict) = getChainByType(context)
1675
    # Set the default chain to the empty string is probably the
1676
    # best solution, by default it is 'default_workflow', which is
1677
    # not very usefull
1678
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1679
    if context.getTemplateFormatVersion() == 1:
1680
      object_list = self._objects
1681
    else:
1682 1683
      object_list = self._archive
    for path in object_list.keys():
1684 1685 1686 1687
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1688
            continue
1689 1690
        obj = object_list[path]
        portal_type = obj.id
1691 1692 1693
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1694 1695
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1696

1697 1698
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1699 1700 1701 1702 1703 1704 1705
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
      dict = {}
      xml = parse(file)
      chain_list = xml.getElementsByTagName('chain')
      for chain in chain_list:
1706
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1707 1708 1709 1710 1711
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1712
        dict[str(ptype)] = str(workflow)
1713 1714 1715 1716
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1717
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1718 1719

  def build(self, context, **kw):
1720 1721 1722 1723 1724
    # 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
1725
    p = context.getPortalObject()
1726
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1727
    for key in self._archive.keys():
1728 1729 1730
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1731
        workflow = wflist[1]
1732
      else:
1733
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1734
        portal_type = wflist[0][:-2]
1735 1736
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1737 1738 1739 1740
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
1741
        if workflow[0] != '-' and \
1742
            workflow_name not in chain_dict['chain_%s' % portal_type].split(', '):
1743
          if not self.is_bt_for_diff:
1744 1745 1746 1747 1748
            # here, we use 'LOG' instead of 'raise', because it can
            # happen when a workflow is removed from the chain by
            # another business template.
            LOG('BusinessTemplate', WARNING, 'workflow %s not found in chain for portal_type %s'\
                % (workflow, portal_type))
1749
        if self._objects.has_key(portal_type):
1750 1751
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1752
        else:
1753
          self._objects[portal_type] = [workflow,]
1754
      elif not self.is_bt_for_diff:
1755
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1756
                        'is probably a sign of a missing dependency.'\
1757
                                                    % portal_type
1758

Christophe Dumez's avatar
Christophe Dumez committed
1759
  # Function to generate XML Code Manually
1760 1761 1762 1763 1764
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1765
      workflow_list = self._objects[key]
1766 1767 1768
      # XXX Not always a list
      if isinstance(workflow_list, str):
        workflow_list = [workflow_list]
1769 1770
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
1771
      xml_data += '\n  <workflow>%s</workflow>' %(', '.join(sorted(workflow_list)))
1772 1773
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
    return xml_data

  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)
    # 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
1790
    (default_chain, chain_dict) = getChainByType(context)
1791
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1792
    # best solution, by default it is 'default_workflow', which is
1793 1794 1795 1796 1797 1798 1799
    # not very usefull
    default_chain = ''
    for path in self._objects.keys():
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1800
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1801 1802
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
1803
        if len(path_splitted) < 1:
Jérome Perrin's avatar
Jérome Perrin committed
1804
          continue
1805
        portal_type = path_splitted[-1]
1806
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1807 1808 1809
          old_chain_dict = chain_dict['chain_%s' % portal_type]
          # XXX we don't use the chain (Default) in erp5 so don't keep it
          if old_chain_dict != '(Default)' and old_chain_dict != '':
1810
            old_chain_workflow_id_set = {}
1811
            # get existing workflow id list
1812 1813
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1814
            # get new workflow id list
1815
            for wf_id in self._objects[path].split(', '):
1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829
              if wf_id[0] == '-':
                # remove wf id if already present
                if old_chain_workflow_id_set.has_key(wf_id[1:]):
                  old_chain_workflow_id_set.pop(wf_id[1:])
              elif wf_id[0] == '=':
                # replace existing chain by this one
                old_chain_workflow_id_set = {}
                old_chain_workflow_id_set[wf_id[1:]] = 1
              # then either '+' or nothing, add wf id to the list
              elif wf_id[0] == '+':
                old_chain_workflow_id_set[wf_id[1:]] = 1
              else:
                old_chain_workflow_id_set[wf_id] = 1
            # create the new chain
1830 1831
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1832
          else:
Romain Courteaud's avatar
Romain Courteaud committed
1833 1834 1835 1836 1837 1838
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
            for wf_id in self._objects[path].split(', '):
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
1839
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1840
        else:
1841 1842 1843 1844
          if portal_type not in context.portal_types.objectIds():
            raise ValueError('Cannot chain workflow %r to non existing '
                           'portal type %r' % (self._objects[path],
                                               portal_type))
Aurel's avatar
Aurel committed
1845
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1846 1847
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1848

1849 1850
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1851 1852 1853 1854 1855 1856
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._objects.keys()
    for path in object_keys:
1857 1858 1859 1860 1861 1862
      path_splitted = path.split('/', 1)
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
      id = 'chain_%s' % portal_type
      if id in chain_dict.keys():
1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874
        chain = chain_dict[id]
        # It should be better to use regexp
        chain = chain.replace(' ', '')
        workflow_list = chain.split(',')
        workflow_id = self._objects[path]
        for i in range(workflow_list.count(workflow_id)):
          workflow_list.remove(workflow_id)
        chain = ', '.join(workflow_list)
        if chain == '':
          del chain_dict[id]
        else:
          chain_dict[id] = chain
1875
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1876

1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
      for key in installed_bt._objects.keys():
        if not "portal_type_workflow_chain/" in key:
          new_key = 'portal_type_workflow_chain/%s' %key
          new_dict[new_key] = installed_bt._objects[key]
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
        installed_bt._objects = new_dict
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
          new_object = self._objects[path]
          old_object = installed_bt._objects[path]
          # compare same type of object
          if isinstance(old_object, list) or isinstance(old_object, tuple):
            old_object = ', '.join(old_object)
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      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

1910
  def _importFile(self, file_name, file):
1911
    if not file_name.endswith('.xml'):
1912
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1913
      return
1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
    # import workflow chain for portal_type
    dict = {}
    xml = parse(file)
    chain_list = xml.getElementsByTagName('chain')
    for chain in chain_list:
      ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
      workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
      if len(workflow_list) == 0:
        workflow = ''
      else:
        workflow = workflow_list[0].data
1925 1926
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1927 1928 1929
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1930 1931
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1932

1933
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
1934 1935 1936
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
1937 1938
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
1939
  business_template_class_property = '_portal_type_allowed_content_type_item'
1940 1941

  def build(self, context, **kw):
1942 1943
    types_tool = self.getPortalObject().portal_types
    types_list = list(types_tool.objectIds())
1944
    for key in self._archive.keys():
1945 1946 1947 1948
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
1949 1950 1951 1952 1953
      # check properties corresponds to what is defined in site
      if not portal_type in types_list:
        raise ValueError, "Portal Type %s not found in site" %(portal_type,)
      ob = types_tool._getOb(portal_type)
      prop_value = getattr(ob, self.class_property, ())
1954
      if not allowed_type in prop_value and not self.is_bt_for_diff:
Jérome Perrin's avatar
Jérome Perrin committed
1955
        raise ValueError, "%s %s not found in portal type %s" % (
1956 1957 1958
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)

1959 1960 1961 1962 1963 1964 1965
      if self._objects.has_key(portal_type):
        allowed_list = self._objects[portal_type]
        allowed_list.append(allowed_type)
        self._objects[portal_type] = allowed_list
      else:
        self._objects[portal_type] = [allowed_type]

Christophe Dumez's avatar
Christophe Dumez committed
1966
  # Function to generate XML Code Manually
1967
  def generateXml(self, path=None):
1968
    dictio = self._objects
1969
    xml_data = '<%s>' %(self.xml_tag,)
1970
    keys = dictio.keys()
1971 1972
    keys.sort()
    for key in keys:
1973
      allowed_list = sorted(dictio[key])
1974
      xml_data += '\n <portal_type id="%s">' %(key,)
1975
      for allowed_item in allowed_list:
1976 1977 1978
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989
    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)
    path = self.__class__.__name__+os.sep+self.class_property
    xml_data = self.generateXml(path=None)
    bta.addObject(obj=xml_data, name=path, path=None)

1990 1991 1992 1993 1994
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
1995 1996 1997 1998
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
      for key in installed_bt._objects.keys():
        if self.class_property not in key:
1999
          new_key = '%s/%s' % (self.class_property, key)
2000
          new_dict[new_key] = installed_bt._objects[key]
2001 2002 2003
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
2004 2005 2006 2007 2008
        installed_bt._objects = new_dict
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
          new_object = self._objects[path]
2009
          old_object = installed_bt._objects[path]
2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      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

2021
  def _importFile(self, file_name, file):
2022
    if not file_name.endswith('.xml'):
2023
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2024
      return
2025
    path, name = posixpath.split(file_name)
2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040
    xml = parse(file)
    portal_type_list = xml.getElementsByTagName('portal_type')
    for portal_type in portal_type_list:
      id = portal_type.getAttribute('id')
      item_type_list = []
      item_list = portal_type.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      self._objects[self.class_property+'/'+id] = item_type_list

  def install(self, context, trashbin, **kw):
    p = context.getPortalObject()
    pt = p.unrestrictedTraverse('portal_types')
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2041 2042 2043 2044 2045 2046 2047
    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())):
2048 2049 2050 2051 2052
      if update_dict.has_key(key) or force:
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2053 2054 2055 2056
        try:
          portal_id = key.split('/')[-1]
          portal_type = pt._getOb(portal_id)
        except (AttributeError, KeyError):
2057 2058
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2059 2060
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
2061 2062 2063
        object_property_list = getattr(portal_type, self.class_property, ())
        if len(object_property_list) > 0:
          # merge differences between portal types properties
2064 2065 2066 2067 2068
          # 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
2069
          for id in object_property_list:
2070
            if id not in property_list and id not in old_property_list:
2071
              property_list.append(id)
2072
        setattr(portal_type, self.class_property, tuple(property_list))
2073

Aurel's avatar
Aurel committed
2074
  def uninstall(self, context, **kw):
2075
    object_path = kw.get('object_path', None)
2076
    p = context.getPortalObject()
2077
    pt = p.unrestrictedTraverse('portal_types')
2078 2079 2080 2081 2082 2083 2084 2085
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._objects.keys()
    for key in object_keys:
      try:
        portal_id = key.split('/')[-1]
        portal_type = pt._getOb(portal_id)
2086
      except (AttributeError,  KeyError):
2087 2088 2089
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
2090 2091
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2092 2093
      for id in property_list:
        if id in original_property_list:
2094
          original_property_list.remove(id)
2095
      setattr(portal_type, self.class_property, tuple(original_property_list))
2096

2097

2098 2099
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2100
  name = 'Hidden Content Type'
2101 2102
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2103
  business_template_class_property = '_portal_type_hidden_content_type_item'
2104

2105

2106 2107
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2108
  name = 'Property Sheet'
2109 2110
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2111
  business_template_class_property = '_portal_type_property_sheet_item'
2112

2113

2114 2115
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2116
  name = 'Base Category'
2117 2118
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2119
  business_template_class_property = '_portal_type_base_category_item'
2120

2121

2122
class CatalogMethodTemplateItem(ObjectTemplateItem):
2123
  """Template Item for catalog methods.
2124

2125 2126 2127 2128 2129
    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.
  """
2130

2131 2132
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2133
    # a mapping to store properties of methods.
2134 2135 2136 2137 2138
    # 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()
2139

2140 2141 2142 2143 2144
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158
  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

2159 2160
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2161

2162
    catalog = _getCatalogValue(self)
2163
    if catalog is None:
2164
      LOG('BusinessTemplate build', 0, 'catalog not found')
2165
      return
2166

2167 2168 2169
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2170

2171 2172
    for obj in self._objects.values():
      method_id = obj.id
2173 2174
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2175
      self._is_filtered_archive[method_id] = 0
2176
      if catalog.filter_dict.has_key(method_id):
2177 2178 2179 2180 2181 2182 2183 2184 2185
        if catalog.filter_dict[method_id]['filtered']:
          self._is_filtered_archive[method_id] = \
                      catalog.filter_dict[method_id]['filtered']
          self._filter_expression_archive[method_id] = \
                      catalog.filter_dict[method_id]['expression']
          self._filter_expression_instance_archive[method_id] = \
                      catalog.filter_dict[method_id]['expression_instance']
          self._filter_type_archive[method_id] = \
                      catalog.filter_dict[method_id]['type']
2186

2187
  def generateXml(self, path):
2188
    catalog = _getCatalogValue(self)
2189 2190 2191 2192
    obj = self._objects[path]
    method_id = obj.id
    xml_data = '<catalog_method>'
    if self._method_properties.has_key(method_id):
2193
      for method_property, value in self._method_properties[method_id].items():
2194 2195 2196
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2197

Aurel's avatar
Aurel committed
2198
      if catalog.filter_dict.has_key(method_id):
2199
        if catalog.filter_dict[method_id]['filtered']:
2200 2201 2202
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2203
          for method in catalog_method_filter_list:
2204 2205 2206 2207 2208
            try:
              value = getattr(self, method, '')[method_id]
            except KeyError:
              # the method has no key
              continue
2209 2210
            if method != '_filter_expression_instance_archive':
              if type(value) in (type(''), type(u'')):
2211 2212 2213
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2214
              elif type(value) in (type(()), type([])):
2215
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2216
                for item in value:
2217 2218
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2219
    xml_data += '\n</catalog_method>'
Christophe Dumez's avatar
Christophe Dumez committed
2220
    return xml_data
2221

2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250
  def preinstall(self, context, installed_bt, **kw):
    modified_object_dict = ObjectTemplateItem.preinstall(self, context, installed_bt, **kw)
    modified_object_dict.update(BaseTemplateItem.preinstall(self, context, installed_bt, **kw))
    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)

2251 2252
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2253
    catalog = _getCatalogValue(self)
2254 2255 2256 2257 2258 2259 2260
    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)
2261

2262 2263 2264
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2265
    new_bt_format = context.getTemplateFormatVersion()
2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281

    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':
2282
              continue
2283 2284 2285 2286
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2287

2288 2289
    for obj in values:
      method_id = obj.id
2290

2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301
      # 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)
          elif isinstance(old_value, list) or isinstance(old_value, tuple):
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2302

2303 2304
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2305
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2306
        if context.getTemplateFormatVersion() == 1:
2307 2308 2309
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2310
        filter_type = self._filter_type_archive[method_id]
2311 2312 2313
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2314
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2315
        catalog.filter_dict[method_id]['type'] = filter_type
2316
      elif method_id in catalog.filter_dict.keys():
2317
        catalog.filter_dict[method_id]['filtered'] = 0
2318

2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344
      # 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)
2345

2346 2347 2348 2349 2350 2351
        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)
2352

2353
  def uninstall(self, context, **kw):
2354
    catalog = _getCatalogValue(self)
2355 2356 2357
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2358

2359 2360 2361 2362
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2363 2364 2365 2366
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2367
    else:
2368 2369 2370 2371
      try:
        value = self._archive[object_path]
      except KeyError:
        value = None
2372 2373
      if value is not None:
        values.append(value)
2374
    for obj in values:
2375
      method_id = obj.id
2376 2377 2378 2379 2380 2381 2382 2383 2384
      # 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)
2385

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2386
      if catalog.filter_dict.has_key(method_id):
2387
        del catalog.filter_dict[method_id]
2388

2389
    # uninstall objects
2390
    ObjectTemplateItem.uninstall(self, context, **kw)
2391

2392
  def _importFile(self, file_name, file):
2393
    if file_name.endswith('.catalog_keys.xml'):
2394
      # recreate data mapping specific to catalog method
2395 2396
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2397
      xml = parse(file)
2398
      method_list = xml.getElementsByTagName('item')
2399
      for method in method_list:
2400
        key = method.getAttribute('key')
2401 2402
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
2403 2404 2405 2406
          if len(method.getElementsByTagName('value')[0].childNodes):
            value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          else:
            value = ''
2407
          key = str(key)
2408
        elif key_type == "int":
2409
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
2410
          key = str(key)
2411
        elif key_type == "tuple":
2412 2413 2414 2415
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
2416
        else:
2417
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2418
          continue
2419
        if key in catalog_method_list or key in catalog_method_filter_list:
2420
          dict = getattr(self, key, {})
2421
          dict[id] = value
2422 2423 2424
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436
    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, ))
2437

2438
class ActionTemplateItem(ObjectTemplateItem):
2439 2440

  def __init__(self, id_list, **kw):
2441
    # XXX It's look like ObjectTemplateItem __init__
2442 2443 2444 2445 2446 2447
    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

2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468
  def _splitPath(self, path):
    """
      Split path tries to split a complexe path such as:

      "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

2469 2470 2471 2472
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2473 2474 2475
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
Julien Muchembled's avatar
Julien Muchembled committed
2476
      # Several tools still use CMF actions
2477
      is_new_action = obj.getParentId() == 'portal_types'
2478
      id_id = is_new_action and 'reference' or 'id'
2479 2480
      for action in (is_new_action and obj.getActionInformationList
                                    or obj.listActions)():
2481
        if getattr(action, id_id, None) == value:
2482
          break
2483
      else:
2484 2485 2486 2487 2488 2489 2490
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
      if is_new_action:
        action = obj._exportOldAction(action)
      else:
        action = action._getCopy(context)
2491
      key = posixpath.join(url[-2], url[-1], value)
2492
      self._objects[key] = self.removeProperties(action)
2493
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2494

2495 2496 2497
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2498
    if context.getTemplateFormatVersion() == 1:
2499
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2500 2501
      p = context.getPortalObject()
      for id in self._objects.keys():
2502 2503 2504 2505 2506
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2507 2508 2509
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2510

2511
          if container.getParentId() == 'portal_types':
2512 2513 2514
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2515 2516
            continue

Julien Muchembled's avatar
Julien Muchembled committed
2517 2518
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534
          try:
            from Products.CMFCore.interfaces import IActionProvider
          except ImportError:
              # 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,
                  'Misplaced action',
                  '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
2535
          obj, action = container, obj
2536
          action_list = obj.listActions()
2537
          for index in range(len(action_list)):
2538
            if action_list[index].id == id:
2539
              # remove previous action
2540
              obj.deleteActions(selections=(index,))
2541 2542 2543
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2544
          obj.addAction(
2545 2546
                        id = action.id
                      , name = action.title
2547
                      , action = action_text
2548 2549 2550 2551
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2552 2553
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2554
                      , priority = action.priority
2555
                      , description = action.description
Aurel's avatar
Aurel committed
2556
                    )
2557
          # sort action based on the priority define on it
2558 2559 2560 2561 2562 2563 2564 2565 2566
          # 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))
2567 2568
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2569
        container.manage_delObjects([obj.id
2570
          for obj in container.getActionInformationList()
2571
          if obj.getReference() in action_dict])
2572 2573
        for obj in action_dict.itervalues():
          container._importOldAction(obj)
Aurel's avatar
Aurel committed
2574
    else:
2575
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2576
      p = context.getPortalObject()
2577 2578
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2579
        relative_url, key, value = self._splitPath(id)
2580 2581
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2582
          if getattr(ai, key) == value:
2583
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2584 2585 2586
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2587
        obj.addAction(
Aurel's avatar
Aurel committed
2588 2589
                      id = action.id
                    , name = action.title
2590
                    , action = action_text
Aurel's avatar
Aurel committed
2591 2592 2593 2594
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2595 2596
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2597
                    )
Aurel's avatar
Aurel committed
2598 2599 2600 2601 2602 2603 2604
        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))
2605 2606
          obj.moveDownActions(selections=tuple(move_down_list))

2607 2608
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2609 2610
    object_path = kw.get("object_path", None)
    if object_path is not None:
2611 2612 2613 2614 2615 2616 2617 2618
      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]
2619
    else:
2620
      keys = self._archive.keys()
2621
    for id in keys:
2622 2623
      if  '|' in id:
        relative_url, value = id.split(' | ')
2624 2625 2626 2627 2628
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
          is_new_action = obj.getParentId() == 'portal_types'
          key = is_new_action and 'reference' or 'id'
2629
      else:
2630
        relative_url, key, value = self._splitPath(id)
2631
        obj = p.unrestrictedTraverse(relative_url, None)
2632 2633 2634
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2635
          if getattr(action_list[index], key, None) == value:
2636 2637
            obj.deleteActions(selections=(index,))
            break
2638 2639
      LOG('BusinessTemplate', 100,
          'unable to uninstall action at %s, ignoring' % relative_url )
2640 2641
    BaseTemplateItem.uninstall(self, context, **kw)

2642 2643 2644
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2645
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2646 2647 2648 2649 2650 2651 2652
    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])
2653
      self._objects[relative_url] = type_role_list = []
2654
      for role in obj.getRoleInformationList():
2655
        type_role_dict = {}
2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672
        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
2673
        type_role_list.append(type_role_dict)
2674
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2675

Christophe Dumez's avatar
Christophe Dumez committed
2676
  # Function to generate XML Code Manually
2677 2678 2679 2680
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2681
      xml_data += "\n  <role id='%s'>" % role['id']
2682
      # uniq
2683
      for property in ('title', 'description', 'condition',
2684 2685 2686
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2687 2688
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2689
          xml_data += "\n   <property id='%s'>%s</property>" % \
2690 2691 2692
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2693
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2694 2695
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2696
          xml_data += "\n   <multi_property "\
2697
          "id='%s'>%s</multi_property>" % (property, prop_value)
2698 2699
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2700
    return xml_data
2701

2702 2703 2704 2705 2706 2707 2708
  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)
2709 2710
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2711 2712 2713 2714
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
2715 2716 2717
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2718 2719
    type_roles_list = []
    xml = parse(file)
2720
    xml_type_roles_list = xml.getElementsByTagName('role')
2721
    for role in xml_type_roles_list:
2722
      id = role.getAttribute('id').encode('utf_8', 'backslashreplace')
2723 2724 2725 2726 2727 2728
      type_role_property_dict = {'id':id}
      # uniq
      property_list = role.getElementsByTagName('property')
      for property in property_list:
        property_id = property.getAttribute('id').encode()
        if property.hasChildNodes():
2729
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2730 2731 2732 2733 2734 2735 2736 2737
          type_role_property_dict[property_id] = property_value
      # multi
      multi_property_list = role.getElementsByTagName('multi_property')
      for property in multi_property_list:
        property_id = property.getAttribute('id').encode()
        if not type_role_property_dict.has_key(property_id):
          type_role_property_dict[property_id] = []
        if property.hasChildNodes():
2738
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752
          type_role_property_dict[property_id].append(property_value)
      type_roles_list.append(type_role_property_dict)
    self._objects['portal_type_roles/'+file_name[:-4]] = type_roles_list

  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
2753 2754 2755
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
2756
          # reset roles before applying
2757
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
2758
          type_roles_list = self._objects[roles_path] or []
2759 2760
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
2761 2762 2763

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2764 2765 2766 2767 2768 2769
    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:
2770
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2771 2772 2773 2774 2775
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2776

2777 2778 2779 2780 2781 2782
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2783 2784
      for property in p.propertyMap():
        if property['id'] == id:
2785
          obj = p.getProperty(id)
2786
          prop_type = property['type']
2787 2788
          break
      else:
2789
        obj = None
2790
      if obj is None and not self.is_bt_for_diff:
2791
        raise NotFound, 'the property %s is not found' % id
2792
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2793

2794 2795
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
2796
    if not file_name.endswith('.xml'):
2797
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2798
      return
2799 2800 2801 2802
    xml = parse(file)
    property_list = xml.getElementsByTagName('property')
    for prop in property_list:
      id = prop.getElementsByTagName('id')[0].childNodes[0].data
2803 2804
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2805 2806 2807 2808 2809 2810 2811
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2812
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2813
      self._objects[str(id)] = (str(prop_type), value)
2814

2815 2816 2817
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2818
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2819 2820
      p = context.getPortalObject()
      for path in self._objects.keys():
2821 2822 2823 2824
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2825
              continue
2826
          dir, id = posixpath.split(path)
2827
          prop_type, property = self._objects[path]
2828 2829 2830 2831 2832 2833 2834 2835
          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
2836
    else:
2837
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2838
      p = context.getPortalObject()
2839
      for id, property in self._archive.keys():
2840
        property = self._archive[id]
Aurel's avatar
Aurel committed
2841
        if p.hasProperty(id):
2842 2843 2844 2845 2846 2847 2848
          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'])
2849 2850 2851

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2852 2853 2854 2855 2856 2857
    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:
2858 2859 2860 2861
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2862
  # Function to generate XML Code Manually
2863
  def generateXml(self, path=None):
2864
    xml_data = ''
2865
    prop_type, obj = self._objects[path]
2866
    xml_data += '\n <property>'
2867 2868
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
2869
    if prop_type in ('lines', 'tokens'):
2870
      xml_data += '\n  <value>'
2871
      for item in obj:
2872
        if item != '':
2873
          xml_data += '\n   <item>%s</item>' % escape(str(item))
2874
      xml_data += '\n  </value>'
2875
    else:
2876
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
2877
    xml_data += '\n </property>'
2878 2879
    return xml_data

Aurel's avatar
Aurel committed
2880 2881 2882 2883 2884
  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)
2885 2886 2887 2888
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2889
      xml_data += self.generateXml(path)
2890
    xml_data += '\n</site_property>'
2891
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2892

2893 2894 2895 2896 2897
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
2898 2899 2900 2901 2902 2903
    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()
2904
      permission_list = []
2905
      mapping['permission_list'] = module.showPermissions()
2906
      mapping['category_list'] = module.getCategoryList()
2907
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2908

Christophe Dumez's avatar
Christophe Dumez committed
2909
  # Function to generate XML Code Manually
2910
  def generateXml(self, path=None):
2911
    mapping = self._objects[path]
2912
    xml_data = ['<module>']
2913
    keys = mapping.keys()
2914 2915
    for key in sorted(keys):
      if key == 'permission_list':
2916
        # separe permission dict into xml
2917
        xml_data.append(' <%s>' % (key, ))
2918
        permission_list = mapping[key]
2919
        for perm in permission_list:
2920
          # the type of the permission defined if we use acquired or not
2921
          if isinstance(perm[1], list):
2922 2923 2924
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
2925
          role_list = list(perm[1])
2926 2927 2928
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
2929
          if (len(role_list) == 0 and ptype == 'list') or \
2930 2931
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
2932
          role_list.sort()
2933 2934
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
2935
          for role in role_list:
2936 2937 2938
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
2939 2940 2941 2942 2943 2944 2945 2946
      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, ))
2947
      else:
2948
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
2949 2950
    xml_data.append('</module>')
    return '\n'.join(xml_data)
2951

2952
  def export(self, context, bta, **kw):
2953
    if len(self._objects) == 0:
2954 2955 2956
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
2957 2958
    keys = self._objects.keys()
    keys.sort()
2959
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
2960
      # export modules one by one
2961 2962
      xml_data = self.generateXml(path=key)
      bta.addObject(obj=xml_data, name=key, path=path)
2963

2964
  def install(self, context, trashbin, **kw):
2965
    portal = context.getPortalObject()
2966 2967
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2968
    if context.getTemplateFormatVersion() == 1:
2969
      items = self._objects
2970
    else:
2971 2972
      items = self._archive

2973 2974
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
2975 2976
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
2977
        if not force:
2978
          action = update_dict[path]
2979 2980
          if action == 'nothing':
            continue
2981 2982
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
2983
        module = portal._getOb(module_id, None)
2984 2985
        if module is not None:
          module.portal_type = portal_type
2986
        else:
2987
          module = portal.newContent(id=module_id, portal_type=portal_type)
2988
        module.setTitle(str(mapping['title']))
2989 2990
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
2991
          # By default, Manager only without acquire permission
2992 2993
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
2994
          module.manage_permission(name, roles=role_list, acquire=acquire)
2995 2996
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
2997 2998

  def _importFile(self, file_name, file):
2999 3000 3001
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3002
    mapping = {}
3003
    xml = parse(file)
3004 3005 3006
    for key in ('portal_type', 'id', 'title', 'permission_list'):
      elt = xml.getElementsByTagName(key)[0]
      if key == 'permission_list':
3007 3008 3009
        plist = []
        perm_list = elt.getElementsByTagName('permission')
        for perm in perm_list:
3010
          perm_type = perm.getAttribute('type').encode() or None
3011 3012 3013 3014 3015 3016 3017 3018 3019
          name_elt = perm.getElementsByTagName('name')[0]
          name_node = name_elt.childNodes[0]
          name = name_node.data
          role_list = perm.getElementsByTagName('role')
          rlist = []
          for role in role_list:
            role_node = role.childNodes[0]
            role = role_node.data
            rlist.append(str(role))
3020
          if perm_type == 'list' or perm_type is None:
3021 3022 3023
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
3024
          plist.append(perm_tuple)
3025
        mapping[key] = plist
3026 3027 3028
      else:
        node_list = elt.childNodes
        if len(node_list) == 0:
3029
          value = ''
3030 3031
        else:
          value = node_list[0].data
3032
        mapping[key] = str(value)
3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046

    category_list = []
    try:
      elt = xml.getElementsByTagName('category_list')[0]
    except IndexError:
      pass
    else:
      category_element_list = elt.getElementsByTagName('category')
      for category_element in category_element_list:
        category_node = category_element.childNodes[0]
        category = str(category_node.data)
        category_list.append(category)
    mapping['category_list'] = category_list

3047
    self._objects[file_name[:-4]] = mapping
3048

3049
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3050 3051 3052
    trash = kw.get('trash', 0)
    if trash:
      return
3053 3054 3055 3056 3057 3058
    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]
3059 3060
    p = context.getPortalObject()
    id_list = p.objectIds()
3061 3062
    for key in keys:
      if key in id_list:
3063
        try:
3064
          if trash and trashbin is not None:
3065 3066 3067
            container_path = key.split('/')
            self.portal_trash.backupObject(trashbin, container_path, key, save=1, keep_subobjects=1)
          p.manage_delObjects([key])
3068
        except NotFound:
3069
          pass
3070 3071
    BaseTemplateItem.uninstall(self, context, **kw)

3072 3073 3074
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3075 3076

class DocumentTemplateItem(BaseTemplateItem):
3077 3078 3079 3080
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
3081 3082 3083 3084

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    for id in self._archive.keys():
3085
      self._objects[self.__class__.__name__+'/'+id] = globals()[self.local_file_reader_name](id)
Aurel's avatar
Aurel committed
3086

3087
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3088 3089
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3090
      new_keys = self._objects.keys()
3091 3092 3093 3094 3095 3096 3097 3098 3099 3100
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
      for key in installed_bt._objects.keys():
        if self.__class__.__name__ in key:
          new_key = key[len('%s/' % self.__class__.__name__):]
          new_dict[new_key] = installed_bt._objects[key]
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
        installed_bt._objects = new_dict
3101 3102 3103 3104 3105 3106
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
          old_obj_code = installed_bt._objects[path]
          if new_obj_code != old_obj_code:
3107 3108
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3109
        else: # new object
3110 3111
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3112 3113 3114 3115
          # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
3116 3117
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3118 3119 3120 3121 3122
    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
3123
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3124
      for id in self._objects.keys():
3125 3126 3127 3128 3129 3130
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
3131
          path, name = posixpath.split(id)
3132 3133
          # This raises an exception if the file already exists.
          try:
3134
            globals()[self.local_file_writer_name](name, text, create=0)
3135
          except IOError, error:
3136
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
3137 3138
            if error.errno :
              raise
3139 3140 3141
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
3142
    else:
3143 3144 3145
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3146
        # This raises an exception if the file exists.
3147
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
3148 3149
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
3150 3151

  def uninstall(self, context, **kw):
3152
    object_path = kw.get('object_path', None)
3153 3154 3155 3156 3157
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
3158
      globals()[self.local_file_remover_name](id)
3159 3160
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3161 3162 3163 3164 3165 3166
  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():
3167 3168
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
3169

3170
  def _importFile(self, file_name, file):
3171 3172 3173
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3174
    text = file.read()
3175
    self._objects[file_name[:-3]]=text
3176

3177 3178 3179 3180 3181 3182
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

3183 3184 3185 3186 3187
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
3188

3189 3190 3191
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
3192 3193
  # Extension needs no import
  local_file_importer_name = None
3194 3195 3196 3197 3198
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
3199
  # Test needs no import
3200 3201 3202
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
3203

3204 3205 3206
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3207 3208 3209

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3210 3211 3212 3213
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
3214
    if len(role_list) > 0:
3215
      self._objects[self.__class__.__name__+'/'+'role_list'] = role_list
Aurel's avatar
Aurel committed
3216

3217
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3218 3219
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3220
      new_roles = self._objects.keys()
3221
      if installed_bt.id == INSTALLED_BT_FOR_DIFF:
3222 3223
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
3224 3225 3226
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
3227 3228
        for key in old_keys:
          new_dict[key] = ''
3229
        installed_bt._objects = new_dict
3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242
      for role in new_roles:
        if installed_bt._objects.has_key(role):
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
      old_roles = installed_bt._objects.keys()
      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):
3243
    p = context.getPortalObject()
3244
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3245
    if context.getTemplateFormatVersion() == 1:
3246
      role_list = self._objects.keys()
3247
    else:
3248
      role_list = self._archive.keys()
3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260
    # 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:
        existing_role_list = role_manager.listRoleIds()
        for role in role_list:
          if role not in existing_role_list:
            role_manager.addRole(role)
    # set roles on portal
    roles = {}
    for role in p.__ac_roles__:
      roles[role] = 1
3261
    for role in role_list:
3262 3263 3264 3265
      roles[role] = 1
    p.__ac_roles__ = tuple(roles.keys())

  def _importFile(self, file_name, file):
3266
    if not file_name.endswith('.xml'):
3267
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3268
      return
3269 3270 3271 3272 3273 3274
    xml = parse(file)
    role_list = xml.getElementsByTagName('role')
    for role in role_list:
      node = role.childNodes[0]
      value = node.data
      self._objects[str(value)] = 1
3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286

  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)

3287 3288 3289 3290 3291 3292 3293 3294 3295
  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
3296
      if role in roles and role not in new_roles:
3297 3298 3299
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3300
  # Function to generate XML Code Manually
3301
  def generateXml(self, path):
3302
    obj = self._objects[path]
3303
    xml_data = '<role_list>'
3304 3305
    obj.sort()
    for role in obj:
3306 3307
      xml_data += '\n <role>%s</role>' %(role)
    xml_data += '\n</role_list>'
3308 3309
    return xml_data

Aurel's avatar
Aurel committed
3310 3311 3312 3313 3314 3315
  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():
3316
      xml_data = self.generateXml(path=path)
3317
      bta.addObject(obj=xml_data, name=path, path=None,)
3318

3319 3320
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3321
  def build(self, context, **kw):
3322
    catalog = _getCatalogValue(self)
3323 3324 3325
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3326
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3327
    key_list = []
3328
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3329
      if key in sql_search_result_keys:
3330
        key_list.append(key)
3331
      elif not self.is_bt_for_diff:
3332
        raise NotFound, 'Result key "%r" not found in catalog' %(key,)
3333
    if len(key_list) > 0:
3334
      self._objects[self.__class__.__name__+'/'+'result_key_list'] = key_list
3335 3336

  def _importFile(self, file_name, file):
3337 3338 3339
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3340 3341 3342 3343 3344 3345 3346 3347 3348
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

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

3355
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3356
    if context.getTemplateFormatVersion() == 1:
3357 3358
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3359 3360 3361
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3362
    else:
3363
      keys = self._archive.keys()
3364 3365
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3366
    # XXX same as related key
Aurel's avatar
Aurel committed
3367
    if update_dict.has_key('result_key_list') or force:
3368
      if not force:
Aurel's avatar
Aurel committed
3369
        action = update_dict['result_key_list']
3370
        if action == 'nothing':
Aurel's avatar
Aurel committed
3371
          return
3372
      for key in keys:
3373 3374
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
3375
      catalog.sql_search_result_keys = sql_search_result_keys
3376

3377
  def uninstall(self, context, **kw):
3378
    catalog = _getCatalogValue(self)
3379 3380 3381 3382
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3383
    object_path = kw.get('object_path', None)
3384 3385 3386 3387 3388
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3389 3390
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
3391
    catalog.sql_search_result_keys = sql_search_result_keys
3392 3393
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3394
  # Function to generate XML Code Manually
3395
  def generateXml(self, path=None):
3396
    obj = self._objects[path]
3397
    xml_data = '<key_list>'
3398 3399
    obj.sort()
    for key in obj:
3400 3401
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3402 3403
    return xml_data

Aurel's avatar
Aurel committed
3404 3405 3406 3407 3408
  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)
3409
    for path in self._objects.keys():
3410
      xml_data = self.generateXml(path=path)
3411
      bta.addObject(obj=xml_data, name=path, path=None)
3412

3413 3414
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3415
  def build(self, context, **kw):
3416
    catalog = _getCatalogValue(self)
3417 3418 3419
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3420
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
3421
    key_list = []
3422
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3423
      if key in sql_search_related_keys:
3424
        key_list.append(key)
3425
      elif not self.is_bt_for_diff:
3426
        raise NotFound, 'Related key "%r" not found in catalog' %(key,)
3427
    if len(key_list) > 0:
3428
      self._objects[self.__class__.__name__+'/'+'related_key_list'] = key_list
3429 3430

  def _importFile(self, file_name, file):
3431 3432 3433
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3434 3435 3436 3437 3438 3439 3440 3441 3442
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

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

3449
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3450
    if context.getTemplateFormatVersion() == 1:
3451
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3452
        return
3453 3454 3455
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3456
    else:
3457
      keys = self._archive.keys()
3458 3459
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3460
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
3461
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3462
      if not force:
Aurel's avatar
Aurel committed
3463 3464 3465 3466
        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
3467 3468 3469
        if action == 'nothing':
          return
      for key in keys:
3470 3471
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
3472
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
3473

3474
  def uninstall(self, context, **kw):
3475
    catalog = _getCatalogValue(self)
3476 3477 3478
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3479
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
3480
    object_path = kw.get('object_path', None)
3481 3482 3483 3484 3485
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3486 3487 3488 3489 3490
      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
3491
  # Function to generate XML Code Manually
3492
  def generateXml(self, path=None):
3493
    obj = self._objects[path]
3494
    xml_data = '<key_list>'
3495 3496
    obj.sort()
    for key in obj:
3497 3498
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3499 3500
    return xml_data

Aurel's avatar
Aurel committed
3501 3502 3503 3504 3505 3506
  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():
3507
      xml_data = self.generateXml(path=path)
3508
      bta.addObject(obj=xml_data, name=path, path=None)
3509

3510 3511
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3512
  def build(self, context, **kw):
3513
    catalog = _getCatalogValue(self)
3514 3515 3516
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3517
    sql_search_result_tables = list(catalog.sql_search_tables)
3518
    key_list = []
3519
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3520
      if key in sql_search_result_tables:
3521
        key_list.append(key)
3522
      elif not self.is_bt_for_diff:
3523
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
3524
    if len(key_list) > 0:
3525
      self._objects[self.__class__.__name__+'/'+'result_table_list'] = key_list
3526 3527

  def _importFile(self, file_name, file):
3528 3529 3530
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3531 3532 3533 3534 3535 3536 3537 3538
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list
Aurel's avatar
Aurel committed
3539

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

3546
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3547
    if context.getTemplateFormatVersion() == 1:
3548
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3549
        return
3550 3551 3552
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3553
    else:
3554
      keys = self._archive.keys()
3555 3556
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3557
    # XXX same as related keys
Aurel's avatar
Aurel committed
3558
    if update_dict.has_key('result_table_list') or force:
3559
      if not force:
Aurel's avatar
Aurel committed
3560
        action = update_dict['result_table_list']
3561
        if action == 'nothing':
Aurel's avatar
Aurel committed
3562
          return
3563
      for key in keys:
3564 3565
        if key not in sql_search_tables:
          sql_search_tables.append(key)
3566
      catalog.sql_search_tables = tuple(sql_search_tables)
3567 3568

  def uninstall(self, context, **kw):
3569
    catalog = _getCatalogValue(self)
3570 3571 3572 3573
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
3574
    object_path = kw.get('object_path', None)
3575 3576 3577 3578 3579
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3580 3581
      if key in sql_search_tables:
        sql_search_tables.remove(key)
3582
    catalog.sql_search_tables = sql_search_tables
3583 3584
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3585
  # Function to generate XML Code Manually
3586
  def generateXml(self, path=None):
3587
    obj = self._objects[path]
3588
    xml_data = '<key_list>'
3589 3590
    obj.sort()
    for key in obj:
3591 3592
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3593 3594
    return xml_data

Aurel's avatar
Aurel committed
3595 3596 3597 3598 3599 3600
  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():
3601
      xml_data = self.generateXml(path=path)
3602
      bta.addObject(obj=xml_data, name=path, path=None)
3603

3604 3605
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3606 3607

  def build(self, context, **kw):
3608
    catalog = _getCatalogValue(self)
3609 3610 3611 3612 3613 3614 3615 3616
    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)
3617
      elif not self.is_bt_for_diff:
3618
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3619
    if len(key_list) > 0:
3620
      self._objects[self.__class__.__name__+'/'+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3621

3622
  def _importFile(self, file_name, file):
3623 3624 3625
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3626 3627 3628 3629 3630 3631 3632 3633
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list
3634 3635

  def install(self, context, trashbin, **kw):
3636
    catalog = _getCatalogValue(self)
3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649
    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()
3650 3651
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663
    # 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):
3664
    catalog = _getCatalogValue(self)
3665 3666 3667 3668
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3669
    object_path = kw.get('object_path', None)
3670 3671
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3672
    else:
3673 3674 3675 3676 3677 3678 3679
      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
3680
  # Function to generate XML Code Manually
3681 3682 3683 3684 3685
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3686 3687
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3688
    return xml_data
Aurel's avatar
Aurel committed
3689 3690 3691 3692

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3693 3694 3695 3696 3697
    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)
3698

3699 3700 3701 3702 3703 3704 3705 3706
# 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
3707
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3708 3709 3710 3711
    key_list = []
    for key in self._archive.keys():
      if key in sql_datetime_keys:
        key_list.append(key)
3712
      elif not self.is_bt_for_diff:
3713 3714 3715 3716 3717
        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):
3718 3719 3720
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

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

3736
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762
    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
3763
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793
    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)      
      
3794 3795
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3796

3797
  def build(self, context, **kw):
3798
    catalog = _getCatalogValue(self)
3799 3800 3801 3802 3803 3804 3805 3806
    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)
3807
      elif not self.is_bt_for_diff:
3808
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
3809
    if len(key_list) > 0:
3810
      self._objects[self.__class__.__name__+'/'+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3811

3812
  def _importFile(self, file_name, file):
3813 3814 3815
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3816 3817 3818 3819 3820 3821 3822 3823
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3824

3825
  def install(self, context, trashbin, **kw):
3826
    catalog = _getCatalogValue(self)
3827 3828 3829
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3830

3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851
    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
3852

3853
  def uninstall(self, context, **kw):
3854
    catalog = _getCatalogValue(self)
3855 3856 3857 3858
    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)
3859
    object_path = kw.get('object_path', None)
3860 3861 3862 3863 3864 3865 3866 3867 3868 3869
    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
3870
  # Function to generate XML Code Manually
3871 3872 3873 3874 3875
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3876 3877
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893
    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):
3894
    catalog = _getCatalogValue(self)
3895 3896 3897 3898 3899 3900 3901 3902
    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)
3903
      elif not self.is_bt_for_diff:
3904
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
3905
    if len(key_list) > 0:
3906
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
3907 3908

  def _importFile(self, file_name, file):
3909 3910 3911
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3912 3913 3914 3915 3916 3917 3918 3919 3920 3921
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
3922
    catalog = _getCatalogValue(self)
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 3948 3949
    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):
3950
    catalog = _getCatalogValue(self)
3951 3952 3953 3954
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
3955
    object_path = kw.get('object_path', None)
3956 3957 3958 3959 3960 3961 3962 3963 3964 3965
    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
3966
  # Function to generate XML Code Manually
3967 3968 3969 3970 3971
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3972 3973
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988
    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):
3989
    catalog = _getCatalogValue(self)
3990 3991 3992 3993 3994 3995 3996 3997
    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)
3998
      elif not self.is_bt_for_diff:
3999
        raise NotFound, 'Multivalue key "%r" not found in catalog' %(key,)
4000
    if len(key_list) > 0:
4001
      self._objects[self.__class__.__name__+'/'+'multivalue_key_list'] = key_list
4002 4003

  def _importFile(self, file_name, file):
4004 4005 4006
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4007 4008 4009 4010 4011 4012 4013 4014 4015 4016
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
4017
    catalog = _getCatalogValue(self)
4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043
    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):
4044
    catalog = _getCatalogValue(self)
4045 4046 4047 4048
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
4049
    object_path = kw.get('object_path', None)
4050 4051 4052 4053 4054 4055 4056 4057 4058 4059
    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
4060
  # Function to generate XML Code Manually
4061 4062 4063 4064 4065
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4066 4067
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082
    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):
4083
    catalog = _getCatalogValue(self)
4084 4085 4086 4087 4088 4089 4090 4091
    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)
4092
      elif not self.is_bt_for_diff:
4093
        raise NotFound, 'Topic key "%r" not found in catalog' %(key,)
4094
    if len(key_list) > 0:
4095
      self._objects[self.__class__.__name__+'/'+'topic_key_list'] = key_list
4096 4097

  def _importFile(self, file_name, file):
4098 4099 4100
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4101 4102 4103 4104 4105 4106 4107 4108 4109 4110
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
4111
    catalog = _getCatalogValue(self)
4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138
    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):
4139
    catalog = _getCatalogValue(self)
4140 4141 4142 4143
    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)
4144
    object_path = kw.get('object_path', None)
4145 4146 4147 4148 4149 4150 4151 4152 4153 4154
    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
4155
  # Function to generate XML Code Manually
4156 4157 4158 4159 4160
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4161 4162
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173
    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)

4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185
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)
4186
      elif not self.is_bt_for_diff:
4187 4188 4189 4190 4191
        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):
4192 4193 4194
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  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)

4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281
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)
4282
      elif not self.is_bt_for_diff:
4283 4284 4285 4286 4287
        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):
4288 4289 4290
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 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
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  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)
4378
      elif not self.is_bt_for_diff:
4379 4380 4381 4382 4383
        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):
4384 4385 4386
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 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
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  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)

4461 4462 4463 4464
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4465 4466 4467
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4468
      else: # XXX backward compatibility
4469 4470
        lang = lang_key
        catalog = 'erp5_ui'
4471
      path = posixpath.join(lang, catalog)
4472 4473
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4474 4475 4476
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502

  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
          old_obj_code = installed_bt._objects[path]
          if new_obj_code != old_obj_code:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      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):
    localizer = context.getPortalObject().Localizer
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
4503 4504
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4505
          if not force:
4506
            action = update_dict[key]
4507
            if action == 'nothing':
4508
              continue
4509 4510 4511 4512 4513
          path = key.split('/')
          if len(path) == 1:
            lang = path[0]
            catalog = None
          elif len(path) == 2:
4514 4515 4516 4517 4518
            lang = path[0]
            catalog = path[1]
          else:
            lang = path[-3]
            catalog = path[-2]
4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534

          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)
4535 4536
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4537 4538 4539 4540 4541 4542 4543 4544
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
            mc = localizer._getOb(catalog)
            if lang not in mc.get_languages():
              mc.manage_addLanguage(lang)
            mc.manage_import(lang, po)
4545 4546
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4547
      for lang, catalogs in self._archive.iteritems():
4548 4549 4550 4551 4552 4553 4554 4555 4556
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
          mc = localizer._getOb(catalog)
          if lang not in mc.get_languages():
            mc.manage_addLanguage(lang)
          mc.manage_import(lang, po)

  def export(self, context, bta, **kw):
4557
    if len(self._objects) == 0:
4558 4559 4560
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
4561
    for key, obj in self._objects.iteritems():
4562 4563
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
4564 4565 4566 4567 4568 4569 4570 4571
      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'))
4572 4573

  def _importFile(self, file_name, file):
4574 4575
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4576 4577
      text = file.read()
      self._objects[file_name[:-3]] = text
4578 4579 4580 4581 4582 4583 4584 4585
    elif name == 'language.xml':
      xml = parse(file)
      language_element = xml.getElementsByTagName('language')[0]
      name_element = language_element.getElementsByTagName('name')[0]
      name = str(name_element.childNodes[0].data)
      code_element = language_element.getElementsByTagName('code')[0]
      code = str(code_element.childNodes[0].data)
      self._objects[code] = name
4586

Aurel's avatar
Aurel committed
4587 4588
class LocalRolesTemplateItem(BaseTemplateItem):

4589
  def __init__(self, id_list, **kw):
4590
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4591 4592
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4593 4594 4595
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4596
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4597 4598
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4599
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4600

Christophe Dumez's avatar
Christophe Dumez committed
4601
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4602
  def generateXml(self, path=None):
4603
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4604 4605
    # local roles
    xml_data = '<local_roles_item>'
4606
    xml_data += '\n <local_roles>'
4607
    for key in sorted(local_roles_dict):
4608
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4609 4610
      tuple = local_roles_dict[key]
      for item in tuple:
4611 4612 4613 4614
        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
4615
    return xml_data
4616

Aurel's avatar
Aurel committed
4617 4618 4619 4620 4621 4622 4623 4624
  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)

4625
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4626
      encode_folders = []
4627
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4628
        if '%' not in folder:
4629
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4630 4631
        else:
          encode_folders.append(folder)
4632
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4633 4634 4635 4636
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
4637 4638 4639
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4640 4641 4642
    xml = parse(file)
    # local roles
    local_roles = xml.getElementsByTagName('local_roles')[0]
4643
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
4644 4645 4646
    local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
4647 4648
      if isinstance(id, unicode):
        id = id.encode('utf-8')
Aurel's avatar
Aurel committed
4649 4650 4651 4652 4653
      item_type_list = []
      item_list = role.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      local_roles_dict[id] = item_type_list
4654
    self._objects['local_roles/'+file_name[:-4]] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665

  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
4666 4667
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4668
        local_roles_dict = self._objects[roles_path][0]
4669
        setattr(obj, '__ac_local_roles__', local_roles_dict)
Aurel's avatar
Aurel committed
4670 4671 4672 4673 4674 4675 4676

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
    for roles_path in self._objects.keys():
      path = roles_path.split('/')[1:]
      obj = p.unrestrictedTraverse(path)
      setattr(obj, '__ac_local_roles__', {})
4677

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

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

    - site property definition
      - id
      - type
4704
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4705

4706 4707
    - document/propertysheet/extension/test definition
      - copy of the local file
4708

4709
    - message transalation definition
4710
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4711

4712 4713
    The Business Template properties are exported to the bt folder with
    one property per file
4714

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4715 4716
    Technology:

4717 4718
    - 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
4719

4720
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4721 4722 4723 4724

    Use case:

    - install core ERP5 (the minimum)
4725

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

4728 4729
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4730
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4731 4732 4733 4734 4735
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4736
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4737 4738 4739

    # Declarative security
    security = ClassSecurityInfo()
4740
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4741 4742 4743 4744

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4745
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4746
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4747
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4748
                      , PropertySheet.BusinessTemplate
4749
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4750 4751
                      )

4752 4753 4754 4755 4756 4757
    # 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."""
4758
         , 'icon'           : 'file_icon.gif'
4759 4760 4761 4762 4763 4764 4765 4766 4767
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4768 4769
    # This is a global variable
    # Order is important for installation
4770 4771 4772 4773 4774 4775
    # 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 )
4776 4777
    _item_name_list = [
      '_product_item',
4778
      '_property_sheet_item',
4779
      '_constraint_item',
4780 4781 4782 4783
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4784
      '_tool_item',
4785 4786 4787 4788
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4789
      '_portal_type_workflow_chain_item',
4790 4791 4792 4793
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4794 4795
      '_category_item',
      '_module_item',
4796
      '_path_item',
4797
      '_skin_item',
4798
      '_registered_skin_selection_item',
4799
      '_preference_item',
4800
      '_action_item',
4801
      '_portal_type_roles_item',
4802
      '_local_roles_item',
4803
      '_catalog_method_item',
4804 4805 4806
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4807
      '_catalog_keyword_key_item',
4808
      '_catalog_datetime_key_item',
4809 4810 4811 4812
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4813
      '_catalog_scriptable_key_item',
4814 4815
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4816 4817 4818 4819
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4820 4821 4822 4823 4824 4825
      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
4826
        self._baseGetTemplateFormatVersion()
4827

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4828 4829 4830
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4831

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4832
      return 0
4833

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

4849 4850
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4851 4852 4853 4854 4855 4856
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4857
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4858 4859 4860 4861 4862 4863 4864 4865
        """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)
4866

4867
    security.declareProtected(Permissions.ManagePortal, 'build')
4868
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4869 4870 4871
      """
        Copy existing portal objects to self
      """
4872
      if no_action: return
4873
        # this is use at import of Business Template to get the status built
4874 4875
      # Make sure that everything is sane.
      self.clean()
4876

4877
      self.updateRevisionNumber()
4878

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4879 4880
      self._setTemplateFormatVersion(1)

4881
      # Store all data
4882 4883
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4884
      self._portal_type_workflow_chain_item = \
4885
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4886 4887 4888 4889
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4890 4891 4892
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4893 4894 4895 4896 4897 4898
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4899
      self._portal_type_roles_item = \
4900
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4901 4902 4903 4904 4905 4906 4907 4908
      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())
4909 4910
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930
      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())
4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942
      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())
4943 4944
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4945 4946
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4947 4948
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4949
               self.getTemplateCatalogKeywordKeyList())
4950 4951 4952
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4953 4954
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4955
               self.getTemplateCatalogFullTextKeyList())
4956 4957
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4958
               self.getTemplateCatalogRequestKeyList())
4959 4960
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4961
               self.getTemplateCatalogMultivalueKeyList())
4962 4963 4964
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4965 4966
      self._local_roles_item = \
          LocalRolesTemplateItem(
4967
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4968 4969 4970
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4971 4972 4973
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4974 4975 4976 4977 4978 4979
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4980

4981 4982
      # Build each part
      for item_name in self._item_name_list:
4983 4984 4985 4986
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4987

4988
    build = WorkflowMethod(build)
4989 4990

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4991
      """
4992
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4993
      """
4994
      return self.portal_templates.publish(self, url, username=username,
4995
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4996

4997
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4998
      """
4999
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5000
      """
5001
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5002

5003 5004 5005 5006 5007
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
5008 5009 5010 5011 5012 5013 5014 5015 5016 5017
      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
5018 5019
      return False

5020
    def preinstall(self, check_dependencies=1, **kw):
5021 5022 5023
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
5024
      """
5025 5026 5027 5028 5029
      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()
5030

5031 5032
      modified_object_list = {}
      bt_title = self.getTitle()
5033 5034 5035 5036 5037 5038 5039

      #  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)
5040 5041 5042
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5043
        installed_bt_format = installed_bt.getTemplateFormatVersion()
5044

5045
      # if reinstall business template, must compare to object in ZODB
5046
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
5047
      # same if we make a diff and select only one business template
5048
      reinstall = 0
5049 5050
      if installed_bt == self:
        reinstall = 1
5051 5052 5053 5054 5055 5056 5057 5058 5059
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, id=INSTALLED_BT_FOR_DIFF)
          # 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)
5060

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5061
      new_bt_format = self.getTemplateFormatVersion()
5062 5063 5064 5065 5066 5067
      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:
5068
          item = getattr(self, item_name, None)
5069 5070 5071 5072
          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
5073

5074
      for item_name in self._item_name_list:
5075
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5076
        old_item = getattr(installed_bt, item_name, None)
5077
        if new_item is not None:
5078
          if old_item is not None and hasattr(old_item, '_objects'):
5079
            modified_object = new_item.preinstall(context=self, installed_bt=old_item)
5080 5081 5082 5083 5084 5085 5086
            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:
5087
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5088

5089 5090
      return modified_object_list

5091 5092
    def _install(self, force=1, object_to_update=None, update_translation=0,
                 update_catalog=0, **kw):
5093
      """
Christophe Dumez's avatar
Christophe Dumez committed
5094
        Install a new Business Template, if force, all will be upgraded or installed
5095 5096
        otherwise depends of dict object_to_update
      """
5097 5098 5099 5100
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
5101

5102 5103
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
5104 5105
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5106
        if installed_bt.getTemplateFormatVersion() == 0:
5107
          force = 1
5108
        installed_bt.replace(self)
5109

5110 5111 5112 5113
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

5114 5115 5116
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
5117

5118 5119 5120
      if not force:
        self.checkDependencies()

5121
      site = self.getPortalObject()
5122 5123 5124
      from Products.ERP5.ERP5Site import ERP5Generator
      generator_class = getattr(site, '_generator_class', ERP5Generator)
      gen = generator_class()
5125 5126 5127
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Activity Tool')
5128
        gen.setupLastTools(site, update=1, create_activities=1)
5129 5130
      if not force:
        if len(object_to_update) == 0:
5131 5132 5133 5134 5135
          # 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():
5136
            LOG('Business Template', 0, 'Updating Business Template Workflows')
5137
            gen.setupWorkflow(site)
5138
          return
5139

5140 5141
      # always created a trash bin because we may to save object already present
      # but not in a previous business templates apart at creation of a new site
5142
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
5143 5144 5145 5146 5147
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

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

5154
      # update catalog if necessary
5155 5156
      if force and self.isCatalogUpdatable():
        update_catalog = 1
5157
      if update_catalog:
5158
        catalog = _getCatalogValue(self)
5159
        if (catalog is None) or (not site.isIndexable):
5160 5161 5162 5163 5164
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
5165

5166
      # get objects to remove
5167
      # do remove after because we may need backup object from installation
5168
      remove_object_dict = {}
5169 5170
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
5171
          remove_object_dict[path] = action
5172

5173
      # remove object from old business template
5174
      if len(remove_object_dict):
5175
        # XXX: this code assumes that there is an installed_bt
5176
        for item_name in reversed(installed_bt._item_name_list):
5177
          item = getattr(installed_bt, item_name, None)
5178
          if item is not None:
5179
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
5180

5181 5182 5183 5184 5185 5186

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

5187
      # check if we have to update business template workflow
5188
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
5189
        LOG('Business Template', 0, 'Updating Business Template Workflows')
5190 5191 5192 5193 5194
        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)

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

5200 5201
      if update_catalog:
        site.ERP5Site_reindexAll()
5202

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

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

5211
    security.declareProtected(Permissions.ManagePortal, 'install')
5212 5213 5214
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
5215
      """
5216
      return self._install(**kw)
5217

5218
    install = WorkflowMethod(install)
5219

5220
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
5221
    def reinstall(self, **kw):
5222 5223 5224 5225
      """Reinstall Business Template.
      """
      return self._install(**kw)

5226
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5227

5228
    security.declareProtected(Permissions.ManagePortal, 'trash')
5229 5230
    def trash(self, new_bt, **kw):
      """
5231
        Trash unnecessary items before upgrading to a new business
5232
        template.
5233
        This is similar to uninstall, but different in that this does
5234
        not remove all items.
5235
      """
5236 5237
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5238
        item = getattr(self, item_name, None)
5239 5240
        if item is not None:
          item.trash(
5241
                self,
5242
                getattr(new_bt, item_name))
5243

5244
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
5245
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5246
      """
5247
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5248
      """
5249 5250 5251
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5252
        item = getattr(self, item_name, None)
5253
        if item is not None:
5254
          item.uninstall(self)
5255
      # It is better to clear cache because the uninstallation of a
5256
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
5257
      self.getPortalObject().portal_caches.clearAllCache()
5258

5259 5260
    uninstall = WorkflowMethod(uninstall)

5261
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5262
    def _clean(self):
5263
      """
5264
        Clean built information.
5265
      """
5266
      # First, remove obsolete attributes if present.
5267 5268 5269 5270
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
5271
                    '_module_archive',
5272 5273 5274
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
5275
                    '_property_sheet_archive'):
5276 5277 5278
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
5279 5280
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
5281

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

5284
    security.declareProtected(Permissions.AccessContentsInformation,
5285
                              'getBuildingState')
5286
    def getBuildingState(self, default=None, id_only=1):
5287
      """
5288
        Returns the current state in building
5289
      """
5290
      portal_workflow = getToolByName(self, 'portal_workflow')
5291 5292
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
5293
      return wf._getWorkflowStateOf(self, id_only=id_only )
5294

5295
    security.declareProtected(Permissions.AccessContentsInformation,
5296
                              'getInstallationState')
5297
    def getInstallationState(self, default=None, id_only=1):
5298
      """
5299
        Returns the current state in installation
5300
      """
5301
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
5302 5303
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
5304
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5305

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5306 5307 5308 5309 5310 5311
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
5312
      export_string = portal_templates.manage_exportObject(
5313 5314
                                               id=self.getId(),
                                               toxml=1,
5315
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5316
      return export_string
5317

5318
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5319
      """
5320 5321
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5322
      """
5323 5324
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
5325 5326 5327 5328
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
5329
        # XXX Why do we need to return a tuple ?
5330 5331
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5332

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

5340
    def getTemplateBaseCategoryList(self):
5341
      """
5342 5343
      We have to set this method because we want an
      ordered list
5344
      """
5345
      return self._getOrderedList('template_base_category')
5346

5347
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5348
      """
5349 5350
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5351
      """
5352
      return self._getOrderedList('template_workflow_id')
5353

5354
    def getTemplatePortalTypeIdList(self):
5355
      """
5356 5357
      We have to set this method because we want an
      ordered list
5358
      """
5359
      return self._getOrderedList('template_portal_type_id')
5360

5361 5362 5363 5364 5365 5366 5367
    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
5368 5369 5370 5371 5372 5373 5374
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

5375 5376 5377 5378 5379 5380 5381
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

5382 5383 5384 5385 5386 5387
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
5388

5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409
    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')

5410
    def getTemplateActionPathList(self):
5411
      """
5412 5413
      We have to set this method because we want an
      ordered list
5414
      """
5415
      return self._getOrderedList('template_action_path')
5416

5417
    def getTemplatePortalTypeRoleList(self):
5418 5419 5420 5421
      """
      We have to set this method because we want an
      ordered list
      """
5422
      return self._getOrderedList('template_portal_type_role')
5423

5424
    def getTemplateLocalRoleList(self):
5425 5426 5427 5428
      """
      We have to set this method because we want an
      ordered list
      """
5429
      return self._getOrderedList('template_local_role')
5430

5431
    def getTemplateSkinIdList(self):
5432
      """
5433 5434
      We have to set this method because we want an
      ordered list
5435
      """
5436
      return self._getOrderedList('template_skin_id')
5437

5438 5439 5440 5441 5442 5443 5444
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

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

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

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

5466
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5467 5468 5469 5470
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5471
      if self.getBuildingState() != 'built':
5472
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5473
              'Business Template must be built before export'
5474

Aurel's avatar
Aurel committed
5475 5476 5477 5478 5479 5480 5481
      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)

5482
      # export bt
5483
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
5484
      for prop in self.propertyMap():
5485
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5486
        id = prop['id']
5487
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5488
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5489
          continue
Aurel's avatar
Aurel committed
5490
        value = self.getProperty(id)
5491
        if prop_type in ('text', 'string', 'int', 'boolean'):
5492
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
5493
        elif prop_type in ('lines', 'tokens'):
5494
          bta.addObject(obj=str('\n').join(value), name=id,
5495
                        path=path+os.sep+'bt', ext='')
5496

Aurel's avatar
Aurel committed
5497 5498 5499
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5500

Aurel's avatar
Aurel committed
5501 5502
      return bta.finishCreation()

5503
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5504 5505
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5506
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5507 5508 5509 5510 5511 5512 5513
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
5514
      self._portal_type_workflow_chain_item = \
5515
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
5516 5517 5518 5519
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
5520 5521 5522
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
Aurel's avatar
Aurel committed
5523 5524 5525 5526 5527 5528
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
5529 5530
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
5531 5532 5533 5534 5535 5536 5537 5538
      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())
5539 5540
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562
      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())
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
5563 5564
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578
      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())
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
5579
               self.getTemplateCatalogKeywordKeyList())
5580 5581 5582
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
5583 5584
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
5585
               self.getTemplateCatalogFullTextKeyList())
5586 5587
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
5588
               self.getTemplateCatalogRequestKeyList())
5589 5590
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
5591
               self.getTemplateCatalogMultivalueKeyList())
5592 5593 5594
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
5595 5596
      self._local_roles_item = \
          LocalRolesTemplateItem(
5597
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5598 5599 5600
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
5601 5602 5603
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
5604 5605 5606 5607 5608 5609
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
5610

5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
      module_id_list = []
      for template_type in ('Constraint', 'Document', 'PropertySheet'):
        for template_id in getattr(self,
                                   'getTemplate%sIdList' % template_type)():
          module_id = 'Products.ERP5Type.%s.%s' % (template_type, template_id)
          if module_id not in sys.modules:
            module_id_list.append(module_id)
            sys.modules[module_id] = module = imp.new_module(module_id)
            module.SimpleItem = SimpleItem.SimpleItem
            exec "class %s(SimpleItem): pass" % template_id in module.__dict__

Aurel's avatar
Aurel committed
5624 5625
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5626

5627 5628 5629 5630 5631
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
      for module_id in module_id_list:
        del sys.modules[module_id]

5632 5633 5634 5635 5636
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5637 5638 5639
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5640
      return items_list
5641

5642 5643 5644 5645 5646 5647 5648 5649 5650 5651
    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:
5652
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5653
          dependency = dependency_couple_list[0]
5654 5655
          if dependency in (None, ''):
            continue
5656 5657
          version_restriction = None
          if len(dependency_couple_list) > 1:
5658
            version_restriction = dependency_couple_list[1]
5659 5660 5661
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5662 5663 5664
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5665
                  or (version_restriction not in (None, '') and
5666 5667 5668 5669
                     (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)
5670

Aurel's avatar
Aurel committed
5671
    def diffObject(self, REQUEST, **kw):
5672 5673
      """
        Make a diff between an object in the Business Template
5674
        and the same in the Business Template installed in the site
5675 5676 5677 5678
      """

      class_name_dict = {
        'Product' : '_product_item',
5679
        'PropertySheet' : '_property_sheet_item',
5680
        'Constraint' : '_constraint_item',
5681 5682 5683 5684 5685 5686 5687 5688 5689
        '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',
5690
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5691 5692 5693 5694
        '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',
5695 5696 5697
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5698
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5699
        'Path' : '_path_item',
5700
        'Preference' : '_preference_item',
5701
        'Action' : '_action_item',
5702
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5703
        'LocalRoles' : '_local_roles_item',
5704 5705 5706
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5707
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5708
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5709 5710 5711 5712
        '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
5713
        'Tool': '_tool_item',
5714
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5715 5716
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5717
        }
5718

5719 5720
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5721

Christophe Dumez's avatar
Christophe Dumez committed
5722
      # Get objects
5723
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5724

Aurel's avatar
Aurel committed
5725
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
5726
      # Compare with a given business template
5727
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5728 5729
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5730 5731
        if bt2_id == self.getId():
          compare_to_zodb = 1
5732
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5733 5734
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5735 5736 5737
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5738 5739
          compare_to_zodb = 1
      if compare_to_zodb:
5740
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5741
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5742 5743 5744
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5745

5746 5747
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5748
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5749
        # XXX maybe only build for the given object to gain time
5750
        installed_item.build(self)
5751 5752 5753
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5754

Christophe Dumez's avatar
Christophe Dumez committed
5755
      # Real Zope Objects (can be exported into XML directly by Zope)
5756 5757
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5758
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5759
                     '_skin_item', '_action_item', '_tool_item', ]
5760

Christophe Dumez's avatar
Christophe Dumez committed
5761
      # Not considered as objects by Zope (will be exported into XML manually)
5762
      # XXX Bad naming
5763
      item_list_2 = ['_site_property_item', '_module_item',
5764
                     '_catalog_result_key_item', '_catalog_related_key_item',
5765 5766
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
5767
                     '_catalog_datetime_key_item',
5768 5769 5770 5771
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5772
                     '_catalog_scriptable_key_item',
5773 5774
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5775 5776 5777 5778 5779 5780
                     '_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',
5781
                     '_portal_type_workflow_chain_item',]
5782

Christophe Dumez's avatar
Christophe Dumez committed
5783
      # Text objects (no need to export them into XML)
5784
      # XXX Bad naming
5785 5786
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5787
                     '_test_item', '_message_translation_item',]
5788

5789
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5790 5791 5792
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5793 5794
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
5795
        # XML Export in memory
5796 5797 5798
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
        OFS.XMLExportImport.exportXML(installed_object._p_jar, installed_object._p_oid, f2)
        new_obj_xml = f1.getvalue()
5799
        f1.close()
5800 5801 5802 5803
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5804
        # End of XML export
5805

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

5814
      elif item_name in item_list_2:
5815
        # Generate XML code manually
5816 5817
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5818 5819
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5820
        # End of XML Code Generation
5821

5822
        # Diff between XML objects
5823 5824
        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
5825
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5826 5827 5828
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5829

5830
      elif item_name in item_list_3:
5831
        # Diff between text objects
5832 5833 5834 5835
        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
5836
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5837 5838
          diff_msg += '\n'.join(diff_list)
        else:
5839
          diff_msg = 'No diff'
5840

5841
      else:
5842
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5843

5844
      if compare_to_zodb:
5845
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5846

5847
      return diff_msg
5848

5849

5850 5851 5852 5853
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5854 5855
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5856 5857 5858 5859 5860 5861 5862
      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 [])
5863 5864
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5865
      p = self.getPortalObject()
5866
      for id in bt_portal_types_id_list:
5867 5868
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5869
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5870
        if portal_type.getRoleInformationList():
5871 5872
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5873

5874 5875 5876 5877
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5878
        action_list = []
5879 5880 5881 5882 5883 5884 5885
        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'):
5886
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5887 5888
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5889

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

5895
        for h_id in hidden_content_type_list:
5896 5897 5898
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5899

5900 5901 5902 5903
        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)
5904

5905 5906 5907 5908
        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)
5909

5910 5911 5912 5913
        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)
5914

5915
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5916
                                    if chain != '(Default)']:
5917 5918 5919
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5920

5921 5922 5923 5924
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5925
      bt_action_list.sort()
5926
      bt_wf_chain_list.sort()
5927

5928 5929 5930 5931 5932 5933 5934
      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)
5935 5936 5937 5938 5939 5940 5941 5942 5943
      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:
5944 5945
        raise TemplateConditionError, 'No module defined in business template'

5946 5947 5948 5949 5950 5951 5952 5953
      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:
5954
          return type_list
5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968

        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():
5969
            type_list.update(getChildPortalType(hidden_ptype_id))
5970
        return type_list
5971

5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018
      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

6019 6020 6021
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
6022
  setattr(BusinessTemplate, key, None)
6023

6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050
# 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)
6051

6052 6053 6054 6055 6056 6057 6058 6059

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

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