BusinessTemplate.py 225 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.Base import WorkflowMethod, _aq_reset
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
from Products.ERP5Type.Utils import readLocalDocument, \
                                    writeLocalDocument, \
                                    importLocalDocument, \
                                    removeLocalDocument
from Products.ERP5Type.Utils import readLocalPropertySheet, \
                                    writeLocalPropertySheet, \
                                    importLocalPropertySheet, \
                                    removeLocalPropertySheet
from Products.ERP5Type.Utils import readLocalConstraint, \
                                    writeLocalConstraint, \
                                    importLocalConstraint, \
                                    removeLocalConstraint
from Products.ERP5Type.Utils import readLocalExtension, \
                                    writeLocalExtension, \
                                    removeLocalExtension
from Products.ERP5Type.Utils import readLocalTest, \
                                    writeLocalTest, \
                                    removeLocalTest
55
from Products.ERP5Type.Utils import convertToUpperCase
56
from Products.ERP5Type import Permissions, PropertySheet
Jean-Paul Smets's avatar
Jean-Paul Smets committed
57
from Products.ERP5Type.XMLObject import XMLObject
Aurel's avatar
Aurel committed
58
from OFS.Traversable import NotFound
59
from OFS import SimpleItem, XMLExportImport
60
from cStringIO import StringIO
Aurel's avatar
Aurel committed
61
from copy import deepcopy
62
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
63 64 65 66
import OFS.XMLExportImport
customImporters={
    XMLExportImport.magic: XMLExportImport.importXML,
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
67

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

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

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

92 93
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'

94 95 96 97 98 99
def _getCatalog(acquisition_context):
  """
    Return the id of the SQLCatalog which correspond to the current BT.
  """
  catalog_method_id_list = acquisition_context.getTemplateCatalogMethodIdList()
  if len(catalog_method_id_list) == 0:
100 101 102 103
    try:
      return acquisition_context.getPortalObject().portal_catalog.objectIds('SQLCatalog')[0]
    except IndexError:
      return None
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
  catalog_method_id = catalog_method_id_list[0]
  return catalog_method_id.split('/')[0]

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

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

123 124 125 126 127
def _recursiveRemoveUid(obj):
  """Recusivly set uid to None, to prevent (un)indexing.
  This is used to prevent unindexing real objects when we delete subobjects on
  a copy of this object.
  """
128 129
  if hasattr(aq_base(obj), 'uid'):
    obj.uid = None
130 131 132
  for subobj in obj.objectValues():
    _recursiveRemoveUid(subobj)

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

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
def getChainByType(context):
  """
  This is used in order to construct the full list
  of mapping between type and list of workflow associated
  This is only useful in order to use
  portal_workflow.manage_changeWorkflows
  """
  pw = context.portal_workflow
  cbt = pw._chains_by_type
  ti = pw._listTypeInfo()
  types_info = []
  for t in ti:
    id = t.getId()
    title = t.Title()
    if title == id:
      title = None
    if cbt is not None and cbt.has_key(id):
      chain = ', '.join(cbt[id])
    else:
      chain = '(Default)'
    types_info.append({'id': id,
                      'title': title,
                      'chain': chain})
  new_dict = {}
  for item in types_info:
    new_dict['chain_%s' % item['id']] = item['chain']
  default_chain=', '.join(pw._default_chain)
  return (default_chain, new_dict)

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
def fixZSQLMethod(portal, method):
  """Make sure the ZSQLMethod uses a valid connection.
  """
  if not isinstance(getattr(portal, method.connection_id, None),
                      RDBConnection):
    # if not valid, we assign to the first valid connection found
    sql_connection_list = portal.objectIds(
                          spec=('Z MySQL Database Connection',))
    if (method.connection_id not in sql_connection_list) and \
       (len(sql_connection_list) != 0):
      LOG('BusinessTemplate', WARNING,
          'connection_id for Z SQL Method %s is invalid, using %s' % (
                    method.getId(), sql_connection_list[0]))
      method.connection_id = sql_connection_list[0]

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

  skin_folder_id = skin_folder.getId()

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

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

202 203 204 205 206 207 208 209 210
  for skin_name in skin_selection_list:

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

    selection = skin_tool.getSkinPath(skin_name) or ''
211
    selection_list = selection.split(',')
212
    if (skin_folder_id not in selection_list):
213
      selection_list.insert(0, skin_folder_id)
214 215
    if reorder_skin_selection:
      selection_list.sort(
216 217
        key=lambda x: x in skin_tool.objectIds() and skin_tool[x].getProperty(
        'business_template_skin_layer_priority', skin_tool[x].meta_type == 'Filesystem Directory View' and -1 or 0) or 0, reverse=True)
218
    if (skin_name in skin_layer_list):
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
      skin_tool.manage_skinLayers(skinpath=selection_list,
                                  skinname=skin_name, add_skin=1)
      skin_tool.getPortalObject().changeSkin(None)

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

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

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

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

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

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

Aurel's avatar
Aurel committed
278 279 280
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
281
  """
Aurel's avatar
Aurel committed
282 283 284 285 286 287 288 289 290 291 292 293

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

  def addFolder(self, **kw):
    pass

  def addObject(self, *kw):
    pass
294

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

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

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

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

  def _initImport(self, file=None, path=None, **kw):
337
    # Normalize the paths to eliminate the effect of double-slashes.
338 339 340 341 342 343 344 345
    root_path_len = len(os.path.normpath(path)) + len(os.sep)
    self.root_path_len = root_path_len
    d = {}
    for f in file:
      f = os.path.normpath(f)
      klass = f[root_path_len:].split(os.sep, 1)[0]
      d.setdefault(klass, []).append(f)
    self.file_list_dict = d
Aurel's avatar
Aurel committed
346

347
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
348 349 350
    """
      Import file from a local folder
    """
351
    class_name = item.__class__.__name__
352 353 354 355 356 357 358
    root_path_len = self.root_path_len
    prefix_len = root_path_len + len(class_name) + len(os.sep)
    for file_path in self.file_list_dict.get(class_name, ()):
      if os.path.isfile(file_path):
        file = open(file_path, 'rb')
        try:
          file_name = file_path[prefix_len:]
359
          if '%' in file_name:
360
            file_name = unquote(file_name)
361
          item._importFile(file_name, file)
362
        finally:
363
          file.close()
364

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

499
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
500 501 502 503 504 505
    """
      If 'remove' is chosen on an object containing subobjects, all the
      subobjects will be removed too, even if 'backup' or 'keep' was chosen for
      the subobjects.
      Likewise, for 'save_and_remove' : subobjects will get saved too.
    """
506 507 508
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
509
    keys.reverse()
510 511 512 513 514 515 516 517 518 519 520
    # if you choose remove, the object and all its subobjects will be removed
    # even if you choose backup or keep for subobjects
    # it is same behaviour for backup_and_remove, all we be save
    for path in keys:
      if remove_dict.has_key(path):
        action = remove_dict[path]
        if action == 'save_and_remove':
          # like trash
          self.uninstall(context, trash=1, object_path=path, **kw)
        elif action == 'remove':
          self.uninstall(context, trash=0, object_path=path, **kw)
521 522 523 524
        else:
          # As the list of available actions is not strictly defined,
          # prevent mistake if an action is not handled
          raise ValueError, 'Unknown action "%s"' % action
525

526

527 528 529 530
  def trash(self, context, new_item, **kw):
    # trash is quite similar to uninstall.
    return self.uninstall(context, new_item=new_item, trash=1, **kw)

Aurel's avatar
Aurel committed
531
  def export(self, context, bta, **kw):
532
    pass
Aurel's avatar
Aurel committed
533

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

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

540 541 542
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
543
    """
544 545 546 547 548 549 550 551 552 553 554 555 556 557
    meta_type = getattr(aq_base(obj), 'meta_type', None)

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

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

    if meta_type == 'ERP5 PDF Form':
      if not obj.getProperty('business_template_include_content', 1):
558
        obj.deletePdfContent()
559 560
    elif meta_type == 'Script (Python)':
      obj._code = None
561 562
    return obj

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

568 569 570 571
  def __init__(self, id_list, tool_id=None, **kw):
    BaseTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
    if tool_id is not None:
      id_list = self._archive.keys()
572
      self._archive.clear()
573 574 575
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
576

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

Aurel's avatar
Aurel committed
601
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
602
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
603 604 605
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
606
      relative_url = '/'.join([url,id])
607 608
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
609
      obj = self.removeProperties(obj)
Vincent Pelletier's avatar
Vincent Pelletier committed
610 611 612
      id_list = obj.objectIds() # FIXME duplicated variable name
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
613
        groups = deepcopy(obj.groups)
614
      if id_list:
Aurel's avatar
Aurel committed
615
        self.build_sub_objects(context, id_list, relative_url)
616
        for id_ in list(id_list):
617
          obj._delObject(id_)
618
      if hasattr(aq_base(obj), 'groups'):
619 620 621
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
622 623
    return sub_list

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

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

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

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

737
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
738 739 740
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
741
    subobjects_dict = {}
742
    if trashbin is None: # must return subobjects
743 744 745 746 747 748
      object_path = container_path + [object_id]
      obj = self.unrestrictedTraverse(object_path)
      for subobject_id in list(obj.objectIds()):
        subobject_path = object_path + [subobject_id]
        subobject = self.unrestrictedTraverse(subobject_path)
        subobject_copy = subobject._p_jar.exportFile(subobject._p_oid)
749
        subobjects_dict[subobject_id] = subobject_copy
750
      return subobjects_dict
751 752
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
753
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, **kw)
754
    elif action == 'install':
