BusinessTemplate.py 147 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 40 41 42 43 44 45
from Products.ERP5Type.Utils import readLocalPropertySheet, \
                                    writeLocalPropertySheet, \
                                    importLocalPropertySheet, \
                                    removeLocalPropertySheet
from Products.ERP5Type.Utils import readLocalExtension, writeLocalExtension, \
                                    removeLocalExtension
from Products.ERP5Type.Utils import readLocalTest, writeLocalTest, \
                                    removeLocalTest
from Products.ERP5Type.Utils import readLocalDocument, writeLocalDocument, \
                                    importLocalDocument, removeLocalDocument
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46
from Products.ERP5Type.XMLObject import XMLObject
47
import fnmatch
Aurel's avatar
Aurel committed
48
import re, os, sys, string, tarfile
Yoshinori Okuji's avatar
Yoshinori Okuji committed
49
from Products.ERP5Type.Cache import clearCache
50
from DateTime import DateTime
Aurel's avatar
Aurel committed
51
from OFS.Traversable import NotFound
52 53
from OFS import XMLExportImport
from cStringIO import StringIO
Aurel's avatar
Aurel committed
54 55 56 57 58 59
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
60 61

from zLOG import LOG
Aurel's avatar
Aurel committed
62 63
from OFS.ObjectManager import customImporters
from gzip import GzipFile
64
from xml.dom.minidom import parse
65
from Products.CMFCore.Expression import Expression
Aurel's avatar
Aurel committed
66
import tarfile
67
from urllib import pathname2url, url2pathname
68
from difflib import unified_diff
Aurel's avatar
Aurel committed
69 70


Aurel's avatar
Aurel committed
71 72
catalog_method_list = ('_is_catalog_list_method_archive',
                       '_is_uncatalog_method_archive',
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
                       '_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
100 101 102
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
103
  """
Aurel's avatar
Aurel committed
104 105 106 107 108 109 110 111 112 113 114 115

  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
116

Aurel's avatar
Aurel committed
117 118 119 120 121 122
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
    Class archiving businnes template into a folder tree
123
  """
Aurel's avatar
Aurel committed
124 125 126 127 128 129
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
130
      removeAll(self.path)
Aurel's avatar
Aurel committed
131 132 133
      os.makedirs(self.path)

  def addFolder(self, name=''):
134
     if name !='':
Aurel's avatar
Aurel committed
135
      path = os.path.join(self.path, name)
136
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
137 138 139
        os.makedirs(path)
      return path

140
  def addObject(self, obj, name, path=None, ext='.xml'):
141
    name = pathname2url(name)
Aurel's avatar
Aurel committed
142 143 144
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
145 146
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
147 148
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
149
    f.write(str(obj))
Aurel's avatar
Aurel committed
150 151 152 153
    f.close()

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

157
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
158 159 160 161
    """
      Import file from a local folder
    """
    class_name = klass.__class__.__name__
162
    for file_path in self.file_list:
163
      if class_name in file_path.split(os.sep):
164 165
        if os.path.isfile(file_path):
          file = open(file_path, 'r')
Aurel's avatar
Aurel committed
166
          # get object id
167 168
          folders = file_path.split(os.sep)
          file_name = string.join(folders[self.root_path_len:], os.sep)
169 170
          if '%' in file_name:
            file_name = url2pathname(file_name)
171
          klass._importFile(file_name, file)
Aurel's avatar
Aurel committed
172
          # close file
173
          file.close()
174

Aurel's avatar
Aurel committed
175 176 177 178 179 180
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
181
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
182 183 184 185 186
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
187
      removeAll(self.path)
Aurel's avatar
Aurel committed
188 189 190 191 192 193
      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
194
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
195 196
      os.makedirs(name)

197
  def addObject(self, obj, name, path=None, ext='.xml'):
198
    name = pathname2url(name)
Aurel's avatar
Aurel committed
199 200 201
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
202 203
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
204 205
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
206
    f.write(str(obj))
Aurel's avatar
Aurel committed
207 208 209 210 211
    f.close()

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
212
    removeAll(self.path)
Aurel's avatar
Aurel committed
213 214 215 216 217
    return self.fobj

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

218
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
219 220
    """
      Import all file from the archive to the site
221
    """
Aurel's avatar
Aurel committed
222 223 224 225 226 227
    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
228 229
      if 'CVS' in info.name.split('/'):
        continue
Aurel's avatar
Aurel committed
230 231 232
      if class_name in info.name:
        if info.isreg():
          file = tar.extractfile(info)
233
          folders = string.split(info.name, os.sep)
234 235 236 237
          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
238 239 240
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
241

242 243
class TemplateConditionError(Exception): pass

244 245
class TemplateConflictError(Exception): pass

246
class BaseTemplateItem(Implicit, Persistent):
247
  """
248
    This class is the base class for all template items.
249
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
250

251
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
252
    self.__dict__.update(kw)
253
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
254
    self._objects = PersistentMapping()
255 256 257 258 259 260 261
    for id in id_list:
      if not id: continue
      self._archive[id] = None

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

262
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
263 264
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
265
      new_keys = self._objects.keys()
266
      for path in new_keys:        
267 268
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
269 270
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
271 272 273 274 275 276 277 278 279 280 281 282
          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):
283
    pass
284 285 286

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

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
  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)
        

305 306 307 308
  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
309
  def export(self, context, bta, **kw):
310
    pass
Aurel's avatar
Aurel committed
311 312

  def importFile(self, bta, **kw):
313
    bta.importFiles(klass=self)
314

315 316 317 318 319 320 321 322 323 324 325 326 327
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
    """  
    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
    return obj      
    
328 329 330
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
331
  """
332

333 334 335 336
  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()
337
      self._archive.clear()
338 339 340
      for id in id_list:
        self._archive["%s/%s" % (tool_id, id)] = None

341 342 343 344 345
  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():
346
      obj = self._objects[key]
347 348
      # create folder and subfolders
      folders, id = os.path.split(key)
Aurel's avatar
Aurel committed
349 350 351 352 353 354 355
      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))
356 357 358
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
359 360
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
361

Aurel's avatar
Aurel committed
362 363 364 365
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
366
      relative_url = '/'.join([url,id])
367 368
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
369
      obj = self.removeProperties(obj)
370
      id_list = obj.objectIds()
371
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
372
        # we must keep groups because it's ereased when we delete subobjects
373
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
374 375
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
376
        obj.manage_delObjects(list(id_list))
377
      if hasattr(aq_base(obj), 'groups'):
378 379 380
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
381 382
    return sub_list

383 384 385 386
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
387 388
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
389
      obj = self.removeProperties(obj)
390
      id_list = obj.objectIds()
391
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
392
        # we must keep groups because it's ereased when we delete subobjects
393
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
394 395
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
396
        obj.manage_delObjects(list(id_list))
397
      if hasattr(aq_base(obj), 'groups'):
398 399 400
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
401

402 403 404 405 406 407 408 409 410 411
  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

412
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
413 414
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
      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]
          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
    """
445
    subobjects_dict = {}
446 447 448 449 450 451 452 453 454
    if trashbin is None: #m ust return subobjects
      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)
        subobjects_dict[subobject_id] = subobject_copy      
      return subobjects_dict
