BusinessTemplate.py 170 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 65 66 67 68
from copy import deepcopy
from App.config import getConfiguration
import OFS.XMLExportImport
customImporters={
    XMLExportImport.magic: XMLExportImport.importXML,
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
69 70

from zLOG import LOG
Aurel's avatar
Aurel committed
71 72
from OFS.ObjectManager import customImporters
from gzip import GzipFile
73
from xml.dom.minidom import parse
74
from Products.CMFCore.Expression import Expression
Aurel's avatar
Aurel committed
75
import tarfile
76
from urllib import pathname2url, url2pathname
77
from difflib import unified_diff
Aurel's avatar
Aurel committed
78 79


Aurel's avatar
Aurel committed
80 81
catalog_method_list = ('_is_catalog_list_method_archive',
                       '_is_uncatalog_method_archive',
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
                       '_is_clear_method_archive', '_is_filtered_archive')

catalog_method_filter_list = ('_filter_expression_archive', '_filter_expression_instance_archive',
                              '_filter_type_archive')


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
109

110 111 112 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
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
139 140 141
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
142
  """
Aurel's avatar
Aurel committed
143 144 145 146 147 148 149 150 151 152 153 154

  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
155

Aurel's avatar
Aurel committed
156 157 158 159 160 161
  def finishCreation(self, **kw):
    pass

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

  def addFolder(self, name=''):
173
     if name !='':
Aurel's avatar
Aurel committed
174
      path = os.path.join(self.path, name)
175
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
176 177 178
        os.makedirs(path)
      return path

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

  def _initImport(self, file=None, path=None, **kw):
    self.file_list = file
193
    # to make id consistent, must remove a part of path while importing
194
    self.root_path_len = len(string.split(path, os.sep)) + 1
Aurel's avatar
Aurel committed
195

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

Aurel's avatar
Aurel committed
214 215 216 217 218 219
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
220
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
221 222 223 224 225
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
226
      removeAll(self.path)
Aurel's avatar
Aurel committed
227 228 229 230 231 232
      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
233
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
234 235
      os.makedirs(name)

236
  def addObject(self, obj, name, path=None, ext='.xml'):
237
    name = pathname2url(name)
Aurel's avatar
Aurel committed
238 239 240
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
241 242
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
243 244
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
245
    f.write(str(obj))
Aurel's avatar
Aurel committed
246 247 248 249 250
    f.close()

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
251
    removeAll(self.path)
Aurel's avatar
Aurel committed
252 253 254 255 256
    return self.fobj

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

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

285 286
class TemplateConditionError(Exception): pass

287 288
class TemplateConflictError(Exception): pass

289
class BaseTemplateItem(Implicit, Persistent):
290
  """
291
    This class is the base class for all template items.
292
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
293

294
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
295
    self.__dict__.update(kw)
296
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
297
    self._objects = PersistentMapping()
298 299 300 301 302 303 304
    for id in id_list:
      if not id: continue
      self._archive[id] = None

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

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

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

331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
  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)
346

347

348 349 350 351
  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
352
  def export(self, context, bta, **kw):
353
    pass
Aurel's avatar
Aurel committed
354 355

  def importFile(self, bta, **kw):
356
    bta.importFiles(klass=self)
357

358 359 360
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
361
    """
362 363 364 365 366 367 368
    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
369 370 371 372 373
    if getattr(obj, 'meta_type', None) == 'Script (Python)':
      if hasattr(aq_base(obj), '_code'):
        obj._code = None
    return obj

374 375 376
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
377
  """
378

379 380 381 382
  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()
383
      self._archive.clear()
384 385 386
      for id in id_list:
        self._archive["%s/%s" % (tool_id, id)] = None

387 388 389 390 391
  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():
392
      obj = self._objects[key]
393 394
      # create folder and subfolders
      folders, id = os.path.split(key)
Aurel's avatar
Aurel committed
395 396 397 398 399 400 401
      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))
402 403 404
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
405 406
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
407

Aurel's avatar
Aurel committed
408 409 410 411
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
412
      relative_url = '/'.join([url,id])
413 414
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
415
      obj = self.removeProperties(obj)
416
      id_list = obj.objectIds()
417
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
418
        # we must keep groups because it's ereased when we delete subobjects
419
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
420 421
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
422
        obj.manage_delObjects(list(id_list))
423
      if hasattr(aq_base(obj), 'groups'):
424 425 426
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
427 428
    return sub_list

429 430 431 432
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
433 434
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
435
      obj = self.removeProperties(obj)
436
      id_list = obj.objectIds()
437
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
438
        # we must keep groups because it's ereased when we delete subobjects
439
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
440 441
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
442
        obj.manage_delObjects(list(id_list))
443
      if hasattr(aq_base(obj), 'groups'):
444 445 446
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
447

448 449 450 451 452 453 454 455 456 457
  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
    obj = connection.importFile(file, customImporters=customImporters)
    self._objects[file_name[:-4]] = obj

458
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
459 460
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
461 462 463 464 465 466 467
      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]