755
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0, **kw)
756 757 758 759
    else:
      # As the list of available actions is not strictly defined,
      # prevent mistake if an action is not handled
      raise ValueError, 'Unknown action "%s"' % action
760
    return subobjects_dict
761

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

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

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

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

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

1087
        container.manage_delObjects([object_id])
1088 1089
        if container.aq_parent.meta_type == 'ERP5 Catalog' and len(container.objectIds()) == 0:
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1090
          container.getParentValue().manage_delObjects([container.id])
1091
      except (NotFound, KeyError, BadRequest, AttributeError):
1092
        # object is already backup and/or removed
1093
        pass
1094 1095
    BaseTemplateItem.uninstall(self, context, **kw)

1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
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

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

1143 1144 1145
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1146

1147 1148 1149 1150 1151 1152 1153 1154 1155
      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.
1156 1157 1158
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1159
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1160 1161
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1162
      if object_id != "":
1163
        path_list.extend(self._resolvePath(
1164
            folder._getOb(object_id),
1165
            relative_url_list + [object_id], id_list[1:]))
1166
    return path_list
Aurel's avatar
Aurel committed
1167

1168 1169 1170
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1171
    keys = self._path_archive.keys()
1172
    keys.sort()
Aurel's avatar
Aurel committed
1173
    for path in keys:
1174 1175 1176
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
1177
      for relative_url in self._resolvePath(p, [], path.split('/')):
1178 1179
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1180
        obj = obj.__of__(context)
1181
        _recursiveRemoveUid(obj)
1182
        id_list = obj.objectIds()
1183
        obj = self.removeProperties(obj)
1184
        if hasattr(aq_base(obj), 'groups'):
1185
          # we must keep groups because it's ereased when we delete subobjects
1186
          groups = deepcopy(obj.groups)
1187
        if len(id_list) > 0:
1188 1189
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1190
          for id_ in list(id_list):
1191
            obj._delObject(id_)
1192
        if hasattr(aq_base(obj), 'groups'):
1193 1194 1195
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1196

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1197 1198 1199 1200 1201 1202 1203 1204
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)

1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
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")
1220
    if len(id_list) != 1:
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
      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():
1233
      pref = portal.unrestrictedTraverse(object_path)
1234
      # XXX getPreferenceState is a bad name
1235 1236 1237
      if pref.getPreferenceState() == 'disabled':
        portal.portal_workflow.doActionFor(
                      pref,
1238 1239 1240 1241
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")

1242 1243
class CategoryTemplateItem(ObjectTemplateItem):

1244 1245
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1246

1247 1248 1249 1250
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1251 1252
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1253
      obj = self.removeProperties(obj)
1254
      id_list = obj.objectIds()
1255
      if id_list:
1256
        self.build_sub_objects(context, id_list, relative_url)
1257
        for id_ in list(id_list):
1258
          obj._delObject(id_)
1259 1260
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1261 1262 1263 1264 1265

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1266 1267
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1268
      _recursiveRemoveUid(obj)
1269
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1270
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1271
      id_list = obj.objectIds()
1272 1273
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1274
        for id_ in list(id_list):
1275
          obj._delObject(id_)
1276
      else:
1277
        for id_ in list(id_list):
1278
          obj._delObject(id_)
1279 1280
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1281

1282 1283 1284 1285 1286 1287 1288 1289
  def beforeInstall(self):
    self._installed_new_category = False

  def onNewObject(self):
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1290 1291
      # reset accessors if we installed a new category
      _aq_reset()
1292

1293 1294
class SkinTemplateItem(ObjectTemplateItem):

1295 1296
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1297

1298 1299 1300 1301 1302 1303 1304 1305 1306 1307
  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')

1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
  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

1323
  def install(self, context, trashbin, **kw):
1324
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1325 1326
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1327
    p = context.getPortalObject()
1328
    skin_tool = p.portal_skins
1329 1330
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1331
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1332 1333
        fixZSQLMethod(p, obj)

1334
      # Do not register skin which were explicitely ask not to be installed
1335 1336 1337 1338 1339
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
      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]
1361
      else:
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 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
        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:
1407
          create_property = True
1408 1409
          selection_string = self._objects[skin_folder_id].replace(',', ' ')
        else:
1410 1411 1412
          create_property = False
          if not isinstance(selection_string, basestring):
            selection_string = ' '.join(selection_string)
1413 1414 1415 1416 1417 1418
          selection_string += ' %s' % \
            self._objects[skin_folder_id].replace(',', ' ')

        # Remove duplicate
        selection_string = \
            ' '.join(dict([(x, 0) for x in selection_string.split(' ')]).keys())
1419 1420 1421 1422 1423 1424 1425 1426
        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(' '))
1427 1428 1429 1430 1431

        selection_list = selection_string.split(' ')
        unregisterSkinFolder(skin_tool, skin_folder,
            skin_tool.getSkinSelections())
        registerSkinFolder(skin_tool, skin_folder)
1432 1433

  def uninstall(self, context, **kw):
1434 1435 1436
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1437 1438 1439 1440
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
      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:
1456
        skin_folder._updateProperty(
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 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
            '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
1512 1513


1514
class WorkflowTemplateItem(ObjectTemplateItem):
1515

1516 1517
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1518

1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
  # 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:
1531
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1532 1533 1534 1535
      else:
        modified_workflow_dict[modified_object] = state
    return modified_workflow_dict

1536
  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1537
    if context.getTemplateFormatVersion() == 1:
1538 1539 1540
      portal = context.getPortalObject()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
Julien Muchembled's avatar
Julien Muchembled committed
1541 1542 1543
      # sort to add objects before their subobjects
      for path in sorted(self._objects):
          if force:
1544
            action = 'backup'
Julien Muchembled's avatar
Julien Muchembled committed
1545
          else:
1546
            action = update_dict.get('/'.join(path.split('/')[:2]))
Julien Muchembled's avatar
Julien Muchembled committed
1547 1548
            if action in (None, 'nothing'):
              continue
1549 1550 1551 1552 1553 1554
          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
1555
            container_url = '/'.join(container_path)
1556 1557 1558 1559 1560 1561
            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
1562
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1563
            container.manage_delObjects([object_id])
1564
          obj = self._objects[path]
1565 1566 1567
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1568 1569 1570 1571 1572
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1573 1574 1575 1576
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1577 1578
class PortalTypeTemplateItem(ObjectTemplateItem):

1579 1580
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1581 1582
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1583 1584 1585
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1586 1587
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1588 1589
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1590 1591
      # obj is in ghost state and an attribute must be accessed
      # so that obj.__dict__ does not return an empty dict
1592
      obj.meta_type
1593
      for attr in obj.__dict__.keys():
1594 1595 1596 1597 1598 1599 1600 1601
        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)
1602 1603
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1604

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

1636 1637
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1638 1639 1640 1641 1642 1643 1644
  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:
1645
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1646 1647 1648 1649 1650
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1651
        dict[str(ptype)] = str(workflow)
1652 1653 1654 1655
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1656
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1657 1658

  def build(self, context, **kw):
1659 1660 1661 1662 1663
    # 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
1664
    p = context.getPortalObject()
1665
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1666
    for key in self._archive.keys():
1667 1668 1669
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1670
        workflow = wflist[1]
1671
      else:
1672
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1673
        portal_type = wflist[0][:-2]
1674 1675
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1676 1677 1678 1679
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
1680
        if workflow[0] != '-' and \
1681
            workflow_name not in chain_dict['chain_%s' % portal_type].split(', '):
1682
          if not self.is_bt_for_diff:
1683 1684 1685 1686 1687
            # 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))
1688
        if self._objects.has_key(portal_type):
1689 1690
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1691
        else:
1692
          self._objects[portal_type] = [workflow,]
1693
      elif not self.is_bt_for_diff:
1694
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1695
                        'is probably a sign of a missing dependency.'\
1696
                                                    % portal_type
1697

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

1788 1789
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1790 1791 1792 1793 1794 1795
    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:
1796 1797 1798 1799 1800 1801
      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():
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813
        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
1814
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1815

1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848
  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

1849
  def _importFile(self, file_name, file):
1850 1851 1852 1853
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864
    # 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
1865 1866
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1867 1868 1869
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1870 1871
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1872

1873
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
1874 1875 1876
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
1877 1878
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
1879
  business_template_class_property = '_portal_type_allowed_content_type_item'
1880 1881

  def build(self, context, **kw):
1882 1883
    types_tool = self.getPortalObject().portal_types
    types_list = list(types_tool.objectIds())
1884
    for key in self._archive.keys():
1885 1886 1887 1888
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
1889 1890 1891 1892 1893
      # 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, ())
1894
      if not allowed_type in prop_value and not self.is_bt_for_diff:
Jérome Perrin's avatar
Jérome Perrin committed
1895
        raise ValueError, "%s %s not found in portal type %s" % (
1896 1897 1898
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)

1899 1900 1901 1902 1903 1904 1905
      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
1906
  # Function to generate XML Code Manually
1907
  def generateXml(self, path=None):
1908
    dictio = self._objects
1909
    xml_data = '<%s>' %(self.xml_tag,)
1910
    keys = dictio.keys()
1911 1912
    keys.sort()
    for key in keys:
1913
      allowed_list = sorted(dictio[key])
1914
      xml_data += '\n <portal_type id="%s">' %(key,)
1915
      for allowed_item in allowed_list:
1916 1917 1918
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929
    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)

1930 1931 1932 1933 1934
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
1935 1936 1937 1938
      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:
1939
          new_key = '%s/%s' % (self.class_property, key)
1940
          new_dict[new_key] = installed_bt._objects[key]
1941 1942 1943
        else:
          new_dict[key] = installed_bt._objects[key]
      if len(new_dict):
1944 1945 1946 1947 1948
        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]
