BusinessTemplate.py 238 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
Sebastien Robin's avatar
Sebastien Robin committed
34 35
from Acquisition import Implicit, aq_base, aq_inner, aq_parent
from AccessControl import ClassSecurityInfo, Unauthorized, getSecurityManager
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36
from Products.CMFCore.utils import getToolByName
37
from Products.ERP5Type.Accessor.Constant import PropertyGetter as ConstantGetter
38
from Products.ERP5Type.Base import WorkflowMethod, _aq_reset
Nicolas Dumazet's avatar
Nicolas Dumazet committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
from Products.ERP5Type.Utils import readLocalDocument, \
                                    writeLocalDocument, \
                                    importLocalDocument, \
                                    removeLocalDocument
from Products.ERP5Type.Utils import readLocalPropertySheet, \
                                    writeLocalPropertySheet, \
                                    importLocalPropertySheet, \
                                    removeLocalPropertySheet
from Products.ERP5Type.Utils import readLocalConstraint, \
                                    writeLocalConstraint, \
                                    importLocalConstraint, \
                                    removeLocalConstraint
from Products.ERP5Type.Utils import readLocalExtension, \
                                    writeLocalExtension, \
                                    removeLocalExtension
from Products.ERP5Type.Utils import readLocalTest, \
                                    writeLocalTest, \
                                    removeLocalTest
57
from Products.ERP5Type.Utils import convertToUpperCase
58
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
59
from Products.ERP5Type.XMLObject import XMLObject
Aurel's avatar
Aurel committed
60
from OFS.Traversable import NotFound
61
from OFS import SimpleItem, XMLExportImport
62
from cStringIO import StringIO
Aurel's avatar
Aurel committed
63
from copy import deepcopy
64
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
65
import OFS.XMLExportImport
66
from Products.ERP5Type.patches.ppml import importXML
Aurel's avatar
Aurel committed
67
customImporters={
68
    XMLExportImport.magic: importXML,
Aurel's avatar
Aurel committed
69
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
70

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

83 84 85 86 87 88
import threading

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

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

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

108
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'
Sebastien Robin's avatar
Sebastien Robin committed
109
_MARKER = []
110

111 112 113 114 115 116
def _getCatalog(acquisition_context):
  """
    Return the id of the SQLCatalog which correspond to the current BT.
  """
  catalog_method_id_list = acquisition_context.getTemplateCatalogMethodIdList()
  if len(catalog_method_id_list) == 0:
117 118 119 120
    try:
      return acquisition_context.getPortalObject().portal_catalog.objectIds('SQLCatalog')[0]
    except IndexError:
      return None
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
  catalog_method_id = catalog_method_id_list[0]
  return catalog_method_id.split('/')[0]

def _getCatalogValue(acquisition_context):
  """
    Returns the catalog object which correspond to the ZSQLMethods
    stored/to store in the business template.

    NB: acquisition_context must make possible to reach portal object
        and getTemplateCatalogMethodIdList.
  """
  catalog_id = _getCatalog(acquisition_context)
  if catalog_id is None:
    return None
  try:
    return acquisition_context.getPortalObject().portal_catalog[catalog_id]
  except KeyError:
    return None

140 141 142 143 144
def _recursiveRemoveUid(obj):
  """Recusivly set uid to None, to prevent (un)indexing.
  This is used to prevent unindexing real objects when we delete subobjects on
  a copy of this object.
  """
145 146
  if hasattr(aq_base(obj), 'uid'):
    obj.uid = None
147 148 149
  for subobj in obj.objectValues():
    _recursiveRemoveUid(subobj)

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

155 156 157 158 159 160 161
def getChainByType(context):
  """
  This is used in order to construct the full list
  of mapping between type and list of workflow associated
  This is only useful in order to use
  portal_workflow.manage_changeWorkflows
  """
162
  pw = context.getPortalObject().portal_workflow
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
  cbt = pw._chains_by_type
  ti = pw._listTypeInfo()
  types_info = []
  for t in ti:
    id = t.getId()
    title = t.Title()
    if title == id:
      title = None
    if cbt is not None and cbt.has_key(id):
      chain = ', '.join(cbt[id])
    else:
      chain = '(Default)'
    types_info.append({'id': id,
                      'title': title,
                      'chain': chain})
  new_dict = {}
  for item in types_info:
    new_dict['chain_%s' % item['id']] = item['chain']
  default_chain=', '.join(pw._default_chain)
  return (default_chain, new_dict)

184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
def fixZSQLMethod(portal, method):
  """Make sure the ZSQLMethod uses a valid connection.
  """
  if not isinstance(getattr(portal, method.connection_id, None),
                      RDBConnection):
    # if not valid, we assign to the first valid connection found
    sql_connection_list = portal.objectIds(
                          spec=('Z MySQL Database Connection',))
    if (method.connection_id not in sql_connection_list) and \
       (len(sql_connection_list) != 0):
      LOG('BusinessTemplate', WARNING,
          'connection_id for Z SQL Method %s is invalid, using %s' % (
                    method.getId(), sql_connection_list[0]))
      method.connection_id = sql_connection_list[0]

199 200
def registerSkinFolder(skin_tool, skin_folder):
  request = skin_tool.REQUEST
201 202 203
  # XXX: Getting parameter from request instead of dialog is bad
  # XXX: This is even non consistent with rest of parameters selected by user
  #      (like update_translation or update_catalog)
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
  register_skin_selection = request.get('your_register_skin_selection', 1)
  reorder_skin_selection = request.get('your_reorder_skin_selection', 1)
  skin_layer_list = request.get('your_skin_layer_list', 
                                skin_tool.getSkinSelections()) 

  skin_folder_id = skin_folder.getId()

  try:
    skin_selection_list = skin_folder.getProperty(
                 'business_template_registered_skin_selections', 
                 skin_tool.getSkinSelections()
                 )
  except AttributeError:
    skin_selection_list = skin_tool.getSkinSelections()

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

Sebastien Robin's avatar
Sebastien Robin committed
222 223 224 225 226 227 228
  def skin_sort_key(skin_folder_id):
    obj = skin_tool._getOb(skin_folder_id, None)
    if obj is None:
      return 0, skin_folder_id
    return -obj.getProperty('business_template_skin_layer_priority',
      obj.meta_type == 'Filesystem Directory View' and -1 or 0), skin_folder_id

229 230 231 232 233 234 235 236 237
  for skin_name in skin_selection_list:

    if (skin_name not in skin_tool.getSkinSelections()) and \
                                          register_skin_selection:
      createSkinSelection(skin_tool, skin_name)
      # add newly created skins to list of skins we care for 
      skin_layer_list.append(skin_name)

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

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

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

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

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

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

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

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

  def __init__(self, creation=0, importing=0, file=None, path=None, **kw):
    if creation:
      self._initCreation(path=path, **kw)
    elif importing:
      self._initImport(file=file, path=path, **kw)

  def addFolder(self, **kw):
    pass

  def addObject(self, *kw):
    pass
320

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

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

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

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

  def _initImport(self, file=None, path=None, **kw):
365
    # Normalize the paths to eliminate the effect of double-slashes.
366 367 368 369 370 371 372 373
    root_path_len = len(os.path.normpath(path)) + len(os.sep)
    self.root_path_len = root_path_len
    d = {}
    for f in file:
      f = os.path.normpath(f)
      klass = f[root_path_len:].split(os.sep, 1)[0]
      d.setdefault(klass, []).append(f)
    self.file_list_dict = d
Aurel's avatar
Aurel committed
374

375
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
376 377 378
    """
      Import file from a local folder
    """
379
    class_name = item.__class__.__name__
380 381
    root_path_len = self.root_path_len
    prefix_len = root_path_len + len(class_name) + len(os.sep)
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
    if CACHE_DATABASE_PATH:
      try:
        cache_database.db = gdbm.open(CACHE_DATABASE_PATH, 'cf')
      except gdbm.error:
        cache_database.db = gdbm.open(CACHE_DATABASE_PATH, 'nf')
    try:
      for file_path in self.file_list_dict.get(class_name, ()):
        if os.path.isfile(file_path):
          file = open(file_path, 'rb')
          try:
            file_name = file_path[prefix_len:]
            if '%' in file_name:
              file_name = unquote(file_name)
            item._importFile(file_name, file)
          finally:
            file.close()
    finally:
      if hasattr(cache_database, 'db'):
        cache_database.db.close()
        del cache_database.db
402

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

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

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

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

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

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

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

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

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

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

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

504
  def preinstall(self, context, installed_item, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
505 506
    """
      Build a list of added/removed/changed files between the BusinessTemplate
507
      being installed (self) and the installed one (installed_item).
Vincent Pelletier's avatar
Vincent Pelletier committed
508 509 510 511 512
      Note : we compare files between BTs, *not* between the installed BT and
      the objects in the DataFS.

      XXX: -12 used here is -len('TemplateItem')
    """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
513 514
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
515
      new_keys = self._objects.keys()
516
      for path in new_keys:
517
        if installed_item._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
518
          # compare objects to see it there are changes
519
          new_obj_xml = self.generateXml(path=path)
520
          old_obj_xml = installed_item.generateXml(path=path)
521 522
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
523
          # else, compared versions are identical, don't overwrite the old one
524 525
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
526
      # list removed objects
527
      old_keys = installed_item._objects.keys()
528 529 530 531 532 533
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
534
    pass
535 536 537

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

539
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
540 541 542 543 544 545
    """
      If 'remove' is chosen on an object containing subobjects, all the
      subobjects will be removed too, even if 'backup' or 'keep' was chosen for
      the subobjects.
      Likewise, for 'save_and_remove' : subobjects will get saved too.
    """
546 547 548
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
549
    keys.reverse()
550 551 552 553 554 555 556 557 558 559 560
    # if you choose remove, the object and all its subobjects will be removed
    # even if you choose backup or keep for subobjects
    # it is same behaviour for backup_and_remove, all we be save
    for path in keys:
      if remove_dict.has_key(path):
        action = remove_dict[path]
        if action == 'save_and_remove':
          # like trash
          self.uninstall(context, trash=1, object_path=path, **kw)
        elif action == 'remove':
          self.uninstall(context, trash=0, object_path=path, **kw)
561 562 563 564
        else:
          # As the list of available actions is not strictly defined,
          # prevent mistake if an action is not handled
          raise ValueError, 'Unknown action "%s"' % action
565

566

567 568 569 570
  def trash(self, context, new_item, **kw):
    # trash is quite similar to uninstall.
    return self.uninstall(context, new_item=new_item, trash=1, **kw)

Aurel's avatar
Aurel committed
571
  def export(self, context, bta, **kw):
572
    pass
Aurel's avatar
Aurel committed
573

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

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

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

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

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

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

607 608 609 610 611 612 613 614 615
  def getTemplateTypeName(self):
    """
     Get a meaningfull class Name without 'TemplateItem'. Used to 
     present to the user.

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

Sebastien Robin's avatar
Sebastien Robin committed
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
  def restrictedResolveValue(self, context=None, path=None, default=_MARKER):
    """
      Get the value with checking the security.
      This method does not acquire the parent.
    """
    def restrictedGetItem(container, key, default):
      validate = getSecurityManager().validate
      try:
        value = container[key]
      except KeyError:
        if default is not _MARKER:
          return default
        return None
      if value is not None:
        try:
          if not validate(container, container, key, value):
            raise Unauthorized('unauthorized access to element %s' % key)
        except Unauthorized:
          # if user can't access object try to return default passed
          if default is not _MARKER:
            return default
          raise
      return value
    return self._resolveValue(context, path, default, getItem=restrictedGetItem)

  def unrestrictedResolveValue(self, context=None, path=None, default=_MARKER):
    """
      Get the value without checking the security.
      This method does not acquire the parent.
    """
    def unrestrictedGetItem(container, key, default):
      try:
        return container[key]
      except KeyError:
        if default is not _MARKER:
          return default
        else:
          return None
    return self._resolveValue(context, path, default, getItem=unrestrictedGetItem)

  def _resolveValue(self, context, path, default=_MARKER, getItem=None):
    """
    Resolve the value without acquire the parent.
    """
    if isinstance(path, basestring):
      stack = path.split('/')
    else:
      stack = list(path)
    stack.reverse()
    value = None
    if stack:
      portal = aq_inner(self.getPortalObject())
      # It can be passed with the context, so at first, searching from the context.
      if context is None:
        container = portal
      else:
        container = context
      key = stack.pop()
      value = getItem(container, key, default)

      # resolve the value from top to down
      while value is not None and stack:
        key = stack.pop()
        value = getItem(value, key, default)
    else:
      # When relative_url is empty, returns the context
      return context

684
    __traceback_info__ = (container, key)
Sebastien Robin's avatar
Sebastien Robin committed
685 686 687 688 689
    if value is None:
      LOG('BusinessTemplate', WARNING,
          'Could not access object %s' % path)
      if default is not _MARKER:
        return default
690
      raise KeyError, key
Sebastien Robin's avatar
Sebastien Robin committed
691 692 693
    return value


694 695 696
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
697
  """
698

699 700 701 702
  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()
703
      self._archive.clear()
704 705 706
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
707

708
  def export(self, context, bta, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
709 710 711 712
    """
      Export the business template : fill the BusinessTemplateArchive with
      objects exported as XML, hierarchicaly organised.
    """
713 714 715
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
Vincent Pelletier's avatar
Vincent Pelletier committed
716
    for key, obj in self._objects.iteritems():
717
      # create folder and subfolders
718
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
719 720 721
      encode_folders = []
      for folder in folders.split('/'):
        if '%' not in folder:
722
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
723 724 725
        else:
          encode_folders.append(folder)
      path = os.path.join(root_path, (os.sep).join(encode_folders))
726 727
      bta.addFolder(name=path)
      # export object in xml
728
      f = StringIO()
729 730
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
731

Aurel's avatar
Aurel committed
732
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
733
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
734 735 736
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
737
      relative_url = '/'.join([url,id])
738 739
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
740
      obj = self.removeProperties(obj)
Vincent Pelletier's avatar
Vincent Pelletier committed
741 742 743
      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
744
        groups = deepcopy(obj.groups)
745
      if id_list:
Aurel's avatar
Aurel committed
746
        self.build_sub_objects(context, id_list, relative_url)
747
        for id_ in list(id_list):
748
          obj._delObject(id_)
749
      if hasattr(aq_base(obj), 'groups'):
750 751 752
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
753 754
    return sub_list

755 756 757 758
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
759 760 761 762
      try:
        obj = p.unrestrictedTraverse(relative_url)
      except ValueError:
        raise ValueError, "Can not access to %s" % relative_url
763 764 765 766
      try:
        obj = obj._getCopy(context)
      except AttributeError:
        raise AttributeError, "Could not find object '%s' during business template processing." % relative_url
767
      _recursiveRemoveUid(obj)
768
      obj = self.removeProperties(obj)
769
      id_list = obj.objectIds()
Vincent Pelletier's avatar
Vincent Pelletier committed
770 771
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
772
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
773 774
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
775
        for id_ in list(id_list):
776
          obj._delObject(id_)
777
      if hasattr(aq_base(obj), 'groups'):
778 779 780
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
781

782
  def _compileXML(self, file):
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
    # 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
842

843
  def _importFile(self, file_name, file_obj):
844
    # import xml file
845
    if not file_name.endswith('.xml'):
846
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
847
      return
848 849 850 851 852
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
853
    __traceback_info__ = 'Importing %s' % file_name
854 855
    if hasattr(cache_database, 'db') and isinstance(file_obj, file):
      obj = connection.importFile(self._compileXML(file_obj))
856
    else:
857 858
      # FIXME: Why not use the importXML function directly? Are there any BT5s
      # with actual .zexp files on the wild?
859
      obj = connection.importFile(file_obj, customImporters=customImporters)
860
    self.removeProperties(obj)
861 862
    self._objects[file_name[:-4]] = obj

863
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
864 865
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
866 867 868
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
      for path in self._objects:
869
        if installed_item._objects.has_key(path):
Julien Muchembled's avatar
Julien Muchembled committed
870
          upgrade_list.append((path,
871
            self.removeProperties(installed_item._objects[path])))
872
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
873 874 875 876 877 878 879 880 881 882
          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()
883 884 885 886 887
        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
888 889 890 891
        new_io.close()
        old_io.close()
        if new_obj_xml != old_obj_xml:
          modified_object_list[path] = 'Modified', type_name
892
      # get removed object
893
      for path in set(installed_item._objects) - set(self._objects):
Julien Muchembled's avatar
Julien Muchembled committed
894
        modified_object_list[path] = 'Removed', type_name
895 896
    return modified_object_list

897
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
898 899 900
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
901
    subobjects_dict = {}
902
    if trashbin is None: # must return subobjects
903 904 905 906 907 908
      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)
909
        subobjects_dict[subobject_id] = subobject_copy
910
      return subobjects_dict
911
    # XXX btsave is for backward compatibility
912
    if action == 'backup' or action == 'btsave' or action == 'save_and_remove':
913 914 915
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=1, **kw)
916
    elif action == 'install':
917 918 919
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=0, **kw)
920 921 922 923
    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
