BusinessTemplate.py 181 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
  def install(self, context, trashbin, **kw):
867 868
    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 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          else:
            action = 'backup'
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
          obj = self._objects[path]
          obj = obj.__of__(category_tool)
          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
            container_url = '/'.join(container_path)
            if update_dict.has_key(container_url):
              if update_dict[container_url] == 'nothing':
895
                continue
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
            raise
          container_ids = container.objectIds()
          # Object already exists
          object_uid = None
          subobjects_dict = {}
          if category_id in container_ids:
            object_uid = container[category_id].getUid()
            subobjects_dict = self._backupObject(action, trashbin, container_path, category_id)
            container.manage_delObjects([category_id])
          category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
          if object_uid is not None:
            category.setUid(object_uid)
          for property in obj.propertyIds():
            if property not in ('id', 'uid'):
              category.setProperty(property, obj.getProperty(property, evaluate=0))
          # 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)
926
    else:
927
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
928 929 930 931
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      if light_install==0:
932
        ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
933
      else:
934
        for relative_url in self._archive.keys():
935
          obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
936
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
937
          obj = obj.__of__(category_tool)
Aurel's avatar
Aurel committed
938 939 940 941 942
          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
943 944
            # XXX call backup here
            subobjects_dict = self._backupObject('backup', trashbin, container_path, category_id)
945
            container.manage_delObjects([category_id])
946 947
          category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
          for property in obj.propertyIds():
Aurel's avatar
Aurel committed
948
            if property not in ('id', 'uid'):
949
              category.setProperty(property, obj.getProperty(property, evaluate=0))
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
          # 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)

966

967 968
class SkinTemplateItem(ObjectTemplateItem):

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

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

987
  def install(self, context, trashbin, **kw):
988
    ObjectTemplateItem.install(self, context, trashbin, **kw)
989 990
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
991 992 993 994 995
    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)
996
      for obj in folder.objectValues(spec=('Z SQL Method',)):
997 998
        if (obj.connection_id not in sql_connection_list) and \
           (len(sql_connection_list) != 0):
999
          obj.connection_id = sql_connection_list[0]
1000 1001 1002 1003 1004 1005
    # 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
1006
        if context.getTemplateFormatVersion() == 1:
1007 1008
          if update_dict.has_key(relative_url) or force:
            if not force:
1009
              if update_dict[relative_url] == 'nothing':
1010
                continue
1011
          obj = self._objects[relative_url]
1012
        else:
1013
          obj = self._archive[relative_url]
1014
        skin_id = relative_url.split('/')[-1]
1015
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
        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)
1029 1030 1031

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
1032 1033 1034 1035
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1036
      object_keys = self._archive.keys()
1037
    ps = context.portal_skins
1038
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
1039 1040 1041 1042 1043 1044 1045
    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)
1046
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
1047
    context.getPortalObject().changeSkin(None)
1048 1049 1050
    ObjectTemplateItem.uninstall(self, context, **kw)


1051
class WorkflowTemplateItem(ObjectTemplateItem):
1052

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

1056
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1057 1058
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1059 1060 1061
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
1062
        if installed_bt._objects.has_key(path):
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
          # 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']})
1079 1080 1081 1082 1083 1084 1085 1086
      # 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
1087
    if context.getTemplateFormatVersion() == 1:
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
      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:
1102
            action = 'backup'
1103 1104 1105 1106 1107 1108
          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
1109
            container_url = '/'.join(container_path)
1110 1111 1112 1113 1114 1115 1116 1117
            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])
1118
          obj = self._objects[path]
1119 1120 1121
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1122 1123 1124 1125 1126
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1127 1128 1129 1130
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1131 1132
class PortalTypeTemplateItem(ObjectTemplateItem):

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

  def build(self, context, **kw):
1140 1141
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1142 1143
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1144 1145 1146
      # remove actions and properties
      action_len = len(obj.listActions())
      obj.deleteActions(selections=range(action_len))
1147
      obj = self.removeProperties(obj)
1148 1149 1150 1151 1152 1153 1154 1155 1156
      # 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
1157 1158
      if hasattr(obj, '_roles'):
        setattr(obj, '_roles', [])
1159 1160
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1161

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

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

1213
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1214 1215

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

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

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