455 456
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
457 458 459 460 461 462 463 464
      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
    
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
465
    if context.getTemplateFormatVersion() == 1:
466 467 468 469 470 471
      groups = {}
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
472 473 474 475 476 477 478
        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:
479
            action = 'backup'
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
          # 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
            container_url = '/'.join(container_path)            
            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
499
          obj = self._objects[path]
500
          if hasattr(aq_base(obj), 'groups'):
501
            # we must keep original order groups because they change when we add subobjects
502
            groups[path] = deepcopy(obj.groups)
503
          # copy the object
504 505 506 507 508
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
509 510 511
          # import sub objects if there is
          if len(subobjects_dict) > 0:
            # get a jar
512 513
            connection = obj._p_jar
            o = obj
514
            while connection is None:
515 516
              o = o.aq_parent
              connection = o._p_jar
517 518 519 520 521
            # import subobjects
            for subobject_id in subobjects_dict.keys():
              subobject_data = subobjects_dict[subobject_id]
              subobject_data.seek(0)
              subobject = connection.importFile(subobject_data)
522 523
              if subobject_id not in obj.objectIds():
                obj._setObject(subobject_id, subobject)
524
              
525
          if obj.meta_type in ('Z SQL Method',):
526 527 528
            # 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',))
529 530
            if obj.connection_id not in sql_connection_list:
              obj.connection_id = sql_connection_list[0]
531 532
      # now put original order group
      for path in groups.keys():
533 534
        obj = portal.unrestrictedTraverse(path)
        obj.groups = groups[path]
Aurel's avatar
Aurel committed
535
    else:
536 537
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
538
      portal = context.getPortalObject()
539
      for relative_url in self._archive.keys():
540
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
541 542 543 544
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
545
        if object_id in container_ids:    # Object already exists          
546
          self._backupObject('backup', trashbin, container_path, object_id)
547
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
548
        # Set a hard link
549 550 551 552 553 554
        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',):
555
          # It is necessary to make sure that the sql connection
Aurel's avatar
Aurel committed
556 557 558
          # in this method is valid.
          sql_connection_list = portal.objectIds(
                                   spec=('Z MySQL Database Connection',))
559 560
          if obj.connection_id not in sql_connection_list:
            obj.connection_id = sql_connection_list[0]
561 562 563

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
564
    trash = kw.get('trash', 0)
565 566 567 568 569
    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
570
      object_keys = self._archive.keys()
571
    for relative_url in object_keys:
572 573
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
574
      try:        
575
        container = portal.unrestrictedTraverse(container_path)
576
        if trash and trashbin is not None:
577 578 579 580
          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
581
        pass
582 583
    BaseTemplateItem.uninstall(self, context, **kw)

584 585 586 587 588 589 590 591 592 593 594 595
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

596 597 598 599 600 601 602 603 604
  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()
605 606
    object_keys.sort()
    object_keys.reverse()
607
    p = context.getPortalObject()
608 609
    object_keys.sort()
    object_keys.reverse()
610 611 612
    for path in object_keys:
      for relative_url in self._resolvePath(p, [], path.split('/')):
        try:        
Aurel's avatar
Aurel committed
613 614
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
615 616 617 618 619 620 621 622 623
          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)

624 625 626
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
627

628 629 630 631 632 633 634 635 636
      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.
637 638
      obj = folder._getOb(id)
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
639 640 641 642
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
      path_list.extend(self._resolvePath(folder._getOb(object_id), relative_url_list + [object_id], id_list[1:]))
    return path_list
Aurel's avatar
Aurel committed
643

644 645 646
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
647 648 649
    keys = self._path_archive.keys()
    keys.sort()    
    for path in keys:
650 651 652
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
653
      for relative_url in self._resolvePath(p, [], path.split('/')):
654 655 656
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
        id_list = obj.objectIds()
657
        obj = self.removeProperties(obj)
658
        if hasattr(aq_base(obj), 'groups'):
659
          # we must keep groups because it's ereased when we delete subobjects
660
          groups = deepcopy(obj.groups)
661
        if len(id_list) > 0:
662 663
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
664
          obj.manage_delObjects(list(id_list))
665
        if hasattr(aq_base(obj), 'groups'):
666 667 668
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
669
      
670 671
class CategoryTemplateItem(ObjectTemplateItem):

672 673
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
674

675 676 677 678
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
679 680
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
681
      obj = self.removeProperties(obj)
682
      id_list = obj.objectIds()
683 684
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
685 686 687
        obj.manage_delObjects(list(id_list))
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
688 689 690 691 692

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
693 694
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
695
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
696
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
697
      id_list = obj.objectIds()
698 699
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
700
        obj.manage_delObjects(list(id_list))
701
      else:
702 703 704
        obj.manage_delObjects(list(id_list))
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
705 706 707 708
      
  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
709
    if context.getTemplateFormatVersion() == 1:
710 711
      if light_install == 0:
        ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
712 713 714 715 716 717 718
      else:
        portal = context.getPortalObject()
        category_tool = portal.portal_categories
        tool_id = self.tool_id
        keys = self._objects.keys()
        keys.sort()
        for path in keys:
719 720 721 722 723 724
          if update_dict.has_key(path) or force:
            if not force:
              action = update_dict[path]
              if action == 'nothing':
                continue
            else:
725
              action = 'backup'
726
            # Wrap the object by an aquisition wrapper for _aq_dynamic.
727 728
            obj = self._objects[path]
            obj = obj.__of__(category_tool)
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
            container_path = path.split('/')[:-1]
            category_id = path.split('/')[-1]
            try:
              container = category_tool.unrestrictedTraverse(container_path)
            except KeyError:
              # parent object can be set to nothing, in this case just go on
              container_url = '/'.join(container_path)            
              if update_dict.has_key(container_url):
                if update_dict[container_url] == 'nothing':
                  continue
              raise
            container_ids = container.objectIds() 
            # Object already exists
            if category_id in container_ids:
              subobjects_dict = self._backupObject(action, trashbin, container_path, category_id)
              container.manage_delObjects([category_id])
745 746
            category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
            for property in obj.propertyIds():
747
              if property not in ('id', 'uid'):
748
                category.setProperty(property, obj.getProperty(property, evaluate=0))
749 750 751
            # import sub objects if there is
            if len(subobjects_dict) > 0:
              # get a jar
752 753
              connection = obj._p_jar
              o = category
754
              while connection is None:
755 756
                o = o.aq_parent
                connection = o._p_jar
757 758 759 760 761 762 763
              # 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)
764
    else:
765
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
766 767 768 769
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      if light_install==0:
770
        ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
771
      else:
772
        for relative_url in self._archive.keys():
773
          obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
774
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
775
          obj = obj.__of__(category_tool)
Aurel's avatar
Aurel committed
776 777 778 779 780
          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
