BusinessTemplate.py 228 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
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
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

Aurel's avatar
Aurel committed
314 315 316 317 318
  def finishCreation(self, **kw):
    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
    f.write(str(obj))
Aurel's avatar
Aurel committed
353 354 355
    f.close()

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

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

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

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

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

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

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

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

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

471
class TemplateConditionError(Exception): pass
472
class TemplateConflictError(Exception): pass
473
class BusinessTemplateMissingDependency(Exception): pass
474

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

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

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

493
  def preinstall(self, context, installed_bt, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
494 495 496 497 498 499 500 501
    """
      Build a list of added/removed/changed files between the BusinessTemplate
      being installed (self) and the installed one (installed_bt).
      Note : we compare files between BTs, *not* between the installed BT and
      the objects in the DataFS.

      XXX: -12 used here is -len('TemplateItem')
    """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
502 503
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
504
      new_keys = self._objects.keys()
505
      for path in new_keys:
506
        if installed_bt._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
507
          # compare objects to see it there are changes
508 509
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
510 511
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
512
          # else, compared versions are identical, don't overwrite the old one
513 514
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
515
      # list removed objects
516 517 518 519 520 521 522
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
523
    pass
524 525 526

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

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

555

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

563 564
  def getKeys(self):
    return self._objects.keys()
565

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

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

592 593 594 595 596 597 598 599 600
  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]

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

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

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

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

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

689
  def _compileXML(self, file):
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
    # 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
749

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

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

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

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
  def beforeInstall(self):
    """
      Installation hook.
      Called right at the begining of "install" method.
      Can be overridden by subclasses.
    """
    pass

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

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

858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
  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

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

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

1166
        container.manage_delObjects([object_id])
1167 1168
        if container.aq_parent.meta_type == 'ERP5 Catalog' and len(container.objectIds()) == 0:
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1169
          container.getParentValue().manage_delObjects([container.id])
1170
      except (NotFound, KeyError, BadRequest, AttributeError):
1171
        # object is already backup and/or removed
1172
        pass
1173 1174
    BaseTemplateItem.uninstall(self, context, **kw)

1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
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

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

1222 1223 1224
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1225

1226 1227 1228 1229 1230 1231 1232 1233 1234
      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.
1235 1236 1237
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1238
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1239 1240
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1241
      if object_id != "":
1242
        path_list.extend(self._resolvePath(
1243
            folder._getOb(object_id),
1244
            relative_url_list + [object_id], id_list[1:]))
1245
    return path_list
Aurel's avatar
Aurel committed
1246

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1276 1277 1278 1279 1280 1281 1282 1283
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)

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

1325 1326
class CategoryTemplateItem(ObjectTemplateItem):

1327 1328
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1329

1330 1331 1332 1333
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1334 1335
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1336
      obj = self.removeProperties(obj)
1337
      id_list = obj.objectIds()
1338
      if id_list:
1339
        self.build_sub_objects(context, id_list, relative_url)
1340
        for id_ in list(id_list):
1341
          obj._delObject(id_)
1342 1343
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1344 1345 1346 1347 1348

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1349 1350
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1351
      _recursiveRemoveUid(obj)
1352
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1353
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1354
      id_list = obj.objectIds()
1355 1356
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1357
        for id_ in list(id_list):
1358
          obj._delObject(id_)
1359
      else:
1360
        for id_ in list(id_list):
1361
          obj._delObject(id_)
1362 1363
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1364

1365 1366 1367 1368 1369 1370 1371 1372
  def beforeInstall(self):
    self._installed_new_category = False

  def onNewObject(self):
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1373 1374
      # reset accessors if we installed a new category
      _aq_reset()
1375

1376 1377
class SkinTemplateItem(ObjectTemplateItem):

1378 1379
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1380

1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
  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')

1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_bt, **kw)
    # We must install/update an ERP5 Form if one of its widget is modified.
    # This allow to keep the widget order and the form layout after an update
    #   from a BT to another one.
    for (bt_obj_path, bt_obj) in self._objects.items():
      if getattr(bt_obj, 'meta_type', None) == 'ERP5 Form':
        # search sub-objects of ERP5 Forms that are marked as "modified"
        for upd_obj_path in modified_object_list.keys():
          if upd_obj_path.startswith(bt_obj_path):
            # a child of the ERP5 Form must be updated, so the form too
            if not modified_object_list.has_key(bt_obj_path):
              modified_object_list.update({bt_obj_path: ['Modified', self.__class__.__name__[:-12]]})
    return modified_object_list

1406
  def install(self, context, trashbin, **kw):
1407
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1408 1409
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1410
    p = context.getPortalObject()
1411
    skin_tool = p.portal_skins
1412 1413
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1414
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1415 1416
        fixZSQLMethod(p, obj)

1417
      # Do not register skin which were explicitely ask not to be installed
1418 1419 1420 1421 1422
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438
      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',
          [])
1439 1440 1441
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1442
      if skin_selection_id in selection_list:
1443
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1444
      else:
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
        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):
1464
    if not self._objects:
1465 1466 1467 1468
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
1469 1470 1471
    bta.addObject(obj=self.generateXml(), 
                  name='registered_skin_selection',  
                  path=root_path)
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486

  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]
1487 1488 1489
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1490

1491
        if selection_list is default_value:
1492
          create_property = True
1493
          selection_list = self._objects[skin_folder_id]
1494
        else:
1495
          create_property = False
1496 1497 1498 1499 1500
          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])
1501 1502

        # Remove duplicate
1503
        selection_list = list(set(selection_list))
1504 1505 1506
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
1507
              selection_list, type='tokens')
1508 1509 1510
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
1511
              selection_list)
1512 1513

        unregisterSkinFolder(skin_tool, skin_folder,
1514
                             skin_tool.getSkinSelections())
1515
        registerSkinFolder(skin_tool, skin_folder)
1516 1517

  def uninstall(self, context, **kw):
1518 1519 1520
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1521 1522 1523 1524
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1525 1526 1527 1528
      object_keys = self._objects.keys()

    for skin_folder_id in object_keys:
      skin_folder = skin_tool[skin_folder_id]
1529
      current_selection_list = skin_folder.getProperty(
1530
        'business_template_registered_skin_selections', [])
1531
      current_selection_set = set(current_selection_list)
1532

1533 1534 1535
      skin_selection_list = workflow_id = self._objects[skin_folder_id]
      if isinstance(skin_selection_list, str):
        skin_selection_list = skin_selection_list.replace(',', ' ').split(' ')
1536 1537 1538 1539 1540
      for skin_selection in skin_selection_list:
        current_selection_set.remove(skin_selection)

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1541
        skin_folder._updateProperty(
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578
            'business_template_registered_skin_selections',
            current_selection_list)

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

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

  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
          new_object = self._objects[path]
          old_object = installed_bt._objects[path]
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def _importFile(self, file_name, file):
    if not file_name.endswith('.xml'):
1579
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1580 1581 1582 1583
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
1584 1585 1586
    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
1587 1588
      if not selection_string:
        selection_list = []
1589
      else:
1590 1591
        selection_list = selection_string.split(',')
      skin_selection_dict[skin_folder_id] = selection_list
1592
    self._objects = skin_selection_dict
1593 1594


1595
class WorkflowTemplateItem(ObjectTemplateItem):
1596

1597 1598
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1599

1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611
  # When the root object of a workflow is modified, the entire workflow is
  # recreated: all subobjects are discarded and must be reinstalled.
  # So we hide modified subobjects to the user and we always reinstall
  # (or remove) everything.

  def preinstall(self, context, installed_bt, **kw):
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
                                                         installed_bt, **kw)
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1612
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1613 1614 1615 1616
      else:
        modified_workflow_dict[modified_object] = state
    return modified_workflow_dict

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


1658 1659
class PortalTypeTemplateItem(ObjectTemplateItem):

1660 1661
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1662 1663
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1664 1665 1666
    self._workflow_chain_archive = PersistentMapping()

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

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

1717 1718
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1719 1720 1721
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
1722
      result_dict = {}
1723
      xml = parse(file)
1724
      chain_list = xml.findall('//chain')
1725
      for chain in chain_list:
1726 1727 1728 1729
        portal_type = chain.find('type').text
        workflow = chain.find('workflow').text or ''
        result_dict[portal_type] = workflow
      self._workflow_chain_archive = result_dict
1730 1731 1732
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1733
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1734 1735

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

Christophe Dumez's avatar
Christophe Dumez committed
1775
  # Function to generate XML Code Manually
1776 1777 1778 1779 1780
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1781
      workflow_list = self._objects[key]
1782 1783 1784
      # XXX Not always a list
      if isinstance(workflow_list, str):
        workflow_list = [workflow_list]
1785 1786
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
1787
      xml_data += '\n  <workflow>%s</workflow>' %(', '.join(sorted(workflow_list)))
1788 1789
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
    xml_data = self.generateXml()
    bta.addObject(obj=xml_data, name='workflow_chain_type',  path=root_path)

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # We now need to setup the list of workflows corresponding to
    # each portal type
1806
    (default_chain, chain_dict) = getChainByType(context)
1807
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1808
    # best solution, by default it is 'default_workflow', which is
1809 1810 1811 1812 1813 1814 1815
    # not very usefull
    default_chain = ''
    for path in self._objects.keys():
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1816
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1817 1818
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
1819
        if len(path_splitted) < 1:
Jérome Perrin's avatar
Jérome Perrin committed
1820
          continue
1821
        portal_type = path_splitted[-1]
1822
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1823 1824 1825
          old_chain_dict = chain_dict['chain_%s' % portal_type]
          # XXX we don't use the chain (Default) in erp5 so don't keep it
          if old_chain_dict != '(Default)' and old_chain_dict != '':
1826
            old_chain_workflow_id_set = {}
1827
            # get existing workflow id list
1828 1829
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1830
            # get new workflow id list
1831
            for wf_id in self._objects[path].split(', '):
1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
              if wf_id[0] == '-':
                # remove wf id if already present
                if old_chain_workflow_id_set.has_key(wf_id[1:]):
                  old_chain_workflow_id_set.pop(wf_id[1:])
              elif wf_id[0] == '=':
                # replace existing chain by this one
                old_chain_workflow_id_set = {}
                old_chain_workflow_id_set[wf_id[1:]] = 1
              # then either '+' or nothing, add wf id to the list
              elif wf_id[0] == '+':
                old_chain_workflow_id_set[wf_id[1:]] = 1
              else:
                old_chain_workflow_id_set[wf_id] = 1
            # create the new chain
1846 1847
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1848
          else:
Romain Courteaud's avatar
Romain Courteaud committed
1849 1850 1851 1852 1853 1854
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
            for wf_id in self._objects[path].split(', '):
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
1855
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1856
        else:
1857 1858 1859 1860
          if portal_type not in context.portal_types.objectIds():
            raise ValueError('Cannot chain workflow %r to non existing '
                           'portal type %r' % (self._objects[path],
                                               portal_type))
Aurel's avatar
Aurel committed
1861
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1862 1863
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1864

1865 1866
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1867 1868 1869 1870 1871 1872
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._objects.keys()
    for path in object_keys:
1873 1874 1875 1876 1877 1878
      path_splitted = path.split('/', 1)
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
      id = 'chain_%s' % portal_type
      if id in chain_dict.keys():
1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
        chain = chain_dict[id]
        # It should be better to use regexp
        chain = chain.replace(' ', '')
        workflow_list = chain.split(',')
        workflow_id = self._objects[path]
        for i in range(workflow_list.count(workflow_id)):
          workflow_list.remove(workflow_id)
        chain = ', '.join(workflow_list)
        if chain == '':
          del chain_dict[id]
        else:
          chain_dict[id] = chain
1891
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1892

1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
      for key in installed_bt._objects.keys():
        if not "portal_type_workflow_chain/" in key:
          new_key = 'portal_type_workflow_chain/%s' %key
          new_dict[new_key] = installed_bt._objects[key]
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
        installed_bt._objects = new_dict
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
          new_object = self._objects[path]
          old_object = installed_bt._objects[path]
          # compare same type of object
          if isinstance(old_object, list) or isinstance(old_object, tuple):
            old_object = ', '.join(old_object)
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

1926
  def _importFile(self, file_name, file):
1927
    if not file_name.endswith('.xml'):
1928
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1929
      return
1930
    # import workflow chain for portal_type
1931
    result_dict = {}
1932
    xml = parse(file)
1933
    chain_list = xml.findall('chain')
1934
    for chain in chain_list:
1935 1936 1937 1938 1939 1940
      portal_type = chain.find('type').text
      workflow = chain.find('workflow').text or ''
      if 'portal_type_workflow_chain/' not in portal_type:
        portal_type = 'portal_type_workflow_chain/%s' % (portal_type,)
      result_dict[portal_type] = workflow
    self._objects = result_dict
1941

1942 1943
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1944

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

  def build(self, context, **kw):
1954 1955
    types_tool = self.getPortalObject().portal_types
    types_list = list(types_tool.objectIds())
1956
    for key in self._archive.keys():
1957 1958 1959 1960
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
1961 1962 1963 1964 1965
      # check properties corresponds to what is defined in site
      if not portal_type in types_list:
        raise ValueError, "Portal Type %s not found in site" %(portal_type,)
      ob = types_tool._getOb(portal_type)
      prop_value = getattr(ob, self.class_property, ())
1966
      if not allowed_type in prop_value and not self.is_bt_for_diff:
Jérome Perrin's avatar
Jérome Perrin committed
1967
        raise ValueError, "%s %s not found in portal type %s" % (
1968 1969 1970
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)

1971 1972 1973 1974 1975 1976 1977
      if self._objects.has_key(portal_type):
        allowed_list = self._objects[portal_type]
        allowed_list.append(allowed_type)
        self._objects[portal_type] = allowed_list
      else:
        self._objects[portal_type] = [allowed_type]

Christophe Dumez's avatar
Christophe Dumez committed
1978
  # Function to generate XML Code Manually
