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

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

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

81 82
# those attributes from CatalogMethodTemplateItem are kept for
# backward compatibility
Aurel's avatar
Aurel committed
83 84
catalog_method_list = ('_is_catalog_list_method_archive',
                       '_is_uncatalog_method_archive',
85 86
                       '_is_clear_method_archive',
                       '_is_filtered_archive',)
87

88 89 90
catalog_method_filter_list = ('_filter_expression_archive',
                              '_filter_expression_instance_archive',
                              '_filter_type_archive',)
91

92 93
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'

94 95 96 97 98 99
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:
100 101 102 103
    try:
      return acquisition_context.getPortalObject().portal_catalog.objectIds('SQLCatalog')[0]
    except IndexError:
      return None
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
  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

123 124 125 126 127
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.
  """
128 129
  if hasattr(aq_base(obj), 'uid'):
    obj.uid = None
130 131 132
  for subobj in obj.objectValues():
    _recursiveRemoveUid(subobj)

133
def removeAll(entry):
134 135 136
  warn('removeAll is deprecated; use shutil.rmtree instead.',
       DeprecationWarning)
  shutil.rmtree(entry, True)
Aurel's avatar
Aurel committed
137

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
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
  """
  pw = context.portal_workflow
  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)

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
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]

182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
def registerSkinFolder(skin_tool, skin_folder):
  request = skin_tool.REQUEST
  register_skin_selection = request.get('your_register_skin_selection', 1)
  reorder_skin_selection = request.get('your_reorder_skin_selection', 1)
  skin_layer_list = request.get('your_skin_layer_list', 
                                skin_tool.getSkinSelections()) 

  skin_folder_id = skin_folder.getId()

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

199 200 201
  if isinstance(skin_selection_list, basestring):
    skin_selection_list = skin_selection_list.split()

202 203 204 205 206 207 208 209 210
  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 ''
211
    selection_list = selection.split(',')
212
    if (skin_folder_id not in selection_list):
213
      selection_list.insert(0, skin_folder_id)
214 215
    if reorder_skin_selection:
      selection_list.sort(
216 217
        key=lambda x: x in skin_tool.objectIds() and skin_tool[x].getProperty(
        'business_template_skin_layer_priority', skin_tool[x].meta_type == 'Filesystem Directory View' and -1 or 0) or 0, reverse=True)
218
    if (skin_name in skin_layer_list):
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
      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
278 279 280
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
281
  """
Aurel's avatar
Aurel committed
282 283 284 285 286 287 288 289 290 291 292 293

  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
294

Aurel's avatar
Aurel committed
295 296 297 298 299
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
300
    Class archiving business template into a folder tree
301
  """
Aurel's avatar
Aurel committed
302 303 304 305 306 307
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
308
      shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
309 310 311
      os.makedirs(self.path)

  def addFolder(self, name=''):
Jérome Perrin's avatar
Jérome Perrin committed
312
    if name != '':
313
      name = os.path.normpath(name)
Aurel's avatar
Aurel committed
314
      path = os.path.join(self.path, name)
315
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
316 317 318
        os.makedirs(path)
      return path

319
  def addObject(self, obj, name, path=None, ext='.xml'):
320 321 322
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
323 324 325
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
326
      if '%' not in path:
327 328 329 330
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
Aurel's avatar
Aurel committed
331
      object_path = os.path.join(path, name)
332
    f = open(object_path+ext, 'wb')
333
    f.write(str(obj))
Aurel's avatar
Aurel committed
334 335 336
    f.close()

  def _initImport(self, file=None, path=None, **kw):
337
    # Normalize the paths to eliminate the effect of double-slashes.
338 339 340 341 342 343 344 345
    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
346

347
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
348 349 350
    """
      Import file from a local folder
    """
351
    class_name = item.__class__.__name__
352 353 354 355 356 357 358
    root_path_len = self.root_path_len
    prefix_len = root_path_len + len(class_name) + len(os.sep)
    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:]
359
          if '%' in file_name:
360
            file_name = unquote(file_name)
361
          item._importFile(file_name, file)
362
        finally:
363
          file.close()
364

Aurel's avatar
Aurel committed
365 366 367 368 369 370
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
371
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
372 373 374 375 376
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
377
      shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
378 379 380 381 382 383
      os.makedirs(self.path)
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)

  def addFolder(self, name=''):
384
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
385
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
386 387
      os.makedirs(name)

388
  def addObject(self, obj, name, path=None, ext='.xml'):
389 390 391
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
392 393 394
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
395
      if '%' not in path:
396 397 398 399
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
Aurel's avatar
Aurel committed
400
      object_path = os.path.join(path, name)
401
    f = open(object_path+ext, 'wb')
402
    f.write(str(obj))
Aurel's avatar
Aurel committed
403 404 405 406 407
    f.close()

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
408
    shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
409 410 411 412 413
    return self.fobj

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

414
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
415 416
    """
      Import all file from the archive to the site
417
    """
418
    class_name = item.__class__.__name__
Aurel's avatar
Aurel committed
419 420 421 422 423
    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
424 425
      if 'CVS' in info.name.split('/'):
        continue
Yoshinori Okuji's avatar
Yoshinori Okuji committed
426 427
      if '.svn' in info.name.split('/'):
        continue
428
      if class_name in info.name.split('/'):
Aurel's avatar
Aurel committed
429 430
        if info.isreg():
          file = tar.extractfile(info)
431 432
          tar_file_name = info.name.startswith('./') and info.name[2:] or \
              info.name
433
          folders = tar_file_name.split('/')
434
          file_name = ('/').join(folders[2:])
435
          if '%' in file_name:
436
            file_name = unquote(file_name)
437
          item._importFile(file_name, file)
Aurel's avatar
Aurel committed
438 439 440
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
441

442
class TemplateConditionError(Exception): pass
443
class TemplateConflictError(Exception): pass
444
class BusinessTemplateMissingDependency(Exception): pass
445

446
class BaseTemplateItem(Implicit, Persistent):
447
  """
448
    This class is the base class for all template items.
449
    is_bt_for_diff means This BT is used to compare self temporary BT with installed BT
450
  """
451
  is_bt_for_diff = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
452

453
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
454
    self.__dict__.update(kw)
455
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
456
    self._objects = PersistentMapping()
457
    for id in id_list:
458 459
      if id is not None and id != '':
        self._archive[id] = None
460 461 462 463

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

464
  def preinstall(self, context, installed_bt, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
465 466 467 468 469 470 471 472
    """
      Build a list of added/removed/changed files between the BusinessTemplate
      being installed (self) and the installed one (installed_bt).
      Note : we compare files between BTs, *not* between the installed BT and
      the objects in the DataFS.

      XXX: -12 used here is -len('TemplateItem')
    """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
473 474
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
475
      new_keys = self._objects.keys()
476
      for path in new_keys:
477
        if installed_bt._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
478
          # compare objects to see it there are changes
479 480
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
481 482
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
483
          # else, compared versions are identical, don't overwrite the old one
484 485
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
486
      # list removed objects
487 488 489 490 491 492 493
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
494
    pass
495 496 497

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

499
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
500 501 502 503 504 505
    """
      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.
    """
506 507 508
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
509
    keys.reverse()
510 511 512 513 514 515 516 517 518 519 520
    # 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)
521 522 523 524
        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
525

526

527 528 529 530
  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
531
  def export(self, context, bta, **kw):
532
    pass
Aurel's avatar
Aurel committed
533

534 535
  def getKeys(self):
    return self._objects.keys()
536

Aurel's avatar
Aurel committed
537
  def importFile(self, bta, **kw):
538
    bta.importFiles(item=self)
539

540 541 542
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
543
    """
544 545 546 547 548 549 550 551 552 553 554 555 556 557
    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):
558
        obj.deletePdfContent()
559 560
    elif meta_type == 'Script (Python)':
      obj._code = None
561 562
    return obj

563 564 565
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
566
  """
567

568 569 570 571
  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()
572
      self._archive.clear()
573 574 575
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
576

577
  def export(self, context, bta, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
578 579 580 581
    """
      Export the business template : fill the BusinessTemplateArchive with
      objects exported as XML, hierarchicaly organised.
    """
582 583 584
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
Vincent Pelletier's avatar
Vincent Pelletier committed
585
    for key, obj in self._objects.iteritems():
586
      # create folder and subfolders
587
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
588 589 590
      encode_folders = []
      for folder in folders.split('/'):
        if '%' not in folder:
591
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
592 593 594
        else:
          encode_folders.append(folder)
      path = os.path.join(root_path, (os.sep).join(encode_folders))
595 596 597
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
598 599
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
600

Aurel's avatar
Aurel committed
601
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
602
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
603 604 605
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
606
      relative_url = '/'.join([url,id])
607 608
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
609
      obj = self.removeProperties(obj)
Vincent Pelletier's avatar
Vincent Pelletier committed
610 611 612
      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
613
        groups = deepcopy(obj.groups)
614
      if id_list:
Aurel's avatar
Aurel committed
615
        self.build_sub_objects(context, id_list, relative_url)
616
        for id_ in list(id_list):
617
          obj._delObject(id_)
618
      if hasattr(aq_base(obj), 'groups'):
619 620 621
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
622 623
    return sub_list

624 625 626 627
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
628 629 630 631
      try:
        obj = p.unrestrictedTraverse(relative_url)
      except ValueError:
        raise ValueError, "Can not access to %s" % relative_url
632 633 634 635
      try:
        obj = obj._getCopy(context)
      except AttributeError:
        raise AttributeError, "Could not find object '%s' during business template processing." % relative_url
636
      _recursiveRemoveUid(obj)
637
      obj = self.removeProperties(obj)
638
      id_list = obj.objectIds()
Vincent Pelletier's avatar
Vincent Pelletier committed
639 640
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
641
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
642 643
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
644
        for id_ in list(id_list):
645
          obj._delObject(id_)
646
      if hasattr(aq_base(obj), 'groups'):
647 648 649
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
650

651 652 653 654
  def _compileXML(self, file):
      name, ext = os.path.splitext(file.name)
      compiled_file = name + '.zexp'
      if not os.path.exists(compiled_file) or os.path.getmtime(file.name) > os.path.getmtime(compiled_file):
655
          LOG('Business Template', 0, 'Compiling %s to %s...' % (file.name, compiled_file))
656
          try:
657
              from Shared.DC.xml import ppml
658
              from OFS.XMLExportImport import start_zopedata, save_record, save_zopedata
659
              import pyexpat
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
              outfile=open(compiled_file, 'wb')
              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=pyexpat.ParserCreate()
                  p.CharacterDataHandler=F.handle_data
                  p.StartElementHandler=F.unknown_starttag
                  p.EndElementHandler=F.unknown_endtag
                  r=p.Parse(data)
              finally:
                  outfile.close()
          except:
              if os.path.exists(compiled_file):
                  os.remove(compiled_file)
              raise
      return open(compiled_file)

682
  def _importFile(self, file_name, file_obj):
683
    # import xml file
684
    if not file_name.endswith('.xml'):
685 686
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
687
      return
688 689 690 691 692
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
693
    __traceback_info__ = 'Importing %s' % file_name
694 695 696 697 698 699 700
    # The pre-compilation hack is disabled, because the design is not
    # nice. Do not enable it without yo's approval.
    if 0:
      if isinstance(file_obj, file):
        obj = connection.importFile(self._compileXML(file_obj))
      else:
        obj = connection.importFile(file_obj, customImporters=customImporters)
701 702
    else:
      obj = connection.importFile(file_obj, customImporters=customImporters)
703
    self.removeProperties(obj)
704 705
    self._objects[file_name[:-4]] = obj

706
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
707 708
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
709 710 711
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
      for path in self._objects:
712
        if installed_bt._objects.has_key(path):
Julien Muchembled's avatar
Julien Muchembled committed
713 714
          upgrade_list.append((path,
            self.removeProperties(installed_bt._objects[path])))
715
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
          modified_object_list[path] = 'New', type_name
      # update _p_jar property of objects cleaned by removeProperties
      transaction.savepoint(optimistic=True)
      for path, old_object in upgrade_list:
        # compare object to see it there is changes
        new_object = self._objects[path]
        new_io = StringIO()
        old_io = StringIO()
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, new_io)
        OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
        new_obj_xml = new_io.getvalue()
        old_obj_xml = old_io.getvalue()
        new_io.close()
        old_io.close()
        if new_obj_xml != old_obj_xml:
          modified_object_list[path] = 'Modified', type_name
732
      # get removed object
Julien Muchembled's avatar
Julien Muchembled committed
733 734
      for path in set(installed_bt._objects) - set(self._objects):
        modified_object_list[path] = 'Removed', type_name
735 736
    return modified_object_list

737
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
738 739 740
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
741
    subobjects_dict = {}
742
    if trashbin is None: # must return subobjects
743 744 745 746 747 748
      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)
749
        subobjects_dict[subobject_id] = subobject_copy
750
      return subobjects_dict
751 752
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
753
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, **kw)
754
    elif action == 'install':
755
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0, **kw)
756 757 758 759
    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
760
    return subobjects_dict
761

762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
  def beforeInstall(self):
    """
      Installation hook.
      Called right at the begining of "install" method.
      Can be overridden by subclasses.
    """
    pass

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

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

787
  def install(self, context, trashbin, **kw):
788
    self.beforeInstall()
789 790
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
791
    if context.getTemplateFormatVersion() == 1:
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
      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
811
      groups = {}
812
      old_groups = {}