781 782
            # XXX call backup here
            subobjects_dict = self._backupObject('backup', trashbin, container_path, category_id)
783
            container.manage_delObjects([category_id])
784 785
          category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
          for property in obj.propertyIds():
Aurel's avatar
Aurel committed
786
            if property not in ('id', 'uid'):
787
              category.setProperty(property, obj.getProperty(property, evaluate=0))
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
          # 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)

804

805 806
class SkinTemplateItem(ObjectTemplateItem):

807 808
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
809

810
  def install(self, context, trashbin, **kw):
811
    ObjectTemplateItem.install(self, context, trashbin, **kw)
812 813
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
814 815 816 817 818
    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)
819 820 821
      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]
822 823 824 825 826 827
    # 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
828
        if context.getTemplateFormatVersion() == 1:
829 830
          if update_dict.has_key(relative_url) or force:
            if not force:
831
              if update_dict[relative_url] == 'nothing':
832
                continue
833
          obj = self._objects[relative_url]
834
        else:
835
          obj = self._archive[relative_url]
836
        skin_id = relative_url.split('/')[-1]
837
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
838 839 840 841 842 843 844 845 846 847 848 849 850
        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)
851 852 853

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
854 855 856 857 858
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()    
859
    ps = context.portal_skins
860
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
861 862 863 864 865 866 867
    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)
868
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
869
    context.getPortalObject().changeSkin(None)
870 871 872
    ObjectTemplateItem.uninstall(self, context, **kw)


873
class WorkflowTemplateItem(ObjectTemplateItem):
874

875 876
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
877

878
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
879 880
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
        if len(path.split('/')) == 2:
          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]
            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', 'Workflow']})
          else: # new object
            modified_object_list.update({path : ['New', 'Workflow']})
      # 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
909
    if context.getTemplateFormatVersion() == 1:
910 911 912 913 914 915 916 917 918 919 920 921 922 923
      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:
924
            action = 'backup'
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
          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
            container_url = '/'.join(container_path)            
            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])
940 941 942 943 944 945
          obj = self._objects[path]
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
946 947 948 949 950
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)

  

951 952 953 954 955 956 957 958
class PortalTypeTemplateItem(ObjectTemplateItem):

  workflow_chain = None

  def _getChainByType(self, context):
    """
    This is used in order to construct the full list
    of mapping between type and list of workflow associated
959
    This is only useful in order to use
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
    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)

984 985
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
986 987 988
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
989 990
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
991 992 993
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
      id_list = obj.objectIds()
994
      # remove optional actions and properties
995
      optional_action_list = []
996
      for index,ai in enumerate(obj.listActions()):
997 998 999
        if ai.getOption():
          optional_action_list.append(index)
      if len(optional_action_list) > 0:
1000
        obj.deleteActions(selections=optional_action_list)
1001
      obj = self.removeProperties(obj)
1002 1003 1004 1005 1006 1007 1008 1009 1010
      # 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', ())
1011 1012
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
1013
    # also export workflow chain
1014
    (default_chain, chain_dict) = self._getChainByType(context)
1015 1016
    for obj in self._objects.values():
      portal_type = obj.id
1017 1018
      self._workflow_chain_archive[portal_type] = chain_dict['chain_%s' % portal_type]

Aurel's avatar
Aurel committed
1019 1020 1021 1022
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
1023
    # export portal type object
1024
    ObjectTemplateItem.export(self, context, bta, **kw)
1025 1026
    # export workflow chain
    xml_data = '<workflow_chain>'
1027 1028 1029
    keys = self._workflow_chain_archive.keys()
    keys.sort()
    for key in keys:
1030 1031 1032
      xml_data += os.linesep+' <chain>'
      xml_data += os.linesep+'  <type>%s</type>' %(key,)
      xml_data += os.linesep+'  <workflow>%s</workflow>' %(self._workflow_chain_archive[key],)
1033
      xml_data += os.linesep+' </chain>'
1034
    xml_data += os.linesep+'</workflow_chain>'
1035
    bta.addObject(obj=xml_data, name='workflow_chain_type',  path=root_path)
1036

1037 1038 1039 1040
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1041 1042 1043 1044 1045 1046
    # We now need to setup the list of workflows corresponding to
    # each portal type
    (default_chain, chain_dict) = self._getChainByType(context)
    # Set the default chain to the empty string is probably the
    # best solution, by default it is 'default_workflow', wich is
    # not very usefull
1047
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1048
    if context.getTemplateFormatVersion() == 1:
1049
      object_list = self._objects
1050
    else:
1051 1052
      object_list = self._archive
    for path in object_list.keys():
1053 1054 1055 1056 1057
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
            continue          
1058 1059
        obj = object_list[path]
        portal_type = obj.id
1060 1061 1062 1063 1064
        chain_dict['chain_%s' % portal_type] = \
                              self._workflow_chain_archive[portal_type]
        context.portal_workflow.manage_changeWorkflows(default_chain,
                                                       props=chain_dict)

1065 1066 1067 1068 1069 1070 1071
  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:
1072
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1073 1074 1075 1076 1077
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1078
        dict[str(ptype)] = str(workflow)
1079 1080 1081 1082 1083
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)


1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
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]

  def generateXml(self, path=None):
1100
    dict = self._objects
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
    xml_data = '<%s>' %(self.xml_tag,)
    keys = dict.keys()
    keys.sort()
    for key in keys:
      allowed_list = dict[key]
      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)

1122 1123 1124 1125 1126 1127
  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':
1128
        #must rename keys in dict if reinstall
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
        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]
          old_object = installed_bt._objects[path]          
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
  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)
        except KeyError:
          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:
            if id not in property_list:              
              property_list.append(id)        
        setattr(portal_type, self.class_property, list(property_list))

Aurel's avatar
Aurel committed
1190
  def uninstall(self, context, **kw):
1191
    object_path = kw.get('object_path', None)
1192
    p = context.getPortalObject()
1193
    pt = p.unrestrictedTraverse('portal_types')
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
    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)
      except KeyError:
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
      original_property_list = getattr(portal_type, self.class_property, ())
Aurel's avatar
Aurel committed
1207 1208 1209
      for id in property_list:
        if id in original_property_list:
          original_property_list.remove(id)        
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
      setattr(portal_type, self.class_property, list(original_property_list))
    
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'

1227 1228
class CatalogMethodTemplateItem(ObjectTemplateItem):

1229 1230
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1231
    self._is_catalog_list_method_archive = PersistentMapping()
1232 1233 1234 1235 1236 1237 1238 1239 1240
    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)
1241 1242
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1243 1244
    except KeyError:
      catalog = None
1245
    if catalog is None:
1246
      LOG('BusinessTemplate build', 0, 'catalog not found')
1247
      return
1248 1249
    for obj in self._objects.values():
      method_id = obj.id
1250 1251 1252
      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
1253
      self._is_filtered_archive[method_id] = 0
1254 1255 1256 1257 1258
      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']
1259

Aurel's avatar
Aurel committed
1260 1261 1262 1263 1264
  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():
1265
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1266 1267 1268 1269 1270 1271
      # 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()
1272 1273
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1274 1275
      # add all datas specific to catalog inside one file
      catalog = context.portal_catalog.getSQLCatalog()
1276
      method_id = obj.id
1277 1278
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1279
      f = open(object_path, 'wt')
1280 1281 1282
      xml_data = '<catalog_method>'
      for method in catalog_method_list:
        value = getattr(self, method, 0)[method_id]
1283
        xml_data += os.linesep+' <item key="%s" type="int">' %(method,)
1284
        xml_data += os.linesep+'  <value>%s</value>' %(str(int(value)))
1285
        xml_data += os.linesep+' </item>'
Aurel's avatar
Aurel committed
1286
      if catalog.filter_dict.has_key(method_id):
1287 1288 1289
        for method in catalog_method_filter_list:
          value = getattr(self, method, '')[method_id]
          if method == '_filter_expression_instance_archive':
1290
            pass
1291
          else:
1292
            if type(value) in (type(''), type(u'')):
1293
              xml_data += os.linesep+' <item key="%s" type="str">' %(method,)
1294
              xml_data += os.linesep+'  <value>%s</value>' %(str(value))
1295
              xml_data += os.linesep+' </item>'
1296
            elif type(value) in (type(()), type([])):
1297
              xml_data += os.linesep+' <item key="%s" type="tuple">'%(method)
1298 1299
              for item in value:
                xml_data += os.linesep+'  <value>%s</value>' %(str(item))
1300
              xml_data += os.linesep+' </item>'
1301 1302
      xml_data += os.linesep+'</catalog_method>'
      f.write(str(xml_data))
Aurel's avatar
Aurel committed
1303
      f.close()
1304

1305 1306
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1307 1308
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1309
    except KeyError:
1310 1311 1312 1313 1314 1315 1316 1317
      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)
1318

1319 1320 1321
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1322
    new_bt_format = context.getTemplateFormatVersion()
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343

    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':
              continue          
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
1344

1345 1346
    for obj in values:
      method_id = obj.id
1347

Aurel's avatar
Aurel committed
1348 1349 1350 1351
      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])
1352

1353 1354 1355 1356 1357
      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)

1358
      if is_uncatalog_method and method_id not in sql_uncatalog_object:
1359
        sql_uncatalog_object.append(method_id)
1360
      elif not is_uncatalog_method and method_id in sql_uncatalog_object:
1361 1362 1363 1364 1365 1366 1367 1368
        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:
1369
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1370
        if context.getTemplateFormatVersion() == 1:
1371 1372 1373
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1374
        filter_type = self._filter_type_archive[method_id]
1375 1376 1377
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1378
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1379
        catalog.filter_dict[method_id]['type'] = filter_type
1380
      elif method_id in catalog.filter_dict.keys():
1381
        catalog.filter_dict[method_id]['filtered'] = 0
1382

1383 1384
    sql_catalog_object_list.sort()
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
1385
    sql_uncatalog_object.sort()
1386
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
1387
    sql_clear_catalog.sort()
1388
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1389 1390

  def uninstall(self, context, **kw):
1391 1392
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1393
    except KeyError:
1394 1395 1396 1397
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1398
    
1399 1400 1401 1402
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
1403 1404 1405 1406
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
1407 1408 1409 1410
    else:
      value = self._archive[object_path]
      if value is not None:
        values.append(value)
1411 1412 1413 1414
    # 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)
1415

1416
    for obj in values:      
1417
      method_id = obj.id
1418 1419
      if method_id in sql_catalog_object_list:
        sql_catalog_object_list.remove(method_id)
1420 1421 1422 1423
      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
1424
      if catalog.filter_dict.has_key(method_id):
1425
        del catalog.filter_dict[method_id]
1426
        
1427 1428 1429
    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)
1430
    # uninstall objects
1431
    ObjectTemplateItem.uninstall(self, context, **kw)
1432

1433
  def _importFile(self, file_name, file):
1434
    if not '.catalog_keys' in file_name:
1435 1436 1437 1438 1439 1440 1441 1442
      # 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
1443
    elif '.catalog_keys' in file_name:
1444 1445 1446 1447
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1448
      method_list = xml.getElementsByTagName('item')
1449
      for method in method_list:
1450
        key = method.getAttribute('key')
1451 1452
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1453 1454
          value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          key = str(key)
1455
        elif key_type == "int":
1456
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1457
          key = str(key)
1458
        elif key_type == "tuple":
1459 1460 1461 1462
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1463
        else:
1464
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1465
          continue
1466 1467 1468
        if key in catalog_method_list or key in catalog_method_filter_list:
          dict = getattr(self, key)
          dict[id] = value
1469 1470

class ActionTemplateItem(ObjectTemplateItem):
1471 1472 1473 1474

  def _splitPath(self, path):
    """
      Split path tries to split a complexe path such as:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1475