1949
          old_object = installed_bt._objects[path]
1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960
          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

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

Aurel's avatar
Aurel committed
2015
  def uninstall(self, context, **kw):
2016
    object_path = kw.get('object_path', None)
2017
    p = context.getPortalObject()
2018
    pt = p.unrestrictedTraverse('portal_types')
2019 2020 2021 2022 2023 2024 2025 2026
    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)
2027
      except (AttributeError,  KeyError):
2028 2029 2030
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
2031 2032
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2033 2034
      for id in property_list:
        if id in original_property_list:
2035
          original_property_list.remove(id)
2036
      setattr(portal_type, self.class_property, tuple(original_property_list))
2037

2038

2039 2040
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2041
  name = 'Hidden Content Type'
2042 2043
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2044
  business_template_class_property = '_portal_type_hidden_content_type_item'
2045

2046

2047 2048
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2049
  name = 'Property Sheet'
2050 2051
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2052
  business_template_class_property = '_portal_type_property_sheet_item'
2053

2054

2055 2056
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2057
  name = 'Base Category'
2058 2059
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2060
  business_template_class_property = '_portal_type_base_category_item'
2061

2062

2063
class CatalogMethodTemplateItem(ObjectTemplateItem):
2064
  """Template Item for catalog methods.
2065

2066 2067 2068 2069 2070
    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.
  """
2071

2072 2073
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2074
    # a mapping to store properties of methods.
2075 2076 2077 2078 2079
    # 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()
2080

2081 2082 2083 2084 2085
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099
  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

2100 2101
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2102

2103
    catalog = _getCatalogValue(self)
2104
    if catalog is None:
2105
      LOG('BusinessTemplate build', 0, 'catalog not found')
2106
      return
2107

2108 2109 2110
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2111

2112 2113
    for obj in self._objects.values():
      method_id = obj.id
2114 2115
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2116
      self._is_filtered_archive[method_id] = 0
2117
      if catalog.filter_dict.has_key(method_id):
2118 2119 2120 2121 2122 2123 2124 2125 2126
        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']
2127

Aurel's avatar
Aurel committed
2128
  def export(self, context, bta, **kw):
2129
    catalog = _getCatalogValue(self)
2130 2131 2132 2133
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

Aurel's avatar
Aurel committed
2134 2135 2136 2137
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
2138
      obj = self._objects[key]
Aurel's avatar
Aurel committed
2139
      # create folder and subfolders
2140
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
2141 2142 2143 2144
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
2145 2146
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
2147
      # add all datas specific to catalog inside one file
2148
      method_id = obj.id
2149 2150
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

2151
      f = open(object_path, 'wb')
2152
      xml_data = '<catalog_method>'
2153

2154
      for method_property, value in self._method_properties[method_id].items():
2155 2156 2157
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2158

Aurel's avatar
Aurel committed
2159
      if catalog.filter_dict.has_key(method_id):
2160
        if catalog.filter_dict[method_id]['filtered']:
2161 2162 2163
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2164 2165 2166 2167
          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'')):
2168 2169 2170
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2171
              elif type(value) in (type(()), type([])):
2172
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2173
                for item in value:
2174 2175 2176
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
      xml_data += '\n</catalog_method>'
2177
      f.write(xml_data)
Aurel's avatar
Aurel committed
2178
      f.close()
2179

Christophe Dumez's avatar
Christophe Dumez committed
2180 2181 2182 2183 2184 2185
  # 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:
2186 2187
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
Christophe Dumez's avatar
Christophe Dumez committed
2188
    return xml_data
2189

2190 2191
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2192
    catalog = _getCatalogValue(self)
2193 2194 2195 2196 2197 2198 2199
    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)
2200

2201 2202 2203
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2204
    new_bt_format = context.getTemplateFormatVersion()
2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220

    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':
2221
              continue
2222 2223 2224 2225
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2226

2227 2228
    for obj in values:
      method_id = obj.id
2229

2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240
      # 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))
2241

2242 2243
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2244
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2245
        if context.getTemplateFormatVersion() == 1:
2246 2247 2248
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2249
        filter_type = self._filter_type_archive[method_id]
2250 2251 2252
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2253
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2254
        catalog.filter_dict[method_id]['type'] = filter_type
2255
      elif method_id in catalog.filter_dict.keys():
2256
        catalog.filter_dict[method_id]['filtered'] = 0
2257

2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283
      # 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)
2284

2285 2286 2287 2288 2289 2290
        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)
2291

2292
  def uninstall(self, context, **kw):
2293
    catalog = _getCatalogValue(self)
2294 2295 2296
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2297

2298 2299 2300 2301
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2302 2303 2304 2305
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2306
    else:
2307 2308 2309 2310
      try:
        value = self._archive[object_path]
      except KeyError:
        value = None
2311 2312
      if value is not None:
        values.append(value)
2313
    for obj in values:
2314
      method_id = obj.id
2315 2316 2317 2318 2319 2320 2321 2322 2323
      # 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)
2324

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2325
      if catalog.filter_dict.has_key(method_id):
2326
        del catalog.filter_dict[method_id]
2327

2328
    # uninstall objects
2329
    ObjectTemplateItem.uninstall(self, context, **kw)
2330

2331
  def _importFile(self, file_name, file):
2332
    if file_name.endswith('.catalog_keys.xml'):
2333
      # recreate data mapping specific to catalog method
2334 2335
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2336
      xml = parse(file)
2337
      method_list = xml.getElementsByTagName('item')
2338
      for method in method_list:
2339
        key = method.getAttribute('key')
2340 2341
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
2342 2343 2344 2345
          if len(method.getElementsByTagName('value')[0].childNodes):
            value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          else:
            value = ''
2346
          key = str(key)
2347
        elif key_type == "int":
2348
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
2349
          key = str(key)
2350
        elif key_type == "tuple":
2351 2352 2353 2354
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
2355
        else:
2356
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2357
          continue
2358
        if key in catalog_method_list or key in catalog_method_filter_list:
2359
          dict = getattr(self, key, {})
2360
          dict[id] = value
2361 2362 2363
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375
    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, ))
2376

2377
class ActionTemplateItem(ObjectTemplateItem):
2378 2379

  def __init__(self, id_list, **kw):
2380
    # XXX It's look like ObjectTemplateItem __init__
2381 2382 2383 2384 2385 2386
    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

2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407
  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

2408 2409 2410 2411
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2412 2413 2414
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
Julien Muchembled's avatar
Julien Muchembled committed
2415
      # Several tools still use CMF actions
2416
      is_new_action = obj.getParentId() == 'portal_types'
2417
      id_id = is_new_action and 'reference' or 'id'
2418 2419
      for action in (is_new_action and obj.getActionInformationList
                                    or obj.listActions)():
2420
        if getattr(action, id_id, None) == value:
2421
          break
2422
      else:
2423 2424 2425 2426 2427 2428 2429
        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)
2430
      key = posixpath.join(url[-2], url[-1], value)
2431
      self._objects[key] = self.removeProperties(action)
2432
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2433

2434 2435 2436
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2437
    if context.getTemplateFormatVersion() == 1:
2438
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2439 2440
      p = context.getPortalObject()
      for id in self._objects.keys():
2441 2442 2443 2444 2445
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2446 2447 2448
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2449

2450
          if container.getParentId() == 'portal_types':
2451 2452 2453
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2454 2455
            continue

Julien Muchembled's avatar
Julien Muchembled committed
2456 2457
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473
          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
2474
          obj, action = container, obj
2475
          action_list = obj.listActions()
2476
          for index in range(len(action_list)):
2477
            if action_list[index].id == id:
2478
              # remove previous action
2479
              obj.deleteActions(selections=(index,))
2480 2481 2482
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2483
          obj.addAction(
2484 2485
                        id = action.id
                      , name = action.title
2486
                      , action = action_text
2487 2488 2489 2490
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2491 2492
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2493
                      , priority = action.priority
2494
                      , description = action.description
Aurel's avatar
Aurel committed
2495
                    )
2496
          # sort action based on the priority define on it
2497 2498 2499 2500 2501 2502 2503 2504 2505
          # 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))
2506 2507
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2508
        container.manage_delObjects([obj.id
2509
          for obj in container.getActionInformationList()
2510
          if obj.getReference() in action_dict])
2511 2512
        for obj in action_dict.itervalues():
          container._importOldAction(obj)
Aurel's avatar
Aurel committed
2513
    else:
2514
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2515
      p = context.getPortalObject()
2516 2517
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2518
        relative_url, key, value = self._splitPath(id)
2519 2520
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2521
          if getattr(ai, key) == value:
2522
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2523 2524 2525
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2526
        obj.addAction(
Aurel's avatar
Aurel committed
2527 2528
                      id = action.id
                    , name = action.title
2529
                    , action = action_text
Aurel's avatar
Aurel committed
2530 2531 2532 2533
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2534 2535
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2536
                    )
Aurel's avatar
Aurel committed
2537 2538 2539 2540 2541 2542 2543
        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))
2544 2545
          obj.moveDownActions(selections=tuple(move_down_list))

2546 2547
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2548 2549
    object_path = kw.get("object_path", None)
    if object_path is not None:
2550 2551 2552 2553 2554 2555 2556 2557
      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]
2558
    else:
2559
      keys = self._archive.keys()
2560
    for id in keys:
2561 2562
      if  '|' in id:
        relative_url, value = id.split(' | ')
2563 2564 2565 2566 2567
        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'
2568
      else:
2569
        relative_url, key, value = self._splitPath(id)
2570
        obj = p.unrestrictedTraverse(relative_url, None)
2571 2572 2573
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2574
          if getattr(action_list[index], key, None) == value:
2575 2576
            obj.deleteActions(selections=(index,))
            break
2577 2578
      LOG('BusinessTemplate', 100,
          'unable to uninstall action at %s, ignoring' % relative_url )
2579 2580
    BaseTemplateItem.uninstall(self, context, **kw)

2581 2582 2583
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2584
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2585 2586 2587 2588 2589 2590 2591
    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])
2592
      self._objects[relative_url] = type_role_list = []
2593
      for role in obj.getRoleInformationList():
2594
        type_role_dict = {}
2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611
        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
2612
        type_role_list.append(type_role_dict)
2613
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2614

Christophe Dumez's avatar
Christophe Dumez committed
2615
  # Function to generate XML Code Manually
2616 2617 2618 2619
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2620
      xml_data += "\n  <role id='%s'>" % role['id']
2621
      # uniq
2622
      for property in ('title', 'description', 'condition',
2623 2624 2625
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2626 2627
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2628
          xml_data += "\n   <property id='%s'>%s</property>" % \
2629 2630 2631
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2632
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2633 2634
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2635
          xml_data += "\n   <multi_property "\
2636
          "id='%s'>%s</multi_property>" % (property, prop_value)
2637 2638
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2639
    return xml_data
2640

2641 2642 2643 2644 2645 2646 2647
  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)
2648 2649
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2650 2651 2652 2653
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
2654 2655 2656
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2657 2658
    type_roles_list = []
    xml = parse(file)
2659
    xml_type_roles_list = xml.getElementsByTagName('role')
2660
    for role in xml_type_roles_list:
2661
      id = role.getAttribute('id').encode('utf_8', 'backslashreplace')
2662 2663 2664 2665 2666 2667
      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():
2668
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2669 2670 2671 2672 2673 2674 2675 2676
          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():
2677
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691
          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
2692 2693 2694
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
2695
          # reset roles before applying
2696
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
2697
          type_roles_list = self._objects[roles_path] or []
2698 2699
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
2700 2701 2702

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2703 2704 2705 2706 2707 2708
    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:
2709
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2710 2711 2712 2713 2714
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
2715

2716 2717 2718 2719 2720 2721
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2722 2723
      for property in p.propertyMap():
        if property['id'] == id:
2724
          obj = p.getProperty(id)
2725
          prop_type = property['type']
2726 2727
          break
      else:
2728
        obj = None
2729
      if obj is None and not self.is_bt_for_diff:
2730
        raise NotFound, 'the property %s is not found' % id
2731
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2732

2733 2734
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
2735 2736 2737 2738
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2739 2740 2741 2742
    xml = parse(file)
    property_list = xml.getElementsByTagName('property')
    for prop in property_list:
      id = prop.getElementsByTagName('id')[0].childNodes[0].data
2743 2744
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2745 2746 2747 2748 2749 2750 2751
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2752
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2753
      self._objects[str(id)] = (str(prop_type), value)
2754

2755 2756 2757
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2758
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2759 2760
      p = context.getPortalObject()
      for path in self._objects.keys():
2761 2762 2763 2764
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2765
              continue
2766
          dir, id = posixpath.split(path)
2767
          prop_type, property = self._objects[path]
2768 2769 2770 2771 2772 2773 2774 2775
          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
2776
    else:
2777
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2778
      p = context.getPortalObject()
2779
      for id, property in self._archive.keys():
2780
        property = self._archive[id]
Aurel's avatar
Aurel committed
2781
        if p.hasProperty(id):
2782 2783 2784 2785 2786 2787 2788
          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'])
2789 2790 2791

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2792 2793 2794 2795 2796 2797
    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:
2798 2799 2800 2801
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2802
  # Function to generate XML Code Manually
2803
  def generateXml(self, path=None):
2804
    xml_data = ''
2805
    prop_type, obj = self._objects[path]
2806
    xml_data += '\n <property>'
2807 2808
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
2809
    if prop_type in ('lines', 'tokens'):
2810
      xml_data += '\n  <value>'
2811
      for item in obj:
2812
        if item != '':
2813
          xml_data += '\n   <item>%s</item>' % escape(str(item))
2814
      xml_data += '\n  </value>'
2815
    else:
2816
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
2817
    xml_data += '\n </property>'
2818 2819
    return xml_data

Aurel's avatar
Aurel committed
2820 2821 2822 2823 2824
  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)
2825 2826 2827 2828
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2829
      xml_data += self.generateXml(path)
2830
    xml_data += '\n</site_property>'
2831
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2832

2833 2834 2835 2836 2837 2838 2839
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
      module = p.unrestrictedTraverse(id)
2840 2841 2842 2843 2844 2845 2846 2847
      dict = {}
      dict['id'] = module.getId()
      dict['title'] = module.getTitle()
      dict['portal_type'] = module.getPortalType()
      permission_list = []
      # use show permission
      dict['permission_list'] = module.showPermissions()
      self._objects[id] = dict
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2848

Christophe Dumez's avatar
Christophe Dumez committed
2849
  # Function to generate XML Code Manually
2850
  def generateXml(self, path=None):
2851 2852
    dict = self._objects[path]
    xml_data = '<module>'
2853 2854 2855 2856
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2857 2858
      if key =='permission_list':
        # separe permission dict into xml
2859
        xml_data += '\n <%s>' %(key,)
2860 2861
        permission_list = dict[key]
        for perm in permission_list:
2862 2863 2864 2865 2866
          # the type of the permission defined if we use acquired or not
          if type(perm[1]) == type([]):
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
2867
          role_list = list(perm[1])
2868 2869 2870 2871 2872 2873
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
          if (not len(role_list) and ptype == 'list') or \
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
2874
          role_list.sort()
2875 2876
          xml_data += "\n  <permission type='%s'>" %(ptype,)
          xml_data += '\n   <name>%s</name>' %(perm[0])
2877
          for role in role_list:
2878 2879 2880
            xml_data += '\n   <role>%s</role>' %(role)
          xml_data += '\n  </permission>'
        xml_data += '\n </%s>' %(key,)
2881
      else:
2882 2883
        xml_data += '\n <%s>%s</%s>' %(key, dict[key], key)
    xml_data += '\n</module>'
2884 2885
    return xml_data

2886 2887 2888 2889 2890
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
2891 2892 2893
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
2894
      # export modules one by one
2895
      xml_data = self.generateXml(path=id)
2896
      bta.addObject(obj=xml_data, name=id, path=path)
2897

2898
  def install(self, context, trashbin, **kw):
2899
    portal = context.getPortalObject()
2900 2901
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2902
    if context.getTemplateFormatVersion() == 1:
2903
      items = self._objects
2904
    else:
2905 2906
      items = self._archive

2907 2908
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
2909 2910 2911 2912 2913 2914 2915
    for id in items.keys():
      if update_dict.has_key(id) or force:
        if not force:
          action = update_dict[id]
          if action == 'nothing':
            continue
        mapping = items[id]
2916
        path, id = posixpath.split(id)
2917 2918
        if id in portal.objectIds():
          module = portal._getOb(id)
2919
          module.portal_type = str(mapping['portal_type'])
2920 2921 2922
        else:
          module = portal.newContent(id=id, portal_type=str(mapping['portal_type']))
        module.setTitle(str(mapping['title']))
2923 2924 2925
        for name in valid_permissions.keys():
          # By default, Manager only without acquire permission
          role_list = dict(mapping['permission_list']).get(name, ('Manager',))
2926
          acquire = (type(role_list) == type([]))
2927
          module.manage_permission(name, roles=role_list, acquire=acquire)
2928 2929

  def _importFile(self, file_name, file):
2930 2931 2932
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2933 2934 2935 2936 2937 2938 2939 2940
    dict = {}
    xml = parse(file)
    for id in ('portal_type', 'id', 'title', 'permission_list'):
      elt = xml.getElementsByTagName(id)[0]
      if id == 'permission_list':
        plist = []
        perm_list = elt.getElementsByTagName('permission')
        for perm in perm_list:
2941
          perm_type = perm.getAttribute('type').encode() or None
2942 2943 2944 2945 2946 2947 2948 2949 2950
          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))
2951 2952 2953 2954
          if perm_type == "list" or perm_type is None:
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965
          plist.append(perm_tuple)
        dict[id] = plist
      else:
        node_list = elt.childNodes
        if len(node_list) == 0:
          value=''
        else:
          value = node_list[0].data
        dict[id] = str(value)
    self._objects[file_name[:-4]] = dict

2966
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2967 2968 2969
    trash = kw.get('trash', 0)
    if trash:
      return
2970 2971 2972 2973 2974 2975
    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]
2976 2977
    p = context.getPortalObject()
    id_list = p.objectIds()
2978
    for id in keys:
2979
      if id in id_list:
2980
        try:
2981
          if trash and trashbin is not None:
2982 2983
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2984
          p.manage_delObjects([id])
2985
        except NotFound:
2986
          pass
2987 2988
    BaseTemplateItem.uninstall(self, context, **kw)

2989 2990 2991
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2992 2993

class DocumentTemplateItem(BaseTemplateItem):
2994 2995 2996 2997
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2998 2999 3000 3001

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

3004
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3005 3006
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3007
      new_keys = self._objects.keys()
3008 3009 3010 3011 3012 3013 3014 3015 3016 3017
      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
3018 3019 3020 3021 3022 3023
      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:
3024 3025
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3026
        else: # new object
3027 3028
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3029 3030 3031 3032
          # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
3033 3034
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3035 3036 3037 3038 3039
    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
3040
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3041
      for id in self._objects.keys():
3042 3043 3044 3045 3046 3047
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
3048
          path, name = posixpath.split(id)
3049 3050
          # This raises an exception if the file already exists.
          try:
3051
            globals()[self.local_file_writer_name](name, text, create=0)