1360 1361
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1362

1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
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
1378
  # Function to generate XML Code Manually
1379
  def generateXml(self, path=None):
1380
    dictio = self._objects
1381
    xml_data = '<%s>' %(self.xml_tag,)
1382
    keys = dictio.keys()
1383 1384
    keys.sort()
    for key in keys:
1385
      allowed_list = dictio[key]
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
      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)

1402 1403 1404 1405 1406 1407
  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':
1408
        #must rename keys in dict if reinstall
1409 1410 1411 1412 1413 1414 1415 1416 1417
        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]
1418
          old_object = installed_bt._objects[path]
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
          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

1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
  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)
1457
        except AttributeError:
1458 1459 1460 1461 1462 1463 1464 1465
          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:
1466 1467
            if id not in property_list:
              property_list.append(id)
1468 1469
        setattr(portal_type, self.class_property, list(property_list))

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

1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
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'

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

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

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

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

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

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

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

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

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

Aurel's avatar
Aurel committed
1576
  def export(self, context, bta, **kw):
1577 1578 1579 1580 1581 1582 1583 1584
    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
1585 1586 1587 1588
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
1589
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1590 1591 1592 1593 1594 1595
      # 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()
1596 1597
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1598 1599
      # add all datas specific to catalog inside one file
      catalog = context.portal_catalog.getSQLCatalog()
1600
      method_id = obj.id
1601 1602
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

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

1606 1607 1608
      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,)
1609
        xml_data += os.linesep+' </item>'
1610

Aurel's avatar
Aurel committed
1611
      if catalog.filter_dict.has_key(method_id):
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
        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>'
1628
      xml_data += os.linesep+'</catalog_method>'
1629
      f.write(xml_data)
Aurel's avatar
Aurel committed
1630
      f.close()
1631

Christophe Dumez's avatar
Christophe Dumez committed
1632 1633 1634 1635 1636 1637 1638 1639 1640
  # 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
1641

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1827
class ActionTemplateItem(ObjectTemplateItem):
1828 1829

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

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

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

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

1953 1954
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1955 1956 1957 1958
    object_path = kw.get("object_path", None)
    if object_path is not None:
      keys = [object_path]
    else:
1959
      keys = self._archive.keys()
1960
    for id in keys:
1961 1962 1963 1964
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
        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 )
1976 1977
    BaseTemplateItem.uninstall(self, context, **kw)

1978 1979 1980
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
1981
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
    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
1994
        for property in ('id', 'title', 'description',
1995 1996 1997 1998
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
1999 2000 2001 2002
        # condition
        prop_value = getattr(role, 'condition')
        if prop_value:
          type_role_dict['condition'] = prop_value.text
2003 2004 2005 2006 2007 2008 2009 2010 2011
        # 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
2012
  # Function to generate XML Code Manually
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026
  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'):
2027
        for prop_value in role.get(property, []):
2028 2029 2030 2031 2032
          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
2033

2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046
  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)
2047
    xml_type_roles_list = xml.getElementsByTagName('role')
2048 2049 2050 2051 2052 2053 2054 2055
    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():
2056
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2057 2058 2059 2060 2061 2062 2063 2064 2065 2066
          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():
2067
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082
          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]
2083 2084 2085 2086 2087 2088
      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))
2089 2090 2091 2092 2093 2094 2095 2096

  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', [])

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

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

2114 2115 2116 2117 2118 2119
  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
2120 2121
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2122 2123 2124 2125 2126 2127 2128
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2129
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2130
      self._objects[str(id)] = (str(prop_type), value)
2131

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

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

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

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

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

Christophe Dumez's avatar
Christophe Dumez committed
2218
  # Function to generate XML Code Manually
2219
  def generateXml(self, path=None):
2220 2221
    dict = self._objects[path]
    xml_data = '<module>'
2222 2223 2224 2225
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2226 2227 2228 2229 2230
      if key =='permission_list':
        # separe permission dict into xml
        xml_data += os.linesep+' <%s>' %(key,)
        permission_list = dict[key]
        for perm in permission_list:
2231 2232 2233 2234 2235 2236
          # 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,)
2237
          xml_data += os.linesep+'   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2238
          role_list = list(perm[1])
2239
          role_list.sort()