1979
  def generateXml(self, path=None):
1980
    dictio = self._objects
1981
    xml_data = '<%s>' %(self.xml_tag,)
1982
    keys = dictio.keys()
1983 1984
    keys.sort()
    for key in keys:
1985
      allowed_list = sorted(dictio[key])
1986
      xml_data += '\n <portal_type id="%s">' %(key,)
1987
      for allowed_item in allowed_list:
1988 1989 1990
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001
    return xml_data

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

2002 2003 2004 2005 2006
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
2007 2008 2009 2010
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
      for key in installed_bt._objects.keys():
        if self.class_property not in key:
2011
          new_key = '%s/%s' % (self.class_property, key)
2012
          new_dict[new_key] = installed_bt._objects[key]
2013 2014 2015
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
2016 2017 2018 2019 2020
        installed_bt._objects = new_dict
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
          new_object = self._objects[path]
2021
          old_object = installed_bt._objects[path]
2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

2033
  def _importFile(self, file_name, file):
2034
    if not file_name.endswith('.xml'):
2035
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2036
      return
2037
    path, name = posixpath.split(file_name)
2038
    xml = parse(file)
2039
    portal_type_list = xml.findall('portal_type')
2040
    for portal_type in portal_type_list:
2041 2042 2043
      id = portal_type.get('id')
      item_type_list = [item.text for item in portal_type.findall('item')]
      self._objects['%s/%s' % (self.class_property, id,)] = item_type_list
2044 2045 2046 2047 2048 2049

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

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

2106

2107 2108
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2109
  name = 'Hidden Content Type'
2110 2111
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2112
  business_template_class_property = '_portal_type_hidden_content_type_item'
2113

2114

2115 2116
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2117
  name = 'Property Sheet'
2118 2119
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2120
  business_template_class_property = '_portal_type_property_sheet_item'
2121

2122

2123 2124
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2125
  name = 'Base Category'
2126 2127
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2128
  business_template_class_property = '_portal_type_base_category_item'
2129

2130

2131
class CatalogMethodTemplateItem(ObjectTemplateItem):
2132
  """Template Item for catalog methods.
2133

2134 2135 2136 2137 2138
    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.
  """
2139

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

2149
    self._is_filtered_archive = PersistentMapping()
2150 2151
    for method in catalog_method_filter_list:
      setattr(self, method, PersistentMapping())
2152

2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166
  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

2167 2168
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2169

2170
    catalog = _getCatalogValue(self)
2171
    if catalog is None:
2172
      LOG('BusinessTemplate build', 0, 'catalog not found')
2173
      return
2174

2175 2176 2177
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2178

2179 2180
    for obj in self._objects.values():
      method_id = obj.id
2181 2182
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2183 2184 2185 2186 2187 2188
      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]
2189

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

2200
      if self._is_filtered_archive.get(method_id):
2201 2202 2203
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2204 2205
          for method in catalog_method_filter_list:
            if method != '_filter_expression_instance_archive':
2206 2207
              value = getattr(self, method, {}).get(method_id)
              if isinstance(value, basestring):
2208 2209 2210
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2211
              elif value:
2212
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2213
                for item in value:
2214 2215
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2216
    xml_data += '\n</catalog_method>\n'
Christophe Dumez's avatar
Christophe Dumez committed
2217
    return xml_data
2218

2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247
  def preinstall(self, context, installed_bt, **kw):
    modified_object_dict = ObjectTemplateItem.preinstall(self, context, installed_bt, **kw)
    modified_object_dict.update(BaseTemplateItem.preinstall(self, context, installed_bt, **kw))
    return modified_object_dict

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

    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
      obj = self._objects[key]
      # create folder and subfolders
      folders, id = posixpath.split(key)
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
      # add all datas specific to catalog inside one file
      key_name = os.path.join(obj.id+'.catalog_keys')
      xml_data = self.generateXml(key)
      bta.addObject(obj=xml_data, name=key_name, path=path)

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

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

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

2285 2286
    for obj in values:
      method_id = obj.id
2287

2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298
      # Restore catalog properties for methods
      if hasattr(self, '_method_properties'):
        for key in self._method_properties.get(method_id, {}).keys():
          old_value = getattr(catalog, key, None)
          if isinstance(old_value, str):
            setattr(catalog, key, method_id)
          elif isinstance(old_value, list) or isinstance(old_value, tuple):
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2299

2300 2301
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2302
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2303
        if context.getTemplateFormatVersion() == 1:
2304 2305 2306 2307 2308
          if expression and expression.strip():
            # only compile non-empty expressions
            expr_instance = Expression(expression)
          else:
            expr_instance = None
2309 2310
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2311 2312 2313
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2314
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2315 2316 2317 2318
        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, ())
2319
      elif method_id in catalog.filter_dict.keys():
2320
        catalog.filter_dict[method_id]['filtered'] = 0
2321

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

2349 2350 2351 2352 2353 2354
        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)
2355

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

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2392
      if catalog.filter_dict.has_key(method_id):
2393
        del catalog.filter_dict[method_id]
2394

2395
    # uninstall objects
2396
    ObjectTemplateItem.uninstall(self, context, **kw)
2397

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

2436
class ActionTemplateItem(ObjectTemplateItem):
2437 2438

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

2446 2447
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2448
      Split path tries to split a complex path such as:
2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466

      "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

2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504
  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
    if obj.getParentId() == 'portal_types':
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2505 2506 2507 2508
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2509 2510 2511
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2512 2513
      action = self._getActionCopy(obj, context, value)
      if action is None:
2514 2515 2516
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2517
      key = posixpath.join(url[-2], url[-1], value)
2518
      self._objects[key] = self.removeProperties(action)
2519
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2520

2521 2522 2523
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2524
    if context.getTemplateFormatVersion() == 1:
2525
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2526 2527
      p = context.getPortalObject()
      for id in self._objects.keys():
2528 2529 2530 2531 2532
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2533 2534 2535
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2536

2537
          if container.getParentId() == 'portal_types':
2538 2539 2540
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2541 2542
            continue

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

2634 2635
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2636 2637
    object_path = kw.get("object_path", None)
    if object_path is not None:
2638 2639 2640 2641 2642 2643 2644 2645
      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]
2646
    else:
2647
      keys = self._archive.keys()
2648
    for id in keys:
2649 2650
      if  '|' in id:
        relative_url, value = id.split(' | ')
2651 2652 2653 2654 2655
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
          is_new_action = obj.getParentId() == 'portal_types'
          key = is_new_action and 'reference' or 'id'
2656
      else:
2657
        relative_url, key, value = self._splitPath(id)
2658
        obj = p.unrestrictedTraverse(relative_url, None)
2659 2660 2661
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2662
          if getattr(action_list[index], key, None) == value:
2663 2664
            obj.deleteActions(selections=(index,))
            break
2665 2666
      LOG('BusinessTemplate', 100,
          'unable to uninstall action at %s, ignoring' % relative_url )
2667 2668
    BaseTemplateItem.uninstall(self, context, **kw)