3052
          except IOError, error:
3053
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
3054 3055
            if error.errno :
              raise
3056 3057 3058
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
3059
    else:
3060 3061 3062
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3063
        # This raises an exception if the file exists.
3064
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
3065 3066
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
3067 3068

  def uninstall(self, context, **kw):
3069
    object_path = kw.get('object_path', None)
3070 3071 3072 3073 3074
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
3075
      globals()[self.local_file_remover_name](id)
3076 3077
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3078 3079 3080 3081 3082 3083
  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():
3084 3085
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
3086

3087
  def _importFile(self, file_name, file):
3088 3089 3090
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3091
    text = file.read()
3092
    self._objects[file_name[:-3]]=text
3093

3094 3095 3096 3097 3098 3099
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

3100 3101 3102 3103 3104
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
3105

3106 3107 3108
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
3109 3110
  # Extension needs no import
  local_file_importer_name = None
3111 3112 3113 3114 3115
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
3116
  # Test needs no import
3117 3118 3119
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
3120

3121 3122 3123
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3124 3125 3126

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3127 3128 3129 3130
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
3131
    if len(role_list) > 0:
3132
      self._objects[self.__class__.__name__+'/'+'role_list'] = role_list
Aurel's avatar
Aurel committed
3133

3134
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3135 3136
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3137
      new_roles = self._objects.keys()
3138
      if installed_bt.id == INSTALLED_BT_FOR_DIFF:
3139 3140
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
3141 3142 3143
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
3144 3145
        for key in old_keys:
          new_dict[key] = ''
3146
        installed_bt._objects = new_dict
3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159
      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):
3160
    p = context.getPortalObject()
3161
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3162
    if context.getTemplateFormatVersion() == 1:
3163
      role_list = self._objects.keys()
3164
    else:
3165
      role_list = self._archive.keys()
3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177
    # 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
3178
    for role in role_list:
3179 3180 3181 3182
      roles[role] = 1
    p.__ac_roles__ = tuple(roles.keys())

  def _importFile(self, file_name, file):
3183 3184 3185 3186
    if not file_name.endswith('.xml'):
      if not file_name.endswith('.zexp'):
        LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3187 3188 3189 3190 3191 3192
    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
3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204

  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)

3205 3206 3207 3208 3209 3210 3211 3212 3213
  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
3214
      if role in roles and role not in new_roles:
3215 3216 3217
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3218
  # Function to generate XML Code Manually
3219
  def generateXml(self, path):
3220
    obj = self._objects[path]
3221
    xml_data = '<role_list>'
3222 3223
    obj.sort()
    for role in obj:
3224 3225
      xml_data += '\n <role>%s</role>' %(role)
    xml_data += '\n</role_list>'
3226 3227
    return xml_data

Aurel's avatar
Aurel committed
3228 3229 3230 3231 3232 3233
  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():
3234
      xml_data = self.generateXml(path=path)
3235
      bta.addObject(obj=xml_data, name=path, path=None,)
3236

3237 3238
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3239
  def build(self, context, **kw):
3240
    catalog = _getCatalogValue(self)
3241 3242 3243
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3244
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3245
    key_list = []
3246
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3247
      if key in sql_search_result_keys:
3248
        key_list.append(key)
3249
      elif not self.is_bt_for_diff:
3250
        raise NotFound, 'Result key "%r" not found in catalog' %(key,)
3251
    if len(key_list) > 0:
3252
      self._objects[self.__class__.__name__+'/'+'result_key_list'] = key_list
3253 3254

  def _importFile(self, file_name, file):
3255 3256 3257
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3258 3259 3260 3261 3262 3263 3264 3265 3266
    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

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

3273
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3274
    if context.getTemplateFormatVersion() == 1:
3275 3276
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3277 3278 3279
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3280
    else:
3281
      keys = self._archive.keys()
3282 3283
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3284
    # XXX same as related key
Aurel's avatar
Aurel committed
3285
    if update_dict.has_key('result_key_list') or force:
3286
      if not force:
Aurel's avatar
Aurel committed
3287
        action = update_dict['result_key_list']
3288
        if action == 'nothing':
Aurel's avatar
Aurel committed
3289
          return
3290
      for key in keys:
3291 3292
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
3293
      catalog.sql_search_result_keys = sql_search_result_keys
3294

3295
  def uninstall(self, context, **kw):
3296
    catalog = _getCatalogValue(self)
3297 3298 3299 3300
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
3301
    object_path = kw.get('object_path', None)
3302 3303 3304 3305 3306
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3307 3308
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
3309
    catalog.sql_search_result_keys = sql_search_result_keys
3310 3311
    BaseTemplateItem.uninstall(self, context, **kw)

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

Aurel's avatar
Aurel committed
3322 3323 3324 3325 3326
  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)
3327
    for path in self._objects.keys():
3328
      xml_data = self.generateXml(path=path)
3329
      bta.addObject(obj=xml_data, name=path, path=None)
3330

3331 3332
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

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

  def _importFile(self, file_name, file):
3349 3350 3351
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3352 3353 3354 3355 3356 3357 3358 3359 3360
    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

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

3367
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3368
    if context.getTemplateFormatVersion() == 1:
3369
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3370
        return
3371 3372 3373
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3374
    else:
3375
      keys = self._archive.keys()
3376 3377
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3378
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
3379
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3380
      if not force:
Aurel's avatar
Aurel committed
3381 3382 3383 3384
        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
3385 3386 3387
        if action == 'nothing':
          return
      for key in keys:
3388 3389
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
3390
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
3391

3392
  def uninstall(self, context, **kw):
3393
    catalog = _getCatalogValue(self)
3394 3395 3396
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3397
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
3398
    object_path = kw.get('object_path', None)
3399 3400 3401 3402 3403
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3404 3405 3406 3407 3408
      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
3409
  # Function to generate XML Code Manually
3410
  def generateXml(self, path=None):
3411
    obj = self._objects[path]
3412
    xml_data = '<key_list>'
3413 3414
    obj.sort()
    for key in obj:
3415 3416
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3417 3418
    return xml_data

Aurel's avatar
Aurel committed
3419 3420 3421 3422 3423 3424
  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():
3425
      xml_data = self.generateXml(path=path)
3426
      bta.addObject(obj=xml_data, name=path, path=None)
3427

3428 3429
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3430
  def build(self, context, **kw):
3431
    catalog = _getCatalogValue(self)
3432 3433 3434
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
3435
    sql_search_result_tables = list(catalog.sql_search_tables)
3436
    key_list = []
3437
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
3438
      if key in sql_search_result_tables:
3439
        key_list.append(key)
3440
      elif not self.is_bt_for_diff:
3441
        raise NotFound, 'Result table "%r" not found in catalog' %(key,)
3442
    if len(key_list) > 0:
3443
      self._objects[self.__class__.__name__+'/'+'result_table_list'] = key_list
3444 3445

  def _importFile(self, file_name, file):
3446 3447 3448
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3449 3450 3451 3452 3453 3454 3455 3456
    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
3457

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

3464
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3465
    if context.getTemplateFormatVersion() == 1:
3466
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3467
        return
3468 3469 3470
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3471
    else:
3472
      keys = self._archive.keys()
3473 3474
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3475
    # XXX same as related keys
Aurel's avatar
Aurel committed
3476
    if update_dict.has_key('result_table_list') or force:
3477
      if not force:
Aurel's avatar
Aurel committed
3478
        action = update_dict['result_table_list']
3479
        if action == 'nothing':
Aurel's avatar
Aurel committed
3480
          return
3481
      for key in keys:
3482 3483
        if key not in sql_search_tables:
          sql_search_tables.append(key)
3484
      catalog.sql_search_tables = tuple(sql_search_tables)
3485 3486

  def uninstall(self, context, **kw):
3487
    catalog = _getCatalogValue(self)
3488 3489 3490 3491
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
3492
    object_path = kw.get('object_path', None)
3493 3494 3495 3496 3497
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3498 3499
      if key in sql_search_tables:
        sql_search_tables.remove(key)
3500
    catalog.sql_search_tables = sql_search_tables
3501 3502
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3503
  # Function to generate XML Code Manually
3504
  def generateXml(self, path=None):
3505
    obj = self._objects[path]
3506
    xml_data = '<key_list>'
3507 3508
    obj.sort()
    for key in obj:
3509 3510
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3511 3512
    return xml_data

Aurel's avatar
Aurel committed
3513 3514 3515 3516 3517 3518
  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():
3519
      xml_data = self.generateXml(path=path)
3520
      bta.addObject(obj=xml_data, name=path, path=None)
3521

3522 3523
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
3524 3525

  def build(self, context, **kw):
3526
    catalog = _getCatalogValue(self)
3527 3528 3529 3530 3531 3532 3533 3534
    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)
3535
      elif not self.is_bt_for_diff:
3536
        raise NotFound, 'Keyword key "%r" not found in catalog' %(key,)
3537
    if len(key_list) > 0:
3538
      self._objects[self.__class__.__name__+'/'+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
3539

3540
  def _importFile(self, file_name, file):
3541 3542 3543
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3544 3545 3546 3547 3548 3549 3550 3551
    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
3552 3553

  def install(self, context, trashbin, **kw):
3554
    catalog = _getCatalogValue(self)
3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567
    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()
3568 3569
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581
    # 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):
3582
    catalog = _getCatalogValue(self)
3583 3584 3585 3586
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3587
    object_path = kw.get('object_path', None)
3588 3589
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3590
    else:
3591 3592 3593 3594 3595 3596 3597
      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
3598
  # Function to generate XML Code Manually
3599 3600 3601 3602 3603
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3604 3605
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3606
    return xml_data
Aurel's avatar
Aurel committed
3607 3608 3609 3610

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3611 3612 3613 3614 3615
    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)