468 469
          new_object = self.removeProperties(new_object)
          old_object = self.removeProperties(old_object)
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
          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
    """
493
    subobjects_dict = {}
494
    if trashbin is None: # must return subobjects
495 496 497 498 499 500
      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)
501
        subobjects_dict[subobject_id] = subobject_copy
502
      return subobjects_dict
503 504
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
505 506 507 508
      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
509

510 511 512
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
513
    if context.getTemplateFormatVersion() == 1:
514 515 516 517 518 519
      groups = {}
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
520 521 522 523 524 525 526
        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:
527
            action = 'backup'
528 529 530 531 532 533 534
          # get subobjects in path
          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
535
            container_url = '/'.join(container_path)
536 537 538 539 540 541 542 543 544 545 546
            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:
            subobjects_dict = self._backupObject(action, trashbin, container_path, object_id)
            container.manage_delObjects([object_id])
          # install object
547
          obj = self._objects[path]
548 549 550
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
551
          if hasattr(aq_base(obj), 'groups'):
552
            # we must keep original order groups because they change when we add subobjects
553
            groups[path] = deepcopy(obj.groups)
554
          # copy the object
555 556 557 558 559
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
          # if portal types upgrade, set backup properties
          if getattr(obj, 'meta_type', None) == 'ERP5 Type Information' and len(subobjects_dict) > 0:
            setattr(obj, 'allowed_content_types', subobjects_dict['allowed_content_type_list'] or [])
            setattr(obj, 'hidden_content_type_list', subobjects_dict['hidden_content_type_list'] or [])
            setattr(obj, 'property_sheet_list', subobjects_dict['property_sheet_list'] or [])
            setattr(obj, 'base_category_list', subobjects_dict['base_category_list'] or [])
            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
585
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
586
          # import sub objects if there is
587
          elif len(subobjects_dict) > 0:
588
            # get a jar
589 590
            connection = obj._p_jar
            o = obj
591
            while connection is None:
592 593
              o = o.aq_parent
              connection = o._p_jar
594 595 596 597 598
            # import subobjects
            for subobject_id in subobjects_dict.keys():
              subobject_data = subobjects_dict[subobject_id]
              subobject_data.seek(0)
              subobject = connection.importFile(subobject_data)
599
              if subobject_id not in obj.objectIds():
600
                obj._setObject(subobject_id, subobject)
601
          if obj.meta_type in ('Z SQL Method',):
602 603 604
            # 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',))
605 606
            if obj.connection_id not in sql_connection_list:
              obj.connection_id = sql_connection_list[0]
607 608
      # now put original order group
      for path in groups.keys():
609 610
        obj = portal.unrestrictedTraverse(path)
        obj.groups = groups[path]
Aurel's avatar
Aurel committed
611
    else:
612 613
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
614
      portal = context.getPortalObject()
615
      for relative_url in self._archive.keys():
616
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
617 618 619 620
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
621
        if object_id in container_ids:    # Object already exists
622
          self._backupObject('backup', trashbin, container_path, object_id)
623
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
624
        # Set a hard link
625 626 627 628 629 630
        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',):
631
          # It is necessary to make sure that the sql connection
Aurel's avatar
Aurel committed
632 633 634
          # in this method is valid.
          sql_connection_list = portal.objectIds(
                                   spec=('Z MySQL Database Connection',))
635 636
          if obj.connection_id not in sql_connection_list:
            obj.connection_id = sql_connection_list[0]
637 638 639

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
640
    trash = kw.get('trash', 0)
641 642 643 644 645
    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
646
      object_keys = self._archive.keys()
647
    for relative_url in object_keys:
648 649
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
650
      try:
651
        container = portal.unrestrictedTraverse(container_path)
652
        if trash and trashbin is not None:
653 654 655 656
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
        container.manage_delObjects([object_id])
      except (NotFound, KeyError):
        # object is already backup and/or removed
657
        pass
658 659
    BaseTemplateItem.uninstall(self, context, **kw)

660 661 662 663 664 665 666 667 668 669 670 671
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

672 673 674 675 676 677 678 679 680
  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()
681 682
    object_keys.sort()
    object_keys.reverse()
683
    p = context.getPortalObject()
684 685
    object_keys.sort()
    object_keys.reverse()
686 687
    for path in object_keys:
      for relative_url in self._resolvePath(p, [], path.split('/')):
688
        try:
Aurel's avatar
Aurel committed
689 690
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
691 692 693 694 695 696 697 698 699
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
            self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

700 701 702
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
703

704 705 706 707 708 709 710 711 712
      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.
713 714 715 716 717 718 719
      try:
        obj = folder._getOb(id)
      except AttributeError:
        # XXX FIXME 
        LOG("WARNING!", 100,
            "Can not resolve '%s' during business template installation." % id)
        return []
720
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
721 722
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
723 724
      if object_id != "":
        path_list.extend(self._resolvePath(folder._getOb(object_id), relative_url_list + [object_id], id_list[1:]))
725
    return path_list
Aurel's avatar
Aurel committed
726

727 728 729
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
730
    keys = self._path_archive.keys()
731
    keys.sort()
Aurel's avatar
Aurel committed
732
    for path in keys:
733 734 735
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
736
      for relative_url in self._resolvePath(p, [], path.split('/')):
737 738
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
739
        obj = obj.__of__(context)
740
        id_list = obj.objectIds()
741
        obj = self.removeProperties(obj)
742
        if hasattr(aq_base(obj), 'groups'):
743
          # we must keep groups because it's ereased when we delete subobjects
744
          groups = deepcopy(obj.groups)
745
        if len(id_list) > 0:
746 747
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
748
          obj.manage_delObjects(list(id_list))
749
        if hasattr(aq_base(obj), 'groups'):
750 751 752
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
753

754 755
class CategoryTemplateItem(ObjectTemplateItem):

756 757
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
758

759 760 761 762
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
763 764
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
765
      obj = self.removeProperties(obj)
766
      id_list = obj.objectIds()
767 768
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
769 770 771
        obj.manage_delObjects(list(id_list))
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
772 773 774 775 776

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
777 778
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
779
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
780
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
781
      id_list = obj.objectIds()
782 783
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
784
        obj.manage_delObjects(list(id_list))
785
      else:
786 787 788
        obj.manage_delObjects(list(id_list))
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
789

790 791 792
  def install(self, context, trashbin, light_install = 0, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
793
    if context.getTemplateFormatVersion() == 1:
794 795
      if light_install == 0:
        ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
796 797 798 799 800 801 802
      else:
        portal = context.getPortalObject()
        category_tool = portal.portal_categories
        tool_id = self.tool_id
        keys = self._objects.keys()
        keys.sort()
        for path in keys:
803 804 805 806 807 808
          if update_dict.has_key(path) or force:
            if not force:
              action = update_dict[path]
              if action == 'nothing':
                continue
            else:
809
              action = 'backup'
810
            # Wrap the object by an aquisition wrapper for _aq_dynamic.
811 812
            obj = self._objects[path]
            obj = obj.__of__(category_tool)
813 814 815 816 817 818
            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
819
              container_url = '/'.join(container_path)
820 821 822 823
              if update_dict.has_key(container_url):
                if update_dict[container_url] == 'nothing':
                  continue
              raise
824
            container_ids = container.objectIds()
825 826 827 828
            # Object already exists
            if category_id in container_ids:
              subobjects_dict = self._backupObject(action, trashbin, container_path, category_id)
              container.manage_delObjects([category_id])
829 830
            category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
            for property in obj.propertyIds():
831
              if property not in ('id', 'uid'):
832
                category.setProperty(property, obj.getProperty(property, evaluate=0))
833 834 835
            # import sub objects if there is
            if len(subobjects_dict) > 0:
              # get a jar
836 837
              connection = obj._p_jar
              o = category
838
              while connection is None:
839 840
                o = o.aq_parent
                connection = o._p_jar
841 842 843 844 845 846 847
              # 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)
848
    else:
849
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
850 851 852 853
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      if light_install==0:
854
        ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
855
      else:
856
        for relative_url in self._archive.keys():
857
          obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
858
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
859
          obj = obj.__of__(category_tool)
Aurel's avatar
Aurel committed
860 861 862 863 864
          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
865 866
            # XXX call backup here
            subobjects_dict = self._backupObject('backup', trashbin, container_path, category_id)
867
            container.manage_delObjects([category_id])
868 869
          category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
          for property in obj.propertyIds():
Aurel's avatar
Aurel committed
870
            if property not in ('id', 'uid'):
871
              category.setProperty(property, obj.getProperty(property, evaluate=0))
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
          # 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)

888

889 890
class SkinTemplateItem(ObjectTemplateItem):

891 892
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
893

894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
  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

909
  def install(self, context, trashbin, **kw):
910
    ObjectTemplateItem.install(self, context, trashbin, **kw)
911 912
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
913 914 915 916 917
    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)
918 919 920
      for obj in folder.objectValues(spec=('Z SQL Method',)):
        if obj.connection_id not in sql_connection_list:
          obj.connection_id = sql_connection_list[0]
921 922 923 924 925 926
    # 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
927
        if context.getTemplateFormatVersion() == 1:
928 929
          if update_dict.has_key(relative_url) or force:
            if not force:
930
              if update_dict[relative_url] == 'nothing':
931
                continue
932
          obj = self._objects[relative_url]
933
        else:
934
          obj = self._archive[relative_url]
935
        skin_id = relative_url.split('/')[-1]
936
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
937 938 939 940 941 942 943 944 945 946 947 948 949
        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)
950 951 952

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
953 954 955 956
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
957
      object_keys = self._archive.keys()
958
    ps = context.portal_skins
959
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
960 961 962 963 964 965 966
    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)
967
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
968
    context.getPortalObject().changeSkin(None)
969 970 971
    ObjectTemplateItem.uninstall(self, context, **kw)


972
class WorkflowTemplateItem(ObjectTemplateItem):
973

974 975
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
976

977
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
978 979
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
980 981 982
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
983
        if installed_bt._objects.has_key(path):
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
          # 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']})
1000 1001 1002 1003 1004 1005 1006 1007
      # 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
1008
    if context.getTemplateFormatVersion() == 1:
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
      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:
1023
            action = 'backup'
1024 1025 1026 1027 1028 1029
          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
1030
            container_url = '/'.join(container_path)
1031 1032 1033 1034 1035 1036 1037 1038
            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])
1039
          obj = self._objects[path]
1040 1041 1042
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1043 1044 1045 1046 1047
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1048 1049 1050 1051
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1052 1053
class PortalTypeTemplateItem(ObjectTemplateItem):

1054 1055
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1056 1057
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1058 1059 1060
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1061 1062
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1063 1064
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1065 1066 1067
      # remove actions and properties
      action_len = len(obj.listActions())
      obj.deleteActions(selections=range(action_len))
1068
      obj = self.removeProperties(obj)
1069 1070 1071 1072 1073 1074 1075 1076 1077
      # 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
1078 1079
      if hasattr(obj, '_roles'):
        setattr(obj, '_roles', [])
1080 1081
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1082

1083 1084
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1085 1086 1087 1088
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1089 1090
    # We now need to setup the list of workflows corresponding to
    # each portal type
1091
    (default_chain, chain_dict) = getChainByType(context)
1092 1093 1094
    # Set the default chain to the empty string is probably the
    # best solution, by default it is 'default_workflow', wich is
    # not very usefull
1095
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1096
    if context.getTemplateFormatVersion() == 1:
1097
      object_list = self._objects
1098
    else:
1099 1100
      object_list = self._archive
    for path in object_list.keys():
1101 1102 1103 1104
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1105
            continue
1106 1107
        obj = object_list[path]
        portal_type = obj.id
1108 1109 1110
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1111 1112
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1113

1114 1115
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1116 1117 1118 1119 1120 1121 1122
  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:
1123
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1124 1125 1126 1127 1128
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1129
        dict[str(ptype)] = str(workflow)
1130 1131 1132 1133
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1134
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1135 1136 1137

  def build(self, context, **kw):
    p = context.getPortalObject()
1138
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1139
    for key in self._archive.keys():
1140 1141 1142
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1143
        workflow = wflist[1]
1144
      else:
Aurel's avatar
Aurel committed
1145
        portal_type = wflist[0][:-2]
1146 1147 1148
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
        if workflow not in chain_dict['chain_%s' % portal_type]:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1149 1150
          raise NotFound, 'workflow %s not found in chain for portal_type %s'\
        % (workflow, portal_type)
1151 1152 1153 1154 1155
        if self._objects.has_key(portal_type):
          workflow_list = self._objects[portal_type]
          workflow_list.append(workflow)
          self._objects[portal_type] = workflow_list
        else:
1156
          self._objects[portal_type] = [workflow,]
1157
      else:
Aurel's avatar
Aurel committed
1158
        LOG('BusinessTemplate build', 100, 'portal type %s not found in workflow chain' %(portal_type))
1159

Christophe Dumez's avatar
Christophe Dumez committed
1160
  # Function to generate XML Code Manually
1161 1162 1163 1164 1165
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1166
      workflow_list = self._objects[key]
1167 1168
      xml_data += os.linesep+' <chain>'
      xml_data += os.linesep+'  <type>%s</type>' %(key,)
1169
      xml_data += os.linesep+'  <workflow>%s</workflow>' %(', '.join(workflow_list))
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
      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
1188
    (default_chain, chain_dict) = getChainByType(context)
1189
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1190
    # best solution, by default it is 'default_workflow', which is
1191 1192 1193 1194 1195 1196 1197
    # 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':
1198
            continue
1199
        portal_type = path.split('/', 1)[1]
1200
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1201 1202 1203
          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 != '':
1204 1205 1206 1207 1208 1209 1210 1211
            # unique workflow chains
            old_chain_workflow_id_set = {}
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
            for wf_id in self._objects[path].split(', '):
              old_chain_workflow_id_set[wf_id] = 1
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1212
          else:
1213
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1214 1215
        else:
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)

  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
1231 1232
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1233 1234 1235
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1236 1237
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1238

1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
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
1254
  # Function to generate XML Code Manually
1255
  def generateXml(self, path=None):
1256
    dictio = self._objects
1257
    xml_data = '<%s>' %(self.xml_tag,)
1258
    keys = dictio.keys()
1259 1260
    keys.sort()
    for key in keys:
1261
      allowed_list = dictio[key]
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
      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)

1278 1279 1280 1281 1282 1283
  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':
1284
        #must rename keys in dict if reinstall
1285 1286 1287 1288 1289 1290 1291 1292 1293
        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]
1294
          old_object = installed_bt._objects[path]
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
          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

1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
  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)
1333
        except AttributeError:
1334 1335 1336 1337 1338 1339 1340 1341
          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:
1342 1343
            if id not in property_list:
              property_list.append(id)
1344 1345
        setattr(portal_type, self.class_property, list(property_list))

Aurel's avatar
Aurel committed
1346
  def uninstall(self, context, **kw):
1347
    object_path = kw.get('object_path', None)
1348
    p = context.getPortalObject()
1349
    pt = p.unrestrictedTraverse('portal_types')
1350 1351 1352 1353 1354 1355 1356 1357
    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)
1358
      except AttributeError:
1359 1360 1361
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
1362 1363
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
1364 1365
      for id in property_list:
        if id in original_property_list:
1366
          original_property_list.remove(id)
1367
      setattr(portal_type, self.class_property, list(original_property_list))
1368

1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
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'

1384 1385
class CatalogMethodTemplateItem(ObjectTemplateItem):

1386 1387
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1388
    self._is_catalog_list_method_archive = PersistentMapping()
1389 1390 1391 1392 1393 1394 1395 1396 1397
    self._is_uncatalog_method_archive = PersistentMapping()
    self._is_clear_method_archive = PersistentMapping()
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1398 1399 1400
    self._check_catalog(context)

  def _check_catalog(self, context):
1401 1402
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1403 1404
    except KeyError:
      catalog = None
1405
    if catalog is None:
1406
      LOG('BusinessTemplate build', 0, 'catalog not found')
1407
      return
1408 1409
    for obj in self._objects.values():
      method_id = obj.id
1410 1411 1412
      self._is_catalog_list_method_archive[method_id] = method_id in catalog.sql_catalog_object_list
      self._is_uncatalog_method_archive[method_id] = method_id in catalog.sql_uncatalog_object
      self._is_clear_method_archive[method_id] = method_id in catalog.sql_clear_catalog
1413
      self._is_filtered_archive[method_id] = 0
1414 1415 1416 1417 1418
      if catalog.filter_dict.has_key(method_id):
        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']
1419

Aurel's avatar
Aurel committed
1420 1421 1422 1423 1424
  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():
1425
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1426 1427 1428 1429 1430 1431
      # 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()
1432 1433
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1434 1435
      # add all datas specific to catalog inside one file
      catalog = context.portal_catalog.getSQLCatalog()
1436
      method_id = obj.id
1437 1438
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1439
      f = open(object_path, 'wt')
1440 1441 1442
      xml_data = '<catalog_method>'
      for method in catalog_method_list:
        value = getattr(self, method, 0)[method_id]
1443
        xml_data += os.linesep+' <item key="%s" type="int">' %(method,)
1444
        xml_data += os.linesep+'  <value>%s</value>' %(str(int(value)))
1445
        xml_data += os.linesep+' </item>'
Aurel's avatar
Aurel committed
1446
      if catalog.filter_dict.has_key(method_id):
1447 1448 1449
        for method in catalog_method_filter_list:
          value = getattr(self, method, '')[method_id]
          if method == '_filter_expression_instance_archive':
1450
            pass
1451
          else:
1452
            if type(value) in (type(''), type(u'')):
1453
              xml_data += os.linesep+' <item key="%s" type="str">' %(method,)
1454
              xml_data += os.linesep+'  <value>%s</value>' %(str(value))
1455
              xml_data += os.linesep+' </item>'
1456
            elif type(value) in (type(()), type([])):
1457
              xml_data += os.linesep+' <item key="%s" type="tuple">'%(method)
1458 1459
              for item in value:
                xml_data += os.linesep+'  <value>%s</value>' %(str(item))
1460
              xml_data += os.linesep+' </item>'
1461 1462
      xml_data += os.linesep+'</catalog_method>'
      f.write(str(xml_data))
Aurel's avatar
Aurel committed
1463
      f.close()
Christophe Dumez's avatar
Christophe Dumez committed
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473
      
  # 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
1474

1475 1476
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1477
    self._check_catalog(context)
1478 1479
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1480
    except KeyError:
1481 1482 1483 1484 1485 1486 1487 1488
      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)
1489

1490 1491 1492
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1493
    new_bt_format = context.getTemplateFormatVersion()
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509

    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':
1510
              continue
1511 1512 1513 1514
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
1515

1516 1517
    for obj in values:
      method_id = obj.id
1518

Aurel's avatar
Aurel committed
1519 1520 1521 1522
      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])
      is_filtered = int(self._is_filtered_archive[method_id])
1523

1524 1525 1526 1527 1528
      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)

1529
      if is_uncatalog_method and method_id not in sql_uncatalog_object:
1530
        sql_uncatalog_object.append(method_id)
1531
      elif not is_uncatalog_method and method_id in sql_uncatalog_object:
1532 1533 1534 1535 1536 1537 1538 1539
        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)

      if is_filtered:
1540
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1541
        if context.getTemplateFormatVersion() == 1:
1542 1543 1544
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1545
        filter_type = self._filter_type_archive[method_id]
1546 1547 1548
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1549
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1550
        catalog.filter_dict[method_id]['type'] = filter_type
1551
      elif method_id in catalog.filter_dict.keys():
1552
        catalog.filter_dict[method_id]['filtered'] = 0
1553

1554 1555
    sql_catalog_object_list.sort()
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
1556
    sql_uncatalog_object.sort()
1557
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
1558
    sql_clear_catalog.sort()
1559
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1560 1561

  def uninstall(self, context, **kw):
1562 1563
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1564
    except KeyError:
1565 1566 1567 1568
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1569

1570 1571 1572 1573
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
1574 1575 1576 1577
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
1578 1579 1580 1581
    else:
      value = self._archive[object_path]
      if value is not None:
        values.append(value)
1582 1583 1584 1585
    # 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)
1586

1587
    for obj in values:
1588
      method_id = obj.id
1589 1590
      if method_id in sql_catalog_object_list:
        sql_catalog_object_list.remove(method_id)
1591 1592 1593 1594
      if method_id in sql_uncatalog_object:
        sql_uncatalog_object.remove(method_id)
      if method_id in sql_clear_catalog:
        sql_clear_catalog.remove(method_id)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1595
      if catalog.filter_dict.has_key(method_id):
1596
        del catalog.filter_dict[method_id]
1597

1598 1599 1600
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1601
    # uninstall objects
1602
    ObjectTemplateItem.uninstall(self, context, **kw)
1603

1604
  def _importFile(self, file_name, file):
1605
    if not '.catalog_keys' in file_name:
1606 1607 1608 1609 1610 1611 1612 1613
      # 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
1614
    elif '.catalog_keys' in file_name:
1615 1616 1617 1618
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1619
      method_list = xml.getElementsByTagName('item')
1620
      for method in method_list:
1621
        key = method.getAttribute('key')
1622 1623
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1624 1625
          value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          key = str(key)
1626
        elif key_type == "int":
1627
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1628
          key = str(key)
1629
        elif key_type == "tuple":
1630 1631 1632 1633
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1634
        else:
1635
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1636
          continue
1637 1638 1639
        if key in catalog_method_list or key in catalog_method_filter_list:
          dict = getattr(self, key)
          dict[id] = value
1640 1641

class ActionTemplateItem(ObjectTemplateItem):
1642 1643

  def __init__(self, id_list, **kw):
1644
    # XXX It's look like ObjectTemplateItem __init__
1645 1646 1647 1648 1649 1650
    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

1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
  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

1672 1673 1674 1675
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1676
      relative_url, value = id.split(' | ')
1677 1678
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1679
        if getattr(ai, 'id') == value:
1680
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1681
          key = os.path.join(url[-2], url[-1], value)
1682
          action = ai._getCopy(context)
1683
          action = self.removeProperties(action)
1684
          self._objects[key] = action
Aurel's avatar
Aurel committed
1685
          self._objects[key].wl_clearLocks()
1686 1687
          break
      else:
1688
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1689

1690 1691 1692
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1693
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1694 1695
      p = context.getPortalObject()
      for id in self._objects.keys():
1696 1697 1698 1699 1700 1701
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
1702 1703
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
1704
          for index in range(len(action_list)):
1705
            if getattr(action_list[index], 'id') == path[-1]:
1706
              # remove previous action
1707
              obj.deleteActions(selections=(index,))
1708
          action = self._objects[id]
1709 1710 1711
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
1712
          obj.addAction(
1713 1714
                        id = action.id
                      , name = action.title
1715
                      , action = action_text
1716 1717 1718 1719 1720 1721
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
                      , icon = getattr(action, 'icon', None) and action.icon.text or ''
                      , optional = getattr(action, 'optional', 0)
1722
                      , priority = action.priority
Aurel's avatar
Aurel committed
1723
                    )
1724
          # sort action based on the priority define on it
1725 1726 1727 1728 1729 1730 1731 1732 1733
          # 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
1734
    else:
1735
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1736
      p = context.getPortalObject()
1737 1738
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
1739
        relative_url, key, value = self._splitPath(id)
1740 1741
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
1742
          if getattr(ai, key) == value:
1743
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
1744 1745 1746
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
1747
        obj.addAction(
Aurel's avatar
Aurel committed
1748 1749
                      id = action.id
                    , name = action.title
1750
                    , action = action_text
Aurel's avatar
Aurel committed
1751 1752 1753 1754 1755 1756 1757
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
                    , icon = getattr(action, 'icon', None) and action.icon.text or ''
                    , optional = getattr(action, 'optional', 0)
                    )
Aurel's avatar
Aurel committed
1758 1759 1760 1761 1762 1763 1764
        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))
1765 1766
          obj.moveDownActions(selections=tuple(move_down_list))

1767 1768
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1769 1770 1771 1772
    object_path = kw.get("object_path", None)
    if object_path is not None:
      keys = [object_path]
    else:
1773
      keys = self._archive.keys()
1774
    for id in keys:
1775 1776 1777 1778
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
        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 )
1790 1791
    BaseTemplateItem.uninstall(self, context, **kw)

1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
    id_list = ['portal_type_roles/%s' % id for id in id_list]
    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
1808
        for property in ('id', 'title', 'description',
1809 1810 1811 1812
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
1813 1814 1815 1816
        # condition
        prop_value = getattr(role, 'condition')
        if prop_value:
          type_role_dict['condition'] = prop_value.text
1817 1818 1819 1820 1821 1822 1823 1824 1825
        # 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
1826
  # Function to generate XML Code Manually
1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846
  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'):
        for prop_value in role.get(property):
          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
1847

1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860
  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)
1861
    xml_type_roles_list = xml.getElementsByTagName('role')
1862 1863 1864 1865 1866 1867 1868 1869
    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():
1870
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
1871 1872 1873 1874 1875 1876 1877 1878 1879 1880
          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():
1881
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
          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]
      obj = p.unrestrictedTraverse(path)
      setattr(obj, '_roles', []) # reset roles before applying
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1899
      type_roles_list = self._objects[roles_path] or []
1900 1901 1902 1903 1904 1905 1906 1907 1908 1909
      for type_role_property_dict in type_roles_list:
        obj._roles.append(RoleInformation(**type_role_property_dict))

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

1910 1911 1912 1913 1914 1915
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1916 1917
      for property in p.propertyMap():
        if property['id'] == id:
1918
          obj = p.getProperty(id)
1919
          prop_type = property['type']
1920 1921
          break
      else:
1922 1923
        obj = None
      if obj is None:
1924
        raise NotFound, 'the property %s is not found' % id
1925
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
1926

1927 1928 1929 1930 1931 1932
  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
1933 1934
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
1935 1936 1937 1938 1939 1940 1941
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
1942
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
1943
      self._objects[str(id)] = (str(prop_type), value)
1944

1945 1946 1947
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1948
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1949 1950
      p = context.getPortalObject()
      for path in self._objects.keys():
1951 1952 1953 1954
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
1955
              continue
1956 1957 1958
          dir, id = os.path.split(path)
          if p.hasProperty(id):
            continue
1959 1960
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
1961
    else:
1962
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1963
      p = context.getPortalObject()
1964 1965
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
1966 1967 1968 1969 1970
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
1971 1972 1973

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1974 1975 1976 1977 1978 1979
    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:
1980 1981 1982 1983
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
1984
  # Function to generate XML Code Manually
1985
  def generateXml(self, path=None):
1986
    xml_data = ''
1987
    prop_type, obj = self._objects[path]
1988 1989
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
1990 1991
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
1992
      xml_data += os.linesep+'  <value>'
1993
      for item in obj:
1994 1995 1996 1997
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
1998
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
1999
    xml_data += os.linesep+' </property>'
2000 2001
    return xml_data

Aurel's avatar
Aurel committed
2002 2003 2004 2005 2006
  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)
2007 2008 2009 2010
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2011
      xml_data += self.generateXml(path)
2012
    xml_data += os.linesep+'</site_property>'
2013
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2014

2015 2016 2017 2018 2019 2020 2021
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)
2022 2023 2024 2025 2026 2027 2028 2029
      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
2030

Christophe Dumez's avatar
Christophe Dumez committed
2031
  # Function to generate XML Code Manually
2032
  def generateXml(self, path=None):
2033 2034
    dict = self._objects[path]
    xml_data = '<module>'
2035 2036 2037 2038
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2039 2040 2041 2042 2043 2044 2045
      if key =='permission_list':
        # separe permission dict into xml
        xml_data += os.linesep+' <%s>' %(key,)
        permission_list = dict[key]
        for perm in permission_list:
          xml_data += os.linesep+'  <permission>'
          xml_data += os.linesep+'   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2046
          role_list = list(perm[1])
2047
          role_list.sort()
2048 2049 2050 2051 2052 2053 2054 2055 2056
          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

2057 2058 2059 2060 2061
  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)
2062 2063 2064
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
2065
      # expor module one by one
2066
      xml_data = self.generateXml(path=id)
2067
      bta.addObject(obj=xml_data, name=id, path=path)
2068

2069
  def install(self, context, trashbin, **kw):
2070
    portal = context.getPortalObject()
2071 2072
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2073
    if context.getTemplateFormatVersion() == 1:
2074
      items = self._objects
2075
    else:
2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087
      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)
2088
          module.portal_type = str(mapping['portal_type'])
2089 2090 2091 2092 2093 2094 2095 2096 2097 2098
        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
2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129

  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:
          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))
          perm_tuple = (str(name), rlist)
          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

2130
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2131 2132 2133
    trash = kw.get('trash', 0)
    if trash:
      return
2134 2135 2136 2137 2138 2139
    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]
2140 2141
    p = context.getPortalObject()
    id_list = p.objectIds()
2142
    for id in keys:
2143
      if id in id_list:
2144
        try:
2145
          if trash and trashbin is not None:
2146 2147
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2148
          p.manage_delObjects([id])
2149
        except NotFound:
2150
          pass
2151 2152
    BaseTemplateItem.uninstall(self, context, **kw)

2153 2154 2155
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2156 2157

class DocumentTemplateItem(BaseTemplateItem):
2158 2159 2160 2161
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2162 2163 2164 2165

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

2168
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2169 2170
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190
      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
2191
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2192
      for id in self._objects.keys():
2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206
        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:
            globals()[self.local_file_writer_name](name, text, create=1)
          except IOError:
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
2207
    else:
2208 2209 2210
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
2211
        # This raises an exception if the file exists.
2212
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
2213 2214
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
2215 2216

  def uninstall(self, context, **kw):
2217
    object_path = kw.get('object_path', None)
2218 2219 2220 2221 2222
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
2223
      globals()[self.local_file_remover_name](id)
2224 2225
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
2226 2227 2228 2229 2230 2231
  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():
2232 2233
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
2234

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

2239 2240 2241 2242 2243 2244
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

2245 2246 2247 2248 2249
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
2250

2251 2252 2253
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
2254 2255
  # Extension needs no import
  local_file_importer_name = None
2256 2257 2258 2259 2260
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
2261
  # Test needs no import
2262 2263 2264
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
2265

2266 2267 2268
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
2269 2270 2271

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2272 2273 2274 2275
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2276 2277
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
2278

2279
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2280 2281
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2282
      new_roles = self._objects.keys()
2283 2284 2285
      if installed_bt.id == 'installed_bt_for_diff':
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
2286 2287 2288
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
2289 2290
        for key in old_keys:
          new_dict[key] = ''
2291
        installed_bt._objects = new_dict
2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304
      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):
2305
    p = context.getPortalObject()
2306
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2307
    if context.getTemplateFormatVersion() == 1:
2308
      role_list = self._objects.keys()
2309
    else:
2310
      role_list = self._archive.keys()
2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322
    # 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
2323
    for role in role_list:
2324 2325 2326 2327 2328 2329 2330 2331 2332 2333
      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
2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345

  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)

2346 2347 2348 2349 2350 2351 2352 2353 2354
  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
2355
      if role in roles and role not in new_roles:
2356 2357 2358
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
2359
  # Function to generate XML Code Manually
2360
  def generateXml(self, path):
2361
    obj = self._objects[path]
2362
    xml_data = '<role_list>'
2363 2364
    obj.sort()
    for role in obj:
2365 2366 2367 2368
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

Aurel's avatar
Aurel committed
2369 2370 2371 2372 2373 2374
  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():
2375
      xml_data = self.generateXml(path=path)
2376
      bta.addObject(obj=xml_data, name=path, path=None,)
2377

2378 2379
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2380
  def build(self, context, **kw):
2381 2382
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2383
    except KeyError:
2384 2385 2386 2387
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2388
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2389
    key_list = []
2390
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2391
      if key in sql_search_result_keys:
2392
        key_list.append(key)
Aurel's avatar
Aurel committed
2393 2394
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2395
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2396
      self._objects[self.__class__.__name__+os.sep+'result_key_list'] = key_list
2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407

  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

2408
  def install(self, context, trashbin, **kw):
2409 2410 2411 2412 2413 2414 2415
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2416

2417
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2418
    if context.getTemplateFormatVersion() == 1:
2419 2420
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
2421 2422 2423
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2424
    else:
2425
      keys = self._archive.keys()
2426 2427
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2428
    # XXX same as related key
Aurel's avatar
Aurel committed
2429
    if update_dict.has_key('result_key_list') or force:
2430
      if not force:
Aurel's avatar
Aurel committed
2431
        action = update_dict['result_key_list']
2432
        if action == 'nothing':
Aurel's avatar
Aurel committed
2433
          return
2434
      for key in keys:
2435 2436
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
2437
      catalog.sql_search_result_keys = sql_search_result_keys
2438

2439
  def uninstall(self, context, **kw):
2440 2441
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2442
    except KeyError:
2443 2444 2445 2446 2447
      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)
2448
    object_path = kw.get('object_path', None)
2449 2450 2451 2452 2453
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2454 2455
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2456
    catalog.sql_search_result_keys = sql_search_result_keys
2457 2458
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2459
  # Function to generate XML Code Manually
2460
  def generateXml(self, path=None):
2461
    obj = self._objects[path]
2462
    xml_data = '<key_list>'
2463 2464
    obj.sort()
    for key in obj:
2465 2466 2467 2468
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2469 2470 2471 2472 2473
  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)
2474
    for path in self._objects.keys():
2475
      xml_data = self.generateXml(path=path)
2476
      bta.addObject(obj=xml_data, name=path, path=None)
2477

2478 2479
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2480
  def build(self, context, **kw):
2481 2482
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2483
    except KeyError:
2484 2485 2486 2487
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2488
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2489
    key_list = []
2490
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2491
      if key in sql_search_related_keys:
2492
        key_list.append(key)
Aurel's avatar
Aurel committed
2493 2494
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2495
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2496
      self._objects[self.__class__.__name__+os.sep+'related_key_list'] = key_list
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507

  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

2508
  def install(self, context, trashbin, **kw):
2509 2510 2511 2512 2513 2514 2515
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2516

2517
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2518
    if context.getTemplateFormatVersion() == 1:
2519
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2520
        return
2521 2522 2523
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2524
    else:
2525
      keys = self._archive.keys()
2526 2527
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
2528
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
2529
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
2530
      if not force:
Aurel's avatar
Aurel committed
2531 2532 2533 2534
        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
2535 2536 2537
        if action == 'nothing':
          return
      for key in keys:
2538 2539
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
2540
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
2541

2542 2543 2544
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2545
    except KeyError:
2546 2547 2548 2549
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2550
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2551
    object_path = kw.get('object_path', None)
2552 2553 2554 2555 2556
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2557 2558 2559 2560 2561
      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
2562
  # Function to generate XML Code Manually
2563
  def generateXml(self, path=None):
2564
    obj = self._objects[path]
2565
    xml_data = '<key_list>'
2566 2567
    obj.sort()
    for key in obj:
2568 2569 2570 2571
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

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

2581 2582
class CatalogResultTableTemplateItem(BaseTemplateItem):

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

  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
2610

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

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

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

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

Aurel's avatar
Aurel committed
2672 2673 2674 2675 2676 2677
  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():
2678
      xml_data = self.generateXml(path=path)
2679
      bta.addObject(obj=xml_data, name=path, path=None)
2680

2681 2682
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
2683 2684

  def build(self, context, **kw):
2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700
    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
2701

2702 2703 2704 2705 2706 2707 2708 2709 2710
  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
2711 2712

  def install(self, context, trashbin, **kw):
2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729
    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()
2730 2731
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751
    # 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)
2752
    object_path = kw.get('object_path', None)
2753 2754
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
2755
    else:
2756 2757 2758 2759 2760 2761 2762
      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
2763
  # Function to generate XML Code Manually
2764 2765 2766 2767 2768 2769 2770 2771
  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
2772 2773 2774 2775

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
2776 2777 2778 2779 2780
    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)
2781

2782 2783
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
2784

2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801
  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
2802

2803 2804 2805 2806 2807 2808 2809 2810 2811
  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
2812

2813 2814 2815 2816 2817 2818 2819 2820
  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
2821

2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842
    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
2843

2844 2845 2846 2847 2848 2849 2850 2851 2852
  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)
2853
    object_path = kw.get('object_path', None)
2854 2855 2856 2857 2858 2859 2860 2861 2862 2863
    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
2864
  # Function to generate XML Code Manually
2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954
  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)
2955
    object_path = kw.get('object_path', None)
2956 2957 2958 2959 2960 2961 2962 2963 2964 2965
    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
2966
  # Function to generate XML Code Manually
2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054
  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)
3055
    object_path = kw.get('object_path', None)
3056 3057 3058 3059 3060 3061 3062 3063 3064 3065
    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
3066
  # Function to generate XML Code Manually
3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155
  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)
3156
    object_path = kw.get('object_path', None)
3157 3158 3159 3160 3161 3162 3163 3164 3165 3166
    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
3167
  # Function to generate XML Code Manually
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
  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':
3228
              continue
3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257
          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
3258
      f = open(path+os.sep+'translation.po', 'wt')
3259 3260 3261 3262 3263 3264 3265
      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
3266 3267
class LocalRolesTemplateItem(BaseTemplateItem):

3268 3269 3270 3271
  def __init__(self, id_list, **kw):
    id_list = ['local_roles/%s' % id for id in id_list]
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
3272 3273 3274
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
3275
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
3276 3277 3278 3279
      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
3280 3281
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

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

Aurel's avatar
Aurel committed
3311 3312 3313 3314 3315 3316 3317 3318 3319 3320
  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 = []
3321
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
3322 3323 3324 3325
        if '%' not in folder:
          encode_folders.append(pathname2url(folder))
        else:
          encode_folders.append(folder)
3326
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
3327 3328 3329 3330 3331 3332 3333
      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]
3334
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3335 3336 3337 3338 3339 3340 3341 3342 3343 3344
    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]
3345
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378
    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__', {})
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
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
    in part or completely. Each object are separated from its
    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
      - object without optinal actions
      - list of relation between portal type and worklfow

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

    - site property definition
      - id
      - type
3406
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3407

3408 3409
    - document/propertysheet/extension/test definition
      - copy of the local file
3410

3411
    - message transalation definition
3412
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3413

3414 3415
    The Business Template properties are exported to the bt folder with
    one property per file
3416

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3417 3418
    Technology:

3419 3420
    - 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
3421

3422
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3423 3424 3425 3426

    Use case:

    - install core ERP5 (the minimum)
3427

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

3430 3431
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
3432
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3433 3434 3435 3436 3437
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
3438
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3439 3440 3441 3442 3443
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
3444
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3445 3446 3447 3448 3449 3450 3451

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
3452
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3453
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3454
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3455 3456 3457
                      , PropertySheet.BusinessTemplate
                      )

3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474
    # 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
      }

3475 3476 3477 3478 3479
    # This is a global variable
    # Order is important for installation
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
3480
      '_constraint_item',
3481 3482 3483 3484 3485 3486 3487 3488
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
3489
      '_portal_type_workflow_chain_item',
3490 3491 3492 3493
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
3494 3495 3496
      '_category_item',
      '_module_item',
      '_skin_item',
3497
      '_path_item',
3498
      '_action_item',
3499
      '_portal_type_roles_item',
3500
      '_local_roles_item',
3501
      '_catalog_method_item',
3502 3503 3504
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
3505 3506 3507 3508 3509
      '_catalog_keyword_key_item',
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
3510 3511 3512 3513
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3514 3515 3516 3517 3518 3519
      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
3520
        self._baseGetTemplateFormatVersion()
3521

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3522 3523 3524
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
3525

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3526
      return 0
3527

3528
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
3529 3530 3531 3532 3533 3534 3535
    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".
3536 3537
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
3538
          # XXX Not good to access the attribute directly,
3539 3540 3541
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
3542

3543
    security.declareProtected(Permissions.ManagePortal, 'build')
3544
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3545 3546 3547
      """
        Copy existing portal objects to self
      """
3548
      if no_action: return # this is use at import of Business Template to get the status built
3549

3550 3551
      # Make sure that everything is sane.
      self.clean()
3552

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3553 3554 3555
      # Set the format version.
      self._setTemplateFormatVersion(1)

3556 3557 3558
      # Store all datas
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
3559
      self._portal_type_workflow_chain_item = \
3560
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
3561 3562 3563 3564 3565 3566 3567 3568 3569 3570
      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())
3571 3572
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
3573 3574 3575 3576 3577 3578 3579 3580
      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())
3581 3582
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602
      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())
3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614
      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())
3615 3616
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
3617 3618
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
3619
               self.getTemplateCatalogKeywordKeyList())
3620 3621
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
3622
               self.getTemplateCatalogFullTextKeyList())
3623 3624
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
3625
               self.getTemplateCatalogRequestKeyList())
3626 3627
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
3628
               self.getTemplateCatalogMultivalueKeyList())
3629 3630 3631
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
3632 3633 3634
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
3635

3636 3637 3638
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
3639

3640
    build = WorkflowMethod(build)
3641 3642

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3643
      """