813 814 815 816
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
817 818 819 820 821 822 823 824 825 826 827
      # 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)
828
      for path in keys:
829 830
        if update_dict.has_key(path) or force:
          # get action for the oject
Yoshinori Okuji's avatar
Yoshinori Okuji committed
831
          action = 'backup'
832 833 834 835 836
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          # get subobjects in path
837 838 839
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
840 841 842 843
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
844
            container_url = '/'.join(container_path)
845 846 847 848
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
849
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
850 851
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
852
              container_container = portal.unrestrictedTraverse(container_path[:-1])
853 854 855 856 857
              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)
858 859
            else:
              raise
860
          saved_uid_dict = {}
861
          subobjects_dict = {}
Julien Muchembled's avatar
Julien Muchembled committed
862
          portal_type_dict = {}
863
          # Object already exists
864 865
          old_obj = container._getOb(object_id, None)
          if old_obj is not None:
866
            recurse(saveHook, old_obj)
867
            if getattr(aq_base(old_obj), 'groups', None) is not None:
868 869 870 871 872
              # 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)
873
            subobjects_dict = self._backupObject(action, trashbin,
874
                                                 container_path, object_id)
Julien Muchembled's avatar
Julien Muchembled committed
875
            # in case of portal types, we want to keep some properties
876
            if getattr(old_obj, 'meta_type', None) == 'ERP5 Base Type':
877
              for attr in ('allowed_content_types',
Julien Muchembled's avatar
Julien Muchembled committed
878 879 880 881 882 883
                           '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, '')
884
            container.manage_delObjects([object_id])
885 886
          else:
            self.onNewObject()
887
          # install object
888
          obj = self._objects[path]
889 890 891
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
892
          if getattr(aq_base(obj), 'groups', None) is not None:
893
            # we must keep original order groups
894
            # because they change when we add subobjects
895
            groups[path] = deepcopy(obj.groups)
896
          # copy the object
897
          obj = obj._getCopy(container)
898 899 900 901 902
          try:
            container._setObject(object_id, obj)
          except AttributeError:
            LOG("BT, install", 0, object_id)
            raise
903
          obj = container._getOb(object_id)
904 905
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
906
          self.REQUEST.set('is_business_template_installation', 1)
907 908
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
909
          if portal_type_dict:
910
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
911
            wf_chain = portal_type_dict.pop('workflow_chain')
912 913
            chain_dict = getChainByType(context)[1]
            default_chain = ''
914
            chain_dict['chain_%s' % (object_id)] = wf_chain
915
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
916 917
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
918
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
919
          if subobjects_dict:
920
            # get a jar
921 922
            connection = obj._p_jar
            o = obj
923
            while connection is None:
924 925
              o = o.aq_parent
              connection = o._p_jar
926
            # import subobjects
927
            for subobject_id, subobject_data in subobjects_dict.iteritems():
928 929 930 931 932 933 934 935 936 937 938
              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))
939
          if obj.meta_type in ('Z SQL Method',):
940
            fixZSQLMethod(portal, obj)
941 942 943
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
944 945 946
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
947
          elif obj.meta_type in ('ERP5 Ram Cache',
948
                                 'ERP5 Distributed Ram Cache',):
949 950 951
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
           
952
          recurse(restoreHook, obj)
953
      # now put original order group
954 955
      # we remove object not added in forms
      # we put old objects we have kept
956
      for path, new_groups_dict in groups.iteritems():
957 958 959 960 961 962 963 964 965
        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
966
          # excetp the one that had to be removed
967 968 969 970
          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'):
971 972
              continue
            widget_in_form = 0
973 974
            for group_id, group_value_list in new_groups_dict.iteritems():
              if widget_id in group_value_list:
975 976 977 978 979 980
                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:
981
              for old_group_id, old_group_values in old_groups_dict.iteritems():
982 983 984 985 986 987 988 989 990 991 992
                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,]
993
                  obj.group_list = list(obj.group_list) + ['not_assigned']
994
          # second check all widget_id in order are in form
995 996
          for group_id, group_value_list in new_groups_dict.iteritems():
            for widget_id in tuple(group_value_list):
997 998 999
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
1000
                group_value_list.remove(widget_id)
1001
          # now set new group object
1002
          obj.groups = new_groups_dict
1003 1004
      # Remove after_method_id
      context.setPlacelessDefaultReindexParameters(**original_reindex_parameters)
Aurel's avatar
Aurel committed
1005
    else:
1006 1007
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1008
      portal = context.getPortalObject()
1009
      for relative_url in self._archive.keys():
1010
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
1011 1012 1013 1014
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
1015
        if object_id in container_ids:    # Object already exists
1016
          self._backupObject('backup', trashbin, container_path, object_id)
1017
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
1018
        # Set a hard link
1019 1020 1021 1022 1023 1024
        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',):
1025
          fixZSQLMethod(portal, obj)
1026
    self.afterInstall()
1027 1028 1029

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
1030
    trash = kw.get('trash', 0)
1031 1032 1033 1034 1035
    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
1036
      object_keys = self._archive.keys()
1037
    for relative_url in object_keys:
1038 1039
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
1040
      try:
1041
        container = portal.unrestrictedTraverse(container_path)
1042
        object = container._getOb(object_id) # We force access to the object to be sure
1043 1044
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
1045
        if trash and trashbin is not None:
1046
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
1047
        if container.meta_type == 'CMF Skins Tool':
1048 1049
          # we are removing a skin folder, check and 
          # remove if registered skin selection
1050
          skin_folder = container[object_id]
1051 1052 1053
          unregisterSkinFolder(container, skin_folder,
              container.getSkinSelections())

1054
        container.manage_delObjects([object_id])
1055 1056
        if container.aq_parent.meta_type == 'ERP5 Catalog' and len(container.objectIds()) == 0:
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1057
          container.getParentValue().manage_delObjects([container.id])
1058
      except (NotFound, KeyError, BadRequest, AttributeError):
1059
        # object is already backup and/or removed
1060
        pass
1061 1062
    BaseTemplateItem.uninstall(self, context, **kw)

1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
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

1075 1076 1077 1078 1079 1080 1081 1082 1083
  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()
1084 1085
    object_keys.sort()
    object_keys.reverse()
1086 1087
    p = context.getPortalObject()
    for path in object_keys:
1088 1089 1090 1091 1092
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1093 1094 1095
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1096
        try:
Aurel's avatar
Aurel committed
1097 1098
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
1099 1100
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
1101 1102
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1103
                                           keep_subobjects=1)
1104 1105 1106 1107 1108 1109
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1110 1111 1112
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1113

1114 1115 1116 1117 1118 1119 1120 1121 1122
      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.
1123 1124 1125
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1126
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1127 1128
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1129
      if object_id != "":
1130
        path_list.extend(self._resolvePath(
1131
            folder._getOb(object_id),
1132
            relative_url_list + [object_id], id_list[1:]))
1133
    return path_list
Aurel's avatar
Aurel committed
1134

1135 1136 1137
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1138
    keys = self._path_archive.keys()
1139
    keys.sort()
Aurel's avatar
Aurel committed
1140
    for path in keys:
1141 1142 1143
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
1144
      for relative_url in self._resolvePath(p, [], path.split('/')):
1145 1146
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1147
        obj = obj.__of__(context)
1148
        _recursiveRemoveUid(obj)
1149
        id_list = obj.objectIds()
1150
        obj = self.removeProperties(obj)
1151
        if hasattr(aq_base(obj), 'groups'):
1152
          # we must keep groups because it's ereased when we delete subobjects
1153
          groups = deepcopy(obj.groups)
1154
        if len(id_list) > 0:
1155 1156
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1157
          for id_ in list(id_list):
1158
            obj._delObject(id_)
1159
        if hasattr(aq_base(obj), 'groups'):
1160 1161 1162
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1163

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1164 1165 1166 1167 1168 1169 1170 1171
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)

1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
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")
1187
    if len(id_list) != 1:
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
      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():
1200
      pref = portal.unrestrictedTraverse(object_path)
1201
      # XXX getPreferenceState is a bad name
1202 1203 1204
      if pref.getPreferenceState() == 'disabled':
        portal.portal_workflow.doActionFor(
                      pref,
1205 1206 1207 1208
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")

1209 1210
class CategoryTemplateItem(ObjectTemplateItem):

1211 1212
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1213

1214 1215 1216 1217
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1218 1219
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1220
      obj = self.removeProperties(obj)
1221
      id_list = obj.objectIds()
1222
      if id_list:
1223
        self.build_sub_objects(context, id_list, relative_url)
1224
        for id_ in list(id_list):
1225
          obj._delObject(id_)
1226 1227
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1228 1229 1230 1231 1232

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1233 1234
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1235
      _recursiveRemoveUid(obj)
1236
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1237
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1238
      id_list = obj.objectIds()
1239 1240
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1241
        for id_ in list(id_list):
1242
          obj._delObject(id_)
1243
      else:
1244
        for id_ in list(id_list):
1245
          obj._delObject(id_)
1246 1247
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1248

1249 1250 1251 1252 1253 1254 1255 1256
  def beforeInstall(self):
    self._installed_new_category = False

  def onNewObject(self):
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1257 1258
      # reset accessors if we installed a new category
      _aq_reset()
1259

1260 1261
class SkinTemplateItem(ObjectTemplateItem):

1262 1263
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1264

1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
  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')

1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_bt, **kw)
    # We must install/update an ERP5 Form if one of its widget is modified.
    # This allow to keep the widget order and the form layout after an update
    #   from a BT to another one.
    for (bt_obj_path, bt_obj) in self._objects.items():
      if getattr(bt_obj, 'meta_type', None) == 'ERP5 Form':
        # search sub-objects of ERP5 Forms that are marked as "modified"
        for upd_obj_path in modified_object_list.keys():
          if upd_obj_path.startswith(bt_obj_path):
            # a child of the ERP5 Form must be updated, so the form too
            if not modified_object_list.has_key(bt_obj_path):
              modified_object_list.update({bt_obj_path: ['Modified', self.__class__.__name__[:-12]]})
    return modified_object_list

1290
  def install(self, context, trashbin, **kw):
1291
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1292 1293
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1294
    p = context.getPortalObject()
1295
    skin_tool = p.portal_skins
1296 1297
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1298
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1299 1300
        fixZSQLMethod(p, obj)

1301
      # Do not register skin which were explicitely ask not to be installed
1302 1303 1304 1305 1306
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
      if folder.aq_parent.meta_type == 'CMF Skins Tool':
        registerSkinFolder(skin_tool, folder)

class RegisteredSkinSelectionTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

    for key in self._archive.keys():
      skin_folder_id, skin_selection_id = key.split(' | ')

      skin_folder = skin_tool[skin_folder_id]
      selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections',
          [])
      if skin_selection_id in selection_list:
        if self._objects.has_key(skin_folder_id):
          self._objects[skin_folder_id].append(skin_selection_id)
        else:
          self._objects[skin_folder_id] = [skin_selection_id]
1328
      else:
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
        raise NotFound, 'No skin selection %s found for skin folder %s.' \
                          % (skin_selection_id, skin_folder_id)

  # Function to generate XML Code Manually
  def generateXml(self, path=None):
    xml_data = '<registered_skin_selection>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
      skin_selection_list = self._objects[key]
      xml_data += '\n <skin_folder_selection>'
      xml_data += '\n  <skin_folder>%s</skin_folder>' % key
      xml_data += '\n  <skin_selection>%s</skin_selection>' \
                      % ','.join(skin_selection_list)
      xml_data += '\n </skin_folder_selection>'
    xml_data += '\n</registered_skin_selection>'
    return xml_data

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

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

    for skin_folder_id in self._objects.keys():

      if update_dict.has_key(skin_folder_id) or force:
        if not force:
          action = update_dict[skin_folder_id]
          if action == 'nothing':
            continue
        skin_folder = skin_tool[skin_folder_id]
        selection_string = skin_folder.getProperty(
          'business_template_registered_skin_selections', None)

        if selection_string is None:
1374
          create_property = True
1375 1376
          selection_string = self._objects[skin_folder_id].replace(',', ' ')
        else:
1377 1378 1379
          create_property = False
          if not isinstance(selection_string, basestring):
            selection_string = ' '.join(selection_string)
1380 1381 1382 1383 1384 1385
          selection_string += ' %s' % \
            self._objects[skin_folder_id].replace(',', ' ')

        # Remove duplicate
        selection_string = \
            ' '.join(dict([(x, 0) for x in selection_string.split(' ')]).keys())
1386 1387 1388 1389 1390 1391 1392 1393
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
              selection_string.split(' '), type='tokens')
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
              selection_string.split(' '))
1394 1395 1396 1397 1398

        selection_list = selection_string.split(' ')
        unregisterSkinFolder(skin_tool, skin_folder,
            skin_tool.getSkinSelections())
        registerSkinFolder(skin_tool, skin_folder)
1399 1400

  def uninstall(self, context, **kw):
1401 1402 1403
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1404 1405 1406 1407
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
      object_keys = self._objects.keys()

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

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

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1423
        skin_folder._updateProperty(
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478
            'business_template_registered_skin_selections',
            current_selection_list)

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

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

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

  def _importFile(self, file_name, file):
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
    skin_folder_selection_list = xml.getElementsByTagName('skin_folder_selection')
    for skin_folder_selection in skin_folder_selection_list:
      skin_folder_id = skin_folder_selection.getElementsByTagName(
          'skin_folder')[0].childNodes[0].data
      selection_list = skin_folder_selection.getElementsByTagName(
          'skin_selection')[0].childNodes
      if len(selection_list) == 0:
        selection = ''
      else:
        selection = selection_list[0].data
      skin_selection_dict[str(skin_folder_id)] = str(selection)
    self._objects = skin_selection_dict
