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

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

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

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

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

93 94
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'

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

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

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

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

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

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

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

203 204 205 206 207 208 209 210 211
  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 ''
212
    selection_list = selection.split(',')
213
    if (skin_folder_id not in selection_list):
214
      selection_list.insert(0, skin_folder_id)
215 216
    if reorder_skin_selection:
      selection_list.sort(
217 218
        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)
219
    if (skin_name in skin_layer_list):
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 278
      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
279 280 281
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
282
  """
Aurel's avatar
Aurel committed
283 284 285 286 287 288 289 290 291 292 293 294

  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
295

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

465
  def preinstall(self, context, installed_bt, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
466 467 468 469 470 471 472 473
    """
      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
474 475
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
476
      new_keys = self._objects.keys()
477
      for path in new_keys:
478
        if installed_bt._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
479
          # compare objects to see it there are changes
480 481
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
482 483
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
484
          # else, compared versions are identical, don't overwrite the old one
485 486
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
487
      # list removed objects
488 489 490 491 492 493 494
      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):
495
    pass
496 497 498

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

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

527

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

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

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

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

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

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

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

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

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

652 653 654 655
  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):
656
          LOG('Business Template', 0, 'Compiling %s to %s...' % (file.name, compiled_file))
657
          try:
658
              from Shared.DC.xml import ppml
659
              from OFS.XMLExportImport import start_zopedata, save_record, save_zopedata
660
              import pyexpat
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
              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)

683
  def _importFile(self, file_name, file_obj):
684
    # import xml file
685
    if not file_name.endswith('.xml'):
686 687
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
688
      return
689 690 691 692 693
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
694
    __traceback_info__ = 'Importing %s' % file_name
695 696 697 698 699 700 701
    # 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)
702
    else:
703 704
      # FIXME: Why not use the importXML function directly? Are there any BT5s
      # with actual .zexp files on the wild?
705
      obj = connection.importFile(file_obj, customImporters=customImporters)
706
    self.removeProperties(obj)
707 708
    self._objects[file_name[:-4]] = obj

709
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
710 711
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
712 713 714
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
      for path in self._objects:
715
        if installed_bt._objects.has_key(path):
Julien Muchembled's avatar
Julien Muchembled committed
716 717
          upgrade_list.append((path,
            self.removeProperties(installed_bt._objects[path])))
718
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
          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
735
      # get removed object
Julien Muchembled's avatar
Julien Muchembled committed
736 737
      for path in set(installed_bt._objects) - set(self._objects):
        modified_object_list[path] = 'Removed', type_name
738 739
    return modified_object_list

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

765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
  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

790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
  def setSafeReindexationMode(self, context):
    """
      Postpone indexations after unindexations.
      This avoids alarming error messages about a single uid being used
      by "deleted" path and reindexed object. This can happen here for
      objects on which the uid was restored: previous object was deleted,
      hence the "deleted" path, and new object does have the same uid.
    """
    original_reindex_parameters = context.getPlacelessDefaultReindexParameters()
    if original_reindex_parameters is None:
      original_reindex_parameters = {}
    activate_kw = original_reindex_parameters.get('activate_kw', {}).copy()
    activate_kw['after_method_id'] = 'unindexObject'
    context.setPlacelessDefaultReindexParameters(activate_kw=activate_kw, \
                                                 **original_reindex_parameters)
    return original_reindex_parameters

807
  def install(self, context, trashbin, **kw):
808
    self.beforeInstall()
809 810
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
811
    if context.getTemplateFormatVersion() == 1:
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
      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
831
      groups = {}
832
      old_groups = {}
833 834 835 836
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
837 838
      # set safe activities execution order
      original_reindex_parameters = self.setSafeReindexationMode(context)
839
      for path in keys:
840 841
        if update_dict.has_key(path) or force:
          # get action for the oject
Yoshinori Okuji's avatar
Yoshinori Okuji committed
842
          action = 'backup'
843 844 845 846 847
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          # get subobjects in path
848 849 850
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
851 852 853 854
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
855
            container_url = '/'.join(container_path)
856 857 858 859
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
860
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
861 862
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
863
              container_container = portal.unrestrictedTraverse(container_path[:-1])
864 865 866 867 868
              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)
869 870
            else:
              raise
871
          saved_uid_dict = {}
872
          subobjects_dict = {}
Julien Muchembled's avatar
Julien Muchembled committed
873
          portal_type_dict = {}
874
          # Object already exists
875 876
          old_obj = container._getOb(object_id, None)
          if old_obj is not None:
877
            recurse(saveHook, old_obj)
878
            if getattr(aq_base(old_obj), 'groups', None) is not None:
879 880 881 882 883
              # 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)
884
            subobjects_dict = self._backupObject(action, trashbin,
885
                                                 container_path, object_id)
Julien Muchembled's avatar
Julien Muchembled committed
886
            # in case of portal types, we want to keep some properties
887
            if getattr(old_obj, 'meta_type', None) == 'ERP5 Base Type':
888
              for attr in ('allowed_content_types',
Julien Muchembled's avatar
Julien Muchembled committed
889 890 891 892 893 894
                           '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, '')
895
            container.manage_delObjects([object_id])
896 897
          else:
            self.onNewObject()
898
          # install object
899
          obj = self._objects[path]
900 901 902
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
903
          if getattr(aq_base(obj), 'groups', None) is not None:
904
            # we must keep original order groups
905
            # because they change when we add subobjects
906
            groups[path] = deepcopy(obj.groups)
907
          # copy the object
908 909 910 911 912 913 914 915 916
          if (getattr(aq_base(obj), '_mt_index', None) is not None and
              obj._count() == 0):
            # some btrees were exported in a corrupted state. They're empty but
            # their metadata-index (._mt_index) contains entries which in
            # Zope 2.12 are used for .objectIds(), .objectValues() and
            # .objectItems(). In these cases, force the 
            LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
                'Cleaning corrupt BTreeFolder2 object at %r.' % (path,))
            obj._initBTrees()
917
          obj = obj._getCopy(container)
918 919 920 921 922
          try:
            container._setObject(object_id, obj)
          except AttributeError:
            LOG("BT, install", 0, object_id)
            raise
923
          obj = container._getOb(object_id)
924 925
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
926
          self.REQUEST.set('is_business_template_installation', 1)
927 928 929 930
          # We set isIndexable to 0 before calling
          # manage_afterClone in order to not call recursiveReindex, this is
          # useless because we will already reindex every created object, so
          # we avoid duplication of reindexation
931
          obj.isIndexable = ConstantGetter('isIndexable', value=False)
932
          obj.manage_afterClone(obj)
933 934 935
          del obj.isIndexable
          if getattr(aq_base(obj), 'reindexObject', None) is not None:
            obj.reindexObject()
936
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
937
          if portal_type_dict:
938
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
939
            wf_chain = portal_type_dict.pop('workflow_chain')
940 941
            chain_dict = getChainByType(context)[1]
            default_chain = ''
942
            chain_dict['chain_%s' % (object_id)] = wf_chain
943
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
944 945
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
946
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
947
          if subobjects_dict:
948
            # get a jar
949 950
            connection = obj._p_jar
            o = obj
951
            while connection is None:
952 953
              o = o.aq_parent
              connection = o._p_jar
954
            # import subobjects
955
            for subobject_id, subobject_data in subobjects_dict.iteritems():
956 957 958 959 960 961 962 963 964 965 966
              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))
967
          if obj.meta_type in ('Z SQL Method',):
968
            fixZSQLMethod(portal, obj)
969 970 971
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
972 973 974
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
975
          elif obj.meta_type in ('ERP5 Ram Cache',
976
                                 'ERP5 Distributed Ram Cache',):
977 978
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
979 980
          elif (container.meta_type == 'CMF Skins Tool') and \
              (old_obj is not None):
981 982 983 984 985 986 987 988 989 990 991 992 993 994
            # Keep compatibility with previous export format of
            # business_template_registered_skin_selections
            # and do not modify exported value
            if obj.getProperty('business_template_registered_skin_selections', 
                               None) is None:
              # Keep previous value of register skin selection for skin folder
              skin_selection_list = old_obj.getProperty(
                  'business_template_registered_skin_selections', None)
              if skin_selection_list is not None:
                if isinstance(skin_selection_list, basestring):
                  skin_selection_list = skin_selection_list.split(' ')
                obj._setProperty(
                    'business_template_registered_skin_selections',
                    skin_selection_list, type='tokens')
995
           
996
          recurse(restoreHook, obj)
997
      # now put original order group
998 999
      # we remove object not added in forms
      # we put old objects we have kept
1000
      for path, new_groups_dict in groups.iteritems():
1001 1002 1003 1004 1005 1006 1007 1008 1009
        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
1010
          # excetp the one that had to be removed
1011 1012 1013 1014
          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'):
1015 1016
              continue
            widget_in_form = 0
1017 1018
            for group_id, group_value_list in new_groups_dict.iteritems():
              if widget_id in group_value_list:
1019 1020 1021 1022 1023 1024
                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:
1025
              for old_group_id, old_group_values in old_groups_dict.iteritems():
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
                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,]
1037
                  obj.group_list = list(obj.group_list) + ['not_assigned']
1038
          # second check all widget_id in order are in form
1039 1040
          for group_id, group_value_list in new_groups_dict.iteritems():
            for widget_id in tuple(group_value_list):
1041 1042 1043
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
1044
                group_value_list.remove(widget_id)
1045
          # now set new group object
1046
          obj.groups = new_groups_dict
1047
      # restore previous activities execution order
1048
      context.setPlacelessDefaultReindexParameters(**original_reindex_parameters)
Aurel's avatar
Aurel committed
1049
    else:
1050 1051
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1052
      portal = context.getPortalObject()
1053
      for relative_url in self._archive.keys():
1054
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
1055 1056 1057 1058
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
1059
        if object_id in container_ids:    # Object already exists
1060
          self._backupObject('backup', trashbin, container_path, object_id)
1061
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
1062
        # Set a hard link
1063 1064 1065 1066 1067 1068
        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',):
1069
          fixZSQLMethod(portal, obj)
1070
    self.afterInstall()
