BusinessTemplate.py 180 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
#
# 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.
#
##############################################################################

29
from Globals import Persistent, PersistentMapping
30
from Acquisition import Implicit, aq_base
31
from AccessControl.Permission import Permission
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32 33
from AccessControl import ClassSecurityInfo
from Products.CMFCore.utils import getToolByName
34
from Products.CMFCore.WorkflowCore import WorkflowMethod
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
36 37 38 39
from Products.ERP5Type.Utils import readLocalDocument, \
                                    writeLocalDocument, \
                                    importLocalDocument, \
                                    removeLocalDocument
40 41 42 43
from Products.ERP5Type.Utils import readLocalPropertySheet, \
                                    writeLocalPropertySheet, \
                                    importLocalPropertySheet, \
                                    removeLocalPropertySheet
44
from Products.ERP5Type.Utils import readLocalConstraint, \
Romain Courteaud's avatar
Romain Courteaud committed
45
                                    writeLocalConstraint, \
46 47 48 49
                                    importLocalConstraint, \
                                    removeLocalConstraint
from Products.ERP5Type.Utils import readLocalExtension, \
                                    writeLocalExtension, \
50
                                    removeLocalExtension
51 52
from Products.ERP5Type.Utils import readLocalTest, \
                                    writeLocalTest, \
53
                                    removeLocalTest
Jean-Paul Smets's avatar
Jean-Paul Smets committed
54
from Products.ERP5Type.XMLObject import XMLObject
55
from Products.ERP5Type.RoleInformation import RoleInformation
56
import fnmatch
Aurel's avatar
Aurel committed
57
import re, os, sys, string, tarfile
Yoshinori Okuji's avatar
Yoshinori Okuji committed
58
from Products.ERP5Type.Cache import clearCache
59
from DateTime import DateTime
Aurel's avatar
Aurel committed
60
from OFS.Traversable import NotFound
61 62
from OFS import XMLExportImport
from cStringIO import StringIO
Aurel's avatar
Aurel committed
63 64
from copy import deepcopy
from App.config import getConfiguration
65
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
66 67 68 69
import OFS.XMLExportImport
customImporters={
    XMLExportImport.magic: XMLExportImport.importXML,
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
70

Jérome Perrin's avatar
Jérome Perrin committed
71
from zLOG import LOG, WARNING, ERROR
Aurel's avatar
Aurel committed
72 73
from OFS.ObjectManager import customImporters
from gzip import GzipFile
74
from xml.dom.minidom import parse
75
from Products.CMFCore.Expression import Expression
Aurel's avatar
Aurel committed
76
import tarfile
77
from urllib import pathname2url, url2pathname
78
from difflib import unified_diff
Aurel's avatar
Aurel committed
79 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 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
def removeAll(entry):
  '''
    Remove all files and directories under 'entry'.
    XXX: This is defined here, because os.removedirs() is buggy.
  '''
  try:
    if os.path.isdir(entry) and not os.path.islink(entry):
      pwd = os.getcwd()
      os.chmod(entry, 0755)
      os.chdir(entry)
      for e in os.listdir(os.curdir):
        removeAll(e)
      os.chdir(pwd)
      os.rmdir(entry)
    else:
      if not os.path.islink(entry):
        os.chmod(entry, 0644)
      os.remove(entry)
  except OSError:
    pass

Aurel's avatar
Aurel committed
113

114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
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)

Aurel's avatar
Aurel committed
143 144 145
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
146
  """
Aurel's avatar
Aurel committed
147 148 149 150 151 152 153 154 155 156 157 158

  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
159

Aurel's avatar
Aurel committed
160 161 162 163 164
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
165
    Class archiving business template into a folder tree
166
  """
Aurel's avatar
Aurel committed
167 168 169 170 171 172
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
173
      removeAll(self.path)
Aurel's avatar
Aurel committed
174 175 176
      os.makedirs(self.path)

  def addFolder(self, name=''):
177
     if name !='':
Aurel's avatar
Aurel committed
178
      path = os.path.join(self.path, name)
179
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
180 181 182
        os.makedirs(path)
      return path

183
  def addObject(self, obj, name, path=None, ext='.xml'):
184
    name = pathname2url(name)
Aurel's avatar
Aurel committed
185 186 187
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
188 189
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
190 191
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
192
    f.write(str(obj))
Aurel's avatar
Aurel committed
193 194 195
    f.close()

  def _initImport(self, file=None, path=None, **kw):
196 197 198
    # Normalize the paths to eliminate the effect of double-slashes.
    self.file_list = [os.path.normpath(f) for f in file]
    path = os.path.normpath(path)
199
    # to make id consistent, must remove a part of path while importing
200
    self.root_path_len = len(string.split(path, os.sep)) + 1
Aurel's avatar
Aurel committed
201

202
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
203 204 205 206
    """
      Import file from a local folder
    """
    class_name = klass.__class__.__name__
207
    for file_path in self.file_list:
208
      if class_name in file_path.split(os.sep):
209 210
        if os.path.isfile(file_path):
          file = open(file_path, 'r')
Aurel's avatar
Aurel committed
211
          # get object id
212 213
          folders = file_path.split(os.sep)
          file_name = string.join(folders[self.root_path_len:], os.sep)
214 215
          if '%' in file_name:
            file_name = url2pathname(file_name)
216
          klass._importFile(file_name, file)
Aurel's avatar
Aurel committed
217
          # close file
218
          file.close()
219

Aurel's avatar
Aurel committed
220 221 222 223 224 225
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
226
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
227 228 229 230 231
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
232
      removeAll(self.path)
Aurel's avatar
Aurel committed
233 234 235 236 237 238
      os.makedirs(self.path)
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)

  def addFolder(self, name=''):
Aurel's avatar
Aurel committed
239
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
240 241
      os.makedirs(name)

242
  def addObject(self, obj, name, path=None, ext='.xml'):
243
    name = pathname2url(name)
Aurel's avatar
Aurel committed
244 245 246
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
247 248
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
249 250
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
251
    f.write(str(obj))
Aurel's avatar
Aurel committed
252 253 254 255 256
    f.close()

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
257
    removeAll(self.path)
Aurel's avatar
Aurel committed
258 259 260 261 262
    return self.fobj

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

263
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
264 265
    """
      Import all file from the archive to the site
266
    """
Aurel's avatar
Aurel committed
267 268 269 270 271 272
    class_name = klass.__class__.__name__
    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
273 274
      if 'CVS' in info.name.split('/'):
        continue
Yoshinori Okuji's avatar
Yoshinori Okuji committed
275 276
      if '.svn' in info.name.split('/'):
        continue
277
      if class_name in info.name.split('/'):
Aurel's avatar
Aurel committed
278 279
        if info.isreg():
          file = tar.extractfile(info)
280 281 282
          tar_file_name = info.name.startswith('./') and info.name[2:] or \
              info.name
          folders = string.split(tar_file_name, os.sep)
283 284 285 286
          file_name = (os.sep).join(folders[2:])
          if '%' in file_name:
            file_name = url2pathname(file_name)
          klass._importFile(file_name, file)
Aurel's avatar
Aurel committed
287 288 289
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
290

291
class TemplateConditionError(Exception): pass
292
class TemplateConflictError(Exception): pass
293
class BusinessTemplateMissingDependency(Exception): pass
294

295
class BaseTemplateItem(Implicit, Persistent):
296
  """
297
    This class is the base class for all template items.
298
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
299

300
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
301
    self.__dict__.update(kw)
302
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
303
    self._objects = PersistentMapping()
304
    for id in id_list:
305 306
      if id is not None and id != '':
        self._archive[id] = None
307 308 309 310

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

311
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
312 313
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
314
      new_keys = self._objects.keys()
315
      for path in new_keys:
316 317
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
318 319
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
320 321 322 323 324 325 326 327 328 329 330 331
          if new_obj_xml != old_obj_xml:
            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):
332
    pass
333 334 335

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

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
  def remove(self, context, **kw):
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
    # 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)
352

353

354 355 356 357
  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
358
  def export(self, context, bta, **kw):
359
    pass
Aurel's avatar
Aurel committed
360

361 362
  def getKeys(self):
    return self._objects.keys()
363

Aurel's avatar
Aurel committed
364
  def importFile(self, bta, **kw):
365
    bta.importFiles(klass=self)
366

367 368 369
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
370
    """
371 372 373 374 375 376 377
    if hasattr(obj, '__ac_local_roles__'):
      # remove local roles
      obj.__ac_local_roles__ = None
    if hasattr(obj, '_owner'):
      obj._owner = None
    if hasattr(aq_base(obj), 'uid'):
      obj.uid = None
378 379
    if hasattr(aq_base(obj), '_filepath'):
      obj._filepath = None
380
    if hasattr(aq_base(obj), 'workflow_history'):
381 382 383 384
      if hasattr(obj.__class__, 'workflow_history'):
        obj.workflow_history = None
      else:
        del obj.workflow_history
385 386 387
    if getattr(obj, 'meta_type', None) == 'Script (Python)':
      if hasattr(aq_base(obj), '_code'):
        obj._code = None
388 389
      if hasattr(aq_base(obj), 'Python_magic'):
        obj.Python_magic = None
390 391 392
    elif getattr(obj, 'meta_type', None) == 'ERP5 PDF Form' :
      if not obj.getProperty('business_template_include_content', 1) :
        obj.deletePdfContent()
393 394
    return obj