3644
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3645
      """
3646
      return self.portal_templates.publish(self, url, username=username,
3647
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3648

3649
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3650
      """
3651
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3652
      """
3653
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3654

3655 3656 3657 3658
    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
3659
      """
3660

3661 3662
      modified_object_list = {}
      bt_title = self.getTitle()
3663 3664 3665 3666 3667 3668 3669

      #  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)
3670 3671 3672
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3673
        installed_bt_format = installed_bt.getTemplateFormatVersion()
3674

3675
      # if reinstall business template, must compare to object in ZODB
3676 3677
      # and not to those in the installed Business Template because it is itself.
      # same if we make a diff and selected only one business template
3678
      reinstall = 0
3679 3680
      if installed_bt == self:
        reinstall = 1
3681 3682 3683
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
3684 3685 3686
        bt2.edit(description='tmp bt generated for diff')
        bt2.build()
        installed_bt = bt2
3687

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3688
      new_bt_format = self.getTemplateFormatVersion()
3689 3690 3691 3692 3693 3694
      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:
3695
          item = getattr(self, item_name, None)
3696 3697 3698 3699
          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
3700

3701 3702 3703 3704
      # 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:
3705
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3706
        old_item = getattr(installed_bt, item_name, None)
3707
        if new_item is not None:
3708
          if old_item is not None and hasattr(old_item, '_objects'):