1071 1072 1073

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
1074
    trash = kw.get('trash', 0)
1075 1076 1077 1078 1079
    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
1080
      object_keys = self._archive.keys()
1081
    for relative_url in object_keys:
1082 1083
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
1084
      try:
1085
        container = portal.unrestrictedTraverse(container_path)
1086
        object = container._getOb(object_id) # We force access to the object to be sure
1087 1088
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
1089
        if trash and trashbin is not None:
1090
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
1091
        if container.meta_type == 'CMF Skins Tool':
1092 1093
          # we are removing a skin folder, check and 
          # remove if registered skin selection
1094
          skin_folder = container[object_id]
1095 1096 1097
          unregisterSkinFolder(container, skin_folder,
              container.getSkinSelections())

1098
        container.manage_delObjects([object_id])
1099 1100
        if container.aq_parent.meta_type == 'ERP5 Catalog' and len(container.objectIds()) == 0:
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1101
          container.getParentValue().manage_delObjects([container.id])
1102
      except (NotFound, KeyError, BadRequest, AttributeError):
1103
        # object is already backup and/or removed
1104
        pass
1105 1106
    BaseTemplateItem.uninstall(self, context, **kw)

1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
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

1119 1120 1121 1122 1123 1124 1125 1126 1127
  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()
1128 1129
    object_keys.sort()
    object_keys.reverse()
1130 1131
    p = context.getPortalObject()
    for path in object_keys:
1132 1133 1134 1135 1136
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1137 1138 1139
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1140
        try:
Aurel's avatar
Aurel committed
1141 1142
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
1143 1144
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
1145 1146
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1147
                                           keep_subobjects=1)
1148 1149 1150 1151 1152 1153
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1154 1155 1156
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1157

1158 1159 1160 1161 1162 1163 1164 1165 1166
      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.
1167 1168 1169
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1170
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1171 1172
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1173
      if object_id != "":
1174
        path_list.extend(self._resolvePath(
1175
            folder._getOb(object_id),
1176
            relative_url_list + [object_id], id_list[1:]))
1177
    return path_list
Aurel's avatar
Aurel committed
1178

1179 1180 1181
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1182
    keys = self._path_archive.keys()
1183
    keys.sort()
Aurel's avatar
Aurel committed
1184
    for path in keys:
1185 1186 1187
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
1188
      for relative_url in self._resolvePath(p, [], path.split('/')):
1189 1190
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1191
        obj = obj.__of__(context)
1192
        _recursiveRemoveUid(obj)
1193
        id_list = obj.objectIds()
1194
        obj = self.removeProperties(obj)
1195
        if hasattr(aq_base(obj), 'groups'):
1196
          # we must keep groups because it's ereased when we delete subobjects
1197
          groups = deepcopy(obj.groups)
1198
        if len(id_list) > 0:
1199 1200
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1201
          for id_ in list(id_list):
1202
            obj._delObject(id_)
1203
        if hasattr(aq_base(obj), 'groups'):
1204 1205 1206
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1207

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1208 1209 1210 1211 1212 1213 1214 1215
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)

1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
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")
1231
    if len(id_list) != 1:
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
      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():
1244
      pref = portal.unrestrictedTraverse(object_path)
1245
      # XXX getPreferenceState is a bad name
1246
      if pref.getPreferenceState() == 'disabled':
1247 1248
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1249 1250
        portal.portal_workflow.doActionFor(
                      pref,
1251 1252 1253
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1254 1255
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1256

1257 1258
class CategoryTemplateItem(ObjectTemplateItem):

1259 1260
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1261

1262 1263 1264 1265
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1266 1267
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1268
      obj = self.removeProperties(obj)
1269
      id_list = obj.objectIds()
1270
      if id_list:
1271
        self.build_sub_objects(context, id_list, relative_url)
1272
        for id_ in list(id_list):
1273
          obj._delObject(id_)
1274 1275
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1276 1277 1278 1279 1280

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1281 1282
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1283
      _recursiveRemoveUid(obj)
1284
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1285
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1286
      id_list = obj.objectIds()
1287 1288
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1289
        for id_ in list(id_list):
1290
          obj._delObject(id_)
1291
      else:
1292
        for id_ in list(id_list):
1293
          obj._delObject(id_)
1294 1295
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1296

1297 1298 1299 1300 1301 1302 1303 1304
  def beforeInstall(self):
    self._installed_new_category = False

  def onNewObject(self):
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1305 1306
      # reset accessors if we installed a new category
      _aq_reset()
1307

1308 1309
class SkinTemplateItem(ObjectTemplateItem):

1310 1311
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1312

1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
  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')

1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
  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

1338
  def install(self, context, trashbin, **kw):
1339
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1340 1341
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1342
    p = context.getPortalObject()
1343
    skin_tool = p.portal_skins
1344 1345
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1346
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1347 1348
        fixZSQLMethod(p, obj)

1349
      # Do not register skin which were explicitely ask not to be installed
1350 1351 1352 1353 1354
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
      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]
1376
      else:
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
        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:
1422
          create_property = True
1423 1424
          selection_string = self._objects[skin_folder_id].replace(',', ' ')
        else:
1425 1426 1427
          create_property = False
          if not isinstance(selection_string, basestring):
            selection_string = ' '.join(selection_string)
1428 1429 1430 1431 1432 1433
          selection_string += ' %s' % \
            self._objects[skin_folder_id].replace(',', ' ')

        # Remove duplicate
        selection_string = \
            ' '.join(dict([(x, 0) for x in selection_string.split(' ')]).keys())
1434 1435 1436 1437 1438 1439 1440 1441
        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(' '))
1442 1443 1444 1445 1446

        selection_list = selection_string.split(' ')
        unregisterSkinFolder(skin_tool, skin_folder,
            skin_tool.getSkinSelections())
        registerSkinFolder(skin_tool, skin_folder)
1447 1448

  def uninstall(self, context, **kw):
1449 1450 1451
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1452 1453 1454 1455
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
      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:
1471
        skin_folder._updateProperty(
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526
            '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
1527 1528


1529
class WorkflowTemplateItem(ObjectTemplateItem):
1530

1531 1532
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1533

1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
  # 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:
1546
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1547 1548 1549 1550
      else:
        modified_workflow_dict[modified_object] = state
    return modified_workflow_dict

1551
  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1552
    if context.getTemplateFormatVersion() == 1:
1553 1554 1555
      portal = context.getPortalObject()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
Julien Muchembled's avatar
Julien Muchembled committed
1556 1557 1558
      # sort to add objects before their subobjects
      for path in sorted(self._objects):
          if force:
1559
            action = 'backup'
Julien Muchembled's avatar
Julien Muchembled committed
1560
          else:
1561
            action = update_dict.get('/'.join(path.split('/')[:2]))
Julien Muchembled's avatar
Julien Muchembled committed
1562 1563
            if action in (None, 'nothing'):
              continue
1564 1565 1566 1567 1568 1569
          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
1570
            container_url = '/'.join(container_path)
1571 1572 1573 1574 1575 1576
            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
1577
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1578
            container.manage_delObjects([object_id])
1579
          obj = self._objects[path]
1580 1581 1582
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1583 1584 1585 1586 1587
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1588 1589 1590 1591
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1592 1593
class PortalTypeTemplateItem(ObjectTemplateItem):

1594 1595
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1596 1597
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1598 1599 1600
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1601 1602
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1603 1604
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1605 1606
      # obj is in ghost state and an attribute must be accessed
      # so that obj.__dict__ does not return an empty dict
1607
      obj.meta_type
1608
      for attr in obj.__dict__.keys():
1609 1610 1611 1612 1613 1614 1615 1616
        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)
1617 1618
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1619

1620 1621
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1622 1623 1624 1625
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1626 1627
    # We now need to setup the list of workflows corresponding to
    # each portal type
1628
    (default_chain, chain_dict) = getChainByType(context)
1629
    # Set the default chain to the empty string is probably the
1630
    # best solution, by default it is 'default_workflow', which is
1631
    # not very usefull
1632
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1633
    if context.getTemplateFormatVersion() == 1:
1634
      object_list = self._objects
1635
    else:
1636 1637
      object_list = self._archive
    for path in object_list.keys():
1638 1639 1640 1641
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1642
            continue
1643 1644
        obj = object_list[path]
        portal_type = obj.id
1645 1646 1647
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1648 1649
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1650

1651 1652
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1653 1654 1655 1656 1657 1658 1659
  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:
1660
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1661 1662 1663 1664 1665
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1666
        dict[str(ptype)] = str(workflow)
1667 1668 1669 1670
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1671
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1672 1673

  def build(self, context, **kw):
1674 1675 1676 1677 1678
    # 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
1679
    p = context.getPortalObject()
1680
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1681
    for key in self._archive.keys():
1682 1683 1684
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1685
        workflow = wflist[1]
1686
      else:
1687
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1688
        portal_type = wflist[0][:-2]
1689 1690
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1691 1692 1693 1694
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
1695
        if workflow[0] != '-' and \
1696
            workflow_name not in chain_dict['chain_%s' % portal_type].split(', '):
1697
          if not self.is_bt_for_diff:
1698 1699 1700 1701 1702
            # 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))
1703
        if self._objects.has_key(portal_type):
1704 1705
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1706
        else:
1707
          self._objects[portal_type] = [workflow,]
1708
      elif not self.is_bt_for_diff:
1709
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1710
                        'is probably a sign of a missing dependency.'\
1711
                                                    % portal_type
1712

Christophe Dumez's avatar
Christophe Dumez committed
1713
  # Function to generate XML Code Manually
1714 1715 1716 1717 1718
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1719
      workflow_list = self._objects[key]
1720 1721 1722
      # XXX Not always a list
      if isinstance(workflow_list, str):
        workflow_list = [workflow_list]
1723 1724
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
1725
      xml_data += '\n  <workflow>%s</workflow>' %(', '.join(sorted(workflow_list)))
1726 1727
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743
    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
1744
    (default_chain, chain_dict) = getChainByType(context)
1745
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1746
    # best solution, by default it is 'default_workflow', which is
1747 1748 1749 1750 1751 1752 1753
    # 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':