2240 2241 2242 2243 2244 2245 2246 2247 2248
          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

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

2261
  def install(self, context, trashbin, **kw):
2262
    portal = context.getPortalObject()
2263 2264
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2265
    if context.getTemplateFormatVersion() == 1:
2266
      items = self._objects
2267
    else:
2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279
      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)
2280
          module.portal_type = str(mapping['portal_type'])
2281 2282 2283 2284 2285 2286 2287 2288 2289 2290
        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
2291 2292 2293 2294 2295 2296 2297 2298 2299 2300

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

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

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

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

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

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

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

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

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

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

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

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

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

Aurel's avatar
Aurel committed
2464

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

class RoleTemplateItem(BaseTemplateItem):

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

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

  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)

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

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

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

2577 2578
class CatalogResultKeyTemplateItem(BaseTemplateItem):

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

  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

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

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

2638
  def uninstall(self, context, **kw):
2639 2640
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2641
    except KeyError:
2642 2643 2644 2645 2646
      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)
2647
    object_path = kw.get('object_path', None)
2648 2649 2650 2651 2652
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2653 2654
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2655
    catalog.sql_search_result_keys = sql_search_result_keys
2656 2657
    BaseTemplateItem.uninstall(self, context, **kw)

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

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

2677 2678
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

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

  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

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

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

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

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

2780 2781
class CatalogResultTableTemplateItem(BaseTemplateItem):

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

  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
2809

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

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

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

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

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

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

  def build(self, context, **kw):
2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899
    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
2900

2901 2902 2903 2904 2905 2906 2907 2908 2909
  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
2910 2911

  def install(self, context, trashbin, **kw):
2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928
    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()
2929 2930
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950
    # 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)
2951
    object_path = kw.get('object_path', None)
2952 2953
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
2954
    else:
2955 2956 2957 2958 2959 2960 2961
      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
2962
  # Function to generate XML Code Manually
2963 2964 2965 2966 2967 2968 2969 2970
  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
2971 2972 2973 2974

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

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

2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000
  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
3001

3002 3003 3004 3005 3006 3007 3008 3009 3010
  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
3011

3012 3013 3014 3015 3016 3017 3018 3019
  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
3020

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

3043 3044 3045 3046 3047 3048 3049 3050 3051
  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)
3052
    object_path = kw.get('object_path', None)
3053 3054 3055 3056 3057 3058 3059 3060 3061 3062
    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
3063
  # Function to generate XML Code Manually
3064 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
  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)
3154
    object_path = kw.get('object_path', None)
3155 3156 3157 3158 3159 3160 3161 3162 3163 3164
    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
3165
  # Function to generate XML Code Manually
3166 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
  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)
3254
    object_path = kw.get('object_path', None)
3255 3256 3257 3258 3259 3260 3261 3262 3263 3264
    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
3265
  # Function to generate XML Code Manually
3266 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
  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)
3355
    object_path = kw.get('object_path', None)
3356 3357 3358 3359 3360 3361 3362 3363 3364 3365
    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
3366
  # Function to generate XML Code Manually
3367 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
  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':
3427
              continue
3428 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
          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
3457
      f = open(path+os.sep+'translation.po', 'wt')
3458 3459 3460 3461 3462 3463 3464
      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
3465 3466
class LocalRolesTemplateItem(BaseTemplateItem):

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

Aurel's avatar
Aurel committed
3471 3472 3473
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
3474
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
3475 3476 3477 3478
      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
3479 3480
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

Christophe Dumez's avatar
Christophe Dumez committed
3481
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
3482 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
  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
3509

Aurel's avatar
Aurel committed
3510 3511 3512 3513 3514 3515 3516 3517 3518 3519
  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 = []
3520
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
3521 3522 3523 3524
        if '%' not in folder:
          encode_folders.append(pathname2url(folder))
        else:
          encode_folders.append(folder)
3525
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
3526 3527 3528 3529 3530 3531 3532
      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]
3533
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3534 3535 3536 3537 3538 3539 3540 3541 3542 3543
    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]
3544
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3545 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
    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__', {})
3578

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

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

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

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

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

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

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

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

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

    Use case:

    - install core ERP5 (the minimum)
3626

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

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

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

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

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

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

3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673
    # 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
      }

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

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

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

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

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

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

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

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

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

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

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

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

