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

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

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

83 84 85 86 87 88
import threading

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

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

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

108 109
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'

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

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

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

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

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

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

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

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

  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
313

314
  def finishCreation(self, name=None, **kw):
Aurel's avatar
Aurel committed
315 316 317 318
    pass

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

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

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

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

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

Aurel's avatar
Aurel committed
396 397 398 399 400 401
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

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

  def addFolder(self, name=''):
415
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
416
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
417 418
      os.makedirs(name)

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

438 439
  def finishCreation(self, name):
    self.tar.add(name)
Aurel's avatar
Aurel committed
440
    self.tar.close()
441
    shutil.rmtree(name)
Aurel's avatar
Aurel committed
442 443 444 445 446
    return self.fobj

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

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

475
class TemplateConditionError(Exception): pass
476
class TemplateConflictError(Exception): pass
477
class BusinessTemplateMissingDependency(Exception): pass
478

479
class BaseTemplateItem(Implicit, Persistent):
480
  """
481
    This class is the base class for all template items.
482
    is_bt_for_diff means This BT is used to compare self temporary BT with installed BT
483
  """
484
  is_bt_for_diff = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
485

486
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
487
    self.__dict__.update(kw)
488
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
489
    self._objects = PersistentMapping()
490
    for id in id_list:
491 492
      if id is not None and id != '':
        self._archive[id] = None
493 494 495 496

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

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

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

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

559

560 561 562 563
  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
564
  def export(self, context, bta, **kw):
565
    pass
Aurel's avatar
Aurel committed
566

567 568
  def getKeys(self):
    return self._objects.keys()
569

Aurel's avatar
Aurel committed
570
  def importFile(self, bta, **kw):
571
    bta.importFiles(item=self)
572

573 574 575
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
576
    """
577 578 579 580 581 582 583 584 585 586 587 588 589 590
    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):
591
        obj.deletePdfContent()
592 593
    elif meta_type == 'Script (Python)':
      obj._code = None
594 595 596 597
    elif  interfaces.IIdGenerator.providedBy(obj):
      for dict_name in ('last_max_id_dict', 'last_id_dict'):
        if getattr(obj, dict_name, None) is not None:
          setattr(obj, dict_name, None)
598 599
    return obj

600 601 602 603 604 605 606 607 608
  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]

609 610 611
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
612
  """
613

614 615 616 617
  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()
618
      self._archive.clear()
619 620 621
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
622

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

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

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

697
  def _compileXML(self, file):
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 747 748 749 750 751 752 753 754 755 756
    # 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
757

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

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

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

841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
  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

857
  def onNewObject(self, obj):
858 859 860 861
    """
      Installation hook.
      Called when installation process determined that object to install is
      new on current site (it's not replacing an existing object).
862
      `obj` parameter is the newly created object in its acquisition context.
863 864 865 866
      Can be overridden by subclasses.
    """
    pass

867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
  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

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

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

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

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

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

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
1197
    trash = kw.get('trash', 0)
1198 1199 1200 1201 1202
    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
1203
      object_keys = self._archive.keys()
1204
    for relative_url in object_keys:
1205 1206
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
1207
      try:
1208
        container = portal.unrestrictedTraverse(container_path)
1209
        object = container._getOb(object_id) # We force access to the object to be sure
1210 1211
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
1212
        if trash and trashbin is not None:
1213
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
1214
        if container.meta_type == 'CMF Skins Tool':
1215 1216
          # we are removing a skin folder, check and 
          # remove if registered skin selection
1217
          skin_folder = container[object_id]
1218 1219 1220
          unregisterSkinFolder(container, skin_folder,
              container.getSkinSelections())

1221
        container.manage_delObjects([object_id])
1222
        if container.aq_parent.meta_type == 'ERP5 Catalog' and not len(container):
1223
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1224
          container.getParentValue().manage_delObjects([container.id])
1225
      except (NotFound, KeyError, BadRequest, AttributeError):
1226
        # object is already backup and/or removed
1227
        pass
1228 1229
    BaseTemplateItem.uninstall(self, context, **kw)

1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
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

1242 1243 1244 1245 1246 1247 1248 1249 1250
  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()
1251 1252
    object_keys.sort()
    object_keys.reverse()
1253 1254
    p = context.getPortalObject()
    for path in object_keys:
1255 1256 1257 1258 1259
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1260 1261 1262
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1263
        try:
Aurel's avatar
Aurel committed
1264 1265
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
1266 1267
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
1268 1269
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1270
                                           keep_subobjects=1)
1271 1272 1273 1274 1275 1276
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1277 1278 1279
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1280

1281 1282 1283 1284 1285 1286 1287 1288 1289
      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.
1290 1291 1292
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1293
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1294 1295
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1296
      if object_id != "":
1297
        path_list.extend(self._resolvePath(
1298
            folder._getOb(object_id),
1299
            relative_url_list + [object_id], id_list[1:]))
1300
    return path_list
Aurel's avatar
Aurel committed
1301

1302 1303 1304
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1305
    keys = self._path_archive.keys()
1306
    keys.sort()
Aurel's avatar
Aurel committed
1307
    for path in keys:
1308 1309 1310
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
1311
      for relative_url in self._resolvePath(p, [], path.split('/')):
1312 1313
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1314
        obj = obj.__of__(context)
1315
        _recursiveRemoveUid(obj)
1316
        id_list = obj.objectIds()
1317
        obj = self.removeProperties(obj)
1318
        if hasattr(aq_base(obj), 'groups'):
1319
          # we must keep groups because it's ereased when we delete subobjects
1320
          groups = deepcopy(obj.groups)
1321
        if len(id_list) > 0:
1322 1323
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1324
          for id_ in list(id_list):
1325
            obj._delObject(id_)
1326
        if hasattr(aq_base(obj), 'groups'):
1327 1328 1329
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1330

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1331 1332 1333 1334 1335 1336 1337 1338
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)

1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
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")
1354
    if len(id_list) != 1:
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
      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():
1367
      pref = portal.unrestrictedTraverse(object_path)
1368
      # XXX getPreferenceState is a bad name
1369
      if pref.getPreferenceState() == 'disabled':
1370 1371
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1372 1373
        portal.portal_workflow.doActionFor(
                      pref,
1374 1375 1376
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1377 1378
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1379

1380 1381
class CategoryTemplateItem(ObjectTemplateItem):

1382 1383
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1384

1385 1386 1387 1388
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1389 1390
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1391
      obj = self.removeProperties(obj)
1392
      id_list = obj.objectIds()
1393
      if id_list:
1394
        self.build_sub_objects(context, id_list, relative_url)
1395
        for id_ in list(id_list):
1396
          obj._delObject(id_)
1397 1398
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1399 1400 1401 1402 1403

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1404 1405
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1406
      _recursiveRemoveUid(obj)
1407
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1408
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1409
      id_list = obj.objectIds()
1410 1411
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1412
        for id_ in list(id_list):
1413
          obj._delObject(id_)
1414
      else:
1415
        for id_ in list(id_list):
1416
          obj._delObject(id_)
1417 1418
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1419

1420 1421 1422
  def beforeInstall(self):
    self._installed_new_category = False

1423
  def onNewObject(self, obj):
1424 1425 1426 1427
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1428 1429
      # reset accessors if we installed a new category
      _aq_reset()
1430

1431 1432
class SkinTemplateItem(ObjectTemplateItem):

1433 1434
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1435

1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
  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')

1446 1447
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
    # 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

1461
  def install(self, context, trashbin, **kw):
1462
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1463 1464
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1465
    p = context.getPortalObject()
1466
    skin_tool = p.portal_skins
1467 1468
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1469
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1470 1471
        fixZSQLMethod(p, obj)

1472
      # Do not register skin which were explicitely ask not to be installed
1473 1474 1475 1476 1477
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
      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',
          [])
1494 1495 1496
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1497
      if skin_selection_id in selection_list:
1498
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1499
      else:
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
        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):
1519
    if not self._objects:
1520 1521 1522 1523
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
1524 1525 1526
    bta.addObject(obj=self.generateXml(), 
                  name='registered_skin_selection',  
                  path=root_path)
1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541

  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]
1542 1543 1544
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1545

1546
        if selection_list is default_value:
1547
          create_property = True
1548
          selection_list = self._objects[skin_folder_id]
1549
        else:
1550
          create_property = False
1551 1552 1553 1554 1555
          if isinstance(selection_list, basestring):
            selection_list = selection_list.replace(',', ' ').split(' ')
          elif isinstance(selection_list, tuple):
            selection_list = list(selection_list)
          selection_list.extend(self._objects[skin_folder_id])
1556 1557

        # Remove duplicate
1558
        selection_list = list(set(selection_list))
1559 1560 1561
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
1562
              selection_list, type='tokens')
1563 1564 1565
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
1566
              selection_list)
1567 1568

        unregisterSkinFolder(skin_tool, skin_folder,
1569
                             skin_tool.getSkinSelections())
1570
        registerSkinFolder(skin_tool, skin_folder)
1571 1572

  def uninstall(self, context, **kw):
1573 1574 1575
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1576 1577 1578 1579
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1580 1581 1582 1583
      object_keys = self._objects.keys()

    for skin_folder_id in object_keys:
      skin_folder = skin_tool[skin_folder_id]
1584
      current_selection_list = skin_folder.getProperty(
1585
        'business_template_registered_skin_selections', [])
1586
      current_selection_set = set(current_selection_list)
1587

1588 1589 1590
      skin_selection_list = workflow_id = self._objects[skin_folder_id]
      if isinstance(skin_selection_list, str):
        skin_selection_list = skin_selection_list.replace(',', ' ').split(' ')
1591 1592 1593 1594 1595
      for skin_selection in skin_selection_list:
        current_selection_set.remove(skin_selection)

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1596
        skin_folder._updateProperty(
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610
            '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)

1611
  def preinstall(self, context, installed_item, **kw):
1612 1613 1614 1615 1616
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      for path in new_keys:
1617
        if installed_item._objects.has_key(path):
1618 1619
          # compare object to see it there is changes
          new_object = self._objects[path]
1620
          old_object = installed_item._objects[path]
1621 1622 1623 1624 1625
          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
1626
      old_keys = installed_item._objects.keys()
1627 1628 1629 1630 1631 1632 1633
      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'):
1634
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1635 1636 1637 1638
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
1639 1640 1641
    for skin_folder_selection in xml.getroot():
      skin_folder_id = skin_folder_selection.find('skin_folder').text
      selection_string = skin_folder_selection.find('skin_selection').text
1642 1643
      if not selection_string:
        selection_list = []
1644
      else:
1645 1646
        selection_list = selection_string.split(',')
      skin_selection_dict[skin_folder_id] = selection_list
1647
    self._objects = skin_selection_dict
1648 1649


1650
class WorkflowTemplateItem(ObjectTemplateItem):
1651

1652 1653
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1654

1655 1656 1657 1658 1659
  # 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.

1660
  def preinstall(self, context, installed_item, installed_bt, **kw):
1661
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
1662
                                                         installed_item, **kw)
1663 1664 1665 1666
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1667
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1668 1669
      else:
        modified_workflow_dict[modified_object] = state