395 396 397
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
398
  """
399

400 401 402 403
  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()
404
      self._archive.clear()
405 406 407
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
408

409 410 411 412 413
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
414
      obj = self._objects[key]
415 416
      # create folder and subfolders
      folders, id = os.path.split(key)
Aurel's avatar
Aurel committed
417 418 419 420 421 422 423
      encode_folders = []
      for folder in folders.split('/'):
        if '%' not in folder:
          encode_folders.append(pathname2url(folder))
        else:
          encode_folders.append(folder)
      path = os.path.join(root_path, (os.sep).join(encode_folders))
424 425 426
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
427 428
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
429

Aurel's avatar
Aurel committed
430 431 432 433
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
434
      relative_url = '/'.join([url,id])
435 436
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
437
      obj = self.removeProperties(obj)
438
      id_list = obj.objectIds()
439
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
440
        # we must keep groups because it's ereased when we delete subobjects
441
        groups = deepcopy(obj.groups)
442
      if id_list:
Aurel's avatar
Aurel committed
443
        self.build_sub_objects(context, id_list, relative_url)
444
        for id_ in list(id_list):
445
          obj._delObject(id_)
446
      if hasattr(aq_base(obj), 'groups'):
447 448 449
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
450 451
    return sub_list

452 453 454 455
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
456 457
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
458
      obj = self.removeProperties(obj)
459
      id_list = obj.objectIds()
460
      if hasattr(aq_base(obj), 'groups'):
Christophe Dumez's avatar
Christophe Dumez committed
461
        # we must keep groups because it's erased when we delete subobjects
462
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
463 464
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
465
        for id_ in list(id_list):
466
          obj._delObject(id_)
467
      if hasattr(aq_base(obj), 'groups'):
468 469 470
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
471

472 473 474 475 476 477 478
  def _importFile(self, file_name, file):
    # import xml file
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
479 480
    __traceback_info__ = 'Importing %s' % file_name
    obj = connection.importFile(file, customImporters=customImporters)
481 482
    self._objects[file_name[:-4]] = obj

483
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
484 485
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
486 487 488 489 490 491 492
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      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]
493 494
          new_object = self.removeProperties(new_object)
          old_object = self.removeProperties(old_object)
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
          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.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 _backupObject(self, action, trashbin, container_path, object_id):
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
518
    subobjects_dict = {}
519
    if trashbin is None: # must return subobjects
520 521 522 523 524 525
      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)
526
        subobjects_dict[subobject_id] = subobject_copy
527
      return subobjects_dict
528 529
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
530 531 532 533
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1)
    elif action == 'install':
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0)
    return subobjects_dict
534

535 536 537
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
538
    if context.getTemplateFormatVersion() == 1:
539 540 541 542 543 544
      groups = {}
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
545 546 547 548 549 550 551
        if update_dict.has_key(path) or force:
          # get action for the oject
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          else:
552
            action = 'backup'
553
          # get subobjects in path
554 555 556
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
557 558 559 560
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
561
            container_url = '/'.join(container_path)
562 563 564 565 566 567 568 569
            if update_dict.has_key(container_url):
              if update_dict[container_url] == 'nothing':
                continue
            raise
          container_ids = container.objectIds()
          subobjects_dict = {}
          # Object already exists
          if object_id in container_ids:
570
            subobjects_dict = self._backupObject(action, trashbin,
571
                                                 container_path, object_id)
572 573
            container.manage_delObjects([object_id])
          # install object
574
          obj = self._objects[path]
575 576 577
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
578
          if hasattr(aq_base(obj), 'groups'):
579
            # we must keep original order groups
580
            # because they change when we add subobjects
581
            groups[path] = deepcopy(obj.groups)
582
          # copy the object
583 584 585 586 587
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
588
          # if portal types upgrade, set backup properties
589 590
          if getattr(obj, 'meta_type', None) == 'ERP5 Type Information' and \
              len(subobjects_dict) > 0:
591
            setattr(obj, 'allowed_content_types',
592
                    subobjects_dict['allowed_content_type_list'] or [])
593
            setattr(obj, 'hidden_content_type_list',
594
                    subobjects_dict['hidden_content_type_list'] or [])
595
            setattr(obj, 'property_sheet_list',
596
                    subobjects_dict['property_sheet_list'] or [])
597
            setattr(obj, 'base_category_list',
598
                    subobjects_dict['base_category_list'] or [])
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
            setattr(obj, '_roles', subobjects_dict['roles_list'] or [])
            # set actions
            action_list = subobjects_dict['action_list']
            for action in action_list:
              obj.addAction(id = action.id
                            , name = action.title
                            , action = action.action.text
                            , condition = action.getCondition()
                            , permission = action.permissions
                            , category = action.category
                            , visible = action.visible
                            , icon = getattr(action, 'icon', None) and action.icon.text or ''
                            , priority = action.priority
                            )
            # set workflow chain
            wf_chain = subobjects_dict['workflow_chain']
            chain_dict = getChainByType(context)[1]
            default_chain = ''
            chain_dict['chain_%s' %(object_id)] = wf_chain
618
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
619
          # import sub objects if there is
620
          elif len(subobjects_dict) > 0:
621
            # get a jar
622 623
            connection = obj._p_jar
            o = obj
624
            while connection is None:
625 626
              o = o.aq_parent
              connection = o._p_jar
627 628 629 630 631
            # import subobjects
            for subobject_id in subobjects_dict.keys():
              subobject_data = subobjects_dict[subobject_id]
              subobject_data.seek(0)
              subobject = connection.importFile(subobject_data)
632
              if subobject_id not in obj.objectIds():
633
                obj._setObject(subobject_id, subobject)
634
          if obj.meta_type in ('Z SQL Method',):
635 636 637
            # It is necessary to make sure that the sql connection
            # in this method is valid.
            sql_connection_list = portal.objectIds(spec=('Z MySQL Database Connection',))
638 639
            if (obj.connection_id not in sql_connection_list) and \
               (len(sql_connection_list) != 0):
640
              obj.connection_id = sql_connection_list[0]
641 642
      # now put original order group
      for path in groups.keys():
643 644
        obj = portal.unrestrictedTraverse(path)
        obj.groups = groups[path]
Aurel's avatar
Aurel committed
645
    else:
646 647
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
648
      portal = context.getPortalObject()
649
      for relative_url in self._archive.keys():
650
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
651 652 653 654
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
655
        if object_id in container_ids:    # Object already exists
656
          self._backupObject('backup', trashbin, container_path, object_id)
657
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
658
        # Set a hard link
659 660 661 662 663 664
        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',):
665
          # It is necessary to make sure that the sql connection
Aurel's avatar
Aurel committed
666 667 668
          # in this method is valid.
          sql_connection_list = portal.objectIds(
                                   spec=('Z MySQL Database Connection',))
669 670
          if obj.connection_id not in sql_connection_list:
            obj.connection_id = sql_connection_list[0]
671 672 673

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
674
    trash = kw.get('trash', 0)
675 676 677 678 679
    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
680
      object_keys = self._archive.keys()
681
    for relative_url in object_keys:
682 683
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
684
      try:
685
        container = portal.unrestrictedTraverse(container_path)
686
        if trash and trashbin is not None:
687 688
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
        container.manage_delObjects([object_id])
689
      except (NotFound, KeyError, BadRequest):
690
        # object is already backup and/or removed
691
        pass
692 693
    BaseTemplateItem.uninstall(self, context, **kw)

694 695 696 697 698 699 700 701 702 703 704 705
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

706 707 708 709 710 711 712 713 714
  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()
715 716
    object_keys.sort()
    object_keys.reverse()
717
    p = context.getPortalObject()
718 719
    object_keys.sort()
    object_keys.reverse()
720 721
    for path in object_keys:
      for relative_url in self._resolvePath(p, [], path.split('/')):
722
        try:
Aurel's avatar
Aurel committed
723 724
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
725 726
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
727 728
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
729
                                           keep_subobjects=1)
730 731 732 733 734 735
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

736 737 738
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
739

740 741 742 743 744 745 746 747 748
      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.
749 750 751
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
752
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
753 754
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
755
      if object_id != "":
756
        path_list.extend(self._resolvePath(
757
            folder._getOb(object_id),
758
            relative_url_list + [object_id], id_list[1:]))
759
    return path_list
Aurel's avatar
Aurel committed
760

761 762 763
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
764
    keys = self._path_archive.keys()
765
    keys.sort()
Aurel's avatar
Aurel committed
766
    for path in keys:
767 768 769
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
770
      for relative_url in self._resolvePath(p, [], path.split('/')):
771 772
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
773
        obj = obj.__of__(context)
774
        id_list = obj.objectIds()
775
        obj = self.removeProperties(obj)
776
        if hasattr(aq_base(obj), 'groups'):
777
          # we must keep groups because it's ereased when we delete subobjects
778
          groups = deepcopy(obj.groups)
779
        if len(id_list) > 0:
780 781
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
782
          for id_ in list(id_list):
783
            obj._delObject(id_)
784
        if hasattr(aq_base(obj), 'groups'):
785 786 787
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
788

789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
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")
    if len(id_list) is not None:
      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():
      object = portal.unrestrictedTraverse(object_path)
      # XXX getPreferenceState is a bad name
      if object.getPreferenceState() == 'disabled':
        object.portal_workflow.doActionFor(
                      object,
                      'enable_action',
                      wf_id='preference_workflow',
                      comment="Initialized during Business Template " \
                              "installation.")

827 828
class CategoryTemplateItem(ObjectTemplateItem):

829 830
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
831

832 833 834 835
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
836 837
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
838
      obj = self.removeProperties(obj)
839
      id_list = obj.objectIds()
840
      if id_list:
841
        self.build_sub_objects(context, id_list, relative_url)
842
        for id_ in list(id_list):
843
          obj._delObject(id_)
844 845
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
846 847 848 849 850

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
851 852
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
853
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
854
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
855
      id_list = obj.objectIds()
856 857
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
858
        for id_ in list(id_list):
859
          obj._delObject(id_)
860
      else:
861
        for id_ in list(id_list):
862
          obj._delObject(id_)
863 864
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
865

866 867 868
  def install(self, context, trashbin, light_install = 0, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
869
    if context.getTemplateFormatVersion() == 1:
870 871
      if light_install == 0:
        ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
872 873 874 875 876 877 878
      else:
        portal = context.getPortalObject()
        category_tool = portal.portal_categories
        tool_id = self.tool_id
        keys = self._objects.keys()
        keys.sort()
        for path in keys:
879 880 881 882 883 884
          if update_dict.has_key(path) or force:
            if not force:
              action = update_dict[path]
              if action == 'nothing':
                continue
            else:
885
              action = 'backup'
886
            # Wrap the object by an aquisition wrapper for _aq_dynamic.
887 888
            obj = self._objects[path]
            obj = obj.__of__(category_tool)
889 890 891 892 893 894
            container_path = path.split('/')[:-1]
            category_id = path.split('/')[-1]
            try:
              container = category_tool.unrestrictedTraverse(container_path)
            except KeyError:
              # parent object can be set to nothing, in this case just go on
895
              container_url = '/'.join(container_path)
896 897 898 899
              if update_dict.has_key(container_url):
                if update_dict[container_url] == 'nothing':
                  continue
              raise
900
            container_ids = container.objectIds()
901
            # Object already exists
902
            object_uid = None
903
            if category_id in container_ids:
904
              object_uid = container[category_id].getUid()
905 906
              subobjects_dict = self._backupObject(action, trashbin, container_path, category_id)
              container.manage_delObjects([category_id])
907
            category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
908 909
            if object_uid is not None:
              category.setUid(object_uid)
910
            for property in obj.propertyIds():
911
              if property not in ('id', 'uid'):
912
                category.setProperty(property, obj.getProperty(property, evaluate=0))
913 914 915
            # import sub objects if there is
            if len(subobjects_dict) > 0:
              # get a jar
916 917
              connection = obj._p_jar
              o = category
918
              while connection is None:
919 920
                o = o.aq_parent
                connection = o._p_jar
921 922 923 924 925 926 927
              # import subobjects
              for subobject_id in subobjects_dict.keys():
                subobject_data = subobjects_dict[subobject_id]
                subobject_data.seek(0)
                subobject = connection.importFile(subobject_data)
                if subobject_id not in category.objectIds():
                  category._setObject(subobject_id, subobject)
928
    else:
929
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
930 931 932 933
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      if light_install==0:
934
        ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
935
      else:
936
        for relative_url in self._archive.keys():
937
          obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
938
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
939
          obj = obj.__of__(category_tool)
Aurel's avatar
Aurel committed
940 941 942 943 944
          container_path = relative_url.split('/')[0:-1]
          category_id = relative_url.split('/')[-1]
          container = category_tool.unrestrictedTraverse(container_path)
          container_ids = container.objectIds()
          if category_id in container_ids:    # Object already exists
945 946
            # XXX call backup here
            subobjects_dict = self._backupObject('backup', trashbin, container_path, category_id)
947
            container.manage_delObjects([category_id])
948 949
          category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
          for property in obj.propertyIds():
Aurel's avatar
Aurel committed
950
            if property not in ('id', 'uid'):
951
              category.setProperty(property, obj.getProperty(property, evaluate=0))
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
          # import sub objects if there is
          if len(subobjects_dict) > 0:
            # get a jar
            connection = obj._p_jar
            o = category
            while connection is None:
              o = o.aq_parent
              connection = o._p_jar
            # import subobjects
            for subobject_id in subobjects_dict.keys():
              subobject_data = subobjects_dict[subobject_id]
              subobject_data.seek(0)
              subobject = connection.importFile(subobject_data)
              if subobject_id not in category.objectIds():
                category._setObject(subobject_id, subobject)

968

969 970
class SkinTemplateItem(ObjectTemplateItem):

971 972
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
973

974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
  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

989
  def install(self, context, trashbin, **kw):
990
    ObjectTemplateItem.install(self, context, trashbin, **kw)
991 992
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
993 994 995 996 997
    p = context.getPortalObject()
    # It is necessary to make sure that the sql connections in Z SQL Methods are valid.
    sql_connection_list = p.objectIds(spec=('Z MySQL Database Connection',))
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
998
      for obj in folder.objectValues(spec=('Z SQL Method',)):
999 1000
        if (obj.connection_id not in sql_connection_list) and \
           (len(sql_connection_list) != 0):
1001
          obj.connection_id = sql_connection_list[0]
1002 1003 1004 1005 1006 1007
    # Add new folders into skin paths.
    ps = p.portal_skins
    for skin_name, selection in ps.getSkinPaths():
      new_selection = []
      selection = selection.split(',')
      for relative_url in self._archive.keys():
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1008
        if context.getTemplateFormatVersion() == 1:
1009 1010
          if update_dict.has_key(relative_url) or force:
            if not force:
1011
              if update_dict[relative_url] == 'nothing':
1012
                continue
1013
          obj = self._objects[relative_url]
1014
        else:
1015
          obj = self._archive[relative_url]
1016
        skin_id = relative_url.split('/')[-1]
1017
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
        if selection_list is None or skin_name in selection_list:
          if skin_id not in selection:
            new_selection.append(skin_id)
      new_selection.extend(selection)
      # sort the layer according to skin priorities
      new_selection.sort(lambda a, b : cmp(
        b in ps.objectIds() and ps[b].getProperty(
            'business_template_skin_layer_priority', 0) or 0,
        a in ps.objectIds() and ps[a].getProperty(
            'business_template_skin_layer_priority', 0) or 0))
      ps.manage_skinLayers(skinpath = tuple(new_selection), skinname = skin_name, add_skin = 1)
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
    p.changeSkin(None)
1031 1032 1033

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
1034 1035 1036 1037
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1038
      object_keys = self._archive.keys()
1039
    ps = context.portal_skins
1040
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
1041 1042 1043 1044 1045 1046 1047
    for skin_name, selection in ps.getSkinPaths():
      new_selection = []
      selection = selection.split(',')
      for skin_id in selection:
        if skin_id not in skin_id_list:
          new_selection.append(skin_id)
      ps.manage_skinLayers(skinpath = tuple(new_selection), skinname = skin_name, add_skin = 1)
1048
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
1049
    context.getPortalObject().changeSkin(None)
1050 1051 1052
    ObjectTemplateItem.uninstall(self, context, **kw)


1053
class WorkflowTemplateItem(ObjectTemplateItem):
1054

1055 1056
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1057

1058
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1059 1060
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1061 1062 1063
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
1064
        if installed_bt._objects.has_key(path):
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
          # compare object to see it there is changes
          new_object = self._objects[path]
          old_object = installed_bt._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:
            wf_id = path.split('/')[:2]
            modified_object_list.update({'/'.join(wf_id) : ['Modified', 'Workflow']})
        else: # new object
          modified_object_list.update({path : ['New', 'Workflow']})
1081 1082 1083 1084 1085 1086 1087 1088
      # 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):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1089
    if context.getTemplateFormatVersion() == 1:
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
      for path in keys:
        wf_path = '/'.join(path.split('/')[:2])
        if wf_path in update_dict or force:
          if not force:
            action = update_dict[wf_path]
            if action == 'nothing':
              continue
          else:
1104
            action = 'backup'
1105 1106 1107 1108 1109 1110
          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
1111
            container_url = '/'.join(container_path)
1112 1113 1114 1115 1116 1117 1118 1119
            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
            self._backupObject(action, trashbin, container_path, object_id)
            container.manage_delObjects([object_id])
1120
          obj = self._objects[path]
1121 1122 1123
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1124 1125 1126 1127 1128
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1129 1130 1131 1132
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1133 1134
class PortalTypeTemplateItem(ObjectTemplateItem):

1135 1136
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1137 1138
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1139 1140 1141
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1142 1143
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1144 1145
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1146 1147 1148
      # remove actions and properties
      action_len = len(obj.listActions())
      obj.deleteActions(selections=range(action_len))
1149
      obj = self.removeProperties(obj)
1150 1151 1152 1153 1154 1155 1156 1157 1158
      # remove some properties
      if hasattr(obj, 'allowed_content_types'):
        setattr(obj, 'allowed_content_types', ())
      if hasattr(obj, 'hidden_content_type_list'):
        setattr(obj, 'hidden_content_type_list', ())
      if hasattr(obj, 'property_sheet_list'):
        setattr(obj, 'property_sheet_list', ())
      if hasattr(obj, 'base_category_list'):
        setattr(obj, 'base_category_list', ())
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1159 1160
      if hasattr(obj, '_roles'):
        setattr(obj, '_roles', [])
1161 1162
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1163

1164 1165
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1166 1167 1168 1169
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1170 1171
    # We now need to setup the list of workflows corresponding to
    # each portal type
1172
    (default_chain, chain_dict) = getChainByType(context)
1173
    # Set the default chain to the empty string is probably the
1174
    # best solution, by default it is 'default_workflow', which is
1175
    # not very usefull
1176
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1177
    if context.getTemplateFormatVersion() == 1:
1178
      object_list = self._objects
1179
    else:
1180 1181
      object_list = self._archive
    for path in object_list.keys():
1182 1183 1184 1185
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1186
            continue
1187 1188
        obj = object_list[path]
        portal_type = obj.id
1189 1190 1191
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1192 1193
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1194

1195 1196
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1197 1198 1199 1200 1201 1202 1203
  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:
1204
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1205 1206 1207 1208 1209
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1210
        dict[str(ptype)] = str(workflow)
1211 1212 1213 1214
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1215
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1216 1217

  def build(self, context, **kw):
1218 1219 1220 1221 1222
    # 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
1223
    p = context.getPortalObject()
1224
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1225
    for key in self._archive.keys():
1226 1227 1228
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1229
        workflow = wflist[1]
1230
      else:
1231
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1232
        portal_type = wflist[0][:-2]
1233 1234
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1235 1236 1237 1238 1239
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
        if workflow_name not in chain_dict['chain_%s' % portal_type]:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1240
          raise NotFound, 'workflow %s not found in chain for portal_type %s'\
1241
                % (workflow, portal_type)
1242
        if self._objects.has_key(portal_type):
1243 1244
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1245
        else:
1246
          self._objects[portal_type] = [workflow,]
1247
      else:
Aurel's avatar
Aurel committed
1248
        LOG('BusinessTemplate build', 100, 'portal type %s not found in workflow chain' %(portal_type))
1249

Christophe Dumez's avatar
Christophe Dumez committed
1250
  # Function to generate XML Code Manually
1251 1252 1253 1254 1255
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1256
      workflow_list = self._objects[key]
1257 1258 1259 1260 1261 1262
      # XXX Not always a list
      if isinstance(workflow_list, str):
        LOG("BusinessTemplate, generateXml.", ERROR,
            "A list was expected instead of %s for key %s." % \
                (workflow_list, key))
        workflow_list = [workflow_list]
1263 1264
      xml_data += os.linesep+' <chain>'
      xml_data += os.linesep+'  <type>%s</type>' %(key,)
1265
      xml_data += os.linesep+'  <workflow>%s</workflow>' %(', '.join(workflow_list))
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
      xml_data += os.linesep+' </chain>'
    xml_data += os.linesep+'</workflow_chain>'
    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
1284
    (default_chain, chain_dict) = getChainByType(context)
1285
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1286
    # best solution, by default it is 'default_workflow', which is
1287 1288 1289 1290 1291 1292 1293
    # 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':
1294
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1295 1296 1297 1298
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
        if len(path_splitted) < 2:
          continue
1299
        portal_type = path_splitted[1]
1300
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1301 1302 1303
          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 != '':
1304
            old_chain_workflow_id_set = {}
1305
            # get existent workflow id list
1306 1307
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1308
            # get new workflow id list
1309
            for wf_id in self._objects[path].split(', '):
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
              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
1324 1325
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1326
          else:
1327
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1328 1329
        else:
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1330 1331
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
    for path in self._objects.keys():
      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():
        del chain_dict[id]
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355

  def _importFile(self, file_name, file):
    # 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
1356 1357
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1358 1359 1360
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1361 1362
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1363

1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):

  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'

  def build(self, context, **kw):
    for key in self._archive.keys():
      portal_type, allowed_type = key.split(' | ')
      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
1379
  # Function to generate XML Code Manually
1380
  def generateXml(self, path=None):
1381
    dictio = self._objects
1382
    xml_data = '<%s>' %(self.xml_tag,)
1383
    keys = dictio.keys()
1384 1385
    keys.sort()
    for key in keys:
1386
      allowed_list = dictio[key]
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
      xml_data += os.linesep+' <portal_type id="%s">' %(key,)
      for allowed_item in allowed_list:
        xml_data += os.linesep+'  <item>%s</item>' %(allowed_item,)
      xml_data += os.linesep+' </portal_type>'
    xml_data += os.linesep+'</%s>' %(self.xml_tag,)
    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)

1403 1404 1405 1406 1407 1408
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      if installed_bt.id == 'installed_bt_for_diff':
1409
        #must rename keys in dict if reinstall
1410 1411 1412 1413 1414 1415 1416 1417 1418
        new_dict = PersistentMapping()
        for key in installed_bt._objects.keys():
          new_key = self.class_property+'/'+key
          new_dict[new_key] = installed_bt._objects[key]
        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]
1419
          old_object = installed_bt._objects[path]
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
          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

1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
  def _importFile(self, file_name, file):
    path, name = os.path.split(file_name)
    id = string.split(name, '.')[0]
    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')
    for key in self._objects.keys():
      if update_dict.has_key(key) or force:
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
        try:
          portal_id = key.split('/')[-1]
          portal_type = pt._getOb(portal_id)
1458
        except AttributeError:
1459 1460 1461 1462 1463 1464 1465 1466
          LOG("portal types not found : ", 100, portal_id)
          continue
        property_list = self._objects[key]
        object_property_list = getattr(portal_type, self.class_property, ())
        if len(object_property_list) > 0:
          # merge differences between portal types properties
          # only add new, do not remove
          for id in object_property_list:
1467 1468
            if id not in property_list:
              property_list.append(id)
1469 1470
        setattr(portal_type, self.class_property, list(property_list))

Aurel's avatar
Aurel committed
1471
  def uninstall(self, context, **kw):
1472
    object_path = kw.get('object_path', None)
1473
    p = context.getPortalObject()
1474
    pt = p.unrestrictedTraverse('portal_types')
1475 1476 1477 1478 1479 1480 1481 1482
    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)
1483
      except AttributeError:
1484 1485 1486
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
1487 1488
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
1489 1490
      for id in property_list:
        if id in original_property_list:
1491
          original_property_list.remove(id)
1492
      setattr(portal_type, self.class_property, list(original_property_list))
1493

1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'

class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'

class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

  xml_tag = 'base_category_list'
  class_property = 'base_category_list'

1509
class CatalogMethodTemplateItem(ObjectTemplateItem):
1510
  """Template Item for catalog methods.