1476
      "foo/bar[id=zoo]"
1477

1478
      into
1479

1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
      "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

  def __init__(self, id_list, **kw):
1494
    # XXX It's look like ObjectTemplateItem __init__
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
    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

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
      relative_url, key, value = self._splitPath(id)
1506 1507
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1508
        if getattr(ai, key) == value:
1509
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1510
          key = os.path.join(url[-2], url[-1], value)
1511
          action = ai._getCopy(context)
1512
          action = self.removeProperties(action)
1513
          self._objects[key] = action
Aurel's avatar
Aurel committed
1514
          self._objects[key].wl_clearLocks()
1515 1516
          break
      else:
1517
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1518

1519 1520 1521
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1522
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1523 1524
      p = context.getPortalObject()
      for id in self._objects.keys():
1525 1526 1527 1528 1529 1530
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
1531 1532
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
1533 1534 1535
          for index in range(len(action_list)):
            if getattr(action_list[index], 'id') == path[-1]:          
              # remove previous action
1536
              obj.deleteActions(selections=(index,))
1537
          action = self._objects[id]
1538
          obj.addAction(
1539 1540 1541 1542 1543 1544 1545 1546 1547
                        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 ''
                      , optional = getattr(action, 'optional', 0)
1548
                      , priority = action.priority
Aurel's avatar
Aurel committed
1549
                    )
1550
          # sort action based on the priority define on it
1551 1552 1553 1554 1555 1556 1557 1558 1559
          # 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
1560
    else:
1561
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1562
      p = context.getPortalObject()
1563 1564
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
1565
        relative_url, key, value = self._splitPath(id)
1566 1567
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
1568
          if getattr(ai, key) == value:
1569 1570
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
        obj.addAction(
Aurel's avatar
Aurel committed
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
                      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 ''
                    , optional = getattr(action, 'optional', 0)
                    )
Aurel's avatar
Aurel committed
1581 1582 1583 1584 1585 1586 1587
        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))
1588 1589
          obj.moveDownActions(selections=tuple(move_down_list))

1590 1591 1592

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1593 1594 1595 1596 1597 1598 1599 1600
    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:
      action = self._archive[id]
1601
      relative_url, key, value = self._splitPath(id)