1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
    removed_workflow_id_list = [x[0].split('/', 1)[1] \
                                for x in modified_workflow_dict.iteritems() \
                                if x[1][0] == 'Removed']
    if len(removed_workflow_id_list) > 0:
      installed_chain_list = [[y.strip() for y in x.split('|')] for x in \
                                installed_bt.getTemplatePortalTypeWorkflowChainList()]
      new_chain_list = [[y.strip() for y in x.split('|')] for x in \
                          context.getTemplatePortalTypeWorkflowChainList()]
      chain_dict = getChainByType(context)[1]
      for workflow_id in removed_workflow_id_list:
        affected_portal_type_set = set([x[0][6:] for x in \
                                        chain_dict.iteritems() \
                                        if workflow_id in \
                                        [y.strip() for y in x[1].split(',')]])
        safe_portal_type_set = set([x[0] for x in installed_chain_list \
                                    if x[1] == workflow_id]) - \
                               set([x[0] for x in new_chain_list \
                                    if x[1] == workflow_id])
        if affected_portal_type_set - safe_portal_type_set:
          value = modified_workflow_dict['portal_workflow/%s' % workflow_id]
          modified_workflow_dict['portal_workflow/%s' % workflow_id] = \
              ('Removed but used', value[1])
1692 1693
    return modified_workflow_dict

1694
  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1695
    if context.getTemplateFormatVersion() == 1:
1696 1697 1698
      portal = context.getPortalObject()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
Julien Muchembled's avatar
Julien Muchembled committed
1699 1700 1701
      # sort to add objects before their subobjects
      for path in sorted(self._objects):
          if force:
1702
            action = 'backup'
Julien Muchembled's avatar
Julien Muchembled committed
1703
          else:
1704
            action = update_dict.get('/'.join(path.split('/')[:2]))
Julien Muchembled's avatar
Julien Muchembled committed
1705 1706
            if action in (None, 'nothing'):
              continue
1707 1708 1709 1710 1711 1712
          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
1713
            container_url = '/'.join(container_path)
1714 1715 1716 1717 1718 1719
            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
1720
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1721
            container.manage_delObjects([object_id])
1722
          obj = self._objects[path]
1723 1724 1725
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1726 1727 1728 1729 1730
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1731 1732 1733
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)

1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
  def uninstall(self, context, **kw):
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    removed_workflow_id_list = set([x.split('/', 1)[1] for x in object_keys])
    (default_chain, chain_dict) = getChainByType(context)
    for portal_type, workflow_ids in chain_dict.iteritems():
      workflow_ids = set([x.strip() for x in workflow_ids.split(',')]) - \
                     removed_workflow_id_list
      chain_dict[portal_type] = ', '.join(workflow_ids)
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
    ObjectTemplateItem.uninstall(self, context, **kw)
1749

1750 1751
class PortalTypeTemplateItem(ObjectTemplateItem):

1752 1753
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1754 1755
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1756 1757 1758
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1759 1760
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1761
      obj = p.unrestrictedTraverse(relative_url)
1762 1763 1764 1765
      # normalize relative_url, not all type informations are stored in
      # "portal_types"
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])

1766
      obj = obj._getCopy(context)
1767 1768
      # obj is in ghost state and an attribute must be accessed
      # so that obj.__dict__ does not return an empty dict
1769
      obj.meta_type
1770
      for attr in obj.__dict__.keys():
1771 1772 1773 1774 1775 1776 1777 1778
        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)
1779 1780
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1781 1782 1783 1784 1785 1786 1787 1788
  
  def onNewObject(self, obj):
    """ When we install a type which is contained in a type provider not
    registered on types tool, register the type provider.
    """
    portal = obj.getPortalObject()
    types_tool = portal.portal_types
    type_container_id = obj.getParentId()
1789 1790
    if type_container_id != 'portal_types' and \
        type_container_id not in types_tool.type_provider_list:
1791 1792
      types_tool.type_provider_list = tuple(types_tool.type_provider_list) + (
          type_container_id,)
1793

1794 1795
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1796 1797 1798 1799
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1800 1801
    # 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
1804
    # best solution, by default it is 'default_workflow', which is
1805
    # not very usefull
1806
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1807
    if context.getTemplateFormatVersion() == 1:
1808
      object_list = self._objects
1809
    else:
1810 1811
      object_list = self._archive
    for path in object_list.keys():
1812 1813 1814 1815
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1816
            continue
1817 1818
        obj = object_list[path]
        portal_type = obj.id
1819 1820 1821
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1822 1823
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1824

1825 1826
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1827 1828 1829
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
1830
      result_dict = {}
1831
      xml = parse(file)
1832
      chain_list = xml.findall('//chain')
1833
      for chain in chain_list:
1834 1835 1836 1837
        portal_type = chain.find('type').text
        workflow = chain.find('workflow').text or ''
        result_dict[portal_type] = workflow
      self._workflow_chain_archive = result_dict
1838 1839 1840
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1841
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1842

1843 1844 1845
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

1846
  def build(self, context, **kw):
1847 1848 1849 1850 1851
    # 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
1852
    p = context.getPortalObject()
1853
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1854
    for key in self._archive.keys():
1855 1856 1857
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1858
        workflow = wflist[1]
1859
      else:
1860
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1861
        portal_type = wflist[0][:-2]
1862
        workflow = ''
1863 1864 1865 1866 1867
      portal_type_key = '%s%s' % (self._chain_string_prefix, portal_type)
      if portal_type_key in chain_dict:
        workflow_name = workflow.lstrip('+-=')
        if workflow[0] != '-' and workflow_name not in \
           chain_dict[portal_type_key].split(self._chain_string_separator):
1868
          if not self.is_bt_for_diff:
1869 1870 1871
            # here, we use 'LOG' instead of 'raise', because it can
            # happen when a workflow is removed from the chain by
            # another business template.
Jérome Perrin's avatar
Jérome Perrin committed
1872
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
1873
                       'in chain for portal_type %s' % (workflow_name, portal_type))
1874
        self._objects.setdefault(portal_type, []).append(workflow)
1875
      elif not self.is_bt_for_diff:
1876
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1877
                        'is probably a sign of a missing dependency.'\
1878
                                                    % portal_type
1879

Christophe Dumez's avatar
Christophe Dumez committed
1880
  # Function to generate XML Code Manually
1881 1882
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
1883 1884 1885
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
1886
      workflow_list = self._objects[key]
1887 1888
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
1889 1890
      xml_data += '\n  <workflow>%s</workflow>' %(
        self._chain_string_separator.join(sorted(workflow_list)))
1891 1892
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
1893 1894 1895
    return xml_data

  def export(self, context, bta, **kw):
1896
    if not self._objects:
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908
      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
1909
    (default_chain, chain_dict) = getChainByType(context)
1910
    # First convert all workflow_ids into list.
1911 1912
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
1913
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1914
    # best solution, by default it is 'default_workflow', which is
1915 1916
    # not very usefull
    default_chain = ''
1917 1918
    for path in self._objects:
      if path in update_dict or force:
1919 1920 1921
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1922
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1923 1924
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
1925
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
1926
          continue
1927
        portal_type = path_splitted[-1]
1928 1929
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
1930
          # XXX we don't use the chain (Default) in erp5 so don't keep it
1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950
          old_chain_list = [workflow_id for workflow_id in\
                            chain_dict[chain_key] if workflow_id not in\
                            ('(Default)', '',)]
          old_chain_workflow_id_set = set(old_chain_list)
          # get new workflow id list
          workflow_id_list = self._objects[path]
          for wf_id in workflow_id_list:
            if wf_id[0] == '-':
              # remove wf id if already present
              if wf_id[1:] in old_chain_workflow_id_set:
                old_chain_workflow_id_set.remove(wf_id[1:])
            elif wf_id[0] == '=':
              # replace existing chain by this one
              old_chain_workflow_id_set = set()
              old_chain_workflow_id_set.add(wf_id[1:])
            # then either '+' or nothing, add wf id to the list
            elif wf_id[0] == '+':
              old_chain_workflow_id_set.add(wf_id[1:])
            else:
              old_chain_workflow_id_set.add(wf_id)
1951
            # create the new chain
1952 1953
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
1954 1955
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
1956
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
1957 1958 1959
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
1960
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
1961
        else:
1962
          if context.portal_types.getTypeInfo(portal_type) is None:
1963
            raise ValueError('Cannot chain workflow %r to non existing '
1964 1965 1966 1967 1968
                           'portal type %r' % (self._chain_string_separator\
                                                     .join(self._objects[path])
                                               , portal_type))
          chain_dict[chain_key] = self._objects[path]
    # convert workflow list into string only at the end.
1969 1970
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
1971 1972
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1973

1974 1975
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1976 1977
    object_path = kw.get('object_path', None)
    if object_path is not None:
1978
      object_key_list = [object_path]
1979
    else:
1980 1981 1982
      object_key_list = self._objects.keys()
    for object_key in object_key_list:
      path_splitted = object_key.split('/', 1)
1983 1984 1985
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
1986 1987 1988 1989 1990 1991 1992 1993 1994 1995
      path = '%s%s' % (self._chain_string_prefix, portal_type)
      if path in chain_dict:
        workflow_id_list = chain_dict[path].\
                                            split(self._chain_string_separator)
        removed_workflow_id_list = self._objects[object_key]
        for workflow_id in removed_workflow_id_list:
          for i in range(workflow_id_list.count(workflow_id)):
            workflow_id_list.remove(workflow_id)
        if not workflow_id_list:
          del chain_dict[path]
1996
        else:
1997 1998 1999 2000
          chain_dict[path] = self._chain_string_separator.\
                                                  join(workflow_id_list)
    context.getPortalObject().portal_workflow.\
                                   manage_changeWorkflows('', props=chain_dict)
2001

2002
  def preinstall(self, context, installed_item, **kw):
2003 2004
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2005
      new_key_list = self._objects.keys()
2006 2007
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
2008
      for key, value in installed_item._objects.iteritems():
2009 2010
        if not 'portal_type_workflow_chain/' in key:
          key = 'portal_type_workflow_chain/%s' % (key)
2011
        new_dict[key] = value
2012
      if new_dict:
2013
        installed_item._objects = new_dict
2014 2015
      for path in new_key_list:
        if path in installed_item._objects:
2016 2017
          # compare object to see it there is changes
          new_object = self._objects[path]
2018
          old_object = installed_item._objects[path]
2019 2020 2021 2022 2023 2024
          if isinstance(new_object, str):
            new_object = new_object.split(self._chain_string_separator)
          if isinstance(old_object, str):
            old_object = old_object.split(self._chain_string_separator)
          new_object.sort()
          old_object.sort()
2025
          if new_object != old_object:
2026
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2027
        else: # new object
2028
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2029
      # get removed object
2030 2031 2032
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2033 2034
    return modified_object_list

2035
  def _importFile(self, file_name, file):
2036
    if not file_name.endswith('.xml'):
2037
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2038
      return
2039
    # import workflow chain for portal_type
2040
    result_dict = {}
2041
    xml = parse(file)
2042
    chain_list = xml.findall('chain')
2043
    for chain in chain_list:
2044
      portal_type = chain.find('type').text
2045
      workflow_chain = chain.find('workflow').text or ''
2046
      if 'portal_type_workflow_chain/' not in portal_type:
2047 2048 2049 2050
        key = 'portal_type_workflow_chain/%s' % (portal_type,)
      else:
        key = portal_type
      result_dict[key] = workflow_chain.split(self._chain_string_separator)
2051
    self._objects = result_dict
2052

2053 2054
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2055

2056
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
2057 2058 2059
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
2060 2061
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
2062
  business_template_class_property = '_portal_type_allowed_content_type_item'
2063 2064

  def build(self, context, **kw):
2065
    types_tool = getToolByName(self.getPortalObject(), 'portal_types')
2066
    for key in self._archive.keys():
2067 2068 2069 2070
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
2071
      ob = types_tool.getTypeInfo(portal_type)
2072
      # check properties corresponds to what is defined in site
2073
      if ob is None:
2074 2075
        raise ValueError, "Portal Type %s not found in site" %(portal_type,)
      prop_value = getattr(ob, self.class_property, ())