3863
    build = WorkflowMethod(build)
3864 3865

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

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

3878 3879 3880 3881
    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
3882
      """
3883

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

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

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

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

3924 3925 3926 3927
      # 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:
3928
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3929
        old_item = getattr(installed_bt, item_name, None)
3930
        if new_item is not None:
3931
          if old_item is not None and hasattr(old_item, '_objects'):
3932 3933 3934 3935 3936 3937 3938 3939
            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:
3940
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
3941

3942 3943
      return modified_object_list

3944
    def _install(self, force=1, object_to_update=None, **kw):
3945
      """
Christophe Dumez's avatar
Christophe Dumez committed
3946
        Install a new Business Template, if force, all will be upgraded or installed
3947 3948
        otherwise depends of dict object_to_update
      """
3949 3950 3951 3952
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
3953

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

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

3965 3966 3967
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
3968

3969 3970 3971 3972 3973 3974
      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')
3975
        gen.setupLastTools(site, update=1, create_activities=1)
3976 3977
      if not force:
        if len(object_to_update) == 0:
3978 3979 3980 3981 3982
          # 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():
3983
            LOG('Business Template', 0, 'Updating Business Template Workflows')
3984
            gen.setupWorkflow(site)
3985
          return
3986 3987 3988 3989

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

3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004
      # 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)
4005

4006 4007 4008
      # update catalog if necessary
      update_catalog=0
      catalog_method = getattr(self, '_catalog_method_item', None)
4009
      if catalog_method is not None and self.getTemplateFormatVersion() == 1:
4010 4011 4012 4013 4014 4015 4016 4017 4018
        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
4019
              break
4020 4021
      if update_catalog:
        catalog = local_configuration.portal_catalog.getSQLCatalog()
4022
        if (catalog is None) or (not site.isIndexable):
4023 4024 4025 4026 4027
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4028

4029
      # get objects to remove
4030
      # do remove after because we may need backup object from installation
4031 4032 4033 4034 4035 4036 4037 4038 4039
      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:
4040
          item = getattr(installed_bt, item_name, None)
4041 4042
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
4043

4044 4045 4046 4047 4048 4049

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

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

4058 4059 4060 4061 4062
      # remove trashbin if empty
      if trashbin is not None:
        if len(trashbin.objectIds()) == 0:
          trash_tool.manage_delObjects([trashbin.getId(),])

4063 4064
      if update_catalog:
        site.ERP5Site_reindexAll()
4065

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4066 4067 4068
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
4069

4070
    security.declareProtected(Permissions.ManagePortal, 'install')
4071 4072 4073
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4074
      """
4075
      return self._install(**kw)
4076

4077
    install = WorkflowMethod(install)
4078

4079
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4080
    def reinstall(self, **kw):
4081 4082 4083 4084
      """Reinstall Business Template.
      """
      return self._install(**kw)

4085
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4086

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

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

4126 4127
    uninstall = WorkflowMethod(uninstall)

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

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

4151
    security.declareProtected(Permissions.AccessContentsInformation,
4152
                              'getBuildingState')
4153
    def getBuildingState(self, id_only=1):
4154
      """
4155
        Returns the current state in building
4156
      """
4157
      portal_workflow = getToolByName(self, 'portal_workflow')
4158 4159
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4160
      return wf._getWorkflowStateOf(self, id_only=id_only )
4161

4162
    security.declareProtected(Permissions.AccessContentsInformation,
4163
                              'getInstallationState')
4164
    def getInstallationState(self, id_only=1):
4165
      """
4166
        Returns the current state in installation
4167
      """
4168
      portal_workflow = getToolByName(self, 'portal_workflow')