1602 1603
      obj = p.unrestrictedTraverse(relative_url)
      action_list = obj.listActions()
1604
      for index in range(len(action_list)):
1605
        if getattr(action_list[index], key) == value:
1606
          obj.deleteActions(selections=(index,))
1607 1608 1609 1610 1611 1612 1613 1614 1615
          break
    BaseTemplateItem.uninstall(self, context, **kw)

class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1616 1617
      for property in p.propertyMap():
        if property['id'] == id:
1618
          obj = p.getProperty(id)
1619
          prop_type = property['type']
1620 1621
          break
      else:
1622 1623
        obj = None
      if obj is None:
1624
        raise NotFound, 'the property %s is not found' % id
1625
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
1626

1627 1628 1629 1630 1631 1632
  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
1633 1634
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
1635 1636 1637 1638 1639 1640 1641
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
1642
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
1643
      self._objects[str(id)] = (str(prop_type), value)
1644

1645 1646 1647
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1648
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1649 1650
      p = context.getPortalObject()
      for path in self._objects.keys():
1651 1652 1653 1654 1655 1656 1657 1658
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue          
          dir, id = os.path.split(path)
          if p.hasProperty(id):
            continue
1659 1660
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
1661
    else:
1662
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1663
      p = context.getPortalObject()
1664 1665
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
1666 1667 1668 1669 1670
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
1671 1672 1673

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1674 1675 1676 1677 1678 1679
    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:
1680 1681 1682 1683
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

1684
  def generateXml(self, path=None):
1685
    xml_data = ''
1686
    prop_type, obj = self._objects[path]
1687 1688
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
1689 1690
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
1691
      xml_data += os.linesep+'  <value>'
1692
      for item in obj:
1693 1694 1695 1696
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
1697
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
1698
    xml_data += os.linesep+' </property>'
1699 1700
    return xml_data

Aurel's avatar
Aurel committed
1701 1702 1703 1704 1705
  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)
1706 1707 1708 1709
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
1710
      xml_data += self.generateXml(path)
1711
    xml_data += os.linesep+'</site_property>'
1712
    bta.addObject(obj=xml_data, name='properties', path=root_path)
1713

1714 1715 1716 1717 1718 1719 1720
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)
1721 1722 1723 1724 1725 1726 1727 1728
      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
1729

1730
  def generateXml(self, path=None):
1731 1732
    dict = self._objects[path]
    xml_data = '<module>'
1733 1734 1735 1736
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
1737 1738 1739 1740 1741 1742 1743
      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
1744
          role_list = list(perm[1])
1745
          role_list.sort()
1746 1747 1748 1749 1750 1751 1752 1753 1754
          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

1755 1756 1757 1758 1759
  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)
1760 1761 1762
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
1763
      # expor module one by one
1764
      xml_data = self.generateXml(path=id)
1765
      bta.addObject(obj=xml_data, name=id, path=path)
1766

1767
  def install(self, context, trashbin, **kw):
1768
    portal = context.getPortalObject()
1769 1770
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1771
    if context.getTemplateFormatVersion() == 1:
1772
      items = self._objects
1773
    else:
1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796
      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)
          module.portal_type = str(mapping['portal_type']) 
        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
1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827

  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

1828
  def uninstall(self, context, **kw):
1829 1830 1831 1832 1833 1834 1835
    trash = kw.get('trash', 0)      
    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]
1836 1837
    p = context.getPortalObject()
    id_list = p.objectIds()
1838
    for id in keys:
1839
      if id in id_list:
1840
        try:
1841
          if trash and trashbin is not None:
1842 1843
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
1844
          p.manage_delObjects([id])
1845
        except NotFound:
1846
          pass
1847 1848
    BaseTemplateItem.uninstall(self, context, **kw)

1849 1850 1851
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
1852 1853

class DocumentTemplateItem(BaseTemplateItem):
1854 1855 1856 1857
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
1858 1859 1860 1861

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

1864
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1865 1866
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
      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
1887
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1888
      for id in self._objects.keys():
1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902
        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
1903
    else:
1904 1905 1906
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
1907
        # This raises an exception if the file exists.
1908
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
1909 1910
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
1911 1912

  def uninstall(self, context, **kw):
1913 1914 1915 1916 1917 1918
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
1919
      globals()[self.local_file_remover_name](id)
1920 1921
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
1922 1923 1924 1925 1926 1927
  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():
1928 1929
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
1930

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

1935 1936 1937 1938 1939 1940
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

1941

1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
  # XXX is this method a error or ?
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
  # XXX is this a error ?
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
1956

1957 1958 1959
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
1960 1961 1962

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
1963 1964 1965 1966
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
1967 1968
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
1969

1970
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1971 1972
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1973
      new_roles = self._objects.keys()
1974 1975 1976
      if installed_bt.id == 'installed_bt_for_diff':
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
1977 1978 1979
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
1980 1981 1982
        for key in old_keys:
          new_dict[key] = ''
        installed_bt._objects = new_dict      
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995
      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):
1996
    p = context.getPortalObject()
1997
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1998
    if context.getTemplateFormatVersion() == 1:
1999
      role_list = self._objects.keys()
2000
    else:
2001
      role_list = self._archive.keys()
2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
    # 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
2014
    for role in role_list:
2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
      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
2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036

  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)

2037 2038 2039 2040 2041 2042 2043 2044 2045
  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
2046
      if role in roles and role not in new_roles:
2047 2048 2049
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

2050
  def generateXml(self, path):
2051
    obj = self._objects[path]
2052
    xml_data = '<role_list>'
2053 2054
    obj.sort()
    for role in obj:
2055 2056 2057 2058
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

Aurel's avatar
Aurel committed
2059 2060 2061 2062 2063 2064
  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():
2065
      xml_data = self.generateXml(path=path)
2066
      bta.addObject(obj=xml_data, name=path, path=None,)
2067

2068 2069
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2070
  def build(self, context, **kw):
2071 2072
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2073
    except KeyError:
2074 2075 2076 2077
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2078
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2079
    key_list = []
2080
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2081
      if key in sql_search_result_keys:
2082
        key_list.append(key)
Aurel's avatar
Aurel committed
2083 2084
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2085
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2086
      self._objects[self.__class__.__name__+os.sep+'result_key_list'] = key_list
2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097

  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

2098
  def install(self, context, trashbin, **kw):
2099 2100 2101 2102 2103 2104 2105
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2106

2107
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2108
    if context.getTemplateFormatVersion() == 1:
2109 2110
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
2111 2112 2113
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2114
    else:
2115
      keys = self._archive.keys()
2116 2117
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2118
    # XXX same as related key
Aurel's avatar
Aurel committed
2119
    if update_dict.has_key('result_key_list') or force:
2120
      if not force:
Aurel's avatar
Aurel committed
2121
        action = update_dict['result_key_list']
2122
        if action == 'nothing':
Aurel's avatar
Aurel committed
2123
          return
2124
      for key in keys:
2125 2126
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
2127
      catalog.sql_search_result_keys = sql_search_result_keys