1511

1512 1513 1514 1515 1516
    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.
  """
1517

1518 1519
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1520
    # a mapping to store properties of methods.
1521 1522 1523 1524 1525
    # 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()
1526

1527 1528 1529 1530 1531
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
  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

1546 1547
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1548

1549 1550
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1551 1552
    except KeyError:
      catalog = None
1553
    if catalog is None:
1554
      LOG('BusinessTemplate build', 0, 'catalog not found')
1555
      return
1556

1557 1558 1559
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
1560

1561 1562
    for obj in self._objects.values():
      method_id = obj.id
1563 1564
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
1565
      self._is_filtered_archive[method_id] = 0
1566
      if catalog.filter_dict.has_key(method_id):
1567 1568 1569 1570 1571 1572 1573 1574 1575
        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']
1576

Aurel's avatar
Aurel committed
1577
  def export(self, context, bta, **kw):
1578 1579 1580 1581 1582 1583 1584 1585
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

Aurel's avatar
Aurel committed
1586 1587 1588 1589
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
1590
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1591 1592 1593 1594 1595 1596
      # create folder and subfolders
      folders, id = os.path.split(key)
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
1597 1598
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1599 1600
      # add all datas specific to catalog inside one file
      catalog = context.portal_catalog.getSQLCatalog()
1601
      method_id = obj.id
1602 1603
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1604
      f = open(object_path, 'wt')
1605
      xml_data = '<catalog_method>'
1606

1607 1608 1609
      for method_property, value in self._method_properties[method_id].items():
        xml_data += os.linesep+' <item key="%s" type="int">' %(method_property,)
        xml_data += os.linesep+'  <value>%s</value>' %(value,)
1610
        xml_data += os.linesep+' </item>'
1611

Aurel's avatar
Aurel committed
1612
      if catalog.filter_dict.has_key(method_id):
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
        if catalog.filter_dict[method_id]['filtered']:
          xml_data += os.linesep+' <item key="_is_filtered_archive" type="int">'
          xml_data += os.linesep+'  <value>1</value>'
          xml_data += os.linesep+' </item>'
          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'')):
                xml_data += os.linesep+' <item key="%s" type="str">' %(method,)
                xml_data += os.linesep+'  <value>%s</value>' %(str(value))
                xml_data += os.linesep+' </item>'
              elif type(value) in (type(()), type([])):
                xml_data += os.linesep+' <item key="%s" type="tuple">'%(method)
                for item in value:
                  xml_data += os.linesep+'  <value>%s</value>' %(str(item))
                xml_data += os.linesep+' </item>'
1629
      xml_data += os.linesep+'</catalog_method>'
1630
      f.write(xml_data)
Aurel's avatar
Aurel committed
1631
      f.close()
1632

Christophe Dumez's avatar
Christophe Dumez committed
1633 1634 1635 1636 1637 1638 1639 1640 1641
  # 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 += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data
1642

1643 1644
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1645 1646
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1647
    except KeyError:
1648 1649 1650 1651 1652 1653 1654 1655
      catalog = None
    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)
1656

1657 1658 1659
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1660
    new_bt_format = context.getTemplateFormatVersion()
1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676

    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':
1677
              continue
1678 1679 1680 1681
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
1682

1683 1684
    for obj in values:
      method_id = obj.id
1685

1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
      # 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))
1697

1698 1699
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
1700
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1701
        if context.getTemplateFormatVersion() == 1:
1702 1703 1704
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1705
        filter_type = self._filter_type_archive[method_id]
1706 1707 1708
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1709
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1710
        catalog.filter_dict[method_id]['type'] = filter_type
1711
      elif method_id in catalog.filter_dict.keys():
1712
        catalog.filter_dict[method_id]['filtered'] = 0
1713

1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
      # 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)
1740

1741 1742 1743 1744 1745 1746
        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)
1747

1748
  def uninstall(self, context, **kw):
1749 1750
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1751
    except KeyError:
1752 1753 1754 1755
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1756

1757 1758 1759 1760
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
1761 1762 1763 1764
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
1765 1766 1767 1768
    else:
      value = self._archive[object_path]
      if value is not None:
        values.append(value)
1769

1770
    for obj in values:
1771
      method_id = obj.id
1772 1773 1774 1775 1776 1777 1778 1779 1780
      # 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)
1781

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1782
      if catalog.filter_dict.has_key(method_id):
1783
        del catalog.filter_dict[method_id]
1784

1785
    # uninstall objects
1786
    ObjectTemplateItem.uninstall(self, context, **kw)
1787

1788
  def _importFile(self, file_name, file):
1789
    if not '.catalog_keys' in file_name:
1790 1791 1792 1793 1794 1795 1796 1797
      # 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._objects[file_name[:-4]] = obj
1798
    else:
1799 1800 1801 1802
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1803
      method_list = xml.getElementsByTagName('item')
1804
      for method in method_list:
1805
        key = method.getAttribute('key')
1806 1807
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1808 1809
          value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          key = str(key)
1810
        elif key_type == "int":
1811
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1812
          key = str(key)
1813
        elif key_type == "tuple":
1814 1815 1816 1817
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1818
        else:
1819
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1820
          continue
1821
        if key in catalog_method_list or key in catalog_method_filter_list:
1822
          dict = getattr(self, key, {})
1823
          dict[id] = value
1824 1825 1826
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
1827

1828
class ActionTemplateItem(ObjectTemplateItem):
1829 1830

  def __init__(self, id_list, **kw):
1831
    # XXX It's look like ObjectTemplateItem __init__
1832 1833 1834 1835 1836 1837
    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

1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858
  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

1859 1860 1861 1862
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1863
      relative_url, value = id.split(' | ')
1864 1865
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1866
        if getattr(ai, 'id') == value:
1867
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1868
          key = os.path.join(url[-2], url[-1], value)
1869
          action = ai._getCopy(context)
1870
          action = self.removeProperties(action)
1871
          self._objects[key] = action
Aurel's avatar
Aurel committed
1872
          self._objects[key].wl_clearLocks()
1873 1874
          break
      else:
1875
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1876

1877 1878 1879
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1880
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1881 1882
      p = context.getPortalObject()
      for id in self._objects.keys():
1883 1884 1885 1886 1887 1888
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
1889 1890
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
1891
          for index in range(len(action_list)):
1892
            if getattr(action_list[index], 'id') == path[-1]:
1893
              # remove previous action
1894
              obj.deleteActions(selections=(index,))
1895
          action = self._objects[id]
1896 1897 1898
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
1899
          obj.addAction(
1900 1901
                        id = action.id
                      , name = action.title
1902
                      , action = action_text
1903 1904 1905 1906
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
1907 1908
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
1909
                      , priority = action.priority
Aurel's avatar
Aurel committed
1910
                    )
1911
          # sort action based on the priority define on it
1912 1913 1914 1915 1916 1917 1918 1919 1920
          # 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))
Aurel's avatar
Aurel committed
1921
    else:
1922
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1923
      p = context.getPortalObject()
1924 1925
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
1926
        relative_url, key, value = self._splitPath(id)
1927 1928
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
1929
          if getattr(ai, key) == value:
1930
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
1931 1932 1933
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
1934
        obj.addAction(
Aurel's avatar
Aurel committed
1935 1936
                      id = action.id
                    , name = action.title
1937
                    , action = action_text
Aurel's avatar
Aurel committed
1938 1939 1940 1941
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
1942 1943
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
1944
                    )
Aurel's avatar
Aurel committed
1945 1946 1947 1948 1949 1950 1951
        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))
1952 1953
          obj.moveDownActions(selections=tuple(move_down_list))

1954 1955
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1956 1957 1958 1959
    object_path = kw.get("object_path", None)
    if object_path is not None:
      keys = [object_path]
    else:
1960
      keys = self._archive.keys()
1961
    for id in keys:
1962 1963 1964 1965
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976
        relative_url, key, value = self._splitPath(id)
      obj = p.unrestrictedTraverse(relative_url, None)
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
          if getattr(action_list[index], key) == value:
            obj.deleteActions(selections=(index,))
            break
      else :
        LOG('BusinessTemplate', 100,
            'unable to uninstall action at %s, ignoring' % relative_url )
1977 1978
    BaseTemplateItem.uninstall(self, context, **kw)

1979 1980 1981
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
1982
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994
    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])
      type_roles_obj = getattr(obj, '_roles', ())
      type_role_list = []
      for role in type_roles_obj:
        type_role_dict = {}
        # uniq
1995
        for property in ('id', 'title', 'description',
1996 1997 1998 1999
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
2000 2001 2002 2003
        # condition
        prop_value = getattr(role, 'condition')
        if prop_value:
          type_role_dict['condition'] = prop_value.text
2004 2005 2006 2007 2008 2009 2010 2011 2012
        # multi
        for property in ('category', 'base_category'):
          prop_value_list = []
          for prop_value in getattr(role, property):
            prop_value_list.append(prop_value)
          type_role_dict[property] = prop_value_list
        type_role_list.append(type_role_dict)
      self._objects[relative_url] = type_role_list

Christophe Dumez's avatar
Christophe Dumez committed
2013
  # Function to generate XML Code Manually
2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
      xml_data += os.linesep+"  <role id='%s'>" % role['id']
      # uniq
      for property in ('title', 'description', 'condition', 'priority',
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
          xml_data += os.linesep+"   <property id='%s'>%s</property>" % \
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2028
        for prop_value in role.get(property, []):
2029 2030 2031 2032 2033
          xml_data += os.linesep+"   <multi_property "\
          "id='%s'>%s</multi_property>" % (property, prop_value)
      xml_data += os.linesep+"  </role>"
    xml_data += os.linesep+'</type_roles>'
    return xml_data
2034

2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047
  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)
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
    type_roles_list = []
    xml = parse(file)
2048
    xml_type_roles_list = xml.getElementsByTagName('role')
2049 2050 2051 2052 2053 2054 2055 2056
    for role in xml_type_roles_list:
      id = role.getAttribute('id')
      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():
2057
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2058 2059 2060 2061 2062 2063 2064 2065 2066 2067
          if property_id == 'priority':
            property_value = float(property_value)
          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():
2068
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083
          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
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2084 2085 2086 2087 2088 2089
      obj = p.unrestrictedTraverse(path, None)
      if obj is not None:
        setattr(obj, '_roles', []) # reset roles before applying
        type_roles_list = self._objects[roles_path] or []
        for type_role_property_dict in type_roles_list:
          obj._roles.append(RoleInformation(**type_role_property_dict))
2090 2091 2092 2093 2094 2095 2096 2097

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
    for roles_path in self._objects.keys():
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
      obj = p.unrestrictedTraverse(path)
      setattr(obj, '_roles', [])

2098 2099 2100 2101 2102 2103
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2104 2105
      for property in p.propertyMap():
        if property['id'] == id:
2106
          obj = p.getProperty(id)
2107
          prop_type = property['type']
2108 2109
          break
      else:
2110 2111
        obj = None
      if obj is None:
2112
        raise NotFound, 'the property %s is not found' % id
2113
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2114

2115 2116 2117 2118 2119 2120
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
    xml = parse(file)
    property_list = xml.getElementsByTagName('property')
    for prop in property_list:
      id = prop.getElementsByTagName('id')[0].childNodes[0].data
2121 2122
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2123 2124 2125 2126 2127 2128 2129
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2130
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2131
      self._objects[str(id)] = (str(prop_type), value)
2132

2133 2134 2135
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2136
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2137 2138
      p = context.getPortalObject()
      for path in self._objects.keys():
2139 2140 2141 2142
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2143
              continue
2144 2145 2146
          dir, id = os.path.split(path)
          if p.hasProperty(id):
            continue
2147 2148
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
2149
    else:
2150
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2151
      p = context.getPortalObject()
2152 2153
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
2154 2155 2156 2157 2158
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
2159 2160 2161

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2162 2163 2164 2165 2166 2167
    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:
2168 2169 2170 2171
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2172
  # Function to generate XML Code Manually
2173
  def generateXml(self, path=None):
2174
    xml_data = ''
2175
    prop_type, obj = self._objects[path]
2176 2177
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
2178 2179
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
2180
      xml_data += os.linesep+'  <value>'
2181
      for item in obj:
2182 2183 2184 2185
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
2186
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
2187
    xml_data += os.linesep+' </property>'
2188 2189
    return xml_data

Aurel's avatar
Aurel committed
2190 2191 2192 2193 2194
  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)
2195 2196 2197 2198
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2199
      xml_data += self.generateXml(path)
2200
    xml_data += os.linesep+'</site_property>'
2201
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2202

2203 2204 2205 2206 2207 2208 2209
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)
2210 2211 2212 2213 2214 2215 2216 2217
      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
2218

Christophe Dumez's avatar
Christophe Dumez committed
2219
  # Function to generate XML Code Manually
2220
  def generateXml(self, path=None):
2221 2222
    dict = self._objects[path]
    xml_data = '<module>'
2223 2224 2225 2226
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2227 2228 2229 2230 2231
      if key =='permission_list':
        # separe permission dict into xml
        xml_data += os.linesep+' <%s>' %(key,)
        permission_list = dict[key]
        for perm in permission_list:
2232 2233 2234 2235 2236 2237
          # the type of the permission defined if we use acquired or not
          if type(perm[1]) == type([]):
            ptype = "list"
          else:
            ptype = "tuple"
          xml_data += os.linesep+"  <permission type='%s'>" %(ptype,)
2238
          xml_data += os.linesep+'   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2239
          role_list = list(perm[1])
2240
          role_list.sort()
2241 2242 2243 2244 2245 2246 2247 2248 2249
          for role in role_list:
            xml_data += os.linesep+'   <role>%s</role>' %(role)
          xml_data += os.linesep+'  </permission>'
        xml_data += os.linesep+' </%s>' %(key,)
      else:
        xml_data += os.linesep+' <%s>%s</%s>' %(key, dict[key], key)
    xml_data += os.linesep+'</module>'
    return xml_data

2250 2251 2252 2253 2254
  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)
2255 2256 2257
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
2258
      # expor module one by one
2259
      xml_data = self.generateXml(path=id)
2260
      bta.addObject(obj=xml_data, name=id, path=path)
2261

2262
  def install(self, context, trashbin, **kw):
2263
    portal = context.getPortalObject()
2264 2265
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2266
    if context.getTemplateFormatVersion() == 1:
2267
      items = self._objects
2268
    else:
2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
      items = self._archive

    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]
        path, id = os.path.split(id)
        if id in portal.objectIds():
          module = portal._getOb(id)
2281
          module.portal_type = str(mapping['portal_type'])
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
        else:
          module = portal.newContent(id=id, portal_type=str(mapping['portal_type']))
        module.setTitle(str(mapping['title']))
        for name,role_list in list(mapping['permission_list']):
          acquire = (type(role_list) == type([]))
          try:
            module.manage_permission(name, roles=role_list, acquire=acquire)
          except ValueError:
            # Ignore a permission not present in this system.
            pass
2292 2293 2294 2295 2296 2297 2298 2299 2300 2301

  def _importFile(self, file_name, file):
    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:
2302
          perm_type = perm.getAttribute('type').encode() or None
2303 2304 2305 2306 2307 2308 2309 2310 2311
          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))
2312 2313 2314 2315
          if perm_type == "list" or perm_type is None:
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326
          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

2327
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2328 2329 2330
    trash = kw.get('trash', 0)
    if trash:
      return
2331 2332 2333 2334 2335 2336
    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]
2337 2338
    p = context.getPortalObject()
    id_list = p.objectIds()
2339
    for id in keys:
2340
      if id in id_list:
2341
        try:
2342
          if trash and trashbin is not None:
2343 2344
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2345
          p.manage_delObjects([id])
2346
        except NotFound:
2347
          pass
2348 2349
    BaseTemplateItem.uninstall(self, context, **kw)

2350 2351 2352
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2353 2354

class DocumentTemplateItem(BaseTemplateItem):
2355 2356 2357 2358
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2359 2360 2361 2362

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

2365
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2366 2367
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387
      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):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2388
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2389
      for id in self._objects.keys():
2390 2391 2392 2393 2394 2395 2396 2397 2398
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
          path, name = os.path.split(id)
          # This raises an exception if the file already exists.
          try:
2399
            globals()[self.local_file_writer_name](name, text, create=0)
2400
          except IOError, error:
2401
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
2402 2403
            if error.errno :
              raise
2404 2405 2406
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
2407
    else:
2408 2409 2410
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
2411
        # This raises an exception if the file exists.
2412
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
2413 2414
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
2415 2416

  def uninstall(self, context, **kw):
2417
    object_path = kw.get('object_path', None)
2418 2419 2420 2421 2422
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
2423
      globals()[self.local_file_remover_name](id)
2424 2425
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
2426 2427 2428 2429 2430 2431
  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():
2432 2433
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
2434

2435 2436
  def _importFile(self, file_name, file):
    text = file.read()
2437
    self._objects[file_name[:-3]]=text
2438

2439 2440 2441 2442 2443 2444
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

2445 2446 2447 2448 2449
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
2450

2451 2452 2453
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
2454 2455
  # Extension needs no import
  local_file_importer_name = None
2456 2457 2458 2459 2460
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
2461
  # Test needs no import
2462 2463 2464
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
2465

2466 2467 2468
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
2469 2470 2471

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2472 2473 2474 2475
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2476 2477
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
2478

2479
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2480 2481
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2482
      new_roles = self._objects.keys()
2483 2484 2485
      if installed_bt.id == 'installed_bt_for_diff':
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
2486 2487 2488
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
2489 2490
        for key in old_keys:
          new_dict[key] = ''
2491
        installed_bt._objects = new_dict
2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504
      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):
2505
    p = context.getPortalObject()
2506
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2507
    if context.getTemplateFormatVersion() == 1:
2508
      role_list = self._objects.keys()
2509
    else:
2510
      role_list = self._archive.keys()
2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522
    # 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
2523
    for role in role_list:
2524 2525 2526 2527 2528 2529 2530 2531 2532 2533
      roles[role] = 1
    p.__ac_roles__ = tuple(roles.keys())

  def _importFile(self, file_name, file):
    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
2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545

  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)

2546 2547 2548 2549 2550 2551 2552 2553 2554
  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
2555
      if role in roles and role not in new_roles:
2556 2557 2558
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
2559
  # Function to generate XML Code Manually
2560
  def generateXml(self, path):
2561
    obj = self._objects[path]
2562
    xml_data = '<role_list>'
2563 2564
    obj.sort()
    for role in obj:
2565 2566 2567 2568
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

Aurel's avatar
Aurel committed
2569 2570 2571 2572 2573 2574
  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():
2575
      xml_data = self.generateXml(path=path)
2576
      bta.addObject(obj=xml_data, name=path, path=None,)
2577

2578 2579
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2580
  def build(self, context, **kw):
2581 2582
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2583
    except KeyError:
2584 2585 2586 2587
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2588
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2589
    key_list = []
2590
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2591
      if key in sql_search_result_keys:
2592
        key_list.append(key)
Aurel's avatar
Aurel committed
2593 2594
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2595
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2596
      self._objects[self.__class__.__name__+os.sep+'result_key_list'] = key_list
2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607

  def _importFile(self, file_name, file):
    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

2608
  def install(self, context, trashbin, **kw):
2609 2610 2611 2612 2613 2614 2615
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2616

2617
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2618
    if context.getTemplateFormatVersion() == 1:
2619 2620
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
2621 2622 2623
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2624
    else:
2625
      keys = self._archive.keys()
2626 2627
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2628
    # XXX same as related key
Aurel's avatar
Aurel committed
2629
    if update_dict.has_key('result_key_list') or force:
2630
      if not force:
Aurel's avatar
Aurel committed
2631
        action = update_dict['result_key_list']
2632
        if action == 'nothing':
Aurel's avatar
Aurel committed
2633
          return
2634
      for key in keys:
2635 2636
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
2637
      catalog.sql_search_result_keys = sql_search_result_keys
2638

2639
  def uninstall(self, context, **kw):
2640 2641
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2642
    except KeyError:
2643 2644 2645 2646 2647
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2648
    object_path = kw.get('object_path', None)
2649 2650 2651 2652 2653
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2654 2655
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2656
    catalog.sql_search_result_keys = sql_search_result_keys
2657 2658
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2659
  # Function to generate XML Code Manually
2660
  def generateXml(self, path=None):
2661
    obj = self._objects[path]
2662
    xml_data = '<key_list>'
2663 2664
    obj.sort()
    for key in obj:
2665 2666 2667 2668
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2669 2670 2671 2672 2673
  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)
2674
    for path in self._objects.keys():
2675
      xml_data = self.generateXml(path=path)
2676
      bta.addObject(obj=xml_data, name=path, path=None)
2677

2678 2679
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2680
  def build(self, context, **kw):
2681 2682
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2683
    except KeyError:
2684 2685 2686 2687
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2688
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2689
    key_list = []
2690
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2691
      if key in sql_search_related_keys:
2692
        key_list.append(key)
Aurel's avatar
Aurel committed
2693 2694
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2695
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2696
      self._objects[self.__class__.__name__+os.sep+'related_key_list'] = key_list
2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707

  def _importFile(self, file_name, file):
    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

2708
  def install(self, context, trashbin, **kw):
2709 2710 2711 2712 2713 2714 2715
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2716

2717
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2718
    if context.getTemplateFormatVersion() == 1:
2719
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2720
        return
2721 2722 2723
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2724
    else:
2725
      keys = self._archive.keys()
2726 2727
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
2728
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
2729
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
2730
      if not force:
Aurel's avatar
Aurel committed
2731 2732 2733 2734
        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
2735 2736 2737
        if action == 'nothing':
          return
      for key in keys:
2738 2739
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
2740
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
2741

2742 2743 2744
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2745
    except KeyError:
2746 2747 2748 2749
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2750
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2751
    object_path = kw.get('object_path', None)
2752 2753 2754 2755 2756
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2757 2758 2759 2760 2761
      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
2762
  # Function to generate XML Code Manually
2763
  def generateXml(self, path=None):
2764
    obj = self._objects[path]
2765
    xml_data = '<key_list>'
2766 2767
    obj.sort()
    for key in obj:
2768 2769 2770 2771
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2772 2773 2774 2775 2776 2777
  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():
2778
      xml_data = self.generateXml(path=path)
2779
      bta.addObject(obj=xml_data, name=path, path=None)
2780

2781 2782
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2783
  def build(self, context, **kw):
2784 2785
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2786
    except KeyError:
2787 2788 2789 2790
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2791
    sql_search_result_tables = list(catalog.sql_search_tables)
2792
    key_list = []
2793
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2794
      if key in sql_search_result_tables:
2795
        key_list.append(key)
Aurel's avatar
Aurel committed
2796 2797
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2798
    if len(key_list) > 0:
2799
      self._objects[self.__class__.__name__+os.sep+'result_table_list'] = key_list
2800 2801 2802 2803 2804 2805 2806 2807 2808 2809

  def _importFile(self, file_name, file):
    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
2810

2811
  def install(self, context, trashbin, **kw):
2812 2813 2814 2815 2816 2817 2818
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2819

2820
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2821
    if context.getTemplateFormatVersion() == 1:
2822
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2823
        return
2824 2825 2826
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2827
    else:
2828
      keys = self._archive.keys()
2829 2830
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2831
    # XXX same as related keys
Aurel's avatar
Aurel committed
2832
    if update_dict.has_key('result_table_list') or force:
2833
      if not force:
Aurel's avatar
Aurel committed
2834
        action = update_dict['result_table_list']
2835
        if action == 'nothing':
Aurel's avatar
Aurel committed
2836
          return
2837
      for key in keys:
2838 2839
        if key not in sql_search_tables:
          sql_search_tables.append(key)
2840
      catalog.sql_search_tables = tuple(sql_search_tables)
2841 2842

  def uninstall(self, context, **kw):
2843 2844
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2845
    except KeyError:
2846 2847 2848 2849 2850
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2851
    object_path = kw.get('object_path', None)
2852 2853 2854 2855 2856
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2857 2858
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2859
    catalog.sql_search_tables = sql_search_tables
2860 2861
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2862
  # Function to generate XML Code Manually
2863
  def generateXml(self, path=None):
2864
    obj = self._objects[path]
2865
    xml_data = '<key_list>'
2866 2867
    obj.sort()
    for key in obj:
2868
      xml_data += os.linesep+' <key>%s</key>' %(key)
2869
    xml_data += os.linesep+'</key_list>'
2870 2871
    return xml_data

Aurel's avatar
Aurel committed
2872 2873 2874 2875 2876 2877
  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():
2878
      xml_data = self.generateXml(path=path)
2879
      bta.addObject(obj=xml_data, name=path, path=None)
2880

2881 2882
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
2883 2884

  def build(self, context, **kw):
2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    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)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
2901

2902 2903 2904 2905 2906 2907 2908 2909 2910
  def _importFile(self, file_name, file):
    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
2911 2912

  def install(self, context, trashbin, **kw):
2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    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()
2930 2931
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951
    # 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):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
2952
    object_path = kw.get('object_path', None)
2953 2954
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
2955
    else:
2956 2957 2958 2959 2960 2961 2962
      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
2963
  # Function to generate XML Code Manually
2964 2965 2966 2967 2968 2969 2970 2971
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data
Aurel's avatar
Aurel committed
2972 2973 2974 2975

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
2976 2977 2978 2979 2980
    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)
2981

2982 2983
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
2984

2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001
  def build(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    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)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'ful_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3002

3003 3004 3005 3006 3007 3008 3009 3010 3011
  def _importFile(self, file_name, file):
    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
3012

3013 3014 3015 3016 3017 3018 3019 3020
  def install(self, context, trashbin, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3021

3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042
    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
3043

3044 3045 3046 3047 3048 3049 3050 3051 3052
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    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)
3053
    object_path = kw.get('object_path', None)
3054 3055 3056 3057 3058 3059 3060 3061 3062 3063
    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
3064
  # Function to generate XML Code Manually
3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</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)


# request
class CatalogRequestKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    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)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'request_key_list'] = key_list

  def _importFile(self, file_name, file):
    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):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    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):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
3155
    object_path = kw.get('object_path', None)
3156 3157 3158 3159 3160 3161 3162 3163 3164 3165
    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
3166
  # Function to generate XML Code Manually
3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</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)

# multivalue
class CatalogMultivalueKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    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)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'multivalue_key_list'] = key_list

  def _importFile(self, file_name, file):
    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):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    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):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
3255
    object_path = kw.get('object_path', None)
3256 3257 3258 3259 3260 3261 3262 3263 3264 3265
    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
3266
  # Function to generate XML Code Manually
3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</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)

# topic
class CatalogTopicKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    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)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'topic_key_list'] = key_list

  def _importFile(self, file_name, file):
    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):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    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):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    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)
3356
    object_path = kw.get('object_path', None)
3357 3358 3359 3360 3361 3362 3363 3364 3365 3366
    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
3367
  # Function to generate XML Code Manually
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</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 MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
    for lang in self._archive.keys():
      # Export only erp5_ui at the moment.
      # This is safer against information leak.
      for catalog in ('erp5_ui', ):
        path = os.path.join(lang, catalog)
        mc = localizer._getOb(catalog)
        self._objects[path] = mc.manage_export(lang)

  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':
3428
              continue
3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457
          path = string.split(path, '/')
          lang = path[-3]
          catalog = path[-2]
          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)
Aurel's avatar
Aurel committed
3458
      f = open(path+os.sep+'translation.po', 'wt')
3459 3460 3461 3462 3463 3464 3465
      f.write(str(obj))
      f.close()

  def _importFile(self, file_name, file):
    text = file.read()
    self._objects[file_name[:-3]]=text

Aurel's avatar
Aurel committed
3466 3467
class LocalRolesTemplateItem(BaseTemplateItem):

3468
  def __init__(self, id_list, **kw):
3469
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
3470 3471
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
3472 3473 3474
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
3475
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
3476 3477 3478 3479
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
      group_local_roles_dict = getattr(obj, '__ac_local_group_roles__',
                                        {}) or {}
Aurel's avatar
Aurel committed
3480 3481
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

Christophe Dumez's avatar
Christophe Dumez committed
3482
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509
  def generateXml(self, path=None):
    local_roles_dict, group_local_roles_dict = self._objects[path]
    local_roles_keys = local_roles_dict.keys()
    group_local_roles_keys = group_local_roles_dict.keys()
    local_roles_keys.sort()
    group_local_roles_keys.sort()
    # local roles
    xml_data = '<local_roles_item>'
    xml_data += os.linesep+' <local_roles>'
    for key in local_roles_keys:
      xml_data += os.linesep+"  <role id='%s'>" %(key,)
      tuple = local_roles_dict[key]
      for item in tuple:
        xml_data += os.linesep+"   <item>%s</item>" %(item,)
      xml_data += os.linesep+"  </role>"
    xml_data += os.linesep+' </local_roles>'
    # group local roles
    xml_data += os.linesep+' <group_local_roles>'
    for key in group_local_roles_keys:
      xml_data += os.linesep+"  <role id='%s'>" %(key,)
      tuple = group_local_roles_dict[key]
      for item in tuple:
        xml_data += os.linesep+"   <item>%s</item>" %(item,)
      xml_data += os.linesep+"  </role>"
    xml_data += os.linesep+' </group_local_roles>'
    xml_data += os.linesep+'</local_roles_item>'
    return xml_data
3510

Aurel's avatar
Aurel committed
3511 3512 3513 3514 3515 3516 3517 3518 3519 3520
  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)

      folders, id = os.path.split(key)
      encode_folders = []
3521
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
3522 3523 3524 3525
        if '%' not in folder:
          encode_folders.append(pathname2url(folder))
        else:
          encode_folders.append(folder)
3526
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
3527 3528 3529 3530 3531 3532 3533
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
    xml = parse(file)
    # local roles
    local_roles = xml.getElementsByTagName('local_roles')[0]
3534
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3535 3536 3537 3538 3539 3540 3541 3542 3543 3544
    local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
      item_type_list = []
      item_list = role.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      local_roles_dict[id] = item_type_list
    # group local roles
    group_local_roles = xml.getElementsByTagName('group_local_roles')[0]
3545
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578
    group_local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
      item_type_list = []
      item_list = role.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      group_local_roles_dict[id] = item_type_list
    self._objects['local_roles/'+file_name[:-4]] = (local_roles_dict, group_local_roles_dict)

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    p = context.getPortalObject()
    for roles_path in self._objects.keys():
      if update_dict.has_key(roles_path) or force:
        if not force:
          action = update_dict[roles_path]
          if action == 'nothing':
            continue
      path = roles_path.split('/')[1:]
      obj = p.unrestrictedTraverse(path)
      local_roles_dict, group_local_roles_dict = self._objects[roles_path]
      setattr(obj, '__ac_local_roles__', local_roles_dict)
      setattr(obj, '__ac_local_group_roles__', group_local_roles_dict)

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

3580 3581 3582
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
3583
    in part or completely. Each object is separated from its
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593
    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
3594 3595
      - object without optimal actions
      - list of relation between portal type and workflow
3596 3597 3598 3599 3600 3601 3602 3603 3604 3605

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

    - site property definition
      - id
      - type
3606
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3607

3608 3609
    - document/propertysheet/extension/test definition
      - copy of the local file
3610

3611
    - message transalation definition
3612
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3613

3614 3615
    The Business Template properties are exported to the bt folder with
    one property per file
3616

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3617 3618
    Technology:

3619 3620
    - 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
3621

3622
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3623 3624 3625 3626

    Use case:

    - install core ERP5 (the minimum)
3627

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

3630 3631
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
3632
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3633 3634 3635 3636 3637
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
3638
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3639 3640 3641 3642 3643
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
3644
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3645 3646 3647 3648 3649 3650 3651

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
3652
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3653
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3654
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3655 3656 3657
                      , PropertySheet.BusinessTemplate
                      )

3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674
    # 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."""
         , 'icon'           : 'order_line_icon.gif'
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
         , 'global_allow'   : 1
      }