924
    return subobjects_dict
925

926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
  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

Sebastien Robin's avatar
Sebastien Robin committed
942
  def onNewObject(self, obj):
943 944 945 946
    """
      Installation hook.
      Called when installation process determined that object to install is
      new on current site (it's not replacing an existing object).
Sebastien Robin's avatar
Sebastien Robin committed
947
      `obj` parameter is the newly created object in its acquisition context.
948 949 950 951
      Can be overridden by subclasses.
    """
    pass

952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
  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

969
  def install(self, context, trashbin, **kw):
970
    self.beforeInstall()
971 972
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
973
    if context.getTemplateFormatVersion() == 1:
974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
      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
993
      groups = {}
994
      old_groups = {}
995 996 997 998
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
999 1000
      # set safe activities execution order
      original_reindex_parameters = self.setSafeReindexationMode(context)
1001
      for path in keys:
1002 1003
        if update_dict.has_key(path) or force:
          # get action for the oject
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1004
          action = 'backup'
1005 1006 1007 1008 1009
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          # get subobjects in path
1010 1011 1012
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
1013
          try:
Sebastien Robin's avatar
Sebastien Robin committed
1014
            container = self.unrestrictedResolveValue(portal, container_path)
1015 1016
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1017
            container_url = '/'.join(container_path)
1018 1019 1020 1021
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
1022
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
1023 1024
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
1025
              container_container = portal.unrestrictedTraverse(container_path[:-1])
1026 1027 1028 1029 1030
              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)
1031 1032
            else:
              raise
1033
          saved_uid_dict = {}
1034
          subobjects_dict = {}
Julien Muchembled's avatar
Julien Muchembled committed
1035
          portal_type_dict = {}
1036
          old_obj = container._getOb(object_id, None)
Sebastien Robin's avatar
Sebastien Robin committed
1037
          object_existed = old_obj is not None
1038
          if old_obj is not None:
Sebastien Robin's avatar
Sebastien Robin committed
1039
            # Object already exists
1040
            recurse(saveHook, old_obj)
1041
            if getattr(aq_base(old_obj), 'groups', None) is not None:
1042 1043 1044 1045 1046
              # 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)
1047
            subobjects_dict = self._backupObject(action, trashbin,
1048
                                                 container_path, object_id)
Julien Muchembled's avatar
Julien Muchembled committed
1049
            # in case of portal types, we want to keep some properties
1050
            if getattr(old_obj, 'meta_type', None) == 'ERP5 Base Type':
1051
              for attr in ('allowed_content_types',
Julien Muchembled's avatar
Julien Muchembled committed
1052 1053 1054 1055 1056 1057
                           '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, '')
1058
            container.manage_delObjects([object_id])
Sebastien Robin's avatar
Sebastien Robin committed
1059

1060
          # install object
1061
          obj = self._objects[path]
1062 1063 1064
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1065
          if getattr(aq_base(obj), 'groups', None) is not None:
1066
            # we must keep original order groups
1067
            # because they change when we add subobjects
1068
            groups[path] = deepcopy(obj.groups)
1069
          # copy the object
1070 1071 1072 1073 1074 1075 1076
          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
1077
                'Cleaning corrupted BTreeFolder2 object at %r.' % (path,))
1078
            obj._initBTrees()
1079
          obj = obj._getCopy(container)
1080 1081 1082 1083 1084
          try:
            container._setObject(object_id, obj)
          except AttributeError:
            LOG("BT, install", 0, object_id)
            raise
1085
          obj = container._getOb(object_id)
Sebastien Robin's avatar
Sebastien Robin committed
1086 1087 1088 1089 1090

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

1091 1092
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
1093
          self.REQUEST.set('is_business_template_installation', 1)
1094 1095 1096 1097
          # 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
1098
          obj.isIndexable = ConstantGetter('isIndexable', value=False)
1099
          obj.manage_afterClone(obj)
1100 1101 1102
          del obj.isIndexable
          if getattr(aq_base(obj), 'reindexObject', None) is not None:
            obj.reindexObject()
1103
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
1104
          if portal_type_dict:
1105
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
1106
            wf_chain = portal_type_dict.pop('workflow_chain')
1107 1108
            chain_dict = getChainByType(context)[1]
            default_chain = ''
1109
            chain_dict['chain_%s' % (object_id)] = wf_chain
1110
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
1111 1112
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
1113
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
1114
          if subobjects_dict:
1115
            # get a jar
1116 1117
            connection = obj._p_jar
            o = obj
1118
            while connection is None:
1119 1120
              o = o.aq_parent
              connection = o._p_jar
1121
            # import subobjects
1122
            for subobject_id, subobject_data in subobjects_dict.iteritems():
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
              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))
1134
          if obj.meta_type in ('Z SQL Method',):
1135
            fixZSQLMethod(portal, obj)
1136 1137 1138
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
1139 1140 1141
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
1142
          elif obj.meta_type in ('ERP5 Ram Cache',
1143
                                 'ERP5 Distributed Ram Cache',):
1144 1145
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
1146 1147
          elif (container.meta_type == 'CMF Skins Tool') and \
              (old_obj is not None):
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
            # 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')
1162 1163 1164 1165 1166 1167 1168 1169
          # in case the portal ids, we want keep the property dict
          elif interfaces.IIdGenerator.providedBy(obj) and \
            old_obj is not None:
            for dict_name in ('last_max_id_dict', 'last_id_dict'):
              # Keep previous last id dict
              if getattr(old_obj, dict_name, None) is not None:
                old_dict = getattr(old_obj, dict_name, None)
                setattr(obj, dict_name, old_dict)
1170

1171
          recurse(restoreHook, obj)
1172
      # now put original order group
1173 1174
      # we remove object not added in forms
      # we put old objects we have kept
1175
      for path, new_groups_dict in groups.iteritems():
1176 1177 1178 1179 1180 1181 1182 1183 1184
        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
1185
          # excetp the one that had to be removed
1186 1187 1188 1189
          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'):
1190 1191
              continue
            widget_in_form = 0
1192 1193
            for group_id, group_value_list in new_groups_dict.iteritems():
              if widget_id in group_value_list:
1194 1195 1196 1197 1198 1199
                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:
1200
              for old_group_id, old_group_values in old_groups_dict.iteritems():
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
                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,]
1212
                  obj.group_list = list(obj.group_list) + ['not_assigned']
1213
          # second check all widget_id in order are in form
1214 1215
          for group_id, group_value_list in new_groups_dict.iteritems():
            for widget_id in tuple(group_value_list):
1216 1217 1218
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
1219
                group_value_list.remove(widget_id)
1220
          # now set new group object
1221
          obj.groups = new_groups_dict
1222
      # restore previous activities execution order
1223
      context.setPlacelessDefaultReindexParameters(**original_reindex_parameters)
1224
      # Do not forget to delete all remaining objects if asked by user
1225 1226 1227 1228 1229 1230
      # Fetch all sub objects path recursively
      recursive_path_list = []
      def fillRecursivePathList(from_path_list):
        for from_path in from_path_list:
          container = portal.unrestrictedTraverse(from_path, None)
          if container is not None:
1231 1232
            if from_path in recursive_path_list:
              continue
1233 1234 1235 1236 1237 1238
            recursive_path_list.append(from_path)
            # Check that container support iteration of sub_content_id
            if getattr(aq_base(container), 'objectIds', None) is not None:
              fillRecursivePathList(['%s/%s' % (from_path, sub_content_id) for\
                                        sub_content_id in container.objectIds()])
      fillRecursivePathList(self._objects.keys())
1239 1240 1241 1242
      for recursive_path in recursive_path_list:
        if recursive_path in update_dict:
          action = update_dict[recursive_path]
          if action in ('remove', 'save_and_remove'):
Sebastien Robin's avatar
Sebastien Robin committed
1243
            document = self.restrictedResolveValue(portal, recursive_path, None)
1244 1245 1246
            if document is None:
              # It happens if the parent of target path is removed before
              continue
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
            if getattr(aq_base(document), 'getParentValue', None) is not None:
              # regular ERP5 object
              parent = document.getParentValue()
            else:
              parent = document.aq_parent
            document_id = document.getId()
            container_path_list = recursive_path.split('/')[:-1]
            self._backupObject(action, trashbin, container_path_list,
                               document_id)
            parent.manage_delObjects([document_id])
Aurel's avatar
Aurel committed
1257
    else:
1258 1259
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1260
      portal = context.getPortalObject()
1261
      for relative_url in self._archive.keys():
1262
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
1263 1264 1265 1266
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
1267
        if object_id in container_ids:    # Object already exists
1268
          self._backupObject('backup', trashbin, container_path, object_id)
1269
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
1270
        # Set a hard link
1271 1272 1273 1274 1275 1276
        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',):
1277
          fixZSQLMethod(portal, obj)
1278
    self.afterInstall()
1279 1280 1281

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
1282
    trash = kw.get('trash', 0)
1283 1284 1285 1286 1287
    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
1288
      object_keys = self._archive.keys()
1289
    for relative_url in object_keys:
1290 1291
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
1292
      try:
Sebastien Robin's avatar
Sebastien Robin committed
1293
        container = self.unrestrictedResolveValue(portal, container_path)
1294
        object = container._getOb(object_id) # We force access to the object to be sure
1295 1296
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
1297
        if trash and trashbin is not None:
1298
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
1299
        if container.meta_type == 'CMF Skins Tool':
1300 1301
          # we are removing a skin folder, check and 
          # remove if registered skin selection
1302
          skin_folder = container[object_id]
1303 1304 1305
          unregisterSkinFolder(container, skin_folder,
              container.getSkinSelections())

1306
        container.manage_delObjects([object_id])
1307
        if container.aq_parent.meta_type == 'ERP5 Catalog' and not len(container):
1308
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1309
          container.getParentValue().manage_delObjects([container.id])
1310
      except (NotFound, KeyError, BadRequest, AttributeError):
1311
        # object is already backup and/or removed
1312
        pass
1313 1314
    BaseTemplateItem.uninstall(self, context, **kw)

1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
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

1327 1328 1329 1330 1331 1332 1333 1334 1335
  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()
1336 1337
    object_keys.sort()
    object_keys.reverse()
1338 1339
    p = context.getPortalObject()
    for path in object_keys:
1340 1341 1342 1343 1344
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1345 1346 1347
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1348
        try:
Aurel's avatar
Aurel committed
1349 1350
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
Sebastien Robin's avatar
Sebastien Robin committed
1351
          container = self.unrestrictedResolveValue(portal, container_path)
1352
          if trash and trashbin is not None:
1353 1354
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1355
                                           keep_subobjects=1)
1356 1357 1358 1359 1360 1361
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1362 1363 1364
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1365

1366 1367 1368 1369 1370 1371 1372 1373 1374
      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.
1375 1376 1377
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1378
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1379 1380
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1381
      if object_id != "":
1382
        path_list.extend(self._resolvePath(
1383
            folder._getOb(object_id),
1384
            relative_url_list + [object_id], id_list[1:]))
1385
    return path_list
Aurel's avatar
Aurel committed
1386

1387 1388 1389
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1390
    keys = self._path_archive.keys()
1391
    keys.sort()
Aurel's avatar
Aurel committed
1392
    for path in keys:
1393 1394 1395
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
1396
      for relative_url in self._resolvePath(p, [], path.split('/')):
1397 1398
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1399
        obj = obj.__of__(context)
1400
        _recursiveRemoveUid(obj)
1401
        id_list = obj.objectIds()
1402
        obj = self.removeProperties(obj)
1403
        if hasattr(aq_base(obj), 'groups'):
1404
          # we must keep groups because it's ereased when we delete subobjects
1405
          groups = deepcopy(obj.groups)
1406
        if len(id_list) > 0:
1407 1408
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1409
          for id_ in list(id_list):
1410
            obj._delObject(id_)
1411
        if hasattr(aq_base(obj), 'groups'):
1412 1413 1414
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1415

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1416 1417 1418 1419 1420 1421 1422 1423
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)