1754
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1755 1756
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
1757
        if len(path_splitted) < 1:
Jérome Perrin's avatar
Jérome Perrin committed
1758
          continue
1759
        portal_type = path_splitted[-1]
1760
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1761 1762 1763
          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 != '':
1764
            old_chain_workflow_id_set = {}
1765
            # get existing workflow id list
1766 1767
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1768
            # get new workflow id list
1769
            for wf_id in self._objects[path].split(', '):
1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
              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
1784 1785
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1786
          else:
Romain Courteaud's avatar
Romain Courteaud committed
1787 1788 1789 1790 1791 1792
            # 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)
1793
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1794
        else:
1795 1796 1797 1798
          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
1799
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1800 1801
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1802

1803 1804
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1805 1806 1807 1808 1809 1810
    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:
1811 1812 1813 1814 1815 1816
      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():
1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
        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
1829
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1830

1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
  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

1864
  def _importFile(self, file_name, file):
1865 1866 1867 1868
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879
    # 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
1880 1881
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1882 1883 1884
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1885 1886
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1887

1888
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
1889 1890 1891
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
1892 1893
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
1894
  business_template_class_property = '_portal_type_allowed_content_type_item'
1895 1896

  def build(self, context, **kw):
1897 1898
    types_tool = self.getPortalObject().portal_types
    types_list = list(types_tool.objectIds())
1899
    for key in self._archive.keys():
1900 1901 1902 1903
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
1904 1905 1906 1907 1908
      # 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, ())
1909
      if not allowed_type in prop_value and not self.is_bt_for_diff:
Jérome Perrin's avatar
Jérome Perrin committed
1910
        raise ValueError, "%s %s not found in portal type %s" % (
1911 1912 1913
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)

1914 1915 1916 1917 1918 1919 1920
      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
1921
  # Function to generate XML Code Manually
1922
  def generateXml(self, path=None):
1923
    dictio = self._objects
1924
    xml_data = '<%s>' %(self.xml_tag,)
1925
    keys = dictio.keys()
1926 1927
    keys.sort()
    for key in keys:
1928
      allowed_list = sorted(dictio[key])
1929
      xml_data += '\n <portal_type id="%s">' %(key,)
1930
      for allowed_item in allowed_list:
1931 1932 1933
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944
    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)

1945 1946 1947 1948 1949
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
1950 1951 1952 1953
      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:
1954
          new_key = '%s/%s' % (self.class_property, key)
1955
          new_dict[new_key] = installed_bt._objects[key]
1956 1957 1958
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
1959 1960 1961 1962 1963
        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]
1964
          old_object = installed_bt._objects[path]
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
          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

1976
  def _importFile(self, file_name, file):
1977 1978 1979 1980
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
1981
    path, name = posixpath.split(file_name)
1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996
    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')
1997 1998 1999 2000 2001 2002 2003
    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())):
2004 2005 2006 2007 2008
      if update_dict.has_key(key) or force:
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2009 2010 2011 2012
        try:
          portal_id = key.split('/')[-1]
          portal_type = pt._getOb(portal_id)
        except (AttributeError, KeyError):
2013 2014
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2015 2016
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
2017 2018 2019
        object_property_list = getattr(portal_type, self.class_property, ())
        if len(object_property_list) > 0:
          # merge differences between portal types properties
2020 2021 2022 2023 2024
          # 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
2025
          for id in object_property_list:
2026
            if id not in property_list and id not in old_property_list:
2027
              property_list.append(id)
2028
        setattr(portal_type, self.class_property, tuple(property_list))
2029

Aurel's avatar
Aurel committed
2030
  def uninstall(self, context, **kw):
2031
    object_path = kw.get('object_path', None)
2032
    p = context.getPortalObject()
2033
    pt = p.unrestrictedTraverse('portal_types')
2034 2035 2036 2037 2038 2039 2040 2041
    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)
2042
      except (AttributeError,  KeyError):
2043 2044 2045
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
2046 2047
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2048 2049
      for id in property_list:
        if id in original_property_list:
2050
          original_property_list.remove(id)
2051
      setattr(portal_type, self.class_property, tuple(original_property_list))
2052

2053

2054 2055
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2056
  name = 'Hidden Content Type'
2057 2058
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2059
  business_template_class_property = '_portal_type_hidden_content_type_item'
2060

2061

2062 2063
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2064
  name = 'Property Sheet'
2065 2066
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2067
  business_template_class_property = '_portal_type_property_sheet_item'
2068

2069

2070 2071
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2072
  name = 'Base Category'
2073 2074
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2075
  business_template_class_property = '_portal_type_base_category_item'
2076

2077

2078
class CatalogMethodTemplateItem(ObjectTemplateItem):
2079
  """Template Item for catalog methods.
2080

2081 2082 2083 2084 2085
    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.
  """
2086

2087 2088
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2089
    # a mapping to store properties of methods.
2090 2091 2092 2093 2094
    # 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()
2095

2096 2097 2098 2099 2100
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114
  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

2115 2116
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2117

2118
    catalog = _getCatalogValue(self)
2119
    if catalog is None:
2120
      LOG('BusinessTemplate build', 0, 'catalog not found')
2121
      return
2122

2123 2124 2125
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2126

2127 2128
    for obj in self._objects.values():
      method_id = obj.id
2129 2130
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2131
      self._is_filtered_archive[method_id] = 0
2132
      if catalog.filter_dict.has_key(method_id):
2133 2134 2135 2136 2137 2138 2139 2140 2141
        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']
2142

Aurel's avatar
Aurel committed
2143
  def export(self, context, bta, **kw):
2144
    catalog = _getCatalogValue(self)
2145 2146 2147 2148
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

Aurel's avatar
Aurel committed
2149 2150 2151 2152
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
2153
      obj = self._objects[key]
Aurel's avatar
Aurel committed
2154
      # create folder and subfolders
2155
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
2156 2157 2158 2159
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
2160 2161
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
2162
      # add all datas specific to catalog inside one file
2163
      method_id = obj.id
2164 2165
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

2166
      f = open(object_path, 'wb')
2167
      xml_data = '<catalog_method>'
2168

2169
      for method_property, value in self._method_properties[method_id].items():
2170 2171 2172
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2173

Aurel's avatar
Aurel committed
2174
      if catalog.filter_dict.has_key(method_id):
2175
        if catalog.filter_dict[method_id]['filtered']:
2176 2177 2178
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2179 2180 2181 2182
          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'')):
2183 2184 2185
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2186
              elif type(value) in (type(()), type([])):
2187
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2188
                for item in value:
2189 2190 2191
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
      xml_data += '\n</catalog_method>'
2192
      f.write(xml_data)
Aurel's avatar
Aurel committed
2193
      f.close()
2194

Christophe Dumez's avatar
Christophe Dumez committed
2195 2196 2197 2198 2199 2200
  # 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:
2201 2202
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
Christophe Dumez's avatar
Christophe Dumez committed
2203
    return xml_data
2204

2205 2206
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2207
    catalog = _getCatalogValue(self)
2208 2209 2210 2211 2212 2213 2214
    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)
2215

2216 2217 2218
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2219
    new_bt_format = context.getTemplateFormatVersion()
2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235

    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':
2236
              continue
2237 2238 2239 2240
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2241

2242 2243
    for obj in values:
      method_id = obj.id
2244

2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255
      # 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))
2256

2257 2258
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2259
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2260
        if context.getTemplateFormatVersion() == 1:
2261 2262 2263
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2264
        filter_type = self._filter_type_archive[method_id]
2265 2266 2267
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2268
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2269
        catalog.filter_dict[method_id]['type'] = filter_type
2270
      elif method_id in catalog.filter_dict.keys():
2271
        catalog.filter_dict[method_id]['filtered'] = 0
2272

2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298
      # 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)
2299

2300 2301 2302 2303 2304 2305
        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)
2306

2307
  def uninstall(self, context, **kw):
2308
    catalog = _getCatalogValue(self)
2309 2310 2311
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2312

2313 2314 2315 2316
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2317 2318 2319 2320
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2321
    else:
2322 2323 2324 2325
      try:
        value = self._archive[object_path]
      except KeyError:
        value = None
2326 2327
      if value is not None:
        values.append(value)
2328
    for obj in values:
2329
      method_id = obj.id
2330 2331 2332 2333 2334 2335 2336 2337 2338
      # 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)
2339

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2340
      if catalog.filter_dict.has_key(method_id):
2341
        del catalog.filter_dict[method_id]
2342

2343
    # uninstall objects
2344
    ObjectTemplateItem.uninstall(self, context, **kw)
2345

2346
  def _importFile(self, file_name, file):
2347
    if file_name.endswith('.catalog_keys.xml'):
2348
      # recreate data mapping specific to catalog method
2349 2350
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2351
      xml = parse(file)
2352
      method_list = xml.getElementsByTagName('item')
2353
      for method in method_list:
2354
        key = method.getAttribute('key')
2355 2356
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
2357 2358 2359 2360
          if len(method.getElementsByTagName('value')[0].childNodes):
            value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          else:
            value = ''
2361
          key = str(key)
2362
        elif key_type == "int":
2363
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
2364
          key = str(key)
2365
        elif key_type == "tuple":
2366 2367 2368 2369
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
2370
        else:
2371
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2372
          continue
2373
        if key in catalog_method_list or key in catalog_method_filter_list:
2374
          dict = getattr(self, key, {})
2375
          dict[id] = value
2376 2377 2378
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
    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, ))
2391

2392
class ActionTemplateItem(ObjectTemplateItem):
2393 2394

  def __init__(self, id_list, **kw):
2395
    # XXX It's look like ObjectTemplateItem __init__
2396 2397 2398 2399 2400 2401
    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

2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422
  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

2423 2424 2425 2426
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2427 2428 2429
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
Julien Muchembled's avatar
Julien Muchembled committed
2430
      # Several tools still use CMF actions
2431
      is_new_action = obj.getParentId() == 'portal_types'
2432
      id_id = is_new_action and 'reference' or 'id'
2433 2434
      for action in (is_new_action and obj.getActionInformationList
                                    or obj.listActions)():