3675 3676 3677 3678 3679
    # This is a global variable
    # Order is important for installation
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
3680
      '_constraint_item',
3681 3682 3683 3684 3685 3686 3687 3688
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
3689
      '_portal_type_workflow_chain_item',
3690 3691 3692 3693
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
3694 3695 3696
      '_category_item',
      '_module_item',
      '_skin_item',
3697
      '_path_item',
3698
      '_preference_item',
3699
      '_action_item',
3700
      '_portal_type_roles_item',
3701
      '_local_roles_item',
3702
      '_catalog_method_item',
3703 3704 3705
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
3706 3707 3708 3709 3710
      '_catalog_keyword_key_item',
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
3711 3712 3713 3714
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3715 3716 3717 3718 3719 3720
      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
3721
        self._baseGetTemplateFormatVersion()
3722

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3723 3724 3725
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
3726

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3727
      return 0
3728

3729
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
3730 3731 3732 3733 3734 3735 3736
    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".
3737 3738
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
3739
          # XXX Not good to access the attribute directly,
3740 3741 3742
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
3743

3744 3745
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
3746 3747 3748 3749 3750 3751
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

3752
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
3753 3754 3755 3756 3757 3758 3759 3760
        """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)
3761

3762
    security.declareProtected(Permissions.ManagePortal, 'build')
3763
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3764 3765 3766
      """
        Copy existing portal objects to self
      """
3767
      if no_action: return
3768
        # this is use at import of Business Template to get the status built
3769 3770
      # Make sure that everything is sane.
      self.clean()
3771

3772 3773 3774
      # Update revision number
      # <christophe@nexedi.com>
      self.updateRevisionNumber()
3775

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3776 3777
      self._setTemplateFormatVersion(1)

3778
      # Store all data
3779 3780
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
3781
      self._portal_type_workflow_chain_item = \
3782
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
3783 3784 3785 3786 3787 3788 3789 3790 3791 3792
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
3793 3794
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
3795 3796 3797 3798 3799 3800 3801 3802
      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())
3803 3804
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824
      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())
3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836
      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())
3837 3838
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
3839 3840
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
3841 3842
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
3843
               self.getTemplateCatalogKeywordKeyList())
3844 3845
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
3846
               self.getTemplateCatalogFullTextKeyList())
3847 3848
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
3849
               self.getTemplateCatalogRequestKeyList())
3850 3851
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
3852
               self.getTemplateCatalogMultivalueKeyList())
3853 3854 3855
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
3856 3857 3858
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
3859

3860 3861 3862
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
3863

3864
    build = WorkflowMethod(build)
3865 3866

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3867
      """