Sebastien Robin's avatar
Sebastien Robin committed
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
  def install(self, context, trashbin, **kw):
    """ When we install a tool that is a type provider not
    registered on types tool, register it into the type provider.
    """
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    for type_container_id, obj in self._objects.iteritems():
      if interfaces.ITypeProvider.providedBy(obj) and \
          type_container_id not in types_tool.type_provider_list:
        types_tool.type_provider_list = tuple(types_tool.type_provider_list) + \
                                        (type_container_id,)

  def uninstall(self, context, **kw):
    """ When we uninstall a tool, unregister it from the type provider. """
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._path_archive.keys()
    for tool_id in object_keys:
      types_tool.type_provider_list = tuple([ \
        x for x in types_tool.type_provider_list \
        if x != tool_id])
    PathTemplateItem.uninstall(self, context, **kw)

  def remove(self, context, **kw):
    """ When we remove a tool, unregister it from the type provider. """
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    for tool_id in keys:
      if remove_dict.has_key(tool_id):
        action = remove_dict[tool_id]
        if 'remove' in action:
          types_tool.type_provider_list = tuple([ \
            x for x in types_tool.type_provider_list \
            if x != tool_id])
    PathTemplateItem.remove(self, context, **kw)

1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
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")
1482
    if len(id_list) != 1:
1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494
      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():
1495
      pref = portal.unrestrictedTraverse(object_path)
1496
      # XXX getPreferenceState is a bad name
1497
      if pref.getPreferenceState() == 'disabled':
1498 1499
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1500 1501
        portal.portal_workflow.doActionFor(
                      pref,
1502 1503 1504
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1505 1506
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1507

1508 1509
class CategoryTemplateItem(ObjectTemplateItem):

1510 1511
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1512

1513 1514 1515 1516
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1517 1518
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1519
      obj = self.removeProperties(obj)
1520
      id_list = obj.objectIds()
1521
      if id_list:
1522
        self.build_sub_objects(context, id_list, relative_url)
1523
        for id_ in list(id_list):
1524
          obj._delObject(id_)
1525 1526
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1527 1528 1529 1530 1531

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1532 1533
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1534
      _recursiveRemoveUid(obj)
1535
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1536
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1537
      id_list = obj.objectIds()
1538 1539
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1540
        for id_ in list(id_list):
1541
          obj._delObject(id_)
1542
      else:
1543
        for id_ in list(id_list):
1544
          obj._delObject(id_)
1545 1546
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1547

1548 1549 1550
  def beforeInstall(self):
    self._installed_new_category = False

Sebastien Robin's avatar
Sebastien Robin committed
1551
  def onNewObject(self, obj):
1552 1553 1554 1555
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1556 1557
      # reset accessors if we installed a new category
      _aq_reset()
1558

1559 1560
class SkinTemplateItem(ObjectTemplateItem):

1561 1562
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1563

1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
  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')

1574 1575
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
    # 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

1589
  def install(self, context, trashbin, **kw):
1590
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1591 1592
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1593
    p = context.getPortalObject()
1594
    skin_tool = p.portal_skins
1595 1596
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1597
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1598 1599
        fixZSQLMethod(p, obj)

1600
      # Do not register skin which were explicitely ask not to be installed
1601 1602 1603 1604 1605
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621
      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',
          [])
1622 1623 1624
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1625
      if skin_selection_id in selection_list:
1626
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1627
      else:
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
        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):
1647
    if not self._objects:
1648 1649 1650 1651
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
1652 1653 1654
    bta.addObject(obj=self.generateXml(), 
                  name='registered_skin_selection',  
                  path=root_path)
1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669

  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]
1670 1671 1672
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1673

1674
        if selection_list is default_value:
1675
          create_property = True
1676
          selection_list = self._objects[skin_folder_id]
1677
        else:
1678
          create_property = False
1679 1680 1681 1682 1683
          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])
1684 1685

        # Remove duplicate
1686
        selection_list = list(set(selection_list))
1687 1688 1689
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
1690
              selection_list, type='tokens')
1691 1692 1693
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
1694
              selection_list)
1695 1696

        unregisterSkinFolder(skin_tool, skin_folder,
1697
                             skin_tool.getSkinSelections())
1698
        registerSkinFolder(skin_tool, skin_folder)
1699 1700

  def uninstall(self, context, **kw):
1701 1702 1703
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1704 1705 1706 1707
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1708 1709 1710 1711
      object_keys = self._objects.keys()

    for skin_folder_id in object_keys:
      skin_folder = skin_tool[skin_folder_id]
1712
      current_selection_list = skin_folder.getProperty(
1713
        'business_template_registered_skin_selections', [])
1714
      current_selection_set = set(current_selection_list)
1715

1716 1717 1718
      skin_selection_list = workflow_id = self._objects[skin_folder_id]
      if isinstance(skin_selection_list, str):
        skin_selection_list = skin_selection_list.replace(',', ' ').split(' ')
1719 1720 1721 1722 1723
      for skin_selection in skin_selection_list:
        current_selection_set.remove(skin_selection)

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1724
        skin_folder._updateProperty(
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
            '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)

1739
  def preinstall(self, context, installed_item, **kw):
1740 1741 1742 1743 1744
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      for path in new_keys:
1745
        if installed_item._objects.has_key(path):
1746 1747
          # compare object to see it there is changes
          new_object = self._objects[path]
1748
          old_object = installed_item._objects[path]
1749 1750 1751 1752 1753
          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
1754
      old_keys = installed_item._objects.keys()
1755 1756 1757 1758 1759 1760 1761
      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'):
1762
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1763 1764 1765 1766
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
1767 1768 1769
    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
1770 1771
      if not selection_string:
        selection_list = []
1772
      else:
1773 1774
        selection_list = selection_string.split(',')
      skin_selection_dict[skin_folder_id] = selection_list
1775
    self._objects = skin_selection_dict
1776 1777


1778
class WorkflowTemplateItem(ObjectTemplateItem):
1779

1780 1781
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1782

1783 1784 1785 1786 1787
  # 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.

1788
  def preinstall(self, context, installed_item, installed_bt, **kw):
1789
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
1790
                                                         installed_item, **kw)
1791 1792 1793 1794
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1795
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1796 1797
      else:
        modified_workflow_dict[modified_object] = state
1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819
    removed_workflow_id_list = [x[0].split('/', 1)[1] \
                                for x in modified_workflow_dict.iteritems() \
                                if x[1][0] == 'Removed']
    if len(removed_workflow_id_list) > 0:
      installed_chain_list = [[y.strip() for y in x.split('|')] for x in \
                                installed_bt.getTemplatePortalTypeWorkflowChainList()]
      new_chain_list = [[y.strip() for y in x.split('|')] for x in \
                          context.getTemplatePortalTypeWorkflowChainList()]
      chain_dict = getChainByType(context)[1]
      for workflow_id in removed_workflow_id_list:
        affected_portal_type_set = set([x[0][6:] for x in \
                                        chain_dict.iteritems() \
                                        if workflow_id in \
                                        [y.strip() for y in x[1].split(',')]])
        safe_portal_type_set = set([x[0] for x in installed_chain_list \
                                    if x[1] == workflow_id]) - \
                               set([x[0] for x in new_chain_list \
                                    if x[1] == workflow_id])
        if affected_portal_type_set - safe_portal_type_set:
          value = modified_workflow_dict['portal_workflow/%s' % workflow_id]
          modified_workflow_dict['portal_workflow/%s' % workflow_id] = \
              ('Removed but used', value[1])
1820 1821
    return modified_workflow_dict

1822
  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1823
    if context.getTemplateFormatVersion() == 1:
1824 1825 1826
      portal = context.getPortalObject()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
Julien Muchembled's avatar
Julien Muchembled committed
1827 1828 1829
      # sort to add objects before their subobjects
      for path in sorted(self._objects):
          if force:
1830
            action = 'backup'
Julien Muchembled's avatar
Julien Muchembled committed
1831
          else:
1832
            action = update_dict.get('/'.join(path.split('/')[:2]))
Julien Muchembled's avatar
Julien Muchembled committed
1833 1834
            if action in (None, 'nothing'):
              continue
1835 1836 1837
          container_path = path.split('/')[:-1]
          object_id = path.split('/')[-1]
          try:
Sebastien Robin's avatar
Sebastien Robin committed
1838
            container = self.unrestrictedResolveValue(portal, container_path)
1839 1840
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1841
            container_url = '/'.join(container_path)
1842 1843 1844 1845 1846 1847
            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
1848
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1849
            container.manage_delObjects([object_id])
1850
          obj = self._objects[path]
1851 1852 1853
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1854 1855 1856 1857 1858
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1859 1860 1861
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)

1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876
  def uninstall(self, context, **kw):
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    removed_workflow_id_list = set([x.split('/', 1)[1] for x in object_keys])
    (default_chain, chain_dict) = getChainByType(context)
    for portal_type, workflow_ids in chain_dict.iteritems():
      workflow_ids = set([x.strip() for x in workflow_ids.split(',')]) - \
                     removed_workflow_id_list
      chain_dict[portal_type] = ', '.join(workflow_ids)
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
    ObjectTemplateItem.uninstall(self, context, **kw)
1877

1878 1879
class PortalTypeTemplateItem(ObjectTemplateItem):

1880 1881
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1882 1883
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1884 1885 1886
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1887 1888
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1889
      obj = p.unrestrictedTraverse(relative_url)
Sebastien Robin's avatar
Sebastien Robin committed
1890 1891 1892 1893
      # normalize relative_url, not all type informations are stored in
      # "portal_types"
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])

1894
      obj = obj._getCopy(context)
1895 1896
      # obj is in ghost state and an attribute must be accessed
      # so that obj.__dict__ does not return an empty dict
1897
      obj.meta_type
1898
      for attr in obj.__dict__.keys():
1899 1900 1901 1902 1903 1904 1905 1906
        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)
1907 1908
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1909

1910 1911
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1912 1913 1914 1915
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1916 1917
    # We now need to setup the list of workflows corresponding to
    # each portal type
1918
    (default_chain, chain_dict) = getChainByType(context)
1919
    # Set the default chain to the empty string is probably the
1920
    # best solution, by default it is 'default_workflow', which is
1921
    # not very usefull
1922
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1923
    if context.getTemplateFormatVersion() == 1:
1924
      object_list = self._objects
1925
    else:
1926 1927
      object_list = self._archive
    for path in object_list.keys():
1928 1929 1930 1931
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1932
            continue
1933 1934
        obj = object_list[path]
        portal_type = obj.id
1935 1936 1937
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1938 1939
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1940

1941 1942
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1943 1944 1945
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
1946
      result_dict = {}
1947
      xml = parse(file)
1948
      chain_list = xml.findall('//chain')
1949
      for chain in chain_list:
1950 1951 1952 1953
        portal_type = chain.find('type').text
        workflow = chain.find('workflow').text or ''
        result_dict[portal_type] = workflow
      self._workflow_chain_archive = result_dict
1954 1955 1956
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1957
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1958

1959 1960 1961
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

1962
  def build(self, context, **kw):
1963 1964 1965 1966 1967
    # 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
1968
    p = context.getPortalObject()
1969
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1970
    for key in self._archive.keys():
1971 1972 1973
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1974
        workflow = wflist[1]
1975
      else:
1976
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1977
        portal_type = wflist[0][:-2]
1978
        workflow = ''
1979 1980 1981 1982 1983
      portal_type_key = '%s%s' % (self._chain_string_prefix, portal_type)
      if portal_type_key in chain_dict:
        workflow_name = workflow.lstrip('+-=')
        if workflow[0] != '-' and workflow_name not in \
           chain_dict[portal_type_key].split(self._chain_string_separator):
1984
          if not self.is_bt_for_diff:
1985 1986 1987
            # here, we use 'LOG' instead of 'raise', because it can
            # happen when a workflow is removed from the chain by
            # another business template.
Jérome Perrin's avatar
Jérome Perrin committed
1988
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
1989
                       'in chain for portal_type %s' % (workflow_name, portal_type))
1990
        self._objects.setdefault(portal_type, []).append(workflow)
1991
      elif not self.is_bt_for_diff:
1992
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1993
                        'is probably a sign of a missing dependency.'\
1994
                                                    % portal_type
1995

Christophe Dumez's avatar
Christophe Dumez committed
1996
  # Function to generate XML Code Manually
1997 1998
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
1999 2000 2001
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2002
      workflow_list = self._objects[key]
2003 2004
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
2005 2006
      xml_data += '\n  <workflow>%s</workflow>' %(
        self._chain_string_separator.join(sorted(workflow_list)))
2007 2008
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
2009 2010 2011
    return xml_data

  def export(self, context, bta, **kw):
2012
    if not self._objects:
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
      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
2025
    (default_chain, chain_dict) = getChainByType(context)
2026
    # First convert all workflow_ids into list.
Sebastien Robin's avatar
Sebastien Robin committed
2027 2028
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
2029
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
2030
    # best solution, by default it is 'default_workflow', which is
2031 2032
    # not very usefull
    default_chain = ''
2033 2034
    for path in self._objects:
      if path in update_dict or force:
2035 2036 2037
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2038
            continue
Jérome Perrin's avatar
Jérome Perrin committed
2039 2040
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
2041
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
2042
          continue
2043
        portal_type = path_splitted[-1]
2044 2045
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
2046
          # XXX we don't use the chain (Default) in erp5 so don't keep it
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066
          old_chain_list = [workflow_id for workflow_id in\
                            chain_dict[chain_key] if workflow_id not in\
                            ('(Default)', '',)]
          old_chain_workflow_id_set = set(old_chain_list)
          # get new workflow id list
          workflow_id_list = self._objects[path]
          for wf_id in workflow_id_list:
            if wf_id[0] == '-':
              # remove wf id if already present
              if wf_id[1:] in old_chain_workflow_id_set:
                old_chain_workflow_id_set.remove(wf_id[1:])
            elif wf_id[0] == '=':
              # replace existing chain by this one
              old_chain_workflow_id_set = set()
              old_chain_workflow_id_set.add(wf_id[1:])
            # then either '+' or nothing, add wf id to the list
            elif wf_id[0] == '+':
              old_chain_workflow_id_set.add(wf_id[1:])
            else:
              old_chain_workflow_id_set.add(wf_id)
2067
            # create the new chain
2068 2069
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
2070 2071
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
2072
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
2073 2074 2075
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
2076
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
2077
        else:
Sebastien Robin's avatar
Sebastien Robin committed
2078
          if context.portal_types.getTypeInfo(portal_type) is None:
2079
            raise ValueError('Cannot chain workflow %r to non existing '
2080 2081 2082 2083 2084
                           'portal type %r' % (self._chain_string_separator\
                                                     .join(self._objects[path])
                                               , portal_type))
          chain_dict[chain_key] = self._objects[path]
    # convert workflow list into string only at the end.
Sebastien Robin's avatar
Sebastien Robin committed
2085 2086
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
2087 2088
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2089

2090 2091
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
2092 2093
    object_path = kw.get('object_path', None)
    if object_path is not None:
2094
      object_key_list = [object_path]
2095
    else:
2096 2097 2098
      object_key_list = self._objects.keys()
    for object_key in object_key_list:
      path_splitted = object_key.split('/', 1)
2099 2100 2101
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
2102 2103 2104 2105 2106 2107 2108 2109 2110 2111
      path = '%s%s' % (self._chain_string_prefix, portal_type)
      if path in chain_dict:
        workflow_id_list = chain_dict[path].\
                                            split(self._chain_string_separator)
        removed_workflow_id_list = self._objects[object_key]
        for workflow_id in removed_workflow_id_list:
          for i in range(workflow_id_list.count(workflow_id)):
            workflow_id_list.remove(workflow_id)
        if not workflow_id_list:
          del chain_dict[path]
2112
        else:
2113 2114 2115 2116
          chain_dict[path] = self._chain_string_separator.\
                                                  join(workflow_id_list)
    context.getPortalObject().portal_workflow.\
                                   manage_changeWorkflows('', props=chain_dict)
2117

2118
  def preinstall(self, context, installed_item, **kw):
2119 2120
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2121
      new_key_list = self._objects.keys()
2122 2123
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
2124
      for key, value in installed_item._objects.iteritems():
2125 2126
        if not 'portal_type_workflow_chain/' in key:
          key = 'portal_type_workflow_chain/%s' % (key)
2127
        new_dict[key] = value
2128
      if new_dict:
2129
        installed_item._objects = new_dict
2130 2131
      for path in new_key_list:
        if path in installed_item._objects:
2132 2133
          # compare object to see it there is changes
          new_object = self._objects[path]
2134
          old_object = installed_item._objects[path]
2135 2136 2137 2138 2139 2140
          if isinstance(new_object, str):
            new_object = new_object.split(self._chain_string_separator)
          if isinstance(old_object, str):
            old_object = old_object.split(self._chain_string_separator)
          new_object.sort()
          old_object.sort()
2141
          if new_object != old_object:
2142
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2143
        else: # new object
2144
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2145
      # get removed object
2146 2147 2148
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2149 2150
    return modified_object_list

2151
  def _importFile(self, file_name, file):
2152
    if not file_name.endswith('.xml'):
2153
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2154
      return
2155
    # import workflow chain for portal_type
2156
    result_dict = {}
2157
    xml = parse(file)
2158
    chain_list = xml.findall('chain')
2159
    for chain in chain_list:
2160
      portal_type = chain.find('type').text
2161
      workflow_chain = chain.find('workflow').text or ''
2162
      if 'portal_type_workflow_chain/' not in portal_type:
2163 2164 2165 2166
        key = 'portal_type_workflow_chain/%s' % (portal_type,)
      else:
        key = portal_type
      result_dict[key] = workflow_chain.split(self._chain_string_separator)
2167
    self._objects = result_dict
2168

2169 2170
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2171

2172
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
2173 2174 2175
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
2176 2177
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
2178
  business_template_class_property = '_portal_type_allowed_content_type_item'
2179 2180

  def build(self, context, **kw):
2181
    types_tool = getToolByName(self.getPortalObject(), 'portal_types')
2182
    for key in self._archive.keys():
2183 2184 2185 2186
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
Sebastien Robin's avatar
Sebastien Robin committed
2187
      ob = types_tool.getTypeInfo(portal_type)
2188
      # check properties corresponds to what is defined in site
Sebastien Robin's avatar
Sebastien Robin committed
2189
      if ob is None:
2190 2191
        raise ValueError, "Portal Type %s not found in site" %(portal_type,)
      prop_value = getattr(ob, self.class_property, ())
2192
      if not allowed_type in prop_value and not self.is_bt_for_diff:
Jérome Perrin's avatar
Jérome Perrin committed
2193
        raise ValueError, "%s %s not found in portal type %s" % (
2194 2195
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)
2196 2197
      if self.class_property not in portal_type:
        key = '%s/%s' % (self.class_property, portal_type)
2198
      else:
2199 2200
        key = portal_type
      self._objects.setdefault(key, []).append(allowed_type)
2201

Christophe Dumez's avatar
Christophe Dumez committed
2202
  # Function to generate XML Code Manually
2203 2204
  def generateXml(self, path=None):
    xml_data = '<%s>' %(self.xml_tag,)
2205 2206 2207
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2208
      id_value = key.replace('%s/' % self.class_property, '')
2209
      allowed_item_list = sorted(self._objects[key])
2210
      xml_data += '\n <portal_type id="%s">' % (id_value)
2211
      for allowed_item in allowed_item_list:
2212 2213 2214
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
2215 2216 2217
    return xml_data

  def export(self, context, bta, **kw):
2218
    if not self._objects:
2219 2220 2221
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
2222
    path = os.sep.join((self.__class__.__name__, self.class_property,))
2223 2224 2225
    xml_data = self.generateXml(path=None)
    bta.addObject(obj=xml_data, name=path, path=None)

2226
  def preinstall(self, context, installed_item, **kw):
2227 2228 2229
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
2230
      new_key_list = self._objects.keys()
2231 2232
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
Nicolas Delaby's avatar
Nicolas Delaby committed
2233
      for key, value in installed_item._objects.iteritems():
2234
        if self.class_property not in key:
2235
          key = '%s/%s' % (self.class_property, key)
Nicolas Delaby's avatar
Nicolas Delaby committed
2236
        new_dict[key] = value
2237
      if new_dict:
2238
        installed_item._objects = new_dict
2239 2240
      for path in new_key_list:
        if path in installed_item._objects:
2241 2242
          # compare object to see it there is changes
          new_object = self._objects[path]
2243
          old_object = installed_item._objects[path]
2244 2245
          new_object.sort()
          old_object.sort()
2246
          if new_object != old_object:
2247
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2248
        else: # new object
2249
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2250
      # get removed object
2251 2252 2253
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2254 2255
    return modified_object_list

2256
  def _importFile(self, file_name, file):
2257
    if not file_name.endswith('.xml'):
2258
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2259
      return
2260
    path, name = posixpath.split(file_name)
2261
    xml = parse(file)
2262
    portal_type_list = xml.findall('portal_type')
2263
    for portal_type in portal_type_list:
2264 2265
      id = portal_type.get('id')
      item_type_list = [item.text for item in portal_type.findall('item')]
Nicolas Delaby's avatar
typo  
Nicolas Delaby committed
2266
      if self.class_property not in id:
2267 2268 2269 2270
        key = '%s/%s' % (self.class_property, id,)
      else:
        key = id
      self._objects[key] = item_type_list
2271 2272

  def install(self, context, trashbin, **kw):
Nicolas Delaby's avatar
Nicolas Delaby committed
2273 2274
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2275 2276
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2277 2278 2279 2280 2281 2282 2283
    installed_bt = kw.get('installed_bt')
    if installed_bt is not None:
      old_objects = getattr(installed_bt,
                            self.business_template_class_property)._objects
    else:
      old_objects = {}
    for key in set(self._objects.keys()).union(set(old_objects.keys())):
Nicolas Delaby's avatar
Nicolas Delaby committed
2284
      if key in update_dict or force:
2285 2286 2287 2288
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
Sebastien Robin's avatar
Sebastien Robin committed
2289 2290 2291
        portal_id = key.split('/')[-1]
        type_information = types_tool.getTypeInfo(portal_id)
        if type_information is None:
2292 2293
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2294 2295
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
Sebastien Robin's avatar
Sebastien Robin committed
2296
        object_property_list = getattr(type_information, self.class_property, ())
Nicolas Delaby's avatar
Nicolas Delaby committed
2297 2298 2299 2300 2301 2302 2303 2304 2305
        # merge differences between portal types properties
        # for example:
        # * current value : [A,B,C]
        # * in new BT : [A,D]
        # * in old BT : [A,B]
        # -> [A,D,C] i.e. C is merged but B is not merged
        for id in object_property_list:
          if id not in property_list and id not in old_property_list:
            property_list.append(id)
Sebastien Robin's avatar
Sebastien Robin committed
2306
        setattr(type_information, self.class_property, tuple(property_list))
2307

Aurel's avatar
Aurel committed
2308
  def uninstall(self, context, **kw):
2309
    object_path = kw.get('object_path', None)
Nicolas Delaby's avatar
Nicolas Delaby committed
2310 2311
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2312
    if object_path is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
2313
      object_key_list = [object_path]
2314
    else:
Nicolas Delaby's avatar
Nicolas Delaby committed
2315 2316
      object_key_list = self._objects.keys()
    for key in object_key_list:
Sebastien Robin's avatar
Sebastien Robin committed
2317 2318 2319 2320 2321
      portal_id = key.split('/')[-1]
      type_information = types_tool.getTypeInfo(portal_id)
      if type_information is None:
        LOG("BusinessTemplate", WARNING,
            "Portal type %r not found while uninstalling" % (portal_id,))
2322 2323
        continue
      property_list = self._objects[key]
Sebastien Robin's avatar
Sebastien Robin committed
2324
      original_property_list = list(getattr(type_information,
2325
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2326 2327
      for id in property_list:
        if id in original_property_list:
2328
          original_property_list.remove(id)
Sebastien Robin's avatar
Sebastien Robin committed
2329
      setattr(type_information, self.class_property, tuple(original_property_list))
2330

2331

2332 2333
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2334
  name = 'Hidden Content Type'
2335 2336
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2337
  business_template_class_property = '_portal_type_hidden_content_type_item'
2338

2339

2340 2341
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2342
  name = 'Property Sheet'
2343 2344
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2345
  business_template_class_property = '_portal_type_property_sheet_item'
2346

2347

2348 2349
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2350
  name = 'Base Category'
2351 2352
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2353
  business_template_class_property = '_portal_type_base_category_item'
2354

2355

2356
class CatalogMethodTemplateItem(ObjectTemplateItem):
2357
  """Template Item for catalog methods.
2358

2359 2360 2361 2362 2363
    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.
  """
2364

2365 2366
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2367
    # a mapping to store properties of methods.
2368 2369 2370 2371 2372
    # 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()
2373

2374
    self._is_filtered_archive = PersistentMapping()
2375 2376
    for method in catalog_method_filter_list:
      setattr(self, method, PersistentMapping())
2377

2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391
  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

2392 2393
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2394

2395
    catalog = _getCatalogValue(self)
2396
    if catalog is None:
2397
      LOG('BusinessTemplate build', 0, 'catalog not found')
2398
      return
2399

2400 2401 2402
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2403

2404 2405
    for obj in self._objects.values():
      method_id = obj.id
2406 2407
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2408 2409 2410 2411 2412 2413
      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]
2414

2415 2416 2417 2418 2419
  def generateXml(self, path):
    obj = self._objects[path]
    method_id = obj.id
    xml_data = '<catalog_method>'
    if self._method_properties.has_key(method_id):
2420
      for method_property, value in self._method_properties[method_id].items():
2421 2422 2423
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2424

2425
      if self._is_filtered_archive.get(method_id):
2426 2427 2428
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2429 2430
          for method in catalog_method_filter_list:
            if method != '_filter_expression_instance_archive':
2431 2432
              value = getattr(self, method, {}).get(method_id)
              if isinstance(value, basestring):
2433 2434 2435
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2436
              elif value:
2437
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2438
                for item in value:
2439 2440
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2441
    xml_data += '\n</catalog_method>\n'
Christophe Dumez's avatar
Christophe Dumez committed
2442
    return xml_data
2443

2444 2445 2446
  def preinstall(self, context, installed_item, **kw):
    modified_object_dict = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
    modified_object_dict.update(BaseTemplateItem.preinstall(self, context, installed_item, **kw))
2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472
    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)

2473 2474
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2475
    catalog = _getCatalogValue(self)
2476 2477 2478 2479 2480 2481 2482
    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)
2483

2484 2485 2486
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2487
    new_bt_format = context.getTemplateFormatVersion()
2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503

    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':
2504
              continue
2505 2506 2507 2508
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2509

2510 2511
    for obj in values:
      method_id = obj.id
2512

2513 2514 2515 2516 2517 2518
      # Restore catalog properties for methods
      if hasattr(self, '_method_properties'):
        for key in self._method_properties.get(method_id, {}).keys():
          old_value = getattr(catalog, key, None)
          if isinstance(old_value, str):
            setattr(catalog, key, method_id)
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2519
          elif isinstance(old_value, (list, tuple)):
2520 2521 2522 2523
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2524

2525 2526
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2527
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2528
        if context.getTemplateFormatVersion() == 1:
2529 2530 2531 2532 2533
          if expression and expression.strip():
            # only compile non-empty expressions
            expr_instance = Expression(expression)
          else:
            expr_instance = None
2534 2535
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2536 2537 2538
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2539
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2540 2541 2542 2543
        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, ())
2544
      elif method_id in catalog.filter_dict.keys():
2545
        catalog.filter_dict[method_id]['filtered'] = 0
2546

2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572
      # 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)
2573

2574 2575 2576 2577 2578 2579
        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)
2580

2581
  def uninstall(self, context, **kw):
2582
    catalog = _getCatalogValue(self)
2583 2584 2585
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2586

2587 2588 2589 2590
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2591 2592 2593 2594
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2595
    else:
2596
      try:
2597 2598 2599 2600
        if context.getTemplateFormatVersion() == 1:
          value = self._objects[object_path]
        else:
          value = self._archive[object_path]
2601 2602
      except KeyError:
        value = None
2603 2604
      if value is not None:
        values.append(value)
2605
    for obj in values:
2606
      method_id = obj.id
2607 2608 2609 2610 2611 2612 2613 2614 2615
      # 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)
2616

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2617
      if catalog.filter_dict.has_key(method_id):
2618
        del catalog.filter_dict[method_id]
2619

2620
    # uninstall objects
2621
    ObjectTemplateItem.uninstall(self, context, **kw)
2622

2623
  def _importFile(self, file_name, file):
2624
    if file_name.endswith('.catalog_keys.xml'):
2625
      # recreate data mapping specific to catalog method
2626 2627
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2628
      xml = parse(file)
2629
      method_list = xml.findall('item')
2630
      for method in method_list:
2631 2632 2633
        key = method.get('key')
        key_type = method.get('type')
        value_node = method.find('value')