3709 3710 3711 3712 3713 3714 3715 3716
            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:
3717
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
3718

3719 3720 3721 3722 3723 3724 3725
      return modified_object_list

    def _install(self, force=1, object_to_update={}, **kw):
      """
        Install a new Business Template, if force, all we be upgrade or installed
        otherwise depends of dict object_to_update
      """
3726

3727 3728
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
3729
      if installed_bt is not None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3730
        if installed_bt.getTemplateFormatVersion() == 0:
3731
          force = 1
3732
        installed_bt.replace(self)
3733

3734 3735 3736 3737
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

3738 3739 3740
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
3741

3742 3743 3744 3745 3746 3747
      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')
3748
        gen.setupLastTools(site, update=1, create_activities=1)
3749 3750
      if not force:
        if len(object_to_update) == 0:
3751 3752 3753 3754 3755
          # 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():
3756
            LOG('Business Template', 0, 'Updating Business Template Workflows')
3757
            gen.setupWorkflow(site)
3758
          return
3759 3760 3761 3762

      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
3763
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3764 3765 3766 3767

      # update catalog if necessary
      update_catalog=0
      catalog_method = getattr(self, '_catalog_method_item', None)
3768
      if catalog_method is not None and self.getTemplateFormatVersion() == 1:
3769 3770 3771 3772 3773 3774 3775 3776 3777
        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