3616

3617 3618 3619 3620 3621 3622 3623 3624
# 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
3625
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3626 3627 3628 3629
    key_list = []
    for key in self._archive.keys():
      if key in sql_datetime_keys:
        key_list.append(key)
3630
      elif not self.is_bt_for_diff:
3631 3632 3633 3634 3635
        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):
3636 3637 3638
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653
    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

3654
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680
    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
3681
    sql_datetime_keys = list(getattr(catalog, 'sql_catalog_datetime_search_keys', []))
3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711
    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)      
      
3712 3713
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3714

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

3730
  def _importFile(self, file_name, file):
3731 3732 3733
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3734 3735 3736 3737 3738 3739 3740 3741
    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
3742

3743
  def install(self, context, trashbin, **kw):
3744
    catalog = _getCatalogValue(self)
3745 3746 3747
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3748

3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769
    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
3770

3771
  def uninstall(self, context, **kw):
3772
    catalog = _getCatalogValue(self)
3773 3774 3775 3776
    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)
3777
    object_path = kw.get('object_path', None)
3778 3779 3780 3781 3782 3783 3784 3785 3786 3787
    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
3788
  # Function to generate XML Code Manually
3789 3790 3791 3792 3793
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3794 3795
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811
    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):
3812
    catalog = _getCatalogValue(self)
3813 3814 3815 3816 3817 3818 3819 3820
    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)
3821
      elif not self.is_bt_for_diff:
3822
        raise NotFound, 'Request key "%r" not found in catalog' %(key,)
3823
    if len(key_list) > 0:
3824
      self._objects[self.__class__.__name__+'/'+'request_key_list'] = key_list
3825 3826

  def _importFile(self, file_name, file):
3827 3828 3829
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3830 3831 3832 3833 3834 3835 3836 3837 3838 3839
    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):
3840
    catalog = _getCatalogValue(self)
3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867
    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):
3868
    catalog = _getCatalogValue(self)
3869 3870 3871 3872
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
3873
    object_path = kw.get('object_path', None)
3874 3875 3876 3877 3878 3879 3880 3881 3882 3883
    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
3884
  # Function to generate XML Code Manually
3885 3886 3887 3888 3889
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3890 3891
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906
    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):
3907
    catalog = _getCatalogValue(self)
3908 3909 3910 3911 3912 3913 3914 3915
    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)
3916
      elif not self.is_bt_for_diff:
3917
        raise NotFound, 'Multivalue key "%r" not found in catalog' %(key,)
3918
    if len(key_list) > 0:
3919
      self._objects[self.__class__.__name__+'/'+'multivalue_key_list'] = key_list
3920 3921

  def _importFile(self, file_name, file):
3922 3923 3924
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3925 3926 3927 3928 3929 3930 3931 3932 3933 3934
    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):
3935
    catalog = _getCatalogValue(self)
3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961
    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):
3962
    catalog = _getCatalogValue(self)
3963 3964 3965 3966
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
3967
    object_path = kw.get('object_path', None)
3968 3969 3970 3971 3972 3973 3974 3975 3976 3977
    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
3978
  # Function to generate XML Code Manually
3979 3980 3981 3982 3983
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
3984 3985
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000
    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):
4001
    catalog = _getCatalogValue(self)
4002 4003 4004 4005 4006 4007 4008 4009
    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)
4010
      elif not self.is_bt_for_diff:
4011
        raise NotFound, 'Topic key "%r" not found in catalog' %(key,)
4012
    if len(key_list) > 0:
4013
      self._objects[self.__class__.__name__+'/'+'topic_key_list'] = key_list
4014 4015

  def _importFile(self, file_name, file):
4016 4017 4018
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4019 4020 4021 4022 4023 4024 4025 4026 4027 4028
    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):
4029
    catalog = _getCatalogValue(self)
4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056
    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):
4057
    catalog = _getCatalogValue(self)
4058 4059 4060 4061
    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)
4062
    object_path = kw.get('object_path', None)
4063 4064 4065 4066 4067 4068 4069 4070 4071 4072
    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
4073
  # Function to generate XML Code Manually
4074 4075 4076 4077 4078
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
4079 4080
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091
    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)

4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103
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)
4104
      elif not self.is_bt_for_diff:
4105 4106 4107 4108 4109
        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):
4110 4111 4112
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 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
    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)

4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199
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)
4200
      elif not self.is_bt_for_diff:
4201 4202 4203 4204 4205
        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):
4206 4207 4208
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295
    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)
4296
      elif not self.is_bt_for_diff:
4297 4298 4299 4300 4301
        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):
4302 4303 4304
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 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
    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)

4379 4380 4381 4382
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
4383 4384 4385
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
4386
      else: # XXX backward compatibility
4387 4388
        lang = lang_key
        catalog = 'erp5_ui'
4389
      path = posixpath.join(lang, catalog)
4390 4391
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422

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

  def install(self, context, trashbin, **kw):
    localizer = context.getPortalObject().Localizer
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
      for path, po in self._objects.items():
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
4423
              continue
4424
          path = path.split('/')
4425 4426 4427 4428 4429 4430
          if len(path) == 2:
            lang = path[0]
            catalog = path[1]
          else:
            lang = path[-3]
            catalog = path[-2]
4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456
          if lang not in localizer.get_languages():
            localizer.manage_addLanguage(lang)
          mc = localizer._getOb(catalog)
          if lang not in mc.get_languages():
            mc.manage_addLanguage(lang)
          mc.manage_import(lang, po)
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for lang, catalogs in self._archive.items():
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
          mc = localizer._getOb(catalog)
          if lang not in mc.get_languages():
            mc.manage_addLanguage(lang)
          mc.manage_import(lang, po)

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      obj = self._objects[key]
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
4457
      f = open(path+os.sep+'translation.po', 'wb')
4458 4459 4460 4461
      f.write(str(obj))
      f.close()

  def _importFile(self, file_name, file):
4462
    if posixpath.split(file_name)[1] == 'translation.po':
4463 4464
      text = file.read()
      self._objects[file_name[:-3]] = text
4465

Aurel's avatar
Aurel committed
4466 4467
class LocalRolesTemplateItem(BaseTemplateItem):

4468
  def __init__(self, id_list, **kw):
4469
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
4470 4471
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
4472 4473 4474
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
4475
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
4476 4477
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
4478
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4479

Christophe Dumez's avatar
Christophe Dumez committed
4480
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
4481
  def generateXml(self, path=None):
4482
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
4483 4484
    # local roles
    xml_data = '<local_roles_item>'
4485
    xml_data += '\n <local_roles>'
4486
    for key in sorted(local_roles_dict):
4487
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
4488 4489
      tuple = local_roles_dict[key]
      for item in tuple:
4490 4491 4492 4493
        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
4494
    return xml_data
4495

Aurel's avatar
Aurel committed
4496 4497 4498 4499 4500 4501 4502 4503
  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)

4504
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
4505
      encode_folders = []
4506
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
4507
        if '%' not in folder:
4508
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
4509 4510
        else:
          encode_folders.append(folder)
4511
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
4512 4513 4514 4515
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
4516 4517 4518
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
4519 4520 4521
    xml = parse(file)
    # local roles
    local_roles = xml.getElementsByTagName('local_roles')[0]
4522
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
4523 4524 4525
    local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
4526 4527
      if isinstance(id, unicode):
        id = id.encode('utf-8')
Aurel's avatar
Aurel committed
4528 4529 4530 4531 4532
      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
4533
    self._objects['local_roles/'+file_name[:-4]] = (local_roles_dict, )
Aurel's avatar
Aurel committed
4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544

  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
4545 4546
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
4547
        local_roles_dict = self._objects[roles_path][0]
4548
        setattr(obj, '__ac_local_roles__', local_roles_dict)
Aurel's avatar
Aurel committed
4549 4550 4551 4552 4553 4554 4555

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

4557 4558 4559
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
4560
    in part or completely. Each object is separated from its
4561 4562 4563 4564 4565 4566 4567 4568 4569 4570
    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
4571 4572
      - object without optimal actions
      - list of relation between portal type and workflow
4573 4574 4575 4576 4577 4578 4579 4580 4581 4582

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

    - site property definition
      - id
      - type
4583
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4584

4585 4586
    - document/propertysheet/extension/test definition
      - copy of the local file
4587

4588
    - message transalation definition
4589
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4590

4591 4592
    The Business Template properties are exported to the bt folder with
    one property per file
4593

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4594 4595
    Technology:

4596 4597
    - 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
4598

4599
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4600 4601 4602 4603

    Use case:

    - install core ERP5 (the minimum)
4604

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

4607 4608
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4609
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4610 4611 4612 4613 4614
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4615
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4616 4617 4618 4619 4620
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
4621
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4622 4623 4624 4625

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4626
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4627
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4628
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4629
                      , PropertySheet.BusinessTemplate
4630
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4631 4632
                      )

4633 4634 4635 4636 4637 4638
    # 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."""
4639
         , 'icon'           : 'file_icon.gif'
4640 4641 4642 4643 4644 4645 4646 4647 4648
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4649 4650
    # This is a global variable
    # Order is important for installation
4651 4652 4653 4654 4655 4656
    # 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 )
4657 4658 4659
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
4660
      '_constraint_item',
4661 4662 4663 4664
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4665
      '_tool_item',
4666 4667 4668 4669
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4670
      '_portal_type_workflow_chain_item',
4671 4672 4673 4674
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4675 4676
      '_category_item',
      '_module_item',
4677
      '_path_item',
4678
      '_skin_item',
4679
      '_registered_skin_selection_item',