4169 4170
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4171
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4172

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4173 4174 4175 4176 4177 4178
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4179
      export_string = portal_templates.manage_exportObject(
4180 4181
                                               id=self.getId(),
                                               toxml=1,
4182
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4183
      return export_string
4184

4185
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4186
      """
4187 4188
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4189
      """
4190
      result = getattr(self, id, ())
4191 4192 4193 4194
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4195
        # XXX Why do we need to return a tuple ?
4196 4197
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4198

4199
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4200
      """
4201 4202
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4203
      """
4204
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4205

4206
    def getTemplateBaseCategoryList(self):
4207
      """
4208 4209
      We have to set this method because we want an
      ordered list
4210
      """
4211
      return self._getOrderedList('template_base_category')
4212

4213
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4214
      """
4215 4216
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4217
      """
4218
      return self._getOrderedList('template_workflow_id')
4219

4220
    def getTemplatePortalTypeIdList(self):
4221
      """
4222 4223
      We have to set this method because we want an
      ordered list
4224
      """
4225
      return self._getOrderedList('template_portal_type_id')
4226

4227 4228 4229 4230 4231 4232 4233
    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
4234 4235 4236 4237 4238 4239 4240
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

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

4248 4249 4250 4251 4252 4253
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4254

4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275
    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')

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

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

4290
    def getTemplateSkinIdList(self):
4291
      """
4292 4293
      We have to set this method because we want an
      ordered list
4294
      """
4295
      return self._getOrderedList('template_skin_id')
4296

4297
    def getTemplateModuleIdList(self):
4298
      """
4299 4300
      We have to set this method because we want an
      ordered list
4301
      """
4302
      return self._getOrderedList('template_module_id')
4303 4304 4305 4306 4307 4308 4309

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

4311
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
4312 4313 4314 4315
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
4316
      if self.getBuildingState() != 'built':
4317
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
4318
              'Business Template must be built before export'
4319 4320 4321
      if self.getInstallationState() == 'installed':
        raise TemplateConditionError, \
              'Can not export installed Business Template'
4322

Aurel's avatar
Aurel committed
4323 4324 4325 4326 4327 4328 4329
      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)

4330
      # export bt
4331
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
4332
      for prop in self.propertyMap():
4333
        prop_type = prop['type']
Aurel's avatar
Aurel committed
4334
        id = prop['id']
4335
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
4336
                  'install_object_list_list', 'id_generator'):
4337
          continue
Aurel's avatar
Aurel committed
4338
        value = self.getProperty(id)
4339
        if prop_type in ('text', 'string', 'int', 'boolean'):
4340
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
4341
        elif prop_type in ('lines', 'tokens'):
4342
          bta.addObject(obj=str(os.linesep).join(value), name=id,
4343
                        path=path+os.sep+'bt', ext='')
4344

Aurel's avatar
Aurel committed
4345 4346 4347
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
4348

Aurel's avatar
Aurel committed
4349 4350
      return bta.finishCreation()

4351
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
4352 4353
    def importFile(self, dir = 0, file=None, root_path=None):
      """
4354
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
4355 4356 4357 4358 4359
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
4360

Aurel's avatar
Aurel committed
4361 4362
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4363
      self._portal_type_workflow_chain_item = \
4364
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
4365 4366 4367 4368 4369 4370 4371 4372 4373 4374
      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())
4375 4376
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
4377 4378 4379 4380 4381 4382 4383 4384
      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())
4385 4386
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408
      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())
4409 4410
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424
      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(
4425
               self.getTemplateCatalogKeywordKeyList())
4426 4427
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4428
               self.getTemplateCatalogFullTextKeyList())
4429 4430
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4431
               self.getTemplateCatalogRequestKeyList())
4432 4433
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4434
               self.getTemplateCatalogMultivalueKeyList())
4435 4436 4437
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4438 4439 4440
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
4441

Aurel's avatar
Aurel committed
4442 4443
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4444

4445 4446 4447 4448 4449 4450 4451 4452 4453
    #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
4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478
    
    #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)
4479

Aurel's avatar
Aurel committed
4480
    def diffObject(self, REQUEST, **kw):
4481 4482
      """
        Make a diff between an object in the Business Template
4483
        and the same in the Business Template installed in the site