2669 2670 2671
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2672
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2673 2674 2675 2676 2677 2678 2679
    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])
2680
      self._objects[relative_url] = type_role_list = []
2681
      for role in obj.getRoleInformationList():
2682
        type_role_dict = {}
2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699
        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
2700
        type_role_list.append(type_role_dict)
2701
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2702

Christophe Dumez's avatar
Christophe Dumez committed
2703
  # Function to generate XML Code Manually
2704 2705 2706 2707
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2708
      xml_data += "\n  <role id='%s'>" % role['id']
2709
      # uniq
2710
      for property in ('title', 'description', 'condition',
2711 2712 2713
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2714 2715
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2716
          xml_data += "\n   <property id='%s'>%s</property>" % \
2717 2718 2719
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2720
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2721 2722
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2723
          xml_data += "\n   <multi_property "\
2724
          "id='%s'>%s</multi_property>" % (property, prop_value)
2725 2726
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2727
    return xml_data
2728

2729 2730 2731 2732 2733 2734 2735
  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)
2736 2737
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2738 2739 2740 2741
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
2742 2743 2744
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2745 2746
    type_roles_list = []
    xml = parse(file)
2747
    xml_type_roles_list = xml.findall('role')
2748
    for role in xml_type_roles_list:
2749 2750 2751 2752
      id = role.get('id')
      if isinstance(id, unicode):
        id = id.encode('utf_8', 'backslashreplace')
      type_role_property_dict = {'id': id}
2753
      # uniq
2754 2755 2756 2757 2758 2759 2760 2761
      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
2762
      # multi
2763 2764 2765 2766 2767 2768 2769 2770
      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)
2771
      type_roles_list.append(type_role_property_dict)
2772
    self._objects['portal_type_roles/%s' % (file_name[:-4],)] = type_roles_list
2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783

  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
2784 2785 2786
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
2787
          # reset roles before applying
2788
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
2789
          type_roles_list = self._objects[roles_path] or []
2790 2791
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
2792 2793 2794

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2795 2796 2797 2798 2799 2800
    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:
2801
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2802 2803 2804 2805 2806
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2807

2808 2809 2810 2811 2812 2813
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2814 2815
      for property in p.propertyMap():
        if property['id'] == id:
2816
          obj = p.getProperty(id)
2817
          prop_type = property['type']
2818 2819
          break
      else:
2820
        obj = None
2821
      if obj is None and not self.is_bt_for_diff:
2822
        raise NotFound, 'the property %s is not found' % id
2823
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2824

2825 2826
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
2827
    if not file_name.endswith('.xml'):
2828
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2829
      return
2830
    xml = parse(file)
2831 2832 2833 2834 2835 2836 2837 2838 2839
    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)
2840

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

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2878 2879 2880 2881 2882 2883
    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:
2884 2885 2886 2887
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2888
  # Function to generate XML Code Manually
2889
  def generateXml(self, path=None):
2890
    xml_data = ''
2891
    prop_type, obj = self._objects[path]
2892
    xml_data += '\n <property>'
2893 2894
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
2895
    if prop_type in ('lines', 'tokens'):
2896
      xml_data += '\n  <value>'
2897
      for item in obj:
2898
        if item != '':
2899
          xml_data += '\n   <item>%s</item>' % escape(str(item))
2900
      xml_data += '\n  </value>'
2901
    else:
2902
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
2903
    xml_data += '\n </property>'
2904 2905
    return xml_data

Aurel's avatar
Aurel committed
2906 2907 2908 2909 2910
  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)
2911 2912 2913 2914
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2915
      xml_data += self.generateXml(path)
2916
    xml_data += '\n</site_property>'
2917
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2918

2919 2920 2921 2922 2923
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
2924 2925 2926 2927 2928 2929
    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()
2930
      permission_list = []
2931
      mapping['permission_list'] = module.showPermissions()
2932
      mapping['category_list'] = module.getCategoryList()
2933
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2934

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

2978
  def export(self, context, bta, **kw):
2979
    if len(self._objects) == 0:
2980 2981 2982
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
2983 2984
    keys = self._objects.keys()
    keys.sort()
2985
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
2986
      # export modules one by one
2987 2988
      xml_data = self.generateXml(path=key)
      bta.addObject(obj=xml_data, name=key, path=path)
2989

2990
  def install(self, context, trashbin, **kw):
2991
    portal = context.getPortalObject()
2992 2993
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2994
    if context.getTemplateFormatVersion() == 1:
2995
      items = self._objects
2996
    else:
2997 2998
      items = self._archive

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

  def _importFile(self, file_name, file):
3025 3026 3027
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3028
    mapping = {}
3029
    xml = parse(file)
3030
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3031
      key_node = xml.find(key)
3032
      if key == 'permission_list':
3033 3034 3035 3036 3037 3038 3039
        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))
3040
          else:
3041 3042 3043
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3044
      else:
3045
        mapping[key] = key_node.text or ''
3046 3047

    category_list = []
3048 3049 3050 3051
    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'))
3052 3053
    mapping['category_list'] = category_list

3054
    self._objects[file_name[:-4]] = mapping
3055

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

3080 3081 3082
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3083 3084

class DocumentTemplateItem(BaseTemplateItem):
3085 3086 3087 3088
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3089 3090 3091 3092

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

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

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

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

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

3195
class PropertySheetTemplateItem(DocumentTemplateItem):
3196 3197 3198 3199
  local_file_reader_name = staticmethod(readLocalPropertySheet)
  local_file_writer_name = staticmethod(writeLocalPropertySheet)
  local_file_importer_name = staticmethod(importLocalPropertySheet)
  local_file_remover_name = staticmethod(removeLocalPropertySheet)
3200

3201
class ConstraintTemplateItem(DocumentTemplateItem):
3202 3203 3204 3205
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3206

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

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

Aurel's avatar
Aurel committed
3221

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

class RoleTemplateItem(BaseTemplateItem):

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

3235
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3236 3237
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3238
      new_roles = self._objects.keys()
3239
      if installed_bt.id == INSTALLED_BT_FOR_DIFF:
3240 3241
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
3242 3243 3244
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
3245 3246
        for key in old_keys:
          new_dict[key] = ''
3247
        installed_bt._objects = new_dict
