BusinessTemplate.py 227 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
import threading

CACHE_DATABASE_PATH = None
try:
  if int(os.getenv('ERP5_BT5_CACHE', 0)):
    from App.config import getConfiguration
88
    import gdbm
89 90 91 92 93 94
    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
def registerSkinFolder(skin_tool, skin_folder):
  request = skin_tool.REQUEST
198 199 200
  # XXX: Getting parameter from request instead of dialog is bad
  # XXX: This is even non consistent with rest of parameters selected by user
  #      (like update_translation or update_catalog)
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
  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()

216 217 218
  if isinstance(skin_selection_list, basestring):
    skin_selection_list = skin_selection_list.split()

219 220 221 222 223 224 225 226 227
  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 ''
228
    selection_list = selection.split(',')
229
    if (skin_folder_id not in selection_list):
230
      selection_list.insert(0, skin_folder_id)
231 232
    if reorder_skin_selection:
      selection_list.sort(
233 234
        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)
235
    if (skin_name in skin_layer_list):
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 292 293 294
      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
295 296 297
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
298
  """
Aurel's avatar
Aurel committed
299 300 301 302 303 304 305 306 307 308 309 310

  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
311

Aurel's avatar
Aurel committed
312 313 314 315 316
  def finishCreation(self, **kw):
    pass

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

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

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

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

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

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

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

  def addFolder(self, name=''):
411
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
412
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
413 414
      os.makedirs(name)

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

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
435
    shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
436 437 438 439 440
    return self.fobj

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

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

469
class TemplateConditionError(Exception): pass
470
class TemplateConflictError(Exception): pass
471
class BusinessTemplateMissingDependency(Exception): pass
472

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

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

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

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

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

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

553

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

561 562
  def getKeys(self):
    return self._objects.keys()
563

Aurel's avatar
Aurel committed
564
  def importFile(self, bta, **kw):
565
    bta.importFiles(item=self)
566

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

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

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

599 600 601
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
602
  """
603

604 605 606 607
  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()
608
      self._archive.clear()
609 610 611
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
612

613
  def export(self, context, bta, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
614 615 616 617
    """
      Export the business template : fill the BusinessTemplateArchive with
      objects exported as XML, hierarchicaly organised.
    """
618 619 620
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
Vincent Pelletier's avatar
Vincent Pelletier committed
621
    for key, obj in self._objects.iteritems():
622
      # create folder and subfolders
623
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
624 625 626
      encode_folders = []
      for folder in folders.split('/'):
        if '%' not in folder:
627
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
628 629 630
        else:
          encode_folders.append(folder)
      path = os.path.join(root_path, (os.sep).join(encode_folders))
631 632 633
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
634 635
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
636

Aurel's avatar
Aurel committed
637
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
638
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
639 640 641
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
642
      relative_url = '/'.join([url,id])
643 644
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
645
      obj = self.removeProperties(obj)
Vincent Pelletier's avatar
Vincent Pelletier committed
646 647 648
      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
649
        groups = deepcopy(obj.groups)
650
      if id_list:
Aurel's avatar
Aurel committed
651
        self.build_sub_objects(context, id_list, relative_url)
652
        for id_ in list(id_list):
653
          obj._delObject(id_)
654
      if hasattr(aq_base(obj), 'groups'):
655 656 657
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
658 659
    return sub_list

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

687
  def _compileXML(self, file):
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 735 736 737 738 739 740 741 742 743 744 745 746
    # 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
747

748
  def _importFile(self, file_name, file_obj):
749
    # import xml file
750
    if not file_name.endswith('.xml'):
751
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
752
      return
753 754 755 756 757
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
758
    __traceback_info__ = 'Importing %s' % file_name
759 760
    if hasattr(cache_database, 'db') and isinstance(file_obj, file):
      obj = connection.importFile(self._compileXML(file_obj))
761
    else:
762 763
      # FIXME: Why not use the importXML function directly? Are there any BT5s
      # with actual .zexp files on the wild?
764
      obj = connection.importFile(file_obj, customImporters=customImporters)
765
    self.removeProperties(obj)
766 767
    self._objects[file_name[:-4]] = obj

768
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
769 770
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
771 772 773
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
      for path in self._objects:
774
        if installed_bt._objects.has_key(path):
Julien Muchembled's avatar
Julien Muchembled committed
775 776
          upgrade_list.append((path,
            self.removeProperties(installed_bt._objects[path])))
777
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
          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
794
      # get removed object
Julien Muchembled's avatar
Julien Muchembled committed
795 796
      for path in set(installed_bt._objects) - set(self._objects):
        modified_object_list[path] = 'Removed', type_name
797 798
    return modified_object_list

799
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
800 801 802
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
803
    subobjects_dict = {}
804
    if trashbin is None: # must return subobjects
805 806 807 808 809 810
      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)
811
        subobjects_dict[subobject_id] = subobject_copy
812
      return subobjects_dict
813
    # XXX btsave is for backward compatibility
814
    if action == 'backup' or action == 'btsave' or action == 'save_and_remove':
815
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, **kw)
816
    elif action == 'install':
817
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0, **kw)
818 819 820 821
    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
822
    return subobjects_dict
823

824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
  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

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

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

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

1157
        container.manage_delObjects([object_id])
1158 1159
        if container.aq_parent.meta_type == 'ERP5 Catalog' and len(container.objectIds()) == 0:
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1160
          container.getParentValue().manage_delObjects([container.id])
1161
      except (NotFound, KeyError, BadRequest, AttributeError):
1162
        # object is already backup and/or removed
1163
        pass
1164 1165
    BaseTemplateItem.uninstall(self, context, **kw)

1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
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

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

1213 1214 1215
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1216

1217 1218 1219 1220 1221 1222 1223 1224 1225
      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.
1226 1227 1228
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1229
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1230 1231
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1232
      if object_id != "":
1233
        path_list.extend(self._resolvePath(
1234
            folder._getOb(object_id),
1235
            relative_url_list + [object_id], id_list[1:]))
1236
    return path_list
Aurel's avatar
Aurel committed
1237

1238 1239 1240
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1241
    keys = self._path_archive.keys()
1242
    keys.sort()
Aurel's avatar
Aurel committed
1243
    for path in keys:
1244 1245 1246
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
1247
      for relative_url in self._resolvePath(p, [], path.split('/')):
1248 1249
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1250
        obj = obj.__of__(context)
1251
        _recursiveRemoveUid(obj)
1252
        id_list = obj.objectIds()
1253
        obj = self.removeProperties(obj)
1254
        if hasattr(aq_base(obj), 'groups'):
1255
          # we must keep groups because it's ereased when we delete subobjects
1256
          groups = deepcopy(obj.groups)
1257
        if len(id_list) > 0:
1258 1259
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1260
          for id_ in list(id_list):
1261
            obj._delObject(id_)
1262
        if hasattr(aq_base(obj), 'groups'):
1263 1264 1265
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1266

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1267 1268 1269 1270 1271 1272 1273 1274
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)

1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
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")
1290
    if len(id_list) != 1:
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302
      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():
1303
      pref = portal.unrestrictedTraverse(object_path)
1304
      # XXX getPreferenceState is a bad name
1305
      if pref.getPreferenceState() == 'disabled':
1306 1307
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1308 1309
        portal.portal_workflow.doActionFor(
                      pref,
1310 1311 1312
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1313 1314
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1315

1316 1317
class CategoryTemplateItem(ObjectTemplateItem):

1318 1319
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1320

1321 1322 1323 1324
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1325 1326
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1327
      obj = self.removeProperties(obj)
1328
      id_list = obj.objectIds()
1329
      if id_list:
1330
        self.build_sub_objects(context, id_list, relative_url)
1331
        for id_ in list(id_list):
1332
          obj._delObject(id_)
1333 1334
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1335 1336 1337 1338 1339

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1340 1341
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1342
      _recursiveRemoveUid(obj)
1343
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1344
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1345
      id_list = obj.objectIds()
1346 1347
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1348
        for id_ in list(id_list):
1349
          obj._delObject(id_)
1350
      else:
1351
        for id_ in list(id_list):
1352
          obj._delObject(id_)
1353 1354
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1355

1356 1357 1358 1359 1360 1361 1362 1363
  def beforeInstall(self):
    self._installed_new_category = False

  def onNewObject(self):
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1364 1365
      # reset accessors if we installed a new category
      _aq_reset()
1366

1367 1368
class SkinTemplateItem(ObjectTemplateItem):

1369 1370
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1371

1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
  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')

1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
  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

1397
  def install(self, context, trashbin, **kw):
1398
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1399 1400
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1401
    p = context.getPortalObject()
1402
    skin_tool = p.portal_skins
1403 1404
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1405
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1406 1407
        fixZSQLMethod(p, obj)

1408
      # Do not register skin which were explicitely ask not to be installed
1409 1410 1411 1412 1413
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
      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]