2076
      if not allowed_type in prop_value and not self.is_bt_for_diff:
Jérome Perrin's avatar
Jérome Perrin committed
2077
        raise ValueError, "%s %s not found in portal type %s" % (
2078 2079
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)
2080 2081
      if self.class_property not in portal_type:
        key = '%s/%s' % (self.class_property, portal_type)
2082
      else:
2083 2084
        key = portal_type
      self._objects.setdefault(key, []).append(allowed_type)
2085

Christophe Dumez's avatar
Christophe Dumez committed
2086
  # Function to generate XML Code Manually
2087 2088
  def generateXml(self, path=None):
    xml_data = '<%s>' %(self.xml_tag,)
2089 2090 2091
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2092
      id_value = key.replace('%s/' % self.class_property, '')
2093
      allowed_item_list = sorted(self._objects[key])
2094
      xml_data += '\n <portal_type id="%s">' % (id_value)
2095
      for allowed_item in allowed_item_list:
2096 2097 2098
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
2099 2100 2101
    return xml_data

  def export(self, context, bta, **kw):
2102
    if not self._objects:
2103 2104 2105
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
2106
    path = os.sep.join((self.__class__.__name__, self.class_property,))
2107 2108 2109
    xml_data = self.generateXml(path=None)
    bta.addObject(obj=xml_data, name=path, path=None)

2110
  def preinstall(self, context, installed_item, **kw):
2111 2112 2113
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
2114
      new_key_list = self._objects.keys()
2115 2116
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
Nicolas Delaby's avatar
Nicolas Delaby committed
2117
      for key, value in installed_item._objects.iteritems():
2118
        if self.class_property not in key:
2119
          key = '%s/%s' % (self.class_property, key)
Nicolas Delaby's avatar
Nicolas Delaby committed
2120
        new_dict[key] = value
2121
      if new_dict:
2122
        installed_item._objects = new_dict
2123 2124
      for path in new_key_list:
        if path in installed_item._objects:
2125 2126
          # compare object to see it there is changes
          new_object = self._objects[path]
2127
          old_object = installed_item._objects[path]
2128 2129
          new_object.sort()
          old_object.sort()
2130
          if new_object != old_object:
2131
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2132
        else: # new object
2133
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2134
      # get removed object
2135 2136 2137
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2138 2139
    return modified_object_list

2140
  def _importFile(self, file_name, file):
2141
    if not file_name.endswith('.xml'):
2142
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2143
      return
2144
    path, name = posixpath.split(file_name)
2145
    xml = parse(file)
2146
    portal_type_list = xml.findall('portal_type')
2147
    for portal_type in portal_type_list:
2148 2149
      id = portal_type.get('id')
      item_type_list = [item.text for item in portal_type.findall('item')]
Nicolas Delaby's avatar
typo  
Nicolas Delaby committed
2150
      if self.class_property not in id:
2151 2152 2153 2154
        key = '%s/%s' % (self.class_property, id,)
      else:
        key = id
      self._objects[key] = item_type_list
2155 2156

  def install(self, context, trashbin, **kw):
Nicolas Delaby's avatar
Nicolas Delaby committed
2157 2158
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2159 2160
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2161 2162 2163 2164 2165 2166 2167
    installed_bt = kw.get('installed_bt')
    if installed_bt is not None:
      old_objects = getattr(installed_bt,
                            self.business_template_class_property)._objects
    else:
      old_objects = {}
    for key in set(self._objects.keys()).union(set(old_objects.keys())):
Nicolas Delaby's avatar
Nicolas Delaby committed
2168
      if key in update_dict or force:
2169 2170 2171 2172
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2173 2174 2175
        portal_id = key.split('/')[-1]
        type_information = types_tool.getTypeInfo(portal_id)
        if type_information is None:
2176 2177
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2178 2179
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
2180
        object_property_list = getattr(type_information, self.class_property, ())
Nicolas Delaby's avatar
Nicolas Delaby committed
2181 2182 2183 2184 2185 2186 2187 2188 2189
        # merge differences between portal types properties
        # for example:
        # * current value : [A,B,C]
        # * in new BT : [A,D]
        # * in old BT : [A,B]
        # -> [A,D,C] i.e. C is merged but B is not merged
        for id in object_property_list:
          if id not in property_list and id not in old_property_list:
            property_list.append(id)
2190
        setattr(type_information, self.class_property, tuple(property_list))
2191

Aurel's avatar
Aurel committed
2192
  def uninstall(self, context, **kw):
2193
    object_path = kw.get('object_path', None)
Nicolas Delaby's avatar
Nicolas Delaby committed
2194 2195
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2196
    if object_path is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
2197
      object_key_list = [object_path]
2198
    else:
Nicolas Delaby's avatar
Nicolas Delaby committed
2199 2200
      object_key_list = self._objects.keys()
    for key in object_key_list:
2201 2202 2203 2204 2205
      portal_id = key.split('/')[-1]
      type_information = types_tool.getTypeInfo(portal_id)
      if type_information is None:
        LOG("BusinessTemplate", WARNING,
            "Portal type %r not found while uninstalling" % (portal_id,))
2206 2207
        continue
      property_list = self._objects[key]
2208
      original_property_list = list(getattr(type_information,
2209
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2210 2211
      for id in property_list:
        if id in original_property_list:
2212
          original_property_list.remove(id)
2213
      setattr(type_information, self.class_property, tuple(original_property_list))
2214

2215

2216 2217
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2218
  name = 'Hidden Content Type'
2219 2220
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2221
  business_template_class_property = '_portal_type_hidden_content_type_item'
2222

2223

2224 2225
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2226
  name = 'Property Sheet'
2227 2228
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2229
  business_template_class_property = '_portal_type_property_sheet_item'
2230

2231

2232 2233
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2234
  name = 'Base Category'
2235 2236
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2237
  business_template_class_property = '_portal_type_base_category_item'
2238

2239

2240
class CatalogMethodTemplateItem(ObjectTemplateItem):
2241
  """Template Item for catalog methods.
2242

2243 2244 2245 2246 2247
    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.
  """
2248

2249 2250
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2251
    # a mapping to store properties of methods.
2252 2253 2254 2255 2256
    # 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()
2257

2258
    self._is_filtered_archive = PersistentMapping()
2259 2260
    for method in catalog_method_filter_list:
      setattr(self, method, PersistentMapping())
2261

2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275
  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

2276 2277
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2278

2279
    catalog = _getCatalogValue(self)
2280
    if catalog is None:
2281
      LOG('BusinessTemplate build', 0, 'catalog not found')
2282
      return
2283

2284 2285 2286
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2287

2288 2289
    for obj in self._objects.values():
      method_id = obj.id
2290 2291
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2292 2293 2294 2295 2296 2297
      filter = catalog.filter_dict.get(method_id, {})
      self._is_filtered_archive[method_id] = filter.get('filtered', 0)
      for method in catalog_method_filter_list:
        property = method[8:-8]
        if property in filter:
          getattr(self, method)[method_id] = filter[property]
2298

2299 2300 2301 2302 2303
  def generateXml(self, path):
    obj = self._objects[path]
    method_id = obj.id
    xml_data = '<catalog_method>'
    if self._method_properties.has_key(method_id):
2304
      for method_property, value in self._method_properties[method_id].items():
2305 2306 2307
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2308

2309
      if self._is_filtered_archive.get(method_id):
2310 2311 2312
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2313 2314
          for method in catalog_method_filter_list:
            if method != '_filter_expression_instance_archive':
2315 2316
              value = getattr(self, method, {}).get(method_id)
              if isinstance(value, basestring):
2317 2318 2319
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2320
              elif value:
2321
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2322
                for item in value:
2323 2324
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2325
    xml_data += '\n</catalog_method>\n'
Christophe Dumez's avatar
Christophe Dumez committed
2326
    return xml_data
2327

2328 2329 2330
  def preinstall(self, context, installed_item, **kw):
    modified_object_dict = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
    modified_object_dict.update(BaseTemplateItem.preinstall(self, context, installed_item, **kw))
2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356
    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)

2357 2358
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2359
    catalog = _getCatalogValue(self)
2360 2361 2362 2363 2364 2365 2366
    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)
2367

2368 2369 2370
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2371
    new_bt_format = context.getTemplateFormatVersion()
2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387

    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':
2388
              continue
2389 2390 2391 2392
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2393

2394 2395
    for obj in values:
      method_id = obj.id
2396

2397 2398 2399 2400 2401 2402
      # Restore catalog properties for methods
      if hasattr(self, '_method_properties'):
        for key in self._method_properties.get(method_id, {}).keys():
          old_value = getattr(catalog, key, None)
          if isinstance(old_value, str):
            setattr(catalog, key, method_id)
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2403
          elif isinstance(old_value, (list, tuple)):
2404 2405 2406 2407
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2408

2409 2410
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2411
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2412
        if context.getTemplateFormatVersion() == 1:
2413 2414 2415 2416 2417
          if expression and expression.strip():
            # only compile non-empty expressions
            expr_instance = Expression(expression)
          else:
            expr_instance = None
2418 2419
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2420 2421 2422
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2423
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2424 2425 2426 2427
        catalog.filter_dict[method_id]['expression_cache_key'] = \
          self._filter_expression_cache_key_archive.get(method_id, ())
        catalog.filter_dict[method_id]['type'] = \
          self._filter_type_archive.get(method_id, ())
2428
      elif method_id in catalog.filter_dict.keys():
2429
        catalog.filter_dict[method_id]['filtered'] = 0
2430

2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456
      # 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)
2457

2458 2459 2460 2461 2462 2463
        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)
2464

2465
  def uninstall(self, context, **kw):
2466
    catalog = _getCatalogValue(self)
2467 2468 2469
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2470

2471 2472 2473 2474
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2475 2476 2477 2478
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2479
    else:
2480
      try:
2481 2482 2483 2484
        if context.getTemplateFormatVersion() == 1:
          value = self._objects[object_path]
        else:
          value = self._archive[object_path]
2485 2486
      except KeyError:
        value = None
2487 2488
      if value is not None:
        values.append(value)
2489
    for obj in values:
2490
      method_id = obj.id
2491 2492 2493 2494 2495 2496 2497 2498 2499
      # 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)
2500

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2501
      if catalog.filter_dict.has_key(method_id):
2502
        del catalog.filter_dict[method_id]
2503

2504
    # uninstall objects
2505
    ObjectTemplateItem.uninstall(self, context, **kw)
2506

2507
  def _importFile(self, file_name, file):
2508
    if file_name.endswith('.catalog_keys.xml'):
2509
      # recreate data mapping specific to catalog method
2510 2511
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2512
      xml = parse(file)
2513
      method_list = xml.findall('item')
2514
      for method in method_list:
2515 2516 2517
        key = method.get('key')
        key_type = method.get('type')
        value_node = method.find('value')
2518
        if key_type == "str":
2519
          value = value_node.text or ''
2520
        elif key_type == "int":
2521
          value = int(value_node.text)
2522
        elif key_type == "tuple":
2523
          value = tuple([value_node.text for value_node in method.findall('value')])
2524
        else:
2525
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2526
          continue
2527
        if key in catalog_method_list or key in catalog_method_filter_list:
2528
          getattr(self, key)[id] = value
2529 2530 2531
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543
    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, ))
2544

2545
class ActionTemplateItem(ObjectTemplateItem):
2546 2547

  def __init__(self, id_list, **kw):
2548
    # XXX It's look like ObjectTemplateItem __init__
2549 2550 2551 2552 2553 2554
    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

2555 2556
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2557
      Split path tries to split a complex path such as:
2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575

      "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

2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608
  def _getPortalTypeActionCopy(self, obj, value):
    id_id = 'reference'
    for action in obj.getActionInformationList():
      if getattr(action, id_id, None) == value:
        return obj._exportOldAction(action)

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

  def _getActionCopy(self, obj, context, value):
    """
    Gets action copy from action provider given the action id or reference
    """
    # Several tools still use CMF actions
2609
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2610 2611 2612 2613
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2614 2615 2616 2617
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2618 2619 2620
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2621 2622
      # normalize url
      url = obj.getPhysicalPath()[-2:]
2623 2624
      action = self._getActionCopy(obj, context, value)
      if action is None:
2625 2626 2627
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2628
      key = posixpath.join(url[-2], url[-1], value)
2629
      self._objects[key] = self.removeProperties(action)
2630
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2631

2632 2633 2634
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2635
    if context.getTemplateFormatVersion() == 1:
2636
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2637 2638
      p = context.getPortalObject()
      for id in self._objects.keys():
2639 2640 2641 2642 2643
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2644 2645 2646
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2647

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

Julien Muchembled's avatar
Julien Muchembled committed
2654 2655
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2656 2657 2658
          try:
            from Products.CMFCore.interfaces import IActionProvider
          except ImportError:
2659
              # BACK:
2660 2661 2662 2663 2664 2665 2666 2667
              # 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,
2668
                  'Redirected action import',
2669 2670 2671 2672
                  '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
2673
          obj, action = container, obj
2674
          action_list = obj.listActions()
2675
          for index in range(len(action_list)):
2676
            if action_list[index].id == id:
2677
              # remove previous action
2678
              obj.deleteActions(selections=(index,))
2679 2680 2681
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2682
          obj.addAction(
2683 2684
                        id = action.id
                      , name = action.title
2685
                      , action = action_text
2686 2687 2688 2689
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2690 2691
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2692
                      , priority = action.priority
2693
                      , description = action.description
Aurel's avatar
Aurel committed
2694
                    )
2695
          # sort action based on the priority define on it
2696 2697 2698 2699 2700 2701 2702 2703 2704
          # 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))
2705 2706
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2707
        container.manage_delObjects([obj.id
2708
          for obj in container.getActionInformationList()
2709
          if obj.getReference() in action_dict])
2710 2711
        for obj in action_dict.itervalues():
          container._importOldAction(obj)
Aurel's avatar
Aurel committed
2712
    else:
2713
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2714
      p = context.getPortalObject()
2715 2716
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2717
        relative_url, key, value = self._splitPath(id)
2718 2719
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2720
          if getattr(ai, key) == value:
2721
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2722 2723 2724
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2725
        obj.addAction(
Aurel's avatar
Aurel committed
2726 2727
                      id = action.id
                    , name = action.title
2728
                    , action = action_text
Aurel's avatar
Aurel committed
2729 2730 2731 2732
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2733 2734
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2735
                    )
Aurel's avatar
Aurel committed
2736 2737 2738 2739 2740 2741 2742
        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))
2743 2744
          obj.moveDownActions(selections=tuple(move_down_list))

2745 2746
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2747 2748
    object_path = kw.get("object_path", None)
    if object_path is not None:
2749 2750 2751 2752 2753 2754 2755 2756
      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]
2757
    else:
2758
      keys = self._archive.keys()
2759
    for id in keys:
2760 2761
      if  '|' in id:
        relative_url, value = id.split(' | ')
2762 2763 2764
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
2765
          is_new_action = interfaces.ITypeProvider.providedBy(obj.getParentValue())
2766
          key = is_new_action and 'reference' or 'id'
2767
      else:
2768
        relative_url, key, value = self._splitPath(id)
2769
        obj = p.unrestrictedTraverse(relative_url, None)
2770 2771 2772
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2773
          if getattr(action_list[index], key, None) == value:
2774 2775
            obj.deleteActions(selections=(index,))
            break
2776 2777
      LOG('BusinessTemplate', WARNING,
          'Unable to uninstall action at %s, ignoring' % relative_url )
2778 2779
    BaseTemplateItem.uninstall(self, context, **kw)

2780 2781 2782
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2783
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2784 2785 2786 2787 2788 2789 2790
    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])
2791 2792
      # normalize url
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])
2793
      self._objects[relative_url] = type_role_list = []
2794
      for role in obj.getRoleInformationList():
2795
        type_role_dict = {}
2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812
        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
2813
        type_role_list.append(type_role_dict)
2814
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2815

Christophe Dumez's avatar
Christophe Dumez committed
2816
  # Function to generate XML Code Manually
2817 2818 2819 2820
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2821
      xml_data += "\n  <role id='%s'>" % role['id']
2822
      # uniq
2823
      for property in ('title', 'description', 'condition',
2824 2825 2826
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2827 2828
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2829
          xml_data += "\n   <property id='%s'>%s</property>" % \
2830 2831 2832
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2833
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2834 2835
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2836
          xml_data += "\n   <multi_property "\
2837
          "id='%s'>%s</multi_property>" % (property, prop_value)
2838 2839
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2840
    return xml_data
2841

2842 2843 2844 2845 2846 2847 2848
  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)
2849 2850
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2851 2852 2853 2854
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
2855 2856 2857
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2858 2859
    type_roles_list = []
    xml = parse(file)
2860
    xml_type_roles_list = xml.findall('role')
2861
    for role in xml_type_roles_list:
2862 2863 2864 2865
      id = role.get('id')
      if isinstance(id, unicode):
        id = id.encode('utf_8', 'backslashreplace')
      type_role_property_dict = {'id': id}
2866
      # uniq
2867 2868 2869 2870 2871 2872 2873 2874
      property_list = role.findall('property')
      for property_node in property_list:
        property_id = property_node.get('id')
        if property_node.text:
          value = property_node.text
          if isinstance(value, unicode):
            value = value.encode('utf_8', 'backslashreplace')
          type_role_property_dict[property_id] = value
2875
      # multi
2876 2877 2878 2879 2880 2881 2882 2883
      multi_property_list = role.findall('multi_property')
      for property_node in multi_property_list:
        property_id = property_node.get('id')
        if property_node.text:
          value = property_node.text
          if isinstance(value, unicode):
            value = value.encode('utf_8', 'backslashreplace')
          type_role_property_dict.setdefault(property_id, []).append(value)
2884
      type_roles_list.append(type_role_property_dict)
2885
    self._objects['portal_type_roles/%s' % (file_name[:-4],)] = type_roles_list
2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896

  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
2897 2898 2899
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
2900
          # reset roles before applying
2901
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
2902
          type_roles_list = self._objects[roles_path] or []
2903 2904
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
2905 2906 2907
        else:
          raise AttributeError("Path '%r' not found while "
                               "installing roles" % (path, ))
2908 2909 2910

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2911 2912 2913 2914 2915 2916
    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:
2917
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2918 2919 2920 2921 2922
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2923

2924 2925 2926 2927 2928 2929
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2930 2931
      for property in p.propertyMap():
        if property['id'] == id:
2932
          obj = p.getProperty(id)
2933
          prop_type = property['type']
2934 2935
          break
      else:
2936
        obj = None
2937
      if obj is None and not self.is_bt_for_diff:
2938
        raise NotFound, 'the property %s is not found' % id
2939
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2940

2941 2942
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
2943
    if not file_name.endswith('.xml'):
2944
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2945
      return
2946
    xml = parse(file)
2947 2948 2949 2950 2951 2952 2953 2954 2955
    property_node = xml.getroot()[0]
    property_id = property_node.find('id').text
    prop_type = property_node.find('type').text
    value_node = property_node.find('value')
    if prop_type in ('lines', 'tokens'):
      value = [item.text for item in value_node.findall('item')]
    else:
      value = value_node.text
    self._objects[property_id] = (prop_type, value)
2956

2957 2958 2959
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2960
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2961 2962
      p = context.getPortalObject()
      for path in self._objects.keys():
2963 2964 2965 2966
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2967
              continue
2968
          dir, id = posixpath.split(path)
2969
          prop_type, property = self._objects[path]
2970 2971 2972 2973 2974 2975 2976 2977
          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
2978
    else:
2979
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2980
      p = context.getPortalObject()
2981
      for id, property in self._archive.keys():
2982
        property = self._archive[id]
Aurel's avatar
Aurel committed
2983
        if p.hasProperty(id):
2984 2985 2986 2987 2988 2989 2990
          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'])
2991 2992 2993

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2994 2995 2996 2997 2998 2999
    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:
3000 3001 3002 3003
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3004
  # Function to generate XML Code Manually
3005
  def generateXml(self, path=None):
3006
    xml_data = ''
3007
    prop_type, obj = self._objects[path]
3008
    xml_data += '\n <property>'
3009 3010
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
3011
    if prop_type in ('lines', 'tokens'):
3012
      xml_data += '\n  <value>'
3013
      for item in obj:
3014
        if item != '':
3015
          xml_data += '\n   <item>%s</item>' % escape(str(item))
3016
      xml_data += '\n  </value>'
3017
    else:
3018
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
3019
    xml_data += '\n </property>'
3020 3021
    return xml_data

Aurel's avatar
Aurel committed
3022 3023 3024 3025 3026
  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)
3027 3028 3029 3030
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
3031
      xml_data += self.generateXml(path)
3032
    xml_data += '\n</site_property>'
3033
    bta.addObject(obj=xml_data, name='properties', path=root_path)
3034

3035 3036 3037 3038 3039
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3040 3041 3042 3043 3044 3045
    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()
3046
      permission_list = []
3047
      mapping['permission_list'] = module.showPermissions()
3048
      mapping['category_list'] = module.getCategoryList()
3049
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3050

Christophe Dumez's avatar
Christophe Dumez committed
3051
  # Function to generate XML Code Manually
3052
  def generateXml(self, path=None):
3053
    mapping = self._objects[path]
3054
    xml_data = ['<module>']
3055
    keys = mapping.keys()
3056 3057
    for key in sorted(keys):
      if key == 'permission_list':
3058
        # separe permission dict into xml
3059
        xml_data.append(' <%s>' % (key, ))
3060
        permission_list = mapping[key]
3061
        for perm in permission_list:
3062
          # the type of the permission defined if we use acquired or not
3063
          if isinstance(perm[1], list):
3064 3065 3066
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
3067
          role_list = list(perm[1])
3068 3069 3070
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
3071
          if (len(role_list) == 0 and ptype == 'list') or \
3072 3073
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
3074
          role_list.sort()
3075 3076
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
3077
          for role in role_list:
3078 3079 3080
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
3081 3082 3083 3084 3085 3086 3087 3088
      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, ))
3089
      else:
3090
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
3091 3092
    xml_data.append('</module>')
    return '\n'.join(xml_data)
3093

3094
  def export(self, context, bta, **kw):
3095
    if len(self._objects) == 0:
3096 3097 3098
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
3099 3100
    keys = self._objects.keys()
    keys.sort()
3101
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
3102
      # export modules one by one
3103 3104
      xml_data = self.generateXml(path=key)
      bta.addObject(obj=xml_data, name=key, path=path)
3105

3106
  def install(self, context, trashbin, **kw):
3107
    portal = context.getPortalObject()
3108 3109
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3110
    if context.getTemplateFormatVersion() == 1:
3111
      items = self._objects
3112
    else:
3113 3114
      items = self._archive

3115 3116
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
3117 3118
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
3119
        if not force:
3120
          action = update_dict[path]
3121 3122
          if action == 'nothing':
            continue
3123 3124
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
3125
        module = portal._getOb(module_id, None)
3126 3127
        if module is not None:
          module.portal_type = portal_type
