BusinessTemplate.py 174 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

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

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


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

87 88 89
catalog_method_filter_list = ('_filter_expression_archive',
                              '_filter_expression_instance_archive',
                              '_filter_type_archive',)
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112


def removeAll(entry):
  '''
    Remove all files and directories under 'entry'.
    XXX: This is defined here, because os.removedirs() is buggy.
  '''
  try:
    if os.path.isdir(entry) and not os.path.islink(entry):
      pwd = os.getcwd()
      os.chmod(entry, 0755)
      os.chdir(entry)
      for e in os.listdir(os.curdir):
        removeAll(e)
      os.chdir(pwd)
      os.rmdir(entry)
    else:
      if not os.path.islink(entry):
        os.chmod(entry, 0644)
      os.remove(entry)
  except OSError:
    pass

Aurel's avatar
Aurel committed
113

114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
def getChainByType(context):
  """
  This is used in order to construct the full list
  of mapping between type and list of workflow associated
  This is only useful in order to use
  portal_workflow.manage_changeWorkflows
  """
  pw = context.portal_workflow
  cbt = pw._chains_by_type
  ti = pw._listTypeInfo()
  types_info = []
  for t in ti:
    id = t.getId()
    title = t.Title()
    if title == id:
      title = None
    if cbt is not None and cbt.has_key(id):
      chain = ', '.join(cbt[id])
    else:
      chain = '(Default)'
    types_info.append({'id': id,
                      'title': title,
                      'chain': chain})
  new_dict = {}
  for item in types_info:
    new_dict['chain_%s' % item['id']] = item['chain']
  default_chain=', '.join(pw._default_chain)
  return (default_chain, new_dict)

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

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

  def addFolder(self, **kw):
    pass

  def addObject(self, *kw):
    pass
159

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

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

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

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

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

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

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

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

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

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

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

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

289 290
class TemplateConditionError(Exception): pass

291 292
class TemplateConflictError(Exception): pass

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

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

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

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

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

335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
  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)
350

351

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

359 360
  def getKeys(self):
    return self._objects.keys()
361

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

365 366 367
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
368
    """
369 370 371 372 373 374 375
    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
376 377
    if hasattr(aq_base(obj), '_filepath'):
      obj._filepath = None
378 379 380
    if getattr(obj, 'meta_type', None) == 'Script (Python)':
      if hasattr(aq_base(obj), '_code'):
        obj._code = None
381 382
      if hasattr(aq_base(obj), 'Python_magic'):
        obj.Python_magic = None
383 384 385
    elif getattr(obj, 'meta_type', None) == 'ERP5 PDF Form' :
      if not obj.getProperty('business_template_include_content', 1) :
        obj.deletePdfContent()
386 387
    return obj

388 389 390
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
391
  """
392

393 394 395 396
  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()
397
      self._archive.clear()
398 399 400
      for id in id_list:
        self._archive["%s/%s" % (tool_id, id)] = None

401 402 403 404 405
  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():
406
      obj = self._objects[key]
407 408
      # create folder and subfolders
      folders, id = os.path.split(key)
Aurel's avatar
Aurel committed
409 410 411 412 413 414 415
      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))
416 417 418
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
419 420
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
421

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

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

464 465 466 467 468 469 470 471 472 473
  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

474
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
475 476
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
477 478 479 480 481 482 483
      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]