3868
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3869
      """
3870
      return self.portal_templates.publish(self, url, username=username,
3871
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3872

3873
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3874
      """
3875
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3876
      """
3877
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3878

3879 3880 3881 3882
    def preinstall(self, **kw):
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
3883
      """
3884

3885 3886
      modified_object_list = {}
      bt_title = self.getTitle()
3887 3888 3889 3890 3891 3892 3893

      #  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)
3894 3895 3896
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3897
        installed_bt_format = installed_bt.getTemplateFormatVersion()
3898

3899
      # if reinstall business template, must compare to object in ZODB
3900
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
3901
      # same if we make a diff and select only one business template
3902
      reinstall = 0
3903 3904
      if installed_bt == self:
        reinstall = 1
3905 3906 3907
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
3908 3909 3910
        bt2.edit(description='tmp bt generated for diff')
        bt2.build()
        installed_bt = bt2
3911

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3912
      new_bt_format = self.getTemplateFormatVersion()
3913 3914 3915 3916 3917 3918
      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:
3919
          item = getattr(self, item_name, None)
3920 3921 3922 3923
          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
3924

3925 3926 3927 3928
      # get the list of modified and new object
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
      for item_name in self._item_name_list:
3929
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3930
        old_item = getattr(installed_bt, item_name, None)