1435
      else:
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 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
        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:
1481
          create_property = True
1482 1483
          selection_string = self._objects[skin_folder_id].replace(',', ' ')
        else:
1484 1485 1486
          create_property = False
          if not isinstance(selection_string, basestring):
            selection_string = ' '.join(selection_string)
1487 1488 1489 1490 1491 1492
          selection_string += ' %s' % \
            self._objects[skin_folder_id].replace(',', ' ')

        # Remove duplicate
        selection_string = \
            ' '.join(dict([(x, 0) for x in selection_string.split(' ')]).keys())
1493 1494 1495 1496 1497 1498 1499 1500
        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(' '))
1501 1502 1503 1504 1505

        selection_list = selection_string.split(' ')
        unregisterSkinFolder(skin_tool, skin_folder,
            skin_tool.getSkinSelections())
        registerSkinFolder(skin_tool, skin_folder)
1506 1507

  def uninstall(self, context, **kw):
1508 1509 1510
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1511 1512 1513 1514
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
      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:
1530
        skin_folder._updateProperty(
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 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
            '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'):
1568
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584
      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
1585 1586


1587
class WorkflowTemplateItem(ObjectTemplateItem):
1588

1589 1590
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1591

1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
  # 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:
1604
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1605 1606 1607 1608
      else:
        modified_workflow_dict[modified_object] = state
    return modified_workflow_dict

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


1650 1651
class PortalTypeTemplateItem(ObjectTemplateItem):

1652 1653
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1654 1655
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1656 1657 1658
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1659 1660
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1661 1662
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1663 1664
      # obj is in ghost state and an attribute must be accessed
      # so that obj.__dict__ does not return an empty dict
1665
      obj.meta_type
1666
      for attr in obj.__dict__.keys():
1667 1668 1669 1670 1671 1672 1673 1674
        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)
1675 1676
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1677

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

1709 1710
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1711 1712 1713 1714 1715 1716 1717
  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:
1718
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1719 1720 1721 1722 1723
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1724
        dict[str(ptype)] = str(workflow)
1725 1726 1727 1728
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1729
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1730 1731

  def build(self, context, **kw):
1732 1733 1734 1735 1736
    # 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
1737
    p = context.getPortalObject()
1738
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1739
    for key in self._archive.keys():
1740 1741 1742
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1743
        workflow = wflist[1]
1744
      else:
1745
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1746
        portal_type = wflist[0][:-2]
1747 1748
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1749 1750 1751 1752
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
1753
        if workflow[0] != '-' and \
1754
            workflow_name not in chain_dict['chain_%s' % portal_type].split(', '):
1755
          if not self.is_bt_for_diff:
1756 1757 1758 1759 1760
            # 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))
1761
        if self._objects.has_key(portal_type):
1762 1763
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1764
        else:
1765
          self._objects[portal_type] = [workflow,]
1766
      elif not self.is_bt_for_diff:
1767
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1768
                        'is probably a sign of a missing dependency.'\
1769
                                                    % portal_type
1770

Christophe Dumez's avatar
Christophe Dumez committed
1771
  # Function to generate XML Code Manually
1772 1773 1774 1775 1776
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1777
      workflow_list = self._objects[key]
1778 1779 1780
      # XXX Not always a list
      if isinstance(workflow_list, str):
        workflow_list = [workflow_list]
1781 1782
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
1783
      xml_data += '\n  <workflow>%s</workflow>' %(', '.join(sorted(workflow_list)))
1784 1785
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801
    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
1802
    (default_chain, chain_dict) = getChainByType(context)
1803
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1804
    # best solution, by default it is 'default_workflow', which is
1805 1806 1807 1808 1809 1810 1811
    # 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':
1812
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1813 1814
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
1815
        if len(path_splitted) < 1:
Jérome Perrin's avatar
Jérome Perrin committed
1816
          continue
1817
        portal_type = path_splitted[-1]
1818
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1819 1820 1821
          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 != '':
1822
            old_chain_workflow_id_set = {}
1823
            # get existing workflow id list
1824 1825
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1826
            # get new workflow id list
1827
            for wf_id in self._objects[path].split(', '):
1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841
              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
1842 1843
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1844
          else:
Romain Courteaud's avatar
Romain Courteaud committed
1845 1846 1847 1848 1849 1850
            # 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)
1851
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1852
        else:
1853 1854 1855 1856
          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
1857
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1858 1859
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1860

1861 1862
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1863 1864 1865 1866 1867 1868
    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:
1869 1870 1871 1872 1873 1874
      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():
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
        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
1887
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1888

1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921
  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

1922
  def _importFile(self, file_name, file):
1923
    if not file_name.endswith('.xml'):
1924
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1925
      return
1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936
    # 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
1937 1938
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1939 1940 1941
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1942 1943
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1944

1945
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
1946 1947 1948
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
1949 1950
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
1951
  business_template_class_property = '_portal_type_allowed_content_type_item'
1952 1953

  def build(self, context, **kw):
1954 1955
    types_tool = self.getPortalObject().portal_types
    types_list = list(types_tool.objectIds())
1956
    for key in self._archive.keys():
1957 1958 1959 1960
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
1961 1962 1963 1964 1965
      # 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, ())
1966
      if not allowed_type in prop_value and not self.is_bt_for_diff:
Jérome Perrin's avatar
Jérome Perrin committed
1967
        raise ValueError, "%s %s not found in portal type %s" % (
1968 1969 1970
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)

1971 1972 1973 1974 1975 1976 1977
      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
1978
  # Function to generate XML Code Manually
1979
  def generateXml(self, path=None):
1980
    dictio = self._objects
1981
    xml_data = '<%s>' %(self.xml_tag,)
1982
    keys = dictio.keys()
1983 1984
    keys.sort()
    for key in keys:
1985
      allowed_list = sorted(dictio[key])
1986
      xml_data += '\n <portal_type id="%s">' %(key,)
1987
      for allowed_item in allowed_list:
1988 1989 1990
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001
    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)

2002 2003 2004 2005 2006
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
2007 2008 2009 2010
      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:
2011
          new_key = '%s/%s' % (self.class_property, key)
2012
          new_dict[new_key] = installed_bt._objects[key]
2013 2014 2015
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
2016 2017 2018 2019 2020
        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]
2021
          old_object = installed_bt._objects[path]
2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032
          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

2033
  def _importFile(self, file_name, file):
2034
    if not file_name.endswith('.xml'):
2035
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2036
      return
2037
    path, name = posixpath.split(file_name)
2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
    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')
2053 2054 2055 2056 2057 2058 2059
    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())):
2060 2061 2062 2063 2064
      if update_dict.has_key(key) or force:
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2065 2066 2067 2068
        try:
          portal_id = key.split('/')[-1]
          portal_type = pt._getOb(portal_id)
        except (AttributeError, KeyError):
2069 2070
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2071 2072
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
2073 2074 2075
        object_property_list = getattr(portal_type, self.class_property, ())
        if len(object_property_list) > 0:
          # merge differences between portal types properties
2076 2077 2078 2079 2080
          # 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
2081
          for id in object_property_list:
2082
            if id not in property_list and id not in old_property_list:
2083
              property_list.append(id)
2084
        setattr(portal_type, self.class_property, tuple(property_list))
2085

Aurel's avatar
Aurel committed
2086
  def uninstall(self, context, **kw):
2087
    object_path = kw.get('object_path', None)
2088
    p = context.getPortalObject()
2089
    pt = p.unrestrictedTraverse('portal_types')
2090 2091 2092 2093 2094 2095 2096 2097
    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)
2098
      except (AttributeError,  KeyError):
2099 2100 2101
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
2102 2103
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2104 2105
      for id in property_list:
        if id in original_property_list:
2106
          original_property_list.remove(id)
2107
      setattr(portal_type, self.class_property, tuple(original_property_list))
2108

2109

2110 2111
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2112
  name = 'Hidden Content Type'
2113 2114
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2115
  business_template_class_property = '_portal_type_hidden_content_type_item'
2116

2117

2118 2119
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2120
  name = 'Property Sheet'
2121 2122
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2123
  business_template_class_property = '_portal_type_property_sheet_item'
2124

2125

2126 2127
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2128
  name = 'Base Category'
2129 2130
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2131
  business_template_class_property = '_portal_type_base_category_item'
2132

2133

2134
class CatalogMethodTemplateItem(ObjectTemplateItem):
2135
  """Template Item for catalog methods.
2136

2137 2138 2139 2140 2141
    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.
  """