3778
              break
3779 3780 3781 3782 3783 3784 3785 3786
      if update_catalog:
        catalog = local_configuration.portal_catalog.getSQLCatalog()
        if catalog is None:
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
3787

3788 3789
      # 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
3790
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates.objectIds()) > 1):
3791
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
3792 3793
      else:
        trashbin = None
3794

3795 3796 3797 3798 3799 3800 3801
      # 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)

3802
      # get objects to remove
3803
      # do remove after because we may need backup object from installation
3804 3805 3806 3807 3808 3809 3810 3811 3812
      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:
3813
          item = getattr(installed_bt, item_name, None)
3814 3815
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
3816

3817 3818 3819 3820 3821 3822 3823 3824

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

      # check if we have to updater business template workflow
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
3825
        LOG('Business Template', 0, 'Updating Business Template Workflows')
3826 3827 3828 3829 3830 3831 3832
        gen.setupWorkflow(site)
        # XXX keep TM in case update of workflow doesn't work
        #         self._v_txn = WorkflowUpdateTM()
        #         self._v_txn.register(update=1, gen=gen, site=site)

      if update_catalog:
        site.ERP5Site_reindexAll()
3833

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3834 3835 3836
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
3837

3838
    security.declareProtected(Permissions.ManagePortal, 'install')