3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260
      for role in new_roles:
        if installed_bt._objects.has_key(role):
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
      old_roles = installed_bt._objects.keys()
      for role in old_roles:
        if role not in new_roles:
          modified_object_list.update({role : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
3261
    p = context.getPortalObject()
3262
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3263
    if context.getTemplateFormatVersion() == 1:
3264
      role_set = set(self._objects)
3265
    else:
3266
      role_set = set(self._archive)
3267 3268 3269 3270
    # 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:
3271 3272
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
3273
    # set roles on portal
3274
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
3275 3276

  def _importFile(self, file_name, file):
3277
    if not file_name.endswith('.xml'):
3278
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3279
      return
3280
    xml = parse(file)
3281 3282 3283
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295

  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)

3296 3297 3298 3299 3300 3301 3302 3303 3304
  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
3305
      if role in roles and role not in new_roles:
3306 3307 3308
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3309
  # Function to generate XML Code Manually
3310
  def generateXml(self, path):
3311
    obj = self._objects[path]
3312
    xml_data = '<role_list>'
3313 3314
    obj.sort()
    for role in obj:
3315 3316
      xml_data += '\n <role>%s</role>' %(role)
    xml_data += '\n</role_list>'
3317 3318
    return xml_data

Aurel's avatar
Aurel committed
3319 3320 3321 3322 3323 3324
  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():
3325
      xml_data = self.generateXml(path=path)
3326
      bta.addObject(obj=xml_data, name=path, path=None,)
3327

3328 3329
class CatalogResultKeyTemplateItem(BaseTemplateItem):

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

  def _importFile(self, file_name, file):
3346 3347 3348
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3349
    xml = parse(file)
3350 3351
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3352

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

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

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

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

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

3417 3418
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

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

  def _importFile(self, file_name, file):
3435 3436 3437
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3438
    xml = parse(file)
3439 3440
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3441

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

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

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

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

3509 3510
class CatalogResultTableTemplateItem(BaseTemplateItem):

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

  def _importFile(self, file_name, file):
3527 3528 3529
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3530
    xml = parse(file)
3531 3532
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
Aurel's avatar
Aurel committed
3533

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

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

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

Christophe Dumez's avatar
Christophe Dumez committed
3579
  # Function to generate XML Code Manually
3580
  def generateXml(self, path=None):
3581
    obj = self._objects[path]
3582
    xml_data = '<key_list>'
3583 3584
    obj.sort()
    for key in obj:
3585 3586
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3587 3588
    return xml_data

Aurel's avatar
Aurel committed
3589 3590 3591 3592 3593 3594
  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():
3595
      xml_data = self.generateXml(path=path)
3596
      bta.addObject(obj=xml_data, name=path, path=None)
3597

3598 3599
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3600 3601

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

3616
  def _importFile(self, file_name, file):
3617 3618 3619
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3620
    xml = parse(file)
3621 3622
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3623 3624

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

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3682 3683 3684 3685 3686
    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)
3687

3688 3689 3690 3691 3692 3693 3694 3695
# 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
3696
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3697 3698 3699 3700
    key_list = []
    for key in self._archive.keys():
      if key in sql_datetime_keys:
        key_list.append(key)
3701
      elif not self.is_bt_for_diff:
3702 3703 3704 3705 3706
        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):
3707 3708 3709
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3710
    xml = parse(file)
3711 3712
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3713 3714 3715 3716 3717 3718 3719

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

3720
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746
    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
3747
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777
    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)      
      
3778 3779
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3780

3781
  def build(self, context, **kw):
3782
    catalog = _getCatalogValue(self)
3783 3784 3785 3786 3787 3788 3789 3790
    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)
3791
      elif not self.is_bt_for_diff:
3792
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
3793
    if len(key_list) > 0:
3794
      self._objects[self.__class__.__name__+'/'+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3795

3796
  def _importFile(self, file_name, file):
3797 3798 3799
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3800
    xml = parse(file)
3801 3802
    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
3803

3804
  def install(self, context, trashbin, **kw):
3805
    catalog = _getCatalogValue(self)
3806 3807 3808
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3809

3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830
    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
3831

3832
  def uninstall(self, context, **kw):
3833
    catalog = _getCatalogValue(self)
3834 3835 3836 3837
    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)
3838
    object_path = kw.get('object_path', None)
3839 3840 3841 3842 3843 3844 3845 3846 3847 3848
    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
3849
  # Function to generate XML Code Manually
3850 3851 3852 3853 3854
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3855 3856
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872
    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):
3873
    catalog = _getCatalogValue(self)
3874 3875 3876 3877 3878 3879 3880 3881
    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)
3882
      elif not self.is_bt_for_diff:
3883
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
3884
    if len(key_list) > 0:
3885
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
3886 3887

  def _importFile(self, file_name, file):
3888 3889 3890
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3891
    xml = parse(file)
3892 3893
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3894 3895

  def install(self, context, trashbin, **kw):
3896
    catalog = _getCatalogValue(self)
3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923
    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):
3924
    catalog = _getCatalogValue(self)
3925 3926 3927 3928
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
3929
    object_path = kw.get('object_path', None)
3930 3931 3932 3933 3934 3935 3936 3937 3938 3939
    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
3940
  # Function to generate XML Code Manually
3941 3942 3943 3944 3945
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3946 3947
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962
    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):
3963
    catalog = _getCatalogValue(self)
3964 3965 3966 3967 3968 3969 3970 3971
    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)
3972
      elif not self.is_bt_for_diff:
3973
        raise NotFound, 'Multivalue key "%r" not found in catalog' %(key,)
3974
    if len(key_list) > 0:
3975
      self._objects[self.__class__.__name__+'/'+'multivalue_key_list'] = key_list
3976 3977

  def _importFile(self, file_name, file):
3978 3979 3980
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3981
    xml = parse(file)
3982 3983
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3984 3985

  def install(self, context, trashbin, **kw):
3986
    catalog = _getCatalogValue(self)
3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012
    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):
4013
    catalog = _getCatalogValue(self)
4014 4015 4016 4017
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
4018
    object_path = kw.get('object_path', None)
4019 4020 4021 4022 4023 4024 4025 4026 4027 4028
    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
4029
  # Function to generate XML Code Manually
4030 4031 4032 4033 4034
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4035 4036
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051
    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):
4052
    catalog = _getCatalogValue(self)
4053 4054 4055 4056 4057 4058 4059 4060
    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)
4061
      elif not self.is_bt_for_diff:
4062
        raise NotFound, 'Topic key "%r" not found in catalog' %(key,)
4063
    if len(key_list) > 0:
4064
      self._objects[self.__class__.__name__+'/'+'topic_key_list'] = key_list
4065 4066

  def _importFile(self, file_name, file):
4067 4068 4069
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4070
    xml = parse(file)
4071 4072
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4073 4074

  def install(self, context, trashbin, **kw):
4075
    catalog = _getCatalogValue(self)
4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102
    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):
4103
    catalog = _getCatalogValue(self)
4104 4105 4106 4107
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
4108
    object_path = kw.get('object_path', None)
4109 4110 4111 4112 4113 4114 4115 4116 4117 4118
    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
4119
  # Function to generate XML Code Manually
4120 4121 4122 4123 4124
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4125 4126
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137
    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)

4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149
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)
4150
      elif not self.is_bt_for_diff:
4151 4152 4153 4154 4155
        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):
4156 4157 4158
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4159
    xml = parse(file)
4160 4161
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 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 4219 4220 4221 4222 4223 4224 4225 4226 4227

  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)

4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240
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)
4241
      elif not self.is_bt_for_diff:
4242 4243 4244 4245 4246
        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):
4247 4248 4249
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4250
    xml = parse(file)
4251 4252
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 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

  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)
4332
      elif not self.is_bt_for_diff:
4333 4334 4335 4336 4337
        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):
4338 4339 4340
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4341
    xml = parse(file)