1479 1480


1481
class WorkflowTemplateItem(ObjectTemplateItem):
1482

1483 1484
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1485

1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
  # When the root object of a workflow is modified, the entire workflow is
  # recreated: all subobjects are discarded and must be reinstalled.
  # So we hide modified subobjects to the user and we always reinstall
  # (or remove) everything.

  def preinstall(self, context, installed_bt, **kw):
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
                                                         installed_bt, **kw)
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1498
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1499 1500 1501 1502
      else:
        modified_workflow_dict[modified_object] = state
    return modified_workflow_dict

1503
  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1504
    if context.getTemplateFormatVersion() == 1:
1505 1506 1507
      portal = context.getPortalObject()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
Julien Muchembled's avatar
Julien Muchembled committed
1508 1509 1510
      # sort to add objects before their subobjects
      for path in sorted(self._objects):
          if force:
1511
            action = 'backup'
Julien Muchembled's avatar
Julien Muchembled committed
1512
          else:
1513
            action = update_dict.get('/'.join(path.split('/')[:2]))
Julien Muchembled's avatar
Julien Muchembled committed
1514 1515
            if action in (None, 'nothing'):
              continue
1516 1517 1518 1519 1520 1521
          container_path = path.split('/')[:-1]
          object_id = path.split('/')[-1]
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1522
            container_url = '/'.join(container_path)
1523 1524 1525 1526 1527 1528
            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
1529
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1530
            container.manage_delObjects([object_id])
1531
          obj = self._objects[path]
1532 1533 1534
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1535 1536 1537 1538 1539
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1540 1541 1542 1543
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1544 1545
class PortalTypeTemplateItem(ObjectTemplateItem):

1546 1547
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1548 1549
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1550 1551 1552
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1553 1554
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1555 1556
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1557 1558
      # obj is in ghost state and an attribute must be accessed
      # so that obj.__dict__ does not return an empty dict
1559
      obj.meta_type
1560
      for attr in obj.__dict__.keys():
1561 1562 1563 1564 1565 1566 1567 1568
        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)
1569 1570
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1571

1572 1573
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1574 1575 1576 1577
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1578 1579
    # We now need to setup the list of workflows corresponding to
    # each portal type
1580
    (default_chain, chain_dict) = getChainByType(context)
1581
    # Set the default chain to the empty string is probably the
1582
    # best solution, by default it is 'default_workflow', which is
1583
    # not very usefull
1584
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1585
    if context.getTemplateFormatVersion() == 1:
1586
      object_list = self._objects
1587
    else:
1588 1589
      object_list = self._archive
    for path in object_list.keys():
1590 1591 1592 1593
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1594
            continue
1595 1596
        obj = object_list[path]
        portal_type = obj.id
1597 1598 1599
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1600 1601
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1602

1603 1604
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1605 1606 1607 1608 1609 1610 1611
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
      dict = {}
      xml = parse(file)
      chain_list = xml.getElementsByTagName('chain')
      for chain in chain_list:
1612
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1613 1614 1615 1616 1617
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1618
        dict[str(ptype)] = str(workflow)
1619 1620 1621 1622
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1623
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1624 1625

  def build(self, context, **kw):
1626 1627 1628 1629 1630
    # 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
1631
    p = context.getPortalObject()
1632
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1633
    for key in self._archive.keys():
1634 1635 1636
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1637
        workflow = wflist[1]
1638
      else:
1639
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1640
        portal_type = wflist[0][:-2]
1641 1642
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1643 1644 1645 1646
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
1647
        if workflow[0] != '-' and \
1648
            workflow_name not in chain_dict['chain_%s' % portal_type].split(', '):
1649
          if not self.is_bt_for_diff:
1650 1651 1652 1653 1654
            # here, we use 'LOG' instead of 'raise', because it can
            # happen when a workflow is removed from the chain by
            # another business template.
            LOG('BusinessTemplate', WARNING, 'workflow %s not found in chain for portal_type %s'\
                % (workflow, portal_type))
1655
        if self._objects.has_key(portal_type):
1656 1657
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1658
        else:
1659
          self._objects[portal_type] = [workflow,]
1660
      elif not self.is_bt_for_diff:
1661
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1662
                        'is probably a sign of a missing dependency.'\
1663
                                                    % portal_type
1664

Christophe Dumez's avatar
Christophe Dumez committed
1665
  # Function to generate XML Code Manually
1666 1667 1668 1669 1670
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1671
      workflow_list = self._objects[key]
1672 1673 1674
      # XXX Not always a list
      if isinstance(workflow_list, str):
        workflow_list = [workflow_list]
1675 1676 1677 1678 1679
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
      xml_data += '\n  <workflow>%s</workflow>' %(', '.join(workflow_list))
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
    return xml_data

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

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # We now need to setup the list of workflows corresponding to
    # each portal type
1696
    (default_chain, chain_dict) = getChainByType(context)
1697
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1698
    # best solution, by default it is 'default_workflow', which is
1699 1700 1701 1702 1703 1704 1705
    # not very usefull
    default_chain = ''
    for path in self._objects.keys():
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1706
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1707 1708
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
1709
        if len(path_splitted) < 1:
Jérome Perrin's avatar
Jérome Perrin committed
1710
          continue
1711
        portal_type = path_splitted[-1]
1712
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1713 1714 1715
          old_chain_dict = chain_dict['chain_%s' % portal_type]
          # XXX we don't use the chain (Default) in erp5 so don't keep it
          if old_chain_dict != '(Default)' and old_chain_dict != '':
1716
            old_chain_workflow_id_set = {}
1717
            # get existing workflow id list
1718 1719
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1720
            # get new workflow id list
1721
            for wf_id in self._objects[path].split(', '):
1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735
              if wf_id[0] == '-':
                # remove wf id if already present
                if old_chain_workflow_id_set.has_key(wf_id[1:]):
                  old_chain_workflow_id_set.pop(wf_id[1:])
              elif wf_id[0] == '=':
                # replace existing chain by this one
                old_chain_workflow_id_set = {}
                old_chain_workflow_id_set[wf_id[1:]] = 1
              # then either '+' or nothing, add wf id to the list
              elif wf_id[0] == '+':
                old_chain_workflow_id_set[wf_id[1:]] = 1
              else:
                old_chain_workflow_id_set[wf_id] = 1
            # create the new chain
1736 1737
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1738
          else:
Romain Courteaud's avatar
Romain Courteaud committed
1739 1740 1741 1742 1743 1744
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
            for wf_id in self._objects[path].split(', '):
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
1745
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1746
        else:
1747 1748 1749 1750
          if portal_type not in context.portal_types.objectIds():
            raise ValueError('Cannot chain workflow %r to non existing '
                           'portal type %r' % (self._objects[path],
                                               portal_type))
Aurel's avatar
Aurel committed
1751
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1752 1753
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1754

1755 1756
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1757 1758 1759 1760 1761 1762
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._objects.keys()
    for path in object_keys:
1763 1764 1765 1766 1767 1768
      path_splitted = path.split('/', 1)
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
      id = 'chain_%s' % portal_type
      if id in chain_dict.keys():
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780
        chain = chain_dict[id]
        # It should be better to use regexp
        chain = chain.replace(' ', '')
        workflow_list = chain.split(',')
        workflow_id = self._objects[path]
        for i in range(workflow_list.count(workflow_id)):
          workflow_list.remove(workflow_id)
        chain = ', '.join(workflow_list)
        if chain == '':
          del chain_dict[id]
        else:
          chain_dict[id] = chain
1781
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1782

1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
      for key in installed_bt._objects.keys():
        if not "portal_type_workflow_chain/" in key:
          new_key = 'portal_type_workflow_chain/%s' %key
          new_dict[new_key] = installed_bt._objects[key]
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
        installed_bt._objects = new_dict
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
          new_object = self._objects[path]
          old_object = installed_bt._objects[path]
          # compare same type of object
          if isinstance(old_object, list) or isinstance(old_object, tuple):
            old_object = ', '.join(old_object)
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

1816
  def _importFile(self, file_name, file):
1817 1818 1819 1820
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831
    # import workflow chain for portal_type
    dict = {}
    xml = parse(file)
    chain_list = xml.getElementsByTagName('chain')
    for chain in chain_list:
      ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
      workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
      if len(workflow_list) == 0:
        workflow = ''
      else:
        workflow = workflow_list[0].data
1832 1833
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1834 1835 1836
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1837 1838
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1839

1840
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
1841 1842 1843
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
1844 1845
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
1846
  business_template_class_property = '_portal_type_allowed_content_type_item'
1847 1848

  def build(self, context, **kw):
1849 1850
    types_tool = self.getPortalObject().portal_types
    types_list = list(types_tool.objectIds())
1851
    for key in self._archive.keys():
1852 1853 1854 1855
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
1856 1857 1858 1859 1860
      # check properties corresponds to what is defined in site
      if not portal_type in types_list:
        raise ValueError, "Portal Type %s not found in site" %(portal_type,)
      ob = types_tool._getOb(portal_type)
      prop_value = getattr(ob, self.class_property, ())
1861
      if not allowed_type in prop_value and not self.is_bt_for_diff:
Jérome Perrin's avatar
Jérome Perrin committed
1862
        raise ValueError, "%s %s not found in portal type %s" % (
1863 1864 1865
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)

1866 1867 1868 1869 1870 1871 1872
      if self._objects.has_key(portal_type):
        allowed_list = self._objects[portal_type]
        allowed_list.append(allowed_type)
        self._objects[portal_type] = allowed_list
      else:
        self._objects[portal_type] = [allowed_type]

Christophe Dumez's avatar
Christophe Dumez committed
1873
  # Function to generate XML Code Manually
1874
  def generateXml(self, path=None):
1875
    dictio = self._objects
1876
    xml_data = '<%s>' %(self.xml_tag,)
1877
    keys = dictio.keys()
1878 1879
    keys.sort()
    for key in keys:
1880
      allowed_list = dictio[key]
1881
      xml_data += '\n <portal_type id="%s">' %(key,)
1882
      for allowed_item in allowed_list:
1883 1884 1885
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896
    return xml_data

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

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

1928
  def _importFile(self, file_name, file):
1929 1930 1931 1932
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
1933
    path, name = posixpath.split(file_name)
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948
    xml = parse(file)
    portal_type_list = xml.getElementsByTagName('portal_type')
    for portal_type in portal_type_list:
      id = portal_type.getAttribute('id')
      item_type_list = []
      item_list = portal_type.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      self._objects[self.class_property+'/'+id] = item_type_list

  def install(self, context, trashbin, **kw):
    p = context.getPortalObject()
    pt = p.unrestrictedTraverse('portal_types')
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1949 1950 1951 1952 1953 1954 1955
    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())):
1956 1957 1958 1959 1960
      if update_dict.has_key(key) or force:
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
1961 1962 1963 1964 1965 1966
        try:
          portal_id = key.split('/')[-1]
          portal_type = pt._getOb(portal_id)
        except (AttributeError, KeyError):
          LOG("portal types not found : ", 100, portal_id)
          continue
1967 1968
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
1969 1970 1971
        object_property_list = getattr(portal_type, self.class_property, ())
        if len(object_property_list) > 0:
          # merge differences between portal types properties
1972 1973 1974 1975 1976
          # 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
1977
          for id in object_property_list:
1978
            if id not in property_list and id not in old_property_list:
1979
              property_list.append(id)
1980
        setattr(portal_type, self.class_property, tuple(property_list))
1981

Aurel's avatar
Aurel committed
1982
  def uninstall(self, context, **kw):
1983
    object_path = kw.get('object_path', None)
1984
    p = context.getPortalObject()
1985
    pt = p.unrestrictedTraverse('portal_types')
1986 1987 1988 1989 1990 1991 1992 1993
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._objects.keys()
    for key in object_keys:
      try:
        portal_id = key.split('/')[-1]
        portal_type = pt._getOb(portal_id)
1994
      except (AttributeError,  KeyError):
1995 1996 1997
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
1998 1999
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2000 2001
      for id in property_list:
        if id in original_property_list:
2002
          original_property_list.remove(id)
2003
      setattr(portal_type, self.class_property, tuple(original_property_list))
2004

2005

2006 2007
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2008
  name = 'Hidden Content Type'
2009 2010
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2011
  business_template_class_property = '_portal_type_hidden_content_type_item'
2012

2013

2014 2015
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2016
  name = 'Property Sheet'
2017 2018
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2019
  business_template_class_property = '_portal_type_property_sheet_item'
2020

2021

2022 2023
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2024
  name = 'Base Category'
2025 2026
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2027
  business_template_class_property = '_portal_type_base_category_item'
2028

2029

2030
class CatalogMethodTemplateItem(ObjectTemplateItem):
2031
  """Template Item for catalog methods.
2032

2033 2034 2035 2036 2037
    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.
  """
2038

2039 2040
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2041
    # a mapping to store properties of methods.
2042 2043 2044 2045 2046
    # 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()
2047

2048 2049 2050 2051 2052
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066
  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

2067 2068
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2069

2070
    catalog = _getCatalogValue(self)
2071
    if catalog is None:
2072
      LOG('BusinessTemplate build', 0, 'catalog not found')
2073
      return
2074