2142

2143 2144
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2145
    # a mapping to store properties of methods.
2146 2147 2148 2149 2150
    # 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()
2151

2152 2153 2154 2155 2156
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170
  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

2171 2172
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2173

2174
    catalog = _getCatalogValue(self)
2175
    if catalog is None:
2176
      LOG('BusinessTemplate build', 0, 'catalog not found')
2177
      return
2178

2179 2180 2181
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2182

2183 2184
    for obj in self._objects.values():
      method_id = obj.id
2185 2186
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2187
      self._is_filtered_archive[method_id] = 0
2188
      if catalog.filter_dict.has_key(method_id):
2189 2190 2191 2192 2193 2194 2195 2196 2197
        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']
2198

2199
  def generateXml(self, path):
2200
    catalog = _getCatalogValue(self)
2201 2202 2203 2204
    obj = self._objects[path]
    method_id = obj.id
    xml_data = '<catalog_method>'
    if self._method_properties.has_key(method_id):
2205
      for method_property, value in self._method_properties[method_id].items():
2206 2207 2208
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2209

Aurel's avatar
Aurel committed
2210
      if catalog.filter_dict.has_key(method_id):
2211
        if catalog.filter_dict[method_id]['filtered']:
2212 2213 2214
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2215
          for method in catalog_method_filter_list:
2216 2217 2218 2219 2220
            try:
              value = getattr(self, method, '')[method_id]
            except KeyError:
              # the method has no key
              continue
2221 2222
            if method != '_filter_expression_instance_archive':
              if type(value) in (type(''), type(u'')):
2223 2224 2225
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2226
              elif type(value) in (type(()), type([])):
2227
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2228
                for item in value:
2229 2230
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2231
    xml_data += '\n</catalog_method>'
Christophe Dumez's avatar
Christophe Dumez committed
2232
    return xml_data
2233

2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262
  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)

2263 2264
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2265
    catalog = _getCatalogValue(self)
2266 2267 2268 2269 2270 2271 2272
    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)
2273

2274 2275 2276
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2277
    new_bt_format = context.getTemplateFormatVersion()
2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293

    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':
2294
              continue
2295 2296 2297 2298
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2299

2300 2301
    for obj in values:
      method_id = obj.id
2302

2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313
      # 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))
2314

2315 2316
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2317
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2318
        if context.getTemplateFormatVersion() == 1:
2319 2320 2321 2322 2323
          if expression and expression.strip():
            # only compile non-empty expressions
            expr_instance = Expression(expression)
          else:
            expr_instance = None
2324 2325
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2326
        filter_type = self._filter_type_archive[method_id]
2327 2328 2329
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2330
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2331
        catalog.filter_dict[method_id]['type'] = filter_type
2332
      elif method_id in catalog.filter_dict.keys():
2333
        catalog.filter_dict[method_id]['filtered'] = 0
2334

2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360
      # 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)
2361

2362 2363 2364 2365 2366 2367
        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)
2368

2369
  def uninstall(self, context, **kw):
2370
    catalog = _getCatalogValue(self)
2371 2372 2373
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2374

2375 2376 2377 2378
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2379 2380 2381 2382
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2383
    else:
2384 2385 2386 2387
      try:
        value = self._archive[object_path]
      except KeyError:
        value = None
2388 2389
      if value is not None:
        values.append(value)
2390
    for obj in values:
2391
      method_id = obj.id
2392 2393 2394 2395 2396 2397 2398 2399 2400
      # 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)
2401

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2402
      if catalog.filter_dict.has_key(method_id):
2403
        del catalog.filter_dict[method_id]
2404

2405
    # uninstall objects
2406
    ObjectTemplateItem.uninstall(self, context, **kw)
2407

2408
  def _importFile(self, file_name, file):
2409
    if file_name.endswith('.catalog_keys.xml'):
2410
      # recreate data mapping specific to catalog method
2411 2412
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2413
      xml = parse(file)
2414
      method_list = xml.getElementsByTagName('item')
2415
      for method in method_list:
2416
        key = method.getAttribute('key')
2417 2418
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
2419 2420 2421 2422
          if len(method.getElementsByTagName('value')[0].childNodes):
            value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          else:
            value = ''
2423
          key = str(key)
2424
        elif key_type == "int":
2425
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
2426
          key = str(key)
2427
        elif key_type == "tuple":
2428 2429 2430 2431
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
2432
        else:
2433
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2434
          continue
2435
        if key in catalog_method_list or key in catalog_method_filter_list:
2436
          dict = getattr(self, key, {})
2437
          dict[id] = value
2438 2439 2440
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452
    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, ))
2453

2454
class ActionTemplateItem(ObjectTemplateItem):
2455 2456

  def __init__(self, id_list, **kw):
2457
    # XXX It's look like ObjectTemplateItem __init__
2458 2459 2460 2461 2462 2463
    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

2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484
  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

2485 2486 2487 2488
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2489 2490 2491
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
Julien Muchembled's avatar
Julien Muchembled committed
2492
      # Several tools still use CMF actions
2493
      is_new_action = obj.getParentId() == 'portal_types'
2494
      id_id = is_new_action and 'reference' or 'id'
2495 2496
      for action in (is_new_action and obj.getActionInformationList
                                    or obj.listActions)():
2497
        if getattr(action, id_id, None) == value:
2498
          break
2499
      else:
2500 2501 2502 2503 2504 2505 2506
        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)
2507
      key = posixpath.join(url[-2], url[-1], value)
2508
      self._objects[key] = self.removeProperties(action)
2509
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2510

2511 2512 2513
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2514
    if context.getTemplateFormatVersion() == 1:
2515
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2516 2517
      p = context.getPortalObject()
      for id in self._objects.keys():
2518 2519 2520 2521 2522
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2523 2524 2525
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2526

2527
          if container.getParentId() == 'portal_types':
2528 2529 2530
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2531 2532
            continue

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

2623 2624
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2625 2626
    object_path = kw.get("object_path", None)
    if object_path is not None:
2627 2628 2629 2630 2631 2632 2633 2634
      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]
2635
    else:
2636
      keys = self._archive.keys()
2637
    for id in keys:
2638 2639
      if  '|' in id:
        relative_url, value = id.split(' | ')
2640 2641 2642 2643 2644
        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'
2645
      else:
2646
        relative_url, key, value = self._splitPath(id)
2647
        obj = p.unrestrictedTraverse(relative_url, None)
2648 2649 2650
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2651
          if getattr(action_list[index], key, None) == value:
2652 2653
            obj.deleteActions(selections=(index,))
            break
2654 2655
      LOG('BusinessTemplate', 100,
          'unable to uninstall action at %s, ignoring' % relative_url )
2656 2657
    BaseTemplateItem.uninstall(self, context, **kw)

2658 2659 2660
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2661
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2662 2663 2664 2665 2666 2667 2668
    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])
2669
      self._objects[relative_url] = type_role_list = []
2670
      for role in obj.getRoleInformationList():
2671
        type_role_dict = {}
2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688
        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
2689
        type_role_list.append(type_role_dict)
2690
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2691

Christophe Dumez's avatar
Christophe Dumez committed
2692
  # Function to generate XML Code Manually
2693 2694 2695 2696
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2697
      xml_data += "\n  <role id='%s'>" % role['id']
2698
      # uniq
2699
      for property in ('title', 'description', 'condition',
2700 2701 2702
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2703 2704
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2705
          xml_data += "\n   <property id='%s'>%s</property>" % \
2706 2707 2708
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2709
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2710 2711
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2712
          xml_data += "\n   <multi_property "\
2713
          "id='%s'>%s</multi_property>" % (property, prop_value)
2714 2715
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2716
    return xml_data
2717

2718 2719 2720 2721 2722 2723 2724
  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)
2725 2726
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2727 2728 2729 2730
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
2731 2732 2733
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2734 2735
    type_roles_list = []
    xml = parse(file)
2736
    xml_type_roles_list = xml.getElementsByTagName('role')
2737
    for role in xml_type_roles_list:
2738
      id = role.getAttribute('id').encode('utf_8', 'backslashreplace')
2739 2740 2741 2742 2743 2744
      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():
2745
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2746 2747 2748 2749 2750 2751 2752 2753
          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():
2754
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768
          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
2769 2770 2771
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
2772
          # reset roles before applying
2773
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
2774
          type_roles_list = self._objects[roles_path] or []
2775 2776
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
2777 2778 2779

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2780 2781 2782 2783 2784 2785
    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:
2786
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2787 2788 2789 2790 2791
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2792