4342 4343
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409

  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)

4410 4411 4412 4413
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4414 4415 4416
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4417
      else: # XXX backward compatibility
4418 4419
        lang = lang_key
        catalog = 'erp5_ui'
4420
      path = posixpath.join(lang, catalog)
4421 4422
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4423 4424 4425
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446

  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
          old_obj_code = installed_bt._objects[path]
          if new_obj_code != old_obj_code:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474
  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', {})
4475 4476
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
4477 4478
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4479
          if not force:
4480
            action = update_dict[key]
4481
            if action == 'nothing':
4482
              continue
4483
          lang, catalog = self._splitKey(key)
4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499

          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)
4500 4501
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4502 4503 4504 4505
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4506
            self._importCatalogLanguage(localizer, catalog, lang, po)
4507 4508
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4509
      for lang, catalogs in self._archive.iteritems():
4510 4511 4512
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542
          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)
4543 4544

  def export(self, context, bta, **kw):
4545
    if len(self._objects) == 0:
4546 4547 4548
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
4549
    for key, obj in self._objects.iteritems():
4550 4551
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
4552 4553 4554 4555 4556 4557 4558 4559
      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'))
4560 4561

  def _importFile(self, file_name, file):
4562 4563
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4564 4565
      text = file.read()
      self._objects[file_name[:-3]] = text
4566 4567
    elif name == 'language.xml':
      xml = parse(file)
4568 4569
      name = xml.find('name').text
      code = xml.find('code').text
4570
      self._objects[code] = name
4571

Aurel's avatar
Aurel committed
4572 4573
class LocalRolesTemplateItem(BaseTemplateItem):

4574
  def __init__(self, id_list, **kw):
4575
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4576 4577
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4578 4579 4580
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4581
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4582 4583
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4584
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4585

Christophe Dumez's avatar
Christophe Dumez committed
4586
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4587
  def generateXml(self, path=None):
4588
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4589 4590
    # local roles
    xml_data = '<local_roles_item>'
4591
    xml_data += '\n <local_roles>'
4592
    for key in sorted(local_roles_dict):
4593
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4594 4595
      tuple = local_roles_dict[key]
      for item in tuple:
4596 4597 4598 4599
        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
4600
    return xml_data
4601

Aurel's avatar
Aurel committed
4602 4603 4604 4605 4606 4607 4608 4609
  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)

4610
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4611
      encode_folders = []
4612
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4613
        if '%' not in folder:
4614
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4615 4616
        else:
          encode_folders.append(folder)
4617
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4618 4619 4620 4621
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
4622 4623 4624
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4625 4626
    xml = parse(file)
    # local roles
4627
    local_roles_list = xml.findall('//role')
Aurel's avatar
Aurel committed
4628 4629
    local_roles_dict = {}
    for role in local_roles_list:
4630 4631
      id = role.get('id')
      item_type_list = [item.text for item in role]
Aurel's avatar
Aurel committed
4632
      local_roles_dict[id] = item_type_list
4633
    self._objects['local_roles/%s' % (file_name[:-4],)] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644

  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
4645 4646
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4647
        local_roles_dict = self._objects[roles_path][0]
4648
        setattr(obj, '__ac_local_roles__', local_roles_dict)
4649
        obj.reindexObject()
Aurel's avatar
Aurel committed
4650 4651 4652 4653 4654 4655 4656

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

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

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

    - site property definition
      - id
      - type
4685
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4686

4687 4688
    - document/propertysheet/extension/test definition
      - copy of the local file
4689

4690
    - message transalation definition
4691
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4692

4693 4694
    The Business Template properties are exported to the bt folder with
    one property per file
4695

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4696 4697
    Technology:

4698 4699
    - 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
4700

4701
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4702 4703 4704 4705

    Use case:

    - install core ERP5 (the minimum)
4706

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

4709 4710
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4711
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4712 4713 4714 4715 4716
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4717
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4718 4719 4720

    # Declarative security
    security = ClassSecurityInfo()
4721
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4722 4723 4724 4725

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4726
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4727
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4728
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4729
                      , PropertySheet.BusinessTemplate
4730
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4731 4732
                      )

4733 4734 4735 4736 4737 4738
    # 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."""
4739
         , 'icon'           : 'file_icon.gif'
4740 4741 4742 4743 4744 4745 4746 4747 4748
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4749 4750
    # This is a global variable
    # Order is important for installation
4751 4752 4753 4754 4755 4756
    # 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 )
4757 4758
    _item_name_list = [
      '_product_item',
4759
      '_property_sheet_item',
4760
      '_constraint_item',
4761 4762 4763 4764
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4765
      '_tool_item',
4766 4767 4768 4769
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4770
      '_portal_type_workflow_chain_item',
4771 4772 4773 4774
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4775 4776
      '_category_item',
      '_module_item',
4777
      '_path_item',
4778
      '_skin_item',
4779
      '_registered_skin_selection_item',
4780
      '_preference_item',
4781
      '_action_item',
4782
      '_portal_type_roles_item',
4783
      '_local_roles_item',
4784
      '_catalog_method_item',
4785 4786 4787
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4788
      '_catalog_keyword_key_item',
4789
      '_catalog_datetime_key_item',
4790 4791 4792 4793
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4794
      '_catalog_scriptable_key_item',
4795 4796
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4797 4798 4799 4800
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4801 4802 4803 4804 4805 4806
      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
4807
        self._baseGetTemplateFormatVersion()
4808

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4809 4810 4811
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4812

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4813
      return 0
4814

4815
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4816 4817 4818 4819 4820 4821 4822
    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".
4823 4824
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4825
          # XXX Not good to access the attribute directly,
4826 4827 4828
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4829

4830 4831
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4832 4833 4834 4835 4836 4837
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4838
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4839 4840 4841 4842 4843 4844 4845 4846
        """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)
4847

4848 4849
    security.declareProtected(Permissions.ManagePortal, 'storeTemplateItemData')
    def storeTemplateItemData(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4850
      """
4851
        Instanciate and Store Template items into properties.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4852
      """
4853
      # Store all Data
4854 4855
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4856
      self._portal_type_workflow_chain_item = \
4857
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4858 4859 4860 4861
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4862 4863 4864
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4865 4866 4867 4868 4869 4870
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4871
      self._portal_type_roles_item = \
4872
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4873 4874 4875 4876 4877 4878 4879 4880
      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())
4881 4882
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902
      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())
4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914
      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())
4915 4916
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4917 4918
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4919 4920
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4921
               self.getTemplateCatalogKeywordKeyList())
4922 4923 4924
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4925 4926
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4927
               self.getTemplateCatalogFullTextKeyList())
4928 4929
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4930
               self.getTemplateCatalogRequestKeyList())
4931 4932
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4933
               self.getTemplateCatalogMultivalueKeyList())
4934 4935 4936
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4937 4938
      self._local_roles_item = \
          LocalRolesTemplateItem(
4939
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4940 4941 4942
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4943 4944 4945
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4946 4947 4948 4949 4950 4951
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4952

4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966
    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()

4967 4968
      # Build each part
      for item_name in self._item_name_list:
4969 4970 4971 4972
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4973

4974
    build = WorkflowMethod(build)
4975 4976

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4977
      """
4978
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4979
      """
4980
      return self.portal_templates.publish(self, url, username=username,
4981
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4982

4983
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4984
      """
4985
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4986
      """
4987
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4988

4989 4990 4991 4992 4993
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4994 4995 4996 4997 4998 4999 5000 5001 5002 5003
      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
5004 5005
      return False

5006
    def preinstall(self, check_dependencies=1, **kw):
5007 5008 5009
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
5010
      """
5011 5012 5013 5014 5015
      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()
5016

5017 5018
      modified_object_list = {}
      bt_title = self.getTitle()
5019 5020 5021 5022 5023 5024 5025

      #  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)
5026 5027 5028
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5029
        installed_bt_format = installed_bt.getTemplateFormatVersion()
5030

5031
      # if reinstall business template, must compare to object in ZODB
5032
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
5033
      # same if we make a diff and select only one business template
5034
      reinstall = 0
5035 5036
      if installed_bt == self:
        reinstall = 1
5037
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
5038 5039
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                   id=INSTALLED_BT_FOR_DIFF)
5040 5041 5042 5043 5044 5045 5046
          # 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)