2435
        if getattr(action, id_id, None) == value:
2436
          break
2437
      else:
2438 2439 2440 2441 2442 2443 2444
        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)
2445
      key = posixpath.join(url[-2], url[-1], value)
2446
      self._objects[key] = self.removeProperties(action)
2447
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2448

2449 2450 2451
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2452
    if context.getTemplateFormatVersion() == 1:
2453
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2454 2455
      p = context.getPortalObject()
      for id in self._objects.keys():
2456 2457 2458 2459 2460
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2461 2462 2463
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2464

2465
          if container.getParentId() == 'portal_types':
2466 2467 2468
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2469 2470
            continue

Julien Muchembled's avatar
Julien Muchembled committed
2471 2472
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488
          try:
            from Products.CMFCore.interfaces import IActionProvider
          except ImportError:
              # we still don't load ZCML on tests on 2.8, but on 2.8 we don't
              # need to redirect actions to portal_actions.
              pass
          else:
            if not IActionProvider.providedBy(container):
              # some tools stopped being ActionProviders in CMF 2.x. Drop the
              # action into portal_actions.
              LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
                  'Misplaced action',
                  'Attempted to store action %r in %r which is no longer an '
                  'IActionProvided. Storing action on portal_actions instead' %
                  (id, path))
              container = p.portal_actions
2489
          obj, action = container, obj
2490
          action_list = obj.listActions()
2491
          for index in range(len(action_list)):
2492
            if action_list[index].id == id:
2493
              # remove previous action
2494
              obj.deleteActions(selections=(index,))
2495 2496 2497
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2498
          obj.addAction(
2499 2500
                        id = action.id
                      , name = action.title
2501
                      , action = action_text
2502 2503 2504 2505
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2506 2507
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2508
                      , priority = action.priority
2509
                      , description = action.description
Aurel's avatar
Aurel committed
2510
                    )
2511
          # sort action based on the priority define on it
2512 2513 2514 2515 2516 2517 2518 2519 2520
          # 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))
2521 2522
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2523
        container.manage_delObjects([obj.id
2524
          for obj in container.getActionInformationList()
2525
          if obj.getReference() in action_dict])
2526 2527
        for obj in action_dict.itervalues():
          container._importOldAction(obj)
Aurel's avatar
Aurel committed
2528
    else:
2529
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2530
      p = context.getPortalObject()
2531 2532
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2533
        relative_url, key, value = self._splitPath(id)
2534 2535
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2536
          if getattr(ai, key) == value:
2537
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2538 2539 2540
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2541
        obj.addAction(
Aurel's avatar
Aurel committed
2542 2543
                      id = action.id
                    , name = action.title
2544
                    , action = action_text
Aurel's avatar
Aurel committed
2545 2546 2547 2548
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2549 2550
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2551
                    )
Aurel's avatar
Aurel committed
2552 2553 2554 2555 2556 2557 2558
        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))
2559 2560
          obj.moveDownActions(selections=tuple(move_down_list))

2561 2562
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2563 2564
    object_path = kw.get("object_path", None)
    if object_path is not None:
2565 2566 2567 2568 2569 2570 2571 2572
      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]
2573
    else:
2574
      keys = self._archive.keys()
2575
    for id in keys:
2576 2577
      if  '|' in id:
        relative_url, value = id.split(' | ')
2578 2579 2580 2581 2582
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
          is_new_action = obj.getParentId() == 'portal_types'
          key = is_new_action and 'reference' or 'id'
2583
      else:
2584
        relative_url, key, value = self._splitPath(id)
2585
        obj = p.unrestrictedTraverse(relative_url, None)
2586 2587 2588
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2589
          if getattr(action_list[index], key, None) == value:
2590 2591
            obj.deleteActions(selections=(index,))
            break
2592 2593
      LOG('BusinessTemplate', 100,
          'unable to uninstall action at %s, ignoring' % relative_url )
2594 2595
    BaseTemplateItem.uninstall(self, context, **kw)

2596 2597 2598
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2599
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2600 2601 2602 2603 2604 2605 2606
    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])
2607
      self._objects[relative_url] = type_role_list = []
2608
      for role in obj.getRoleInformationList():
2609
        type_role_dict = {}
2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626
        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
2627
        type_role_list.append(type_role_dict)
2628
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2629

Christophe Dumez's avatar
Christophe Dumez committed
2630
  # Function to generate XML Code Manually
2631 2632 2633 2634
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2635
      xml_data += "\n  <role id='%s'>" % role['id']
2636
      # uniq
2637
      for property in ('title', 'description', 'condition',
2638 2639 2640
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2641 2642
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2643
          xml_data += "\n   <property id='%s'>%s</property>" % \
2644 2645 2646
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2647
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2648 2649
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2650
          xml_data += "\n   <multi_property "\
2651
          "id='%s'>%s</multi_property>" % (property, prop_value)
2652 2653
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2654
    return xml_data
2655

2656 2657 2658 2659 2660 2661 2662
  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)
2663 2664
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2665 2666 2667 2668
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
2669 2670 2671
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2672 2673
    type_roles_list = []
    xml = parse(file)
2674
    xml_type_roles_list = xml.getElementsByTagName('role')
2675
    for role in xml_type_roles_list:
2676
      id = role.getAttribute('id').encode('utf_8', 'backslashreplace')
2677 2678 2679 2680 2681 2682
      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():
2683
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2684 2685 2686 2687 2688 2689 2690 2691
          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():
2692
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706
          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
2707 2708 2709
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
2710
          # reset roles before applying
2711
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
2712
          type_roles_list = self._objects[roles_path] or []
2713 2714
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
2715 2716 2717

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2718 2719 2720 2721 2722 2723
    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:
2724
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2725 2726 2727 2728 2729
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2730

2731 2732 2733 2734 2735 2736
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2737 2738
      for property in p.propertyMap():
        if property['id'] == id:
2739
          obj = p.getProperty(id)
2740
          prop_type = property['type']
2741 2742
          break
      else:
2743
        obj = None
2744
      if obj is None and not self.is_bt_for_diff:
2745
        raise NotFound, 'the property %s is not found' % id
2746
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2747

2748 2749
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
2750 2751 2752 2753
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2754 2755 2756 2757
    xml = parse(file)
    property_list = xml.getElementsByTagName('property')
    for prop in property_list:
      id = prop.getElementsByTagName('id')[0].childNodes[0].data
2758 2759
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2760 2761 2762 2763 2764 2765 2766
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2767
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2768
      self._objects[str(id)] = (str(prop_type), value)
2769

2770 2771 2772
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2773
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2774 2775
      p = context.getPortalObject()
      for path in self._objects.keys():
2776 2777 2778 2779
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2780
              continue
2781
          dir, id = posixpath.split(path)
2782
          prop_type, property = self._objects[path]
2783 2784 2785 2786 2787 2788 2789 2790
          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
2791
    else:
2792
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2793
      p = context.getPortalObject()
2794
      for id, property in self._archive.keys():
2795
        property = self._archive[id]
Aurel's avatar
Aurel committed
2796
        if p.hasProperty(id):
2797 2798 2799 2800 2801 2802 2803
          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'])
2804 2805 2806

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2807 2808 2809 2810 2811 2812
    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:
2813 2814 2815 2816
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2817
  # Function to generate XML Code Manually
2818
  def generateXml(self, path=None):
2819
    xml_data = ''
2820
    prop_type, obj = self._objects[path]
2821
    xml_data += '\n <property>'
2822 2823
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
2824
    if prop_type in ('lines', 'tokens'):
2825
      xml_data += '\n  <value>'
2826
      for item in obj:
2827
        if item != '':
2828
          xml_data += '\n   <item>%s</item>' % escape(str(item))
2829
      xml_data += '\n  </value>'
2830
    else:
2831
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
2832
    xml_data += '\n </property>'
2833 2834
    return xml_data

Aurel's avatar
Aurel committed
2835 2836 2837 2838 2839
  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)
2840 2841 2842 2843
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2844
      xml_data += self.generateXml(path)
2845
    xml_data += '\n</site_property>'
2846
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2847

2848 2849 2850 2851 2852
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
2853 2854 2855 2856 2857 2858
    for module_id in self._archive.keys():
      module = p.unrestrictedTraverse(module_id)
      mapping = {}
      mapping['id'] = module.getId()
      mapping['title'] = module.getTitle()
      mapping['portal_type'] = module.getPortalType()
2859
      permission_list = []
2860
      mapping['permission_list'] = module.showPermissions()
2861
      mapping['category_list'] = module.getCategoryList()
2862
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2863

Christophe Dumez's avatar
Christophe Dumez committed
2864
  # Function to generate XML Code Manually
2865
  def generateXml(self, path=None):
2866
    mapping = self._objects[path]
2867
    xml_data = ['<module>']
2868
    keys = mapping.keys()
2869 2870
    for key in sorted(keys):
      if key == 'permission_list':
2871
        # separe permission dict into xml
2872
        xml_data.append(' <%s>' % (key, ))
2873
        permission_list = mapping[key]
2874
        for perm in permission_list:
2875
          # the type of the permission defined if we use acquired or not
2876
          if isinstance(perm[1], list):
2877 2878 2879
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
2880
          role_list = list(perm[1])
2881 2882 2883
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
2884
          if (len(role_list) == 0 and ptype == 'list') or \
2885 2886
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
2887
          role_list.sort()
2888 2889
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
2890
          for role in role_list:
2891 2892 2893
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
2894 2895 2896 2897 2898 2899 2900 2901
      elif key == 'category_list':
        category_list = mapping[key]
        if not category_list:
          continue
        xml_data.append(' <%s>' % (key, ))
        for category in category_list:
          xml_data.append('  <category>%s</category>' % (category, ))
        xml_data.append(' </%s>' % (key, ))
2902
      else:
2903
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
2904 2905
    xml_data.append('</module>')
    return '\n'.join(xml_data)
2906

2907
  def export(self, context, bta, **kw):
2908
    if len(self._objects) == 0:
2909 2910 2911
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
2912 2913
    keys = self._objects.keys()
    keys.sort()
2914
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
2915
      # export modules one by one