2793 2794 2795 2796 2797 2798
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2799 2800
      for property in p.propertyMap():
        if property['id'] == id:
2801
          obj = p.getProperty(id)
2802
          prop_type = property['type']
2803 2804
          break
      else:
2805
        obj = None
2806
      if obj is None and not self.is_bt_for_diff:
2807
        raise NotFound, 'the property %s is not found' % id
2808
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2809

2810 2811
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
2812
    if not file_name.endswith('.xml'):
2813
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2814
      return
2815 2816 2817 2818
    xml = parse(file)
    property_list = xml.getElementsByTagName('property')
    for prop in property_list:
      id = prop.getElementsByTagName('id')[0].childNodes[0].data
2819 2820
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2821 2822 2823 2824 2825 2826 2827
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2828
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2829
      self._objects[str(id)] = (str(prop_type), value)
2830

2831 2832 2833
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2834
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2835 2836
      p = context.getPortalObject()
      for path in self._objects.keys():
2837 2838 2839 2840
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2841
              continue
2842
          dir, id = posixpath.split(path)
2843
          prop_type, property = self._objects[path]
2844 2845 2846 2847 2848 2849 2850 2851
          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
2852
    else:
2853
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2854
      p = context.getPortalObject()
2855
      for id, property in self._archive.keys():
2856
        property = self._archive[id]
Aurel's avatar
Aurel committed
2857
        if p.hasProperty(id):
2858 2859 2860 2861 2862 2863 2864
          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'])
2865 2866 2867

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2868 2869 2870 2871 2872 2873
    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:
2874 2875 2876 2877
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2878
  # Function to generate XML Code Manually
2879
  def generateXml(self, path=None):
2880
    xml_data = ''
2881
    prop_type, obj = self._objects[path]
2882
    xml_data += '\n <property>'
2883 2884
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
2885
    if prop_type in ('lines', 'tokens'):
2886
      xml_data += '\n  <value>'
2887
      for item in obj:
2888
        if item != '':
2889
          xml_data += '\n   <item>%s</item>' % escape(str(item))
2890
      xml_data += '\n  </value>'
2891
    else:
2892
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
2893
    xml_data += '\n </property>'
2894 2895
    return xml_data

Aurel's avatar
Aurel committed
2896 2897 2898 2899 2900
  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)
2901 2902 2903 2904
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2905
      xml_data += self.generateXml(path)
2906
    xml_data += '\n</site_property>'
2907
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2908

2909 2910 2911 2912 2913
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
2914 2915 2916 2917 2918 2919
    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()
2920
      permission_list = []
2921
      mapping['permission_list'] = module.showPermissions()
2922
      mapping['category_list'] = module.getCategoryList()
2923
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2924

Christophe Dumez's avatar
Christophe Dumez committed
2925
  # Function to generate XML Code Manually
2926
  def generateXml(self, path=None):
2927
    mapping = self._objects[path]
2928
    xml_data = ['<module>']
2929
    keys = mapping.keys()
2930 2931
    for key in sorted(keys):
      if key == 'permission_list':
2932
        # separe permission dict into xml
2933
        xml_data.append(' <%s>' % (key, ))
2934
        permission_list = mapping[key]
2935
        for perm in permission_list:
2936
          # the type of the permission defined if we use acquired or not
2937
          if isinstance(perm[1], list):
2938 2939 2940
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
2941
          role_list = list(perm[1])
2942 2943 2944
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
2945
          if (len(role_list) == 0 and ptype == 'list') or \
2946 2947
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
2948
          role_list.sort()
2949 2950
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
2951
          for role in role_list:
2952 2953 2954
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
2955 2956 2957 2958 2959 2960 2961 2962
      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, ))
2963
      else:
2964
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
2965 2966
    xml_data.append('</module>')
    return '\n'.join(xml_data)
2967

2968
  def export(self, context, bta, **kw):
2969
    if len(self._objects) == 0:
2970 2971 2972
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
2973 2974
    keys = self._objects.keys()
    keys.sort()
2975
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
2976
      # export modules one by one
2977 2978
      xml_data = self.generateXml(path=key)
      bta.addObject(obj=xml_data, name=key, path=path)
2979

2980
  def install(self, context, trashbin, **kw):
2981
    portal = context.getPortalObject()
2982 2983
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2984
    if context.getTemplateFormatVersion() == 1:
2985
      items = self._objects
2986
    else:
2987 2988
      items = self._archive

2989 2990
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
2991 2992
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
2993
        if not force:
2994
          action = update_dict[path]
2995 2996
          if action == 'nothing':
            continue
2997 2998
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
2999
        module = portal._getOb(module_id, None)
3000 3001
        if module is not None:
          module.portal_type = portal_type
3002
        else:
3003
          module = portal.newContent(id=module_id, portal_type=portal_type)
3004
        module.setTitle(str(mapping['title']))
3005 3006
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
3007
          # By default, Manager only without acquire permission
3008 3009
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
3010
          module.manage_permission(name, roles=role_list, acquire=acquire)
3011 3012
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
3013 3014

  def _importFile(self, file_name, file):
3015 3016 3017
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3018
    mapping = {}
3019
    xml = parse(file)
3020 3021 3022
    for key in ('portal_type', 'id', 'title', 'permission_list'):
      elt = xml.getElementsByTagName(key)[0]
      if key == 'permission_list':
3023 3024 3025
        plist = []
        perm_list = elt.getElementsByTagName('permission')
        for perm in perm_list:
3026
          perm_type = perm.getAttribute('type').encode() or None
3027 3028 3029 3030 3031 3032 3033 3034 3035
          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))
3036
          if perm_type == 'list' or perm_type is None:
3037 3038 3039
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
3040
          plist.append(perm_tuple)
3041
        mapping[key] = plist
3042 3043 3044
      else:
        node_list = elt.childNodes
        if len(node_list) == 0:
3045
          value = ''
3046 3047
        else:
          value = node_list[0].data
3048
        mapping[key] = str(value)
3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062

    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

3063
    self._objects[file_name[:-4]] = mapping
3064

3065
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3066 3067 3068
    trash = kw.get('trash', 0)
    if trash:
      return
3069 3070 3071 3072 3073 3074
    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]
3075 3076
    p = context.getPortalObject()
    id_list = p.objectIds()
3077 3078
    for key in keys:
      if key in id_list:
3079
        try:
3080
          if trash and trashbin is not None:
3081 3082 3083
            container_path = key.split('/')
            self.portal_trash.backupObject(trashbin, container_path, key, save=1, keep_subobjects=1)
          p.manage_delObjects([key])
3084
        except NotFound:
3085
          pass
3086 3087
    BaseTemplateItem.uninstall(self, context, **kw)

3088 3089 3090
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3091 3092

class DocumentTemplateItem(BaseTemplateItem):
3093 3094 3095 3096
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
3097 3098 3099 3100

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

3103
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3104 3105
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3106
      new_keys = self._objects.keys()
3107 3108 3109 3110 3111 3112 3113 3114 3115 3116
      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
3117 3118 3119 3120 3121 3122
      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:
3123 3124
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3125
        else: # new object
3126 3127
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3128 3129 3130 3131
          # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
3132 3133
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3134 3135 3136 3137 3138
    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
3139
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3140
      for id in self._objects.keys():
3141 3142 3143 3144 3145 3146
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
3147
          path, name = posixpath.split(id)
3148 3149
          # This raises an exception if the file already exists.
          try:
3150
            globals()[self.local_file_writer_name](name, text, create=0)
3151
          except IOError, error:
3152
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
3153 3154
            if error.errno :
              raise
3155 3156 3157
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
3158
    else:
3159 3160 3161
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3162
        # This raises an exception if the file exists.
3163
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
3164 3165
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
3166 3167

  def uninstall(self, context, **kw):
3168
    object_path = kw.get('object_path', None)
3169 3170 3171 3172 3173
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
3174
      globals()[self.local_file_remover_name](id)
3175 3176
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3177 3178 3179 3180 3181 3182
  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():
3183 3184
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
3185

3186
  def _importFile(self, file_name, file):
3187 3188 3189
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3190
    text = file.read()
3191
    self._objects[file_name[:-3]]=text
3192

3193 3194 3195 3196 3197 3198
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

3199 3200 3201 3202 3203
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
3204

3205 3206 3207
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
3208 3209
  # Extension needs no import
  local_file_importer_name = None
3210 3211 3212 3213 3214
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
3215
  # Test needs no import
3216 3217 3218
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
3219

3220 3221 3222
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3223 3224 3225

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3226 3227 3228 3229
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
3230
    if len(role_list) > 0:
3231
      self._objects[self.__class__.__name__+'/'+'role_list'] = role_list