484 485
          new_object = self.removeProperties(new_object)
          old_object = self.removeProperties(old_object)
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
          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
    """
509
    subobjects_dict = {}
510
    if trashbin is None: # must return subobjects
511 512 513 514 515 516
      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)
517
        subobjects_dict[subobject_id] = subobject_copy
518
      return subobjects_dict
519 520
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
521 522 523 524
      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
525

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

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
656
    trash = kw.get('trash', 0)
657 658 659 660 661
    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
662
      object_keys = self._archive.keys()
663
    for relative_url in object_keys:
664 665
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
666
      try:
667
        container = portal.unrestrictedTraverse(container_path)
668
        if trash and trashbin is not None:
669 670 671 672
          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
673
        pass
674 675
    BaseTemplateItem.uninstall(self, context, **kw)

676 677 678 679 680 681 682 683 684 685 686 687
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

688 689 690 691 692 693 694 695 696
  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()
697 698
    object_keys.sort()
    object_keys.reverse()
699
    p = context.getPortalObject()
700 701
    object_keys.sort()
    object_keys.reverse()
702 703
    for path in object_keys:
      for relative_url in self._resolvePath(p, [], path.split('/')):
704
        try:
Aurel's avatar
Aurel committed
705 706
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
707 708 709 710 711 712 713 714 715
          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)

716 717 718
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
719

720 721 722 723 724 725 726 727 728
      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.
729 730 731
      try:
        obj = folder._getOb(id)
      except AttributeError:
732
        # XXX FIXME
733 734 735
        LOG("WARNING!", 100,
            "Can not resolve '%s' during business template installation." % id)
        return []
736
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
737 738
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
739 740
      if object_id != "":
        path_list.extend(self._resolvePath(folder._getOb(object_id), relative_url_list + [object_id], id_list[1:]))
741
    return path_list
Aurel's avatar
Aurel committed
742

743 744 745
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
746
    keys = self._path_archive.keys()
747
    keys.sort()
Aurel's avatar
Aurel committed
748
    for path in keys:
749 750 751
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
752
      for relative_url in self._resolvePath(p, [], path.split('/')):
753 754
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
755
        obj = obj.__of__(context)
756
        id_list = obj.objectIds()
757
        obj = self.removeProperties(obj)
758
        if hasattr(aq_base(obj), 'groups'):
759
          # we must keep groups because it's ereased when we delete subobjects
760
          groups = deepcopy(obj.groups)
761
        if len(id_list) > 0:
762 763
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
764
          for id_ in list(id_list):
765
            obj._delObject(id_)
766
        if hasattr(aq_base(obj), 'groups'):
767 768 769
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
770

771 772
class CategoryTemplateItem(ObjectTemplateItem):

773 774
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
775

776 777 778 779
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
780 781
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
782
      obj = self.removeProperties(obj)
783
      id_list = obj.objectIds()
784
      if id_list:
785
        self.build_sub_objects(context, id_list, relative_url)
786
        for id_ in list(id_list):
787
          obj._delObject(id_)
788 789
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
790 791 792 793 794

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
795 796
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
797
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
798
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
799
      id_list = obj.objectIds()
800 801
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
802
        for id_ in list(id_list):
803
          obj._delObject(id_)
804
      else:
805
        for id_ in list(id_list):
806
          obj._delObject(id_)
807 808
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
809

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

908

909 910
class SkinTemplateItem(ObjectTemplateItem):

911 912
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
913

914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_bt, **kw)
    # We must install/update an ERP5 Form if one of its widget is modified.
    # This allow to keep the widget order and the form layout after an update
    #   from a BT to another one.
    for (bt_obj_path, bt_obj) in self._objects.items():
      if getattr(bt_obj, 'meta_type', None) == 'ERP5 Form':
        # search sub-objects of ERP5 Forms that are marked as "modified"
        for upd_obj_path in modified_object_list.keys():
          if upd_obj_path.startswith(bt_obj_path):
            # a child of the ERP5 Form must be updated, so the form too
            if not modified_object_list.has_key(bt_obj_path):
              modified_object_list.update({bt_obj_path: ['Modified', self.__class__.__name__[:-12]]})
    return modified_object_list

929
  def install(self, context, trashbin, **kw):
930
    ObjectTemplateItem.install(self, context, trashbin, **kw)
931 932
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
933 934 935 936 937
    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)
938 939 940
      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]
941 942 943 944 945 946
    # 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
947
        if context.getTemplateFormatVersion() == 1:
948 949
          if update_dict.has_key(relative_url) or force:
            if not force:
950
              if update_dict[relative_url] == 'nothing':
951
                continue
952
          obj = self._objects[relative_url]
953
        else:
954
          obj = self._archive[relative_url]
955
        skin_id = relative_url.split('/')[-1]
956
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
957 958 959 960 961 962 963 964 965 966 967 968 969
        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)
970 971 972

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
973 974 975 976
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
977
      object_keys = self._archive.keys()
978
    ps = context.portal_skins
979
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
980 981 982 983 984 985 986
    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)
987
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
988
    context.getPortalObject().changeSkin(None)
989 990 991
    ObjectTemplateItem.uninstall(self, context, **kw)


992
class WorkflowTemplateItem(ObjectTemplateItem):
993

994 995
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
996

997
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
998 999
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1000 1001 1002
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
1003
        if installed_bt._objects.has_key(path):
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
          # compare object to see it there is changes
          new_object = self._objects[path]
          old_object = installed_bt._objects[path]
          new_io = StringIO()
          old_io = StringIO()
          OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, new_io)
          OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
          new_obj_xml = new_io.getvalue()
          old_obj_xml = old_io.getvalue()
          new_io.close()
          old_io.close()
          if new_obj_xml != old_obj_xml:
            wf_id = path.split('/')[:2]
            modified_object_list.update({'/'.join(wf_id) : ['Modified', 'Workflow']})
        else: # new object
          modified_object_list.update({path : ['New', 'Workflow']})
1020 1021 1022 1023 1024 1025 1026 1027
      # 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
1028
    if context.getTemplateFormatVersion() == 1:
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
      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:
1043
            action = 'backup'
1044 1045 1046 1047 1048 1049
          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
1050
            container_url = '/'.join(container_path)
1051 1052 1053 1054 1055 1056 1057 1058
            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])
1059
          obj = self._objects[path]
1060 1061 1062
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1063 1064 1065 1066 1067
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1068 1069 1070 1071
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1072 1073
class PortalTypeTemplateItem(ObjectTemplateItem):

1074 1075
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1076 1077
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1078 1079 1080
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1081 1082
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1083 1084
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1085 1086 1087
      # remove actions and properties
      action_len = len(obj.listActions())
      obj.deleteActions(selections=range(action_len))
1088
      obj = self.removeProperties(obj)
1089 1090 1091 1092 1093 1094 1095 1096 1097
      # remove some properties
      if hasattr(obj, 'allowed_content_types'):
        setattr(obj, 'allowed_content_types', ())
      if hasattr(obj, 'hidden_content_type_list'):
        setattr(obj, 'hidden_content_type_list', ())
      if hasattr(obj, 'property_sheet_list'):
        setattr(obj, 'property_sheet_list', ())
      if hasattr(obj, 'base_category_list'):
        setattr(obj, 'base_category_list', ())
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1098 1099
      if hasattr(obj, '_roles'):
        setattr(obj, '_roles', [])
1100 1101
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1102

1103 1104
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1105 1106 1107 1108
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1109 1110
    # We now need to setup the list of workflows corresponding to
    # each portal type
1111
    (default_chain, chain_dict) = getChainByType(context)
1112
    # Set the default chain to the empty string is probably the
1113
    # best solution, by default it is 'default_workflow', which is
1114
    # not very usefull
1115
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1116
    if context.getTemplateFormatVersion() == 1:
1117
      object_list = self._objects
1118
    else:
1119 1120
      object_list = self._archive
    for path in object_list.keys():
1121 1122 1123 1124
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1125
            continue
1126 1127
        obj = object_list[path]
        portal_type = obj.id
1128 1129 1130
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1131 1132
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1133

1134 1135
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1136 1137 1138 1139 1140 1141 1142
  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:
1143
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1144 1145 1146 1147 1148
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1149
        dict[str(ptype)] = str(workflow)
1150 1151 1152 1153
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1154
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1155 1156

  def build(self, context, **kw):
1157 1158 1159 1160 1161
    # we can either specify nothing, +, - or = before the chain
    # this is used to know how to manage the chain
    # if nothing or +, chain is added to the existing one
    # if - chain is removed from the exisiting one
    # if = chain replaced the existing one
1162
    p = context.getPortalObject()
1163
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1164
    for key in self._archive.keys():
1165 1166 1167
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1168
        workflow = wflist[1]
1169
      else:
1170
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1171
        portal_type = wflist[0][:-2]
1172 1173
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1174 1175 1176 1177 1178
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
        if workflow_name not in chain_dict['chain_%s' % portal_type]:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1179
          raise NotFound, 'workflow %s not found in chain for portal_type %s'\
1180
                % (workflow, portal_type)
1181
        if self._objects.has_key(portal_type):
1182 1183
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1184
        else:
1185
          self._objects[portal_type] = [workflow,]
1186
      else:
Aurel's avatar
Aurel committed
1187
        LOG('BusinessTemplate build', 100, 'portal type %s not found in workflow chain' %(portal_type))
1188

Christophe Dumez's avatar
Christophe Dumez committed
1189
  # Function to generate XML Code Manually
1190 1191 1192 1193 1194
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1195
      workflow_list = self._objects[key]
1196 1197
      xml_data += os.linesep+' <chain>'
      xml_data += os.linesep+'  <type>%s</type>' %(key,)
1198
      xml_data += os.linesep+'  <workflow>%s</workflow>' %(', '.join(workflow_list))
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
      xml_data += os.linesep+' </chain>'
    xml_data += os.linesep+'</workflow_chain>'
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
    xml_data = self.generateXml()
    bta.addObject(obj=xml_data, name='workflow_chain_type',  path=root_path)

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # We now need to setup the list of workflows corresponding to
    # each portal type
1217
    (default_chain, chain_dict) = getChainByType(context)
1218
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1219
    # best solution, by default it is 'default_workflow', which is
1220 1221 1222 1223 1224 1225 1226
    # not very usefull
    default_chain = ''
    for path in self._objects.keys():
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1227
            continue
1228
        portal_type = path.split('/', 1)[1]
1229
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1230 1231 1232
          old_chain_dict = chain_dict['chain_%s' % portal_type]
          # XXX we don't use the chain (Default) in erp5 so don't keep it
          if old_chain_dict != '(Default)' and old_chain_dict != '':
1233
            old_chain_workflow_id_set = {}
1234
            # get existent workflow id list
1235 1236
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1237
            # get new workflow id list
1238
            for wf_id in self._objects[path].split(', '):
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
              if wf_id[0] == '-':
                # remove wf id if already present
                if old_chain_workflow_id_set.has_key(wf_id[1:]):
                  old_chain_workflow_id_set.pop(wf_id[1:])
              elif wf_id[0] == '=':
                # replace existing chain by this one
                old_chain_workflow_id_set = {}
                old_chain_workflow_id_set[wf_id[1:]] = 1
              # then either '+' or nothing, add wf id to the list
              elif wf_id[0] == '+':
                old_chain_workflow_id_set[wf_id[1:]] = 1
              else:
                old_chain_workflow_id_set[wf_id] = 1
            # create the new chain
1253 1254
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1255
          else:
1256
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1257 1258
        else:
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)

  def _importFile(self, file_name, file):
    # import workflow chain for portal_type
    dict = {}
    xml = parse(file)
    chain_list = xml.getElementsByTagName('chain')
    for chain in chain_list:
      ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
      workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
      if len(workflow_list) == 0:
        workflow = ''
      else:
        workflow = workflow_list[0].data
1274 1275
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1276 1277 1278
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1279 1280
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1281

1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):

  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'

  def build(self, context, **kw):
    for key in self._archive.keys():
      portal_type, allowed_type = key.split(' | ')
      if self._objects.has_key(portal_type):
        allowed_list = self._objects[portal_type]
        allowed_list.append(allowed_type)
        self._objects[portal_type] = allowed_list
      else:
        self._objects[portal_type] = [allowed_type]

Christophe Dumez's avatar
Christophe Dumez committed
1297
  # Function to generate XML Code Manually
1298
  def generateXml(self, path=None):
1299
    dictio = self._objects
1300
    xml_data = '<%s>' %(self.xml_tag,)
1301
    keys = dictio.keys()
1302 1303
    keys.sort()
    for key in keys:
1304
      allowed_list = dictio[key]
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
      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)

1321 1322 1323 1324 1325 1326
  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':
1327
        #must rename keys in dict if reinstall
1328 1329 1330 1331 1332 1333 1334 1335 1336
        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]
1337
          old_object = installed_bt._objects[path]
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
          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

1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
  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)
1376
        except AttributeError:
1377 1378 1379 1380 1381 1382 1383 1384
          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:
1385 1386
            if id not in property_list:
              property_list.append(id)
1387 1388
        setattr(portal_type, self.class_property, list(property_list))

Aurel's avatar
Aurel committed
1389
  def uninstall(self, context, **kw):
1390
    object_path = kw.get('object_path', None)
1391
    p = context.getPortalObject()
1392
    pt = p.unrestrictedTraverse('portal_types')
1393 1394 1395 1396 1397 1398 1399 1400
    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)
1401
      except AttributeError:
1402 1403 1404
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
1405 1406
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
1407 1408
      for id in property_list:
        if id in original_property_list:
1409
          original_property_list.remove(id)
1410
      setattr(portal_type, self.class_property, list(original_property_list))
1411

1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
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'

1427
class CatalogMethodTemplateItem(ObjectTemplateItem):
1428
  """Template Item for catalog methods.
1429