2634
        if key_type == "str":
2635
          value = value_node.text or ''
2636
        elif key_type == "int":
2637
          value = int(value_node.text)
2638
        elif key_type == "tuple":
2639
          value = tuple([value_node.text for value_node in method.findall('value')])
2640
        else:
2641
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2642
          continue
2643
        if key in catalog_method_list or key in catalog_method_filter_list:
2644
          getattr(self, key)[id] = value
2645 2646 2647
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659
    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, ))
2660

2661
class ActionTemplateItem(ObjectTemplateItem):
2662 2663

  def __init__(self, id_list, **kw):
2664
    # XXX It's look like ObjectTemplateItem __init__
2665 2666 2667 2668 2669 2670
    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

2671 2672
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2673
      Split path tries to split a complex path such as:
2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691

      "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

2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724
  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
Sebastien Robin's avatar
Sebastien Robin committed
2725
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2726 2727 2728 2729
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2730 2731 2732 2733
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2734 2735 2736
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
Sebastien Robin's avatar
Sebastien Robin committed
2737 2738 2739 2740 2741 2742
      # normalize url
      url = p.portal_url.getRelativeContentPath(obj)
      if len(url) == 1:
        # global actions are stored under 'portal_types', mostly for
        # compatibility
        url = 'portal_types', url[0]
2743 2744
      action = self._getActionCopy(obj, context, value)
      if action is None:
2745 2746 2747
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2748
      key = posixpath.join(url[-2], url[-1], value)
2749
      self._objects[key] = self.removeProperties(action)
2750
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2751

2752 2753 2754
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2755
    if context.getTemplateFormatVersion() == 1:
2756
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2757 2758
      p = context.getPortalObject()
      for id in self._objects.keys():
2759 2760 2761 2762 2763
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2764 2765 2766
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2767

Sebastien Robin's avatar
Sebastien Robin committed
2768
          if interfaces.ITypeProvider.providedBy(aq_parent(aq_inner(container))):
2769 2770 2771
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2772 2773
            continue

Julien Muchembled's avatar
Julien Muchembled committed
2774 2775
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2776 2777 2778
          try:
            from Products.CMFCore.interfaces import IActionProvider
          except ImportError:
2779
              # BACK:
2780 2781 2782 2783 2784 2785 2786 2787
              # 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,
2788
                  'Redirected action import',
2789 2790 2791 2792
                  '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
2793
          obj, action = container, obj
2794
          action_list = obj.listActions()
2795
          for index in range(len(action_list)):
2796
            if action_list[index].id == id:
2797
              # remove previous action
2798
              obj.deleteActions(selections=(index,))
2799 2800 2801
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2802
          obj.addAction(
2803 2804
                        id = action.id
                      , name = action.title
2805
                      , action = action_text
2806 2807 2808 2809
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2810 2811
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2812
                      , priority = action.priority
2813
                      , description = action.description
Aurel's avatar
Aurel committed
2814
                    )
2815
          # sort action based on the priority define on it
2816 2817 2818 2819 2820 2821 2822 2823 2824
          # 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))
2825 2826
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2827
        container.manage_delObjects([obj.id
2828
          for obj in container.getActionInformationList()
2829
          if obj.getReference() in action_dict])
2830 2831
        for obj in action_dict.itervalues():
          container._importOldAction(obj)
Aurel's avatar
Aurel committed
2832
    else:
2833
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2834
      p = context.getPortalObject()
2835 2836
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2837
        relative_url, key, value = self._splitPath(id)
2838 2839
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2840
          if getattr(ai, key) == value:
2841
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2842 2843 2844
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2845
        obj.addAction(
Aurel's avatar
Aurel committed
2846 2847
                      id = action.id
                    , name = action.title
2848
                    , action = action_text
Aurel's avatar
Aurel committed
2849 2850 2851 2852
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2853 2854
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2855
                    )
Aurel's avatar
Aurel committed
2856 2857 2858 2859 2860 2861 2862
        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))
2863 2864
          obj.moveDownActions(selections=tuple(move_down_list))

2865 2866
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2867 2868
    object_path = kw.get("object_path", None)
    if object_path is not None:
2869 2870 2871 2872 2873 2874 2875 2876
      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]
2877
    else:
2878
      keys = self._archive.keys()
2879
    for id in keys:
2880 2881
      if  '|' in id:
        relative_url, value = id.split(' | ')
2882 2883 2884
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
Sebastien Robin's avatar
Sebastien Robin committed
2885
          is_new_action = interfaces.ITypeProvider.providedBy(obj.getParentValue())
2886
          key = is_new_action and 'reference' or 'id'
2887
      else:
2888
        relative_url, key, value = self._splitPath(id)
2889
        obj = p.unrestrictedTraverse(relative_url, None)
2890 2891 2892
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2893
          if getattr(action_list[index], key, None) == value:
2894 2895
            obj.deleteActions(selections=(index,))
            break
Sebastien Robin's avatar
Sebastien Robin committed
2896 2897
      LOG('BusinessTemplate', WARNING,
          'Unable to uninstall action at %s, ignoring' % relative_url )
2898 2899
    BaseTemplateItem.uninstall(self, context, **kw)

2900 2901 2902
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2903
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2904 2905 2906 2907 2908 2909 2910
    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])
Sebastien Robin's avatar
Sebastien Robin committed
2911 2912
      # normalize url
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])
2913
      self._objects[relative_url] = type_role_list = []
2914
      for role in obj.getRoleInformationList():
2915
        type_role_dict = {}
2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932
        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
2933
        type_role_list.append(type_role_dict)
2934
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2935

Christophe Dumez's avatar
Christophe Dumez committed
2936
  # Function to generate XML Code Manually
2937 2938 2939 2940
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2941
      xml_data += "\n  <role id='%s'>" % role['id']
2942
      # uniq
2943
      for property in ('title', 'description', 'condition',
2944 2945 2946
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2947 2948
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2949
          xml_data += "\n   <property id='%s'>%s</property>" % \
2950 2951 2952
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2953
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2954 2955
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2956
          xml_data += "\n   <multi_property "\
2957
          "id='%s'>%s</multi_property>" % (property, prop_value)
2958 2959
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2960
    return xml_data
2961

2962 2963 2964 2965 2966 2967 2968
  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)
2969 2970
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2971 2972 2973 2974
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
2975 2976 2977
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2978 2979
    type_roles_list = []
    xml = parse(file)
2980
    xml_type_roles_list = xml.findall('role')
2981
    for role in xml_type_roles_list:
2982 2983 2984 2985
      id = role.get('id')
      if isinstance(id, unicode):
        id = id.encode('utf_8', 'backslashreplace')
      type_role_property_dict = {'id': id}
2986
      # uniq
2987 2988 2989 2990 2991 2992 2993 2994
      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
2995
      # multi
2996 2997 2998 2999 3000 3001 3002 3003
      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)
3004
      type_roles_list.append(type_role_property_dict)
3005
    self._objects['portal_type_roles/%s' % (file_name[:-4],)] = type_roles_list
3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016

  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
3017 3018 3019
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
3020
          # reset roles before applying
3021
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
3022
          type_roles_list = self._objects[roles_path] or []
3023 3024
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
Sebastien Robin's avatar
Sebastien Robin committed
3025 3026 3027
        else:
          raise AttributeError("Path '%r' not found while "
                               "installing roles" % (path, ))
3028 3029 3030

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
3031 3032 3033 3034 3035 3036
    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:
3037
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
3038 3039 3040 3041 3042
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
3043

3044 3045 3046 3047 3048 3049
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
3050 3051
      for property in p.propertyMap():
        if property['id'] == id:
3052
          obj = p.getProperty(id)
3053
          prop_type = property['type']
3054 3055
          break
      else:
3056
        obj = None
3057
      if obj is None and not self.is_bt_for_diff:
3058
        raise NotFound, 'the property %s is not found' % id
3059
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
3060

3061 3062
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
3063
    if not file_name.endswith('.xml'):
3064
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3065
      return
3066
    xml = parse(file)
3067 3068 3069 3070 3071 3072 3073 3074 3075
    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)
3076

3077 3078 3079
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3080
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3081 3082
      p = context.getPortalObject()
      for path in self._objects.keys():
3083 3084 3085 3086
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
3087
              continue
3088
          dir, id = posixpath.split(path)
3089
          prop_type, property = self._objects[path]
3090 3091 3092 3093 3094 3095 3096 3097
          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
3098
    else:
3099
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
3100
      p = context.getPortalObject()
3101
      for id, property in self._archive.keys():
3102
        property = self._archive[id]
Aurel's avatar
Aurel committed
3103
        if p.hasProperty(id):
3104 3105 3106 3107 3108 3109 3110
          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'])
3111 3112 3113

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3114 3115 3116 3117 3118 3119
    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:
3120 3121 3122 3123
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3124
  # Function to generate XML Code Manually
3125
  def generateXml(self, path=None):
3126
    xml_data = ''
3127
    prop_type, obj = self._objects[path]
3128
    xml_data += '\n <property>'
3129 3130
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
3131
    if prop_type in ('lines', 'tokens'):
3132
      xml_data += '\n  <value>'
3133
      for item in obj:
3134
        if item != '':
3135
          xml_data += '\n   <item>%s</item>' % escape(str(item))
3136
      xml_data += '\n  </value>'
3137
    else:
3138
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
3139
    xml_data += '\n </property>'
3140 3141
    return xml_data

Aurel's avatar
Aurel committed
3142 3143 3144 3145 3146
  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)
3147 3148 3149 3150
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
3151
      xml_data += self.generateXml(path)
3152
    xml_data += '\n</site_property>'
3153
    bta.addObject(obj=xml_data, name='properties', path=root_path)
3154

3155 3156 3157 3158 3159
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3160 3161 3162 3163 3164 3165
    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()
3166
      permission_list = []
3167
      mapping['permission_list'] = module.showPermissions()
3168
      mapping['category_list'] = module.getCategoryList()
3169
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3170

Christophe Dumez's avatar
Christophe Dumez committed
3171
  # Function to generate XML Code Manually
3172
  def generateXml(self, path=None):
3173
    mapping = self._objects[path]
3174
    xml_data = ['<module>']
3175
    keys = mapping.keys()
3176 3177
    for key in sorted(keys):
      if key == 'permission_list':
3178
        # separe permission dict into xml
3179
        xml_data.append(' <%s>' % (key, ))
3180
        permission_list = mapping[key]
3181
        for perm in permission_list:
3182
          # the type of the permission defined if we use acquired or not
3183
          if isinstance(perm[1], list):
3184 3185 3186
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
3187
          role_list = list(perm[1])
3188 3189 3190
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
3191
          if (len(role_list) == 0 and ptype == 'list') or \
3192 3193
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
3194
          role_list.sort()
3195 3196
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
3197
          for role in role_list:
3198 3199 3200
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
3201 3202 3203 3204 3205 3206 3207 3208
      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, ))
3209
      else:
3210
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
3211 3212
    xml_data.append('</module>')
    return '\n'.join(xml_data)
3213

3214
  def export(self, context, bta, **kw):
3215
    if len(self._objects) == 0:
3216 3217 3218
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
3219 3220
    keys = self._objects.keys()
    keys.sort()
3221
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
3222
      # export modules one by one
3223 3224
      xml_data = self.generateXml(path=key)
      bta.addObject(obj=xml_data, name=key, path=path)
3225

3226
  def install(self, context, trashbin, **kw):
3227
    portal = context.getPortalObject()
3228 3229
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3230
    if context.getTemplateFormatVersion() == 1:
3231
      items = self._objects
3232
    else:
3233 3234
      items = self._archive

3235 3236
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
3237 3238
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
3239
        if not force:
3240
          action = update_dict[path]
3241 3242
          if action == 'nothing':
            continue
3243 3244
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
3245
        module = portal._getOb(module_id, None)
3246 3247
        if module is not None:
          module.portal_type = portal_type
3248
        else:
3249
          module = portal.newContent(id=module_id, portal_type=portal_type)
3250
        module.setTitle(str(mapping['title']))
3251 3252
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
3253
          # By default, Manager only without acquire permission
3254 3255
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
3256
          module.manage_permission(name, roles=role_list, acquire=acquire)
3257 3258
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
3259 3260

  def _importFile(self, file_name, file):
3261 3262 3263
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3264
    mapping = {}
3265
    xml = parse(file)
3266
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3267
      key_node = xml.find(key)
3268
      if key == 'permission_list':
3269 3270 3271 3272 3273 3274 3275
        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))
3276
          else:
3277 3278 3279
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3280
      else:
3281
        mapping[key] = key_node.text or ''
3282 3283

    category_list = []
3284 3285 3286 3287
    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'))
3288 3289
    mapping['category_list'] = category_list

3290
    self._objects[file_name[:-4]] = mapping
3291

3292
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3293 3294 3295
    trash = kw.get('trash', 0)
    if trash:
      return
3296 3297 3298 3299 3300 3301
    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]
3302 3303
    p = context.getPortalObject()
    id_list = p.objectIds()
3304 3305
    for key in keys:
      if key in id_list:
3306
        try:
3307
          if trash and trashbin is not None:
3308
            container_path = key.split('/')
3309 3310
            self.portal_trash.backupObject(trashbin, container_path, 
                                           key, save=1, keep_subobjects=1)
3311
          p.manage_delObjects([key])
3312
        except NotFound:
3313
          pass
3314 3315
    BaseTemplateItem.uninstall(self, context, **kw)

3316 3317 3318
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3319 3320

class DocumentTemplateItem(BaseTemplateItem):
3321 3322 3323 3324
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3325 3326 3327

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

3331
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3332 3333
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3334
      new_keys = self._objects.keys()
3335
      # fix key if necessary in installed bt for diff
3336
      extra_prefix = self.__class__.__name__ + '/'
3337
      for key in installed_item._objects.keys():
3338 3339 3340 3341
        if key.startswith(extra_prefix):
          new_key = key[len(extra_prefix):]
          installed_item._objects[new_key] = installed_item._objects[key]
          del installed_item._objects[key]
3342
      for path in new_keys:
3343
        if installed_item._objects.has_key(path):
3344 3345
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3346
          old_obj_code = installed_item._objects[path]
3347
          if new_obj_code != old_obj_code:
3348 3349
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3350
        else: # new object
3351 3352
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3353
          # get removed object
3354
      old_keys = installed_item._objects.keys()
3355 3356
      for path in old_keys:
        if path not in new_keys:
3357 3358
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3359 3360 3361 3362 3363
    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
3364
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3365
      for id in self._objects.keys():