2075 2076 2077
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2078

2079 2080
    for obj in self._objects.values():
      method_id = obj.id
2081 2082
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2083
      self._is_filtered_archive[method_id] = 0
2084
      if catalog.filter_dict.has_key(method_id):
2085 2086 2087 2088 2089 2090 2091 2092 2093
        if catalog.filter_dict[method_id]['filtered']:
          self._is_filtered_archive[method_id] = \
                      catalog.filter_dict[method_id]['filtered']
          self._filter_expression_archive[method_id] = \
                      catalog.filter_dict[method_id]['expression']
          self._filter_expression_instance_archive[method_id] = \
                      catalog.filter_dict[method_id]['expression_instance']
          self._filter_type_archive[method_id] = \
                      catalog.filter_dict[method_id]['type']
2094

Aurel's avatar
Aurel committed
2095
  def export(self, context, bta, **kw):
2096
    catalog = _getCatalogValue(self)
2097 2098 2099 2100
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

Aurel's avatar
Aurel committed
2101 2102 2103 2104
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
2105
      obj = self._objects[key]
Aurel's avatar
Aurel committed
2106
      # create folder and subfolders
2107
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
2108 2109 2110 2111
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
2112 2113
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
2114
      # add all datas specific to catalog inside one file
2115
      method_id = obj.id
2116 2117
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

2118
      f = open(object_path, 'wb')
2119
      xml_data = '<catalog_method>'
2120

2121
      for method_property, value in self._method_properties[method_id].items():
2122 2123 2124
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2125

Aurel's avatar
Aurel committed
2126
      if catalog.filter_dict.has_key(method_id):
2127
        if catalog.filter_dict[method_id]['filtered']:
2128 2129 2130
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2131 2132 2133 2134
          for method in catalog_method_filter_list:
            value = getattr(self, method, '')[method_id]
            if method != '_filter_expression_instance_archive':
              if type(value) in (type(''), type(u'')):
2135 2136 2137
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2138
              elif type(value) in (type(()), type([])):
2139
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2140
                for item in value:
2141 2142 2143
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
      xml_data += '\n</catalog_method>'
2144
      f.write(xml_data)
Aurel's avatar
Aurel committed
2145
      f.close()
2146

Christophe Dumez's avatar
Christophe Dumez committed
2147 2148 2149 2150 2151 2152
  # 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:
2153 2154
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
Christophe Dumez's avatar
Christophe Dumez committed
2155
    return xml_data
2156

2157 2158
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2159
    catalog = _getCatalogValue(self)
2160 2161 2162 2163 2164 2165 2166
    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)
2167

2168 2169 2170
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2171
    new_bt_format = context.getTemplateFormatVersion()
2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187

    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':
2188
              continue
2189 2190 2191 2192
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2193

2194 2195
    for obj in values:
      method_id = obj.id
2196

2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207
      # Restore catalog properties for methods
      if hasattr(self, '_method_properties'):
        for key in self._method_properties.get(method_id, {}).keys():
          old_value = getattr(catalog, key, None)
          if isinstance(old_value, str):
            setattr(catalog, key, method_id)
          elif isinstance(old_value, list) or isinstance(old_value, tuple):
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2208

2209 2210
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2211
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2212
        if context.getTemplateFormatVersion() == 1:
2213 2214 2215
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2216
        filter_type = self._filter_type_archive[method_id]
2217 2218 2219
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2220
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2221
        catalog.filter_dict[method_id]['type'] = filter_type
2222
      elif method_id in catalog.filter_dict.keys():
2223
        catalog.filter_dict[method_id]['filtered'] = 0
2224

2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250
      # 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)
2251

2252 2253 2254 2255 2256 2257
        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)
2258

2259
  def uninstall(self, context, **kw):
2260
    catalog = _getCatalogValue(self)
2261 2262 2263
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2264

2265 2266 2267 2268
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2269 2270 2271 2272
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2273
    else:
2274 2275 2276 2277
      try:
        value = self._archive[object_path]
      except KeyError:
        value = None
2278 2279
      if value is not None:
        values.append(value)
2280
    for obj in values:
2281
      method_id = obj.id
2282 2283 2284 2285 2286 2287 2288 2289 2290
      # 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)
2291

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2292
      if catalog.filter_dict.has_key(method_id):
2293
        del catalog.filter_dict[method_id]
2294

2295
    # uninstall objects
2296
    ObjectTemplateItem.uninstall(self, context, **kw)
2297

2298
  def _importFile(self, file_name, file):
2299
    if file_name.endswith('.catalog_keys.xml'):
2300
      # recreate data mapping specific to catalog method
2301 2302
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2303
      xml = parse(file)
2304
      method_list = xml.getElementsByTagName('item')
2305
      for method in method_list:
2306
        key = method.getAttribute('key')
2307 2308
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
2309 2310 2311 2312
          if len(method.getElementsByTagName('value')[0].childNodes):
            value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          else:
            value = ''
2313
          key = str(key)
2314
        elif key_type == "int":
2315
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
2316
          key = str(key)
2317
        elif key_type == "tuple":
2318 2319 2320 2321
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
2322
        else:
2323
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2324
          continue
2325
        if key in catalog_method_list or key in catalog_method_filter_list:
2326
          dict = getattr(self, key, {})
2327
          dict[id] = value
2328 2329 2330
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342
    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, ))
2343

2344
class ActionTemplateItem(ObjectTemplateItem):
2345 2346

  def __init__(self, id_list, **kw):
2347
    # XXX It's look like ObjectTemplateItem __init__
2348 2349 2350 2351 2352 2353
    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

2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374
  def _splitPath(self, path):
    """
      Split path tries to split a complexe path such as:

      "foo/bar[id=zoo]"

      into

      "foo/bar", "id", "zoo"

      This is used mostly for generic objects
    """
    # Add error checking here
    if path.find('[') >= 0 and path.find(']') > path.find('=') and path.find('=') > path.find('['):
      relative_url = path[0:path.find('[')]
      id_block = path[path.find('[')+1:path.find(']')]
      key = id_block.split('=')[0]
      value = id_block.split('=')[1]
      return relative_url, key, value
    return path, None, None

2375 2376 2377 2378
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2379 2380 2381
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
Julien Muchembled's avatar
Julien Muchembled committed
2382
      # Several tools still use CMF actions
2383
      is_new_action = obj.getParentId() == 'portal_types'
2384
      id_id = is_new_action and 'reference' or 'id'
2385 2386
      for action in (is_new_action and obj.getActionInformationList
                                    or obj.listActions)():
2387
        if getattr(action, id_id, None) == value:
2388
          break
2389
      else:
2390 2391 2392 2393 2394 2395 2396
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
      if is_new_action:
        action = obj._exportOldAction(action)
      else:
        action = action._getCopy(context)
2397
      key = posixpath.join(url[-2], url[-1], value)
2398
      self._objects[key] = self.removeProperties(action)
2399
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2400

2401 2402 2403
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2404
    if context.getTemplateFormatVersion() == 1:
2405
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2406 2407
      p = context.getPortalObject()
      for id in self._objects.keys():
2408 2409 2410 2411 2412
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2413 2414 2415
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2416

2417
          if container.getParentId() == 'portal_types':
2418 2419 2420
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2421 2422
            continue

Julien Muchembled's avatar
Julien Muchembled committed
2423 2424
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2425
          obj, action = container, obj
2426
          action_list = obj.listActions()
2427
          for index in range(len(action_list)):
2428
            if action_list[index].id == id:
2429
              # remove previous action
2430
              obj.deleteActions(selections=(index,))
2431 2432 2433
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2434
          obj.addAction(
2435 2436
                        id = action.id
                      , name = action.title
2437
                      , action = action_text
2438 2439 2440 2441
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2442 2443
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2444
                      , priority = action.priority
2445
                      , description = action.description
Aurel's avatar
Aurel committed
2446
                    )
2447
          # sort action based on the priority define on it
2448 2449 2450 2451 2452 2453 2454 2455 2456
          # 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))
2457 2458
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2459
        container.manage_delObjects([obj.id
2460
          for obj in container.getActionInformationList()
2461
          if obj.getReference() in action_dict])
2462 2463
        for obj in action_dict.itervalues():
          container._importOldAction(obj)
Aurel's avatar
Aurel committed
2464
    else:
2465
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2466
      p = context.getPortalObject()
2467 2468
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2469
        relative_url, key, value = self._splitPath(id)
2470 2471
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2472
          if getattr(ai, key) == value:
2473
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2474 2475 2476
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2477
        obj.addAction(
Aurel's avatar
Aurel committed
2478 2479
                      id = action.id
                    , name = action.title
2480
                    , action = action_text
Aurel's avatar
Aurel committed
2481 2482 2483 2484
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2485 2486
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2487
                    )
Aurel's avatar
Aurel committed
2488 2489 2490 2491 2492 2493 2494
        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))
2495 2496
          obj.moveDownActions(selections=tuple(move_down_list))

2497 2498
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2499 2500
    object_path = kw.get("object_path", None)
    if object_path is not None:
2501 2502 2503 2504 2505 2506 2507 2508
      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]
2509
    else:
2510
      keys = self._archive.keys()
2511
    for id in keys:
2512 2513 2514 2515
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526
        relative_url, key, value = self._splitPath(id)
      obj = p.unrestrictedTraverse(relative_url, None)
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
          if getattr(action_list[index], key) == value:
            obj.deleteActions(selections=(index,))
            break
      else :
        LOG('BusinessTemplate', 100,
            'unable to uninstall action at %s, ignoring' % relative_url )
2527 2528
    BaseTemplateItem.uninstall(self, context, **kw)

2529 2530 2531
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2532
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2533 2534 2535 2536 2537 2538 2539
    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])
2540
      self._objects[relative_url] = type_role_list = []
2541
      for role in obj.getRoleInformationList():
2542
        type_role_dict = {}
2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559
        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
2560
        type_role_list.append(type_role_dict)
2561
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2562

Christophe Dumez's avatar
Christophe Dumez committed
2563
  # Function to generate XML Code Manually
2564 2565 2566 2567
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2568
      xml_data += "\n  <role id='%s'>" % role['id']
2569
      # uniq
2570
      for property in ('title', 'description', 'condition',
2571 2572 2573
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2574 2575
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2576
          xml_data += "\n   <property id='%s'>%s</property>" % \
2577 2578 2579
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2580
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2581 2582
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2583
          xml_data += "\n   <multi_property "\
2584
          "id='%s'>%s</multi_property>" % (property, prop_value)
2585 2586
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2587
    return xml_data
2588

2589 2590 2591 2592 2593 2594 2595
  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)
2596 2597
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2598 2599 2600 2601
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
2602 2603 2604
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2605 2606
    type_roles_list = []
    xml = parse(file)
2607
    xml_type_roles_list = xml.getElementsByTagName('role')
2608
    for role in xml_type_roles_list:
2609
      id = role.getAttribute('id').encode('utf_8', 'backslashreplace')
2610 2611 2612 2613 2614 2615
      type_role_property_dict = {'id':id}
      # uniq
      property_list = role.getElementsByTagName('property')
      for property in property_list:
        property_id = property.getAttribute('id').encode()
        if property.hasChildNodes():
2616
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2617 2618 2619 2620 2621 2622 2623 2624
          type_role_property_dict[property_id] = property_value
      # multi
      multi_property_list = role.getElementsByTagName('multi_property')
      for property in multi_property_list:
        property_id = property.getAttribute('id').encode()
        if not type_role_property_dict.has_key(property_id):
          type_role_property_dict[property_id] = []
        if property.hasChildNodes():
2625
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639
          type_role_property_dict[property_id].append(property_value)
      type_roles_list.append(type_role_property_dict)
    self._objects['portal_type_roles/'+file_name[:-4]] = type_roles_list

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    p = context.getPortalObject()
    for roles_path in self._objects.keys():
      if update_dict.has_key(roles_path) or force:
        if not force:
          action = update_dict[roles_path]
          if action == 'nothing':
            continue
2640 2641 2642
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
2643
          # reset roles before applying
2644
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
2645
          type_roles_list = self._objects[roles_path] or []
2646 2647
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
2648 2649 2650

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2651 2652 2653 2654 2655 2656
    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:
2657
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2658 2659 2660 2661 2662
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2663

2664 2665 2666 2667 2668 2669
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2670 2671
      for property in p.propertyMap():
        if property['id'] == id:
2672
          obj = p.getProperty(id)
2673
          prop_type = property['type']
2674 2675
          break
      else:
2676
        obj = None
2677
      if obj is None and not self.is_bt_for_diff:
2678
        raise NotFound, 'the property %s is not found' % id
2679
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2680

2681 2682
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
2683 2684 2685 2686
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2687 2688 2689 2690
    xml = parse(file)
    property_list = xml.getElementsByTagName('property')
    for prop in property_list:
      id = prop.getElementsByTagName('id')[0].childNodes[0].data
2691 2692
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2693 2694 2695 2696 2697 2698 2699
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2700
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2701
      self._objects[str(id)] = (str(prop_type), value)
2702

2703 2704 2705
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2706
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2707 2708
      p = context.getPortalObject()
      for path in self._objects.keys():
2709 2710 2711 2712
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2713
              continue
2714
          dir, id = posixpath.split(path)
2715
          prop_type, property = self._objects[path]
2716 2717 2718 2719 2720 2721 2722 2723
          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
2724
    else:
2725
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2726
      p = context.getPortalObject()
2727
      for id, property in self._archive.keys():