1430 1431 1432 1433 1434
    This template item stores catalog method and install them in the
    default catalog.
    The use Catalog makes for methods is saved as well and recreated on
    installation.
  """
1435

1436 1437
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1438
    # a mapping to store properties of methods.
1439 1440 1441 1442 1443
    # the mapping contains an entry for each method, and this entry is
    # another mapping having the id of the catalog property as key and a
    # boolean value to say wether the method is part of this catalog
    # configuration property.
    self._method_properties = PersistentMapping()
1444

1445 1446 1447 1448 1449
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
  def _extractMethodProperties(self, catalog, method_id):
    """Extracts properties for a given method in the catalog.
    Returns a mapping of property name -> boolean """
    method_properties = PersistentMapping()
    for prop in catalog._properties:
      if prop.get('select_variable') == 'getCatalogMethodIds':
        if prop['type'] == 'selection' and \
            getattr(catalog, prop['id']) == method_id:
          method_properties[prop['id']] = 1
        elif prop['type'] == 'multiple selection' and \
            method_id in getattr(catalog, prop['id']):
          method_properties[prop['id']] = 1
    return method_properties

1464 1465
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1466 1467
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1468 1469
    except KeyError:
      catalog = None
1470
    if catalog is None:
1471
      LOG('BusinessTemplate build', 0, 'catalog not found')
1472
      return
1473

1474 1475 1476
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
1477

1478 1479
    for obj in self._objects.values():
      method_id = obj.id
1480 1481
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
1482
      self._is_filtered_archive[method_id] = 0
1483
      if catalog.filter_dict.has_key(method_id):
1484 1485 1486 1487 1488 1489 1490 1491 1492
        if catalog.filter_dict[method_id]['filtered']:
          self._is_filtered_archive[method_id] = \
                      catalog.filter_dict[method_id]['filtered']
          self._filter_expression_archive[method_id] = \
                      catalog.filter_dict[method_id]['expression']
          self._filter_expression_instance_archive[method_id] = \
                      catalog.filter_dict[method_id]['expression_instance']
          self._filter_type_archive[method_id] = \
                      catalog.filter_dict[method_id]['type']
1493

Aurel's avatar
Aurel committed
1494 1495 1496 1497 1498
  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():
1499
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1500 1501 1502 1503 1504 1505
      # 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()
1506 1507
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1508 1509
      # add all datas specific to catalog inside one file
      catalog = context.portal_catalog.getSQLCatalog()
1510
      method_id = obj.id
1511 1512
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1513
      f = open(object_path, 'wt')
1514
      xml_data = '<catalog_method>'
1515

1516 1517 1518
      for method_property, value in self._method_properties[method_id].items():
        xml_data += os.linesep+' <item key="%s" type="int">' %(method_property,)
        xml_data += os.linesep+'  <value>%s</value>' %(value,)
1519
        xml_data += os.linesep+' </item>'
1520

Aurel's avatar
Aurel committed
1521
      if catalog.filter_dict.has_key(method_id):
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
        if catalog.filter_dict[method_id]['filtered']:
          xml_data += os.linesep+' <item key="_is_filtered_archive" type="int">'
          xml_data += os.linesep+'  <value>1</value>'
          xml_data += os.linesep+' </item>'
          for method in catalog_method_filter_list:
            value = getattr(self, method, '')[method_id]
            if method != '_filter_expression_instance_archive':
              if type(value) in (type(''), type(u'')):
                xml_data += os.linesep+' <item key="%s" type="str">' %(method,)
                xml_data += os.linesep+'  <value>%s</value>' %(str(value))
                xml_data += os.linesep+' </item>'
              elif type(value) in (type(()), type([])):
                xml_data += os.linesep+' <item key="%s" type="tuple">'%(method)
                for item in value:
                  xml_data += os.linesep+'  <value>%s</value>' %(str(item))
                xml_data += os.linesep+' </item>'
1538
      xml_data += os.linesep+'</catalog_method>'
1539
      f.write(xml_data)
Aurel's avatar
Aurel committed
1540
      f.close()
1541

Christophe Dumez's avatar
Christophe Dumez committed
1542 1543 1544 1545 1546 1547 1548 1549 1550
  # Function to generate XML Code Manually
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data
1551

1552 1553
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1554 1555
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1556
    except KeyError:
1557 1558 1559 1560 1561 1562 1563 1564
      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)
1565

1566 1567 1568
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1569
    new_bt_format = context.getTemplateFormatVersion()
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585

    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':
1586
              continue
1587 1588 1589 1590
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
1591

1592 1593
    for obj in values:
      method_id = obj.id
1594

1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
      # Restore catalog properties for methods
      if hasattr(self, '_method_properties'):
        for key in self._method_properties.get(method_id, {}).keys():
          old_value = getattr(catalog, key, None)
          if isinstance(old_value, str):
            setattr(catalog, key, method_id)
          elif isinstance(old_value, list) or isinstance(old_value, tuple):
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
1606

1607 1608
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
1609
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1610
        if context.getTemplateFormatVersion() == 1:
1611 1612 1613
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1614
        filter_type = self._filter_type_archive[method_id]
1615 1616 1617
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1618
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1619
        catalog.filter_dict[method_id]['type'] = filter_type
1620
      elif method_id in catalog.filter_dict.keys():
1621
        catalog.filter_dict[method_id]['filtered'] = 0
1622

1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
      # backward compatibility
      if hasattr(self, '_is_catalog_list_method_archive'):
        LOG("BusinessTemplate.CatalogMethodTemplateItem", 0,
            "installing old style catalog method configuration")
        is_catalog_list_method = int(
                  self._is_catalog_list_method_archive[method_id])
        is_uncatalog_method = int(
                  self._is_uncatalog_method_archive[method_id])
        is_clear_method = int(
                  self._is_clear_method_archive[method_id])

        if is_catalog_list_method and method_id not in sql_catalog_object_list:
          sql_catalog_object_list.append(method_id)
        elif not is_catalog_list_method and\
                        method_id in sql_catalog_object_list:
          sql_catalog_object_list.remove(method_id)

        if is_uncatalog_method and method_id not in sql_uncatalog_object:
          sql_uncatalog_object.append(method_id)
        elif not is_uncatalog_method and method_id in sql_uncatalog_object:
          sql_uncatalog_object.remove(method_id)

        if is_clear_method and method_id not in sql_clear_catalog:
          sql_clear_catalog.append(method_id)
        elif not is_clear_method and method_id in sql_clear_catalog:
          sql_clear_catalog.remove(method_id)
1649

1650 1651 1652 1653 1654 1655
        sql_catalog_object_list.sort()
        catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
        sql_uncatalog_object.sort()
        catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
        sql_clear_catalog.sort()
        catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1656

1657
  def uninstall(self, context, **kw):
1658 1659
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1660
    except KeyError:
1661 1662 1663 1664
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1665

1666 1667 1668 1669
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
1670 1671 1672 1673
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
1674 1675 1676 1677
    else:
      value = self._archive[object_path]
      if value is not None:
        values.append(value)
1678

1679
    for obj in values:
1680
      method_id = obj.id
1681 1682 1683 1684 1685 1686 1687 1688 1689
      # remove method references in portal_catalog
      for catalog_prop in catalog._properties:
        if catalog_prop.get('select_variable') == 'getCatalogMethodIds'\
            and catalog_prop['type'] == 'multiple selection':
          old_value = getattr(catalog, catalog_prop['id'], ())
          if method_id in old_value:
            new_value = list(old_value)
            new_value.remove(method_id)
            setattr(catalog, catalog_prop['id'], new_value)
1690

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1691
      if catalog.filter_dict.has_key(method_id):
1692
        del catalog.filter_dict[method_id]
1693

1694
    # uninstall objects
1695
    ObjectTemplateItem.uninstall(self, context, **kw)
1696

1697
  def _importFile(self, file_name, file):
1698
    if not '.catalog_keys' in file_name:
1699 1700 1701 1702 1703 1704 1705 1706
      # 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
1707
    else:
1708 1709 1710 1711
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1712
      method_list = xml.getElementsByTagName('item')
1713
      for method in method_list:
1714
        key = method.getAttribute('key')
1715 1716
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1717 1718
          value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          key = str(key)
1719
        elif key_type == "int":
1720
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1721
          key = str(key)
1722
        elif key_type == "tuple":
1723 1724 1725 1726
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1727
        else:
1728
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1729
          continue
1730
        if key in catalog_method_list or key in catalog_method_filter_list:
1731
          dict = getattr(self, key, {})
1732
          dict[id] = value
1733 1734 1735
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
1736

1737
class ActionTemplateItem(ObjectTemplateItem):
1738 1739

  def __init__(self, id_list, **kw):
1740
    # XXX It's look like ObjectTemplateItem __init__
1741 1742 1743 1744 1745 1746
    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

1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767
  def _splitPath(self, path):
    """
      Split path tries to split a complexe path such as:

      "foo/bar[id=zoo]"

      into

      "foo/bar", "id", "zoo"

      This is used mostly for generic objects
    """
    # Add error checking here
    if path.find('[') >= 0 and path.find(']') > path.find('=') and path.find('=') > path.find('['):
      relative_url = path[0:path.find('[')]
      id_block = path[path.find('[')+1:path.find(']')]
      key = id_block.split('=')[0]
      value = id_block.split('=')[1]
      return relative_url, key, value
    return path, None, None

1768 1769 1770 1771
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1772
      relative_url, value = id.split(' | ')
1773 1774
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1775
        if getattr(ai, 'id') == value:
1776
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1777
          key = os.path.join(url[-2], url[-1], value)
1778
          action = ai._getCopy(context)
1779
          action = self.removeProperties(action)
1780
          self._objects[key] = action
Aurel's avatar
Aurel committed
1781
          self._objects[key].wl_clearLocks()
1782 1783
          break
      else:
1784
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1785

1786 1787 1788
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1789
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1790 1791
      p = context.getPortalObject()
      for id in self._objects.keys():
1792 1793 1794 1795 1796 1797
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
1798 1799
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
1800
          for index in range(len(action_list)):
1801
            if getattr(action_list[index], 'id') == path[-1]:
1802
              # remove previous action
1803
              obj.deleteActions(selections=(index,))
1804
          action = self._objects[id]
1805 1806 1807
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
1808
          obj.addAction(
1809 1810
                        id = action.id
                      , name = action.title
1811
                      , action = action_text
1812 1813 1814 1815
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
1816 1817
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
1818
                      , priority = action.priority
Aurel's avatar
Aurel committed
1819
                    )
1820
          # sort action based on the priority define on it
1821 1822 1823 1824 1825 1826 1827 1828 1829
          # 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
1830
    else:
1831
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1832
      p = context.getPortalObject()
1833 1834
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
1835
        relative_url, key, value = self._splitPath(id)
1836 1837
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
1838
          if getattr(ai, key) == value:
1839
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
1840 1841 1842
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
1843
        obj.addAction(
Aurel's avatar
Aurel committed
1844 1845
                      id = action.id
                    , name = action.title
1846
                    , action = action_text
Aurel's avatar
Aurel committed
1847 1848 1849 1850
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
1851 1852
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
1853
                    )
Aurel's avatar
Aurel committed
1854 1855 1856 1857 1858 1859 1860
        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))
1861 1862
          obj.moveDownActions(selections=tuple(move_down_list))

1863 1864
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1865 1866 1867 1868
    object_path = kw.get("object_path", None)
    if object_path is not None:
      keys = [object_path]
    else:
1869
      keys = self._archive.keys()
1870
    for id in keys:
1871 1872 1873 1874
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885
        relative_url, key, value = self._splitPath(id)
      obj = p.unrestrictedTraverse(relative_url, None)
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
          if getattr(action_list[index], key) == value:
            obj.deleteActions(selections=(index,))
            break
      else :
        LOG('BusinessTemplate', 100,
            'unable to uninstall action at %s, ignoring' % relative_url )
1886 1887
    BaseTemplateItem.uninstall(self, context, **kw)

1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
    id_list = ['portal_type_roles/%s' % id for id in id_list]
    BaseTemplateItem.__init__(self, id_list, **kw)

  def build(self, context, **kw):
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      obj = p.unrestrictedTraverse("portal_types/%s" %
          relative_url.split('/', 1)[1])
      type_roles_obj = getattr(obj, '_roles', ())
      type_role_list = []
      for role in type_roles_obj:
        type_role_dict = {}
        # uniq
1904
        for property in ('id', 'title', 'description',
1905 1906 1907 1908
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
1909 1910 1911 1912
        # condition
        prop_value = getattr(role, 'condition')
        if prop_value:
          type_role_dict['condition'] = prop_value.text
1913 1914 1915 1916 1917 1918 1919 1920 1921
        # multi
        for property in ('category', 'base_category'):
          prop_value_list = []
          for prop_value in getattr(role, property):
            prop_value_list.append(prop_value)
          type_role_dict[property] = prop_value_list
        type_role_list.append(type_role_dict)
      self._objects[relative_url] = type_role_list

Christophe Dumez's avatar
Christophe Dumez committed
1922
  # Function to generate XML Code Manually
1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
      xml_data += os.linesep+"  <role id='%s'>" % role['id']
      # uniq
      for property in ('title', 'description', 'condition', 'priority',
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
          xml_data += os.linesep+"   <property id='%s'>%s</property>" % \
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
        for prop_value in role.get(property):
          xml_data += os.linesep+"   <multi_property "\
          "id='%s'>%s</multi_property>" % (property, prop_value)
      xml_data += os.linesep+"  </role>"
    xml_data += os.linesep+'</type_roles>'
    return xml_data
1943

1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      xml_data = self.generateXml(key)
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
    type_roles_list = []
    xml = parse(file)
1957
    xml_type_roles_list = xml.getElementsByTagName('role')
1958 1959 1960 1961 1962 1963 1964 1965
    for role in xml_type_roles_list:
      id = role.getAttribute('id')
      type_role_property_dict = {'id':id}
      # uniq
      property_list = role.getElementsByTagName('property')
      for property in property_list:
        property_id = property.getAttribute('id').encode()
        if property.hasChildNodes():
1966
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
1967 1968 1969 1970 1971 1972 1973 1974 1975 1976
          if property_id == 'priority':
            property_value = float(property_value)
          type_role_property_dict[property_id] = property_value
      # multi
      multi_property_list = role.getElementsByTagName('multi_property')
      for property in multi_property_list:
        property_id = property.getAttribute('id').encode()
        if not type_role_property_dict.has_key(property_id):
          type_role_property_dict[property_id] = []
        if property.hasChildNodes():
1977
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992
          type_role_property_dict[property_id].append(property_value)
      type_roles_list.append(type_role_property_dict)
    self._objects['portal_type_roles/'+file_name[:-4]] = type_roles_list

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    p = context.getPortalObject()
    for roles_path in self._objects.keys():
      if update_dict.has_key(roles_path) or force:
        if not force:
          action = update_dict[roles_path]
          if action == 'nothing':
            continue
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
1993 1994 1995 1996 1997 1998
      obj = p.unrestrictedTraverse(path, None)
      if obj is not None:
        setattr(obj, '_roles', []) # reset roles before applying
        type_roles_list = self._objects[roles_path] or []
        for type_role_property_dict in type_roles_list:
          obj._roles.append(RoleInformation(**type_role_property_dict))
1999 2000 2001 2002 2003 2004 2005 2006

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

2007 2008 2009 2010 2011 2012
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2013 2014
      for property in p.propertyMap():
        if property['id'] == id:
2015
          obj = p.getProperty(id)
2016
          prop_type = property['type']
2017 2018
          break
      else:
2019 2020
        obj = None
      if obj is None:
2021
        raise NotFound, 'the property %s is not found' % id
2022
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2023

2024 2025 2026 2027 2028 2029
  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
2030 2031
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2032 2033 2034 2035 2036 2037 2038
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2039
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2040
      self._objects[str(id)] = (str(prop_type), value)
2041

2042 2043 2044
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2045
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2046 2047
      p = context.getPortalObject()
      for path in self._objects.keys():
2048 2049 2050 2051
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2052
              continue
2053 2054 2055
          dir, id = os.path.split(path)
          if p.hasProperty(id):
            continue
2056 2057
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
2058
    else:
2059
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2060
      p = context.getPortalObject()
2061 2062
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
2063 2064 2065 2066 2067
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
2068 2069 2070

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2071 2072 2073 2074 2075 2076
    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:
2077 2078 2079 2080
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2081
  # Function to generate XML Code Manually
2082
  def generateXml(self, path=None):
2083
    xml_data = ''
2084
    prop_type, obj = self._objects[path]
2085 2086
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
2087 2088
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
2089
      xml_data += os.linesep+'  <value>'
2090
      for item in obj:
2091 2092 2093 2094
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
2095
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
2096
    xml_data += os.linesep+' </property>'
2097 2098
    return xml_data

Aurel's avatar
Aurel committed
2099 2100 2101 2102 2103
  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)
2104 2105 2106 2107
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2108
      xml_data += self.generateXml(path)
2109
    xml_data += os.linesep+'</site_property>'
2110
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2111

2112 2113 2114 2115 2116 2117 2118
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)
2119 2120 2121 2122 2123 2124 2125 2126
      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
2127

Christophe Dumez's avatar
Christophe Dumez committed
2128
  # Function to generate XML Code Manually
2129
  def generateXml(self, path=None):
2130 2131
    dict = self._objects[path]
    xml_data = '<module>'
2132 2133 2134 2135
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2136 2137 2138 2139 2140
      if key =='permission_list':
        # separe permission dict into xml
        xml_data += os.linesep+' <%s>' %(key,)
        permission_list = dict[key]
        for perm in permission_list:
2141 2142 2143 2144 2145 2146
          # the type of the permission defined if we use acquired or not
          if type(perm[1]) == type([]):
            ptype = "list"
          else:
            ptype = "tuple"
          xml_data += os.linesep+"  <permission type='%s'>" %(ptype,)
2147
          xml_data += os.linesep+'   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2148
          role_list = list(perm[1])
2149
          role_list.sort()
2150 2151 2152 2153 2154 2155 2156 2157 2158
          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

2159 2160 2161 2162 2163
  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)
2164 2165 2166
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
2167
      # expor module one by one
2168
      xml_data = self.generateXml(path=id)
2169
      bta.addObject(obj=xml_data, name=id, path=path)
2170

2171
  def install(self, context, trashbin, **kw):
2172
    portal = context.getPortalObject()
2173 2174
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2175
    if context.getTemplateFormatVersion() == 1:
2176
      items = self._objects
2177
    else:
2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189
      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)
2190
          module.portal_type = str(mapping['portal_type'])
2191 2192 2193 2194 2195 2196 2197 2198 2199 2200
        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
2201 2202 2203 2204 2205 2206 2207 2208 2209 2210

  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:
2211
          perm_type = perm.getAttribute('type').encode() or None
2212 2213 2214 2215 2216 2217 2218 2219 2220
          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))
2221 2222 2223 2224
          if perm_type == "list" or perm_type is None:
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235
          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

2236
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2237 2238 2239
    trash = kw.get('trash', 0)
    if trash:
      return
2240 2241 2242 2243 2244 2245
    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]
2246 2247
    p = context.getPortalObject()
    id_list = p.objectIds()
2248
    for id in keys:
2249
      if id in id_list:
2250
        try:
2251
          if trash and trashbin is not None:
2252 2253
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2254
          p.manage_delObjects([id])
2255
        except NotFound:
2256
          pass
2257 2258
    BaseTemplateItem.uninstall(self, context, **kw)

2259 2260 2261
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2262 2263

class DocumentTemplateItem(BaseTemplateItem):
2264 2265 2266 2267
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2268 2269 2270 2271

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

2274
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2275 2276
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296
      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
2297
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2298
      for id in self._objects.keys():
2299 2300 2301 2302 2303 2304 2305 2306 2307 2308
        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)
2309 2310 2311
          except IOError, error:
            if error.errno :
              raise
2312 2313 2314
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
2315
    else:
2316 2317 2318
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
2319
        # This raises an exception if the file exists.
2320
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
2321 2322
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
2323 2324

  def uninstall(self, context, **kw):
2325
    object_path = kw.get('object_path', None)
2326 2327 2328 2329 2330
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
2331
      globals()[self.local_file_remover_name](id)
2332 2333
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
2334 2335 2336 2337 2338 2339
  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():
2340 2341
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
2342

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

2347 2348 2349 2350 2351 2352
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

2353 2354 2355 2356 2357
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
2358

2359 2360 2361
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
2362 2363
  # Extension needs no import
  local_file_importer_name = None
2364 2365 2366 2367 2368
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
2369
  # Test needs no import
2370 2371 2372
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
2373

2374 2375 2376
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
2377 2378 2379

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2380 2381 2382 2383
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2384 2385
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
2386

2387
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2388 2389
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2390
      new_roles = self._objects.keys()
2391 2392 2393
      if installed_bt.id == 'installed_bt_for_diff':
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
2394 2395 2396
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
2397 2398
        for key in old_keys:
          new_dict[key] = ''
2399
        installed_bt._objects = new_dict
2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412
      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):
2413
    p = context.getPortalObject()
2414
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2415
    if context.getTemplateFormatVersion() == 1:
2416
      role_list = self._objects.keys()
2417
    else:
2418
      role_list = self._archive.keys()
2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430
    # 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
2431
    for role in role_list:
2432 2433 2434 2435 2436 2437 2438 2439 2440 2441
      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
2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453

  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)

2454 2455 2456 2457 2458 2459 2460 2461 2462
  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
2463
      if role in roles and role not in new_roles:
2464 2465 2466
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
2467
  # Function to generate XML Code Manually
2468
  def generateXml(self, path):
2469
    obj = self._objects[path]
2470
    xml_data = '<role_list>'
2471 2472
    obj.sort()
    for role in obj:
2473 2474 2475 2476
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

Aurel's avatar
Aurel committed
2477 2478 2479 2480 2481 2482
  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():
2483
      xml_data = self.generateXml(path=path)
2484
      bta.addObject(obj=xml_data, name=path, path=None,)
2485

2486 2487
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2488
  def build(self, context, **kw):
2489 2490
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2491
    except KeyError:
2492 2493 2494 2495
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2496
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2497
    key_list = []
2498
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2499
      if key in sql_search_result_keys:
2500
        key_list.append(key)
Aurel's avatar
Aurel committed
2501 2502
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2503
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2504
      self._objects[self.__class__.__name__+os.sep+'result_key_list'] = key_list
2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515

  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

2516
  def install(self, context, trashbin, **kw):
2517 2518 2519 2520 2521 2522 2523
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2524

2525
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2526
    if context.getTemplateFormatVersion() == 1:
2527 2528
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
2529 2530 2531
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2532
    else:
2533
      keys = self._archive.keys()
2534 2535
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2536
    # XXX same as related key
Aurel's avatar
Aurel committed
2537
    if update_dict.has_key('result_key_list') or force:
2538
      if not force:
Aurel's avatar
Aurel committed
2539
        action = update_dict['result_key_list']
2540
        if action == 'nothing':
Aurel's avatar
Aurel committed
2541
          return
2542
      for key in keys:
2543 2544
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
2545
      catalog.sql_search_result_keys = sql_search_result_keys
2546

2547
  def uninstall(self, context, **kw):
2548 2549
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2550
    except KeyError:
2551 2552 2553 2554 2555
      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)
2556
    object_path = kw.get('object_path', None)
2557 2558 2559 2560 2561
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2562 2563
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2564
    catalog.sql_search_result_keys = sql_search_result_keys
2565 2566
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2567
  # Function to generate XML Code Manually
2568
  def generateXml(self, path=None):
2569
    obj = self._objects[path]
2570
    xml_data = '<key_list>'
2571 2572
    obj.sort()
    for key in obj:
2573 2574 2575 2576
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2577 2578 2579 2580 2581
  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)
2582
    for path in self._objects.keys():
2583
      xml_data = self.generateXml(path=path)
2584
      bta.addObject(obj=xml_data, name=path, path=None)
2585

2586 2587
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

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

  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

2616
  def install(self, context, trashbin, **kw):
2617 2618 2619 2620 2621 2622 2623
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2624

2625
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2626
    if context.getTemplateFormatVersion() == 1:
2627
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2628
        return
2629 2630 2631
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2632
    else:
2633
      keys = self._archive.keys()
2634 2635
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
2636
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
2637
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
2638
      if not force:
Aurel's avatar
Aurel committed
2639 2640 2641 2642
        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
2643 2644 2645
        if action == 'nothing':
          return
      for key in keys:
2646 2647
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
2648
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
2649

2650 2651 2652
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2653
    except KeyError:
2654 2655 2656 2657
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2658
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2659
    object_path = kw.get('object_path', None)
2660 2661 2662 2663 2664
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2665 2666 2667 2668 2669
      if key in sql_catalog_related_keys:
        sql_catalog_related_keys.remove(key)
    catalog.sql_catalog_related_keys = sql_catalog_related_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2670
  # Function to generate XML Code Manually
2671
  def generateXml(self, path=None):
2672
    obj = self._objects[path]
2673
    xml_data = '<key_list>'
2674 2675
    obj.sort()
    for key in obj:
2676 2677 2678 2679
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2680 2681 2682 2683 2684 2685
  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():
2686
      xml_data = self.generateXml(path=path)
2687
      bta.addObject(obj=xml_data, name=path, path=None)
2688

2689 2690
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2691
  def build(self, context, **kw):
2692 2693
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2694
    except KeyError:
2695 2696 2697 2698
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2699
    sql_search_result_tables = list(catalog.sql_search_tables)
2700
    key_list = []
2701
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2702
      if key in sql_search_result_tables:
2703
        key_list.append(key)
Aurel's avatar
Aurel committed
2704 2705
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2706
    if len(key_list) > 0:
2707
      self._objects[self.__class__.__name__+os.sep+'result_table_list'] = key_list
2708 2709 2710 2711 2712 2713 2714 2715 2716 2717

  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
2718

2719
  def install(self, context, trashbin, **kw):
2720 2721 2722 2723 2724 2725 2726
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2727

2728
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2729
    if context.getTemplateFormatVersion() == 1:
2730
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2731
        return
2732 2733 2734
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2735
    else:
2736
      keys = self._archive.keys()
2737 2738
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2739
    # XXX same as related keys
Aurel's avatar
Aurel committed
2740
    if update_dict.has_key('result_table_list') or force:
2741
      if not force:
Aurel's avatar
Aurel committed
2742
        action = update_dict['result_table_list']
2743
        if action == 'nothing':
Aurel's avatar
Aurel committed
2744
          return
2745
      for key in keys:
2746 2747
        if key not in sql_search_tables:
          sql_search_tables.append(key)
2748
      catalog.sql_search_tables = list(sql_search_tables)
2749 2750

  def uninstall(self, context, **kw):
2751 2752
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2753
    except KeyError:
2754 2755 2756 2757 2758
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2759
    object_path = kw.get('object_path', None)
2760 2761 2762 2763 2764
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2765 2766
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2767
    catalog.sql_search_tables = sql_search_tables
2768 2769
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2770
  # Function to generate XML Code Manually
2771
  def generateXml(self, path=None):
2772
    obj = self._objects[path]
2773
    xml_data = '<key_list>'
2774 2775
    obj.sort()
    for key in obj:
2776
      xml_data += os.linesep+' <key>%s</key>' %(key)
2777
    xml_data += os.linesep+'</key_list>'
2778 2779
    return xml_data

Aurel's avatar
Aurel committed
2780 2781 2782 2783 2784 2785
  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():
2786
      xml_data = self.generateXml(path=path)
2787
      bta.addObject(obj=xml_data, name=path, path=None)
2788

2789 2790
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
2791 2792

  def build(self, context, **kw):
2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808
    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
2809

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

  def install(self, context, trashbin, **kw):
2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837
    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()
2838 2839
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859
    # 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)
2860
    object_path = kw.get('object_path', None)
2861 2862
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
2863
    else:
2864 2865 2866 2867 2868 2869 2870
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_keyword_keys:
        sql_keyword_keys.remove(key)
    catalog.sql_catalog_keyword_search_keys = sql_keyword_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2871
  # Function to generate XML Code Manually
2872 2873 2874 2875 2876 2877 2878 2879
  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
2880 2881 2882 2883

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
2884 2885 2886 2887 2888
    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)
2889

2890 2891
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
2892

2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909
  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
2910

2911 2912 2913 2914 2915 2916 2917 2918 2919
  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
2920

2921 2922 2923 2924 2925 2926 2927 2928
  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
2929

2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950
    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
2951

2952 2953 2954 2955 2956 2957 2958 2959 2960
  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)
2961
    object_path = kw.get('object_path', None)
2962 2963 2964 2965 2966 2967 2968 2969 2970 2971
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_full_text_keys:
        sql_full_text_keys.remove(key)
    catalog.sql_catalog_full_text_search_keys = sql_full_text_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2972
  # Function to generate XML Code Manually
2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062
  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)
3063
    object_path = kw.get('object_path', None)
3064 3065 3066 3067 3068 3069 3070 3071 3072 3073
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_request_keys:
        sql_catalog_request_keys.remove(key)
    catalog.sql_catalog_request_keys = sql_catalog_request_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3074
  # Function to generate XML Code Manually
3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162
  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)
3163
    object_path = kw.get('object_path', None)
3164 3165 3166 3167 3168 3169 3170 3171 3172 3173
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_multivalue_keys:
        sql_catalog_multivalue_keys.remove(key)
    catalog.sql_catalog_multivalue_keys = sql_catalog_multivalue_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3174
  # Function to generate XML Code Manually
3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263
  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)
3264
    object_path = kw.get('object_path', None)
3265 3266 3267 3268 3269 3270 3271 3272 3273 3274
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_topic_search_keys:
        sql_catalog_topic_search_keys.remove(key)
    catalog.sql_catalog_topic_search_keys = sql_catalog_topic_search_keys
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3275
  # Function to generate XML Code Manually
3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335
  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':
3336
              continue
3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365
          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
3366
      f = open(path+os.sep+'translation.po', 'wt')
3367 3368 3369 3370 3371 3372 3373
      f.write(str(obj))
      f.close()

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

Aurel's avatar
Aurel committed
3374 3375
class LocalRolesTemplateItem(BaseTemplateItem):

3376 3377 3378 3379
  def __init__(self, id_list, **kw):
    id_list = ['local_roles/%s' % id for id in id_list]
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
3380 3381 3382
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
3383
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
3384 3385 3386 3387
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
      group_local_roles_dict = getattr(obj, '__ac_local_group_roles__',
                                        {}) or {}
Aurel's avatar
Aurel committed
3388 3389
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

Christophe Dumez's avatar
Christophe Dumez committed
3390
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417
  def generateXml(self, path=None):
    local_roles_dict, group_local_roles_dict = self._objects[path]
    local_roles_keys = local_roles_dict.keys()
    group_local_roles_keys = group_local_roles_dict.keys()
    local_roles_keys.sort()
    group_local_roles_keys.sort()
    # local roles
    xml_data = '<local_roles_item>'
    xml_data += os.linesep+' <local_roles>'
    for key in local_roles_keys:
      xml_data += os.linesep+"  <role id='%s'>" %(key,)
      tuple = local_roles_dict[key]
      for item in tuple:
        xml_data += os.linesep+"   <item>%s</item>" %(item,)
      xml_data += os.linesep+"  </role>"
    xml_data += os.linesep+' </local_roles>'
    # group local roles
    xml_data += os.linesep+' <group_local_roles>'
    for key in group_local_roles_keys:
      xml_data += os.linesep+"  <role id='%s'>" %(key,)
      tuple = group_local_roles_dict[key]
      for item in tuple:
        xml_data += os.linesep+"   <item>%s</item>" %(item,)
      xml_data += os.linesep+"  </role>"
    xml_data += os.linesep+' </group_local_roles>'
    xml_data += os.linesep+'</local_roles_item>'
    return xml_data
3418

Aurel's avatar
Aurel committed
3419 3420 3421 3422 3423 3424 3425 3426 3427 3428
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      xml_data = self.generateXml(key)

      folders, id = os.path.split(key)
      encode_folders = []
3429
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
3430 3431 3432 3433
        if '%' not in folder:
          encode_folders.append(pathname2url(folder))
        else:
          encode_folders.append(folder)
3434
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
3435 3436 3437 3438 3439 3440 3441
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
    xml = parse(file)
    # local roles
    local_roles = xml.getElementsByTagName('local_roles')[0]
3442
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3443 3444 3445 3446 3447 3448 3449 3450 3451 3452
    local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
      item_type_list = []
      item_list = role.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      local_roles_dict[id] = item_type_list
    # group local roles
    group_local_roles = xml.getElementsByTagName('group_local_roles')[0]
3453
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486
    group_local_roles_dict = {}
    for role in local_roles_list:
      id = role.getAttribute('id')
      item_type_list = []
      item_list = role.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      group_local_roles_dict[id] = item_type_list
    self._objects['local_roles/'+file_name[:-4]] = (local_roles_dict, group_local_roles_dict)

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

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

3488 3489 3490
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
3491
    in part or completely. Each object is separated from its
3492 3493 3494 3495 3496 3497 3498 3499 3500 3501
    subobjects and exported in xml format.
    It may include:

    - catalog definition
      - SQL method objects
      - SQL methods including:
        - purpose (catalog, uncatalog, etc.)
        - filter definition

    - portal_types definition
Christophe Dumez's avatar
Christophe Dumez committed
3502 3503
      - object without optimal actions
      - list of relation between portal type and workflow
3504 3505 3506 3507 3508 3509 3510 3511 3512 3513

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

    - site property definition
      - id
      - type
3514
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3515

3516 3517
    - document/propertysheet/extension/test definition
      - copy of the local file
3518

3519
    - message transalation definition
3520
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3521

3522 3523
    The Business Template properties are exported to the bt folder with
    one property per file
3524

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3525 3526
    Technology:

3527 3528
    - 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
3529

3530
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3531 3532 3533 3534

    Use case:

    - install core ERP5 (the minimum)
3535

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

3538 3539
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
3540
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3541 3542 3543 3544 3545
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
3546
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3547 3548 3549 3550 3551
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
3552
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3553 3554 3555 3556 3557 3558 3559

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
3560
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3561
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3562
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3563 3564 3565
                      , PropertySheet.BusinessTemplate
                      )

3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582
    # 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
      }

3583 3584 3585 3586 3587
    # This is a global variable
    # Order is important for installation
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
3588
      '_constraint_item',
3589 3590 3591 3592 3593 3594 3595 3596
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
3597
      '_portal_type_workflow_chain_item',
3598 3599 3600 3601
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
3602 3603 3604
      '_category_item',
      '_module_item',
      '_skin_item',
3605
      '_path_item',
3606
      '_action_item',
3607
      '_portal_type_roles_item',
3608
      '_local_roles_item',
3609
      '_catalog_method_item',
3610 3611 3612
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
3613 3614 3615 3616 3617
      '_catalog_keyword_key_item',
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
3618 3619 3620 3621
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3622 3623 3624 3625 3626 3627
      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
3628
        self._baseGetTemplateFormatVersion()
3629

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3630 3631 3632
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
3633

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3634
      return 0
3635

3636
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
3637 3638 3639 3640 3641 3642 3643
    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".
3644 3645
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
3646
          # XXX Not good to access the attribute directly,
3647 3648 3649
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
3650

3651
    security.declareProtected(Permissions.ManagePortal, 'build')
3652
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3653 3654 3655
      """
        Copy existing portal objects to self
      """
3656
      if no_action: return # this is use at import of Business Template to get the status built
3657 3658
      # Make sure that everything is sane.
      self.clean()
3659

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3660 3661 3662
      # Set the format version.
      self._setTemplateFormatVersion(1)

3663 3664 3665
      # Store all datas
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
3666
      self._portal_type_workflow_chain_item = \
3667
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
3668 3669 3670 3671 3672 3673 3674 3675 3676 3677
      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())
3678 3679
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
3680 3681 3682 3683 3684 3685 3686 3687
      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())
3688 3689
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709
      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())
3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721
      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())
3722 3723
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
3724 3725
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
3726
               self.getTemplateCatalogKeywordKeyList())
3727 3728
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
3729
               self.getTemplateCatalogFullTextKeyList())
3730 3731
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
3732
               self.getTemplateCatalogRequestKeyList())
3733 3734
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
3735
               self.getTemplateCatalogMultivalueKeyList())
3736 3737 3738
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
3739 3740 3741
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
3742

3743 3744 3745
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
3746

3747
    build = WorkflowMethod(build)
3748 3749

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3750
      """