2128

2129
  def uninstall(self, context, **kw):
2130 2131
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2132
    except KeyError:
2133 2134 2135 2136 2137
      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)
2138 2139 2140 2141 2142 2143
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2144 2145
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2146
    catalog.sql_search_result_keys = sql_search_result_keys
2147 2148
    BaseTemplateItem.uninstall(self, context, **kw)

2149
  def generateXml(self, path=None):
2150
    obj = self._objects[path]
2151
    xml_data = '<key_list>'
2152 2153
    obj.sort()
    for key in obj:
2154 2155 2156 2157
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2158 2159 2160 2161 2162
  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)
2163
    for path in self._objects.keys():
2164
      xml_data = self.generateXml(path=path)
2165
      bta.addObject(obj=xml_data, name=path, path=None)
2166

2167 2168
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2169
  def build(self, context, **kw):
2170 2171
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2172
    except KeyError:
2173 2174 2175 2176
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2177
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2178
    key_list = []
2179
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2180
      if key in sql_search_related_keys:
2181
        key_list.append(key)
Aurel's avatar
Aurel committed
2182 2183
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2184
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2185
      self._objects[self.__class__.__name__+os.sep+'related_key_list'] = key_list
2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196

  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

2197
  def install(self, context, trashbin, **kw):
2198 2199 2200 2201 2202 2203 2204
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2205

2206
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2207
    if context.getTemplateFormatVersion() == 1:
2208
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2209
        return
2210 2211 2212
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2213
    else:
2214
      keys = self._archive.keys()
2215 2216
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
2217
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
2218
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
2219
      if not force:
Aurel's avatar
Aurel committed
2220 2221 2222 2223
        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
2224 2225 2226
        if action == 'nothing':
          return
      for key in keys:
2227 2228
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
2229
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
2230

2231 2232 2233
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2234
    except KeyError:
2235 2236 2237 2238
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2239
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2240 2241 2242 2243 2244 2245
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2246 2247 2248 2249 2250
      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)

2251
  def generateXml(self, path=None):
2252
    obj = self._objects[path]
2253
    xml_data = '<key_list>'
2254 2255
    obj.sort()
    for key in obj:
2256 2257 2258 2259
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2260 2261 2262 2263 2264 2265
  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():
2266
      xml_data = self.generateXml(path=path)
2267
      bta.addObject(obj=xml_data, name=path, path=None)
2268

2269 2270
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2271
  def build(self, context, **kw):
2272 2273
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2274
    except KeyError:
2275 2276 2277 2278
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2279
    sql_search_result_tables = list(catalog.sql_search_tables)
2280
    key_list = []
2281
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2282
      if key in sql_search_result_tables:
2283
        key_list.append(key)
Aurel's avatar
Aurel committed
2284 2285
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2286
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2287
      self._objects[self.__class__.__name__+os.sep+'resutl_table_list'] = key_list
2288 2289 2290 2291 2292 2293 2294 2295 2296 2297

  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
2298

2299
  def install(self, context, trashbin, **kw):
2300 2301 2302 2303 2304 2305 2306
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2307

2308
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2309
    if context.getTemplateFormatVersion() == 1:
2310
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2311
        return
2312 2313 2314
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2315
    else:
2316
      keys = self._archive.keys()
2317 2318
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2319
    # XXX same as related keys
Aurel's avatar
Aurel committed
2320
    if update_dict.has_key('result_table_list') or force:
2321
      if not force:
Aurel's avatar
Aurel committed
2322
        action = update_dict['result_table_list']
2323
        if action == 'nothing':
Aurel's avatar
Aurel committed
2324
          return
2325
      for key in keys:
2326 2327
        if key not in sql_search_tables:
          sql_search_tables.append(key)
2328
      catalog.sql_search_tables = sql_search_tables
2329 2330

  def uninstall(self, context, **kw):
2331 2332
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2333
    except KeyError:
2334 2335 2336 2337 2338
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2339 2340 2341 2342 2343 2344
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2345 2346
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2347
    catalog.sql_search_tables = sql_search_tables
2348 2349
    BaseTemplateItem.uninstall(self, context, **kw)

2350
  def generateXml(self, path=None):
2351
    obj = self._objects[path]
2352
    xml_data = '<key_list>'
2353 2354
    obj.sort()
    for key in obj:
2355 2356 2357 2358
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'    
    return xml_data

Aurel's avatar
Aurel committed
2359 2360 2361 2362 2363 2364
  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():
2365
      xml_data = self.generateXml(path=path)
2366
      bta.addObject(obj=xml_data, name=path, path=None)
2367 2368 2369
      
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
2370 2371

  def build(self, context, **kw):
2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387
    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
2388

2389 2390 2391 2392 2393 2394 2395 2396 2397
  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
2398 2399

  def install(self, context, trashbin, **kw):
2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416
    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()
2417 2418
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441
    # 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)
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
2442
    else:
2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457
      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)

  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
2458 2459 2460 2461

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
2462 2463 2464 2465 2466
    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)
2467

2468 2469
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
2470

2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487
  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
2488

2489 2490 2491 2492 2493 2494 2495 2496 2497
  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
2498

2499 2500 2501 2502 2503 2504 2505 2506
  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
2507

2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528
    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
2529

2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 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
  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)
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_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)

  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)
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_request_keys:
        sql_catalog_request_keys.remove(key)
    catalog.sql_catalog_request_keys = sql_catalog_request_keys
    BaseTemplateItem.uninstall(self, context, **kw)

  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)
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_multivalue_keys:
        sql_catalog_multivalue_keys.remove(key)
    catalog.sql_catalog_multivalue_keys = sql_catalog_multivalue_keys
    BaseTemplateItem.uninstall(self, context, **kw)

  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)
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_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)

  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':
              continue          
          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
2940
      f = open(path+os.sep+'translation.po', 'wt')
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973
      f.write(str(obj))
      f.close()

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

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
2974
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2975

2976 2977
    - document/propertysheet/extension/test definition
      - copy of the local file
2978

2979
    - message transalation definition
2980
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2981

2982 2983
    The Business Template properties are exported to the bt folder with
    one property per file
2984

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2985 2986
    Technology:

2987 2988
    - 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
2989

2990
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2991 2992 2993 2994

    Use case:

    - install core ERP5 (the minimum)
2995

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

2998 2999
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
3000
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3001 3002 3003 3004 3005
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
3006
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
    security.declareObjectProtected(Permissions.View)

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
3020
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3021
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3022
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3023 3024 3025
                      , PropertySheet.BusinessTemplate
                      )

3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042
    # 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
      }

3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056
    # This is a global variable
    # Order is important for installation
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
      '_message_translation_item',
      '_workflow_item',
      '_catalog_method_item',
      '_site_property_item',
      '_portal_type_item',
3057 3058 3059 3060
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
3061 3062 3063
      '_category_item',
      '_module_item',
      '_skin_item',
3064
      '_path_item',