Aurel's avatar
Aurel committed
3232

3233
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3234 3235
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3236
      new_roles = self._objects.keys()
3237
      if installed_bt.id == INSTALLED_BT_FOR_DIFF:
3238 3239
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
3240 3241 3242
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
3243 3244
        for key in old_keys:
          new_dict[key] = ''
3245
        installed_bt._objects = new_dict
3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258
      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):
3259
    p = context.getPortalObject()
3260
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3261
    if context.getTemplateFormatVersion() == 1:
3262
      role_list = self._objects.keys()
3263
    else:
3264
      role_list = self._archive.keys()
3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276
    # 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
3277
    for role in role_list:
3278 3279 3280 3281
      roles[role] = 1
    p.__ac_roles__ = tuple(roles.keys())

  def _importFile(self, file_name, file):
3282
    if not file_name.endswith('.xml'):
3283
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3284
      return
3285 3286 3287 3288 3289 3290
    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
3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302

  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)

3303 3304 3305 3306 3307 3308 3309 3310 3311
  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
3312
      if role in roles and role not in new_roles:
3313 3314 3315
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3316
  # Function to generate XML Code Manually
3317
  def generateXml(self, path):
3318
    obj = self._objects[path]
3319
    xml_data = '<role_list>'
3320 3321
    obj.sort()
    for role in obj:
3322 3323
      xml_data += '\n <role>%s</role>' %(role)
    xml_data += '\n</role_list>'
3324 3325
    return xml_data

Aurel's avatar
Aurel committed
3326 3327 3328 3329 3330 3331
  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():
3332
      xml_data = self.generateXml(path=path)
3333
      bta.addObject(obj=xml_data, name=path, path=None,)
3334

3335 3336
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3337
  def build(self, context, **kw):
3338
    catalog = _getCatalogValue(self)
3339 3340 3341
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3342
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3343
    key_list = []
3344
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3345
      if key in sql_search_result_keys:
3346
        key_list.append(key)
3347
      elif not self.is_bt_for_diff:
3348
        raise NotFound, 'Result key "%r" not found in catalog' %(key,)
3349
    if len(key_list) > 0:
3350
      self._objects[self.__class__.__name__+'/'+'result_key_list'] = key_list
3351 3352

  def _importFile(self, file_name, file):
3353 3354 3355
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3356 3357 3358 3359 3360 3361 3362 3363 3364
    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

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

3371
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3372
    if context.getTemplateFormatVersion() == 1:
3373 3374
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3375 3376 3377
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3378
    else:
3379
      keys = self._archive.keys()
3380 3381
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3382
    # XXX same as related key
Aurel's avatar
Aurel committed
3383
    if update_dict.has_key('result_key_list') or force:
3384
      if not force:
Aurel's avatar
Aurel committed
3385
        action = update_dict['result_key_list']
3386
        if action == 'nothing':
Aurel's avatar
Aurel committed
3387
          return
3388
      for key in keys:
3389 3390
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
3391
      catalog.sql_search_result_keys = sql_search_result_keys
3392

3393
  def uninstall(self, context, **kw):
3394
    catalog = _getCatalogValue(self)
3395 3396 3397 3398
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3399
    object_path = kw.get('object_path', None)
3400 3401 3402 3403 3404
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3405 3406
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
3407
    catalog.sql_search_result_keys = sql_search_result_keys
3408 3409
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3410
  # Function to generate XML Code Manually
3411
  def generateXml(self, path=None):
3412
    obj = self._objects[path]
3413
    xml_data = '<key_list>'
3414 3415
    obj.sort()
    for key in obj:
3416 3417
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3418 3419
    return xml_data

Aurel's avatar
Aurel committed
3420 3421 3422 3423 3424
  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)
3425
    for path in self._objects.keys():
3426
      xml_data = self.generateXml(path=path)
3427
      bta.addObject(obj=xml_data, name=path, path=None)
3428

3429 3430
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3431
  def build(self, context, **kw):
3432
    catalog = _getCatalogValue(self)
3433 3434 3435
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3436
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
3437
    key_list = []
3438
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3439
      if key in sql_search_related_keys:
3440
        key_list.append(key)
3441
      elif not self.is_bt_for_diff:
3442
        raise NotFound, 'Related key "%r" not found in catalog' %(key,)
3443
    if len(key_list) > 0:
3444
      self._objects[self.__class__.__name__+'/'+'related_key_list'] = key_list
3445 3446

  def _importFile(self, file_name, file):
3447 3448 3449
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3450 3451 3452 3453 3454 3455 3456 3457 3458
    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

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

3465
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3466
    if context.getTemplateFormatVersion() == 1:
3467
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3468
        return
3469 3470 3471
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3472
    else:
3473
      keys = self._archive.keys()
3474 3475
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3476
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
3477
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3478
      if not force:
Aurel's avatar
Aurel committed
3479 3480 3481 3482
        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
3483 3484 3485
        if action == 'nothing':
          return
      for key in keys:
3486 3487
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
3488
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
3489

3490
  def uninstall(self, context, **kw):
3491
    catalog = _getCatalogValue(self)
3492 3493 3494
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3495
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
3496
    object_path = kw.get('object_path', None)
3497 3498 3499 3500 3501
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3502 3503 3504 3505 3506
      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
3507
  # Function to generate XML Code Manually
3508
  def generateXml(self, path=None):
3509
    obj = self._objects[path]
3510
    xml_data = '<key_list>'
3511 3512
    obj.sort()
    for key in obj:
3513 3514
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3515 3516
    return xml_data

Aurel's avatar
Aurel committed
3517 3518 3519 3520 3521 3522
  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():
3523
      xml_data = self.generateXml(path=path)
3524
      bta.addObject(obj=xml_data, name=path, path=None)
3525

3526 3527
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3528
  def build(self, context, **kw):
3529
    catalog = _getCatalogValue(self)
3530 3531 3532
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3533
    sql_search_result_tables = list(catalog.sql_search_tables)
3534
    key_list = []
3535
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3536
      if key in sql_search_result_tables:
3537
        key_list.append(key)
3538
      elif not self.is_bt_for_diff:
3539
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
3540
    if len(key_list) > 0:
3541
      self._objects[self.__class__.__name__+'/'+'result_table_list'] = key_list
3542 3543

  def _importFile(self, file_name, file):
3544 3545 3546
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3547 3548 3549 3550 3551 3552 3553 3554
    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
3555

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

3562
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3563
    if context.getTemplateFormatVersion() == 1:
3564
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3565
        return
3566 3567 3568
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3569
    else:
3570
      keys = self._archive.keys()
3571 3572
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3573
    # XXX same as related keys
Aurel's avatar
Aurel committed
3574
    if update_dict.has_key('result_table_list') or force:
3575
      if not force:
Aurel's avatar
Aurel committed
3576
        action = update_dict['result_table_list']
3577
        if action == 'nothing':
Aurel's avatar
Aurel committed
3578
          return
3579
      for key in keys:
3580 3581
        if key not in sql_search_tables:
          sql_search_tables.append(key)
3582
      catalog.sql_search_tables = tuple(sql_search_tables)
3583 3584

  def uninstall(self, context, **kw):
3585
    catalog = _getCatalogValue(self)
3586 3587 3588 3589
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
3590
    object_path = kw.get('object_path', None)
3591 3592 3593 3594 3595
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3596 3597
      if key in sql_search_tables:
        sql_search_tables.remove(key)
3598
    catalog.sql_search_tables = sql_search_tables
3599 3600
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3601
  # Function to generate XML Code Manually
3602
  def generateXml(self, path=None):
3603
    obj = self._objects[path]
3604
    xml_data = '<key_list>'
3605 3606
    obj.sort()
    for key in obj:
3607 3608
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3609 3610
    return xml_data

Aurel's avatar
Aurel committed
3611 3612 3613 3614 3615 3616
  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():
3617
      xml_data = self.generateXml(path=path)
3618
      bta.addObject(obj=xml_data, name=path, path=None)
3619

3620 3621
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3622 3623

  def build(self, context, **kw):
3624
    catalog = _getCatalogValue(self)
3625 3626 3627 3628 3629 3630 3631 3632
    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)
3633
      elif not self.is_bt_for_diff:
3634
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3635
    if len(key_list) > 0:
3636
      self._objects[self.__class__.__name__+'/'+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3637

3638
  def _importFile(self, file_name, file):
3639 3640 3641
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3642 3643 3644 3645 3646 3647 3648 3649
    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
3650 3651

  def install(self, context, trashbin, **kw):
3652
    catalog = _getCatalogValue(self)
3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665
    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()
3666 3667
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679
    # 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):
3680
    catalog = _getCatalogValue(self)
3681 3682 3683 3684
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3685
    object_path = kw.get('object_path', None)
3686 3687
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3688
    else:
3689 3690 3691 3692 3693 3694 3695
      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
3696
  # Function to generate XML Code Manually
3697 3698 3699 3700 3701
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3702 3703
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3704
    return xml_data
Aurel's avatar
Aurel committed
3705 3706 3707 3708

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3709 3710 3711 3712 3713
    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)
3714

3715 3716 3717 3718 3719 3720 3721 3722
# 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
3723
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3724 3725 3726 3727
    key_list = []
    for key in self._archive.keys():
      if key in sql_datetime_keys:
        key_list.append(key)
3728
      elif not self.is_bt_for_diff:
3729 3730 3731 3732 3733
        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):
3734 3735 3736
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751
    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

3752
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778
    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
3779
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809
    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)      
      
3810 3811
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3812

3813
  def build(self, context, **kw):
3814
    catalog = _getCatalogValue(self)
3815 3816 3817 3818 3819 3820 3821 3822
    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)
3823
      elif not self.is_bt_for_diff:
3824
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
3825
    if len(key_list) > 0:
3826
      self._objects[self.__class__.__name__+'/'+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3827

3828
  def _importFile(self, file_name, file):
3829 3830 3831
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3832 3833 3834 3835 3836 3837 3838 3839
    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
3840

3841
  def install(self, context, trashbin, **kw):
3842
    catalog = _getCatalogValue(self)
3843 3844 3845
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3846

3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867
    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
3868

3869
  def uninstall(self, context, **kw):
3870
    catalog = _getCatalogValue(self)
3871 3872 3873 3874
    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)
3875
    object_path = kw.get('object_path', None)
3876 3877 3878 3879 3880 3881 3882 3883 3884 3885
    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
3886
  # Function to generate XML Code Manually
3887 3888 3889 3890 3891
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3892 3893
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909
    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):
3910
    catalog = _getCatalogValue(self)
3911 3912 3913 3914 3915 3916 3917 3918
    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)
3919
      elif not self.is_bt_for_diff:
3920
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
3921
    if len(key_list) > 0:
3922
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
3923 3924

  def _importFile(self, file_name, file):
3925 3926 3927
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3928 3929 3930 3931 3932 3933 3934 3935 3936 3937
    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):
3938
    catalog = _getCatalogValue(self)
3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965
    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):
3966
    catalog = _getCatalogValue(self)
3967 3968 3969 3970
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
3971
    object_path = kw.get('object_path', None)
3972 3973 3974 3975 3976 3977 3978 3979 3980 3981
    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
3982
  # Function to generate XML Code Manually
3983 3984 3985 3986 3987
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3988 3989
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004
    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):
4005
    catalog = _getCatalogValue(self)
4006 4007 4008 4009 4010 4011 4012 4013
    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)
4014
      elif not self.is_bt_for_diff:
4015
        raise NotFound, 'Multivalue key "%r" not found in catalog' %(key,)
4016
    if len(key_list) > 0:
4017
      self._objects[self.__class__.__name__+'/'+'multivalue_key_list'] = key_list
4018 4019

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

  def _importFile(self, file_name, file):
4114 4115 4116
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4117 4118 4119 4120 4121 4122 4123 4124 4125 4126
    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):
4127
    catalog = _getCatalogValue(self)
4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154
    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):
4155
    catalog = _getCatalogValue(self)
4156 4157 4158 4159
    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)
4160
    object_path = kw.get('object_path', None)
4161 4162 4163 4164 4165 4166 4167 4168 4169 4170
    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
4171
  # Function to generate XML Code Manually
4172 4173 4174 4175 4176
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4177 4178
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189
    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)

4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201
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)
4202
      elif not self.is_bt_for_diff:
4203 4204 4205 4206 4207
        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):
4208 4209 4210
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
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 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284
    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)

4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297
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)
4298
      elif not self.is_bt_for_diff:
4299 4300 4301 4302 4303
        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):
4304 4305 4306
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
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 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393
    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)
4394
      elif not self.is_bt_for_diff:
4395 4396 4397 4398 4399
        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):
4400 4401 4402
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
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 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476
    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)

4477 4478 4479 4480
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4481 4482 4483
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4484
      else: # XXX backward compatibility
4485 4486
        lang = lang_key
        catalog = 'erp5_ui'
4487
      path = posixpath.join(lang, catalog)
4488 4489
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4490 4491 4492
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518

  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:
4519 4520
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4521
          if not force:
4522
            action = update_dict[key]
4523
            if action == 'nothing':
4524
              continue
4525 4526 4527 4528 4529
          path = key.split('/')
          if len(path) == 1:
            lang = path[0]
            catalog = None
          elif len(path) == 2:
4530 4531 4532 4533 4534
            lang = path[0]
            catalog = path[1]
          else:
            lang = path[-3]
            catalog = path[-2]
4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550

          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)
4551 4552
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4553 4554 4555 4556 4557 4558 4559 4560
          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)
4561 4562
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4563
      for lang, catalogs in self._archive.iteritems():
4564 4565 4566 4567 4568 4569 4570 4571 4572
        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):
4573
    if len(self._objects) == 0:
4574 4575 4576
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
4577
    for key, obj in self._objects.iteritems():
4578 4579
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
4580 4581 4582 4583 4584 4585 4586 4587
      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'))
4588 4589

  def _importFile(self, file_name, file):
4590 4591
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4592 4593
      text = file.read()
      self._objects[file_name[:-3]] = text
4594 4595 4596 4597 4598 4599 4600 4601
    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
4602

Aurel's avatar
Aurel committed
4603 4604
class LocalRolesTemplateItem(BaseTemplateItem):

4605
  def __init__(self, id_list, **kw):
4606
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4607 4608
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4609 4610 4611
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4612
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4613 4614
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4615
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4616

Christophe Dumez's avatar
Christophe Dumez committed
4617
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4618
  def generateXml(self, path=None):
4619
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4620 4621
    # local roles
    xml_data = '<local_roles_item>'
4622
    xml_data += '\n <local_roles>'
4623
    for key in sorted(local_roles_dict):
4624
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4625 4626
      tuple = local_roles_dict[key]
      for item in tuple:
4627 4628 4629 4630
        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
4631
    return xml_data
4632

Aurel's avatar
Aurel committed
4633 4634 4635 4636 4637 4638 4639 4640
  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)

4641
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4642
      encode_folders = []
4643
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4644
        if '%' not in folder:
4645
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4646 4647
        else:
          encode_folders.append(folder)
4648
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4649 4650 4651 4652
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
4653 4654 4655
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4656 4657 4658
    xml = parse(file)
    # local roles
    local_roles = xml.getElementsByTagName('local_roles')[0]
4659
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
4660 4661 4662
    local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
4663 4664
      if isinstance(id, unicode):
        id = id.encode('utf-8')
Aurel's avatar
Aurel committed
4665 4666 4667 4668 4669
      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
4670
    self._objects['local_roles/'+file_name[:-4]] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681

  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
4682 4683
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4684
        local_roles_dict = self._objects[roles_path][0]
4685
        setattr(obj, '__ac_local_roles__', local_roles_dict)
Aurel's avatar
Aurel committed
4686 4687 4688 4689 4690 4691 4692

  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__', {})
4693

4694 4695 4696
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4697
    in part or completely. Each object is separated from its
4698 4699 4700 4701 4702 4703 4704 4705 4706 4707
    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
4708 4709
      - object without optimal actions
      - list of relation between portal type and workflow
4710 4711 4712 4713 4714 4715 4716 4717 4718 4719

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

    - site property definition
      - id
      - type
4720
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4721

4722 4723
    - document/propertysheet/extension/test definition
      - copy of the local file
4724

4725
    - message transalation definition
4726
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4727

4728 4729
    The Business Template properties are exported to the bt folder with
    one property per file
4730

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4731 4732
    Technology:

4733 4734
    - 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
4735

4736
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4737 4738 4739 4740

    Use case:

    - install core ERP5 (the minimum)
4741

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

4744 4745
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4746
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4747 4748 4749 4750 4751
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4752
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4753 4754 4755

    # Declarative security
    security = ClassSecurityInfo()
4756
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4757 4758 4759 4760

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4761
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4762
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4763
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4764
                      , PropertySheet.BusinessTemplate
4765
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4766 4767
                      )

4768 4769 4770 4771 4772 4773
    # 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."""
4774
         , 'icon'           : 'file_icon.gif'
4775 4776 4777 4778 4779 4780 4781 4782 4783
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4784 4785
    # This is a global variable
    # Order is important for installation