3751
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3752
      """
3753
      return self.portal_templates.publish(self, url, username=username,
3754
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3755

3756
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3757
      """
3758
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3759
      """
3760
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3761

3762 3763 3764 3765
    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
3766
      """
3767

3768 3769
      modified_object_list = {}
      bt_title = self.getTitle()
3770 3771 3772 3773 3774 3775 3776

      #  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)
3777 3778 3779
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3780
        installed_bt_format = installed_bt.getTemplateFormatVersion()
3781

3782
      # if reinstall business template, must compare to object in ZODB
3783
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
3784
      # same if we make a diff and select only one business template
3785
      reinstall = 0
3786 3787
      if installed_bt == self:
        reinstall = 1
3788 3789 3790
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
3791 3792 3793
        bt2.edit(description='tmp bt generated for diff')
        bt2.build()
        installed_bt = bt2
3794

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3795
      new_bt_format = self.getTemplateFormatVersion()
3796 3797 3798 3799 3800 3801
      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:
3802
          item = getattr(self, item_name, None)
3803 3804 3805 3806
          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
3807

3808 3809 3810 3811
      # 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:
3812
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3813
        old_item = getattr(installed_bt, item_name, None)
3814
        if new_item is not None:
3815
          if old_item is not None and hasattr(old_item, '_objects'):