3839 3840 3841
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
3842
      """
3843
      return self._install(**kw)
3844

3845
    install = WorkflowMethod(install)
3846

3847
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
3848
    def reinstall(self, **kw):
3849 3850 3851 3852
      """Reinstall Business Template.
      """
      return self._install(**kw)

3853
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3854

3855
    security.declareProtected(Permissions.ManagePortal, 'trash')
3856 3857
    def trash(self, new_bt, **kw):
      """
3858
        Trash unnecessary items before upgrading to a new business
3859
        template.
3860
        This is similar to uninstall, but different in that this does
3861
        not remove all items.
3862 3863 3864 3865 3866
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3867 3868
      # Trash everything
      for item_name in self._item_name_list[::-1]:
3869
        item = getattr(self, item_name, None)
3870 3871 3872 3873
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
3874

3875
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
3876
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3877
      """
3878
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3879
      """
3880 3881 3882 3883
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3884 3885 3886
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
3887
        item = getattr(self, item_name, None)
3888 3889
        if item is not None:
          item.uninstall(local_configuration)
3890
      # It is better to clear cache because the uninstallation of a
3891
      # template deletes many things from the portal.
3892
      clearCache()
3893

3894 3895
    uninstall = WorkflowMethod(uninstall)

3896
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3897
    def _clean(self):