3931
        if new_item is not None:
3932
          if old_item is not None and hasattr(old_item, '_objects'):
3933 3934 3935 3936 3937 3938 3939 3940
            modified_object = new_item.preinstall(context=local_configuration, installed_bt=old_item)
            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:
3941
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
3942

3943 3944 3945 3946
      return modified_object_list

    def _install(self, force=1, object_to_update={}, **kw):
      """
Christophe Dumez's avatar
Christophe Dumez committed
3947
        Install a new Business Template, if force, all will be upgraded or installed
3948 3949
        otherwise depends of dict object_to_update
      """
3950

3951 3952
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
3953
      if installed_bt is not None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3954
        if installed_bt.getTemplateFormatVersion() == 0:
3955
          force = 1
3956
        installed_bt.replace(self)
3957

3958 3959 3960 3961
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

3962 3963 3964
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
3965

3966 3967 3968 3969 3970 3971
      site = self.getPortalObject()
      from Products.ERP5.ERP5Site import ERP5Generator
      gen = ERP5Generator()
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Activity Tool')
3972
        gen.setupLastTools(site, update=1, create_activities=1)
3973 3974
      if not force:
        if len(object_to_update) == 0:
3975 3976 3977 3978 3979
          # 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():
3980
            LOG('Business Template', 0, 'Updating Business Template Workflows')