3816 3817 3818 3819 3820 3821 3822 3823
            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:
3824
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
3825

3826 3827 3828 3829
      return modified_object_list

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

3834 3835
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
3836
      if installed_bt is not None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3837
        if installed_bt.getTemplateFormatVersion() == 0:
3838
          force = 1
3839
        installed_bt.replace(self)
3840

3841 3842 3843 3844
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

3845 3846 3847
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
3848

3849 3850 3851 3852 3853 3854
      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')
3855
        gen.setupLastTools(site, update=1, create_activities=1)
3856 3857
      if not force:
        if len(object_to_update) == 0:
3858 3859 3860 3861 3862
          # 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():
3863
            LOG('Business Template', 0, 'Updating Business Template Workflows')
3864
            gen.setupWorkflow(site)
3865
          return
3866 3867 3868 3869

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

3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884
      # always created a trash bin because we may to save object already present
      # but not in a previous business templates apart at creation of a new site
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates.objectIds()) > 1):
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

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

3886 3887 3888
      # update catalog if necessary
      update_catalog=0
      catalog_method = getattr(self, '_catalog_method_item', None)
3889
      if catalog_method is not None and self.getTemplateFormatVersion() == 1:
3890 3891 3892 3893 3894 3895 3896 3897 3898
        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