3898
      """
3899
        Clean built information.
3900
      """
3901
      # First, remove obsolete attributes if present.
3902 3903 3904 3905
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
3906
                    '_module_archive',
3907 3908 3909
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
3910
                    '_property_sheet_archive'):
3911 3912 3913
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
3914 3915
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
3916

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

3919
    security.declareProtected(Permissions.AccessContentsInformation,
3920
                              'getBuildingState')
3921
    def getBuildingState(self, id_only=1):
3922
      """
3923
        Returns the current state in building
3924
      """
3925
      portal_workflow = getToolByName(self, 'portal_workflow')
3926 3927
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
3928
      return wf._getWorkflowStateOf(self, id_only=id_only )
3929

3930
    security.declareProtected(Permissions.AccessContentsInformation,
3931
                              'getInstallationState')
3932
    def getInstallationState(self, id_only=1):
3933
      """
3934
        Returns the current state in installation
3935
      """
3936
      portal_workflow = getToolByName(self, 'portal_workflow')
3937 3938
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
3939
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3940

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3941 3942 3943 3944 3945 3946
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
3947
      export_string = portal_templates.manage_exportObject(
3948 3949
                                               id=self.getId(),
                                               toxml=1,
3950
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3951
      return export_string
3952

3953
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3954
      """
3955 3956
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3957
      """
3958
      result = getattr(self, id, ())
3959 3960 3961 3962 3963 3964
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3965

3966
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3967
      """
3968 3969
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3970
      """
3971
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3972

3973
    def getTemplateBaseCategoryList(self):
3974
      """
3975 3976
      We have to set this method because we want an
      ordered list
3977
      """
3978
      return self._getOrderedList('template_base_category')
3979

3980
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3981
      """
3982 3983
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3984
      """
3985
      return self._getOrderedList('template_workflow_id')
3986

3987
    def getTemplatePortalTypeIdList(self):
3988
      """
3989 3990
      We have to set this method because we want an
      ordered list
3991
      """
3992
      return self._getOrderedList('template_portal_type_id')
3993

3994 3995 3996 3997 3998 3999 4000
    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
4001 4002 4003 4004 4005 4006 4007
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

4008 4009 4010 4011 4012 4013
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4014

4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035
    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')

4036
    def getTemplateActionPathList(self):
4037
      """
4038 4039
      We have to set this method because we want an
      ordered list
4040
      """
4041
      return self._getOrderedList('template_action_path')
4042

4043 4044 4045 4046 4047 4048 4049
    def getTemplatePortalTypeRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_roles')

4050
    def getTemplateSkinIdList(self):
4051
      """
4052 4053
      We have to set this method because we want an
      ordered list
4054
      """
4055
      return self._getOrderedList('template_skin_id')
4056

4057
    def getTemplateModuleIdList(self):
4058
      """
4059 4060
      We have to set this method because we want an
      ordered list
4061
      """
4062
      return self._getOrderedList('template_module_id')
4063 4064 4065 4066 4067 4068 4069

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

4071
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
4072 4073 4074 4075
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
4076 4077
      if self.getBuildingState() != 'built':
        raise TemplateConditionError, 'Business Template must be build before export'
4078

Aurel's avatar
Aurel committed
4079 4080 4081 4082 4083 4084 4085
      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)

4086
      # export bt
4087
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
4088
      for prop in self.propertyMap():
4089
        prop_type = prop['type']
Aurel's avatar
Aurel committed
4090
        id = prop['id']
4091
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id', 'install_object_list_list'):
4092
          continue