3128
        else:
3129
          module = portal.newContent(id=module_id, portal_type=portal_type)
3130
        module.setTitle(str(mapping['title']))
3131 3132
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
3133
          # By default, Manager only without acquire permission
3134 3135
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
3136
          module.manage_permission(name, roles=role_list, acquire=acquire)
3137 3138
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
3139 3140

  def _importFile(self, file_name, file):
3141 3142 3143
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3144
    mapping = {}
3145
    xml = parse(file)
3146
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3147
      key_node = xml.find(key)
3148
      if key == 'permission_list':
3149 3150 3151 3152 3153 3154 3155
        permission_list = []
        for permission in key_node:
          permission_type = permission.get('type', None)
          name = permission.find('name').text
          role_list = [role.text for role in permission.findall('role')]
          if permission_type in ('list', None):
            perm_tuple = (name, list(role_list))
3156
          else:
3157 3158 3159
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3160
      else:
3161
        mapping[key] = key_node.text or ''
3162 3163

    category_list = []
3164 3165 3166 3167
    category_list_node = xml.find('category_list')
    if category_list_node is not None:
      category_list.extend(node.text for node\
                            in category_list_node.findall('category'))
3168 3169
    mapping['category_list'] = category_list

3170
    self._objects[file_name[:-4]] = mapping
3171

3172
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3173 3174 3175
    trash = kw.get('trash', 0)
    if trash:
      return
3176 3177 3178 3179 3180 3181
    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]
3182 3183
    p = context.getPortalObject()
    id_list = p.objectIds()
3184 3185
    for key in keys:
      if key in id_list:
3186
        try:
3187
          if trash and trashbin is not None:
3188
            container_path = key.split('/')
3189 3190
            self.portal_trash.backupObject(trashbin, container_path, 
                                           key, save=1, keep_subobjects=1)
3191
          p.manage_delObjects([key])
3192
        except NotFound:
3193
          pass
3194 3195
    BaseTemplateItem.uninstall(self, context, **kw)

3196 3197 3198
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3199 3200

class DocumentTemplateItem(BaseTemplateItem):
3201 3202 3203 3204
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3205 3206 3207

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

3211
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3212 3213
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3214
      new_keys = self._objects.keys()
3215
      # fix key if necessary in installed bt for diff
3216
      extra_prefix = self.__class__.__name__ + '/'
3217
      for key in installed_item._objects.keys():
3218 3219 3220 3221
        if key.startswith(extra_prefix):
          new_key = key[len(extra_prefix):]
          installed_item._objects[new_key] = installed_item._objects[key]
          del installed_item._objects[key]
3222
      for path in new_keys:
3223
        if installed_item._objects.has_key(path):
3224 3225
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3226
          old_obj_code = installed_item._objects[path]
3227
          if new_obj_code != old_obj_code:
3228 3229
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3230
        else: # new object
3231 3232
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3233
          # get removed object
3234
      old_keys = installed_item._objects.keys()
3235 3236
      for path in old_keys:
        if path not in new_keys:
3237 3238
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3239 3240 3241 3242 3243
    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
3244
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3245
      for id in self._objects.keys():
3246 3247 3248 3249 3250 3251
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
3252
          path, name = posixpath.split(id)
3253 3254
          # This raises an exception if the file already exists.
          try:
3255
            self.local_file_writer_name(name, text, create=0)
3256
          except IOError, error:
3257
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
3258
            if error.errno:
3259
              raise
3260 3261
            continue
          if self.local_file_importer_name is not None:
3262
            self.local_file_importer_name(name)
3263 3264 3265 3266 3267 3268 3269 3270 3271 3272
            # after any import, flush all ZODB caches to force a DB reload
            # otherwise we could have objects trying to get commited while
            # holding reference to a class that is no longer the same one as
            # the class in its import location and pickle doesn't tolerate it.
            # First we do a savepoint to dump dirty objects to temporary
            # storage, so that all references to them can be freed.
            transaction.savepoint(optimistic=True)
            # Then we need to flush from all caches, not only the one from this
            # connection
            self.getPortalObject()._p_jar.db().cacheMinimize()
Aurel's avatar
Aurel committed
3273
    else:
3274 3275 3276
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3277
        # This raises an exception if the file exists.
3278
        self.local_file_writer_name(id, text, create=1)
Aurel's avatar
Aurel committed
3279
        if self.local_file_importer_name is not None:
3280
          self.local_file_importer_name(id)
3281 3282

  def uninstall(self, context, **kw):
3283
    object_path = kw.get('object_path', None)
3284 3285 3286 3287
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
3288 3289
    for key in object_keys:
      self.local_file_remover_name(key)
3290 3291
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3292 3293 3294 3295 3296
  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)
3297 3298 3299 3300 3301 3302 3303
    extra_prefix = self.__class__.__name__ + '/'
    for key in self._objects.keys():
      obj = self._objects[key]
      # BBB the prefix was put into each key in the previous implementation.
      if not key.startswith(extra_prefix):
        key = extra_prefix + key
      bta.addObject(obj=obj, name=key, ext='.py')
Aurel's avatar
Aurel committed
3304

3305
  def _importFile(self, file_name, file):
3306 3307 3308
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3309
    text = file.read()
3310
    self._objects[file_name[:-3]] = text
3311

3312
class PropertySheetTemplateItem(DocumentTemplateItem):
3313 3314 3315 3316
  local_file_reader_name = staticmethod(readLocalPropertySheet)
  local_file_writer_name = staticmethod(writeLocalPropertySheet)
  local_file_importer_name = staticmethod(importLocalPropertySheet)
  local_file_remover_name = staticmethod(removeLocalPropertySheet)
3317

3318
class ConstraintTemplateItem(DocumentTemplateItem):
3319 3320 3321 3322
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3323

3324
class ExtensionTemplateItem(DocumentTemplateItem):
3325 3326
  local_file_reader_name = staticmethod(readLocalExtension)
  local_file_writer_name = staticmethod(writeLocalExtension)
3327 3328
  # Extension needs no import
  local_file_importer_name = None
3329
  local_file_remover_name = staticmethod(removeLocalExtension)
3330 3331

class TestTemplateItem(DocumentTemplateItem):
3332 3333
  local_file_reader_name = staticmethod(readLocalTest)
  local_file_writer_name = staticmethod(writeLocalTest)
3334
  # Test needs no import
3335
  local_file_importer_name = None
3336
  local_file_remover_name = staticmethod(removeLocalTest)
3337

Aurel's avatar
Aurel committed
3338

3339 3340 3341
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3342 3343 3344

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3345
  def build(self, context, **kw):
3346 3347
    for key in self._archive.iterkeys():
      self._objects[key] = 1
Aurel's avatar
Aurel committed
3348

3349
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3350 3351
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3352
      new_roles = self._objects.keys()
3353 3354 3355 3356 3357 3358
      # BBB it might be necessary to change the data structure.
      obsolete_key = self.__class__.__name__ + '/role_list'
      if obsolete_key in installed_item._objects:
        for role in installed_item._objects[obsolete_key]:
          installed_item._objects[role] = 1
        del installed_item._objects[obsolete_key]
3359
      for role in new_roles:
3360
        if installed_item._objects.has_key(role):
3361 3362 3363 3364
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
3365
      old_roles = installed_item._objects.keys()
3366 3367 3368 3369 3370 3371
      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):
3372
    p = context.getPortalObject()
3373
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3374
    if context.getTemplateFormatVersion() == 1:
3375
      role_set = set(self._objects)
3376
    else:
3377
      role_set = set(self._archive)
3378 3379 3380 3381
    # 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:
3382 3383
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
3384
    # set roles on portal
3385
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
3386 3387

  def _importFile(self, file_name, file):
3388
    if not file_name.endswith('.xml'):
3389
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3390
      return
3391
    xml = parse(file)
3392 3393 3394
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406

  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)

3407 3408 3409 3410 3411 3412 3413 3414 3415
  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
3416
      if role in roles and role not in new_roles:
3417 3418 3419
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3420
  # Function to generate XML Code Manually
3421 3422
  def generateXml(self):
    role_list = self._objects.keys()
3423
    xml_data = '<role_list>'
3424 3425
    for role in sorted(role_list):
      xml_data += '\n <role>%s</role>' % (role,)
3426
    xml_data += '\n</role_list>'
3427 3428
    return xml_data

Aurel's avatar
Aurel committed
3429
  def export(self, context, bta, **kw):
3430
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
3431 3432 3433
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
3434 3435 3436 3437 3438 3439 3440 3441 3442
    # BBB it might be necessary to change the data structure.
    obsolete_key = self.__class__.__name__ + '/role_list'
    if obsolete_key in self._objects:
      for role in self._objects[obsolete_key]:
        self._objects[role] = 1
      del self._objects[obsolete_key]
    xml_data = self.generateXml()
    path = obsolete_key
    bta.addObject(obj=xml_data, name=path)
3443

3444 3445
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3446
  def build(self, context, **kw):
3447
    catalog = _getCatalogValue(self)
3448 3449 3450
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3451
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3452
    key_list = []
3453
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3454
      if key in sql_search_result_keys:
3455
        key_list.append(key)
3456
      elif not self.is_bt_for_diff:
3457
        raise NotFound, 'Result key "%r" not found in catalog' %(key,)
3458
    if len(key_list) > 0:
3459
      self._objects[self.__class__.__name__+'/'+'result_key_list'] = key_list
3460 3461

  def _importFile(self, file_name, file):
3462 3463 3464
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3465
    xml = parse(file)
3466 3467
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3468

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

3475
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3476
    if context.getTemplateFormatVersion() == 1:
3477 3478
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3479 3480 3481
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3482
    else:
3483
      keys = self._archive.keys()
3484 3485
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3486
    # XXX same as related key
Aurel's avatar
Aurel committed
3487
    if update_dict.has_key('result_key_list') or force:
3488
      if not force:
Aurel's avatar
Aurel committed
3489
        action = update_dict['result_key_list']
3490
        if action == 'nothing':
Aurel's avatar
Aurel committed
3491
          return
3492
      for key in keys:
3493 3494
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
3495
      catalog.sql_search_result_keys = sql_search_result_keys
3496

3497
  def uninstall(self, context, **kw):
3498
    catalog = _getCatalogValue(self)
3499 3500 3501 3502
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3503
    object_path = kw.get('object_path', None)
3504 3505 3506 3507 3508
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3509 3510
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
3511
    catalog.sql_search_result_keys = sql_search_result_keys
3512 3513
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3514
  # Function to generate XML Code Manually
3515
  def generateXml(self, path=None):
3516
    obj = self._objects[path]
3517
    xml_data = '<key_list>'
3518 3519
    obj.sort()
    for key in obj:
3520 3521
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3522 3523
    return xml_data

Aurel's avatar
Aurel committed
3524 3525 3526 3527 3528
  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)
3529
    for path in self._objects.keys():
3530
      xml_data = self.generateXml(path=path)
3531
      bta.addObject(obj=xml_data, name=path, path=None)
3532

3533 3534
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3535
  def build(self, context, **kw):
3536
    catalog = _getCatalogValue(self)
3537 3538 3539
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3540
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
3541
    key_list = []
3542
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3543
      if key in sql_search_related_keys:
3544
        key_list.append(key)
3545
      elif not self.is_bt_for_diff:
3546
        raise NotFound, 'Related key "%r" not found in catalog' %(key,)
3547
    if len(key_list) > 0:
3548
      self._objects[self.__class__.__name__+'/'+'related_key_list'] = key_list
3549 3550

  def _importFile(self, file_name, file):
3551 3552 3553
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3554
    xml = parse(file)