2728
        property = self._archive[id]
Aurel's avatar
Aurel committed
2729
        if p.hasProperty(id):
2730 2731 2732 2733 2734 2735 2736
          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'])
2737 2738 2739

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2740 2741 2742 2743 2744 2745
    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:
2746 2747 2748 2749
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2750
  # Function to generate XML Code Manually
2751
  def generateXml(self, path=None):
2752
    xml_data = ''
2753
    prop_type, obj = self._objects[path]
2754
    xml_data += '\n <property>'
2755 2756
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
2757
    if prop_type in ('lines', 'tokens'):
2758
      xml_data += '\n  <value>'
2759
      for item in obj:
2760
        if item != '':
2761
          xml_data += '\n   <item>%s</item>' % escape(str(item))
2762
      xml_data += '\n  </value>'
2763
    else:
2764
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
2765
    xml_data += '\n </property>'
2766 2767
    return xml_data

Aurel's avatar
Aurel committed
2768 2769 2770 2771 2772
  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)
2773 2774 2775 2776
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2777
      xml_data += self.generateXml(path)
2778
    xml_data += '\n</site_property>'
2779
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2780

2781 2782 2783 2784 2785 2786 2787
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
      module = p.unrestrictedTraverse(id)
2788 2789 2790 2791 2792 2793 2794 2795
      dict = {}
      dict['id'] = module.getId()
      dict['title'] = module.getTitle()
      dict['portal_type'] = module.getPortalType()
      permission_list = []
      # use show permission
      dict['permission_list'] = module.showPermissions()
      self._objects[id] = dict
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2796

Christophe Dumez's avatar
Christophe Dumez committed
2797
  # Function to generate XML Code Manually
2798
  def generateXml(self, path=None):
2799 2800
    dict = self._objects[path]
    xml_data = '<module>'
2801 2802 2803 2804
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2805 2806
      if key =='permission_list':
        # separe permission dict into xml
2807
        xml_data += '\n <%s>' %(key,)
2808 2809
        permission_list = dict[key]
        for perm in permission_list:
2810 2811 2812 2813 2814
          # the type of the permission defined if we use acquired or not
          if type(perm[1]) == type([]):
            ptype = "list"
          else:
            ptype = "tuple"
2815 2816
          xml_data += "\n  <permission type='%s'>" %(ptype,)
          xml_data += '\n   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2817
          role_list = list(perm[1])
2818
          role_list.sort()
2819
          for role in role_list:
2820 2821 2822
            xml_data += '\n   <role>%s</role>' %(role)
          xml_data += '\n  </permission>'
        xml_data += '\n </%s>' %(key,)
2823
      else:
2824 2825
        xml_data += '\n <%s>%s</%s>' %(key, dict[key], key)
    xml_data += '\n</module>'
2826 2827
    return xml_data

2828 2829 2830 2831 2832
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
2833 2834 2835
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
2836
      # export modules one by one
2837
      xml_data = self.generateXml(path=id)
2838
      bta.addObject(obj=xml_data, name=id, path=path)
2839

2840
  def install(self, context, trashbin, **kw):
2841
    portal = context.getPortalObject()
2842 2843
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2844
    if context.getTemplateFormatVersion() == 1:
2845
      items = self._objects
2846
    else:
2847 2848
      items = self._archive

2849 2850
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
2851 2852 2853 2854 2855 2856 2857
    for id in items.keys():
      if update_dict.has_key(id) or force:
        if not force:
          action = update_dict[id]
          if action == 'nothing':
            continue
        mapping = items[id]
2858
        path, id = posixpath.split(id)
2859 2860
        if id in portal.objectIds():
          module = portal._getOb(id)
2861
          module.portal_type = str(mapping['portal_type'])
2862 2863 2864
        else:
          module = portal.newContent(id=id, portal_type=str(mapping['portal_type']))
        module.setTitle(str(mapping['title']))
2865
        for name, role_list in list(mapping['permission_list']):
2866
          acquire = (type(role_list) == type([]))
2867
          if name in valid_permissions:
2868
            module.manage_permission(name, roles=role_list, acquire=acquire)
2869 2870

  def _importFile(self, file_name, file):
2871 2872 2873
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2874 2875 2876 2877 2878 2879 2880 2881
    dict = {}
    xml = parse(file)
    for id in ('portal_type', 'id', 'title', 'permission_list'):
      elt = xml.getElementsByTagName(id)[0]
      if id == 'permission_list':
        plist = []
        perm_list = elt.getElementsByTagName('permission')
        for perm in perm_list:
2882
          perm_type = perm.getAttribute('type').encode() or None
2883 2884 2885 2886 2887 2888 2889 2890 2891
          name_elt = perm.getElementsByTagName('name')[0]
          name_node = name_elt.childNodes[0]
          name = name_node.data
          role_list = perm.getElementsByTagName('role')
          rlist = []
          for role in role_list:
            role_node = role.childNodes[0]
            role = role_node.data
            rlist.append(str(role))
2892 2893 2894 2895
          if perm_type == "list" or perm_type is None:
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906
          plist.append(perm_tuple)
        dict[id] = plist
      else:
        node_list = elt.childNodes
        if len(node_list) == 0:
          value=''
        else:
          value = node_list[0].data
        dict[id] = str(value)
    self._objects[file_name[:-4]] = dict

2907
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2908 2909 2910
    trash = kw.get('trash', 0)
    if trash:
      return
2911 2912 2913 2914 2915 2916
    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]
2917 2918
    p = context.getPortalObject()
    id_list = p.objectIds()
2919
    for id in keys:
2920
      if id in id_list:
2921
        try:
2922
          if trash and trashbin is not None:
2923 2924
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2925
          p.manage_delObjects([id])
2926
        except NotFound:
2927
          pass
2928 2929
    BaseTemplateItem.uninstall(self, context, **kw)

2930 2931 2932
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2933 2934

class DocumentTemplateItem(BaseTemplateItem):
2935 2936 2937 2938
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2939 2940 2941 2942

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

2945
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2946 2947
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2948
      new_keys = self._objects.keys()
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
      for key in installed_bt._objects.keys():
        if self.__class__.__name__ in key:
          new_key = key[len('%s/' % self.__class__.__name__):]
          new_dict[new_key] = installed_bt._objects[key]
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
        installed_bt._objects = new_dict
2959 2960 2961 2962 2963 2964
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
          old_obj_code = installed_bt._objects[path]
          if new_obj_code != old_obj_code:
2965 2966
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
2967
        else: # new object
2968 2969
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
2970 2971 2972 2973
          # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
2974 2975
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
2976 2977 2978 2979 2980
    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
2981
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2982
      for id in self._objects.keys():
2983 2984 2985 2986 2987 2988
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
2989
          path, name = posixpath.split(id)
2990 2991
          # This raises an exception if the file already exists.
          try:
2992
            globals()[self.local_file_writer_name](name, text, create=0)
2993
          except IOError, error:
2994
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
2995 2996
            if error.errno :
              raise
2997 2998 2999
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
3000
    else:
3001 3002 3003
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3004
        # This raises an exception if the file exists.
3005
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
3006 3007
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
3008 3009

  def uninstall(self, context, **kw):
3010
    object_path = kw.get('object_path', None)
3011 3012 3013 3014 3015
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
3016
      globals()[self.local_file_remover_name](id)
3017 3018
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3019 3020 3021 3022 3023 3024
  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():
3025 3026
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
3027

3028
  def _importFile(self, file_name, file):
3029 3030 3031
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3032
    text = file.read()
3033
    self._objects[file_name[:-3]]=text
3034

3035 3036 3037 3038 3039 3040
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

3041 3042 3043 3044 3045
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
3046

3047 3048 3049
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
3050 3051
  # Extension needs no import
  local_file_importer_name = None
3052 3053 3054 3055 3056
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
3057
  # Test needs no import
3058 3059 3060
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
3061

3062 3063 3064
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3065 3066 3067

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3068 3069 3070 3071
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
3072
    if len(role_list) > 0:
3073
      self._objects[self.__class__.__name__+'/'+'role_list'] = role_list
Aurel's avatar
Aurel committed
3074

3075
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3076 3077
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3078
      new_roles = self._objects.keys()
3079
      if installed_bt.id == INSTALLED_BT_FOR_DIFF:
3080 3081
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
3082 3083 3084
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
3085 3086
        for key in old_keys:
          new_dict[key] = ''
3087
        installed_bt._objects = new_dict
3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100
      for role in new_roles:
        if installed_bt._objects.has_key(role):
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
      old_roles = installed_bt._objects.keys()
      for role in old_roles:
        if role not in new_roles:
          modified_object_list.update({role : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
3101
    p = context.getPortalObject()
3102
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3103
    if context.getTemplateFormatVersion() == 1:
3104
      role_list = self._objects.keys()
3105
    else:
3106
      role_list = self._archive.keys()
3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118
    # set roles in PAS
    if p.acl_users.meta_type == 'Pluggable Auth Service':
      role_manager_list = p.acl_users.objectValues('ZODB Role Manager')
      for role_manager in role_manager_list:
        existing_role_list = role_manager.listRoleIds()
        for role in role_list:
          if role not in existing_role_list:
            role_manager.addRole(role)
    # set roles on portal
    roles = {}
    for role in p.__ac_roles__:
      roles[role] = 1
3119
    for role in role_list:
3120 3121 3122 3123
      roles[role] = 1
    p.__ac_roles__ = tuple(roles.keys())

  def _importFile(self, file_name, file):
3124 3125 3126 3127
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3128 3129 3130 3131 3132 3133
    xml = parse(file)
    role_list = xml.getElementsByTagName('role')
    for role in role_list:
      node = role.childNodes[0]
      value = node.data
      self._objects[str(value)] = 1
3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145

  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)

3146 3147 3148 3149 3150 3151 3152 3153 3154
  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
3155
      if role in roles and role not in new_roles:
3156 3157 3158
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3159
  # Function to generate XML Code Manually
3160
  def generateXml(self, path):
3161
    obj = self._objects[path]
3162
    xml_data = '<role_list>'
3163 3164
    obj.sort()
    for role in obj:
3165 3166
      xml_data += '\n <role>%s</role>' %(role)
    xml_data += '\n</role_list>'
3167 3168
    return xml_data

Aurel's avatar
Aurel committed
3169 3170 3171 3172 3173 3174
  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():
3175
      xml_data = self.generateXml(path=path)
3176
      bta.addObject(obj=xml_data, name=path, path=None,)
3177

3178 3179
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3180
  def build(self, context, **kw):
3181
    catalog = _getCatalogValue(self)
3182 3183 3184
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3185
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3186
    key_list = []
3187
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3188
      if key in sql_search_result_keys:
3189
        key_list.append(key)
3190
      elif not self.is_bt_for_diff:
3191
        raise NotFound, 'Result key "%r" not found in catalog' %(key,)
3192
    if len(key_list) > 0:
3193
      self._objects[self.__class__.__name__+'/'+'result_key_list'] = key_list
3194 3195

  def _importFile(self, file_name, file):
3196 3197 3198
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3199 3200 3201 3202 3203 3204 3205 3206 3207
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

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

3214
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3215
    if context.getTemplateFormatVersion() == 1:
3216 3217
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3218 3219 3220
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3221
    else:
3222
      keys = self._archive.keys()
3223 3224
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3225
    # XXX same as related key
Aurel's avatar
Aurel committed
3226
    if update_dict.has_key('result_key_list') or force:
3227
      if not force:
Aurel's avatar
Aurel committed
3228
        action = update_dict['result_key_list']
3229
        if action == 'nothing':
Aurel's avatar
Aurel committed
3230
          return
3231
      for key in keys:
3232 3233
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
3234
      catalog.sql_search_result_keys = sql_search_result_keys
3235

3236
  def uninstall(self, context, **kw):
3237
    catalog = _getCatalogValue(self)
3238 3239 3240 3241
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3242
    object_path = kw.get('object_path', None)
3243 3244 3245 3246 3247
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3248 3249
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
3250
    catalog.sql_search_result_keys = sql_search_result_keys
3251 3252
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3253
  # Function to generate XML Code Manually
3254
  def generateXml(self, path=None):
3255
    obj = self._objects[path]
3256
    xml_data = '<key_list>'
3257 3258
    obj.sort()
    for key in obj:
3259 3260
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3261 3262
    return xml_data

Aurel's avatar
Aurel committed
3263 3264 3265 3266 3267
  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)
3268
    for path in self._objects.keys():
3269
      xml_data = self.generateXml(path=path)
3270
      bta.addObject(obj=xml_data, name=path, path=None)
3271

3272 3273
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3274
  def build(self, context, **kw):
3275
    catalog = _getCatalogValue(self)
3276 3277 3278
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3279
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
3280
    key_list = []
3281
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3282
      if key in sql_search_related_keys:
3283
        key_list.append(key)
3284
      elif not self.is_bt_for_diff:
3285
        raise NotFound, 'Related key "%r" not found in catalog' %(key,)
3286
    if len(key_list) > 0:
3287
      self._objects[self.__class__.__name__+'/'+'related_key_list'] = key_list
3288 3289

  def _importFile(self, file_name, file):
3290 3291 3292
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3293 3294 3295 3296 3297 3298 3299 3300 3301
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

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

3308
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3309
    if context.getTemplateFormatVersion() == 1:
3310
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3311
        return
3312 3313 3314
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3315
    else:
3316
      keys = self._archive.keys()
3317 3318
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3319
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
3320
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3321
      if not force:
Aurel's avatar
Aurel committed
3322 3323 3324 3325
        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
3326 3327 3328
        if action == 'nothing':
          return
      for key in keys:
3329 3330
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
3331
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
3332

3333
  def uninstall(self, context, **kw):
3334
    catalog = _getCatalogValue(self)
3335 3336 3337
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3338
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
3339
    object_path = kw.get('object_path', None)
3340 3341 3342 3343 3344
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3345 3346 3347 3348 3349
      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
3350
  # Function to generate XML Code Manually
3351
  def generateXml(self, path=None):
3352
    obj = self._objects[path]
3353
    xml_data = '<key_list>'
3354 3355
    obj.sort()
    for key in obj:
3356 3357
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3358 3359
    return xml_data

Aurel's avatar
Aurel committed
3360 3361 3362 3363 3364 3365
  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():
3366
      xml_data = self.generateXml(path=path)
3367
      bta.addObject(obj=xml_data, name=path, path=None)
3368

3369 3370
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3371
  def build(self, context, **kw):
3372
    catalog = _getCatalogValue(self)
3373 3374 3375
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3376
    sql_search_result_tables = list(catalog.sql_search_tables)
3377
    key_list = []
3378
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3379
      if key in sql_search_result_tables:
3380
        key_list.append(key)
3381
      elif not self.is_bt_for_diff:
3382
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
3383
    if len(key_list) > 0:
3384
      self._objects[self.__class__.__name__+'/'+'result_table_list'] = key_list
3385 3386

  def _importFile(self, file_name, file):
3387 3388 3389
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3390 3391 3392 3393 3394 3395 3396 3397
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list
Aurel's avatar
Aurel committed
3398

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

3405
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3406
    if context.getTemplateFormatVersion() == 1:
3407
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3408
        return
3409 3410 3411
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3412
    else:
3413
      keys = self._archive.keys()
3414 3415
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3416
    # XXX same as related keys
Aurel's avatar
Aurel committed
3417
    if update_dict.has_key('result_table_list') or force:
3418
      if not force:
Aurel's avatar
Aurel committed
3419
        action = update_dict['result_table_list']
3420
        if action == 'nothing':
Aurel's avatar
Aurel committed
3421
          return
3422
      for key in keys:
3423 3424
        if key not in sql_search_tables:
          sql_search_tables.append(key)
3425
      catalog.sql_search_tables = tuple(sql_search_tables)
3426 3427

  def uninstall(self, context, **kw):
3428
    catalog = _getCatalogValue(self)
3429 3430 3431 3432
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
3433
    object_path = kw.get('object_path', None)
3434 3435 3436 3437 3438
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3439 3440
      if key in sql_search_tables:
        sql_search_tables.remove(key)
3441
    catalog.sql_search_tables = sql_search_tables
3442 3443
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3444
  # Function to generate XML Code Manually
3445
  def generateXml(self, path=None):
3446
    obj = self._objects[path]
3447
    xml_data = '<key_list>'
3448 3449
    obj.sort()
    for key in obj:
3450 3451
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3452 3453
    return xml_data

Aurel's avatar
Aurel committed
3454 3455 3456 3457 3458 3459
  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():
3460
      xml_data = self.generateXml(path=path)
3461
      bta.addObject(obj=xml_data, name=path, path=None)
3462

3463 3464
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3465 3466

  def build(self, context, **kw):
3467
    catalog = _getCatalogValue(self)
3468 3469 3470 3471 3472 3473 3474 3475
    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)
3476
      elif not self.is_bt_for_diff:
3477
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3478
    if len(key_list) > 0:
3479
      self._objects[self.__class__.__name__+'/'+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3480

3481
  def _importFile(self, file_name, file):
3482 3483 3484
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3485 3486 3487 3488 3489 3490 3491 3492
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list
3493 3494

  def install(self, context, trashbin, **kw):
3495
    catalog = _getCatalogValue(self)
3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508
    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()
3509 3510
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522
    # 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):
3523
    catalog = _getCatalogValue(self)
3524 3525 3526 3527
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3528
    object_path = kw.get('object_path', None)
3529 3530
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3531
    else:
3532 3533 3534 3535 3536 3537 3538
      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
3539
  # Function to generate XML Code Manually
3540 3541 3542 3543 3544
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3545 3546
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3547
    return xml_data
Aurel's avatar
Aurel committed
3548 3549 3550 3551

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3552 3553 3554 3555 3556
    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)
3557

3558 3559 3560 3561 3562 3563 3564 3565
# 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
3566
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3567 3568 3569 3570
    key_list = []
    for key in self._archive.keys():
      if key in sql_datetime_keys:
        key_list.append(key)
3571
      elif not self.is_bt_for_diff:
3572 3573 3574 3575 3576
        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):
3577 3578 3579
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

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

3595
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621
    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
3622
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652
    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)      
      
3653 3654
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3655

3656
  def build(self, context, **kw):
3657
    catalog = _getCatalogValue(self)
3658 3659 3660 3661 3662 3663 3664 3665
    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)
3666
      elif not self.is_bt_for_diff:
3667
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
3668
    if len(key_list) > 0:
3669
      self._objects[self.__class__.__name__+'/'+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3670

3671
  def _importFile(self, file_name, file):
3672 3673 3674
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3675 3676 3677 3678 3679 3680 3681 3682
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3683

3684
  def install(self, context, trashbin, **kw):
3685
    catalog = _getCatalogValue(self)
3686 3687 3688
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3689

3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710
    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
3711

3712
  def uninstall(self, context, **kw):
3713
    catalog = _getCatalogValue(self)
3714 3715 3716 3717
    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)
3718
    object_path = kw.get('object_path', None)
3719 3720 3721 3722 3723 3724 3725 3726 3727 3728
    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
3729
  # Function to generate XML Code Manually
3730 3731 3732 3733 3734
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3735 3736
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752
    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):
3753
    catalog = _getCatalogValue(self)
3754 3755 3756 3757 3758 3759 3760 3761
    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)
3762
      elif not self.is_bt_for_diff:
3763
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
3764
    if len(key_list) > 0:
3765
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
3766 3767

  def _importFile(self, file_name, file):
3768 3769 3770
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3771 3772 3773 3774 3775 3776 3777 3778 3779 3780
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
3781
    catalog = _getCatalogValue(self)
3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808
    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):
3809
    catalog = _getCatalogValue(self)
3810 3811 3812 3813
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
3814
    object_path = kw.get('object_path', None)
3815 3816 3817 3818 3819 3820 3821 3822 3823 3824
    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
3825
  # Function to generate XML Code Manually
3826 3827 3828 3829 3830
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3831 3832
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847
    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):
3848
    catalog = _getCatalogValue(self)
3849 3850 3851 3852 3853 3854 3855 3856
    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)
3857
      elif not self.is_bt_for_diff:
3858
        raise NotFound, 'Multivalue key "%r" not found in catalog' %(key,)
3859
    if len(key_list) > 0:
3860
      self._objects[self.__class__.__name__+'/'+'multivalue_key_list'] = key_list
3861 3862

  def _importFile(self, file_name, file):
3863 3864 3865
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3866 3867 3868 3869 3870 3871 3872 3873 3874 3875
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
3876
    catalog = _getCatalogValue(self)
3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902
    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):
3903
    catalog = _getCatalogValue(self)
3904 3905 3906 3907
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
3908
    object_path = kw.get('object_path', None)
3909 3910 3911 3912 3913 3914 3915 3916 3917 3918
    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
3919
  # Function to generate XML Code Manually
3920 3921 3922 3923 3924
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3925 3926
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941
    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):
3942
    catalog = _getCatalogValue(self)
3943 3944 3945 3946 3947 3948 3949 3950
    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)
3951
      elif not self.is_bt_for_diff:
3952
        raise NotFound, 'Topic key "%r" not found in catalog' %(key,)
3953
    if len(key_list) > 0:
3954
      self._objects[self.__class__.__name__+'/'+'topic_key_list'] = key_list
3955 3956

  def _importFile(self, file_name, file):
3957 3958 3959
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3960 3961 3962 3963 3964 3965 3966 3967 3968 3969
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
3970
    catalog = _getCatalogValue(self)
3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997
    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):
3998
    catalog = _getCatalogValue(self)
3999 4000 4001 4002
    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)
4003
    object_path = kw.get('object_path', None)
4004 4005 4006 4007 4008 4009 4010 4011 4012 4013
    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
4014
  # Function to generate XML Code Manually
4015 4016 4017 4018 4019
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4020 4021
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032
    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)

4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044
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)
4045
      elif not self.is_bt_for_diff:
4046 4047 4048 4049 4050
        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):