3366 3367 3368 3369 3370 3371
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
3372
          path, name = posixpath.split(id)
3373 3374
          # This raises an exception if the file already exists.
          try:
3375
            self.local_file_writer_name(name, text, create=0)
3376
          except IOError, error:
3377
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
3378
            if error.errno:
3379
              raise
3380 3381
            continue
          if self.local_file_importer_name is not None:
3382
            self.local_file_importer_name(name)
3383 3384 3385 3386 3387 3388 3389 3390 3391 3392
            # 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
3393
    else:
3394 3395 3396
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3397
        # This raises an exception if the file exists.
3398
        self.local_file_writer_name(id, text, create=1)
Aurel's avatar
Aurel committed
3399
        if self.local_file_importer_name is not None:
3400
          self.local_file_importer_name(id)
3401 3402

  def uninstall(self, context, **kw):
3403
    object_path = kw.get('object_path', None)
3404 3405 3406 3407
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
3408 3409
    for key in object_keys:
      self.local_file_remover_name(key)
3410 3411
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3412 3413 3414 3415 3416
  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)
3417 3418 3419 3420 3421 3422 3423
    extra_prefix = self.__class__.__name__ + '/'
    for key in self._objects.keys():
      obj = self._objects[key]
      # BBB the prefix was put into each key in the previous implementation.
      if not key.startswith(extra_prefix):
        key = extra_prefix + key
      bta.addObject(obj=obj, name=key, ext='.py')
Aurel's avatar
Aurel committed
3424

3425
  def _importFile(self, file_name, file):
3426 3427 3428
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3429
    text = file.read()
3430
    self._objects[file_name[:-3]] = text
3431

3432
class PropertySheetTemplateItem(DocumentTemplateItem):
3433 3434 3435 3436
  local_file_reader_name = staticmethod(readLocalPropertySheet)
  local_file_writer_name = staticmethod(writeLocalPropertySheet)
  local_file_importer_name = staticmethod(importLocalPropertySheet)
  local_file_remover_name = staticmethod(removeLocalPropertySheet)
3437

3438
class ConstraintTemplateItem(DocumentTemplateItem):
3439 3440 3441 3442
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3443

3444
class ExtensionTemplateItem(DocumentTemplateItem):
3445 3446
  local_file_reader_name = staticmethod(readLocalExtension)
  local_file_writer_name = staticmethod(writeLocalExtension)
3447 3448
  # Extension needs no import
  local_file_importer_name = None
3449
  local_file_remover_name = staticmethod(removeLocalExtension)
3450 3451

class TestTemplateItem(DocumentTemplateItem):
3452 3453
  local_file_reader_name = staticmethod(readLocalTest)
  local_file_writer_name = staticmethod(writeLocalTest)
3454
  # Test needs no import
3455
  local_file_importer_name = None
3456
  local_file_remover_name = staticmethod(removeLocalTest)
3457

Aurel's avatar
Aurel committed
3458

3459 3460 3461
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3462 3463 3464

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3465
  def build(self, context, **kw):
3466 3467
    for key in self._archive.iterkeys():
      self._objects[key] = 1
Aurel's avatar
Aurel committed
3468

3469
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3470 3471
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3472
      new_roles = self._objects.keys()
3473 3474 3475 3476 3477 3478
      # BBB it might be necessary to change the data structure.
      obsolete_key = self.__class__.__name__ + '/role_list'
      if obsolete_key in installed_item._objects:
        for role in installed_item._objects[obsolete_key]:
          installed_item._objects[role] = 1
        del installed_item._objects[obsolete_key]
3479
      for role in new_roles:
3480
        if installed_item._objects.has_key(role):
3481 3482 3483 3484
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
3485
      old_roles = installed_item._objects.keys()
3486 3487 3488 3489 3490 3491
      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):
3492
    p = context.getPortalObject()
3493
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3494
    if context.getTemplateFormatVersion() == 1:
3495
      role_set = set(self._objects)
3496
    else:
3497
      role_set = set(self._archive)
3498 3499 3500 3501
    # 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:
3502 3503
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
3504
    # set roles on portal
3505
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
3506 3507

  def _importFile(self, file_name, file):
3508
    if not file_name.endswith('.xml'):
3509
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3510
      return
3511
    xml = parse(file)
3512 3513 3514
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526

  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)

3527 3528 3529 3530 3531 3532 3533 3534 3535
  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
3536
      if role in roles and role not in new_roles:
3537 3538 3539
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3540
  # Function to generate XML Code Manually
3541 3542
  def generateXml(self):
    role_list = self._objects.keys()
3543
    xml_data = '<role_list>'
3544 3545
    for role in sorted(role_list):
      xml_data += '\n <role>%s</role>' % (role,)
3546
    xml_data += '\n</role_list>'
3547 3548
    return xml_data

Aurel's avatar
Aurel committed
3549
  def export(self, context, bta, **kw):
3550
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
3551 3552 3553
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
3554 3555 3556 3557 3558 3559 3560 3561 3562
    # BBB it might be necessary to change the data structure.
    obsolete_key = self.__class__.__name__ + '/role_list'
    if obsolete_key in self._objects:
      for role in self._objects[obsolete_key]:
        self._objects[role] = 1
      del self._objects[obsolete_key]
    xml_data = self.generateXml()
    path = obsolete_key
    bta.addObject(obj=xml_data, name=path)
3563

3564 3565
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3566
  def build(self, context, **kw):
3567
    catalog = _getCatalogValue(self)
3568 3569 3570
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3571
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3572
    key_list = []
3573
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3574
      if key in sql_search_result_keys:
3575
        key_list.append(key)
3576
      elif not self.is_bt_for_diff:
3577
        raise NotFound, 'Result key "%r" not found in catalog' %(key,)
3578
    if len(key_list) > 0:
3579
      self._objects[self.__class__.__name__+'/'+'result_key_list'] = key_list
3580 3581

  def _importFile(self, file_name, file):
3582 3583 3584
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3585
    xml = parse(file)
3586 3587
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3588

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

3595
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3596
    if context.getTemplateFormatVersion() == 1:
3597 3598
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3599 3600 3601
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3602
    else:
3603
      keys = self._archive.keys()
3604 3605
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3606
    # XXX same as related key
Aurel's avatar
Aurel committed
3607
    if update_dict.has_key('result_key_list') or force:
3608
      if not force:
Aurel's avatar
Aurel committed
3609
        action = update_dict['result_key_list']
3610
        if action == 'nothing':
Aurel's avatar
Aurel committed
3611
          return
3612
      for key in keys:
3613 3614
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
3615
      catalog.sql_search_result_keys = sql_search_result_keys
3616

3617
  def uninstall(self, context, **kw):
3618
    catalog = _getCatalogValue(self)
3619 3620 3621 3622
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3623
    object_path = kw.get('object_path', None)
3624 3625 3626 3627 3628
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3629 3630
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
3631
    catalog.sql_search_result_keys = sql_search_result_keys
3632 3633
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3634
  # Function to generate XML Code Manually
3635
  def generateXml(self, path=None):
3636
    obj = self._objects[path]
3637
    xml_data = '<key_list>'
3638 3639
    obj.sort()
    for key in obj:
3640 3641
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3642 3643
    return xml_data

Aurel's avatar
Aurel committed
3644 3645 3646 3647 3648
  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)
3649
    for path in self._objects.keys():
3650
      xml_data = self.generateXml(path=path)
3651
      bta.addObject(obj=xml_data, name=path, path=None)
3652

3653 3654
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3655
  def build(self, context, **kw):
3656
    catalog = _getCatalogValue(self)
3657 3658 3659
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3660
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
3661
    key_list = []
3662
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3663
      if key in sql_search_related_keys:
3664
        key_list.append(key)
3665
      elif not self.is_bt_for_diff:
3666
        raise NotFound, 'Related key "%r" not found in catalog' %(key,)
3667
    if len(key_list) > 0:
3668
      self._objects[self.__class__.__name__+'/'+'related_key_list'] = key_list
3669 3670

  def _importFile(self, file_name, file):
3671 3672 3673
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3674
    xml = parse(file)
3675 3676
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3677

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

3684
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3685
    if context.getTemplateFormatVersion() == 1:
3686
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3687
        return
3688 3689 3690
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3691
    else:
3692
      keys = self._archive.keys()
3693 3694
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3695
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
3696
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3697
      if not force:
Aurel's avatar
Aurel committed
3698 3699 3700 3701
        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
3702 3703 3704
        if action == 'nothing':
          return
      for key in keys:
3705 3706
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
3707
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
3708

3709
  def uninstall(self, context, **kw):
3710
    catalog = _getCatalogValue(self)
3711 3712 3713
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3714
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
3715
    object_path = kw.get('object_path', None)
3716 3717 3718 3719 3720
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3721 3722 3723 3724 3725
      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
3726
  # Function to generate XML Code Manually
3727
  def generateXml(self, path=None):
3728
    obj = self._objects[path]
3729
    xml_data = '<key_list>'
3730 3731
    obj.sort()
    for key in obj:
3732 3733
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3734 3735
    return xml_data

Aurel's avatar
Aurel committed
3736 3737 3738 3739 3740 3741
  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():
3742
      xml_data = self.generateXml(path=path)
3743
      bta.addObject(obj=xml_data, name=path, path=None)
3744

3745 3746
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3747
  def build(self, context, **kw):
3748
    catalog = _getCatalogValue(self)
3749 3750 3751
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3752
    sql_search_result_tables = list(catalog.sql_search_tables)
3753
    key_list = []
3754
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3755
      if key in sql_search_result_tables:
3756
        key_list.append(key)
3757
      elif not self.is_bt_for_diff:
3758
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
3759
    if len(key_list) > 0:
3760
      self._objects[self.__class__.__name__+'/'+'result_table_list'] = key_list
3761 3762

  def _importFile(self, file_name, file):
3763 3764 3765
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3766
    xml = parse(file)
3767 3768
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
Aurel's avatar
Aurel committed
3769

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

3776
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3777
    if context.getTemplateFormatVersion() == 1:
3778
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3779
        return
3780 3781 3782
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3783
    else:
3784
      keys = self._archive.keys()
3785 3786
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3787
    # XXX same as related keys
Aurel's avatar
Aurel committed
3788
    if update_dict.has_key('result_table_list') or force:
3789
      if not force:
Aurel's avatar
Aurel committed
3790
        action = update_dict['result_table_list']
3791
        if action == 'nothing':
Aurel's avatar
Aurel committed
3792
          return
3793
      for key in keys:
3794 3795
        if key not in sql_search_tables:
          sql_search_tables.append(key)
3796
      catalog.sql_search_tables = tuple(sql_search_tables)
3797 3798

  def uninstall(self, context, **kw):
3799
    catalog = _getCatalogValue(self)
3800 3801 3802 3803
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
3804
    object_path = kw.get('object_path', None)
3805 3806 3807 3808 3809
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3810 3811
      if key in sql_search_tables:
        sql_search_tables.remove(key)
3812
    catalog.sql_search_tables = sql_search_tables
3813 3814
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3815
  # Function to generate XML Code Manually
3816
  def generateXml(self, path=None):
3817
    obj = self._objects[path]
3818
    xml_data = '<key_list>'
3819 3820
    obj.sort()
    for key in obj:
3821 3822
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3823 3824
    return xml_data

Aurel's avatar
Aurel committed
3825 3826 3827 3828 3829 3830
  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():
3831
      xml_data = self.generateXml(path=path)
3832
      bta.addObject(obj=xml_data, name=path, path=None)
3833

3834 3835
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3836 3837

  def build(self, context, **kw):
3838
    catalog = _getCatalogValue(self)
3839 3840 3841 3842 3843 3844 3845 3846
    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)
3847
      elif not self.is_bt_for_diff:
3848
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3849
    if len(key_list) > 0:
3850
      self._objects[self.__class__.__name__+'/'+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3851

3852
  def _importFile(self, file_name, file):
3853 3854 3855
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3856
    xml = parse(file)
3857 3858
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3859 3860

  def install(self, context, trashbin, **kw):
3861
    catalog = _getCatalogValue(self)
3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874
    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()
3875 3876
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888
    # 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):
3889
    catalog = _getCatalogValue(self)
3890 3891 3892 3893
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3894
    object_path = kw.get('object_path', None)
3895 3896
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3897
    else:
3898 3899 3900 3901 3902 3903 3904
      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
3905
  # Function to generate XML Code Manually
3906 3907 3908 3909 3910
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3911 3912
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3913
    return xml_data
Aurel's avatar
Aurel committed
3914 3915 3916 3917

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3918 3919 3920 3921 3922
    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)
3923

3924 3925 3926 3927 3928 3929 3930 3931
# 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
3932
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3933 3934 3935 3936
    key_list = []
    for key in self._archive.keys():
      if key in sql_datetime_keys:
        key_list.append(key)
3937
      elif not self.is_bt_for_diff:
3938 3939 3940 3941 3942
        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):
3943 3944 3945
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3946
    xml = parse(file)
3947 3948
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3949 3950 3951 3952 3953 3954 3955

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

3956
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982
    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
3983
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3984 3985 3986 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 4013
    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)      
      
4014 4015
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
4016

4017
  def build(self, context, **kw):
4018
    catalog = _getCatalogValue(self)
4019 4020 4021 4022 4023 4024 4025 4026
    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)
4027
      elif not self.is_bt_for_diff:
4028
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
4029
    if len(key_list) > 0:
4030
      self._objects[self.__class__.__name__+'/'+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4031

4032
  def _importFile(self, file_name, file):
4033 4034 4035
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4036
    xml = parse(file)
4037 4038
    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
4039

4040
  def install(self, context, trashbin, **kw):
4041
    catalog = _getCatalogValue(self)
4042 4043 4044
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4045

4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066
    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
4067

4068
  def uninstall(self, context, **kw):
4069
    catalog = _getCatalogValue(self)
4070 4071 4072 4073
    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)
4074
    object_path = kw.get('object_path', None)
4075 4076 4077 4078 4079 4080 4081 4082 4083 4084
    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
4085
  # Function to generate XML Code Manually
4086 4087 4088 4089 4090
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4091 4092
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108
    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):
4109
    catalog = _getCatalogValue(self)
4110 4111 4112 4113 4114 4115 4116 4117
    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)
4118
      elif not self.is_bt_for_diff:
4119
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
4120
    if len(key_list) > 0:
4121
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
4122 4123

  def _importFile(self, file_name, file):
4124 4125 4126
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4127
    xml = parse(file)
4128 4129
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4130 4131

  def install(self, context, trashbin, **kw):