3981
            gen.setupWorkflow(site)
3982
          return
3983 3984 3985 3986

      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
3987
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3988

3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001
      # 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
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates.objectIds()) > 1):
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
      if len(object_to_update) > 0 or force:
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
            item.install(local_configuration, force=force, object_to_update=object_to_update, trashbin=trashbin)
4002

4003 4004 4005
      # update catalog if necessary
      update_catalog=0
      catalog_method = getattr(self, '_catalog_method_item', None)
4006
      if catalog_method is not None and self.getTemplateFormatVersion() == 1:
4007 4008 4009 4010 4011 4012 4013 4014 4015
        for id in catalog_method._objects.keys():
          if id in object_to_update.keys() or force:
            if not force:
              action = object_to_update[id]
              if action == 'nothing':
                continue
            if 'related' not in id:
              # must update catalog
              update_catalog = 1
4016
              break
4017 4018
      if update_catalog:
        catalog = local_configuration.portal_catalog.getSQLCatalog()
4019
        if (catalog is None) or (not site.isIndexable):
4020 4021 4022 4023 4024
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4025

4026
      # get objects to remove
4027
      # do remove after because we may need backup object from installation
4028 4029 4030 4031 4032 4033 4034 4035 4036
      remove_object_dict = {}
      for path in object_to_update.keys():
        action = object_to_update[path]
        if action == 'remove' or action == 'save_and_remove':
          remove_object_dict[path] = action
          object_to_update.pop(path)
      # remove object from old business template
      if len(remove_object_dict) > 0:
        for item_name in installed_bt._item_name_list:
4037
          item = getattr(installed_bt, item_name, None)
4038 4039
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
4040

4041 4042 4043 4044 4045 4046 4047 4048

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

      # check if we have to updater business template workflow
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4049
        LOG('Business Template', 0, 'Updating Business Template Workflows')
4050 4051 4052 4053 4054 4055 4056
        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)

      if update_catalog:
        site.ERP5Site_reindexAll()
4057

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4058 4059 4060
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
4061

4062
    security.declareProtected(Permissions.ManagePortal, 'install')
4063 4064 4065
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4066
      """
4067
      return self._install(**kw)
4068

4069
    install = WorkflowMethod(install)
4070

4071
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4072
    def reinstall(self, **kw):
4073 4074 4075 4076
      """Reinstall Business Template.
      """
      return self._install(**kw)

4077
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4078

4079
    security.declareProtected(Permissions.ManagePortal, 'trash')
4080 4081
    def trash(self, new_bt, **kw):
      """
4082
        Trash unnecessary items before upgrading to a new business
4083
        template.
4084
        This is similar to uninstall, but different in that this does
4085
        not remove all items.
4086 4087 4088 4089 4090
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4091 4092
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4093
        item = getattr(self, item_name, None)
4094 4095 4096 4097
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
4098

4099
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
4100
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4101
      """
4102
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4103
      """
4104 4105 4106 4107
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4108 4109 4110
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4111
        item = getattr(self, item_name, None)
4112 4113
        if item is not None:
          item.uninstall(local_configuration)
4114
      # It is better to clear cache because the uninstallation of a
4115
      # template deletes many things from the portal.
4116
      clearCache()
4117

4118 4119
    uninstall = WorkflowMethod(uninstall)

4120
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4121
    def _clean(self):
4122
      """
4123
        Clean built information.
4124
      """
4125
      # First, remove obsolete attributes if present.
4126 4127 4128 4129
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4130
                    '_module_archive',
4131 4132 4133
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4134
                    '_property_sheet_archive'):
4135 4136 4137
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4138 4139
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4140

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

4143
    security.declareProtected(Permissions.AccessContentsInformation,
4144
                              'getBuildingState')
4145
    def getBuildingState(self, id_only=1):
4146
      """
4147
        Returns the current state in building
4148
      """