4051 4052 4053
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

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

    sql_catalog_scriptable_keys = list(catalog.sql_catalog_scriptable_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX must a find a better way to manage scriptable key
    if update_dict.has_key('scriptable_key_list') or force:
      if not force:
        if update_dict.has_key('scriptable_key_list'):
          action = update_dict['scriptable_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_scriptable_keys:
          sql_catalog_scriptable_keys.append(key)
      catalog.sql_catalog_scriptable_keys = tuple(sql_catalog_scriptable_keys)

  def uninstall(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_scriptable_keys = list(catalog.sql_catalog_scriptable_keys)
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_scriptable_keys:
        sql_catalog_scriptable_keys.remove(key)
    catalog.sql_catalog_scriptable_keys = tuple(sql_catalog_scriptable_keys)
    BaseTemplateItem.uninstall(self, context, **kw)

  # Function to generate XML Code Manually
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
    return xml_data

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

4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140
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)
4141
      elif not self.is_bt_for_diff:
4142 4143 4144 4145 4146
        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):
4147 4148 4149
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

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

    sql_catalog_role_keys = list(catalog.sql_catalog_role_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX must a find a better way to manage scriptable key
    if update_dict.has_key('role_key_list') or force:
      if not force:
        if update_dict.has_key('role_key_list'):
          action = update_dict['role_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_role_keys:
          sql_catalog_role_keys.append(key)
      catalog.sql_catalog_role_keys = tuple(sql_catalog_role_keys)

  def uninstall(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_role_keys = list(catalog.sql_catalog_role_keys)
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_role_keys:
        sql_catalog_role_keys.remove(key)
    catalog.sql_catalog_role_keys = tuple(sql_catalog_role_keys)
    BaseTemplateItem.uninstall(self, context, **kw)

  # Function to generate XML Code Manually
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
    return xml_data

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

class CatalogLocalRoleKeyTemplateItem(BaseTemplateItem):
  # XXX Copy/paste from CatalogScriptableKeyTemplateItem

  def build(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_local_role_keys = list(catalog.sql_catalog_local_role_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_catalog_local_role_keys:
        key_list.append(key)
4237
      elif not self.is_bt_for_diff:
4238 4239 4240 4241 4242
        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):
4243 4244 4245
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

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

    sql_catalog_local_role_keys = list(catalog.sql_catalog_local_role_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX must a find a better way to manage scriptable key
    if update_dict.has_key('local_role_key_list') or force:
      if not force:
        if update_dict.has_key('local_role_key_list'):
          action = update_dict['local_role_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_local_role_keys:
          sql_catalog_local_role_keys.append(key)
      catalog.sql_catalog_local_role_keys = tuple(sql_catalog_local_role_keys)

  def uninstall(self, context, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_local_role_keys = list(catalog.sql_catalog_local_role_keys)
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_local_role_keys:
        sql_catalog_local_role_keys.remove(key)
    catalog.sql_catalog_local_role_keys = tuple(sql_catalog_local_role_keys)
    BaseTemplateItem.uninstall(self, context, **kw)

  # Function to generate XML Code Manually
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
    return xml_data

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

4320 4321 4322 4323
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4324 4325 4326
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4327
      else: # XXX backward compatibility
4328 4329
        lang = lang_key
        catalog = 'erp5_ui'
4330
      path = posixpath.join(lang, catalog)
4331 4332
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363

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

  def install(self, context, trashbin, **kw):
    localizer = context.getPortalObject().Localizer
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
      for path, po in self._objects.items():
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
4364
              continue
4365
          path = path.split('/')
4366 4367 4368 4369 4370 4371
          if len(path) == 2:
            lang = path[0]
            catalog = path[1]
          else:
            lang = path[-3]
            catalog = path[-2]
4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397
          if lang not in localizer.get_languages():
            localizer.manage_addLanguage(lang)
          mc = localizer._getOb(catalog)
          if lang not in mc.get_languages():
            mc.manage_addLanguage(lang)
          mc.manage_import(lang, po)
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for lang, catalogs in self._archive.items():
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
          mc = localizer._getOb(catalog)
          if lang not in mc.get_languages():
            mc.manage_addLanguage(lang)
          mc.manage_import(lang, po)

  def export(self, context, bta, **kw):
    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():
      obj = self._objects[key]
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
4398
      f = open(path+os.sep+'translation.po', 'wb')
4399 4400 4401 4402
      f.write(str(obj))
      f.close()

  def _importFile(self, file_name, file):
4403
    if posixpath.split(file_name)[1] == 'translation.po':
4404 4405
      text = file.read()
      self._objects[file_name[:-3]] = text
4406

Aurel's avatar
Aurel committed
4407 4408
class LocalRolesTemplateItem(BaseTemplateItem):

4409
  def __init__(self, id_list, **kw):
4410
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4411 4412
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4413 4414 4415
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4416
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4417 4418 4419 4420
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
      group_local_roles_dict = getattr(obj, '__ac_local_group_roles__',
                                        {}) or {}
Aurel's avatar
Aurel committed
4421 4422
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

Christophe Dumez's avatar
Christophe Dumez committed
4423
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4424 4425 4426 4427 4428 4429 4430 4431
  def generateXml(self, path=None):
    local_roles_dict, group_local_roles_dict = self._objects[path]
    local_roles_keys = local_roles_dict.keys()
    group_local_roles_keys = group_local_roles_dict.keys()
    local_roles_keys.sort()
    group_local_roles_keys.sort()
    # local roles
    xml_data = '<local_roles_item>'
4432
    xml_data += '\n <local_roles>'
Aurel's avatar
Aurel committed
4433
    for key in local_roles_keys:
4434
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4435 4436
      tuple = local_roles_dict[key]
      for item in tuple:
4437 4438 4439
        xml_data += "\n   <item>%s</item>" %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </local_roles>'
Aurel's avatar
Aurel committed
4440
    # group local roles
4441
    xml_data += '\n <group_local_roles>'
Aurel's avatar
Aurel committed
4442
    for key in group_local_roles_keys:
4443
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4444 4445
      tuple = group_local_roles_dict[key]
      for item in tuple:
4446 4447 4448 4449
        xml_data += '\n   <item>%s</item>' %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </group_local_roles>'
    xml_data += '\n</local_roles_item>'
Aurel's avatar
Aurel committed
4450
    return xml_data
4451

Aurel's avatar
Aurel committed
4452 4453 4454 4455 4456 4457 4458 4459
  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)

4460
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4461
      encode_folders = []
4462
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4463
        if '%' not in folder:
4464
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4465 4466
        else:
          encode_folders.append(folder)
4467
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4468 4469 4470 4471
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
4472 4473 4474
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4475 4476 4477
    xml = parse(file)
    # local roles
    local_roles = xml.getElementsByTagName('local_roles')[0]
4478
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
4479 4480 4481
    local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
4482 4483
      if isinstance(id, unicode):
        id = id.encode('utf-8')
Aurel's avatar
Aurel committed
4484 4485 4486 4487 4488 4489 4490
      item_type_list = []
      item_list = role.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      local_roles_dict[id] = item_type_list
    # group local roles
    group_local_roles = xml.getElementsByTagName('group_local_roles')[0]
4491
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
4492 4493 4494
    group_local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
4495 4496
      if isinstance(id, unicode):
        id = id.encode('utf-8')
Aurel's avatar
Aurel committed
4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513
      item_type_list = []
      item_list = role.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      group_local_roles_dict[id] = item_type_list
    self._objects['local_roles/'+file_name[:-4]] = (local_roles_dict, group_local_roles_dict)

  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
4514 4515 4516 4517 4518
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
        local_roles_dict, group_local_roles_dict = self._objects[roles_path]
        setattr(obj, '__ac_local_roles__', local_roles_dict)
        setattr(obj, '__ac_local_group_roles__', group_local_roles_dict)
Aurel's avatar
Aurel committed
4519 4520 4521 4522 4523 4524 4525 4526

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

4528 4529 4530
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4531
    in part or completely. Each object is separated from its
4532 4533 4534 4535 4536 4537 4538 4539 4540 4541
    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
4542 4543
      - object without optimal actions
      - list of relation between portal type and workflow
4544 4545 4546 4547 4548 4549 4550 4551 4552 4553

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

    - site property definition
      - id
      - type
4554
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4555

4556 4557
    - document/propertysheet/extension/test definition
      - copy of the local file
4558

4559
    - message transalation definition
4560
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4561

4562 4563
    The Business Template properties are exported to the bt folder with
    one property per file
4564

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4565 4566
    Technology:

4567 4568
    - 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
4569

4570
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4571 4572 4573 4574

    Use case:

    - install core ERP5 (the minimum)
4575

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

4578 4579
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4580
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4581 4582 4583 4584 4585
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4586
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4587 4588 4589 4590 4591
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
4592
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4593 4594 4595 4596

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4597
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4598
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4599
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4600
                      , PropertySheet.BusinessTemplate
4601
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4602 4603
                      )

4604 4605 4606 4607 4608 4609
    # 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."""
4610
         , 'icon'           : 'file_icon.gif'
4611 4612 4613 4614 4615 4616 4617 4618 4619
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4620 4621
    # This is a global variable
    # Order is important for installation
4622 4623 4624 4625 4626 4627
    # 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 )
4628 4629 4630
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
4631
      '_constraint_item',
4632 4633 4634 4635
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4636
      '_tool_item',
4637 4638 4639 4640
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4641
      '_portal_type_workflow_chain_item',
4642 4643 4644 4645
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4646 4647
      '_category_item',
      '_module_item',
4648
      '_path_item',
4649
      '_skin_item',
4650
      '_registered_skin_selection_item',
4651
      '_preference_item',
4652
      '_action_item',
4653
      '_portal_type_roles_item',
4654
      '_local_roles_item',
4655
      '_catalog_method_item',
4656 4657 4658
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4659
      '_catalog_keyword_key_item',
4660
      '_catalog_datetime_key_item',
4661 4662 4663 4664
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4665
      '_catalog_scriptable_key_item',
4666 4667
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4668 4669 4670 4671
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4672 4673 4674 4675 4676 4677
      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
4678
        self._baseGetTemplateFormatVersion()
4679

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4680 4681 4682
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4683

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4684
      return 0
4685

4686
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4687 4688 4689 4690 4691 4692 4693
    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".
4694 4695
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4696
          # XXX Not good to access the attribute directly,
4697 4698 4699
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4700

4701 4702
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4703 4704 4705 4706 4707 4708
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4709
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4710 4711 4712 4713 4714 4715 4716 4717
        """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)
4718

4719
    security.declareProtected(Permissions.ManagePortal, 'build')
4720
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4721 4722 4723
      """
        Copy existing portal objects to self
      """
4724
      if no_action: return
4725
        # this is use at import of Business Template to get the status built
4726 4727
      # Make sure that everything is sane.
      self.clean()
4728

4729
      self.updateRevisionNumber()
4730

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4731 4732
      self._setTemplateFormatVersion(1)

4733
      # Store all data
4734 4735
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4736
      self._portal_type_workflow_chain_item = \
4737
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4738 4739 4740 4741
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4742 4743 4744
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4745 4746 4747 4748 4749 4750
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4751
      self._portal_type_roles_item = \
4752
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4753 4754 4755 4756 4757 4758 4759 4760
      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())
4761 4762
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782
      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())
4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794
      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())
4795 4796
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4797 4798
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4799 4800
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4801
               self.getTemplateCatalogKeywordKeyList())
4802 4803 4804
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4805 4806
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4807
               self.getTemplateCatalogFullTextKeyList())
4808 4809
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4810
               self.getTemplateCatalogRequestKeyList())
4811 4812
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4813
               self.getTemplateCatalogMultivalueKeyList())
4814 4815 4816
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4817 4818
      self._local_roles_item = \
          LocalRolesTemplateItem(
4819
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4820 4821 4822
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4823 4824 4825
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4826 4827 4828 4829 4830 4831
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4832

4833 4834
      # Build each part
      for item_name in self._item_name_list:
4835 4836 4837 4838
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4839

4840
    build = WorkflowMethod(build)
4841 4842

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4843
      """
4844
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4845
      """
4846
      return self.portal_templates.publish(self, url, username=username,
4847
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4848

4849
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4850
      """
4851
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4852
      """
4853
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4854

4855 4856 4857 4858 4859
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4860 4861 4862 4863 4864 4865 4866 4867 4868 4869
      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
4870 4871
      return False

4872
    def preinstall(self, check_dependencies=1, **kw):
4873 4874 4875
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4876
      """
4877 4878 4879 4880 4881
      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()
4882

4883 4884
      modified_object_list = {}
      bt_title = self.getTitle()
4885 4886 4887 4888 4889 4890 4891

      #  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)
4892 4893 4894
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4895
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4896

4897
      # if reinstall business template, must compare to object in ZODB
4898
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4899
      # same if we make a diff and select only one business template
4900
      reinstall = 0
4901 4902
      if installed_bt == self:
        reinstall = 1
4903 4904 4905 4906 4907 4908 4909 4910 4911
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, id=INSTALLED_BT_FOR_DIFF)
          # update portal types properties to get last modifications
          bt2.getPortalTypesProperties()
          bt2.edit(description='tmp bt generated for diff', bt_for_diff=1)
          bt2.build()
          installed_bt = bt2
        else:
          installed_bt = self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF)
4912

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4913
      new_bt_format = self.getTemplateFormatVersion()
4914 4915 4916 4917 4918 4919
      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:
4920
          item = getattr(self, item_name, None)
4921 4922 4923 4924
          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
4925

4926
      for item_name in self._item_name_list:
4927
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4928
        old_item = getattr(installed_bt, item_name, None)
4929
        if new_item is not None:
4930
          if old_item is not None and hasattr(old_item, '_objects'):
4931
            modified_object = new_item.preinstall(context=self, installed_bt=old_item)
4932 4933 4934 4935 4936 4937 4938
            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:
4939
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
4940

4941 4942
      return modified_object_list

4943 4944
    def _install(self, force=1, object_to_update=None, update_translation=0,
                 update_catalog=0, **kw):
4945
      """
Christophe Dumez's avatar
Christophe Dumez committed
4946
        Install a new Business Template, if force, all will be upgraded or installed
4947 4948
        otherwise depends of dict object_to_update
      """
4949 4950 4951 4952
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4953

4954 4955
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
4956 4957
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4958
        if installed_bt.getTemplateFormatVersion() == 0:
4959
          force = 1
4960
        installed_bt.replace(self)
4961

4962 4963 4964 4965
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4966 4967 4968
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4969

4970 4971 4972
      if not force:
        self.checkDependencies()

4973
      site = self.getPortalObject()
4974 4975 4976 4977 4978 4979
      custom_generator_class = getattr(site, '_generator_class', None)
      if custom_generator_class is not None:
        gen = custom_generator_class()
      else:
        from Products.ERP5.ERP5Site import ERP5Generator
        gen = ERP5Generator()
4980 4981 4982
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Activity Tool')
4983
        gen.setupLastTools(site, update=1, create_activities=1)
4984 4985
      if not force:
        if len(object_to_update) == 0:
4986 4987 4988 4989 4990
          # 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():
4991
            LOG('Business Template', 0, 'Updating Business Template Workflows')
4992
            gen.setupWorkflow(site)
4993
          return
4994

4995 4996
      # 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
4997
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
4998 4999 5000 5001 5002
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
5003
      if len(object_to_update) or force:
5004 5005 5006
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
5007
            item.install(self, force=force, object_to_update=object_to_update, trashbin=trashbin, installed_bt=installed_bt)
5008

5009
      # update catalog if necessary
5010 5011
      if force and self.isCatalogUpdatable():
        update_catalog = 1
5012
      if update_catalog:
5013
        catalog = _getCatalogValue(self)
5014
        if (catalog is None) or (not site.isIndexable):
5015 5016 5017 5018 5019
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
5020

5021
      # get objects to remove
5022
      # do remove after because we may need backup object from installation
5023
      remove_object_dict = {}
5024 5025
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
5026
          remove_object_dict[path] = action
5027

5028
      # remove object from old business template
5029
      if len(remove_object_dict):
5030
        # XXX: this code assumes that there is an installed_bt
5031
        for item_name in reversed(installed_bt._item_name_list):
5032
          item = getattr(installed_bt, item_name, None)
5033
          if item is not None:
5034
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
5035

5036 5037 5038 5039 5040 5041

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

5042
      # check if we have to update business template workflow
5043
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
5044
        LOG('Business Template', 0, 'Updating Business Template Workflows')
5045 5046 5047 5048 5049
        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)

5050 5051
      # remove trashbin if empty
      if trashbin is not None:
5052
        if len(trashbin) == 0:
5053 5054
          trash_tool.manage_delObjects([trashbin.getId(),])

5055 5056
      if update_catalog:
        site.ERP5Site_reindexAll()
5057

5058 5059
      # Update translation table, in case we added new portal types or
      # workflow states.
5060 5061
      if update_translation:
        site.ERP5Site_updateTranslationTable()
5062

5063 5064
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
5065

5066
    security.declareProtected(Permissions.ManagePortal, 'install')
5067 5068 5069
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
5070
      """
5071
      return self._install(**kw)
5072

5073
    install = WorkflowMethod(install)
5074

5075
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
5076
    def reinstall(self, **kw):
5077 5078 5079 5080
      """Reinstall Business Template.
      """
      return self._install(**kw)

5081
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5082

5083
    security.declareProtected(Permissions.ManagePortal, 'trash')
5084 5085
    def trash(self, new_bt, **kw):
      """
5086
        Trash unnecessary items before upgrading to a new business
5087
        template.
5088
        This is similar to uninstall, but different in that this does
5089
        not remove all items.
5090
      """
5091 5092
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5093
        item = getattr(self, item_name, None)
5094 5095
        if item is not None:
          item.trash(
5096
                self,
5097
                getattr(new_bt, item_name))
5098

5099
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
5100
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5101
      """
5102
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5103
      """
5104 5105 5106
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5107
        item = getattr(self, item_name, None)
5108
        if item is not None:
5109
          item.uninstall(self)
5110
      # It is better to clear cache because the uninstallation of a
5111
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
5112
      self.getPortalObject().portal_caches.clearAllCache()
5113

5114 5115
    uninstall = WorkflowMethod(uninstall)

5116
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5117
    def _clean(self):
5118
      """
5119
        Clean built information.
5120
      """
5121
      # First, remove obsolete attributes if present.
5122 5123 5124 5125
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
5126
                    '_module_archive',
5127 5128 5129
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
5130
                    '_property_sheet_archive'):
5131 5132 5133
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
5134 5135
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
5136

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

5139
    security.declareProtected(Permissions.AccessContentsInformation,
5140
                              'getBuildingState')
5141
    def getBuildingState(self, default=None, id_only=1):
5142
      """
5143
        Returns the current state in building
5144
      """
5145
      portal_workflow = getToolByName(self, 'portal_workflow')
5146 5147
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
5148
      return wf._getWorkflowStateOf(self, id_only=id_only )
5149

5150
    security.declareProtected(Permissions.AccessContentsInformation,
5151
                              'getInstallationState')
5152
    def getInstallationState(self, default=None, id_only=1):
5153
      """
5154
        Returns the current state in installation
5155
      """
5156
      portal_workflow = getToolByName(self, 'portal_workflow')
5157 5158
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
5159
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5160

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5161 5162 5163 5164 5165 5166
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
5167
      export_string = portal_templates.manage_exportObject(
5168 5169
                                               id=self.getId(),
                                               toxml=1,
5170
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5171
      return export_string
5172

5173
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5174
      """
5175 5176
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5177
      """
5178 5179
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
5180 5181 5182 5183
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
5184
        # XXX Why do we need to return a tuple ?
5185 5186
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5187

5188
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5189
      """
5190 5191
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5192
      """
5193
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5194

5195
    def getTemplateBaseCategoryList(self):
5196
      """
5197 5198
      We have to set this method because we want an
      ordered list
5199
      """
5200
      return self._getOrderedList('template_base_category')
5201

5202
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5203
      """
5204 5205
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5206
      """
5207
      return self._getOrderedList('template_workflow_id')
5208

5209
    def getTemplatePortalTypeIdList(self):
5210
      """
5211 5212
      We have to set this method because we want an
      ordered list
5213
      """
5214
      return self._getOrderedList('template_portal_type_id')
5215

5216 5217 5218 5219 5220 5221 5222
    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
5223 5224 5225 5226 5227 5228 5229
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

5230 5231 5232 5233 5234 5235 5236
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

5237 5238 5239 5240 5241 5242
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
5243

5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264
    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')

5265
    def getTemplateActionPathList(self):
5266
      """
5267 5268
      We have to set this method because we want an
      ordered list
5269
      """
5270
      return self._getOrderedList('template_action_path')
5271

5272
    def getTemplatePortalTypeRoleList(self):
5273 5274 5275 5276
      """
      We have to set this method because we want an
      ordered list
      """
5277
      return self._getOrderedList('template_portal_type_role')
5278

5279
    def getTemplateLocalRoleList(self):
5280 5281 5282 5283
      """
      We have to set this method because we want an
      ordered list
      """
5284
      return self._getOrderedList('template_local_role')
5285

5286
    def getTemplateSkinIdList(self):
5287
      """
5288 5289
      We have to set this method because we want an
      ordered list
5290
      """
5291
      return self._getOrderedList('template_skin_id')
5292

5293 5294 5295 5296 5297 5298 5299
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

5300
    def getTemplateModuleIdList(self):
5301
      """
5302 5303
      We have to set this method because we want an
      ordered list
5304
      """
5305
      return self._getOrderedList('template_module_id')
5306 5307 5308 5309 5310 5311 5312

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5314 5315 5316 5317 5318 5319 5320
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5321
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5322 5323 5324 5325
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5326
      if self.getBuildingState() != 'built':
5327
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5328
              'Business Template must be built before export'
5329

Aurel's avatar
Aurel committed
5330 5331 5332 5333 5334 5335 5336
      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)

5337
      # export bt
5338
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
5339
      for prop in self.propertyMap():
5340
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5341
        id = prop['id']
5342
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5343
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5344
          continue
Aurel's avatar
Aurel committed
5345
        value = self.getProperty(id)
5346
        if prop_type in ('text', 'string', 'int', 'boolean'):
5347
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
5348
        elif prop_type in ('lines', 'tokens'):
5349
          bta.addObject(obj=str('\n').join(value), name=id,
5350
                        path=path+os.sep+'bt', ext='')
5351

Aurel's avatar
Aurel committed
5352 5353 5354
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5355

Aurel's avatar
Aurel committed
5356 5357
      return bta.finishCreation()

5358
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5359 5360
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5361
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5362 5363 5364 5365 5366 5367 5368
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
5369
      self._portal_type_workflow_chain_item = \
5370
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
5371 5372 5373 5374
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
5375 5376 5377
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
Aurel's avatar
Aurel committed
5378 5379 5380 5381 5382 5383
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
5384 5385
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
5386 5387 5388 5389 5390 5391 5392 5393
      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())
5394 5395
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417
      self._extension_item = \
          ExtensionTemplateItem(self.getTemplateExtensionIdList())
      self._test_item = \
          TestTemplateItem(self.getTemplateTestIdList())
      self._product_item = \
          ProductTemplateItem(self.getTemplateProductIdList())
      self._role_item = \
          RoleTemplateItem(self.getTemplateRoleList())
      self._catalog_result_key_item = \
          CatalogResultKeyTemplateItem(
               self.getTemplateCatalogResultKeyList())
      self._catalog_related_key_item = \
          CatalogRelatedKeyTemplateItem(
               self.getTemplateCatalogRelatedKeyList())
      self._catalog_result_table_item = \
          CatalogResultTableTemplateItem(
               self.getTemplateCatalogResultTableList())
      self._message_translation_item = \
          MessageTranslationTemplateItem(
               self.getTemplateMessageTranslationList())
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
5418 5419
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433
      self._portal_type_allowed_content_type_item = \
           PortalTypeAllowedContentTypeTemplateItem(
               self.getTemplatePortalTypeAllowedContentTypeList())
      self._portal_type_hidden_content_type_item = \
           PortalTypeHiddenContentTypeTemplateItem(
               self.getTemplatePortalTypeHiddenContentTypeList())
      self._portal_type_property_sheet_item = \
           PortalTypePropertySheetTemplateItem(
               self.getTemplatePortalTypePropertySheetList())
      self._portal_type_base_category_item = \
           PortalTypeBaseCategoryTemplateItem(
               self.getTemplatePortalTypeBaseCategoryList())
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
5434
               self.getTemplateCatalogKeywordKeyList())
5435 5436 5437
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
5438 5439
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
5440
               self.getTemplateCatalogFullTextKeyList())
5441 5442
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
5443
               self.getTemplateCatalogRequestKeyList())
5444 5445
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
5446
               self.getTemplateCatalogMultivalueKeyList())
5447 5448 5449
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
5450 5451
      self._local_roles_item = \
          LocalRolesTemplateItem(
5452
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5453 5454 5455
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
5456 5457 5458
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
5459 5460 5461 5462 5463 5464
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
5465

5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
      module_id_list = []
      for template_type in ('Constraint', 'Document', 'PropertySheet'):
        for template_id in getattr(self,
                                   'getTemplate%sIdList' % template_type)():
          module_id = 'Products.ERP5Type.%s.%s' % (template_type, template_id)
          if module_id not in sys.modules:
            module_id_list.append(module_id)
            sys.modules[module_id] = module = imp.new_module(module_id)
            module.SimpleItem = SimpleItem.SimpleItem
            exec "class %s(SimpleItem): pass" % template_id in module.__dict__

Aurel's avatar
Aurel committed
5479 5480
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5481

5482 5483 5484 5485 5486
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
      for module_id in module_id_list:
        del sys.modules[module_id]

5487 5488 5489 5490 5491
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5492 5493 5494
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5495
      return items_list
5496

5497 5498 5499 5500 5501 5502 5503 5504 5505 5506
    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:
5507
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5508
          dependency = dependency_couple_list[0]
5509 5510
          if dependency in (None, ''):
            continue
5511 5512
          version_restriction = None
          if len(dependency_couple_list) > 1:
5513
            version_restriction = dependency_couple_list[1]
5514 5515 5516
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5517 5518 5519
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5520
                  or (version_restriction not in (None, '') and
5521 5522 5523 5524
                     (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)
5525

Aurel's avatar
Aurel committed
5526
    def diffObject(self, REQUEST, **kw):
5527 5528
      """
        Make a diff between an object in the Business Template
5529
        and the same in the Business Template installed in the site
5530 5531 5532 5533
      """

      class_name_dict = {
        'Product' : '_product_item',
5534
        'PropertySheet' : '_property_sheet_item',
5535
        'Constraint' : '_constraint_item',
5536 5537 5538 5539 5540 5541 5542 5543 5544
        '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',
5545
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5546 5547 5548 5549
        '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',
5550 5551 5552
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5553
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5554
        'Path' : '_path_item',
5555
        'Preference' : '_preference_item',
5556
        'Action' : '_action_item',
5557
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5558
        'LocalRoles' : '_local_roles_item',
5559 5560 5561
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5562
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5563
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5564 5565 5566 5567
        '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
5568
        'Tool': '_tool_item',
5569
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5570 5571
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5572
        }
5573

5574 5575
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5576

Christophe Dumez's avatar
Christophe Dumez committed
5577
      # Get objects
5578
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5579

Aurel's avatar
Aurel committed
5580
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
5581
      # Compare with a given business template
5582
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5583 5584
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5585 5586
        if bt2_id == self.getId():
          compare_to_zodb = 1
5587
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5588 5589
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5590 5591 5592
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5593 5594
          compare_to_zodb = 1
      if compare_to_zodb:
5595
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5596
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5597 5598 5599
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5600

5601 5602
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5603
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5604
        # XXX maybe only build for the given object to gain time
5605
        installed_item.build(self)
5606 5607 5608
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5609

Christophe Dumez's avatar
Christophe Dumez committed
5610
      # Real Zope Objects (can be exported into XML directly by Zope)
5611 5612
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5613
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5614
                     '_skin_item', '_action_item', '_tool_item', ]
5615

Christophe Dumez's avatar
Christophe Dumez committed
5616
      # Not considered as objects by Zope (will be exported into XML manually)
5617
      # XXX Bad naming
5618
      item_list_2 = ['_site_property_item', '_module_item',
5619
                     '_catalog_result_key_item', '_catalog_related_key_item',
5620 5621
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
5622
                     '_catalog_datetime_key_item',
5623 5624 5625 5626
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5627
                     '_catalog_scriptable_key_item',
5628 5629
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5630 5631 5632 5633 5634 5635
                     '_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',
5636
                     '_portal_type_workflow_chain_item',]
5637

Christophe Dumez's avatar
Christophe Dumez committed
5638
      # Text objects (no need to export them into XML)
5639
      # XXX Bad naming
5640 5641
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5642
                     '_test_item', '_message_translation_item',]
5643

5644
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5645 5646 5647
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5648 5649
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
5650
        # XML Export in memory
5651 5652 5653
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
        OFS.XMLExportImport.exportXML(installed_object._p_jar, installed_object._p_oid, f2)
        new_obj_xml = f1.getvalue()
5654
        f1.close()
5655 5656 5657 5658
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5659
        # End of XML export
5660

5661
        # Diff between XML objects
5662 5663
        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
5664
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5665 5666 5667
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5668

5669
      elif item_name in item_list_2:
5670
        # Generate XML code manually
5671 5672
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5673 5674
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5675
        # End of XML Code Generation
5676

5677
        # Diff between XML objects
5678 5679
        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
5680
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5681 5682 5683
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5684

5685
      elif item_name in item_list_3:
5686
        # Diff between text objects
5687 5688 5689 5690
        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
5691
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5692 5693
          diff_msg += '\n'.join(diff_list)
        else:
5694
          diff_msg = 'No diff'
5695

5696
      else:
5697
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5698

5699
      if compare_to_zodb:
5700
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5701

5702
      return diff_msg
5703

5704

5705 5706 5707 5708
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5709 5710
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5711 5712 5713 5714 5715 5716 5717
      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 [])
5718 5719
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5720
      p = self.getPortalObject()
5721
      for id in bt_portal_types_id_list:
5722 5723
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5724
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5725
        if portal_type.getRoleInformationList():
5726 5727
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5728

5729 5730 5731 5732
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5733
        action_list = []
5734 5735 5736 5737 5738 5739 5740
        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'):
5741
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5742 5743
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5744

5745 5746 5747 5748
        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)
5749

5750
        for h_id in hidden_content_type_list:
5751 5752 5753
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5754

5755 5756 5757 5758
        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)
5759

5760 5761 5762 5763
        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)
5764

5765 5766 5767 5768
        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)
5769

5770
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5771
                                    if chain != '(Default)']:
5772 5773 5774
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5775

5776 5777 5778 5779
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5780
      bt_action_list.sort()
5781
      bt_wf_chain_list.sort()
5782

5783 5784 5785 5786 5787 5788 5789
      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)
5790 5791 5792 5793 5794 5795 5796 5797 5798
      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:
5799 5800
        raise TemplateConditionError, 'No module defined in business template'

5801 5802 5803 5804 5805 5806 5807 5808
      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:
5809
          return type_list
5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823

        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():
5824
            type_list.update(getChildPortalType(hidden_ptype_id))
5825
        return type_list
5826

5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873
      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

5874 5875 5876
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5877
  setattr(BusinessTemplate, key, None)
5878

5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905
# 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)
5906

5907 5908 5909 5910 5911 5912 5913 5914

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

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