3899
              break
3900 3901 3902 3903 3904 3905 3906 3907
      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()
3908

3909
      # get objects to remove
3910
      # do remove after because we may need backup object from installation
3911 3912 3913 3914 3915 3916 3917 3918 3919
      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:
3920
          item = getattr(installed_bt, item_name, None)
3921 3922
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
3923

3924 3925 3926 3927 3928 3929 3930 3931

      # 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():
3932
        LOG('Business Template', 0, 'Updating Business Template Workflows')
3933 3934 3935 3936 3937 3938 3939
        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()
3940

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3941 3942 3943
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
3944

3945
    security.declareProtected(Permissions.ManagePortal, 'install')
3946 3947 3948
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
3949
      """
3950
      return self._install(**kw)
3951

3952
    install = WorkflowMethod(install)
3953

3954
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
3955
    def reinstall(self, **kw):
3956 3957 3958 3959
      """Reinstall Business Template.
      """
      return self._install(**kw)

3960
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3961

3962
    security.declareProtected(Permissions.ManagePortal, 'trash')
3963 3964
    def trash(self, new_bt, **kw):
      """
3965
        Trash unnecessary items before upgrading to a new business
3966
        template.
3967
        This is similar to uninstall, but different in that this does
3968
        not remove all items.
3969 3970 3971 3972 3973
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3974 3975
      # Trash everything
      for item_name in self._item_name_list[::-1]:
3976
        item = getattr(self, item_name, None)
3977 3978 3979 3980
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
3981

3982
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
3983
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3984
      """
3985
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3986
      """
3987 3988 3989 3990
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3991 3992 3993
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
3994
        item = getattr(self, item_name, None)
3995 3996
        if item is not None:
          item.uninstall(local_configuration)
3997
      # It is better to clear cache because the uninstallation of a
3998
      # template deletes many things from the portal.
3999
      clearCache()
4000

4001 4002
    uninstall = WorkflowMethod(uninstall)

4003
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4004
    def _clean(self):
4005
      """
4006
        Clean built information.
4007
      """
4008
      # First, remove obsolete attributes if present.
4009 4010 4011 4012
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4013
                    '_module_archive',
4014 4015 4016
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4017
                    '_property_sheet_archive'):
4018 4019 4020
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4021 4022
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4023

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

4026
    security.declareProtected(Permissions.AccessContentsInformation,
4027
                              'getBuildingState')
4028
    def getBuildingState(self, id_only=1):
4029
      """
4030
        Returns the current state in building
4031
      """
4032
      portal_workflow = getToolByName(self, 'portal_workflow')
4033 4034
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4035
      return wf._getWorkflowStateOf(self, id_only=id_only )
4036

4037
    security.declareProtected(Permissions.AccessContentsInformation,
4038
                              'getInstallationState')
4039
    def getInstallationState(self, id_only=1):
4040
      """
4041
        Returns the current state in installation
4042
      """
4043
      portal_workflow = getToolByName(self, 'portal_workflow')
4044 4045
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4046
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4047

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4048 4049 4050 4051 4052 4053
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4054
      export_string = portal_templates.manage_exportObject(
4055 4056
                                               id=self.getId(),
                                               toxml=1,
4057
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4058
      return export_string
4059

4060
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4061
      """
4062 4063
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4064
      """
4065
      result = getattr(self, id, ())
4066 4067 4068 4069 4070 4071
      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
4072

4073
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4074
      """
4075 4076
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4077
      """
4078
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4079

4080
    def getTemplateBaseCategoryList(self):
4081
      """
4082 4083
      We have to set this method because we want an
      ordered list
4084
      """
4085
      return self._getOrderedList('template_base_category')
4086

4087
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4088
      """
4089 4090
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4091
      """
4092
      return self._getOrderedList('template_workflow_id')
4093

4094
    def getTemplatePortalTypeIdList(self):
4095
      """
4096 4097
      We have to set this method because we want an
      ordered list
4098
      """
4099
      return self._getOrderedList('template_portal_type_id')
4100

4101 4102 4103 4104 4105 4106 4107
    def getTemplatePortalTypeWorkflowChainList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_workflow_chain')

Alexandre Boeglin's avatar
Alexandre Boeglin committed
4108 4109 4110 4111 4112 4113 4114
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

4115 4116 4117 4118 4119 4120
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4121

4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142
    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')

4143
    def getTemplateActionPathList(self):
4144
      """
4145 4146
      We have to set this method because we want an
      ordered list
4147
      """
4148
      return self._getOrderedList('template_action_path')
4149

4150 4151 4152 4153 4154 4155 4156
    def getTemplatePortalTypeRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_roles')

4157
    def getTemplateSkinIdList(self):
4158
      """
4159 4160
      We have to set this method because we want an
      ordered list
4161
      """
4162
      return self._getOrderedList('template_skin_id')
4163

4164
    def getTemplateModuleIdList(self):
4165
      """
4166 4167
      We have to set this method because we want an
      ordered list
4168
      """
4169
      return self._getOrderedList('template_module_id')
4170 4171 4172 4173 4174 4175 4176

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

4178
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
4179 4180 4181 4182
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
4183 4184
      if self.getBuildingState() != 'built':
        raise TemplateConditionError, 'Business Template must be build before export'
4185

Aurel's avatar
Aurel committed
4186 4187 4188 4189 4190 4191 4192
      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)

4193
      # export bt
4194
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
4195
      for prop in self.propertyMap():
4196
        prop_type = prop['type']
Aurel's avatar
Aurel committed
4197
        id = prop['id']
4198
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id', 'install_object_list_list'):
4199
          continue
Aurel's avatar
Aurel committed
4200
        value = self.getProperty(id)
4201
        if prop_type in ('text', 'string', 'int', 'boolean'):
4202
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
4203
        elif prop_type in ('lines', 'tokens'):
4204
          bta.addObject(obj=str(os.linesep).join(value), name=id, path=path+os.sep+'bt', ext='')