3065 3066 3067 3068
      '_action_item',
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
3069 3070 3071 3072 3073
      '_catalog_keyword_key_item',
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
3074 3075 3076 3077
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3078 3079 3080 3081 3082 3083
      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
3084
        self._baseGetTemplateFormatVersion()
3085

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3086 3087 3088
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
3089
      
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3090 3091
      return 0
        
3092
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
3093 3094 3095 3096 3097 3098 3099
    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".
3100 3101
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
3102
          # XXX Not good to access the attribute directly,
3103 3104 3105
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
3106

3107
    security.declareProtected(Permissions.ManagePortal, 'build')
3108
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3109 3110 3111
      """
        Copy existing portal objects to self
      """
3112 3113
      if no_action: return # this is use at import of Business Template to get the status built
      
3114 3115
      # Make sure that everything is sane.
      self.clean()
3116

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3117 3118 3119
      # Set the format version.
      self._setTemplateFormatVersion(1)

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 3156 3157 3158 3159 3160
      # Store all datas
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
      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())
      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())
      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())
3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172
      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())
3173 3174
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
               self.getTemplateCatalogKeywordKeyList())      
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
               self.getTemplateCatalogFullTextKeyList())      
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
               self.getTemplateCatalogRequestKeyList())    
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
               self.getTemplateCatalogMultivalueKeyList())      
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
      
3191 3192 3193
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
3194

3195
    build = WorkflowMethod(build)
3196 3197

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3198
      """
3199
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3200
      """
3201
      return self.portal_templates.publish(self, url, username=username,
3202
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3203

3204
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3205
      """
3206
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3207
      """
3208
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3209

3210 3211 3212 3213
    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
3214 3215
      """
                
3216 3217
      modified_object_list = {}
      bt_title = self.getTitle()
3218 3219 3220 3221 3222 3223 3224

      #  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)
3225 3226 3227
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3228
        installed_bt_format = installed_bt.getTemplateFormatVersion()
3229

3230
      # if reinstall business template, must compare to object in ZODB
3231 3232 3233
      # 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
      reinstall = 0      
3234 3235
      if installed_bt == self:
        reinstall = 1
3236 3237 3238
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
3239 3240 3241 3242
        bt2.edit(description='tmp bt generated for diff')
        bt2.build()
        installed_bt = bt2
      
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3243
      new_bt_format = self.getTemplateFormatVersion()
3244 3245 3246 3247 3248 3249
      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:
3250
          item = getattr(self, item_name, None)
3251 3252 3253 3254
          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
3255

3256 3257 3258 3259
      # 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:
3260
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3261
        old_item = getattr(installed_bt, item_name, None)
3262
        if new_item is not None:
3263
          if old_item is not None:
3264
            LOG('compare object item', 0, item_name)
3265 3266 3267 3268 3269 3270 3271 3272
            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:
3273
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
3274
      
3275 3276 3277 3278 3279 3280 3281
      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
      """
3282 3283
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
3284
      if installed_bt is not None:        
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3285
        if installed_bt.getTemplateFormatVersion() == 0:
3286 3287 3288
          # maybe another to uninstall old format bt, maybe not needed
          installed_bt.trash(self)
          force = 1
3289
        installed_bt.replace(self)
3290
        
3291 3292 3293 3294 3295 3296 3297 3298
      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')
        gen.setupLastTools(site, update=1, create_activities=1)
             
3299 3300
      if not force:
        if len(object_to_update) == 0:
3301 3302 3303 3304 3305
          # 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():
3306
            LOG('Business Template', 0, 'Updating Business Template Workflows')
3307
            gen.setupWorkflow(site)
3308
          return
3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337

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

      # update catalog if necessary
      update_catalog=0
      catalog_method = getattr(self, '_catalog_method_item', None)
      if catalog_method is not None:
        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
              break            
      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()
              
3338 3339
      # 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
3340
      trash_tool = getToolByName(self, 'portal_trash', None)
3341
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates.objectIds()) > 1):
3342
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
3343 3344
      else:
        trashbin = None
3345
              
3346 3347 3348 3349 3350 3351 3352
      # 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)

3353
      # get objects to remove
3354
      # do remove after because we may need backup object from installation
3355 3356 3357 3358 3359 3360 3361 3362 3363
      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:
3364
          item = getattr(installed_bt, item_name, None)
3365 3366
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
3367

3368 3369 3370 3371 3372 3373 3374 3375

      # 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():
3376
        LOG('Business Template', 0, 'Updating Business Template Workflows')
3377 3378 3379 3380 3381 3382 3383 3384
        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()
       
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3385 3386 3387
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
3388

3389
    security.declareProtected(Permissions.ManagePortal, 'install')
3390 3391 3392 3393 3394
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
      """
      return self._install(**kw)
3395

3396
    install = WorkflowMethod(install)
3397

3398
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
3399
    def reinstall(self, **kw):
3400 3401 3402 3403
      """Reinstall Business Template.
      """
      return self._install(**kw)

3404
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3405

3406
    security.declareProtected(Permissions.ManagePortal, 'trash')
3407 3408
    def trash(self, new_bt, **kw):
      """
3409
        Trash unnecessary items before upgrading to a new business
3410
        template.
3411
        This is similar to uninstall, but different in that this does
3412
        not remove all items.
3413 3414 3415 3416 3417
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3418 3419
      # Trash everything
      for item_name in self._item_name_list[::-1]:
3420
        item = getattr(self, item_name, None)
3421 3422 3423 3424
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
3425

3426
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
3427
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3428
      """
3429
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3430
      """
3431 3432 3433 3434
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3435 3436 3437
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
3438
        item = getattr(self, item_name, None)
3439 3440
        if item is not None:
          item.uninstall(local_configuration)
3441
      # It is better to clear cache because the uninstallation of a
3442
      # template deletes many things from the portal.
3443
      clearCache()
3444

3445 3446
    uninstall = WorkflowMethod(uninstall)

3447
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3448
    def _clean(self):
3449
      """
3450
        Clean built information.
3451
      """
3452
      # First, remove obsolete attributes if present.
3453 3454 3455 3456
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
3457
                    '_module_archive',
3458 3459 3460
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
3461
                    '_property_sheet_archive'):
3462 3463 3464
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
3465 3466
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
3467

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

3470
    security.declareProtected(Permissions.AccessContentsInformation,
3471
                              'getBuildingState')
3472
    def getBuildingState(self, id_only=1):
3473
      """
3474
        Returns the current state in building
3475
      """
3476
      portal_workflow = getToolByName(self, 'portal_workflow')
3477 3478
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
3479
      return wf._getWorkflowStateOf(self, id_only=id_only )
3480

3481
    security.declareProtected(Permissions.AccessContentsInformation,
3482
                              'getInstallationState')
3483
    def getInstallationState(self, id_only=1):
3484
      """
3485
        Returns the current state in installation
3486
      """
3487
      portal_workflow = getToolByName(self, 'portal_workflow')