3555 3556
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3557

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

3564
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3565
    if context.getTemplateFormatVersion() == 1:
3566
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3567
        return
3568 3569 3570
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3571
    else:
3572
      keys = self._archive.keys()
3573 3574
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3575
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
3576
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3577
      if not force:
Aurel's avatar
Aurel committed
3578 3579 3580 3581
        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
3582 3583 3584
        if action == 'nothing':
          return
      for key in keys:
3585 3586
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
3587
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
3588

3589
  def uninstall(self, context, **kw):
3590
    catalog = _getCatalogValue(self)
3591 3592 3593
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3594
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
3595
    object_path = kw.get('object_path', None)
3596 3597 3598 3599 3600
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3601 3602 3603 3604 3605
      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
3606
  # Function to generate XML Code Manually
3607
  def generateXml(self, path=None):
3608
    obj = self._objects[path]
3609
    xml_data = '<key_list>'
3610 3611
    obj.sort()
    for key in obj:
3612 3613
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3614 3615
    return xml_data

Aurel's avatar
Aurel committed
3616 3617 3618 3619 3620 3621
  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():
3622
      xml_data = self.generateXml(path=path)
3623
      bta.addObject(obj=xml_data, name=path, path=None)
3624

3625 3626
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3627
  def build(self, context, **kw):
3628
    catalog = _getCatalogValue(self)
3629 3630 3631
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3632
    sql_search_result_tables = list(catalog.sql_search_tables)
3633
    key_list = []
3634
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3635
      if key in sql_search_result_tables:
3636
        key_list.append(key)
3637
      elif not self.is_bt_for_diff:
3638
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
3639
    if len(key_list) > 0:
3640
      self._objects[self.__class__.__name__+'/'+'result_table_list'] = key_list
3641 3642

  def _importFile(self, file_name, file):
3643 3644 3645
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3646
    xml = parse(file)
3647 3648
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
Aurel's avatar
Aurel committed
3649

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

3656
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3657
    if context.getTemplateFormatVersion() == 1:
3658
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3659
        return
3660 3661 3662
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3663
    else:
3664
      keys = self._archive.keys()
3665 3666
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3667
    # XXX same as related keys
Aurel's avatar
Aurel committed
3668
    if update_dict.has_key('result_table_list') or force:
3669
      if not force:
Aurel's avatar
Aurel committed
3670
        action = update_dict['result_table_list']
3671
        if action == 'nothing':
Aurel's avatar
Aurel committed
3672
          return
3673
      for key in keys:
3674 3675
        if key not in sql_search_tables:
          sql_search_tables.append(key)
3676
      catalog.sql_search_tables = tuple(sql_search_tables)
3677 3678

  def uninstall(self, context, **kw):
3679
    catalog = _getCatalogValue(self)
3680 3681 3682 3683
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
3684
    object_path = kw.get('object_path', None)
3685 3686 3687 3688 3689
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3690 3691
      if key in sql_search_tables:
        sql_search_tables.remove(key)
3692
    catalog.sql_search_tables = sql_search_tables
3693 3694
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3695
  # Function to generate XML Code Manually
3696
  def generateXml(self, path=None):
3697
    obj = self._objects[path]
3698
    xml_data = '<key_list>'
3699 3700
    obj.sort()
    for key in obj:
3701 3702
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3703 3704
    return xml_data

Aurel's avatar
Aurel committed
3705 3706 3707 3708 3709 3710
  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():
3711
      xml_data = self.generateXml(path=path)
3712
      bta.addObject(obj=xml_data, name=path, path=None)
3713

3714 3715
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3716 3717

  def build(self, context, **kw):
3718
    catalog = _getCatalogValue(self)
3719 3720 3721 3722 3723 3724 3725 3726
    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)
3727
      elif not self.is_bt_for_diff:
3728
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3729
    if len(key_list) > 0:
3730
      self._objects[self.__class__.__name__+'/'+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3731

3732
  def _importFile(self, file_name, file):
3733 3734 3735
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3736
    xml = parse(file)
3737 3738
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3739 3740

  def install(self, context, trashbin, **kw):
3741
    catalog = _getCatalogValue(self)
3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754
    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()
3755 3756
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768
    # 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):
3769
    catalog = _getCatalogValue(self)
3770 3771 3772 3773
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3774
    object_path = kw.get('object_path', None)
3775 3776
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3777
    else:
3778 3779 3780 3781 3782 3783 3784
      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
3785
  # Function to generate XML Code Manually
3786 3787 3788 3789 3790
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3791 3792
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3793
    return xml_data
Aurel's avatar
Aurel committed
3794 3795 3796 3797

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3798 3799 3800 3801 3802
    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)
3803

3804 3805 3806 3807 3808 3809 3810 3811
# 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
3812
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3813 3814 3815 3816
    key_list = []
    for key in self._archive.keys():
      if key in sql_datetime_keys:
        key_list.append(key)
3817
      elif not self.is_bt_for_diff:
3818 3819 3820 3821 3822
        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):
3823 3824 3825
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3826
    xml = parse(file)
3827 3828
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3829 3830 3831 3832 3833 3834 3835

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

3836
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862
    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
3863
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893
    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)      
      
3894 3895
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3896

3897
  def build(self, context, **kw):
3898
    catalog = _getCatalogValue(self)
3899 3900 3901 3902 3903 3904 3905 3906
    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)
3907
      elif not self.is_bt_for_diff:
3908
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
3909
    if len(key_list) > 0:
3910
      self._objects[self.__class__.__name__+'/'+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3911

3912
  def _importFile(self, file_name, file):
3913 3914 3915
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3916
    xml = parse(file)
3917 3918
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3919

3920
  def install(self, context, trashbin, **kw):
3921
    catalog = _getCatalogValue(self)
3922 3923 3924
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3925

3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946
    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
3947

3948
  def uninstall(self, context, **kw):
3949
    catalog = _getCatalogValue(self)
3950 3951 3952 3953
    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)
3954
    object_path = kw.get('object_path', None)
3955 3956 3957 3958 3959 3960 3961 3962 3963 3964
    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
3965
  # Function to generate XML Code Manually
3966 3967 3968 3969 3970
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3971 3972
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988
    return xml_data

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


# request
class CatalogRequestKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
3989
    catalog = _getCatalogValue(self)
3990 3991 3992 3993 3994 3995 3996 3997
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_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)
3998
      elif not self.is_bt_for_diff:
3999
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
4000
    if len(key_list) > 0:
4001
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
4002 4003

  def _importFile(self, file_name, file):
4004 4005 4006
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4007
    xml = parse(file)
4008 4009
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4010 4011

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

  def _importFile(self, file_name, file):
4094 4095 4096
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4097
    xml = parse(file)
4098 4099
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4100 4101

  def install(self, context, trashbin, **kw):
4102
    catalog = _getCatalogValue(self)
4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128
    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):
4129
    catalog = _getCatalogValue(self)
4130 4131 4132 4133
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
4134
    object_path = kw.get('object_path', None)
4135 4136 4137 4138 4139 4140 4141 4142 4143 4144
    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
4145
  # Function to generate XML Code Manually
4146 4147 4148 4149 4150
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4151 4152
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167
    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):
4168
    catalog = _getCatalogValue(self)
4169 4170 4171 4172 4173 4174 4175 4176
    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)
4177
      elif not self.is_bt_for_diff:
4178
        raise NotFound, 'Topic key "%r" not found in catalog' %(key,)
4179
    if len(key_list) > 0:
4180
      self._objects[self.__class__.__name__+'/'+'topic_key_list'] = key_list
4181 4182

  def _importFile(self, file_name, file):
4183 4184 4185
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4186
    xml = parse(file)
4187 4188
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4189 4190

  def install(self, context, trashbin, **kw):
4191
    catalog = _getCatalogValue(self)
4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218
    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):
4219
    catalog = _getCatalogValue(self)
4220 4221 4222 4223
    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)
4224
    object_path = kw.get('object_path', None)
4225 4226 4227 4228 4229 4230 4231 4232 4233 4234
    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
4235
  # Function to generate XML Code Manually
4236 4237 4238 4239 4240
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4241 4242
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253
    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)

4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265
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)
4266
      elif not self.is_bt_for_diff:
4267 4268 4269 4270 4271
        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):
4272 4273 4274
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4275
    xml = parse(file)
4276 4277
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343

  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)

4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356
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)
4357
      elif not self.is_bt_for_diff:
4358 4359 4360 4361 4362
        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):
4363 4364 4365
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4366
    xml = parse(file)
4367 4368
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447

  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)
4448
      elif not self.is_bt_for_diff:
4449 4450 4451 4452 4453
        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):
4454 4455 4456
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4457
    xml = parse(file)
4458 4459
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525

  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)

4526 4527 4528 4529
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4530 4531 4532
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4533
      else: # XXX backward compatibility
4534 4535
        lang = lang_key
        catalog = 'erp5_ui'
4536
      path = posixpath.join(lang, catalog)
4537 4538
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4539 4540 4541
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4542

4543
  def preinstall(self, context, installed_item, **kw):
4544 4545 4546 4547
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
4548
        if installed_item._objects.has_key(path):
4549 4550
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
4551
          old_obj_code = installed_item._objects[path]
4552 4553 4554 4555 4556
          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
4557
      old_keys = installed_item._objects.keys()
4558 4559 4560 4561 4562
      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

4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590
  def _splitKey(self,key):
    path = key.split('/')
    if len(path) == 1:
      lang = path[0]
      catalog = None
    elif len(path) == 2:
      lang = path[0]
      catalog = path[1]
    else:
      lang = path[-3]
      catalog = path[-2]
    return lang, catalog

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

  def install(self, context, trashbin, localizer=None, **kw):
    if localizer is None:
      localizer = context.getPortalObject().Localizer
    update_dict = kw.get('object_to_update', {})
4591 4592
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
4593 4594
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4595
          if not force:
4596
            action = update_dict[key]
4597
            if action == 'nothing':
4598
              continue
4599
          lang, catalog = self._splitKey(key)
4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615

          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)
4616 4617
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4618 4619 4620 4621
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4622
            self._importCatalogLanguage(localizer, catalog, lang, po)
4623 4624
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4625
      for lang, catalogs in self._archive.iteritems():
4626 4627 4628
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658
          self._importCatalogLanguage(catalog, lang, po)

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

  def export(self, context, bta, **kw):
4661
    if len(self._objects) == 0:
4662 4663 4664
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
4665
    for key, obj in self._objects.iteritems():
4666 4667
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
4668 4669 4670 4671 4672 4673 4674 4675
      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'))
4676 4677

  def _importFile(self, file_name, file):
4678 4679
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4680 4681
      text = file.read()
      self._objects[file_name[:-3]] = text
4682 4683
    elif name == 'language.xml':
      xml = parse(file)
4684 4685
      name = xml.find('name').text
      code = xml.find('code').text
4686
      self._objects[code] = name
4687

Aurel's avatar
Aurel committed
4688 4689
class LocalRolesTemplateItem(BaseTemplateItem):

4690
  def __init__(self, id_list, **kw):
4691
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4692 4693
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4694 4695 4696
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4697
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4698 4699
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4700
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4701

Christophe Dumez's avatar
Christophe Dumez committed
4702
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4703
  def generateXml(self, path=None):
4704
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4705 4706
    # local roles
    xml_data = '<local_roles_item>'
4707
    xml_data += '\n <local_roles>'
4708
    for key in sorted(local_roles_dict):
4709
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4710 4711
      tuple = local_roles_dict[key]
      for item in tuple:
4712 4713 4714 4715
        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
4716
    return xml_data
4717