4786 4787 4788 4789 4790 4791
    # 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 )
4792 4793
    _item_name_list = [
      '_product_item',
4794
      '_property_sheet_item',
4795
      '_constraint_item',
4796 4797 4798 4799
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4800
      '_tool_item',
4801 4802 4803 4804
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4805
      '_portal_type_workflow_chain_item',
4806 4807 4808 4809
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4810 4811
      '_category_item',
      '_module_item',
4812
      '_path_item',
4813
      '_skin_item',
4814
      '_registered_skin_selection_item',
4815
      '_preference_item',
4816
      '_action_item',
4817
      '_portal_type_roles_item',
4818
      '_local_roles_item',
4819
      '_catalog_method_item',
4820 4821 4822
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4823
      '_catalog_keyword_key_item',
4824
      '_catalog_datetime_key_item',
4825 4826 4827 4828
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4829
      '_catalog_scriptable_key_item',
4830 4831
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4832 4833 4834 4835
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4836 4837 4838 4839 4840 4841
      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
4842
        self._baseGetTemplateFormatVersion()
4843

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4844 4845 4846
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4847

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4848
      return 0
4849

4850
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4851 4852 4853 4854 4855 4856 4857
    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".
4858 4859
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4860
          # XXX Not good to access the attribute directly,
4861 4862 4863
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4864

4865 4866
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4867 4868 4869 4870 4871 4872
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4873
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4874 4875 4876 4877 4878 4879 4880 4881
        """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)
4882

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

4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003
    security.declareProtected(Permissions.ManagePortal, 'build')
    def build(self, no_action=0):
      """
        Copy existing portal objects to self
      """
      if no_action: return
        # this is use at import of Business Template to get the status built
      # Make sure that everything is sane.
      self.clean()

      self.updateRevisionNumber()

      self._setTemplateFormatVersion(1)

      self.storeTemplateItemData()

5004 5005
      # Build each part
      for item_name in self._item_name_list:
5006 5007 5008 5009
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
5010

5011
    build = WorkflowMethod(build)
5012 5013

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5014
      """
5015
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5016
      """
5017
      return self.portal_templates.publish(self, url, username=username,
5018
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5019

5020
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5021
      """
5022
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5023
      """
5024
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5025

5026 5027 5028 5029 5030
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
5031 5032 5033 5034 5035 5036 5037 5038 5039 5040
      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
5041 5042
      return False

5043
    def preinstall(self, check_dependencies=1, **kw):
5044 5045 5046
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
5047
      """
5048 5049 5050 5051 5052
      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()
5053

5054 5055
      modified_object_list = {}
      bt_title = self.getTitle()
5056 5057 5058 5059 5060 5061 5062

      #  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)
5063 5064 5065
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5066
        installed_bt_format = installed_bt.getTemplateFormatVersion()
5067

5068
      # if reinstall business template, must compare to object in ZODB
5069
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
5070
      # same if we make a diff and select only one business template
5071
      reinstall = 0
5072 5073
      if installed_bt == self:
        reinstall = 1
5074 5075 5076 5077 5078 5079 5080 5081 5082
        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)
5083

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5084
      new_bt_format = self.getTemplateFormatVersion()
5085 5086 5087 5088 5089 5090
      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:
5091
          item = getattr(self, item_name, None)
5092 5093 5094 5095
          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
5096

5097
      for item_name in self._item_name_list:
5098
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5099
        old_item = getattr(installed_bt, item_name, None)
5100
        if new_item is not None:
5101
          if old_item is not None and hasattr(old_item, '_objects'):
5102
            modified_object = new_item.preinstall(context=self, installed_bt=old_item)
5103 5104 5105 5106 5107 5108 5109
            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:
5110
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5111

5112 5113
      return modified_object_list

5114 5115
    def _install(self, force=1, object_to_update=None, update_translation=0,
                 update_catalog=0, **kw):
5116
      """
Christophe Dumez's avatar
Christophe Dumez committed
5117
        Install a new Business Template, if force, all will be upgraded or installed
5118 5119
        otherwise depends of dict object_to_update
      """
5120 5121 5122 5123
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
5124

5125 5126
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
5127 5128
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5129
        if installed_bt.getTemplateFormatVersion() == 0:
5130
          force = 1
5131
        installed_bt.replace(self)
5132

5133 5134 5135 5136
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

5137 5138 5139
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
5140

5141 5142 5143
      if not force:
        self.checkDependencies()

5144
      site = self.getPortalObject()
5145 5146 5147
      from Products.ERP5.ERP5Site import ERP5Generator
      generator_class = getattr(site, '_generator_class', ERP5Generator)
      gen = generator_class()
5148 5149 5150
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Activity Tool')
5151
        gen.setupLastTools(site, update=1, create_activities=1)
5152 5153
      if not force:
        if len(object_to_update) == 0:
5154 5155 5156 5157 5158
          # 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():
5159
            LOG('Business Template', 0, 'Updating Business Template Workflows')
5160
            gen.setupWorkflow(site)
5161
          return
5162

5163 5164
      # 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
5165
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
5166 5167 5168 5169 5170
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
5171
      if len(object_to_update) or force:
5172 5173 5174
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
5175
            item.install(self, force=force, object_to_update=object_to_update, trashbin=trashbin, installed_bt=installed_bt)
5176

5177
      # update catalog if necessary
5178 5179
      if force and self.isCatalogUpdatable():
        update_catalog = 1
5180
      if update_catalog:
5181
        catalog = _getCatalogValue(self)
5182
        if (catalog is None) or (not site.isIndexable):
5183 5184 5185 5186 5187
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
5188

5189
      # get objects to remove
5190
      # do remove after because we may need backup object from installation
5191
      remove_object_dict = {}
5192 5193
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
5194
          remove_object_dict[path] = action
5195

5196
      # remove object from old business template
5197
      if len(remove_object_dict):
5198
        # XXX: this code assumes that there is an installed_bt
5199
        for item_name in reversed(installed_bt._item_name_list):
5200
          item = getattr(installed_bt, item_name, None)
5201
          if item is not None:
5202
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
5203

5204 5205 5206 5207 5208 5209

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

5210
      # check if we have to update business template workflow
5211
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
5212
        LOG('Business Template', 0, 'Updating Business Template Workflows')
5213 5214 5215 5216 5217
        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)

5218 5219
      # remove trashbin if empty
      if trashbin is not None:
5220
        if len(trashbin) == 0:
5221 5222
          trash_tool.manage_delObjects([trashbin.getId(),])

5223 5224
      if update_catalog:
        site.ERP5Site_reindexAll()
5225

5226 5227
      # Update translation table, in case we added new portal types or
      # workflow states.
5228 5229
      if update_translation:
        site.ERP5Site_updateTranslationTable()
5230

5231 5232
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
5233

5234
    security.declareProtected(Permissions.ManagePortal, 'install')
5235 5236 5237
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
5238
      """
5239
      return self._install(**kw)
5240

5241
    install = WorkflowMethod(install)
5242

5243
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
5244
    def reinstall(self, **kw):
5245 5246 5247 5248
      """Reinstall Business Template.
      """
      return self._install(**kw)

5249
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5250

5251
    security.declareProtected(Permissions.ManagePortal, 'trash')
5252 5253
    def trash(self, new_bt, **kw):
      """
5254
        Trash unnecessary items before upgrading to a new business
5255
        template.
5256
        This is similar to uninstall, but different in that this does
5257
        not remove all items.
5258
      """
5259 5260
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5261
        item = getattr(self, item_name, None)
5262 5263
        if item is not None:
          item.trash(
5264
                self,
5265
                getattr(new_bt, item_name))
5266

5267
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
5268
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5269
      """
5270
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5271
      """
5272 5273 5274
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5275
        item = getattr(self, item_name, None)
5276
        if item is not None:
5277
          item.uninstall(self)
5278
      # It is better to clear cache because the uninstallation of a
5279
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
5280
      self.getPortalObject().portal_caches.clearAllCache()
5281

5282 5283
    uninstall = WorkflowMethod(uninstall)

5284
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5285
    def _clean(self):
5286
      """
5287
        Clean built information.
5288
      """
5289
      # First, remove obsolete attributes if present.
5290 5291 5292 5293
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
5294
                    '_module_archive',
5295 5296 5297
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
5298
                    '_property_sheet_archive'):
5299 5300 5301
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
5302 5303
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
5304

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

5307
    security.declareProtected(Permissions.AccessContentsInformation,
5308
                              'getBuildingState')
5309
    def getBuildingState(self, default=None, id_only=1):
5310
      """
5311
        Returns the current state in building