3488 3489
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
3490
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3491

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3492 3493 3494 3495 3496 3497
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
3498
      export_string = portal_templates.manage_exportObject(
3499 3500
                                               id=self.getId(),
                                               toxml=1,
3501
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3502
      return export_string
3503

3504
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3505
      """
3506 3507
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3508
      """
3509
      result = getattr(self, id, ())
3510 3511 3512 3513 3514 3515
      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
3516

3517
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3518
      """
3519 3520
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3521
      """
3522
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3523

3524
    def getTemplateBaseCategoryList(self):
3525
      """
3526 3527
      We have to set this method because we want an
      ordered list
3528
      """
3529
      return self._getOrderedList('template_base_category')
3530

3531
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3532
      """
3533 3534
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3535
      """
3536
      return self._getOrderedList('template_workflow_id')
3537

3538
    def getTemplatePortalTypeIdList(self):
3539
      """
3540 3541
      We have to set this method because we want an
      ordered list
3542
      """
3543
      return self._getOrderedList('template_portal_type_id')
3544

3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
    
    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')

3573
    def getTemplateActionPathList(self):
3574
      """
3575 3576
      We have to set this method because we want an
      ordered list
3577
      """
3578
      return self._getOrderedList('template_action_path')
3579

3580
    def getTemplateSkinIdList(self):
3581
      """
3582 3583
      We have to set this method because we want an
      ordered list
3584
      """
3585
      return self._getOrderedList('template_skin_id')
3586

3587
    def getTemplateModuleIdList(self):
3588
      """
3589 3590
      We have to set this method because we want an
      ordered list
3591
      """
3592
      return self._getOrderedList('template_module_id')
3593 3594 3595 3596 3597 3598 3599

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

3601
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
3602 3603 3604 3605
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
3606 3607
      if self.getBuildingState() != 'built':
        raise TemplateConditionError, 'Business Template must be build before export'
3608
      
Aurel's avatar
Aurel committed
3609 3610 3611 3612 3613 3614 3615
      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)

3616
      # export bt
3617
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
3618
      for prop in self.propertyMap():
3619
        prop_type = prop['type']
Aurel's avatar
Aurel committed
3620
        id = prop['id']
3621
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id', 'install_object_list_list'):
3622
          continue
Aurel's avatar
Aurel committed
3623 3624
        if id in ('template_update_business_template_workflow', 'template_update_tool') and self.getTitle() != 'erp5_core':
          continue
Aurel's avatar
Aurel committed
3625
        value = self.getProperty(id)
3626
        if prop_type in ('text', 'string', 'int', 'boolean'):
3627
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
3628
        elif prop_type in ('lines', 'tokens'):
3629
          bta.addObject(obj=str(os.linesep).join(value), name=id, path=path+os.sep+'bt', ext='')
3630

Aurel's avatar
Aurel committed
3631 3632 3633
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
3634
        
Aurel's avatar
Aurel committed
3635 3636
      return bta.finishCreation()

3637
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
3638 3639
    def importFile(self, dir = 0, file=None, root_path=None):
      """
3640
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
3641 3642 3643 3644 3645
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
3646

Aurel's avatar
Aurel committed
3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
      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())
      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())
      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())
3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716
      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(
               self.getTemplateCatalogKeywordKeyList())      
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
               self.getTemplateCatalogFullTextKeyList())      
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
               self.getTemplateCatalogRequestKeyList())      
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
               self.getTemplateCatalogMultivalueKeyList())      
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
      
Aurel's avatar
Aurel committed
3717 3718
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
3719 3720


Aurel's avatar
Aurel committed
3721
    def diffObject(self, REQUEST, **kw):
3722 3723
      """
        Make a diff between an object in the Business Template
3724
        and the same in the Business Template installed in the site
3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738
      """

      class_name_dict = {
        'Product' : '_product_item',
        'PropertySheet' : '_property_sheet_item', 
        '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',
3739 3740 3741 3742
        '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',
3743 3744 3745 3746 3747 3748 3749 3750
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
        'Action' : '_action_item',
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
3751 3752 3753 3754 3755
        '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',
3756 3757 3758 3759 3760 3761
        }

      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
      # get objects
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
3762

Aurel's avatar
Aurel committed
3763
      new_bt =self
Aurel's avatar
Aurel committed
3764
      # compare with a given business template
3765
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
3766 3767
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
3768 3769 3770 3771
        if bt2_id == self.getId():
          compare_to_zodb = 1
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
3772 3773 3774
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
3775 3776 3777 3778 3779 3780 3781 3782
          compare_to_zodb = 1
      if compare_to_zodb:
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
        
3783 3784
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
3785
      if compare_to_zodb:
Aurel's avatar
Aurel committed
3786
        # XXX maybe only build for the given object to gain time
3787
        installed_item.build(self)
3788 3789 3790 3791
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      # make diff
      diff_msg = ''
3792 3793 3794 3795 3796 3797 3798
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item', '_category_item', '_path_item',
                     '_skin_item', '_action_item']
      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_base_category_item',]
3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816
      item_list_3 = ['_document_item', '_property_sheet_item', '_extension_item', '_test_item', '_message_translation_item']
      if item_name in item_list_1:
        f1 = StringIO()
        f2 = StringIO()
        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()
        installed_obj_xml = f2.getvalue()
        f1.close()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
        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:
          diff_msg += '\n\nObject %s diff :\n' %( object_id)
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
Aurel's avatar
Aurel committed
3817
          
3818
      elif item_name in item_list_2:
3819 3820
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
3821 3822 3823 3824 3825 3826 3827 3828
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
        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:
          diff_msg += '\n\nObject %s diff :\n' %( object_id)
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
Aurel's avatar
Aurel committed
3829
          
3830 3831 3832 3833 3834 3835 3836 3837 3838
      elif item_name in item_list_3:
        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:
          diff_msg += '\n\nObject %s diff :\n' %( object_id)
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'                
3839 3840 3841

      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
3842 3843 3844
      
      return diff_msg

3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013
    
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
      bt_allowed_content_type_list = []
      bt_hidden_content_type_list = []
      bt_property_sheet_list = []
      bt_base_category_list = []
      
      bt_portal_types_id_list = list(self.getTemplatePortalTypeIdList())      
      p = self.getPortalObject()
      for id in bt_portal_types_id_list:        
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+id)
        except KeyError:
          continue
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_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
        if hasattr(portal_type, 'property_sheet_list'):
          property_sheet_list = portal_type.property_sheet_list
        if hasattr(portal_type, 'base_category_list'):
          base_category_list = portal_type.base_category_list       

        for a_id in allowed_content_type_list:            
          bt_allowed_content_type_list.append(id+' | '+a_id)
        for h_id in hidden_content_type_list:
          bt_hidden_content_type_list.append(id+' | '+h_id)
        for ps_id in property_sheet_list:           
          bt_property_sheet_list.append(id+' | '+ps_id)
        for bc_id in base_category_list:            
          bt_base_category_list.append(id+' | '+bc_id)

      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()

      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)
      setattr(self, 'template_portal_type_base_category', bt_base_category_list)        
      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:
        raise TemplateConditionError, 'No module defined in business template'    
      
      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:
          return type_list        

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

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

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