4132
    catalog = _getCatalogValue(self)
4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159
    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):
4160
    catalog = _getCatalogValue(self)
4161 4162 4163 4164
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
4165
    object_path = kw.get('object_path', None)
4166 4167 4168 4169 4170 4171 4172 4173 4174 4175
    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
4176
  # Function to generate XML Code Manually
4177 4178 4179 4180 4181
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4182 4183
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198
    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):
4199
    catalog = _getCatalogValue(self)
4200 4201 4202 4203 4204 4205 4206 4207
    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)
4208
      elif not self.is_bt_for_diff:
4209
        raise NotFound, 'Multivalue key "%r" not found in catalog' %(key,)
4210
    if len(key_list) > 0:
4211
      self._objects[self.__class__.__name__+'/'+'multivalue_key_list'] = key_list
4212 4213

  def _importFile(self, file_name, file):
4214 4215 4216
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4217
    xml = parse(file)
4218 4219
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4220 4221

  def install(self, context, trashbin, **kw):
4222
    catalog = _getCatalogValue(self)
4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248
    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):
4249
    catalog = _getCatalogValue(self)
4250 4251 4252 4253
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
4254
    object_path = kw.get('object_path', None)
4255 4256 4257 4258 4259 4260 4261 4262 4263 4264
    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
4265
  # Function to generate XML Code Manually
4266 4267 4268 4269 4270
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4271 4272
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287
    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):
4288
    catalog = _getCatalogValue(self)
4289 4290 4291 4292 4293 4294 4295 4296
    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)
4297
      elif not self.is_bt_for_diff:
4298
        raise NotFound, 'Topic key "%r" not found in catalog' %(key,)
4299
    if len(key_list) > 0:
4300
      self._objects[self.__class__.__name__+'/'+'topic_key_list'] = key_list
4301 4302

  def _importFile(self, file_name, file):
4303 4304 4305
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4306
    xml = parse(file)
4307 4308
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4309 4310

  def install(self, context, trashbin, **kw):
4311
    catalog = _getCatalogValue(self)
4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338
    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):
4339
    catalog = _getCatalogValue(self)
4340 4341 4342 4343
    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)
4344
    object_path = kw.get('object_path', None)
4345 4346 4347 4348 4349 4350 4351 4352 4353 4354
    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
4355
  # Function to generate XML Code Manually
4356 4357 4358 4359 4360
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4361 4362
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373
    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)

4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385
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)
4386
      elif not self.is_bt_for_diff:
4387 4388 4389 4390 4391
        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):
4392 4393 4394
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4395
    xml = parse(file)
4396 4397
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463

  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)

4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476
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)
4477
      elif not self.is_bt_for_diff:
4478 4479 4480 4481 4482
        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):
4483 4484 4485
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4486
    xml = parse(file)
4487 4488
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567

  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)
4568
      elif not self.is_bt_for_diff:
4569 4570 4571 4572 4573
        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):
4574 4575 4576
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4577
    xml = parse(file)
4578 4579
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645

  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)

4646 4647 4648 4649
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4650 4651 4652
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4653
      else: # XXX backward compatibility
4654 4655
        lang = lang_key
        catalog = 'erp5_ui'
4656
      path = posixpath.join(lang, catalog)
4657 4658
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4659 4660 4661
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4662

4663
  def preinstall(self, context, installed_item, **kw):
4664 4665 4666 4667
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
4668
        if installed_item._objects.has_key(path):
4669 4670
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
4671
          old_obj_code = installed_item._objects[path]
4672 4673 4674 4675 4676
          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
4677
      old_keys = installed_item._objects.keys()
4678 4679 4680 4681 4682
      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

4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710
  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', {})
4711 4712
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
4713 4714
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4715
          if not force:
4716
            action = update_dict[key]
4717
            if action == 'nothing':
4718
              continue
4719
          lang, catalog = self._splitKey(key)
4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735

          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)
4736 4737
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4738 4739 4740 4741
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
4742
            self._importCatalogLanguage(localizer, catalog, lang, po)
4743 4744
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4745
      for lang, catalogs in self._archive.iteritems():
4746 4747 4748
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778
          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)
4779 4780

  def export(self, context, bta, **kw):
4781
    if len(self._objects) == 0:
4782 4783 4784
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
4785
    for key, obj in self._objects.iteritems():
4786 4787
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
4788 4789 4790 4791 4792 4793 4794 4795
      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'))
4796 4797

  def _importFile(self, file_name, file):
4798 4799
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4800 4801
      text = file.read()
      self._objects[file_name[:-3]] = text
4802 4803
    elif name == 'language.xml':
      xml = parse(file)
4804 4805
      name = xml.find('name').text
      code = xml.find('code').text
4806
      self._objects[code] = name
4807

Aurel's avatar
Aurel committed
4808 4809
class LocalRolesTemplateItem(BaseTemplateItem):

4810
  def __init__(self, id_list, **kw):
4811
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4812 4813
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4814 4815 4816
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4817
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4818 4819
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4820
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4821

Christophe Dumez's avatar
Christophe Dumez committed
4822
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4823
  def generateXml(self, path=None):
4824
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4825 4826
    # local roles
    xml_data = '<local_roles_item>'
4827
    xml_data += '\n <local_roles>'
4828
    for key in sorted(local_roles_dict):
4829
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4830 4831
      tuple = local_roles_dict[key]
      for item in tuple:
4832 4833 4834 4835
        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
4836
    return xml_data
4837

Aurel's avatar
Aurel committed
4838 4839 4840 4841 4842 4843 4844 4845
  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)

4846
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4847
      encode_folders = []
4848
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4849
        if '%' not in folder:
4850
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4851 4852
        else:
          encode_folders.append(folder)
4853
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4854 4855 4856 4857
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
4858 4859 4860
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4861 4862
    xml = parse(file)
    # local roles
4863
    local_roles_list = xml.findall('//role')
Aurel's avatar
Aurel committed
4864 4865
    local_roles_dict = {}
    for role in local_roles_list:
4866 4867
      id = role.get('id')
      item_type_list = [item.text for item in role]
Aurel's avatar
Aurel committed
4868
      local_roles_dict[id] = item_type_list
4869
    self._objects['local_roles/%s' % (file_name[:-4],)] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880

  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
4881 4882
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4883
        local_roles_dict = self._objects[roles_path][0]
4884
        setattr(obj, '__ac_local_roles__', local_roles_dict)
4885
        obj.reindexObject()
Aurel's avatar
Aurel committed
4886

4887
  def uninstall(self, context, object_path=None, **kw):
Aurel's avatar
Aurel committed
4888
    p = context.getPortalObject()
4889 4890 4891 4892 4893
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
Aurel's avatar
Aurel committed
4894 4895 4896
      path = roles_path.split('/')[1:]
      obj = p.unrestrictedTraverse(path)
      setattr(obj, '__ac_local_roles__', {})
4897
      obj.reindexObject()
4898

4899 4900 4901
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4902
    in part or completely. Each object is separated from its
4903 4904 4905 4906 4907 4908 4909 4910 4911 4912
    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
4913 4914
      - object without optimal actions
      - list of relation between portal type and workflow
4915 4916 4917 4918 4919 4920 4921 4922 4923 4924

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

    - site property definition
      - id
      - type
4925
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4926

4927 4928
    - document/propertysheet/extension/test definition
      - copy of the local file
4929

4930
    - message transalation definition
4931
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4932

4933 4934
    The Business Template properties are exported to the bt folder with
    one property per file
4935

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4936 4937
    Technology:

4938 4939
    - 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
4940

4941
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4942 4943 4944 4945

    Use case:

    - install core ERP5 (the minimum)
4946

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

4949 4950
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4951
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4952 4953 4954 4955 4956
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4957
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4958 4959 4960

    # Declarative security
    security = ClassSecurityInfo()
4961
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4962 4963 4964 4965

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4966
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4967
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4968
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4969
                      , PropertySheet.BusinessTemplate
4970
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4971 4972
                      )

4973 4974 4975 4976 4977 4978
    # 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."""
4979
         , 'icon'           : 'file_icon.gif'
4980 4981 4982 4983 4984 4985 4986 4987 4988
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4989 4990
    # This is a global variable
    # Order is important for installation
4991 4992 4993 4994 4995 4996
    # 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 )
4997 4998
    _item_name_list = [
      '_product_item',
4999
      '_property_sheet_item',
5000
      '_constraint_item',
5001 5002 5003 5004
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5005
      '_tool_item',
5006 5007 5008 5009
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
5010
      '_portal_type_workflow_chain_item',
5011 5012 5013 5014
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
5015 5016
      '_category_item',
      '_module_item',
5017
      '_path_item',
5018
      '_skin_item',
5019
      '_registered_skin_selection_item',
5020
      '_preference_item',
5021
      '_action_item',
5022
      '_portal_type_roles_item',
5023
      '_local_roles_item',
5024
      '_catalog_method_item',
5025 5026 5027
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
5028
      '_catalog_keyword_key_item',
5029
      '_catalog_datetime_key_item',
5030 5031 5032 5033
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
5034
      '_catalog_scriptable_key_item',
5035 5036
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
5037 5038 5039 5040
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5041 5042 5043 5044 5045 5046
      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
5047
        self._baseGetTemplateFormatVersion()
5048

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5049 5050 5051
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
5052

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5053
      return 0
5054

5055
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
5056 5057 5058 5059 5060 5061 5062
    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".
5063 5064
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
5065
          # XXX Not good to access the attribute directly,
5066 5067 5068
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
5069

5070 5071
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
5072 5073 5074 5075 5076 5077
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

5078
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
5079 5080 5081 5082 5083 5084 5085 5086
        """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)
5087

5088 5089
    security.declareProtected(Permissions.ManagePortal, 'storeTemplateItemData')
    def storeTemplateItemData(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5090
      """
5091
        Instanciate and Store Template items into properties.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5092
      """
5093
      # Store all Data
5094 5095
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
5096
      self._portal_type_workflow_chain_item = \
5097
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
5098 5099 5100 5101
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
5102 5103 5104
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
5105 5106 5107 5108 5109 5110
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
5111
      self._portal_type_roles_item = \
5112
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
5113 5114 5115 5116 5117 5118 5119 5120
      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())
5121 5122
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142
      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())
5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154
      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())
5155 5156
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
5157 5158
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
5159 5160
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
5161
               self.getTemplateCatalogKeywordKeyList())
5162 5163 5164
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
5165 5166
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
5167
               self.getTemplateCatalogFullTextKeyList())
5168 5169
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
5170
               self.getTemplateCatalogRequestKeyList())
5171 5172
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
5173
               self.getTemplateCatalogMultivalueKeyList())
5174 5175 5176
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
5177 5178
      self._local_roles_item = \
          LocalRolesTemplateItem(
5179
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5180 5181 5182
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
5183 5184 5185
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
5186 5187 5188 5189 5190 5191
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
5192

5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206
    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()

5207 5208
      # Build each part
      for item_name in self._item_name_list:
5209 5210 5211 5212
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
5213

5214
    build = WorkflowMethod(build)
5215 5216

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5217
      """
5218
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5219
      """
5220
      return self.portal_templates.publish(self, url, username=username,
5221
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5222

5223
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5224
      """
5225
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5226
      """
5227
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5228

5229 5230 5231 5232 5233
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
5234 5235 5236 5237 5238 5239 5240 5241 5242 5243
      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
5244 5245
      return False

5246
    def preinstall(self, check_dependencies=1, **kw):
5247 5248 5249
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
5250
      """
5251 5252 5253 5254 5255
      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()
5256

5257 5258
      modified_object_list = {}
      bt_title = self.getTitle()
5259 5260 5261 5262 5263 5264 5265

      #  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)
5266 5267 5268
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5269
        installed_bt_format = installed_bt.getTemplateFormatVersion()
5270

5271
      # if reinstall business template, must compare to object in ZODB
5272
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
5273
      # same if we make a diff and select only one business template
5274
      reinstall = 0
5275 5276
      if installed_bt == self:
        reinstall = 1
5277
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
5278 5279
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                   id=INSTALLED_BT_FOR_DIFF)
5280 5281 5282 5283 5284 5285 5286
          # 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)
5287

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5288
      new_bt_format = self.getTemplateFormatVersion()
5289 5290 5291 5292 5293 5294
      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:
5295
          item = getattr(self, item_name, None)
5296 5297 5298 5299
          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
5300

5301
      for item_name in self._item_name_list:
5302
        new_item = getattr(self, item_name, None)
5303
        installed_item = getattr(installed_bt, item_name, None)
5304
        if new_item is not None:
5305
          if installed_item is not None and hasattr(installed_item, '_objects'):
5306
            modified_object = new_item.preinstall(context=self, 
5307 5308
                                                  installed_item=installed_item,
                                                  installed_bt=installed_bt)
5309 5310 5311 5312 5313 5314 5315
            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:
5316
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5317

5318 5319
      return modified_object_list

5320
    def _install(self, force=1, object_to_update=None, update_translation=0,
Sebastien Robin's avatar
Sebastien Robin committed
5321
                 update_catalog=_MARKER, **kw):
5322
      """
Christophe Dumez's avatar
Christophe Dumez committed
5323
        Install a new Business Template, if force, all will be upgraded or installed
5324 5325
        otherwise depends of dict object_to_update
      """
5326 5327 5328 5329
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
5330

Sebastien Robin's avatar
Sebastien Robin committed
5331 5332
      site = self.getPortalObject()
      installed_bt = site.portal_templates.getInstalledBusinessTemplate(
5333
                                                           self.getTitle())
5334 5335
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5336
        if installed_bt.getTemplateFormatVersion() == 0:
5337
          force = 1
Sebastien Robin's avatar
Sebastien Robin committed
5338 5339 5340
        if site.portal_workflow.isTransitionPossible(
            installed_bt, 'replace'):
          installed_bt.replace(self)
5341

Sebastien Robin's avatar
Sebastien Robin committed
5342
      trash_tool = getToolByName(site, 'portal_trash', None)
5343 5344 5345
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

5346 5347 5348
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
5349

5350 5351 5352
      if not force:
        self.checkDependencies()

5353 5354 5355
      from Products.ERP5.ERP5Site import ERP5Generator
      generator_class = getattr(site, '_generator_class', ERP5Generator)
      gen = generator_class()
5356 5357
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
5358 5359 5360 5361 5362 5363
        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)
5364 5365
      if not force:
        if len(object_to_update) == 0:
5366 5367 5368 5369 5370
          # 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():
5371
            LOG('Business Template', 0, 'Updating Business Template Workflows')
5372
            gen.setupWorkflow(site)