4484 4485 4486 4487
      """

      class_name_dict = {
        'Product' : '_product_item',
4488
        'PropertySheet' : '_property_sheet_item',
4489
        'Constraint' : '_constraint_item',
4490 4491 4492 4493 4494 4495 4496 4497 4498
        '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',
4499
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
4500 4501 4502 4503
        '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',
4504 4505 4506 4507
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
4508
        'Preference' : '_preference_item',
4509
        'Action' : '_action_item',
4510
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4511
        'LocalRoles' : '_local_roles_item',
4512 4513 4514
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4515 4516 4517 4518 4519
        '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',
4520
        }
4521

4522 4523
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
4524

Christophe Dumez's avatar
Christophe Dumez committed
4525
      # Get objects
4526
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4527

Aurel's avatar
Aurel committed
4528
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
4529
      # Compare with a given business template
4530
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
4531 4532
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
4533 4534
        if bt2_id == self.getId():
          compare_to_zodb = 1
4535
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
4536 4537
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
4538 4539 4540
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
4541 4542 4543
          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
4544
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
4545 4546 4547
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
4548

4549 4550
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
4551
      if compare_to_zodb:
Aurel's avatar
Aurel committed
4552
        # XXX maybe only build for the given object to gain time
4553
        installed_item.build(self)
4554 4555 4556
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
4557

Christophe Dumez's avatar
Christophe Dumez committed
4558
      # Real Zope Objects (can be exported into XML directly by Zope)
4559 4560
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
4561
                     '_category_item', '_path_item', '_preference_tem',
Christophe Dumez's avatar
Christophe Dumez committed
4562
                     '_skin_item', '_action_item',]
4563

Christophe Dumez's avatar
Christophe Dumez committed
4564
      # Not considered as objects by Zope (will be exported into XML manually)
4565
      # XXX Bad naming
4566
      item_list_2 = ['_site_property_item', '_module_item',
4567
                     '_catalog_result_key_item', '_catalog_related_key_item',
4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579
                     '_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',
4580
                     '_portal_type_workflow_chain_item',]
4581

Christophe Dumez's avatar
Christophe Dumez committed
4582
      # Text objects (no need to export them into XML)
4583
      # XXX Bad naming
4584 4585
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
4586
                     '_test_item', '_message_translation_item',]
4587

4588
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
4589 4590 4591
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
4592 4593
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
4594
        # XML Export in memory
4595 4596 4597
        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()
4598
        f1.close()
4599 4600 4601 4602
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
4603
        # End of XML export
4604

4605
        # Diff between XML objects
4606 4607
        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
4608
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4609 4610 4611
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4612

4613
      elif item_name in item_list_2:
4614
        # Generate XML code manually
4615 4616
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
4617 4618
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
4619
        # End of XML Code Generation
4620

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

4629
      elif item_name in item_list_3:
4630
        # Diff between text objects
4631 4632 4633 4634
        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
4635
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4636 4637
          diff_msg += '\n'.join(diff_list)
        else:
4638
          diff_msg = 'No diff'
4639

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

4643 4644
      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4645

4646
      return diff_msg
4647

4648

4649 4650 4651 4652
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
4653 4654
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
4655 4656 4657 4658 4659 4660 4661
      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 [])
4662 4663
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

4664
      p = self.getPortalObject()
4665
      for id in bt_portal_types_id_list:
4666 4667
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
4668
          continue
4669
        if len(getattr(portal_type, '_roles', ())) > 0:
4670 4671
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
4672

4673 4674 4675 4676
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
4677
        action_list = []
4678 4679 4680 4681 4682 4683 4684
        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'):
4685
          base_category_list = portal_type.base_category_list
4686 4687
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
4688

4689 4690 4691 4692
        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)
4693

4694
        for h_id in hidden_content_type_list:
4695 4696 4697
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
4698

4699 4700 4701 4702
        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)
4703

4704 4705 4706 4707
        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)
4708

4709 4710 4711 4712
        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)
4713

4714
        for workflow_id in [chain for chain in wtool.getChainFor(id)
4715
                                    if chain != '(Default)']:
4716 4717 4718
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
4719

4720 4721 4722 4723
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
4724
      bt_action_list.sort()
4725
      bt_wf_chain_list.sort()
4726

4727 4728 4729 4730 4731 4732 4733
      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)
4734 4735 4736 4737 4738 4739 4740 4741 4742
      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:
4743 4744
        raise TemplateConditionError, 'No module defined in business template'

4745 4746 4747 4748 4749 4750 4751 4752
      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:
4753
          return type_list
4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767

        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():
4768
            type_list.update(getChildPortalType(hidden_ptype_id))
4769
        return type_list
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 4837 4838 4839 4840 4841 4842 4843 4844
      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)
4845

4846 4847 4848 4849 4850 4851 4852 4853

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

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