Aurel's avatar
Aurel committed
4093 4094
        if id in ('template_update_business_template_workflow', 'template_update_tool') and self.getTitle() != 'erp5_core':
          continue
Aurel's avatar
Aurel committed
4095
        value = self.getProperty(id)
4096
        if prop_type in ('text', 'string', 'int', 'boolean'):
4097
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
4098
        elif prop_type in ('lines', 'tokens'):
4099
          bta.addObject(obj=str(os.linesep).join(value), name=id, path=path+os.sep+'bt', ext='')
4100

Aurel's avatar
Aurel committed
4101 4102 4103
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
4104

Aurel's avatar
Aurel committed
4105 4106
      return bta.finishCreation()

4107
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
4108 4109
    def importFile(self, dir = 0, file=None, root_path=None):
      """
4110
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
4111 4112 4113 4114 4115
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
4116

Aurel's avatar
Aurel committed
4117 4118
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4119
      self._portal_type_workflow_chain_item = \
4120
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
4121 4122 4123 4124 4125 4126 4127 4128 4129 4130
      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())
4131 4132
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
4133 4134 4135 4136 4137 4138 4139 4140
      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())
4141 4142
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164
      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())
4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178
      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(
4179
               self.getTemplateCatalogKeywordKeyList())
4180 4181
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4182
               self.getTemplateCatalogFullTextKeyList())
4183 4184
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4185
               self.getTemplateCatalogRequestKeyList())
4186 4187
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4188
               self.getTemplateCatalogMultivalueKeyList())
4189 4190 4191
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4192 4193 4194
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
4195

Aurel's avatar
Aurel committed
4196 4197
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4198 4199


Aurel's avatar
Aurel committed
4200
    def diffObject(self, REQUEST, **kw):
4201 4202
      """
        Make a diff between an object in the Business Template
4203
        and the same in the Business Template installed in the site
4204 4205 4206 4207
      """

      class_name_dict = {
        'Product' : '_product_item',
4208
        'PropertySheet' : '_property_sheet_item',
4209
        'Constraint' : '_constraint_item',
4210 4211 4212 4213 4214 4215 4216 4217 4218
        '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',
4219
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
4220 4221 4222 4223
        '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',
4224 4225 4226 4227 4228
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
        'Action' : '_action_item',
4229
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4230
        'LocalRoles' : '_local_roles_item',
4231 4232 4233
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4234 4235 4236 4237 4238
        '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',
Christophe Dumez's avatar
Christophe Dumez committed
4239
	'CatalogMethod' : '_catalog_method_item',
4240
        }
4241

4242 4243
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
Christophe Dumez's avatar
Christophe Dumez committed
4244 4245
      
      # Get objects
4246
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4247

Aurel's avatar
Aurel committed
4248
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
4249
      # Compare with a given business template
4250
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
4251 4252
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
4253 4254
        if bt2_id == self.getId():
          compare_to_zodb = 1
4255
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
4256 4257
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
4258 4259 4260
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
4261 4262 4263
          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
4264
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
4265 4266 4267
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
4268

4269 4270
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
4271
      if compare_to_zodb:
Aurel's avatar
Aurel committed
4272
        # XXX maybe only build for the given object to gain time
4273
        installed_item.build(self)
4274 4275 4276
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
Christophe Dumez's avatar
Christophe Dumez committed
4277 4278
      
      # Real Zope Objects (can be exported into XML directly by Zope)
4279
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item', '_category_item', '_path_item',
Christophe Dumez's avatar
Christophe Dumez committed
4280 4281 4282 4283 4284 4285 4286
                     '_skin_item', '_action_item',]
      
      # Not considered as objects by Zope (will be exported into XML manually)
      item_list_2 = ['_site_property_item', '_module_item', '_catalog_result_key_item', '_catalog_related_key_item', '_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', '_portal_type_workflow_chain_item',]
      
      # Text objects (no need to export them into XML)
      item_list_3 = ['_document_item', '_property_sheet_item', '_constraint_item', '_extension_item', '_test_item', '_message_translation_item',]
4287

4288
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
4289 4290 4291
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
4292 4293
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
Christophe Dumez's avatar
Christophe Dumez committed
4294
	# XML Export in memory
4295 4296 4297
        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()
Christophe Dumez's avatar
Christophe Dumez committed
4298
	f1.close()
4299 4300 4301 4302
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
Christophe Dumez's avatar
Christophe Dumez committed
4303 4304 4305
	# End of XML export
	
	# Diff between XML objects
4306 4307
        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
4308
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4309 4310 4311
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4312

4313
      elif item_name in item_list_2:
Christophe Dumez's avatar
Christophe Dumez committed
4314
	# Generate XML code manually
4315 4316
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
4317 4318
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
Christophe Dumez's avatar
Christophe Dumez committed
4319 4320 4321
	# End of XML Code Generation
	
	# Diff between XML objects
4322 4323
        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
4324
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4325 4326 4327
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4328

4329
      elif item_name in item_list_3:
Christophe Dumez's avatar
Christophe Dumez committed
4330
	# Diff between text objects
4331 4332 4333 4334
        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
4335
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4336 4337
          diff_msg += '\n'.join(diff_list)
        else:
4338
          diff_msg = 'No diff'
4339

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

4343 4344
      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4345

4346
      return diff_msg
Christophe Dumez's avatar
Christophe Dumez committed
4347
      
4348

4349 4350 4351 4352
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
4353 4354 4355 4356 4357 4358 4359
      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 [])
4360 4361 4362 4363 4364 4365 4366
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

      pt_wf_item = getattr(self, '_portal_type_workflow_chain_item', None)
      if pt_wf_item is not None:
        chain_dict = getChainByType(self.getPortalObject())[1]
      else:
        chain_dict = {}
4367

4368
      p = self.getPortalObject()
4369
      for id in bt_portal_types_id_list:
4370 4371 4372 4373
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+id)
        except KeyError:
          continue
4374
        if len(getattr(portal_type, '_roles', ())) > 0:
4375 4376
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
4377

4378 4379 4380 4381
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
4382
        action_list = []
4383
        wf_list = []
4384 4385 4386 4387 4388 4389 4390
        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'):
4391
          base_category_list = portal_type.base_category_list
4392 4393
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
4394
        if chain_dict.has_key('chain_%s' % id):
Aurel's avatar
Aurel committed
4395 4396 4397
          chain = chain_dict['chain_%s' % id]
          if chain != '' and chain != '(Default)':
            wf_list = chain.split(', ')
4398

4399 4400 4401 4402
        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)
4403

4404
        for h_id in hidden_content_type_list:
4405 4406 4407
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
4408

4409 4410 4411 4412
        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)
4413

4414 4415 4416 4417
        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)
4418

4419 4420 4421 4422
        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)
4423 4424 4425 4426 4427

        for workflow_id in wf_list:
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
4428

4429 4430 4431 4432
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
4433
      bt_action_list.sort()
4434
      bt_wf_chain_list.sort()
4435

4436
      setattr(self, 'template_portal_type_workflow_chain', bt_wf_chain_list)
4437
      setattr(self, 'template_portal_type_roles', bt_portal_type_roles_list)
4438 4439 4440
      setattr(self, 'template_portal_type_allowed_content_type', bt_allowed_content_type_list)
      setattr(self, 'template_portal_type_hidden_content_type', bt_hidden_content_type_list)
      setattr(self, 'template_portal_type_property_sheet', bt_property_sheet_list)
4441
      setattr(self, 'template_portal_type_base_category', bt_base_category_list)
4442
      setattr(self, 'template_action_path', bt_action_list)
4443 4444 4445 4446 4447 4448 4449 4450 4451
      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:
4452 4453
        raise TemplateConditionError, 'No module defined in business template'

4454 4455 4456 4457 4458 4459 4460 4461
      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:
4462
          return type_list
4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476

        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():
4477
            type_list.update(getChildPortalType(hidden_ptype_id))
4478
        return type_list
4479

4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553
      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)
4554

4555 4556 4557 4558 4559 4560 4561 4562

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

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