5047

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5048
      new_bt_format = self.getTemplateFormatVersion()
5049 5050 5051 5052 5053 5054
      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:
5055
          item = getattr(self, item_name, None)
5056 5057 5058 5059
          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
5060

5061
      for item_name in self._item_name_list:
5062
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5063
        old_item = getattr(installed_bt, item_name, None)
5064
        if new_item is not None:
5065
          if old_item is not None and hasattr(old_item, '_objects'):
5066 5067
            modified_object = new_item.preinstall(context=self, 
                                                  installed_bt=old_item)
5068 5069 5070 5071 5072 5073 5074
            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:
5075
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5076

5077 5078
      return modified_object_list

5079 5080
    def _install(self, force=1, object_to_update=None, update_translation=0,
                 update_catalog=0, **kw):
5081
      """
Christophe Dumez's avatar
Christophe Dumez committed
5082
        Install a new Business Template, if force, all will be upgraded or installed
5083 5084
        otherwise depends of dict object_to_update
      """
5085 5086 5087 5088
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
5089

5090 5091
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
5092 5093
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5094
        if installed_bt.getTemplateFormatVersion() == 0:
5095
          force = 1
5096
        installed_bt.replace(self)
5097

5098 5099 5100 5101
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

5102 5103 5104
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
5105

5106 5107 5108
      if not force:
        self.checkDependencies()

5109
      site = self.getPortalObject()
5110 5111 5112
      from Products.ERP5.ERP5Site import ERP5Generator
      generator_class = getattr(site, '_generator_class', ERP5Generator)
      gen = generator_class()
5113 5114
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
5115 5116 5117 5118 5119 5120
        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)
5121 5122
      if not force:
        if len(object_to_update) == 0:
5123 5124 5125 5126 5127
          # 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():
5128
            LOG('Business Template', 0, 'Updating Business Template Workflows')
5129
            gen.setupWorkflow(site)
5130
          return
5131

5132 5133
      # 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
5134
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
5135 5136 5137 5138 5139
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
5140
      if len(object_to_update) or force:
5141 5142 5143
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
5144 5145
            item.install(self, force=force, object_to_update=object_to_update, 
                               trashbin=trashbin, installed_bt=installed_bt)
5146

5147
      # update catalog if necessary
5148 5149
      if force and self.isCatalogUpdatable():
        update_catalog = 1
5150
      if update_catalog:
5151
        catalog = _getCatalogValue(self)
5152
        if (catalog is None) or (not site.isIndexable):
5153 5154 5155 5156 5157
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
5158

5159
      # get objects to remove
5160
      # do remove after because we may need backup object from installation
5161
      remove_object_dict = {}
5162 5163
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
5164
          remove_object_dict[path] = action
5165

5166
      # remove object from old business template
5167
      if len(remove_object_dict):
5168
        # XXX: this code assumes that there is an installed_bt
5169
        for item_name in reversed(installed_bt._item_name_list):
5170
          item = getattr(installed_bt, item_name, None)
5171
          if item is not None:
5172
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
5173

5174 5175 5176 5177 5178 5179

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

5180
      # check if we have to update business template workflow
5181
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
5182
        LOG('Business Template', 0, 'Updating Business Template Workflows')
5183 5184 5185 5186 5187
        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)

5188 5189
      # remove trashbin if empty
      if trashbin is not None:
5190
        if len(trashbin) == 0:
5191 5192
          trash_tool.manage_delObjects([trashbin.getId(),])

5193 5194
      if update_catalog:
        site.ERP5Site_reindexAll()
5195

5196 5197
      # Update translation table, in case we added new portal types or
      # workflow states.
5198 5199
      if update_translation:
        site.ERP5Site_updateTranslationTable()
5200

5201 5202
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
5203

5204
    security.declareProtected(Permissions.ManagePortal, 'install')
5205 5206 5207
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
5208
      """
5209
      return self._install(**kw)
5210

5211
    install = WorkflowMethod(install)
5212

5213
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
5214
    def reinstall(self, **kw):
5215 5216 5217 5218
      """Reinstall Business Template.
      """
      return self._install(**kw)

5219
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5220

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

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

5252 5253
    uninstall = WorkflowMethod(uninstall)

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

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

5277
    security.declareProtected(Permissions.AccessContentsInformation,
5278
                              'getBuildingState')
5279
    def getBuildingState(self, default=None, id_only=1):
5280
      """
5281
        Returns the current state in building
5282
      """
5283
      portal_workflow = getToolByName(self, 'portal_workflow')
5284 5285
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
5286
      return wf._getWorkflowStateOf(self, id_only=id_only )
5287

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

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

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

5326
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5327
      """
5328 5329
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5330
      """
5331
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5332

5333
    def getTemplateBaseCategoryList(self):
5334
      """
5335 5336
      We have to set this method because we want an
      ordered list
5337
      """
5338
      return self._getOrderedList('template_base_category')
5339

5340
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5341
      """
5342 5343
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5344
      """
5345
      return self._getOrderedList('template_workflow_id')
5346

5347
    def getTemplatePortalTypeIdList(self):
5348
      """
5349 5350
      We have to set this method because we want an
      ordered list
5351
      """
5352
      return self._getOrderedList('template_portal_type_id')
5353

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

5368 5369 5370 5371 5372 5373 5374
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

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

5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402
    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')

5403
    def getTemplateActionPathList(self):
5404
      """
5405 5406
      We have to set this method because we want an
      ordered list
5407
      """
5408
      return self._getOrderedList('template_action_path')
5409

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

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

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

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

5438
    def getTemplateModuleIdList(self):
5439
      """
5440 5441
      We have to set this method because we want an
      ordered list