2916 2917
      xml_data = self.generateXml(path=key)
      bta.addObject(obj=xml_data, name=key, path=path)
2918

2919
  def install(self, context, trashbin, **kw):
2920
    portal = context.getPortalObject()
2921 2922
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2923
    if context.getTemplateFormatVersion() == 1:
2924
      items = self._objects
2925
    else:
2926 2927
      items = self._archive

2928 2929
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
2930 2931
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
2932
        if not force:
2933
          action = update_dict[path]
2934 2935
          if action == 'nothing':
            continue
2936 2937
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
2938
        module = portal._getOb(module_id, None)
2939 2940
        if module is not None:
          module.portal_type = portal_type
2941
        else:
2942
          module = portal.newContent(id=module_id, portal_type=portal_type)
2943
        module.setTitle(str(mapping['title']))
2944 2945
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
2946
          # By default, Manager only without acquire permission
2947 2948
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
2949
          module.manage_permission(name, roles=role_list, acquire=acquire)
2950 2951
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
2952 2953

  def _importFile(self, file_name, file):
2954 2955 2956
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2957
    mapping = {}
2958
    xml = parse(file)
2959 2960 2961
    for key in ('portal_type', 'id', 'title', 'permission_list'):
      elt = xml.getElementsByTagName(key)[0]
      if key == 'permission_list':
2962 2963 2964
        plist = []
        perm_list = elt.getElementsByTagName('permission')
        for perm in perm_list:
2965
          perm_type = perm.getAttribute('type').encode() or None
2966 2967 2968 2969 2970 2971 2972 2973 2974
          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))
2975
          if perm_type == 'list' or perm_type is None:
2976 2977 2978
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2979
          plist.append(perm_tuple)
2980
        mapping[key] = plist
2981 2982 2983
      else:
        node_list = elt.childNodes
        if len(node_list) == 0:
2984
          value = ''
2985 2986
        else:
          value = node_list[0].data
2987
        mapping[key] = str(value)
2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001

    category_list = []
    try:
      elt = xml.getElementsByTagName('category_list')[0]
    except IndexError:
      pass
    else:
      category_element_list = elt.getElementsByTagName('category')
      for category_element in category_element_list:
        category_node = category_element.childNodes[0]
        category = str(category_node.data)
        category_list.append(category)
    mapping['category_list'] = category_list

3002
    self._objects[file_name[:-4]] = mapping
3003

3004
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3005 3006 3007
    trash = kw.get('trash', 0)
    if trash:
      return
3008 3009 3010 3011 3012 3013
    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]
3014 3015
    p = context.getPortalObject()
    id_list = p.objectIds()
3016 3017
    for key in keys:
      if key in id_list:
3018
        try:
3019
          if trash and trashbin is not None:
3020 3021 3022
            container_path = key.split('/')
            self.portal_trash.backupObject(trashbin, container_path, key, save=1, keep_subobjects=1)
          p.manage_delObjects([key])
3023
        except NotFound:
3024
          pass
3025 3026
    BaseTemplateItem.uninstall(self, context, **kw)

3027 3028 3029
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3030 3031

class DocumentTemplateItem(BaseTemplateItem):
3032 3033 3034 3035
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
3036 3037 3038 3039

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

3042
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3043 3044
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3045
      new_keys = self._objects.keys()
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055
      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
3056 3057 3058 3059 3060 3061
      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:
3062 3063
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3064
        else: # new object
3065 3066
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3067 3068 3069 3070
          # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
3071 3072
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3073 3074 3075 3076 3077
    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
3078
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3079
      for id in self._objects.keys():
3080 3081 3082 3083 3084 3085
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
3086
          path, name = posixpath.split(id)
3087 3088
          # This raises an exception if the file already exists.
          try:
3089
            globals()[self.local_file_writer_name](name, text, create=0)
3090
          except IOError, error:
3091
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
3092 3093
            if error.errno :
              raise
3094 3095 3096
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
3097
    else:
3098 3099 3100
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3101
        # This raises an exception if the file exists.
3102
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
3103 3104
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
3105 3106

  def uninstall(self, context, **kw):
3107
    object_path = kw.get('object_path', None)
3108 3109 3110 3111 3112
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
3113
      globals()[self.local_file_remover_name](id)
3114 3115
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3116 3117 3118 3119 3120 3121
  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():
3122 3123
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
3124

3125
  def _importFile(self, file_name, file):
3126 3127 3128
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3129
    text = file.read()
3130
    self._objects[file_name[:-3]]=text
3131

3132 3133 3134 3135 3136 3137
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

3138 3139 3140 3141 3142
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
3143

3144 3145 3146
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
3147 3148
  # Extension needs no import
  local_file_importer_name = None
3149 3150 3151 3152 3153
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
3154
  # Test needs no import
3155 3156 3157
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
3158

3159 3160 3161
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3162 3163 3164

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3165 3166 3167 3168
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
3169
    if len(role_list) > 0:
3170
      self._objects[self.__class__.__name__+'/'+'role_list'] = role_list
Aurel's avatar
Aurel committed
3171

3172
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3173 3174
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3175
      new_roles = self._objects.keys()
3176
      if installed_bt.id == INSTALLED_BT_FOR_DIFF:
3177 3178
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
3179 3180 3181
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
3182 3183
        for key in old_keys:
          new_dict[key] = ''
3184
        installed_bt._objects = new_dict
3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197
      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):
3198
    p = context.getPortalObject()
3199
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3200
    if context.getTemplateFormatVersion() == 1:
3201
      role_list = self._objects.keys()
3202
    else:
3203
      role_list = self._archive.keys()
3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215
    # 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
3216
    for role in role_list:
3217 3218 3219 3220
      roles[role] = 1
    p.__ac_roles__ = tuple(roles.keys())

  def _importFile(self, file_name, file):
3221 3222 3223 3224
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3225 3226 3227 3228 3229 3230
    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
3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242

  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)

3243 3244 3245 3246 3247 3248 3249 3250 3251
  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
3252
      if role in roles and role not in new_roles:
3253 3254 3255
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

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

Aurel's avatar
Aurel committed
3266 3267 3268 3269 3270 3271
  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():
3272
      xml_data = self.generateXml(path=path)
3273
      bta.addObject(obj=xml_data, name=path, path=None,)
3274

3275 3276
class CatalogResultKeyTemplateItem(BaseTemplateItem):

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

  def _importFile(self, file_name, file):
3293 3294 3295
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3296 3297 3298 3299 3300 3301 3302 3303 3304
    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

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

3311
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3312
    if context.getTemplateFormatVersion() == 1:
3313 3314
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3315 3316 3317
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3318
    else:
3319
      keys = self._archive.keys()
3320 3321
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3322
    # XXX same as related key
Aurel's avatar
Aurel committed
3323
    if update_dict.has_key('result_key_list') or force:
3324
      if not force:
Aurel's avatar
Aurel committed
3325
        action = update_dict['result_key_list']
3326
        if action == 'nothing':
Aurel's avatar
Aurel committed
3327
          return
3328
      for key in keys:
3329 3330
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
3331
      catalog.sql_search_result_keys = sql_search_result_keys
3332

3333
  def uninstall(self, context, **kw):
3334
    catalog = _getCatalogValue(self)
3335 3336 3337 3338
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_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
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
3347
    catalog.sql_search_result_keys = sql_search_result_keys
3348 3349
    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
  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)
3365
    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 CatalogRelatedKeyTemplateItem(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_related_keys = list(catalog.sql_catalog_related_keys)
3377
    key_list = []
3378
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3379
      if key in sql_search_related_keys:
3380
        key_list.append(key)
3381
      elif not self.is_bt_for_diff:
3382
        raise NotFound, 'Related key "%r" not found in catalog' %(key,)
3383
    if len(key_list) > 0:
3384
      self._objects[self.__class__.__name__+'/'+'related_key_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 3398
    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

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_catalog_related_keys = list(catalog.sql_catalog_related_keys)
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')
Aurel's avatar
Aurel committed
3416
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
3417
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3418
      if not force:
Aurel's avatar
Aurel committed
3419 3420 3421 3422
        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
3423 3424 3425
        if action == 'nothing':
          return
      for key in keys:
3426 3427
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
3428
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
3429

3430
  def uninstall(self, context, **kw):
3431
    catalog = _getCatalogValue(self)
3432 3433 3434
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3435
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
3436
    object_path = kw.get('object_path', None)
3437 3438 3439 3440 3441
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3442 3443 3444 3445 3446
      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
3447
  # Function to generate XML Code Manually
3448
  def generateXml(self, path=None):
3449
    obj = self._objects[path]
3450
    xml_data = '<key_list>'
3451 3452
    obj.sort()
    for key in obj:
3453 3454
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3455 3456
    return xml_data

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

3466 3467
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3468
  def build(self, context, **kw):
3469
    catalog = _getCatalogValue(self)
3470 3471 3472
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3473
    sql_search_result_tables = list(catalog.sql_search_tables)
3474
    key_list = []
3475
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3476
      if key in sql_search_result_tables:
3477
        key_list.append(key)
3478
      elif not self.is_bt_for_diff:
3479
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
3480
    if len(key_list) > 0:
3481
      self._objects[self.__class__.__name__+'/'+'result_table_list'] = key_list
3482 3483

  def _importFile(self, file_name, file):
3484 3485 3486
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3487 3488 3489 3490 3491 3492 3493 3494
    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
3495

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

3502
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3503
    if context.getTemplateFormatVersion() == 1:
3504
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3505
        return
3506 3507 3508
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3509
    else:
3510
      keys = self._archive.keys()
3511 3512
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3513
    # XXX same as related keys
Aurel's avatar
Aurel committed
3514
    if update_dict.has_key('result_table_list') or force:
3515
      if not force:
Aurel's avatar
Aurel committed
3516
        action = update_dict['result_table_list']
3517
        if action == 'nothing':
Aurel's avatar
Aurel committed
3518
          return
3519
      for key in keys:
3520 3521
        if key not in sql_search_tables:
          sql_search_tables.append(key)
3522
      catalog.sql_search_tables = tuple(sql_search_tables)
3523 3524

  def uninstall(self, context, **kw):
3525
    catalog = _getCatalogValue(self)
3526 3527 3528 3529
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
3530
    object_path = kw.get('object_path', None)
3531 3532 3533 3534 3535
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3536 3537
      if key in sql_search_tables:
        sql_search_tables.remove(key)
3538
    catalog.sql_search_tables = sql_search_tables
3539 3540
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3541
  # Function to generate XML Code Manually
3542
  def generateXml(self, path=None):
3543
    obj = self._objects[path]
3544
    xml_data = '<key_list>'
3545 3546
    obj.sort()
    for key in obj:
3547 3548
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3549 3550
    return xml_data

Aurel's avatar
Aurel committed
3551 3552 3553 3554 3555 3556
  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():
3557
      xml_data = self.generateXml(path=path)
3558
      bta.addObject(obj=xml_data, name=path, path=None)
3559

3560 3561
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3562 3563

  def build(self, context, **kw):
3564
    catalog = _getCatalogValue(self)
3565 3566 3567 3568 3569 3570 3571 3572
    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)
3573
      elif not self.is_bt_for_diff:
3574
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3575
    if len(key_list) > 0:
3576
      self._objects[self.__class__.__name__+'/'+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3577

3578
  def _importFile(self, file_name, file):
3579 3580 3581
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3582 3583 3584 3585 3586 3587 3588 3589
    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
3590 3591

  def install(self, context, trashbin, **kw):
3592
    catalog = _getCatalogValue(self)
3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605
    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()
3606 3607
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619
    # 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):
3620
    catalog = _getCatalogValue(self)
3621 3622 3623 3624
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3625
    object_path = kw.get('object_path', None)
3626 3627
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3628
    else:
3629 3630 3631 3632 3633 3634 3635
      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
3636
  # Function to generate XML Code Manually
3637 3638 3639 3640 3641
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3642 3643
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3644
    return xml_data
Aurel's avatar
Aurel committed
3645 3646 3647 3648

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3649 3650 3651 3652 3653
    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)
3654

3655 3656 3657 3658 3659 3660 3661 3662
# 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
3663
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3664 3665 3666 3667
    key_list = []
    for key in self._archive.keys():
      if key in sql_datetime_keys:
        key_list.append(key)
3668
      elif not self.is_bt_for_diff:
3669 3670 3671 3672 3673
        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):