4149
      portal_workflow = getToolByName(self, 'portal_workflow')
4150 4151
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4152
      return wf._getWorkflowStateOf(self, id_only=id_only )
4153

4154
    security.declareProtected(Permissions.AccessContentsInformation,
4155
                              'getInstallationState')
4156
    def getInstallationState(self, id_only=1):
4157
      """
4158
        Returns the current state in installation
4159
      """
4160
      portal_workflow = getToolByName(self, 'portal_workflow')
4161 4162
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4163
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4164

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4165 4166 4167 4168 4169 4170
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4171
      export_string = portal_templates.manage_exportObject(
4172 4173
                                               id=self.getId(),
                                               toxml=1,
4174
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4175
      return export_string
4176

4177
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4178
      """
4179 4180
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4181
      """
4182
      result = getattr(self, id, ())
4183 4184 4185 4186
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4187
        # XXX Why do we need to return a tuple ?
4188 4189
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4190

4191
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4192
      """
4193 4194
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4195
      """
4196
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4197

4198
    def getTemplateBaseCategoryList(self):
4199
      """
4200 4201
      We have to set this method because we want an
      ordered list
4202
      """
4203
      return self._getOrderedList('template_base_category')
4204

4205
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4206
      """
4207 4208
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4209
      """
4210
      return self._getOrderedList('template_workflow_id')
4211

4212
    def getTemplatePortalTypeIdList(self):
4213
      """
4214 4215
      We have to set this method because we want an
      ordered list
4216
      """
4217
      return self._getOrderedList('template_portal_type_id')
4218

4219 4220 4221 4222 4223 4224 4225
    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
4226 4227 4228 4229 4230 4231 4232
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

4233 4234 4235 4236 4237 4238 4239
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

4240 4241 4242 4243 4244 4245
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4246

4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267
    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')

4268
    def getTemplateActionPathList(self):
4269
      """
4270 4271
      We have to set this method because we want an
      ordered list
4272
      """
4273
      return self._getOrderedList('template_action_path')
4274

4275 4276 4277 4278 4279 4280 4281
    def getTemplatePortalTypeRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_roles')

4282
    def getTemplateSkinIdList(self):
4283
      """
4284 4285
      We have to set this method because we want an
      ordered list
4286
      """
4287
      return self._getOrderedList('template_skin_id')
4288

4289
    def getTemplateModuleIdList(self):
4290
      """
4291 4292
      We have to set this method because we want an
      ordered list
4293
      """
4294
      return self._getOrderedList('template_module_id')
4295 4296 4297 4298 4299 4300 4301

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

4303
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
4304 4305 4306 4307
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
4308
      if self.getBuildingState() != 'built':
4309
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
4310
              'Business Template must be built before export'
4311 4312 4313
      if self.getInstallationState() == 'installed':
        raise TemplateConditionError, \
              'Can not export installed Business Template'
4314

Aurel's avatar
Aurel committed
4315 4316 4317 4318 4319 4320 4321
      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)

4322
      # export bt
4323
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
4324
      for prop in self.propertyMap():
4325
        prop_type = prop['type']
Aurel's avatar
Aurel committed
4326
        id = prop['id']
4327
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
4328
                  'install_object_list_list', 'id_generator'):
4329
          continue
Aurel's avatar
Aurel committed
4330
        value = self.getProperty(id)
4331
        if prop_type in ('text', 'string', 'int', 'boolean'):
4332
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
4333
        elif prop_type in ('lines', 'tokens'):
4334
          bta.addObject(obj=str(os.linesep).join(value), name=id,
4335
                        path=path+os.sep+'bt', ext='')
4336

Aurel's avatar
Aurel committed
4337 4338 4339
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
4340

Aurel's avatar
Aurel committed
4341 4342
      return bta.finishCreation()

4343
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
4344 4345
    def importFile(self, dir = 0, file=None, root_path=None):
      """
4346
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
4347 4348 4349 4350 4351
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
4352

Aurel's avatar
Aurel committed
4353 4354
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4355
      self._portal_type_workflow_chain_item = \
4356
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
4357 4358 4359 4360 4361 4362 4363 4364 4365 4366
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4367 4368
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
4369 4370 4371 4372 4373 4374 4375 4376
      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())
4377 4378
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400
      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())
4401 4402
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416
      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(
4417
               self.getTemplateCatalogKeywordKeyList())
4418 4419
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4420
               self.getTemplateCatalogFullTextKeyList())
4421 4422
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4423
               self.getTemplateCatalogRequestKeyList())
4424 4425
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4426
               self.getTemplateCatalogMultivalueKeyList())
4427 4428 4429
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4430 4431 4432
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
4433

Aurel's avatar
Aurel committed
4434 4435
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4436

4437 4438 4439 4440 4441 4442 4443 4444 4445
    #By christophe Dumez <christophe@nexedi.com>
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
        item = getattr(self, item_name)
        items_list.extend(item.getKeys())
      return items_list
4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470
    
    #By christophe Dumez <christophe@nexedi.com>
    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:
          dependency_couple_list = dependency_couple.split(' ')
          dependency = dependency_couple_list[0]
          version_restriction = None
          if len(dependency_couple_list) > 1:
            version_restriction = dependency_couple_list[1][1:-1]
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
                  or (version_restriction is not None and 
                     (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)
4471

Aurel's avatar
Aurel committed
4472
    def diffObject(self, REQUEST, **kw):
4473 4474
      """
        Make a diff between an object in the Business Template
4475
        and the same in the Business Template installed in the site
4476 4477 4478 4479
      """

      class_name_dict = {
        'Product' : '_product_item',
4480
        'PropertySheet' : '_property_sheet_item',
4481
        'Constraint' : '_constraint_item',
4482 4483 4484 4485 4486 4487 4488 4489 4490
        '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',
4491
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
4492 4493 4494 4495
        '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',
4496 4497 4498 4499
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
4500
        'Preference' : '_preference_item',
4501
        'Action' : '_action_item',
4502
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4503
        'LocalRoles' : '_local_roles_item',
4504 4505 4506
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4507 4508 4509 4510 4511
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
        'CatalogFullTextKey' : '_catalog_full_text_key_item',
        'CatalogRequestKey' : '_catalog_request_key_item',
        'CatalogMultivalueKey' : '_catalog_multivalue_key_item',
        'CatalogTopicKey' : '_catalog_topic_key_item',
4512
        }
4513

4514 4515
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
4516

Christophe Dumez's avatar
Christophe Dumez committed
4517
      # Get objects
4518
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4519

Aurel's avatar
Aurel committed
4520
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
4521
      # Compare with a given business template
4522
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
4523 4524
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
4525 4526
        if bt2_id == self.getId():
          compare_to_zodb = 1
4527
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
4528 4529
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
4530 4531 4532
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
4533 4534 4535
          compare_to_zodb = 1
      if compare_to_zodb:
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
Christophe Dumez's avatar
Christophe Dumez committed
4536
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
4537 4538 4539
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
4540

4541 4542
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
4543
      if compare_to_zodb:
Aurel's avatar
Aurel committed
4544
        # XXX maybe only build for the given object to gain time
4545
        installed_item.build(self)
4546 4547 4548
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
4549

Christophe Dumez's avatar
Christophe Dumez committed
4550
      # Real Zope Objects (can be exported into XML directly by Zope)
4551 4552
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
4553
                     '_category_item', '_path_item', '_preference_tem',
Christophe Dumez's avatar
Christophe Dumez committed
4554
                     '_skin_item', '_action_item',]
4555

Christophe Dumez's avatar
Christophe Dumez committed
4556
      # Not considered as objects by Zope (will be exported into XML manually)
4557
      # XXX Bad naming
4558
      item_list_2 = ['_site_property_item', '_module_item',
4559
                     '_catalog_result_key_item', '_catalog_related_key_item',
4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571
                     '_catalog_result_table_item',
                     '_catalog_keyword_key_item',
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
                     '_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',
4572
                     '_portal_type_workflow_chain_item',]
4573

Christophe Dumez's avatar
Christophe Dumez committed
4574
      # Text objects (no need to export them into XML)
4575
      # XXX Bad naming
4576 4577
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
4578
                     '_test_item', '_message_translation_item',]
4579

4580
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
4581 4582 4583
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
4584 4585
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
4586
        # XML Export in memory
4587 4588 4589
        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()
4590
        f1.close()
4591 4592 4593 4594
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
4595
        # End of XML export
4596

4597
        # Diff between XML objects
4598 4599
        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
4600
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4601 4602 4603
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4604

4605
      elif item_name in item_list_2:
4606
        # Generate XML code manually
4607 4608
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
4609 4610
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
4611
        # End of XML Code Generation
4612

4613
        # Diff between XML objects
4614 4615
        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
4616
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4617 4618 4619
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4620

4621
      elif item_name in item_list_3:
4622
        # Diff between text objects
4623 4624 4625 4626
        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
4627
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4628 4629
          diff_msg += '\n'.join(diff_list)
        else:
4630
          diff_msg = 'No diff'
4631

Christophe Dumez's avatar
Christophe Dumez committed
4632
      else: # Added By <christophe@nexedi.com>
4633
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
4634

4635 4636
      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4637

4638
      return diff_msg
4639

4640

4641 4642 4643 4644
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
4645 4646
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
4647 4648 4649 4650 4651 4652 4653
      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 [])
4654 4655
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

4656
      p = self.getPortalObject()
4657
      for id in bt_portal_types_id_list:
4658 4659
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
4660
          continue
4661
        if len(getattr(portal_type, '_roles', ())) > 0:
4662 4663
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
4664

4665 4666 4667 4668
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
4669
        action_list = []
4670 4671 4672 4673 4674 4675 4676
        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'):
4677
          base_category_list = portal_type.base_category_list
4678 4679
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
4680

4681 4682 4683 4684
        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)
4685

4686
        for h_id in hidden_content_type_list:
4687 4688 4689
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
4690

4691 4692 4693 4694
        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)
4695

4696 4697 4698 4699
        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)
4700

4701 4702 4703 4704
        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)
4705

4706 4707
        for workflow_id in [chain in wtool.getChainFor(id)
                                    if chain != '(Default)']:
4708 4709 4710
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
4711

4712 4713 4714 4715
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
4716
      bt_action_list.sort()
4717
      bt_wf_chain_list.sort()
4718

4719 4720 4721 4722 4723 4724 4725
      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)
4726 4727 4728 4729 4730 4731 4732 4733 4734
      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:
4735 4736
        raise TemplateConditionError, 'No module defined in business template'

4737 4738 4739 4740 4741 4742 4743 4744
      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:
4745
          return type_list
4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759

        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():
4760
            type_list.update(getChildPortalType(hidden_ptype_id))
4761
        return type_list
4762

4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836
      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

# 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)
4837

4838 4839 4840 4841 4842 4843 4844 4845

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

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