4680
      '_preference_item',
4681
      '_action_item',
4682
      '_portal_type_roles_item',
4683
      '_local_roles_item',
4684
      '_catalog_method_item',
4685 4686 4687
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4688
      '_catalog_keyword_key_item',
4689
      '_catalog_datetime_key_item',
4690 4691 4692 4693
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4694
      '_catalog_scriptable_key_item',
4695 4696
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4697 4698 4699 4700
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4701 4702 4703 4704 4705 4706
      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
4707
        self._baseGetTemplateFormatVersion()
4708

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4709 4710 4711
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4712

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4713
      return 0
4714

4715
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4716 4717 4718 4719 4720 4721 4722
    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".
4723 4724
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4725
          # XXX Not good to access the attribute directly,
4726 4727 4728
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4729

4730 4731
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4732 4733 4734 4735 4736 4737
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4738
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4739 4740 4741 4742 4743 4744 4745 4746
        """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)
4747

4748
    security.declareProtected(Permissions.ManagePortal, 'build')
4749
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4750 4751 4752
      """
        Copy existing portal objects to self
      """
4753
      if no_action: return
4754
        # this is use at import of Business Template to get the status built
4755 4756
      # Make sure that everything is sane.
      self.clean()
4757

4758
      self.updateRevisionNumber()
4759

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4760 4761
      self._setTemplateFormatVersion(1)

4762
      # Store all data
4763 4764
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4765
      self._portal_type_workflow_chain_item = \
4766
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4767 4768 4769 4770
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4771 4772 4773
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4774 4775 4776 4777 4778 4779
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4780
      self._portal_type_roles_item = \
4781
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4782 4783 4784 4785 4786 4787 4788 4789
      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())
4790 4791
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811
      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())
4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823
      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())
4824 4825
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4826 4827
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4828 4829
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4830
               self.getTemplateCatalogKeywordKeyList())
4831 4832 4833
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4834 4835
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4836
               self.getTemplateCatalogFullTextKeyList())
4837 4838
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4839
               self.getTemplateCatalogRequestKeyList())
4840 4841
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4842
               self.getTemplateCatalogMultivalueKeyList())
4843 4844 4845
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4846 4847
      self._local_roles_item = \
          LocalRolesTemplateItem(
4848
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4849 4850 4851
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4852 4853 4854
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4855 4856 4857 4858 4859 4860
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4861

4862 4863
      # Build each part
      for item_name in self._item_name_list:
4864 4865 4866 4867
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4868

4869
    build = WorkflowMethod(build)
4870 4871

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4872
      """
4873
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4874
      """
4875
      return self.portal_templates.publish(self, url, username=username,
4876
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4877

4878
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4879
      """
4880
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4881
      """
4882
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4883

4884 4885 4886 4887 4888
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4889 4890 4891 4892 4893 4894 4895 4896 4897 4898
      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
4899 4900
      return False

4901
    def preinstall(self, check_dependencies=1, **kw):
4902 4903 4904
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4905
      """
4906 4907 4908 4909 4910
      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()
4911

4912 4913
      modified_object_list = {}
      bt_title = self.getTitle()
4914 4915 4916 4917 4918 4919 4920

      #  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)
4921 4922 4923
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4924
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4925

4926
      # if reinstall business template, must compare to object in ZODB
4927
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4928
      # same if we make a diff and select only one business template
4929
      reinstall = 0
4930 4931
      if installed_bt == self:
        reinstall = 1
4932 4933 4934 4935 4936 4937 4938 4939 4940
        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)
4941

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4942
      new_bt_format = self.getTemplateFormatVersion()
4943 4944 4945 4946 4947 4948
      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:
4949
          item = getattr(self, item_name, None)
4950 4951 4952 4953
          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
4954

4955
      for item_name in self._item_name_list:
4956
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4957
        old_item = getattr(installed_bt, item_name, None)
4958
        if new_item is not None:
4959
          if old_item is not None and hasattr(old_item, '_objects'):
4960
            modified_object = new_item.preinstall(context=self, installed_bt=old_item)
4961 4962 4963 4964 4965 4966 4967
            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:
4968
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
4969

4970 4971
      return modified_object_list

4972 4973
    def _install(self, force=1, object_to_update=None, update_translation=0,
                 update_catalog=0, **kw):
4974
      """
Christophe Dumez's avatar
Christophe Dumez committed
4975
        Install a new Business Template, if force, all will be upgraded or installed
4976 4977
        otherwise depends of dict object_to_update
      """
4978 4979 4980 4981
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4982

4983 4984
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
4985 4986
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4987
        if installed_bt.getTemplateFormatVersion() == 0:
4988
          force = 1
4989
        installed_bt.replace(self)
4990

4991 4992 4993 4994
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4995 4996 4997
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4998

4999 5000 5001
      if not force:
        self.checkDependencies()

5002
      site = self.getPortalObject()
5003 5004 5005 5006 5007 5008
      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()
5009 5010 5011
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Activity Tool')
5012
        gen.setupLastTools(site, update=1, create_activities=1)
5013 5014
      if not force:
        if len(object_to_update) == 0:
5015 5016 5017 5018 5019
          # 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():
5020
            LOG('Business Template', 0, 'Updating Business Template Workflows')
5021
            gen.setupWorkflow(site)
5022
          return
5023

5024 5025
      # 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
5026
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
5027 5028 5029 5030 5031
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
5032
      if len(object_to_update) or force:
5033 5034 5035
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
5036
            item.install(self, force=force, object_to_update=object_to_update, trashbin=trashbin, installed_bt=installed_bt)
5037

5038
      # update catalog if necessary
5039 5040
      if force and self.isCatalogUpdatable():
        update_catalog = 1
5041
      if update_catalog:
5042
        catalog = _getCatalogValue(self)
5043
        if (catalog is None) or (not site.isIndexable):
5044 5045 5046 5047 5048
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
5049

5050
      # get objects to remove
5051
      # do remove after because we may need backup object from installation
5052
      remove_object_dict = {}
5053 5054
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
5055
          remove_object_dict[path] = action
5056

5057
      # remove object from old business template
5058
      if len(remove_object_dict):
5059
        # XXX: this code assumes that there is an installed_bt
5060
        for item_name in reversed(installed_bt._item_name_list):
5061
          item = getattr(installed_bt, item_name, None)
5062
          if item is not None:
5063
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
5064

5065 5066 5067 5068 5069 5070

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

5071
      # check if we have to update business template workflow
5072
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
5073
        LOG('Business Template', 0, 'Updating Business Template Workflows')
5074 5075 5076 5077 5078
        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)

5079 5080
      # remove trashbin if empty
      if trashbin is not None:
5081
        if len(trashbin) == 0:
5082 5083
          trash_tool.manage_delObjects([trashbin.getId(),])

5084 5085
      if update_catalog:
        site.ERP5Site_reindexAll()
5086

5087 5088
      # Update translation table, in case we added new portal types or
      # workflow states.
5089 5090
      if update_translation:
        site.ERP5Site_updateTranslationTable()
5091

5092 5093
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
5094

5095
    security.declareProtected(Permissions.ManagePortal, 'install')
5096 5097 5098
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
5099
      """
5100
      return self._install(**kw)
5101

5102
    install = WorkflowMethod(install)
5103

5104
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
5105
    def reinstall(self, **kw):
5106 5107 5108 5109
      """Reinstall Business Template.
      """
      return self._install(**kw)

5110
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5111

5112
    security.declareProtected(Permissions.ManagePortal, 'trash')
5113 5114
    def trash(self, new_bt, **kw):
      """
5115
        Trash unnecessary items before upgrading to a new business
5116
        template.
5117
        This is similar to uninstall, but different in that this does
5118
        not remove all items.
5119
      """
5120 5121
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5122
        item = getattr(self, item_name, None)
5123 5124
        if item is not None:
          item.trash(
5125
                self,
5126
                getattr(new_bt, item_name))
5127

5128
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
5129
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5130
      """
5131
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5132
      """
5133 5134 5135
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
5136
        item = getattr(self, item_name, None)
5137
        if item is not None:
5138
          item.uninstall(self)
5139
      # It is better to clear cache because the uninstallation of a
5140
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
5141
      self.getPortalObject().portal_caches.clearAllCache()
5142

5143 5144
    uninstall = WorkflowMethod(uninstall)

5145
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5146
    def _clean(self):
5147
      """
5148
        Clean built information.
5149
      """
5150
      # First, remove obsolete attributes if present.
5151 5152 5153 5154
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
5155
                    '_module_archive',
5156 5157 5158
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
5159
                    '_property_sheet_archive'):
5160 5161 5162
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
5163 5164
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
5165

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

5168
    security.declareProtected(Permissions.AccessContentsInformation,
5169
                              'getBuildingState')
5170
    def getBuildingState(self, default=None, id_only=1):
5171
      """
5172
        Returns the current state in building
5173
      """
5174
      portal_workflow = getToolByName(self, 'portal_workflow')
5175 5176
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
5177
      return wf._getWorkflowStateOf(self, id_only=id_only )
5178

5179
    security.declareProtected(Permissions.AccessContentsInformation,
5180
                              'getInstallationState')
5181
    def getInstallationState(self, default=None, id_only=1):
5182
      """
5183
        Returns the current state in installation
5184
      """
5185
      portal_workflow = getToolByName(self, 'portal_workflow')
5186 5187
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
5188
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5189

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5190 5191 5192 5193 5194 5195
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
5196
      export_string = portal_templates.manage_exportObject(
5197 5198
                                               id=self.getId(),
                                               toxml=1,
5199
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5200
      return export_string
5201

5202
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5203
      """