5442
      """
5443
      return self._getOrderedList('template_module_id')
5444 5445 5446 5447 5448 5449 5450

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5452 5453 5454 5455 5456 5457 5458
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5459
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5460 5461 5462 5463
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5464
      if self.getBuildingState() != 'built':
5465
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5466
              'Business Template must be built before export'
5467

Aurel's avatar
Aurel committed
5468 5469 5470 5471 5472 5473 5474
      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)

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

Aurel's avatar
Aurel committed
5492 5493 5494
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5495

Aurel's avatar
Aurel committed
5496 5497
      return bta.finishCreation()

5498
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5499 5500
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5501
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5502 5503 5504 5505 5506
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
5507 5508

      self.storeTemplateItemData()
5509

5510 5511
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5512
      orig_module_dict = {}
5513
      instance_oid_list = []
5514 5515
      for template_id in self.getTemplateDocumentIdList():
          module_id = 'Products.ERP5Type.Document.' + template_id
5516
          orig_module_dict[module_id] = sys.modules.get(module_id)
5517 5518 5519 5520 5521 5522 5523 5524 5525 5526
          # 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__
5527

Aurel's avatar
Aurel committed
5528 5529
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5530

5531 5532 5533 5534 5535 5536
      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)
5537 5538
        self._p_jar.cacheMinimize()
        gc.collect()
5539

5540 5541
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5542 5543 5544 5545 5546 5547
      # 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
5548

5549 5550 5551 5552 5553
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5554 5555 5556
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5557
      return items_list
5558

5559 5560 5561 5562 5563 5564 5565 5566 5567 5568
    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:
5569
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5570
          dependency = dependency_couple_list[0]
5571 5572
          if dependency in (None, ''):
            continue
5573 5574
          version_restriction = None
          if len(dependency_couple_list) > 1:
5575
            version_restriction = dependency_couple_list[1]
5576 5577 5578
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5579 5580 5581
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5582
                  or (version_restriction not in (None, '') and
5583 5584 5585 5586
                     (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)
5587

5588 5589 5590 5591 5592 5593 5594 5595
    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
5596
    def diffObject(self, REQUEST, **kw):
5597 5598
      """
        Make a diff between an object in the Business Template
5599
        and the same in the Business Template installed in the site
5600 5601 5602 5603
      """

      class_name_dict = {
        'Product' : '_product_item',
5604
        'PropertySheet' : '_property_sheet_item',
5605
        'Constraint' : '_constraint_item',
5606 5607 5608 5609 5610 5611 5612 5613 5614
        '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',
5615
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5616 5617 5618 5619
        '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',
5620 5621 5622
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5623
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5624
        'Path' : '_path_item',
5625
        'Preference' : '_preference_item',
5626
        'Action' : '_action_item',
5627
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5628
        'LocalRoles' : '_local_roles_item',
5629 5630 5631
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5632
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5633
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5634 5635 5636 5637
        '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
5638
        'Tool': '_tool_item',
5639
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5640 5641
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5642
        }
5643

5644 5645
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5646

Christophe Dumez's avatar
Christophe Dumez committed
5647
      # Get objects
5648
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5649

5650
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
5651
      # Compare with a given business template
5652
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5653 5654
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5655 5656
        if bt2_id == self.getId():
          compare_to_zodb = 1
5657
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5658 5659
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5660 5661 5662
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5663 5664
          compare_to_zodb = 1
      if compare_to_zodb:
5665 5666
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5667
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5668 5669 5670
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5671

5672 5673
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5674
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5675
        # XXX maybe only build for the given object to gain time
5676
        installed_item.build(self)
5677 5678 5679
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5680

Christophe Dumez's avatar
Christophe Dumez committed
5681
      # Real Zope Objects (can be exported into XML directly by Zope)
5682 5683
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5684
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5685
                     '_skin_item', '_action_item', '_tool_item', ]
5686

Christophe Dumez's avatar
Christophe Dumez committed
5687
      # Not considered as objects by Zope (will be exported into XML manually)
5688
      # XXX Bad naming
5689 5690 5691 5692
      item_list_2 = ['_site_property_item',
                     '_module_item',
                     '_catalog_result_key_item', 
                     '_catalog_related_key_item',
5693 5694
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
5695
                     '_catalog_datetime_key_item',
5696 5697 5698 5699
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5700
                     '_catalog_scriptable_key_item',
5701 5702
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5703 5704 5705 5706 5707 5708
                     '_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',
5709
                     '_portal_type_workflow_chain_item',]
5710

Christophe Dumez's avatar
Christophe Dumez committed
5711
      # Text objects (no need to export them into XML)
5712
      # XXX Bad naming
5713 5714
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5715
                     '_test_item', '_message_translation_item',]
5716

5717
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5718 5719 5720
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5721 5722
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
5723
        # XML Export in memory
5724
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5725 5726
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5727
        new_obj_xml = f1.getvalue()
5728
        f1.close()
5729 5730 5731 5732
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5733
        # End of XML export
5734

5735
        # Diff between XML objects
5736 5737
        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
5738
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5739 5740 5741
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5742

5743
      elif item_name in item_list_2:
5744
        # Generate XML code manually
5745 5746
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5747 5748
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5749
        # End of XML Code Generation
5750

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

5759
      elif item_name in item_list_3:
5760
        # Diff between text objects
5761 5762 5763 5764
        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
5765
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5766 5767
          diff_msg += '\n'.join(diff_list)
        else:
5768
          diff_msg = 'No diff'
5769

5770
      else:
5771
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5772

5773
      if compare_to_zodb:
5774
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5775

5776
      return diff_msg
5777

5778

5779 5780 5781 5782
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5783 5784
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5785 5786 5787 5788 5789 5790 5791
      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 [])
5792 5793
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5794
      p = self.getPortalObject()
5795
      for id in bt_portal_types_id_list:
5796 5797
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5798
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5799
        if portal_type.getRoleInformationList():
5800 5801
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5802

5803 5804 5805 5806
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5807
        action_list = []
5808 5809 5810 5811 5812 5813 5814
        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'):
5815
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5816 5817
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5818

5819 5820 5821 5822
        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)
5823

5824
        for h_id in hidden_content_type_list:
5825 5826 5827
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5828

5829 5830 5831 5832
        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)
5833

5834 5835 5836 5837
        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)
5838

5839 5840 5841 5842
        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)
5843

5844
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5845
                                    if chain != '(Default)']:
5846 5847 5848
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5849

5850 5851 5852 5853
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5854
      bt_action_list.sort()
5855
      bt_wf_chain_list.sort()
5856

5857 5858 5859 5860 5861 5862 5863
      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)
5864 5865 5866 5867 5868 5869 5870 5871 5872
      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:
5873 5874
        raise TemplateConditionError, 'No module defined in business template'

5875 5876 5877 5878 5879 5880 5881 5882
      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:
5883
          return type_list
5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897

        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():
5898
            type_list.update(getChildPortalType(hidden_ptype_id))
5899
        return type_list
5900

5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947
      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

5948 5949 5950
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5951
  setattr(BusinessTemplate, key, None)
5952

5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979
# 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)
5980

5981 5982 5983 5984 5985 5986 5987 5988

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

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