3674 3675 3676
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691
    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

3692
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718
    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
3719
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749
    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)      
      
3750 3751
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3752

3753
  def build(self, context, **kw):
3754
    catalog = _getCatalogValue(self)
3755 3756 3757 3758 3759 3760 3761 3762
    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)
3763
      elif not self.is_bt_for_diff:
3764
        raise NotFound, 'Fulltext key "%r" not found in catalog' %(key,)
3765
    if len(key_list) > 0:
3766
      self._objects[self.__class__.__name__+'/'+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3767

3768
  def _importFile(self, file_name, file):
3769 3770 3771
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3772 3773 3774 3775 3776 3777 3778 3779
    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
3780

3781
  def install(self, context, trashbin, **kw):
3782
    catalog = _getCatalogValue(self)
3783 3784 3785
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3786

3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807
    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
3808

3809
  def uninstall(self, context, **kw):
3810
    catalog = _getCatalogValue(self)
3811 3812 3813 3814
    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)
3815
    object_path = kw.get('object_path', None)
3816 3817 3818 3819 3820 3821 3822 3823 3824 3825
    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
3826
  # Function to generate XML Code Manually
3827 3828 3829 3830 3831
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3832 3833
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849
    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):
3850
    catalog = _getCatalogValue(self)
3851 3852 3853 3854 3855 3856 3857 3858
    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)
3859
      elif not self.is_bt_for_diff:
3860
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
3861
    if len(key_list) > 0:
3862
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
3863 3864

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

  def _importFile(self, file_name, file):
3960 3961 3962
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3963 3964 3965 3966 3967 3968 3969 3970 3971 3972
    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):
3973
    catalog = _getCatalogValue(self)
3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999
    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):
4000
    catalog = _getCatalogValue(self)
4001 4002 4003 4004
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
4005
    object_path = kw.get('object_path', None)
4006 4007 4008 4009 4010 4011 4012 4013 4014 4015
    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
4016
  # Function to generate XML Code Manually
4017 4018 4019 4020 4021
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4022 4023
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038
    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):
4039
    catalog = _getCatalogValue(self)
4040 4041 4042 4043 4044 4045 4046 4047
    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)
4048
      elif not self.is_bt_for_diff:
4049
        raise NotFound, 'Topic key "%r" not found in catalog' %(key,)
4050
    if len(key_list) > 0:
4051
      self._objects[self.__class__.__name__+'/'+'topic_key_list'] = key_list
4052 4053

  def _importFile(self, file_name, file):
4054 4055 4056
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4057 4058 4059 4060 4061 4062 4063 4064 4065 4066
    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):
4067
    catalog = _getCatalogValue(self)
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
    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):
4095
    catalog = _getCatalogValue(self)
4096 4097 4098 4099
    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)
4100
    object_path = kw.get('object_path', None)
4101 4102 4103 4104 4105 4106 4107 4108 4109 4110
    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
4111
  # Function to generate XML Code Manually
4112 4113 4114 4115 4116
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4117 4118
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129
    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)

4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141
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)
4142
      elif not self.is_bt_for_diff:
4143 4144 4145 4146 4147
        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):
4148 4149 4150
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
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
    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)

4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237
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)
4238
      elif not self.is_bt_for_diff:
4239 4240 4241 4242 4243
        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):
4244 4245 4246
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
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 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333
    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)
4334
      elif not self.is_bt_for_diff:
4335 4336 4337 4338 4339
        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):
4340 4341 4342
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416
    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)

4417 4418 4419 4420
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4421 4422 4423
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4424
      else: # XXX backward compatibility
4425 4426
        lang = lang_key
        catalog = 'erp5_ui'
4427
      path = posixpath.join(lang, catalog)
4428 4429
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4430 4431 4432
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458

  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:
4459 4460
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
4461
          if not force:
4462
            action = update_dict[key]
4463
            if action == 'nothing':
4464
              continue
4465 4466 4467 4468 4469
          path = key.split('/')
          if len(path) == 1:
            lang = path[0]
            catalog = None
          elif len(path) == 2:
4470 4471 4472 4473 4474
            lang = path[0]
            catalog = path[1]
          else:
            lang = path[-3]
            catalog = path[-2]
4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498

          if catalog is None:
            name = self._objects[key]
            for lang_dict in localizer.get_all_languages():
              if lang_dict['code'] == lang:
                # When the Localizer has the language as a user-defined
                # language, make sure that the name is updated.
                old_name = localizer.get_user_defined_language_name(lang)
                if old_name is not None and old_name != name:
                  localizer._del_user_defined_language(lang)
                  localizer._add_user_defined_language(name, lang)
                break
            else:
              # if the Localizer does not know the language code, it must be
              # defined as a user-defined language.
              localizer._add_user_defined_language(name, lang)
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
            mc = localizer._getOb(catalog)
            if lang not in mc.get_languages():
              mc.manage_addLanguage(lang)
            mc.manage_import(lang, po)
4499 4500
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
4501
      for lang, catalogs in self._archive.iteritems():
4502 4503 4504 4505 4506 4507 4508 4509 4510
        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):
4511
    if len(self._objects) == 0:
4512 4513 4514
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
4515
    for key, obj in self._objects.iteritems():
4516 4517
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
4518 4519 4520 4521 4522 4523 4524 4525
      if '/' in key:
        bta.addObject(obj, os.path.join(path, 'translation'), ext='.po')
      else:
        xml_data = ['<language>']
        xml_data.append(' <code>%s</code>' % (escape(key), ))
        xml_data.append(' <name>%s</name>' % (escape(obj), ))
        xml_data.append('</language>')
        bta.addObject('\n'.join(xml_data), os.path.join(path, 'language'))
4526 4527

  def _importFile(self, file_name, file):
4528 4529
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
4530 4531
      text = file.read()
      self._objects[file_name[:-3]] = text
4532 4533 4534 4535 4536 4537 4538 4539
    elif name == 'language.xml':
      xml = parse(file)
      language_element = xml.getElementsByTagName('language')[0]
      name_element = language_element.getElementsByTagName('name')[0]
      name = str(name_element.childNodes[0].data)
      code_element = language_element.getElementsByTagName('code')[0]
      code = str(code_element.childNodes[0].data)
      self._objects[code] = name
4540

Aurel's avatar
Aurel committed
4541 4542
class LocalRolesTemplateItem(BaseTemplateItem):

4543
  def __init__(self, id_list, **kw):
4544
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4545 4546
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4547 4548 4549
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4550
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4551 4552
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4553
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4554

Christophe Dumez's avatar
Christophe Dumez committed
4555
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4556
  def generateXml(self, path=None):
4557
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4558 4559
    # local roles
    xml_data = '<local_roles_item>'
4560
    xml_data += '\n <local_roles>'
4561
    for key in sorted(local_roles_dict):
4562
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4563 4564
      tuple = local_roles_dict[key]
      for item in tuple:
4565 4566 4567 4568
        xml_data += "\n   <item>%s</item>" %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </local_roles>'
    xml_data += '\n</local_roles_item>'
Aurel's avatar
Aurel committed
4569
    return xml_data
4570

Aurel's avatar
Aurel committed
4571 4572 4573 4574 4575 4576 4577 4578
  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)

4579
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4580
      encode_folders = []
4581
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4582
        if '%' not in folder:
4583
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4584 4585
        else:
          encode_folders.append(folder)
4586
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4587 4588 4589 4590
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
4591 4592 4593
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4594 4595 4596
    xml = parse(file)
    # local roles
    local_roles = xml.getElementsByTagName('local_roles')[0]
4597
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
4598 4599 4600
    local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
4601 4602
      if isinstance(id, unicode):
        id = id.encode('utf-8')
Aurel's avatar
Aurel committed
4603 4604 4605 4606 4607
      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
4608
    self._objects['local_roles/'+file_name[:-4]] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619

  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