5312
      """
5313
      portal_workflow = getToolByName(self, 'portal_workflow')
5314 5315
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
5316
      return wf._getWorkflowStateOf(self, id_only=id_only )
5317

5318
    security.declareProtected(Permissions.AccessContentsInformation,
5319
                              'getInstallationState')
5320
    def getInstallationState(self, default=None, id_only=1):
5321
      """
5322
        Returns the current state in installation
5323
      """
5324
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
5325 5326
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
5327
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5328

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5329 5330 5331 5332 5333 5334
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
5335
      export_string = portal_templates.manage_exportObject(
5336 5337
                                               id=self.getId(),
                                               toxml=1,
5338
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5339
      return export_string
5340

5341
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5342
      """
5343 5344
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5345
      """
5346 5347
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
5348 5349 5350 5351
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
5352
        # XXX Why do we need to return a tuple ?
5353 5354
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5355

5356
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5357
      """
5358 5359
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5360
      """
5361
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5362

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

5370
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5371
      """
5372 5373
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5374
      """
5375
      return self._getOrderedList('template_workflow_id')
5376

5377
    def getTemplatePortalTypeIdList(self):
5378
      """
5379 5380
      We have to set this method because we want an
      ordered list
5381
      """
5382
      return self._getOrderedList('template_portal_type_id')
5383

5384 5385 5386 5387 5388 5389 5390
    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
5391 5392 5393 5394 5395 5396 5397
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

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

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

5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432
    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')

5433
    def getTemplateActionPathList(self):
5434
      """
5435 5436
      We have to set this method because we want an
      ordered list
5437
      """
5438
      return self._getOrderedList('template_action_path')
5439

5440
    def getTemplatePortalTypeRoleList(self):
5441 5442 5443 5444
      """
      We have to set this method because we want an
      ordered list
      """
5445
      return self._getOrderedList('template_portal_type_role')
5446

5447
    def getTemplateLocalRoleList(self):
5448 5449 5450 5451
      """
      We have to set this method because we want an
      ordered list
      """
5452
      return self._getOrderedList('template_local_role')
5453

5454
    def getTemplateSkinIdList(self):
5455
      """
5456 5457
      We have to set this method because we want an
      ordered list
5458
      """
5459
      return self._getOrderedList('template_skin_id')
5460

5461 5462 5463 5464 5465 5466 5467
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

5468
    def getTemplateModuleIdList(self):
5469
      """
5470 5471
      We have to set this method because we want an
      ordered list
5472
      """
5473
      return self._getOrderedList('template_module_id')
5474 5475 5476 5477 5478 5479 5480

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5482 5483 5484 5485 5486 5487 5488
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5489
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5490 5491 5492 5493
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5494
      if self.getBuildingState() != 'built':
5495
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5496
              'Business Template must be built before export'
5497

Aurel's avatar
Aurel committed
5498 5499 5500 5501 5502 5503 5504
      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)

5505
      # export bt
5506
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
5507
      for prop in self.propertyMap():
5508
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5509
        id = prop['id']
5510
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5511
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5512
          continue
Aurel's avatar
Aurel committed
5513
        value = self.getProperty(id)
5514
        if prop_type in ('text', 'string', 'int', 'boolean'):
5515
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
5516
        elif prop_type in ('lines', 'tokens'):
5517
          bta.addObject(obj=str('\n').join(value), name=id,
5518
                        path=path+os.sep+'bt', ext='')
5519

Aurel's avatar
Aurel committed
5520 5521 5522
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5523

Aurel's avatar
Aurel committed
5524 5525
      return bta.finishCreation()

5526
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5527 5528
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5529
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5530 5531 5532 5533 5534
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
5535 5536

      self.storeTemplateItemData()
5537

5538 5539
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5540
      orig_module_dict = {}
5541
      instance_oid_list = []
5542 5543 5544 5545
      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)
5546
          orig_module_dict[module_id] = sys.modules.get(module_id)
5547 5548 5549 5550 5551 5552 5553 5554 5555 5556
          # Always redefine the module, so that 'instance_oid_list' contains
          # the full list of oid to remove from pickle cache.
          sys.modules[module_id] = module = imp.new_module(module_id)
          module.SimpleItem = SimpleItem.SimpleItem
          module.instance_oid_list = instance_oid_list
          exec """class %s(SimpleItem):
            def __setstate__(self, state):
              instance_oid_list.append(self._p_oid)
              return SimpleItem.__setstate__(self, state)""" % template_id \
            in module.__dict__
5557

Aurel's avatar
Aurel committed
5558 5559
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5560

5561 5562
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5563 5564 5565 5566 5567 5568
      # Restore original module if any, in case the new one is not installed.
      for module_id, module in orig_module_dict.iteritems():
        if module is None:
          del sys.modules[module_id]
        else:
          sys.modules[module_id] = module
5569 5570 5571 5572 5573 5574 5575
      # Remove from pickle cache all objects whose classes are temporary
      # (= defined by this BT). This forces to reload these objects on next
      # access, with the correct classes.
      # Invalidation is forced using __delitem__ instead of invalidate.
      if instance_oid_list:
        pickle_cache = self.getPortalObject()._p_jar._cache
        for oid in instance_oid_list:
5576 5577
          if pickle_cache.get(oid) is not None:
            del pickle_cache[oid]
5578

5579 5580 5581 5582 5583
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5584 5585 5586
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5587
      return items_list
5588

5589 5590 5591 5592 5593 5594 5595 5596 5597 5598
    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:
5599
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5600
          dependency = dependency_couple_list[0]
5601 5602
          if dependency in (None, ''):
            continue
5603 5604
          version_restriction = None
          if len(dependency_couple_list) > 1:
5605
            version_restriction = dependency_couple_list[1]
5606 5607 5608
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5609 5610 5611
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5612
                  or (version_restriction not in (None, '') and
5613 5614 5615 5616
                     (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)
5617

Aurel's avatar
Aurel committed
5618
    def diffObject(self, REQUEST, **kw):
5619 5620
      """
        Make a diff between an object in the Business Template
5621
        and the same in the Business Template installed in the site
5622 5623 5624 5625
      """

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

5666 5667
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5668

Christophe Dumez's avatar
Christophe Dumez committed
5669
      # Get objects
5670
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5671

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

5693 5694
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5695
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5696
        # XXX maybe only build for the given object to gain time
5697
        installed_item.build(self)
5698 5699 5700
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5701

Christophe Dumez's avatar
Christophe Dumez committed
5702
      # Real Zope Objects (can be exported into XML directly by Zope)
5703 5704
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5705
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5706
                     '_skin_item', '_action_item', '_tool_item', ]
5707

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

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

5736
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5737 5738 5739
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5740 5741
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
5742
        # XML Export in memory
5743 5744 5745
        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()
5746
        f1.close()
5747 5748 5749 5750
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5751
        # End of XML export
5752

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

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

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

5777
      elif item_name in item_list_3:
5778
        # Diff between text objects
5779 5780 5781 5782
        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
5783
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5784 5785
          diff_msg += '\n'.join(diff_list)
        else:
5786
          diff_msg = 'No diff'
5787

5788
      else:
5789
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5790

5791
      if compare_to_zodb:
5792
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5793

5794
      return diff_msg
5795

5796

5797 5798 5799 5800
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5801 5802
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5803 5804 5805 5806 5807 5808 5809
      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 [])
5810 5811
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5812
      p = self.getPortalObject()
5813
      for id in bt_portal_types_id_list:
5814 5815
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5816
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5817
        if portal_type.getRoleInformationList():
5818 5819
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5820

5821 5822 5823 5824
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5825
        action_list = []
5826 5827 5828 5829 5830 5831 5832
        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'):
5833
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5834 5835
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5836

5837 5838 5839 5840
        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)
5841

5842
        for h_id in hidden_content_type_list:
5843 5844 5845
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5846

5847 5848 5849 5850
        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)
5851

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

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

5862
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5863
                                    if chain != '(Default)']:
5864 5865 5866
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5867

5868 5869 5870 5871
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5872
      bt_action_list.sort()
5873
      bt_wf_chain_list.sort()
5874

5875 5876 5877 5878 5879 5880 5881
      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)
5882 5883 5884 5885 5886 5887 5888 5889 5890
      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:
5891 5892
        raise TemplateConditionError, 'No module defined in business template'

5893 5894 5895 5896 5897 5898 5899 5900
      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:
5901
          return type_list
5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915

        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():
5916
            type_list.update(getChildPortalType(hidden_ptype_id))
5917
        return type_list
5918

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

5966 5967 5968
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5969
  setattr(BusinessTemplate, key, None)
5970

5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997
# 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)
5998

5999 6000 6001 6002 6003 6004 6005 6006

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

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