5204 5205
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5206
      """
5207 5208
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
5209 5210 5211 5212
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
5213
        # XXX Why do we need to return a tuple ?
5214 5215
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5216

5217
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5218
      """
5219 5220
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5221
      """
5222
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5223

5224
    def getTemplateBaseCategoryList(self):
5225
      """
5226 5227
      We have to set this method because we want an
      ordered list
5228
      """
5229
      return self._getOrderedList('template_base_category')
5230

5231
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5232
      """
5233 5234
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5235
      """
5236
      return self._getOrderedList('template_workflow_id')
5237

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

5245 5246 5247 5248 5249 5250 5251
    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
5252 5253 5254 5255 5256 5257 5258
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

5259 5260 5261 5262 5263 5264 5265
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

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

5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293
    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')

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

5301
    def getTemplatePortalTypeRoleList(self):
5302 5303 5304 5305
      """
      We have to set this method because we want an
      ordered list
      """
5306
      return self._getOrderedList('template_portal_type_role')
5307

5308
    def getTemplateLocalRoleList(self):
5309 5310 5311 5312
      """
      We have to set this method because we want an
      ordered list
      """
5313
      return self._getOrderedList('template_local_role')
5314

5315
    def getTemplateSkinIdList(self):
5316
      """
5317 5318
      We have to set this method because we want an
      ordered list
5319
      """
5320
      return self._getOrderedList('template_skin_id')
5321

5322 5323 5324 5325 5326 5327 5328
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

5329
    def getTemplateModuleIdList(self):
5330
      """
5331 5332
      We have to set this method because we want an
      ordered list
5333
      """
5334
      return self._getOrderedList('template_module_id')
5335 5336 5337 5338 5339 5340 5341

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
5343 5344 5345 5346 5347 5348 5349
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

5350
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
5351 5352 5353 5354
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
5355
      if self.getBuildingState() != 'built':
5356
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
5357
              'Business Template must be built before export'
5358

Aurel's avatar
Aurel committed
5359 5360 5361 5362 5363 5364 5365
      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)

5366
      # export bt
5367
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
5368
      for prop in self.propertyMap():
5369
        prop_type = prop['type']
Aurel's avatar
Aurel committed
5370
        id = prop['id']
5371
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
5372
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
5373
          continue
Aurel's avatar
Aurel committed
5374
        value = self.getProperty(id)
5375
        if prop_type in ('text', 'string', 'int', 'boolean'):
5376
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
5377
        elif prop_type in ('lines', 'tokens'):
5378
          bta.addObject(obj=str('\n').join(value), name=id,
5379
                        path=path+os.sep+'bt', ext='')
5380

Aurel's avatar
Aurel committed
5381 5382 5383
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
5384

Aurel's avatar
Aurel committed
5385 5386
      return bta.finishCreation()

5387
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
5388 5389
    def importFile(self, dir = 0, file=None, root_path=None):
      """
5390
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
5391 5392 5393 5394 5395 5396 5397
      """
      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())
5398
      self._portal_type_workflow_chain_item = \
5399
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
5400 5401 5402 5403
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
5404 5405 5406
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
Aurel's avatar
Aurel committed
5407 5408 5409 5410 5411 5412
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
5413 5414
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
5415 5416 5417 5418 5419 5420 5421 5422
      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())
5423 5424
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446
      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())
5447 5448
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462
      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(
5463
               self.getTemplateCatalogKeywordKeyList())
5464 5465 5466
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
5467 5468
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
5469
               self.getTemplateCatalogFullTextKeyList())
5470 5471
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
5472
               self.getTemplateCatalogRequestKeyList())
5473 5474
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
5475
               self.getTemplateCatalogMultivalueKeyList())
5476 5477 5478
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
5479 5480
      self._local_roles_item = \
          LocalRolesTemplateItem(
5481
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5482 5483 5484
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
5485 5486 5487
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
5488 5489 5490 5491 5492 5493
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
5494

5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507
      # 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
5508 5509
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
5510

5511 5512 5513 5514 5515
      # 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]

5516 5517 5518 5519 5520
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
5521 5522 5523
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
5524
      return items_list
5525

5526 5527 5528 5529 5530 5531 5532 5533 5534 5535
    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:
5536
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
5537
          dependency = dependency_couple_list[0]
5538 5539
          if dependency in (None, ''):
            continue
5540 5541
          version_restriction = None
          if len(dependency_couple_list) > 1:
5542
            version_restriction = dependency_couple_list[1]
5543 5544 5545
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
5546 5547 5548
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
5549
                  or (version_restriction not in (None, '') and
5550 5551 5552 5553
                     (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)
5554

Aurel's avatar
Aurel committed
5555
    def diffObject(self, REQUEST, **kw):
5556 5557
      """
        Make a diff between an object in the Business Template
5558
        and the same in the Business Template installed in the site
5559 5560 5561 5562
      """

      class_name_dict = {
        'Product' : '_product_item',
5563
        'PropertySheet' : '_property_sheet_item',
5564
        'Constraint' : '_constraint_item',
5565 5566 5567 5568 5569 5570 5571 5572 5573
        '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',
5574
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
5575 5576 5577 5578
        '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',
5579 5580 5581
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
5582
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
5583
        'Path' : '_path_item',
5584
        'Preference' : '_preference_item',
5585
        'Action' : '_action_item',
5586
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
5587
        'LocalRoles' : '_local_roles_item',
5588 5589 5590
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
5591
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
5592
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
5593 5594 5595 5596
        '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
5597
        'Tool': '_tool_item',
5598
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
5599 5600
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
5601
        }
5602

5603 5604
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
5605

Christophe Dumez's avatar
Christophe Dumez committed
5606
      # Get objects
5607
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
5608

Aurel's avatar
Aurel committed
5609
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
5610
      # Compare with a given business template
5611
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5612 5613
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5614 5615
        if bt2_id == self.getId():
          compare_to_zodb = 1
5616
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5617 5618
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5619 5620 5621
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5622 5623
          compare_to_zodb = 1
      if compare_to_zodb:
5624
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5625
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5626 5627 5628
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5629

5630 5631
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5632
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5633
        # XXX maybe only build for the given object to gain time
5634
        installed_item.build(self)
5635 5636 5637
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5638

Christophe Dumez's avatar
Christophe Dumez committed
5639
      # Real Zope Objects (can be exported into XML directly by Zope)
5640 5641
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5642
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5643
                     '_skin_item', '_action_item', '_tool_item', ]
5644

Christophe Dumez's avatar
Christophe Dumez committed
5645
      # Not considered as objects by Zope (will be exported into XML manually)
5646
      # XXX Bad naming
5647
      item_list_2 = ['_site_property_item', '_module_item',
5648
                     '_catalog_result_key_item', '_catalog_related_key_item',
5649 5650
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
5651
                     '_catalog_datetime_key_item',
5652 5653 5654 5655
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5656
                     '_catalog_scriptable_key_item',
5657 5658
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5659 5660 5661 5662 5663 5664
                     '_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',
5665
                     '_portal_type_workflow_chain_item',]
5666

Christophe Dumez's avatar
Christophe Dumez committed
5667
      # Text objects (no need to export them into XML)
5668
      # XXX Bad naming
5669 5670
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5671
                     '_test_item', '_message_translation_item',]
5672

5673
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5674 5675 5676
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5677 5678
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
5679
        # XML Export in memory
5680 5681 5682
        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()
5683
        f1.close()
5684 5685 5686 5687
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5688
        # End of XML export
5689

5690
        # Diff between XML objects
5691 5692
        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
5693
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5694 5695 5696
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5697

5698
      elif item_name in item_list_2:
5699
        # Generate XML code manually
5700 5701
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5702 5703
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5704
        # End of XML Code Generation
5705

5706
        # Diff between XML objects
5707 5708
        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
5709
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5710 5711 5712
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5713

5714
      elif item_name in item_list_3:
5715
        # Diff between text objects
5716 5717 5718 5719
        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
5720
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5721 5722
          diff_msg += '\n'.join(diff_list)
        else:
5723
          diff_msg = 'No diff'
5724

5725
      else:
5726
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5727

5728
      if compare_to_zodb:
5729
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5730

5731
      return diff_msg
5732

5733

5734 5735 5736 5737
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5738 5739
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5740 5741 5742 5743 5744 5745 5746
      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 [])
5747 5748
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5749
      p = self.getPortalObject()
5750
      for id in bt_portal_types_id_list:
5751 5752
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5753
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5754
        if portal_type.getRoleInformationList():
5755 5756
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5757

5758 5759 5760 5761
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5762
        action_list = []
5763 5764 5765 5766 5767 5768 5769
        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'):
5770
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5771 5772
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5773

5774 5775 5776 5777
        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)
5778

5779
        for h_id in hidden_content_type_list:
5780 5781 5782
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5783

5784 5785 5786 5787
        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)
5788

5789 5790 5791 5792
        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)
5793

5794 5795 5796 5797
        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)
5798

5799
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5800
                                    if chain != '(Default)']:
5801 5802 5803
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5804

5805 5806 5807 5808
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5809
      bt_action_list.sort()
5810
      bt_wf_chain_list.sort()
5811

5812 5813 5814 5815 5816 5817 5818
      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)
5819 5820 5821 5822 5823 5824 5825 5826 5827
      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:
5828 5829
        raise TemplateConditionError, 'No module defined in business template'

5830 5831 5832 5833 5834 5835 5836 5837
      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:
5838
          return type_list
5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852

        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():
5853
            type_list.update(getChildPortalType(hidden_ptype_id))
5854
        return type_list
5855

5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902
      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

5903 5904 5905
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5906
  setattr(BusinessTemplate, key, None)
5907

5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934
# 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)
5935

5936 5937 5938 5939 5940 5941 5942 5943

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

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