4620 4621
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4622
        local_roles_dict = self._objects[roles_path][0]
4623
        setattr(obj, '__ac_local_roles__', local_roles_dict)
Aurel's avatar
Aurel committed
4624 4625 4626 4627 4628 4629 4630

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

4632 4633 4634
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4635
    in part or completely. Each object is separated from its
4636 4637 4638 4639 4640 4641 4642 4643 4644 4645
    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
4646 4647
      - object without optimal actions
      - list of relation between portal type and workflow
4648 4649 4650 4651 4652 4653 4654 4655 4656 4657

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

    - site property definition
      - id
      - type
4658
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4659

4660 4661
    - document/propertysheet/extension/test definition
      - copy of the local file
4662

4663
    - message transalation definition
4664
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4665

4666 4667
    The Business Template properties are exported to the bt folder with
    one property per file
4668

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4669 4670
    Technology:

4671 4672
    - 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
4673

4674
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4675 4676 4677 4678

    Use case:

    - install core ERP5 (the minimum)
4679

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

4682 4683
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4684
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4685 4686 4687 4688 4689
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4690
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4691 4692 4693

    # Declarative security
    security = ClassSecurityInfo()
4694
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4695 4696 4697 4698

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4699
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4700
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4701
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4702
                      , PropertySheet.BusinessTemplate
4703
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4704 4705
                      )

4706 4707 4708 4709 4710 4711
    # 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."""
4712
         , 'icon'           : 'file_icon.gif'
4713 4714 4715 4716 4717 4718 4719 4720 4721
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4722 4723
    # This is a global variable
    # Order is important for installation
4724 4725 4726 4727 4728 4729
    # 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 )
4730 4731 4732
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
4733
      '_constraint_item',
4734 4735 4736 4737
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4738
      '_tool_item',
4739 4740 4741 4742
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4743
      '_portal_type_workflow_chain_item',
4744 4745 4746 4747
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4748 4749
      '_category_item',
      '_module_item',
4750
      '_path_item',
4751
      '_skin_item',
4752
      '_registered_skin_selection_item',
4753
      '_preference_item',
4754
      '_action_item',
4755
      '_portal_type_roles_item',
4756
      '_local_roles_item',
4757
      '_catalog_method_item',
4758 4759 4760
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4761
      '_catalog_keyword_key_item',
4762
      '_catalog_datetime_key_item',
4763 4764 4765 4766
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4767
      '_catalog_scriptable_key_item',
4768 4769
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4770 4771 4772 4773
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4774 4775 4776 4777 4778 4779
      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
4780
        self._baseGetTemplateFormatVersion()
4781

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4782 4783 4784
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4785

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4786
      return 0
4787

4788
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4789 4790 4791 4792 4793 4794 4795
    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".
4796 4797
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4798
          # XXX Not good to access the attribute directly,
4799 4800 4801
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4802

4803 4804
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4805 4806 4807 4808 4809 4810
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4811
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4812 4813 4814 4815 4816 4817 4818 4819
        """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)
4820

4821
    security.declareProtected(Permissions.ManagePortal, 'build')
4822
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4823 4824 4825
      """
        Copy existing portal objects to self
      """
4826
      if no_action: return
4827
        # this is use at import of Business Template to get the status built
4828 4829
      # Make sure that everything is sane.
      self.clean()
4830

4831
      self.updateRevisionNumber()
4832

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4833 4834
      self._setTemplateFormatVersion(1)

4835
      # Store all data
4836 4837
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4838
      self._portal_type_workflow_chain_item = \
4839
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4840 4841 4842 4843
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4844 4845 4846
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4847 4848 4849 4850 4851 4852
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4853
      self._portal_type_roles_item = \
4854
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4855 4856 4857 4858 4859 4860 4861 4862
      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())
4863 4864
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884
      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())
4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896
      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())
4897 4898
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4899 4900
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4901 4902
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4903
               self.getTemplateCatalogKeywordKeyList())
4904 4905 4906
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4907 4908
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4909
               self.getTemplateCatalogFullTextKeyList())
4910 4911
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4912
               self.getTemplateCatalogRequestKeyList())
4913 4914
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4915
               self.getTemplateCatalogMultivalueKeyList())
4916 4917 4918
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4919 4920
      self._local_roles_item = \
          LocalRolesTemplateItem(
4921
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4922 4923 4924
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4925 4926 4927
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4928 4929 4930 4931 4932 4933
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4934

4935 4936
      # Build each part
      for item_name in self._item_name_list:
4937 4938 4939 4940
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4941

4942
    build = WorkflowMethod(build)
4943 4944

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4945
      """
4946
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4947
      """
4948
      return self.portal_templates.publish(self, url, username=username,
4949
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4950

4951
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4952
      """
4953
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4954
      """
4955
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4956

4957 4958 4959 4960 4961
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4962 4963 4964 4965 4966 4967 4968 4969 4970 4971
      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
4972 4973
      return False

4974
    def preinstall(self, check_dependencies=1, **kw):
4975 4976 4977
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4978
      """
4979 4980 4981 4982 4983
      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()
4984

4985 4986
      modified_object_list = {}
      bt_title = self.getTitle()
4987 4988 4989 4990 4991 4992 4993

      #  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)
4994 4995 4996
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4997
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4998

4999
      # if reinstall business template, must compare to object in ZODB
5000
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
5001
      # same if we make a diff and select only one business template
5002
      reinstall = 0
5003 5004
      if installed_bt == self:
        reinstall = 1
5005 5006 5007 5008 5009 5010 5011 5012 5013
        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)
5014

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5015
      new_bt_format = self.getTemplateFormatVersion()
5016 5017 5018 5019 5020 5021
      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:
5022
          item = getattr(self, item_name, None)
5023 5024 5025 5026
          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
5027

5028
      for item_name in self._item_name_list:
5029
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5030
        old_item = getattr(installed_bt, item_name, None)
5031
        if new_item is not None:
5032
          if old_item is not None and hasattr(old_item, '_objects'):
5033
            modified_object = new_item.preinstall(context=self, installed_bt=old_item)
5034 5035 5036 5037 5038 5039 5040
            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:
5041
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5042

5043 5044
      return modified_object_list

5045 5046
    def _install(self, force=1, object_to_update=None, update_translation=0,
                 update_catalog=0, **kw):
5047
      """
Christophe Dumez's avatar
Christophe Dumez committed
5048
        Install a new Business Template, if force, all will be upgraded or installed
5049 5050
        otherwise depends of dict object_to_update
      """
5051 5052 5053 5054
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
5055

5056 5057
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
5058 5059
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5060
        if installed_bt.getTemplateFormatVersion() == 0:
5061
          force = 1
5062
        installed_bt.replace(self)
5063

5064 5065 5066 5067
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

5068 5069 5070
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
5071

5072 5073 5074
      if not force:
        self.checkDependencies()

5075
      site = self.getPortalObject()
5076 5077 5078 5079 5080 5081
      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()
5082 5083 5084
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Activity Tool')
5085
        gen.setupLastTools(site, update=1, create_activities=1)
5086 5087
      if not force:
        if len(object_to_update) == 0:
5088 5089 5090 5091 5092
          # 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():
5093
            LOG('Business Template', 0, 'Updating Business Template Workflows')
5094
            gen.setupWorkflow(site)
5095
          return
5096

5097 5098
      # 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
5099
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
5100 5101 5102 5103 5104
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
5105
      if len(object_to_update) or force:
5106 5107 5108
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
5109
            item.install(self, force=force, object_to_update=object_to_update, trashbin=trashbin, installed_bt=installed_bt)
5110

5111
      # update catalog if necessary
5112 5113
      if force and self.isCatalogUpdatable():
        update_catalog = 1
5114
      if update_catalog:
5115
        catalog = _getCatalogValue(self)
5116
        if (catalog is None) or (not site.isIndexable):
5117 5118 5119 5120 5121
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
5122

5123
      # get objects to remove
5124
      # do remove after because we may need backup object from installation
5125
      remove_object_dict = {}
5126 5127
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
5128
          remove_object_dict[path] = action
5129

5130
      # remove object from old business template
5131
      if len(remove_object_dict):
5132
        # XXX: this code assumes that there is an installed_bt
5133
        for item_name in reversed(installed_bt._item_name_list):
5134
          item = getattr(installed_bt, item_name, None)
5135
          if item is not None:
5136
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
5137

5138 5139 5140 5141 5142 5143

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

5144
      # check if we have to update business template workflow
5145
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
5146
        LOG('Business Template', 0, 'Updating Business Template Workflows')
5147 5148 5149 5150 5151
        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)

5152 5153
      # remove trashbin if empty
      if trashbin is not None:
5154
        if len(trashbin) == 0:
5155 5156
          trash_tool.manage_delObjects([trashbin.getId(),])

5157 5158
      if update_catalog:
        site.ERP5Site_reindexAll()
5159

5160 5161
      # Update translation table, in case we added new portal types or
      # workflow states.
5162 5163
      if update_translation:
        site.ERP5Site_updateTranslationTable()
5164

5165 5166
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
5167

5168
    security.declareProtected(Permissions.ManagePortal, 'install')
5169 5170 5171
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
5172
      """
5173
      return self._install(**kw)
5174

5175
    install = WorkflowMethod(install)
5176

5177
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
5178
    def reinstall(self, **kw):
5179 5180 5181 5182
      """Reinstall Business Template.
      """
      return self._install(**kw)

5183
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5184

5185
    security.declareProtected(Permissions.ManagePortal, 'trash')
5186 5187
    def trash(self, new_bt, **kw):
      """
5188
        Trash unnecessary items before upgrading to a new business
5189
        template.
5190
        This is similar to uninstall, but different in that this does
5191
        not remove all items.
5192
      """
5193 5194
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5195
        item = getattr(self, item_name, None)
5196 5197
        if item is not None:
          item.trash(
5198
                self,
5199
                getattr(new_bt, item_name))
5200

5201
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
5202
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5203
      """