4205

Aurel's avatar
Aurel committed
4206 4207 4208
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
4209

Aurel's avatar
Aurel committed
4210 4211
      return bta.finishCreation()

4212
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
4213 4214
    def importFile(self, dir = 0, file=None, root_path=None):
      """
4215
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
4216 4217 4218 4219 4220
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
4221

Aurel's avatar
Aurel committed
4222 4223
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4224
      self._portal_type_workflow_chain_item = \
4225
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
4226 4227 4228 4229 4230 4231 4232 4233 4234 4235
      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())
4236 4237
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
4238 4239 4240 4241 4242 4243 4244 4245
      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())
4246 4247
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269
      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())
4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283
      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(
4284
               self.getTemplateCatalogKeywordKeyList())
4285 4286
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4287
               self.getTemplateCatalogFullTextKeyList())
4288 4289
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4290
               self.getTemplateCatalogRequestKeyList())
4291 4292
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4293
               self.getTemplateCatalogMultivalueKeyList())
4294 4295 4296
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4297 4298 4299
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
4300

Aurel's avatar
Aurel committed
4301 4302
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4303

4304 4305 4306 4307 4308 4309 4310 4311 4312
    #By christophe Dumez <christophe@nexedi.com>
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
        item = getattr(self, item_name)
        items_list.extend(item.getKeys())
      return items_list
4313

Aurel's avatar
Aurel committed
4314
    def diffObject(self, REQUEST, **kw):
4315 4316
      """
        Make a diff between an object in the Business Template
4317
        and the same in the Business Template installed in the site
4318 4319 4320 4321
      """

      class_name_dict = {
        'Product' : '_product_item',
4322
        'PropertySheet' : '_property_sheet_item',
4323
        'Constraint' : '_constraint_item',
4324 4325 4326 4327 4328 4329 4330 4331 4332
        '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',
4333
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
4334 4335 4336 4337
        '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',
4338 4339 4340 4341 4342
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
        'Action' : '_action_item',
4343
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4344
        'LocalRoles' : '_local_roles_item',
4345 4346 4347
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4348 4349 4350 4351 4352
        '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',
4353
        }
4354

4355 4356
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
4357

Christophe Dumez's avatar
Christophe Dumez committed
4358
      # Get objects
4359
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4360

Aurel's avatar
Aurel committed
4361
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
4362
      # Compare with a given business template
4363
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
4364 4365
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
4366 4367
        if bt2_id == self.getId():
          compare_to_zodb = 1
4368
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
4369 4370
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
4371 4372 4373
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
4374 4375 4376
          compare_to_zodb = 1
      if compare_to_zodb:
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
Christophe Dumez's avatar
Christophe Dumez committed
4377
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
4378 4379 4380
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
4381

4382 4383
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
4384
      if compare_to_zodb:
Aurel's avatar
Aurel committed
4385
        # XXX maybe only build for the given object to gain time
4386
        installed_item.build(self)
4387 4388 4389
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
4390

Christophe Dumez's avatar
Christophe Dumez committed
4391
      # Real Zope Objects (can be exported into XML directly by Zope)
4392
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item', '_category_item', '_path_item',
Christophe Dumez's avatar
Christophe Dumez committed
4393
                     '_skin_item', '_action_item',]
4394

Christophe Dumez's avatar
Christophe Dumez committed
4395 4396
      # Not considered as objects by Zope (will be exported into XML manually)
      item_list_2 = ['_site_property_item', '_module_item', '_catalog_result_key_item', '_catalog_related_key_item', '_catalog_result_table_item', '_catalog_keyword_key_item', '_catalog_full_text_key_item', '_catalog_request_key_item', '_catalog_multivalue_key_item', '_catalog_topic_key_item', '_portal_type_allowed_content_type_item', '_portal_type_hidden_content_type_item', '_portal_type_property_sheet_item', '_portal_type_roles_item', '_portal_type_base_category_item', '_local_roles_item', '_portal_type_workflow_chain_item',]
4397

Christophe Dumez's avatar
Christophe Dumez committed
4398 4399
      # Text objects (no need to export them into XML)
      item_list_3 = ['_document_item', '_property_sheet_item', '_constraint_item', '_extension_item', '_test_item', '_message_translation_item',]
4400

4401
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
4402 4403 4404
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
4405 4406
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
4407
        # XML Export in memory
4408 4409 4410
        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()
4411
        f1.close()
4412 4413 4414 4415
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
4416
        # End of XML export
4417

4418
        # Diff between XML objects
4419 4420
        diff_list = list(unified_diff(installed_ob_xml_lines, new_ob_xml_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
Christophe Dumez's avatar
Christophe Dumez committed
4421
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4422 4423 4424
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4425

4426
      elif item_name in item_list_2:
4427
        # Generate XML code manually
4428 4429
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
4430 4431
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
4432
        # End of XML Code Generation
4433

4434
        # Diff between XML objects
4435 4436
        diff_list = list(unified_diff(installed_obj_xml_lines, new_obj_xml_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
Christophe Dumez's avatar
Christophe Dumez committed
4437
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4438 4439 4440
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4441

4442
      elif item_name in item_list_3:
4443
        # Diff between text objects
4444 4445 4446 4447
        new_obj_lines = new_object.splitlines()
        installed_obj_lines = installed_object.splitlines()
        diff_list = list(unified_diff(installed_obj_lines, new_obj_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
Christophe Dumez's avatar
Christophe Dumez committed
4448
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4449 4450
          diff_msg += '\n'.join(diff_list)
        else:
4451
          diff_msg = 'No diff'
4452

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

4456 4457
      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4458

4459
      return diff_msg
4460

4461

4462 4463 4464 4465
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
4466 4467 4468 4469 4470 4471 4472
      bt_allowed_content_type_list = list(getattr(self, 'template_portal_type_allowed_content_type', []) or [])
      bt_hidden_content_type_list = list(getattr(self, 'template_portal_type_hidden_content_type', []) or [])
      bt_property_sheet_list = list(getattr(self, 'template_portal_type_property_sheet', []) or [])
      bt_base_category_list = list(getattr(self, 'template_portal_type_base_category', []) or [])
      bt_action_list = list(getattr(self, 'template_action_path', []) or [])
      bt_portal_types_id_list = list(self.getTemplatePortalTypeIdList())
      bt_portal_type_roles_list =  list(getattr(self, 'template_portal_type_roles', []) or [])
4473 4474 4475 4476 4477 4478 4479
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

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

4481
      p = self.getPortalObject()
4482
      for id in bt_portal_types_id_list:
4483 4484 4485 4486
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+id)
        except KeyError:
          continue
4487
        if len(getattr(portal_type, '_roles', ())) > 0:
4488 4489
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
4490

4491 4492 4493 4494
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
4495
        action_list = []
4496
        wf_list = []
4497 4498 4499 4500 4501 4502 4503
        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'):
4504
          base_category_list = portal_type.base_category_list
4505 4506
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
4507
        if chain_dict.has_key('chain_%s' % id):
Aurel's avatar
Aurel committed
4508 4509 4510
          chain = chain_dict['chain_%s' % id]
          if chain != '' and chain != '(Default)':
            wf_list = chain.split(', ')
4511

4512 4513 4514 4515
        for a_id in allowed_content_type_list:
          allowed_id = id+' | '+a_id
          if allowed_id not in bt_allowed_content_type_list:
            bt_allowed_content_type_list.append(allowed_id)
4516

4517
        for h_id in hidden_content_type_list:
4518 4519 4520
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
4521

4522 4523 4524 4525
        for ps_id in property_sheet_list:
          p_sheet_id = id+' | '+ps_id
          if p_sheet_id not in bt_property_sheet_list:
            bt_property_sheet_list.append(p_sheet_id)
4526

4527 4528 4529 4530
        for bc_id in base_category_list:
          base_cat_id = id+' | '+bc_id
          if base_cat_id not in bt_base_category_list:
            bt_base_category_list.append(base_cat_id)
4531

4532 4533 4534 4535
        for act_id in action_list:
          action_id = id+' | '+act_id
          if action_id not in bt_action_list:
            bt_action_list.append(action_id)
4536 4537 4538 4539 4540

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

4542 4543 4544 4545
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
4546
      bt_action_list.sort()
4547
      bt_wf_chain_list.sort()
4548

4549
      setattr(self, 'template_portal_type_workflow_chain', bt_wf_chain_list)
4550
      setattr(self, 'template_portal_type_roles', bt_portal_type_roles_list)
4551 4552 4553
      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)
4554
      setattr(self, 'template_portal_type_base_category', bt_base_category_list)
4555
      setattr(self, 'template_action_path', bt_action_list)
4556 4557 4558 4559 4560 4561 4562 4563 4564
      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:
4565 4566
        raise TemplateConditionError, 'No module defined in business template'

4567 4568 4569 4570 4571 4572 4573 4574
      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:
4575
          return type_list
4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589

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

4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666
      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)
4667

4668 4669 4670 4671 4672 4673 4674 4675

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

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