Aurel's avatar
Aurel committed
4718 4719 4720 4721 4722 4723 4724 4725
  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)

4726
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4727
      encode_folders = []
4728
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4729
        if '%' not in folder:
4730
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4731 4732
        else:
          encode_folders.append(folder)
4733
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4734 4735 4736 4737
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
4738 4739 4740
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4741 4742
    xml = parse(file)
    # local roles
4743
    local_roles_list = xml.findall('//role')
Aurel's avatar
Aurel committed
4744 4745
    local_roles_dict = {}
    for role in local_roles_list:
4746 4747
      id = role.get('id')
      item_type_list = [item.text for item in role]
Aurel's avatar
Aurel committed
4748
      local_roles_dict[id] = item_type_list
4749
    self._objects['local_roles/%s' % (file_name[:-4],)] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760

  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
4761 4762
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4763
        local_roles_dict = self._objects[roles_path][0]
4764
        setattr(obj, '__ac_local_roles__', local_roles_dict)
4765
        obj.reindexObject()
Aurel's avatar
Aurel committed
4766

4767
  def uninstall(self, context, object_path=None, **kw):
Aurel's avatar
Aurel committed
4768
    p = context.getPortalObject()
4769 4770 4771 4772 4773
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
Aurel's avatar
Aurel committed
4774 4775 4776
      path = roles_path.split('/')[1:]
      obj = p.unrestrictedTraverse(path)
      setattr(obj, '__ac_local_roles__', {})
4777
      obj.reindexObject()
4778

4779 4780 4781
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4782
    in part or completely. Each object is separated from its
4783 4784 4785 4786 4787 4788 4789 4790 4791 4792
    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
4793 4794
      - object without optimal actions
      - list of relation between portal type and workflow
4795 4796 4797 4798 4799 4800 4801 4802 4803 4804

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

    - site property definition
      - id
      - type
4805
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4806

4807 4808
    - document/propertysheet/extension/test definition
      - copy of the local file
4809

4810
    - message transalation definition
4811
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4812

4813 4814
    The Business Template properties are exported to the bt folder with
    one property per file
4815

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4816 4817
    Technology:

4818 4819
    - 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
4820

4821
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4822 4823 4824 4825

    Use case:

    - install core ERP5 (the minimum)
4826

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

4829 4830
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4831
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4832 4833 4834 4835 4836
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4837
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4838 4839 4840

    # Declarative security
    security = ClassSecurityInfo()
4841
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4842 4843 4844 4845

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4846
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4847
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4848
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4849
                      , PropertySheet.BusinessTemplate
4850
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4851 4852
                      )

4853 4854 4855 4856 4857 4858
    # 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."""
4859
         , 'icon'           : 'file_icon.gif'
4860 4861 4862 4863 4864 4865 4866 4867 4868
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4869 4870
    # This is a global variable
    # Order is important for installation
4871 4872 4873 4874 4875 4876
    # 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 )
4877 4878
    _item_name_list = [
      '_product_item',
4879
      '_property_sheet_item',
4880
      '_constraint_item',
4881 4882 4883 4884
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4885
      '_tool_item',
4886 4887 4888 4889
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4890
      '_portal_type_workflow_chain_item',
4891 4892 4893 4894
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4895 4896
      '_category_item',
      '_module_item',
4897
      '_path_item',
4898
      '_skin_item',
4899
      '_registered_skin_selection_item',
4900
      '_preference_item',
4901
      '_action_item',
4902
      '_portal_type_roles_item',
4903
      '_local_roles_item',
4904
      '_catalog_method_item',
4905 4906 4907
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4908
      '_catalog_keyword_key_item',
4909
      '_catalog_datetime_key_item',
4910 4911 4912 4913
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4914
      '_catalog_scriptable_key_item',
4915 4916
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4917 4918 4919 4920
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4921 4922 4923 4924 4925 4926
      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
4927
        self._baseGetTemplateFormatVersion()
4928

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4929 4930 4931
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4932

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4933
      return 0
4934

4935
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4936 4937 4938 4939 4940 4941 4942
    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".
4943 4944
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4945
          # XXX Not good to access the attribute directly,
4946 4947 4948
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4949

4950 4951
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4952 4953 4954 4955 4956 4957
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4958
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4959 4960 4961 4962 4963 4964 4965 4966
        """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)
4967

4968 4969
    security.declareProtected(Permissions.ManagePortal, 'storeTemplateItemData')
    def storeTemplateItemData(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4970
      """
4971
        Instanciate and Store Template items into properties.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4972
      """
4973
      # Store all Data
4974 4975
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4976
      self._portal_type_workflow_chain_item = \
4977
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4978 4979 4980 4981
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4982 4983 4984
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4985 4986 4987 4988 4989 4990
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4991
      self._portal_type_roles_item = \
4992
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4993 4994 4995 4996 4997 4998 4999 5000
      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())
5001 5002
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022
      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())
5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034
      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())
5035 5036
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
5037 5038
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
5039 5040
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
5041
               self.getTemplateCatalogKeywordKeyList())
5042 5043 5044
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
5045 5046
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
5047
               self.getTemplateCatalogFullTextKeyList())
5048 5049
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
5050
               self.getTemplateCatalogRequestKeyList())
5051 5052
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
5053
               self.getTemplateCatalogMultivalueKeyList())
5054 5055 5056
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
5057 5058
      self._local_roles_item = \
          LocalRolesTemplateItem(
5059
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5060 5061 5062
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
5063 5064 5065
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
5066 5067 5068 5069 5070 5071
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
5072

5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086
    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()

5087 5088
      # Build each part
      for item_name in self._item_name_list:
5089 5090 5091 5092
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
5093

5094
    build = WorkflowMethod(build)
5095 5096

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5097
      """
5098
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5099
      """
5100
      return self.portal_templates.publish(self, url, username=username,
5101
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5102

5103
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5104
      """
5105
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5106
      """
5107
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5108

5109 5110 5111 5112 5113
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
5114 5115 5116 5117 5118 5119 5120 5121 5122 5123
      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
5124 5125
      return False

5126
    def preinstall(self, check_dependencies=1, **kw):
5127 5128 5129
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
5130
      """
5131 5132 5133 5134 5135
      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()
5136

5137 5138
      modified_object_list = {}
      bt_title = self.getTitle()
5139 5140 5141 5142 5143 5144 5145

      #  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)
5146 5147 5148
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5149
        installed_bt_format = installed_bt.getTemplateFormatVersion()
5150

5151
      # if reinstall business template, must compare to object in ZODB
5152
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
5153
      # same if we make a diff and select only one business template
5154
      reinstall = 0
5155 5156
      if installed_bt == self:
        reinstall = 1
5157
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
5158 5159
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                   id=INSTALLED_BT_FOR_DIFF)
5160 5161 5162 5163 5164 5165 5166
          # 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)
5167

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5168
      new_bt_format = self.getTemplateFormatVersion()
5169 5170 5171 5172 5173 5174
      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:
5175
          item = getattr(self, item_name, None)
5176 5177 5178 5179
          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
5180

5181
      for item_name in self._item_name_list:
5182
        new_item = getattr(self, item_name, None)
5183
        installed_item = getattr(installed_bt, item_name, None)
5184
        if new_item is not None:
5185
          if installed_item is not None and hasattr(installed_item, '_objects'):
5186
            modified_object = new_item.preinstall(context=self, 
5187 5188
                                                  installed_item=installed_item,
                                                  installed_bt=installed_bt)
5189 5190 5191 5192 5193 5194 5195
            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:
5196
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5197

5198 5199
      return modified_object_list

5200 5201
    def _install(self, force=1, object_to_update=None, update_translation=0,
                 update_catalog=0, **kw):
5202
      """
Christophe Dumez's avatar
Christophe Dumez committed
5203
        Install a new Business Template, if force, all will be upgraded or installed
5204 5205
        otherwise depends of dict object_to_update
      """
5206 5207 5208 5209
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
5210

5211 5212
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
5213 5214
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5215
        if installed_bt.getTemplateFormatVersion() == 0:
5216
          force = 1
5217
        installed_bt.replace(self)
5218

5219 5220 5221 5222
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

5223 5224 5225
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
5226

5227 5228 5229
      if not force:
        self.checkDependencies()

5230
      site = self.getPortalObject()
5231 5232 5233
      from Products.ERP5.ERP5Site import ERP5Generator
      generator_class = getattr(site, '_generator_class', ERP5Generator)
      gen = generator_class()
5234 5235
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
5236 5237 5238 5239 5240 5241
        if not site.hasObject('portal_activities'):
          create_activities = True
          LOG('Business Template', 0, 'Updating Activity Tool')
        else:
          create_activities = False
        gen.setupLastTools(site, update=1, create_activities=create_activities)
5242 5243
      if not force:
        if len(object_to_update) == 0:
5244 5245 5246 5247 5248
          # 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():
5249
            LOG('Business Template', 0, 'Updating Business Template Workflows')
5250
            gen.setupWorkflow(site)
5251
          return
5252

5253 5254
      # 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
5255
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
5256 5257 5258 5259 5260
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
5261
      if len(object_to_update) or force:
5262 5263 5264
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
5265 5266
            item.install(self, force=force, object_to_update=object_to_update, 
                               trashbin=trashbin, installed_bt=installed_bt)
5267

5268
      # update catalog if necessary
5269 5270
      if force and self.isCatalogUpdatable():
        update_catalog = 1
5271
      if update_catalog:
5272
        catalog = _getCatalogValue(self)
5273
        if (catalog is None) or (not site.isIndexable):
5274 5275 5276 5277 5278
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
5279

5280
      # get objects to remove
5281
      # do remove after because we may need backup object from installation
5282
      remove_object_dict = {}
5283 5284
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
5285
          remove_object_dict[path] = action
5286

5287
      # remove object from old business template
5288
      if len(remove_object_dict):
5289
        # XXX: this code assumes that there is an installed_bt
5290
        for item_name in reversed(installed_bt._item_name_list):
5291
          item = getattr(installed_bt, item_name, None)
5292
          if item is not None:
5293
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
5294

5295 5296 5297 5298 5299 5300

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

5301
      # check if we have to update business template workflow
5302
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
5303
        LOG('Business Template', 0, 'Updating Business Template Workflows')
5304 5305 5306 5307 5308
        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)

5309 5310
      # remove trashbin if empty
      if trashbin is not None:
5311
        if len(trashbin) == 0:
5312 5313
          trash_tool.manage_delObjects([trashbin.getId(),])

5314 5315
      if update_catalog:
        site.ERP5Site_reindexAll()
5316

5317 5318
      # Update translation table, in case we added new portal types or
      # workflow states.
5319 5320
      if update_translation:
        site.ERP5Site_updateTranslationTable()
5321

5322 5323
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
5324

5325
    security.declareProtected(Permissions.ManagePortal, 'install')
5326 5327 5328
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
5329
      """
5330
      return self._install(**kw)
5331

5332
    install = WorkflowMethod(install)
5333

5334
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
5335
    def reinstall(self, **kw):
5336 5337 5338 5339
      """Reinstall Business Template.
      """
      return self._install(**kw)

5340
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5341

5342
    security.declareProtected(Permissions.ManagePortal, 'trash')
5343 5344
    def trash(self, new_bt, **kw):
      """
5345
        Trash unnecessary items before upgrading to a new business
5346
        template.
5347
        This is similar to uninstall, but different in that this does
5348
        not remove all items.
5349
      """
5350 5351
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5352
        item = getattr(self, item_name, None)
5353 5354
        if item is not None:
          item.trash(
5355
                self,
5356
                getattr(new_bt, item_name))
5357

5358
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
5359
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5360
      """