5373
          return
5374

5375 5376
      # 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
5377
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
5378 5379 5380 5381 5382
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
5383
      if len(object_to_update) or force:
5384 5385 5386
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
5387 5388
            item.install(self, force=force, object_to_update=object_to_update, 
                               trashbin=trashbin, installed_bt=installed_bt)
5389

5390
      # update catalog if necessary
Sebastien Robin's avatar
Sebastien Robin committed
5391 5392 5393
      if update_catalog is _MARKER and force and self.isCatalogUpdatable():
        # override update_catalog parameter only if value
        # is not explicitely passed.
5394
        update_catalog = 1
Sebastien Robin's avatar
Sebastien Robin committed
5395 5396
      elif update_catalog is _MARKER:
        update_catalog = 0
5397
      if update_catalog:
5398
        catalog = _getCatalogValue(self)
5399
        if (catalog is None) or (not site.isIndexable):
5400 5401 5402 5403 5404
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
5405

5406
      # get objects to remove
5407
      # do remove after because we may need backup object from installation
5408
      remove_object_dict = {}
5409 5410
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
5411
          remove_object_dict[path] = action
5412

5413
      # remove object from old business template
5414
      if len(remove_object_dict):
5415
        # XXX: this code assumes that there is an installed_bt
5416
        for item_name in reversed(installed_bt._item_name_list):
5417
          item = getattr(installed_bt, item_name, None)
5418
          if item is not None:
5419
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
5420

5421 5422 5423 5424 5425 5426

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

5427
      # check if we have to update business template workflow
5428
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
5429
        LOG('Business Template', 0, 'Updating Business Template Workflows')
5430 5431 5432 5433 5434
        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)

5435 5436
      # remove trashbin if empty
      if trashbin is not None:
5437
        if len(trashbin) == 0:
5438 5439
          trash_tool.manage_delObjects([trashbin.getId(),])

5440 5441
      if update_catalog:
        site.ERP5Site_reindexAll()
5442

5443 5444
      # Update translation table, in case we added new portal types or
      # workflow states.
5445 5446
      if update_translation:
        site.ERP5Site_updateTranslationTable()
5447

5448 5449
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
5450

5451
    security.declareProtected(Permissions.ManagePortal, 'install')
5452 5453 5454
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
5455
      """
5456
      return self._install(**kw)
5457

5458
    install = WorkflowMethod(install)
5459

5460
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
5461
    def reinstall(self, **kw):
5462 5463 5464 5465
      """Reinstall Business Template.
      """
      return self._install(**kw)

5466
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5467

5468
    security.declareProtected(Permissions.ManagePortal, 'trash')
5469 5470
    def trash(self, new_bt, **kw):
      """
5471
        Trash unnecessary items before upgrading to a new business
5472
        template.
5473
        This is similar to uninstall, but different in that this does
5474
        not remove all items.
5475
      """
5476 5477
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5478
        item = getattr(self, item_name, None)
5479 5480
        if item is not None:
          item.trash(
5481
                self,
5482
                getattr(new_bt, item_name))
5483

5484
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
5485
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5486
      """
5487
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5488
      """
5489 5490 5491
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5492
        item = getattr(self, item_name, None)
5493
        if item is not None:
5494
          item.uninstall(self, **kw)
5495
      # It is better to clear cache because the uninstallation of a
5496
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
5497
      self.getPortalObject().portal_caches.clearAllCache()
5498

5499 5500
    uninstall = WorkflowMethod(uninstall)

5501
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5502
    def _clean(self):
5503
      """
5504
        Clean built information.
5505
      """
5506
      # First, remove obsolete attributes if present.
5507 5508 5509 5510
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
5511
                    '_module_archive',
5512 5513 5514
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
5515
                    '_property_sheet_archive'):
5516 5517 5518
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
5519 5520
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
5521

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

5524
    security.declareProtected(Permissions.AccessContentsInformation,
5525
                              'getBuildingState')
5526
    def getBuildingState(self, default=None, id_only=1):
5527
      """
5528
        Returns the current state in building
5529
      """
5530
      portal_workflow = getToolByName(self, 'portal_workflow')
5531 5532
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
5533
      return wf._getWorkflowStateOf(self, id_only=id_only )
5534

5535
    security.declareProtected(Permissions.AccessContentsInformation,
5536
                              'getInstallationState')
5537
    def getInstallationState(self, default=None, id_only=1):
5538
      """
5539
        Returns the current state in installation
5540
      """
5541
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
5542 5543
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
5544
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5545

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5546 5547 5548 5549 5550 5551
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
5552
      export_string = portal_templates.manage_exportObject(
5553 5554
                                               id=self.getId(),
                                               toxml=1,
5555
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5556
      return export_string
5557

5558
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5559
      """
5560 5561
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5562
      """
5563 5564
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
5565 5566 5567 5568
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
5569
        # XXX Why do we need to return a tuple ?
5570 5571
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5572

5573
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5574
      """
5575 5576
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5577
      """
5578
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5579

5580
    def getTemplateBaseCategoryList(self):
5581
      """
5582 5583
      We have to set this method because we want an
      ordered list
5584
      """
5585
      return self._getOrderedList('template_base_category')
5586

5587
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5588
      """
5589 5590
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5591
      """
5592
      return self._getOrderedList('template_workflow_id')
5593

5594
    def getTemplatePortalTypeIdList(self):
5595
      """
5596 5597
      We have to set this method because we want an
      ordered list
5598
      """
5599
      return self._getOrderedList('template_portal_type_id')
5600

5601 5602 5603 5604 5605 5606 5607
    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
5608 5609 5610 5611 5612 5613 5614
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

5615 5616 5617 5618 5619 5620 5621
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

5622 5623 5624 5625 5626 5627
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
5628

5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649
    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')

5650
    def getTemplateActionPathList(self):
5651
      """
5652 5653
      We have to set this method because we want an
      ordered list
5654
      """
5655
      return self._getOrderedList('template_action_path')
5656

5657
    def getTemplatePortalTypeRoleList(self):
5658 5659 5660 5661
      """
      We have to set this method because we want an
      ordered list
      """
5662
      return self._getOrderedList('template_portal_type_role')
5663

5664
    def getTemplateLocalRoleList(self):
5665 5666 5667 5668
      """
      We have to set this method because we want an
      ordered list
      """
5669
      return self._getOrderedList('template_local_role')
5670

5671
    def getTemplateSkinIdList(self):
5672
      """
5673 5674
      We have to set this method because we want an
      ordered list
5675
      """
5676
      return self._getOrderedList('template_skin_id')
5677

5678 5679 5680 5681 5682 5683 5684
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

5685
    def getTemplateModuleIdList(self):
5686
      """
5687 5688
      We have to set this method because we want an
      ordered list
5689
      """
5690
      return self._getOrderedList('template_module_id')
5691 5692 5693 5694 5695 5696 5697

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5699 5700 5701 5702 5703 5704 5705
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5706
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5707 5708 5709 5710
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5711
      if self.getBuildingState() != 'built':
5712
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5713
              'Business Template must be built before export'
5714

Aurel's avatar
Aurel committed
5715 5716 5717 5718 5719 5720 5721
      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)

5722
      # export bt
5723
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
5724
      for prop in self.propertyMap():
5725
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5726
        id = prop['id']
5727
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5728
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5729
          continue
Aurel's avatar
Aurel committed
5730
        value = self.getProperty(id)
5731 5732
        if value is None:
          continue
5733
        if prop_type in ('text', 'string', 'int', 'boolean'):
5734
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
5735
        elif prop_type in ('lines', 'tokens'):
5736
          bta.addObject(obj=str('\n').join(value), name=id,
5737
                        path=path+os.sep+'bt', ext='')
5738

Aurel's avatar
Aurel committed
5739 5740 5741
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5742

5743
      return bta.finishCreation(self.getTitle())
Aurel's avatar
Aurel committed
5744

5745
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5746 5747
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5748
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5749 5750 5751 5752 5753
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
5754 5755

      self.storeTemplateItemData()
5756

5757 5758
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
5759
      orig_module_dict = {}
5760
      instance_oid_list = []
5761 5762
      for template_id in self.getTemplateDocumentIdList():
          module_id = 'Products.ERP5Type.Document.' + template_id
5763
          orig_module_dict[module_id] = sys.modules.get(module_id)
5764 5765 5766 5767 5768 5769 5770 5771 5772 5773
          # 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__
5774

Aurel's avatar
Aurel committed
5775 5776
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5777

5778 5779 5780 5781 5782 5783
      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)
5784 5785
        self._p_jar.cacheMinimize()
        gc.collect()
5786

5787 5788
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
5789 5790 5791 5792 5793 5794
      # 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
5795

5796 5797 5798 5799 5800
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5801 5802 5803
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5804
      return items_list
5805

5806 5807 5808 5809 5810 5811 5812 5813 5814 5815
    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:
5816
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5817
          dependency = dependency_couple_list[0]
5818 5819
          if dependency in (None, ''):
            continue
5820 5821
          version_restriction = None
          if len(dependency_couple_list) > 1:
5822
            version_restriction = dependency_couple_list[1]
5823 5824 5825
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5826 5827 5828
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5829
                  or (version_restriction not in (None, '') and
5830 5831 5832 5833
                     (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)
5834

5835 5836 5837 5838 5839 5840 5841 5842
    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
5843
    def diffObject(self, REQUEST, **kw):
5844 5845
      """
        Make a diff between an object in the Business Template
5846
        and the same in the Business Template installed in the site
5847 5848 5849 5850
      """

      class_name_dict = {
        'Product' : '_product_item',
5851
        'PropertySheet' : '_property_sheet_item',
5852
        'Constraint' : '_constraint_item',
5853 5854 5855 5856 5857 5858 5859 5860 5861
        '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',
5862
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5863 5864 5865 5866
        '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',
5867 5868 5869
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5870
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5871
        'Path' : '_path_item',
5872
        'Preference' : '_preference_item',
5873
        'Action' : '_action_item',
5874
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5875
        'LocalRoles' : '_local_roles_item',
5876 5877 5878
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5879
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5880
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5881 5882 5883 5884
        '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
5885
        'Tool': '_tool_item',
5886
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5887 5888
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5889
        }
5890

5891 5892
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5893

Christophe Dumez's avatar
Christophe Dumez committed
5894
      # Get objects
5895
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5896

5897
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
5898
      # Compare with a given business template
5899
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5900 5901
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5902 5903
        if bt2_id == self.getId():
          compare_to_zodb = 1
5904
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5905 5906
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5907 5908 5909
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5910 5911
          compare_to_zodb = 1
      if compare_to_zodb:
5912 5913
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5914
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5915 5916 5917
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5918

5919 5920
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5921
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5922
        # XXX maybe only build for the given object to gain time
5923
        installed_item.build(self)
5924 5925 5926
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5927

Christophe Dumez's avatar
Christophe Dumez committed
5928
      # Real Zope Objects (can be exported into XML directly by Zope)
5929 5930
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5931
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5932
                     '_skin_item', '_action_item', '_tool_item', ]
5933

Christophe Dumez's avatar
Christophe Dumez committed
5934
      # Not considered as objects by Zope (will be exported into XML manually)
5935
      # XXX Bad naming
5936 5937 5938 5939
      item_list_2 = ['_site_property_item',
                     '_module_item',
                     '_catalog_result_key_item', 
                     '_catalog_related_key_item',
5940 5941
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
5942
                     '_catalog_datetime_key_item',
5943 5944 5945 5946
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5947
                     '_catalog_scriptable_key_item',
5948 5949
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5950 5951 5952 5953 5954 5955
                     '_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',
5956
                     '_portal_type_workflow_chain_item',]
5957

Christophe Dumez's avatar
Christophe Dumez committed
5958
      # Text objects (no need to export them into XML)
5959
      # XXX Bad naming
5960 5961
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5962
                     '_test_item', '_message_translation_item',]
5963

5964
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5965 5966 5967
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5968 5969
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
5970
        # XML Export in memory
5971
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5972 5973
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5974
        new_obj_xml = f1.getvalue()
5975
        f1.close()
5976 5977 5978 5979
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5980
        # End of XML export
5981

5982
        # Diff between XML objects
5983 5984
        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
5985
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5986 5987 5988
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5989

5990
      elif item_name in item_list_2:
5991
        # Generate XML code manually
5992 5993
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5994 5995
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5996
        # End of XML Code Generation
5997

5998
        # Diff between XML objects
5999 6000
        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
6001
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
6002 6003 6004
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
6005

6006
      elif item_name in item_list_3:
6007
        # Diff between text objects
6008 6009 6010 6011
        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
6012
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
6013 6014
          diff_msg += '\n'.join(diff_list)
        else:
6015
          diff_msg = 'No diff'
6016

6017
      else:
6018
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
6019

6020
      if compare_to_zodb:
6021
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
6022

6023
      return diff_msg
6024

6025

6026 6027 6028 6029
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
6030 6031
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
6032 6033 6034 6035 6036 6037 6038
      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 [])
6039 6040
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

6041
      p = self.getPortalObject()
6042
      for id in bt_portal_types_id_list:
6043 6044
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
6045
          continue
Julien Muchembled's avatar
Julien Muchembled committed
6046
        if portal_type.getRoleInformationList():
6047 6048
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
6049

6050 6051 6052 6053
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
6054
        action_list = []
6055 6056 6057 6058 6059 6060 6061
        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'):
6062
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
6063 6064
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
6065

6066 6067 6068 6069
        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)
6070

6071
        for h_id in hidden_content_type_list:
6072 6073 6074
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
6075

6076 6077 6078 6079
        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)
6080

6081 6082 6083 6084
        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)
6085

6086 6087 6088 6089
        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)
6090

6091
        for workflow_id in [chain for chain in wtool.getChainFor(id)
6092
                                    if chain != '(Default)']:
6093 6094 6095
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
6096

6097 6098 6099 6100
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
6101
      bt_action_list.sort()
6102
      bt_wf_chain_list.sort()
6103

6104 6105 6106 6107 6108 6109 6110
      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)
6111 6112 6113 6114 6115 6116 6117 6118 6119
      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:
6120 6121
        raise TemplateConditionError, 'No module defined in business template'

6122 6123 6124 6125 6126 6127 6128 6129
      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:
6130
          return type_list
6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144

        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():
6145
            type_list.update(getChildPortalType(hidden_ptype_id))
6146
        return type_list
6147

6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194
      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

6195 6196 6197
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
6198
  setattr(BusinessTemplate, key, None)
6199

6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226
# 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)
6227

6228 6229 6230 6231 6232 6233 6234 6235

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

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