5204
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5205
      """
5206 5207 5208
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5209
        item = getattr(self, item_name, None)
5210
        if item is not None:
5211
          item.uninstall(self)
5212
      # It is better to clear cache because the uninstallation of a
5213
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
5214
      self.getPortalObject().portal_caches.clearAllCache()
5215

5216 5217
    uninstall = WorkflowMethod(uninstall)

5218
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5219
    def _clean(self):
5220
      """
5221
        Clean built information.
5222
      """
5223
      # First, remove obsolete attributes if present.
5224 5225 5226 5227
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
5228
                    '_module_archive',
5229 5230 5231
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
5232
                    '_property_sheet_archive'):
5233 5234 5235
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
5236 5237
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
5238

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

5241
    security.declareProtected(Permissions.AccessContentsInformation,
5242
                              'getBuildingState')
5243
    def getBuildingState(self, default=None, id_only=1):
5244
      """
5245
        Returns the current state in building
5246
      """
5247
      portal_workflow = getToolByName(self, 'portal_workflow')
5248 5249
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
5250
      return wf._getWorkflowStateOf(self, id_only=id_only )
5251

5252
    security.declareProtected(Permissions.AccessContentsInformation,
5253
                              'getInstallationState')
5254
    def getInstallationState(self, default=None, id_only=1):
5255
      """
5256
        Returns the current state in installation
5257
      """
5258
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
5259 5260
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
5261
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5262

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5263 5264 5265 5266 5267 5268
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
5269
      export_string = portal_templates.manage_exportObject(
5270 5271
                                               id=self.getId(),
                                               toxml=1,
5272
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5273
      return export_string
5274

5275
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5276
      """
5277 5278
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5279
      """
5280 5281
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
5282 5283 5284 5285
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
5286
        # XXX Why do we need to return a tuple ?
5287 5288
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5289

5290
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5291
      """
5292 5293
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5294
      """
5295
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5296

5297
    def getTemplateBaseCategoryList(self):
5298
      """
5299 5300
      We have to set this method because we want an
      ordered list
5301
      """
5302
      return self._getOrderedList('template_base_category')
5303

5304
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5305
      """
5306 5307
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5308
      """
5309
      return self._getOrderedList('template_workflow_id')
5310

5311
    def getTemplatePortalTypeIdList(self):
5312
      """
5313 5314
      We have to set this method because we want an
      ordered list
5315
      """
5316
      return self._getOrderedList('template_portal_type_id')
5317

5318 5319 5320 5321 5322 5323 5324
    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
5325 5326 5327 5328 5329 5330 5331
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

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

5339 5340 5341 5342 5343 5344
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
5345

5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366
    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')

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

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

5381
    def getTemplateLocalRoleList(self):
5382 5383 5384 5385
      """
      We have to set this method because we want an
      ordered list
      """
5386
      return self._getOrderedList('template_local_role')
5387

5388
    def getTemplateSkinIdList(self):
5389
      """
5390 5391
      We have to set this method because we want an
      ordered list
5392
      """
5393
      return self._getOrderedList('template_skin_id')
5394

5395 5396 5397 5398 5399 5400 5401
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

5402
    def getTemplateModuleIdList(self):
5403
      """
5404 5405
      We have to set this method because we want an
      ordered list
5406
      """
5407
      return self._getOrderedList('template_module_id')
5408 5409 5410 5411 5412 5413 5414

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5416 5417 5418 5419 5420 5421 5422
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5423
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5424 5425 5426 5427
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5428
      if self.getBuildingState() != 'built':
5429
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5430
              'Business Template must be built before export'
5431

Aurel's avatar
Aurel committed
5432 5433 5434 5435 5436 5437 5438
      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)

5439
      # export bt
5440
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
5441
      for prop in self.propertyMap():
5442
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5443
        id = prop['id']
5444
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5445
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5446
          continue
Aurel's avatar
Aurel committed
5447
        value = self.getProperty(id)
5448
        if prop_type in ('text', 'string', 'int', 'boolean'):
5449
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
5450
        elif prop_type in ('lines', 'tokens'):
5451
          bta.addObject(obj=str('\n').join(value), name=id,
5452
                        path=path+os.sep+'bt', ext='')
5453

Aurel's avatar
Aurel committed
5454 5455 5456
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5457

Aurel's avatar
Aurel committed
5458 5459
      return bta.finishCreation()

5460
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5461 5462
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5463
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5464 5465 5466 5467 5468 5469 5470
      """
      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())
5471
      self._portal_type_workflow_chain_item = \
5472
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
5473 5474 5475 5476
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
5477 5478 5479
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
Aurel's avatar
Aurel committed
5480 5481 5482 5483 5484 5485
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
5486 5487
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
5488 5489 5490 5491 5492 5493 5494 5495
      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())
5496 5497
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519
      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())
5520 5521
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535
      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(
5536
               self.getTemplateCatalogKeywordKeyList())
5537 5538 5539
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
5540 5541
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
5542
               self.getTemplateCatalogFullTextKeyList())
5543 5544
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
5545
               self.getTemplateCatalogRequestKeyList())
5546 5547
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
5548
               self.getTemplateCatalogMultivalueKeyList())
5549 5550 5551
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
5552 5553
      self._local_roles_item = \
          LocalRolesTemplateItem(
5554
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5555 5556 5557
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
5558 5559 5560
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
5561 5562 5563 5564 5565 5566
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
5567

5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580
      # 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
5581 5582
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5583

5584 5585 5586 5587 5588
      # 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]

5589 5590 5591 5592 5593
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5594 5595 5596
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5597
      return items_list
5598

5599 5600 5601 5602 5603 5604 5605 5606 5607 5608
    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:
5609
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5610
          dependency = dependency_couple_list[0]
5611 5612
          if dependency in (None, ''):
            continue
5613 5614
          version_restriction = None
          if len(dependency_couple_list) > 1:
5615
            version_restriction = dependency_couple_list[1]
5616 5617 5618
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5619 5620 5621
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5622
                  or (version_restriction not in (None, '') and
5623 5624 5625 5626
                     (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)
5627

Aurel's avatar
Aurel committed
5628
    def diffObject(self, REQUEST, **kw):
5629 5630
      """
        Make a diff between an object in the Business Template
5631
        and the same in the Business Template installed in the site
5632 5633 5634 5635
      """

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

5676 5677
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5678

Christophe Dumez's avatar
Christophe Dumez committed
5679
      # Get objects
5680
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5681

Aurel's avatar
Aurel committed
5682
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
5683
      # Compare with a given business template
5684
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5685 5686
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5687 5688
        if bt2_id == self.getId():
          compare_to_zodb = 1
5689
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5690 5691
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5692 5693 5694
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5695 5696
          compare_to_zodb = 1
      if compare_to_zodb:
5697
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5698
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5699 5700 5701
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5702

5703 5704
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5705
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5706
        # XXX maybe only build for the given object to gain time
5707
        installed_item.build(self)
5708 5709 5710
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5711

Christophe Dumez's avatar
Christophe Dumez committed
5712
      # Real Zope Objects (can be exported into XML directly by Zope)
5713 5714
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5715
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5716
                     '_skin_item', '_action_item', '_tool_item', ]
5717

Christophe Dumez's avatar
Christophe Dumez committed
5718
      # Not considered as objects by Zope (will be exported into XML manually)
5719
      # XXX Bad naming
5720
      item_list_2 = ['_site_property_item', '_module_item',
5721
                     '_catalog_result_key_item', '_catalog_related_key_item',
5722 5723
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
5724
                     '_catalog_datetime_key_item',
5725 5726 5727 5728
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5729
                     '_catalog_scriptable_key_item',
5730 5731
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5732 5733 5734 5735 5736 5737
                     '_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',
5738
                     '_portal_type_workflow_chain_item',]
5739

Christophe Dumez's avatar
Christophe Dumez committed
5740
      # Text objects (no need to export them into XML)
5741
      # XXX Bad naming
5742 5743
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5744
                     '_test_item', '_message_translation_item',]
5745

5746
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5747 5748 5749
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5750 5751
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
5752
        # XML Export in memory
5753 5754 5755
        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()
5756
        f1.close()
5757 5758 5759 5760
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5761
        # End of XML export
5762

5763
        # Diff between XML objects
5764 5765
        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
5766
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5767 5768 5769
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5770

5771
      elif item_name in item_list_2:
5772
        # Generate XML code manually
5773 5774
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5775 5776
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5777
        # End of XML Code Generation
5778

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

5787
      elif item_name in item_list_3:
5788
        # Diff between text objects
5789 5790 5791 5792
        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
5793
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5794 5795
          diff_msg += '\n'.join(diff_list)
        else:
5796
          diff_msg = 'No diff'
5797

5798
      else:
5799
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5800

5801
      if compare_to_zodb:
5802
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5803

5804
      return diff_msg
5805

5806

5807 5808 5809 5810
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5811 5812
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5813 5814 5815 5816 5817 5818 5819
      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 [])
5820 5821
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5822
      p = self.getPortalObject()
5823
      for id in bt_portal_types_id_list:
5824 5825
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5826
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5827
        if portal_type.getRoleInformationList():
5828 5829
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5830

5831 5832 5833 5834
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5835
        action_list = []
5836 5837 5838 5839 5840 5841 5842
        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'):
5843
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5844 5845
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5846

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

5852
        for h_id in hidden_content_type_list:
5853 5854 5855
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5856

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

5862 5863 5864 5865
        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)
5866

5867 5868 5869 5870
        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)
5871

5872
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5873
                                    if chain != '(Default)']:
5874 5875 5876
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5877

5878 5879 5880 5881
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5882
      bt_action_list.sort()
5883
      bt_wf_chain_list.sort()
5884

5885 5886 5887 5888 5889 5890 5891
      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)
5892 5893 5894 5895 5896 5897 5898 5899 5900
      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:
5901 5902
        raise TemplateConditionError, 'No module defined in business template'

5903 5904 5905 5906 5907 5908 5909 5910
      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:
5911
          return type_list
5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925

        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():
5926
            type_list.update(getChildPortalType(hidden_ptype_id))
5927
        return type_list
5928

5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975
      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

5976 5977 5978
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5979
  setattr(BusinessTemplate, key, None)
5980

5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007
# 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)
6008

6009 6010 6011 6012 6013 6014 6015 6016

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

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