5361
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5362
      """
5363 5364 5365
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5366
        item = getattr(self, item_name, None)
5367
        if item is not None:
5368
          item.uninstall(self, **kw)
5369
      # It is better to clear cache because the uninstallation of a
5370
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
5371
      self.getPortalObject().portal_caches.clearAllCache()
5372

5373 5374
    uninstall = WorkflowMethod(uninstall)

5375
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5376
    def _clean(self):
5377
      """
5378
        Clean built information.
5379
      """
5380
      # First, remove obsolete attributes if present.
5381 5382 5383 5384
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
5385
                    '_module_archive',
5386 5387 5388
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
5389
                    '_property_sheet_archive'):
5390 5391 5392
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
5393 5394
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
5395

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

5398
    security.declareProtected(Permissions.AccessContentsInformation,
5399
                              'getBuildingState')
5400
    def getBuildingState(self, default=None, id_only=1):
5401
      """
5402
        Returns the current state in building
5403
      """
5404
      portal_workflow = getToolByName(self, 'portal_workflow')
5405 5406
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
5407
      return wf._getWorkflowStateOf(self, id_only=id_only )
5408

5409
    security.declareProtected(Permissions.AccessContentsInformation,
5410
                              'getInstallationState')
5411
    def getInstallationState(self, default=None, id_only=1):
5412
      """
5413
        Returns the current state in installation
5414
      """
5415
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
5416 5417
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
5418
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5419

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5420 5421 5422 5423 5424 5425
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
5426
      export_string = portal_templates.manage_exportObject(
5427 5428
                                               id=self.getId(),
                                               toxml=1,
5429
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5430
      return export_string
5431

5432
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5433
      """
5434 5435
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5436
      """
5437 5438
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
5439 5440 5441 5442
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
5443
        # XXX Why do we need to return a tuple ?
5444 5445
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5446

5447
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5448
      """
5449 5450
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5451
      """
5452
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5453

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

5461
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5462
      """
5463 5464
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5465
      """
5466
      return self._getOrderedList('template_workflow_id')
5467

5468
    def getTemplatePortalTypeIdList(self):
5469
      """
5470 5471
      We have to set this method because we want an
      ordered list
5472
      """
5473
      return self._getOrderedList('template_portal_type_id')
5474

5475 5476 5477 5478 5479 5480 5481
    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
5482 5483 5484 5485 5486 5487 5488
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

5489 5490 5491 5492 5493 5494 5495
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

5496 5497 5498 5499 5500 5501
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
5502

5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523
    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')

5524
    def getTemplateActionPathList(self):
5525
      """
5526 5527
      We have to set this method because we want an
      ordered list
5528
      """
5529
      return self._getOrderedList('template_action_path')
5530

5531
    def getTemplatePortalTypeRoleList(self):
5532 5533 5534 5535
      """
      We have to set this method because we want an
      ordered list
      """
5536
      return self._getOrderedList('template_portal_type_role')
5537

5538
    def getTemplateLocalRoleList(self):
5539 5540 5541 5542
      """
      We have to set this method because we want an
      ordered list
      """
5543
      return self._getOrderedList('template_local_role')
5544

5545
    def getTemplateSkinIdList(self):
5546
      """
5547 5548
      We have to set this method because we want an
      ordered list
5549
      """
5550
      return self._getOrderedList('template_skin_id')
5551

5552 5553 5554 5555 5556 5557 5558
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

5559
    def getTemplateModuleIdList(self):
5560
      """
5561 5562
      We have to set this method because we want an
      ordered list
5563
      """
5564
      return self._getOrderedList('template_module_id')
5565 5566 5567 5568 5569 5570 5571

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5573 5574 5575 5576 5577 5578 5579
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5580
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5581 5582 5583 5584
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5585
      if self.getBuildingState() != 'built':
5586
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5587
              'Business Template must be built before export'
5588

Aurel's avatar
Aurel committed
5589 5590 5591 5592 5593 5594 5595
      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)

5596
      # export bt
5597
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
5598
      for prop in self.propertyMap():
5599
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5600
        id = prop['id']
5601
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5602
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5603
          continue
Aurel's avatar
Aurel committed
5604
        value = self.getProperty(id)
5605 5606
        if value is None:
          continue
5607
        if prop_type in ('text', 'string', 'int', 'boolean'):
5608
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
5609
        elif prop_type in ('lines', 'tokens'):
5610
          bta.addObject(obj=str('\n').join(value), name=id,
5611
                        path=path+os.sep+'bt', ext='')
5612

Aurel's avatar
Aurel committed
5613 5614 5615
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5616

5617
      return bta.finishCreation(self.getTitle())
Aurel's avatar
Aurel committed
5618

5619
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5620 5621
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5622
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5623 5624 5625 5626 5627
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
5628 5629

      self.storeTemplateItemData()
5630

5631 5632
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5633
      orig_module_dict = {}
5634
      instance_oid_list = []
5635 5636
      for template_id in self.getTemplateDocumentIdList():
          module_id = 'Products.ERP5Type.Document.' + template_id
5637
          orig_module_dict[module_id] = sys.modules.get(module_id)
5638 5639 5640 5641 5642 5643 5644 5645 5646 5647
          # 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__
5648

Aurel's avatar
Aurel committed
5649 5650
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5651

5652 5653 5654 5655 5656 5657
      if instance_oid_list:
        # If a temporary class was used, we must force all instances using it
        # to be reloaded (i.e. unpickle) on next access (at installation).
        # Doing a savepoint will pickle them to a temporary storage so that all
        # references to it can be freed.
        transaction.savepoint(optimistic=True)
5658 5659
        self._p_jar.cacheMinimize()
        gc.collect()
5660

5661 5662
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5663 5664 5665 5666 5667 5668
      # 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
5669

5670 5671 5672 5673 5674
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5675 5676 5677
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5678
      return items_list
5679

5680 5681 5682 5683 5684 5685 5686 5687 5688 5689
    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:
5690
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5691
          dependency = dependency_couple_list[0]
5692 5693
          if dependency in (None, ''):
            continue
5694 5695
          version_restriction = None
          if len(dependency_couple_list) > 1:
5696
            version_restriction = dependency_couple_list[1]
5697 5698 5699
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5700 5701 5702
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5703
                  or (version_restriction not in (None, '') and
5704 5705 5706 5707
                     (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)
5708

5709 5710 5711 5712 5713 5714 5715 5716
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
        This is compatible with ERP5Subversion look and feel but
        it is preferred in future we use more difflib python library.
      """
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

Aurel's avatar
Aurel committed
5717
    def diffObject(self, REQUEST, **kw):
5718 5719
      """
        Make a diff between an object in the Business Template
5720
        and the same in the Business Template installed in the site
5721 5722 5723 5724
      """

      class_name_dict = {
        'Product' : '_product_item',
5725
        'PropertySheet' : '_property_sheet_item',
5726
        'Constraint' : '_constraint_item',
5727 5728 5729 5730 5731 5732 5733 5734 5735
        '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',
5736
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5737 5738 5739 5740
        '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',
5741 5742 5743
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5744
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5745
        'Path' : '_path_item',
5746
        'Preference' : '_preference_item',
5747
        'Action' : '_action_item',
5748
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5749
        'LocalRoles' : '_local_roles_item',
5750 5751 5752
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5753
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5754
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5755 5756 5757 5758
        '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
5759
        'Tool': '_tool_item',
5760
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5761 5762
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5763
        }
5764

5765 5766
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5767

Christophe Dumez's avatar
Christophe Dumez committed
5768
      # Get objects
5769
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5770

5771
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
5772
      # Compare with a given business template
5773
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5774 5775
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5776 5777
        if bt2_id == self.getId():
          compare_to_zodb = 1
5778
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5779 5780
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5781 5782 5783
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5784 5785
          compare_to_zodb = 1
      if compare_to_zodb:
5786 5787
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5788
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5789 5790 5791
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5792

5793 5794
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5795
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5796
        # XXX maybe only build for the given object to gain time
5797
        installed_item.build(self)
5798 5799 5800
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5801

Christophe Dumez's avatar
Christophe Dumez committed
5802
      # Real Zope Objects (can be exported into XML directly by Zope)
5803 5804
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5805
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5806
                     '_skin_item', '_action_item', '_tool_item', ]
5807

Christophe Dumez's avatar
Christophe Dumez committed
5808
      # Not considered as objects by Zope (will be exported into XML manually)
5809
      # XXX Bad naming
5810 5811 5812 5813
      item_list_2 = ['_site_property_item',
                     '_module_item',
                     '_catalog_result_key_item', 
                     '_catalog_related_key_item',
5814 5815
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
5816
                     '_catalog_datetime_key_item',
5817 5818 5819 5820
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5821
                     '_catalog_scriptable_key_item',
5822 5823
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5824 5825 5826 5827 5828 5829
                     '_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',
5830
                     '_portal_type_workflow_chain_item',]
5831

Christophe Dumez's avatar
Christophe Dumez committed
5832
      # Text objects (no need to export them into XML)
5833
      # XXX Bad naming
5834 5835
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5836
                     '_test_item', '_message_translation_item',]
5837

5838
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5839 5840 5841
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5842 5843
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
5844
        # XML Export in memory
5845
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5846 5847
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5848
        new_obj_xml = f1.getvalue()
5849
        f1.close()
5850 5851 5852 5853
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5854
        # End of XML export
5855

5856
        # Diff between XML objects
5857 5858
        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
5859
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5860 5861 5862
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5863

5864
      elif item_name in item_list_2:
5865
        # Generate XML code manually
5866 5867
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5868 5869
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5870
        # End of XML Code Generation
5871

5872
        # Diff between XML objects
5873 5874
        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
5875
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5876 5877 5878
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5879

5880
      elif item_name in item_list_3:
5881
        # Diff between text objects
5882 5883 5884 5885
        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
5886
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5887 5888
          diff_msg += '\n'.join(diff_list)
        else:
5889
          diff_msg = 'No diff'
5890

5891
      else:
5892
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5893

5894
      if compare_to_zodb:
5895
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5896

5897
      return diff_msg
5898

5899

5900 5901 5902 5903
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5904 5905
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5906 5907 5908 5909 5910 5911 5912
      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 [])
5913 5914
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5915
      p = self.getPortalObject()
5916
      for id in bt_portal_types_id_list:
5917 5918
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5919
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5920
        if portal_type.getRoleInformationList():
5921 5922
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5923

5924 5925 5926 5927
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5928
        action_list = []
5929 5930 5931 5932 5933 5934 5935
        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'):
5936
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5937 5938
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5939

5940 5941 5942 5943
        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)
5944

5945
        for h_id in hidden_content_type_list:
5946 5947 5948
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5949

5950 5951 5952 5953
        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)
5954

5955 5956 5957 5958
        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)
5959

5960 5961 5962 5963
        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)
5964

5965
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5966
                                    if chain != '(Default)']:
5967 5968 5969
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5970

5971 5972 5973 5974
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5975
      bt_action_list.sort()
5976
      bt_wf_chain_list.sort()
5977

5978 5979 5980 5981 5982 5983 5984
      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)
5985 5986 5987 5988 5989 5990 5991 5992 5993
      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:
5994 5995
        raise TemplateConditionError, 'No module defined in business template'

5996 5997 5998 5999 6000 6001 6002 6003
      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:
6004
          return type_list
6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018

        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():
6019
            type_list.update(getChildPortalType(hidden_ptype_id))
6020
        return type_list
6021

6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068
      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

6069 6070 6071
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
6072
  setattr(BusinessTemplate, key, None)
6073

6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100
# 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)
6101

6102 6103 6104 6105 6106 6107 6108 6109

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

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