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

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
665
    trash = kw.get('trash', 0)
666 667 668 669 670
    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
671
      object_keys = self._archive.keys()
672
    for relative_url in object_keys:
673 674
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
675
      try:
676
        container = portal.unrestrictedTraverse(container_path)
677
        if trash and trashbin is not None:
678 679 680 681
          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
682
        pass
683 684
    BaseTemplateItem.uninstall(self, context, **kw)

685 686 687 688 689 690 691 692 693 694 695 696
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

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

727 728 729
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
730

731 732 733 734 735 736 737 738 739
      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.
740 741 742
      try:
        obj = folder._getOb(id)
      except AttributeError:
743
        # XXX FIXME
744 745 746
        LOG("WARNING!", 100,
            "Can not resolve '%s' during business template installation." % id)
        return []
747
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
748 749
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
750
      if object_id != "":
751
        path_list.extend(self._resolvePath(
752
            folder._getOb(object_id),
753
            relative_url_list + [object_id], id_list[1:]))
754
    return path_list
Aurel's avatar
Aurel committed
755

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

784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
class PreferenceTemplateItem(PathTemplateItem):
  """
  This class is used to store preference objects
  """
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
    This method calls itself recursively.

    The folder is the current object which contains sub-objects.
    The list of ids are path components. If the list is empty,
    the current folder is valid.
    """
    if relative_url_list != []:
      LOG("PreferenceTemplateItem, _resolvePath", WARNING,
          "Should be empty")
    if len(id_list) is not None:
      LOG("PreferenceTemplateItem, _resolvePath", WARNING,
          "Should contain only one element")
    # XXX hardcoded
    return ['portal_preferences/%s' % id_list[0]]

  def install(self, context, trashbin, **kw):
    """
    Enable Preference
    """
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    for object_path in self._objects.keys():
      object = portal.unrestrictedTraverse(object_path)
      # XXX getPreferenceState is a bad name
      if object.getPreferenceState() == 'disabled':
        object.portal_workflow.doActionFor(
                      object,
                      'enable_action',
                      wf_id='preference_workflow',
                      comment="Initialized during Business Template " \
                              "installation.")

822 823
class CategoryTemplateItem(ObjectTemplateItem):

824 825
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
826

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

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

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

959

960 961
class SkinTemplateItem(ObjectTemplateItem):

962 963
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
964

965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
  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

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

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


1044
class WorkflowTemplateItem(ObjectTemplateItem):
1045

1046 1047
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1048

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


1124 1125
class PortalTypeTemplateItem(ObjectTemplateItem):

1126 1127
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1128 1129
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1130 1131 1132
    self._workflow_chain_archive = PersistentMapping()

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

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

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

1206
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1207 1208

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

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

1341 1342
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1343

1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
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
1359
  # Function to generate XML Code Manually
1360
  def generateXml(self, path=None):
1361
    dictio = self._objects
1362
    xml_data = '<%s>' %(self.xml_tag,)
1363
    keys = dictio.keys()
1364 1365
    keys.sort()
    for key in keys:
1366
      allowed_list = dictio[key]
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
      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)

1383 1384 1385 1386 1387 1388
  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':
1389
        #must rename keys in dict if reinstall
1390 1391 1392 1393 1394 1395 1396 1397 1398
        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]
1399
          old_object = installed_bt._objects[path]
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410
          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

1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
  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)
1438
        except AttributeError:
1439 1440 1441 1442 1443 1444 1445 1446
          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:
1447 1448
            if id not in property_list:
              property_list.append(id)
1449 1450
        setattr(portal_type, self.class_property, list(property_list))

Aurel's avatar
Aurel committed
1451
  def uninstall(self, context, **kw):
1452
    object_path = kw.get('object_path', None)
1453
    p = context.getPortalObject()
1454
    pt = p.unrestrictedTraverse('portal_types')
1455 1456 1457 1458 1459 1460 1461 1462
    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)
1463
      except AttributeError:
1464 1465 1466
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
1467 1468
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
1469 1470
      for id in property_list:
        if id in original_property_list:
1471
          original_property_list.remove(id)
1472
      setattr(portal_type, self.class_property, list(original_property_list))
1473

1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
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'

1489
class CatalogMethodTemplateItem(ObjectTemplateItem):
1490
  """Template Item for catalog methods.
1491

1492 1493 1494 1495 1496
    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.
  """
1497

1498 1499
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1500
    # a mapping to store properties of methods.
1501 1502 1503 1504 1505
    # 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()
1506

1507 1508 1509 1510 1511
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
  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

1526 1527
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1528

1529 1530
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1531 1532
    except KeyError:
      catalog = None
1533
    if catalog is None:
1534
      LOG('BusinessTemplate build', 0, 'catalog not found')
1535
      return
1536

1537 1538 1539
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
1540

1541 1542
    for obj in self._objects.values():
      method_id = obj.id
1543 1544
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
1545
      self._is_filtered_archive[method_id] = 0
1546
      if catalog.filter_dict.has_key(method_id):
1547 1548 1549 1550 1551 1552 1553 1554 1555
        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']
1556

Aurel's avatar
Aurel committed
1557
  def export(self, context, bta, **kw):
1558 1559 1560 1561 1562 1563 1564 1565
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

Aurel's avatar
Aurel committed
1566 1567 1568 1569
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
1570
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1571 1572 1573 1574 1575 1576
      # 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()
1577 1578
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1579 1580
      # add all datas specific to catalog inside one file
      catalog = context.portal_catalog.getSQLCatalog()
1581
      method_id = obj.id
1582 1583
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1584
      f = open(object_path, 'wt')
1585
      xml_data = '<catalog_method>'
1586

1587 1588 1589
      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,)
1590
        xml_data += os.linesep+' </item>'
1591

Aurel's avatar
Aurel committed
1592
      if catalog.filter_dict.has_key(method_id):
1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608
        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>'
1609
      xml_data += os.linesep+'</catalog_method>'
1610
      f.write(xml_data)
Aurel's avatar
Aurel committed
1611
      f.close()
1612

Christophe Dumez's avatar
Christophe Dumez committed
1613 1614 1615 1616 1617 1618 1619 1620 1621
  # 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
1622

1623 1624
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1625 1626
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1627
    except KeyError:
1628 1629 1630 1631 1632 1633 1634 1635
      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)
1636

1637 1638 1639
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1640
    new_bt_format = context.getTemplateFormatVersion()
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656

    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':
1657
              continue
1658 1659 1660 1661
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
1662

1663 1664
    for obj in values:
      method_id = obj.id
1665

1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
      # 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))
1677

1678 1679
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
1680
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1681
        if context.getTemplateFormatVersion() == 1:
1682 1683 1684
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1685
        filter_type = self._filter_type_archive[method_id]
1686 1687 1688
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1689
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1690
        catalog.filter_dict[method_id]['type'] = filter_type
1691
      elif method_id in catalog.filter_dict.keys():
1692
        catalog.filter_dict[method_id]['filtered'] = 0
1693

1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719
      # 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)
1720

1721 1722 1723 1724 1725 1726
        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)
1727

1728
  def uninstall(self, context, **kw):
1729 1730
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1731
    except KeyError:
1732 1733 1734 1735
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1736

1737 1738 1739 1740
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
1741 1742 1743 1744
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
1745 1746 1747 1748
    else:
      value = self._archive[object_path]
      if value is not None:
        values.append(value)
1749

1750
    for obj in values:
1751
      method_id = obj.id
1752 1753 1754 1755 1756 1757 1758 1759 1760
      # 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)
1761

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1762
      if catalog.filter_dict.has_key(method_id):
1763
        del catalog.filter_dict[method_id]
1764

1765
    # uninstall objects
1766
    ObjectTemplateItem.uninstall(self, context, **kw)
1767

1768
  def _importFile(self, file_name, file):
1769
    if not '.catalog_keys' in file_name:
1770 1771 1772 1773 1774 1775 1776 1777
      # 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
1778
    else:
1779 1780 1781 1782
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1783
      method_list = xml.getElementsByTagName('item')
1784
      for method in method_list:
1785
        key = method.getAttribute('key')
1786 1787
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1788 1789
          value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          key = str(key)
1790
        elif key_type == "int":
1791
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1792
          key = str(key)
1793
        elif key_type == "tuple":
1794 1795 1796 1797
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1798
        else:
1799
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1800
          continue
1801
        if key in catalog_method_list or key in catalog_method_filter_list:
1802
          dict = getattr(self, key, {})
1803
          dict[id] = value
1804 1805 1806
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
1807

1808
class ActionTemplateItem(ObjectTemplateItem):
1809 1810

  def __init__(self, id_list, **kw):
1811
    # XXX It's look like ObjectTemplateItem __init__
1812 1813 1814 1815 1816 1817
    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

1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838
  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

1839 1840 1841 1842
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1843
      relative_url, value = id.split(' | ')
1844 1845
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1846
        if getattr(ai, 'id') == value:
1847
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1848
          key = os.path.join(url[-2], url[-1], value)
1849
          action = ai._getCopy(context)
1850
          action = self.removeProperties(action)
1851
          self._objects[key] = action
Aurel's avatar
Aurel committed
1852
          self._objects[key].wl_clearLocks()
1853 1854
          break
      else:
1855
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1856

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

1934 1935
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1936 1937 1938 1939
    object_path = kw.get("object_path", None)
    if object_path is not None:
      keys = [object_path]
    else:
1940
      keys = self._archive.keys()
1941
    for id in keys:
1942 1943 1944 1945
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956
        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 )
1957 1958
    BaseTemplateItem.uninstall(self, context, **kw)

1959 1960 1961
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
1962
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974
    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
1975
        for property in ('id', 'title', 'description',
1976 1977 1978 1979
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
1980 1981 1982 1983
        # condition
        prop_value = getattr(role, 'condition')
        if prop_value:
          type_role_dict['condition'] = prop_value.text
1984 1985 1986 1987 1988 1989 1990 1991 1992
        # 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
1993
  # Function to generate XML Code Manually
1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
  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'):
2008
        for prop_value in role.get(property, []):
2009 2010 2011 2012 2013
          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
2014

2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
  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)
2028
    xml_type_roles_list = xml.getElementsByTagName('role')
2029 2030 2031 2032 2033 2034 2035 2036
    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():
2037
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2038 2039 2040 2041 2042 2043 2044 2045 2046 2047
          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():
2048
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063
          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]
2064 2065 2066 2067 2068 2069
      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))
2070 2071 2072 2073 2074 2075 2076 2077

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

2078 2079 2080 2081 2082 2083
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2084 2085
      for property in p.propertyMap():
        if property['id'] == id:
2086
          obj = p.getProperty(id)
2087
          prop_type = property['type']
2088 2089
          break
      else:
2090 2091
        obj = None
      if obj is None:
2092
        raise NotFound, 'the property %s is not found' % id
2093
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2094

2095 2096 2097 2098 2099 2100
  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
2101 2102
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2103 2104 2105 2106 2107 2108 2109
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2110
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2111
      self._objects[str(id)] = (str(prop_type), value)
2112

2113 2114 2115
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2116
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2117 2118
      p = context.getPortalObject()
      for path in self._objects.keys():
2119 2120 2121 2122
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2123
              continue
2124 2125 2126
          dir, id = os.path.split(path)
          if p.hasProperty(id):
            continue
2127 2128
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
2129
    else:
2130
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2131
      p = context.getPortalObject()
2132 2133
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
2134 2135 2136 2137 2138
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
2139 2140 2141

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2142 2143 2144 2145 2146 2147
    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:
2148 2149 2150 2151
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2152
  # Function to generate XML Code Manually
2153
  def generateXml(self, path=None):
2154
    xml_data = ''
2155
    prop_type, obj = self._objects[path]
2156 2157
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
2158 2159
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
2160
      xml_data += os.linesep+'  <value>'
2161
      for item in obj:
2162 2163 2164 2165
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
2166
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
2167
    xml_data += os.linesep+' </property>'
2168 2169
    return xml_data

Aurel's avatar
Aurel committed
2170 2171 2172 2173 2174
  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)
2175 2176 2177 2178
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2179
      xml_data += self.generateXml(path)
2180
    xml_data += os.linesep+'</site_property>'
2181
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2182

2183 2184 2185 2186 2187 2188 2189
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)
2190 2191 2192 2193 2194 2195 2196 2197
      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
2198

Christophe Dumez's avatar
Christophe Dumez committed
2199
  # Function to generate XML Code Manually
2200
  def generateXml(self, path=None):
2201 2202
    dict = self._objects[path]
    xml_data = '<module>'
2203 2204 2205 2206
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2207 2208 2209 2210 2211
      if key =='permission_list':
        # separe permission dict into xml
        xml_data += os.linesep+' <%s>' %(key,)
        permission_list = dict[key]
        for perm in permission_list:
2212 2213 2214 2215 2216 2217
          # 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,)
2218
          xml_data += os.linesep+'   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2219
          role_list = list(perm[1])
2220
          role_list.sort()
2221 2222 2223 2224 2225 2226 2227 2228 2229
          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

2230 2231 2232 2233 2234
  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)
2235 2236 2237
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
2238
      # expor module one by one
2239
      xml_data = self.generateXml(path=id)
2240
      bta.addObject(obj=xml_data, name=id, path=path)
2241

2242
  def install(self, context, trashbin, **kw):
2243
    portal = context.getPortalObject()
2244 2245
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2246
    if context.getTemplateFormatVersion() == 1:
2247
      items = self._objects
2248
    else:
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260
      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)
2261
          module.portal_type = str(mapping['portal_type'])
2262 2263 2264 2265 2266 2267 2268 2269 2270 2271
        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
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281

  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:
2282
          perm_type = perm.getAttribute('type').encode() or None
2283 2284 2285 2286 2287 2288 2289 2290 2291
          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))
2292 2293 2294 2295
          if perm_type == "list" or perm_type is None:
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306
          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

2307
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2308 2309 2310
    trash = kw.get('trash', 0)
    if trash:
      return
2311 2312 2313 2314 2315 2316
    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]
2317 2318
    p = context.getPortalObject()
    id_list = p.objectIds()
2319
    for id in keys:
2320
      if id in id_list:
2321
        try:
2322
          if trash and trashbin is not None:
2323 2324
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2325
          p.manage_delObjects([id])
2326
        except NotFound:
2327
          pass
2328 2329
    BaseTemplateItem.uninstall(self, context, **kw)

2330 2331 2332
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2333 2334

class DocumentTemplateItem(BaseTemplateItem):
2335 2336 2337 2338
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2339 2340 2341 2342

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

2345
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2346 2347
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367
      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
2368
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2369
      for id in self._objects.keys():
2370 2371 2372 2373 2374 2375 2376 2377 2378 2379
        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)
2380 2381 2382
          except IOError, error:
            if error.errno :
              raise
2383 2384 2385
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
2386
    else:
2387 2388 2389
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
2390
        # This raises an exception if the file exists.
2391
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
2392 2393
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
2394 2395

  def uninstall(self, context, **kw):
2396
    object_path = kw.get('object_path', None)
2397 2398 2399 2400 2401
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
2402
      globals()[self.local_file_remover_name](id)
2403 2404
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
2405 2406 2407 2408 2409 2410
  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():
2411 2412
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
2413

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

2418 2419 2420 2421 2422 2423
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

2424 2425 2426 2427 2428
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
2429

2430 2431 2432
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
2433 2434
  # Extension needs no import
  local_file_importer_name = None
2435 2436 2437 2438 2439
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
2440
  # Test needs no import
2441 2442 2443
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
2444

2445 2446 2447
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
2448 2449 2450

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2451 2452 2453 2454
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2455 2456
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
2457

2458
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2459 2460
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2461
      new_roles = self._objects.keys()
2462 2463 2464
      if installed_bt.id == 'installed_bt_for_diff':
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
2465 2466 2467
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
2468 2469
        for key in old_keys:
          new_dict[key] = ''
2470
        installed_bt._objects = new_dict
2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483
      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):
2484
    p = context.getPortalObject()
2485
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2486
    if context.getTemplateFormatVersion() == 1:
2487
      role_list = self._objects.keys()
2488
    else:
2489
      role_list = self._archive.keys()
2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501
    # 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
2502
    for role in role_list:
2503 2504 2505 2506 2507 2508 2509 2510 2511 2512
      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
2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524

  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)

2525 2526 2527 2528 2529 2530 2531 2532 2533
  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
2534
      if role in roles and role not in new_roles:
2535 2536 2537
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
2538
  # Function to generate XML Code Manually
2539
  def generateXml(self, path):
2540
    obj = self._objects[path]
2541
    xml_data = '<role_list>'
2542 2543
    obj.sort()
    for role in obj:
2544 2545 2546 2547
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

Aurel's avatar
Aurel committed
2548 2549 2550 2551 2552 2553
  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():
2554
      xml_data = self.generateXml(path=path)
2555
      bta.addObject(obj=xml_data, name=path, path=None,)
2556

2557 2558
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2559
  def build(self, context, **kw):
2560 2561
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2562
    except KeyError:
2563 2564 2565 2566
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2567
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2568
    key_list = []
2569
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2570
      if key in sql_search_result_keys:
2571
        key_list.append(key)
Aurel's avatar
Aurel committed
2572 2573
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2574
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2575
      self._objects[self.__class__.__name__+os.sep+'result_key_list'] = key_list
2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586

  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

2587
  def install(self, context, trashbin, **kw):
2588 2589 2590 2591 2592 2593 2594
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2595

2596
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2597
    if context.getTemplateFormatVersion() == 1:
2598 2599
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
2600 2601 2602
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2603
    else:
2604
      keys = self._archive.keys()
2605 2606
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2607
    # XXX same as related key
Aurel's avatar
Aurel committed
2608
    if update_dict.has_key('result_key_list') or force:
2609
      if not force:
Aurel's avatar
Aurel committed
2610
        action = update_dict['result_key_list']
2611
        if action == 'nothing':
Aurel's avatar
Aurel committed
2612
          return
2613
      for key in keys:
2614 2615
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
2616
      catalog.sql_search_result_keys = sql_search_result_keys
2617

2618
  def uninstall(self, context, **kw):
2619 2620
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2621
    except KeyError:
2622 2623 2624 2625 2626
      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)
2627
    object_path = kw.get('object_path', None)
2628 2629 2630 2631 2632
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2633 2634
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2635
    catalog.sql_search_result_keys = sql_search_result_keys
2636 2637
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2638
  # Function to generate XML Code Manually
2639
  def generateXml(self, path=None):
2640
    obj = self._objects[path]
2641
    xml_data = '<key_list>'
2642 2643
    obj.sort()
    for key in obj:
2644 2645 2646 2647
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2648 2649 2650 2651 2652
  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)
2653
    for path in self._objects.keys():
2654
      xml_data = self.generateXml(path=path)
2655
      bta.addObject(obj=xml_data, name=path, path=None)
2656

2657 2658
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2659
  def build(self, context, **kw):
2660 2661
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2662
    except KeyError:
2663 2664 2665 2666
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2667
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2668
    key_list = []
2669
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2670
      if key in sql_search_related_keys:
2671
        key_list.append(key)
Aurel's avatar
Aurel committed
2672 2673
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2674
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2675
      self._objects[self.__class__.__name__+os.sep+'related_key_list'] = key_list
2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686

  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

2687
  def install(self, context, trashbin, **kw):
2688 2689 2690 2691 2692 2693 2694
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2695

2696
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2697
    if context.getTemplateFormatVersion() == 1:
2698
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2699
        return
2700 2701 2702
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2703
    else:
2704
      keys = self._archive.keys()
2705 2706
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
2707
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
2708
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
2709
      if not force:
Aurel's avatar
Aurel committed
2710 2711 2712 2713
        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
2714 2715 2716
        if action == 'nothing':
          return
      for key in keys:
2717 2718
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
2719
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
2720

2721 2722 2723
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2724
    except KeyError:
2725 2726 2727 2728
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2729
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2730
    object_path = kw.get('object_path', None)
2731 2732 2733 2734 2735
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2736 2737 2738 2739 2740
      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
2741
  # Function to generate XML Code Manually
2742
  def generateXml(self, path=None):
2743
    obj = self._objects[path]
2744
    xml_data = '<key_list>'
2745 2746
    obj.sort()
    for key in obj:
2747 2748 2749 2750
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2751 2752 2753 2754 2755 2756
  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():
2757
      xml_data = self.generateXml(path=path)
2758
      bta.addObject(obj=xml_data, name=path, path=None)
2759

2760 2761
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2762
  def build(self, context, **kw):
2763 2764
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2765
    except KeyError:
2766 2767 2768 2769
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2770
    sql_search_result_tables = list(catalog.sql_search_tables)
2771
    key_list = []
2772
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2773
      if key in sql_search_result_tables:
2774
        key_list.append(key)
Aurel's avatar
Aurel committed
2775 2776
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2777
    if len(key_list) > 0:
2778
      self._objects[self.__class__.__name__+os.sep+'result_table_list'] = key_list
2779 2780 2781 2782 2783 2784 2785 2786 2787 2788

  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
2789

2790
  def install(self, context, trashbin, **kw):
2791 2792 2793 2794 2795 2796 2797
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2798

2799
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2800
    if context.getTemplateFormatVersion() == 1:
2801
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2802
        return
2803 2804 2805
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2806
    else:
2807
      keys = self._archive.keys()
2808 2809
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2810
    # XXX same as related keys
Aurel's avatar
Aurel committed
2811
    if update_dict.has_key('result_table_list') or force:
2812
      if not force:
Aurel's avatar
Aurel committed
2813
        action = update_dict['result_table_list']
2814
        if action == 'nothing':
Aurel's avatar
Aurel committed
2815
          return
2816
      for key in keys:
2817 2818
        if key not in sql_search_tables:
          sql_search_tables.append(key)
2819
      catalog.sql_search_tables = list(sql_search_tables)
2820 2821

  def uninstall(self, context, **kw):
2822 2823
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2824
    except KeyError:
2825 2826 2827 2828 2829
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2830
    object_path = kw.get('object_path', None)
2831 2832 2833 2834 2835
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2836 2837
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2838
    catalog.sql_search_tables = sql_search_tables
2839 2840
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2841
  # Function to generate XML Code Manually
2842
  def generateXml(self, path=None):
2843
    obj = self._objects[path]
2844
    xml_data = '<key_list>'
2845 2846
    obj.sort()
    for key in obj:
2847
      xml_data += os.linesep+' <key>%s</key>' %(key)
2848
    xml_data += os.linesep+'</key_list>'
2849 2850
    return xml_data

Aurel's avatar
Aurel committed
2851 2852 2853 2854 2855 2856
  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():
2857
      xml_data = self.generateXml(path=path)
2858
      bta.addObject(obj=xml_data, name=path, path=None)
2859

2860 2861
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
2862 2863

  def build(self, context, **kw):
2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879
    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
2880

2881 2882 2883 2884 2885 2886 2887 2888 2889
  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
2890 2891

  def install(self, context, trashbin, **kw):
2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908
    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()
2909 2910
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930
    # 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)
2931
    object_path = kw.get('object_path', None)
2932 2933
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
2934
    else:
2935 2936 2937 2938 2939 2940 2941
      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
2942
  # Function to generate XML Code Manually
2943 2944 2945 2946 2947 2948 2949 2950
  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
2951 2952 2953 2954

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
2955 2956 2957 2958 2959
    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)
2960

2961 2962
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
2963

2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980
  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
2981

2982 2983 2984 2985 2986 2987 2988 2989 2990
  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
2991

2992 2993 2994 2995 2996 2997 2998 2999
  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
3000

3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021
    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
3022

3023 3024 3025 3026 3027 3028 3029 3030 3031
  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)
3032
    object_path = kw.get('object_path', None)
3033 3034 3035 3036 3037 3038 3039 3040 3041 3042
    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
3043
  # Function to generate XML Code Manually
3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133
  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)
3134
    object_path = kw.get('object_path', None)
3135 3136 3137 3138 3139 3140 3141 3142 3143 3144
    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
3145
  # Function to generate XML Code Manually
3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233
  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)
3234
    object_path = kw.get('object_path', None)
3235 3236 3237 3238 3239 3240 3241 3242 3243 3244
    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
3245
  # Function to generate XML Code Manually
3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334
  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)
3335
    object_path = kw.get('object_path', None)
3336 3337 3338 3339 3340 3341 3342 3343 3344 3345
    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
3346
  # Function to generate XML Code Manually
3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406
  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':
3407
              continue
3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436
          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
3437
      f = open(path+os.sep+'translation.po', 'wt')
3438 3439 3440 3441 3442 3443 3444
      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
3445 3446
class LocalRolesTemplateItem(BaseTemplateItem):

3447
  def __init__(self, id_list, **kw):
3448
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
3449 3450
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
3451 3452 3453
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
3454
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
3455 3456 3457 3458
      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
3459 3460
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

Christophe Dumez's avatar
Christophe Dumez committed
3461
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
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 3487 3488
  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
3489

Aurel's avatar
Aurel committed
3490 3491 3492 3493 3494 3495 3496 3497 3498 3499
  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 = []
3500
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
3501 3502 3503 3504
        if '%' not in folder:
          encode_folders.append(pathname2url(folder))
        else:
          encode_folders.append(folder)
3505
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
3506 3507 3508 3509 3510 3511 3512
      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]
3513
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3514 3515 3516 3517 3518 3519 3520 3521 3522 3523
    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]
3524
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557
    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__', {})
3558

3559 3560 3561
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
3562
    in part or completely. Each object is separated from its
3563 3564 3565 3566 3567 3568 3569 3570 3571 3572
    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
3573 3574
      - object without optimal actions
      - list of relation between portal type and workflow
3575 3576 3577 3578 3579 3580 3581 3582 3583 3584

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

    - site property definition
      - id
      - type
3585
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3586

3587 3588
    - document/propertysheet/extension/test definition
      - copy of the local file
3589

3590
    - message transalation definition
3591
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3592

3593 3594
    The Business Template properties are exported to the bt folder with
    one property per file
3595

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3596 3597
    Technology:

3598 3599
    - 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
3600

3601
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3602 3603 3604 3605

    Use case:

    - install core ERP5 (the minimum)
3606

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

3609 3610
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
3611
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3612 3613 3614 3615 3616
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
3617
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3618 3619 3620 3621 3622
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
3623
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3624 3625 3626 3627 3628 3629 3630

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
3631
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3632
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3633
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3634 3635 3636
                      , PropertySheet.BusinessTemplate
                      )

3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653
    # 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
      }

3654 3655 3656 3657 3658
    # This is a global variable
    # Order is important for installation
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
3659
      '_constraint_item',
3660 3661 3662 3663 3664 3665 3666 3667
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
3668
      '_portal_type_workflow_chain_item',
3669 3670 3671 3672
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
3673 3674 3675
      '_category_item',
      '_module_item',
      '_skin_item',
3676
      '_path_item',
3677
      '_preference_item',
3678
      '_action_item',
3679
      '_portal_type_roles_item',
3680
      '_local_roles_item',
3681
      '_catalog_method_item',
3682 3683 3684
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
3685 3686 3687 3688 3689
      '_catalog_keyword_key_item',
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
3690 3691 3692 3693
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3694 3695 3696 3697 3698 3699
      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
3700
        self._baseGetTemplateFormatVersion()
3701

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3702 3703 3704
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
3705

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3706
      return 0
3707

3708
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
3709 3710 3711 3712 3713 3714 3715
    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".
3716 3717
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
3718
          # XXX Not good to access the attribute directly,
3719 3720 3721
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
3722

3723 3724 3725 3726 3727 3728 3729 3730 3731 3732
    def updateRevisionNumber(self):
	""" incremente bt revision number
	"""
	revision_number = self.getRevision()
	if revision_number is None or revision_number.strip() == '':
	  revision_number = 1
	else:
	  revision_number = int(revision_number)+1
	self.setRevision(revision_number)

3733
    security.declareProtected(Permissions.ManagePortal, 'build')
3734
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3735 3736 3737
      """
        Copy existing portal objects to self
      """
3738
      if no_action: return
3739
        # this is use at import of Business Template to get the status built
3740 3741
      # Make sure that everything is sane.
      self.clean()
3742

3743 3744 3745
      # Update revision number
      # <christophe@nexedi.com>
      self.updateRevisionNumber()
3746

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3747 3748
      self._setTemplateFormatVersion(1)

3749
      # Store all data
3750 3751
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
3752
      self._portal_type_workflow_chain_item = \
3753
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
3754 3755 3756 3757 3758 3759 3760 3761 3762 3763
      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())
3764 3765
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
3766 3767 3768 3769 3770 3771 3772 3773
      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())
3774 3775
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795
      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())
3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807
      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())
3808 3809
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
3810 3811
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
3812 3813
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
3814
               self.getTemplateCatalogKeywordKeyList())
3815 3816
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
3817
               self.getTemplateCatalogFullTextKeyList())
3818 3819
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
3820
               self.getTemplateCatalogRequestKeyList())
3821 3822
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
3823
               self.getTemplateCatalogMultivalueKeyList())
3824 3825 3826
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
3827 3828 3829
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
3830

3831 3832 3833
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
3834

3835
    build = WorkflowMethod(build)
3836 3837

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3838
      """
3839
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3840
      """
3841
      return self.portal_templates.publish(self, url, username=username,
3842
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3843

3844
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3845
      """
3846
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3847
      """
3848
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3849

3850 3851 3852 3853
    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
3854
      """
3855

3856 3857
      modified_object_list = {}
      bt_title = self.getTitle()
3858 3859 3860 3861 3862 3863 3864

      #  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)
3865 3866 3867
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3868
        installed_bt_format = installed_bt.getTemplateFormatVersion()
3869

3870
      # if reinstall business template, must compare to object in ZODB
3871
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
3872
      # same if we make a diff and select only one business template
3873
      reinstall = 0
3874 3875
      if installed_bt == self:
        reinstall = 1
3876 3877 3878
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
3879 3880 3881
        bt2.edit(description='tmp bt generated for diff')
        bt2.build()
        installed_bt = bt2
3882

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3883
      new_bt_format = self.getTemplateFormatVersion()
3884 3885 3886 3887 3888 3889
      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:
3890
          item = getattr(self, item_name, None)
3891 3892 3893 3894
          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
3895

3896 3897 3898 3899
      # 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:
3900
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3901
        old_item = getattr(installed_bt, item_name, None)
3902
        if new_item is not None:
3903
          if old_item is not None and hasattr(old_item, '_objects'):
3904 3905 3906 3907 3908 3909 3910 3911
            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:
3912
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
3913

3914 3915 3916 3917
      return modified_object_list

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

3922 3923
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
3924
      if installed_bt is not None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3925
        if installed_bt.getTemplateFormatVersion() == 0:
3926
          force = 1
3927
        installed_bt.replace(self)
3928

3929 3930 3931 3932
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

3933 3934 3935
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
3936

3937 3938 3939 3940 3941 3942
      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')
3943
        gen.setupLastTools(site, update=1, create_activities=1)
3944 3945
      if not force:
        if len(object_to_update) == 0:
3946 3947 3948 3949 3950
          # 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():
3951
            LOG('Business Template', 0, 'Updating Business Template Workflows')
3952
            gen.setupWorkflow(site)
3953
          return
3954 3955 3956 3957

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

3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972
      # 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)
3973

3974 3975 3976
      # update catalog if necessary
      update_catalog=0
      catalog_method = getattr(self, '_catalog_method_item', None)
3977
      if catalog_method is not None and self.getTemplateFormatVersion() == 1:
3978 3979 3980 3981 3982 3983 3984 3985 3986
        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
3987
              break
3988 3989
      if update_catalog:
        catalog = local_configuration.portal_catalog.getSQLCatalog()
3990
        if (catalog is None) or (not site.isIndexable):
3991 3992 3993 3994 3995
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
3996

3997
      # get objects to remove
3998
      # do remove after because we may need backup object from installation
3999 4000 4001 4002 4003 4004 4005 4006 4007
      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:
4008
          item = getattr(installed_bt, item_name, None)
4009 4010
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
4011

4012 4013 4014 4015 4016 4017 4018 4019

      # 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():
4020
        LOG('Business Template', 0, 'Updating Business Template Workflows')
4021 4022 4023 4024 4025 4026 4027
        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()
4028

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4029 4030 4031
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
4032

4033
    security.declareProtected(Permissions.ManagePortal, 'install')
4034 4035 4036
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4037
      """
4038
      return self._install(**kw)
4039

4040
    install = WorkflowMethod(install)
4041

4042
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4043
    def reinstall(self, **kw):
4044 4045 4046 4047
      """Reinstall Business Template.
      """
      return self._install(**kw)

4048
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4049

4050
    security.declareProtected(Permissions.ManagePortal, 'trash')
4051 4052
    def trash(self, new_bt, **kw):
      """
4053
        Trash unnecessary items before upgrading to a new business
4054
        template.
4055
        This is similar to uninstall, but different in that this does
4056
        not remove all items.
4057 4058 4059 4060 4061
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4062 4063
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4064
        item = getattr(self, item_name, None)
4065 4066 4067 4068
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
4069

4070
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
4071
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4072
      """
4073
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4074
      """
4075 4076 4077 4078
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4079 4080 4081
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4082
        item = getattr(self, item_name, None)
4083 4084
        if item is not None:
          item.uninstall(local_configuration)
4085
      # It is better to clear cache because the uninstallation of a
4086
      # template deletes many things from the portal.
4087
      clearCache()
4088

4089 4090
    uninstall = WorkflowMethod(uninstall)

4091
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4092
    def _clean(self):
4093
      """
4094
        Clean built information.
4095
      """
4096
      # First, remove obsolete attributes if present.
4097 4098 4099 4100
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4101
                    '_module_archive',
4102 4103 4104
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4105
                    '_property_sheet_archive'):
4106 4107 4108
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4109 4110
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4111

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

4114
    security.declareProtected(Permissions.AccessContentsInformation,
4115
                              'getBuildingState')
4116
    def getBuildingState(self, id_only=1):
4117
      """
4118
        Returns the current state in building
4119
      """
4120
      portal_workflow = getToolByName(self, 'portal_workflow')
4121 4122
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4123
      return wf._getWorkflowStateOf(self, id_only=id_only )
4124

4125
    security.declareProtected(Permissions.AccessContentsInformation,
4126
                              'getInstallationState')
4127
    def getInstallationState(self, id_only=1):
4128
      """
4129
        Returns the current state in installation
4130
      """
4131
      portal_workflow = getToolByName(self, 'portal_workflow')
4132 4133
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4134
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4135

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4136 4137 4138 4139 4140 4141
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4142
      export_string = portal_templates.manage_exportObject(
4143 4144
                                               id=self.getId(),
                                               toxml=1,
4145
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4146
      return export_string
4147

4148
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4149
      """
4150 4151
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4152
      """
4153
      result = getattr(self, id, ())
4154 4155 4156 4157
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4158
        # XXX Why do we need to return a tuple ?
4159 4160
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4161

4162
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4163
      """
4164 4165
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4166
      """
4167
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4168

4169
    def getTemplateBaseCategoryList(self):
4170
      """
4171 4172
      We have to set this method because we want an
      ordered list
4173
      """
4174
      return self._getOrderedList('template_base_category')
4175

4176
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4177
      """
4178 4179
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4180
      """
4181
      return self._getOrderedList('template_workflow_id')
4182

4183
    def getTemplatePortalTypeIdList(self):
4184
      """
4185 4186
      We have to set this method because we want an
      ordered list
4187
      """
4188
      return self._getOrderedList('template_portal_type_id')
4189

4190 4191 4192 4193 4194 4195 4196
    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
4197 4198 4199 4200 4201 4202 4203
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

4204 4205 4206 4207 4208 4209 4210
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

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

4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238
    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')

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

4246 4247 4248 4249 4250 4251 4252
    def getTemplatePortalTypeRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_roles')

4253
    def getTemplateSkinIdList(self):
4254
      """
4255 4256
      We have to set this method because we want an
      ordered list
4257
      """
4258
      return self._getOrderedList('template_skin_id')
4259

4260
    def getTemplateModuleIdList(self):
4261
      """
4262 4263
      We have to set this method because we want an
      ordered list
4264
      """
4265
      return self._getOrderedList('template_module_id')
4266 4267 4268 4269 4270 4271 4272

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

4274
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
4275 4276 4277 4278
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
4279
      if self.getBuildingState() != 'built':
4280 4281 4282 4283 4284
        raise TemplateConditionError, \
              'Business Template must be build before export'
      if self.getInstallationState() == 'installed':
        raise TemplateConditionError, \
              'Can not export installed Business Template'
4285

Aurel's avatar
Aurel committed
4286 4287 4288 4289 4290 4291 4292
      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)

4293
      # export bt
4294
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
4295
      for prop in self.propertyMap():
4296
        prop_type = prop['type']
Aurel's avatar
Aurel committed
4297
        id = prop['id']
4298
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
4299
                  'install_object_list_list'):
4300
          continue
Aurel's avatar
Aurel committed
4301
        value = self.getProperty(id)
4302
        if prop_type in ('text', 'string', 'int', 'boolean'):
4303
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
4304
        elif prop_type in ('lines', 'tokens'):
4305
          bta.addObject(obj=str(os.linesep).join(value), name=id,
4306
                        path=path+os.sep+'bt', ext='')
4307

Aurel's avatar
Aurel committed
4308 4309 4310
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
4311

Aurel's avatar
Aurel committed
4312 4313
      return bta.finishCreation()

4314
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
4315 4316
    def importFile(self, dir = 0, file=None, root_path=None):
      """
4317
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
4318 4319 4320 4321 4322
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
4323

Aurel's avatar
Aurel committed
4324 4325
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4326
      self._portal_type_workflow_chain_item = \
4327
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
4328 4329 4330 4331 4332 4333 4334 4335 4336 4337
      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())
4338 4339
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
4340 4341 4342 4343 4344 4345 4346 4347
      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())
4348 4349
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371
      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())
4372 4373
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387
      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(
4388
               self.getTemplateCatalogKeywordKeyList())
4389 4390
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4391
               self.getTemplateCatalogFullTextKeyList())
4392 4393
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4394
               self.getTemplateCatalogRequestKeyList())
4395 4396
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4397
               self.getTemplateCatalogMultivalueKeyList())
4398 4399 4400
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4401 4402 4403
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
4404

Aurel's avatar
Aurel committed
4405 4406
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4407

4408 4409 4410 4411 4412 4413 4414 4415 4416
    #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
4417

Aurel's avatar
Aurel committed
4418
    def diffObject(self, REQUEST, **kw):
4419 4420
      """
        Make a diff between an object in the Business Template
4421
        and the same in the Business Template installed in the site
4422 4423 4424 4425
      """

      class_name_dict = {
        'Product' : '_product_item',
4426
        'PropertySheet' : '_property_sheet_item',
4427
        'Constraint' : '_constraint_item',
4428 4429 4430 4431 4432 4433 4434 4435 4436
        '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',
4437
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
4438 4439 4440 4441
        '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',
4442 4443 4444 4445
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
4446
        'Preference' : '_preference_item',
4447
        'Action' : '_action_item',
4448
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4449
        'LocalRoles' : '_local_roles_item',
4450 4451 4452
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4453 4454 4455 4456 4457
        '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',
4458
        }
4459

4460 4461
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
4462

Christophe Dumez's avatar
Christophe Dumez committed
4463
      # Get objects
4464
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4465

Aurel's avatar
Aurel committed
4466
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
4467
      # Compare with a given business template
4468
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
4469 4470
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
4471 4472
        if bt2_id == self.getId():
          compare_to_zodb = 1
4473
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
4474 4475
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
4476 4477 4478
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
4479 4480 4481
          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
4482
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
4483 4484 4485
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
4486

4487 4488
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
4489
      if compare_to_zodb:
Aurel's avatar
Aurel committed
4490
        # XXX maybe only build for the given object to gain time
4491
        installed_item.build(self)
4492 4493 4494
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
4495

Christophe Dumez's avatar
Christophe Dumez committed
4496
      # Real Zope Objects (can be exported into XML directly by Zope)
4497 4498
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
4499
                     '_category_item', '_path_item', '_preference_tem',
Christophe Dumez's avatar
Christophe Dumez committed
4500
                     '_skin_item', '_action_item',]
4501

Christophe Dumez's avatar
Christophe Dumez committed
4502
      # Not considered as objects by Zope (will be exported into XML manually)
4503
      # XXX Bad naming
4504
      item_list_2 = ['_site_property_item', '_module_item',
4505
                     '_catalog_result_key_item', '_catalog_related_key_item',
4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517
                     '_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',
4518
                     '_portal_type_workflow_chain_item',]
4519

Christophe Dumez's avatar
Christophe Dumez committed
4520
      # Text objects (no need to export them into XML)
4521
      # XXX Bad naming
4522 4523
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
4524
                     '_test_item', '_message_translation_item',]
4525

4526
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
4527 4528 4529
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
4530 4531
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
4532
        # XML Export in memory
4533 4534 4535
        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()
4536
        f1.close()
4537 4538 4539 4540
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
4541
        # End of XML export
4542

4543
        # Diff between XML objects
4544 4545
        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
4546
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4547 4548 4549
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4550

4551
      elif item_name in item_list_2:
4552
        # Generate XML code manually
4553 4554
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
4555 4556
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
4557
        # End of XML Code Generation
4558

4559
        # Diff between XML objects
4560 4561
        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
4562
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4563 4564 4565
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4566

4567
      elif item_name in item_list_3:
4568
        # Diff between text objects
4569 4570 4571 4572
        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
4573
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4574 4575
          diff_msg += '\n'.join(diff_list)
        else:
4576
          diff_msg = 'No diff'
4577

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

4581 4582
      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4583

4584
      return diff_msg
4585

4586

4587 4588 4589 4590
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
4591 4592 4593 4594 4595 4596 4597
      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 [])
4598 4599 4600 4601 4602 4603 4604
      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 = {}
4605

4606
      p = self.getPortalObject()
4607
      for id in bt_portal_types_id_list:
4608 4609 4610 4611
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+id)
        except KeyError:
          continue
4612
        if len(getattr(portal_type, '_roles', ())) > 0:
4613 4614
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
4615

4616 4617 4618 4619
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
4620
        action_list = []
4621
        wf_list = []
4622 4623 4624 4625 4626 4627 4628
        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'):
4629
          base_category_list = portal_type.base_category_list
4630 4631
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
4632
        if chain_dict.has_key('chain_%s' % id):
Aurel's avatar
Aurel committed
4633 4634 4635
          chain = chain_dict['chain_%s' % id]
          if chain != '' and chain != '(Default)':
            wf_list = chain.split(', ')
4636

4637 4638 4639 4640
        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)
4641

4642
        for h_id in hidden_content_type_list:
4643 4644 4645
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
4646

4647 4648 4649 4650
        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)
4651

4652 4653 4654 4655
        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)
4656

4657 4658 4659 4660
        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)
4661 4662 4663 4664 4665

        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)
4666

4667 4668 4669 4670
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
4671
      bt_action_list.sort()
4672
      bt_wf_chain_list.sort()
4673

4674
      setattr(self, 'template_portal_type_workflow_chain', bt_wf_chain_list)
4675
      setattr(self, 'template_portal_type_roles', bt_portal_type_roles_list)
4676 4677 4678
      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)
4679
      setattr(self, 'template_portal_type_base_category', bt_base_category_list)
4680
      setattr(self, 'template_action_path', bt_action_list)
4681 4682 4683 4684 4685 4686 4687 4688 4689
      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:
4690 4691
        raise TemplateConditionError, 'No module defined in business template'

4692 4693 4694 4695 4696 4697 4698 4699
      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:
4700
          return type_list
4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714

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

4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791
      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)
4792

4793 4794 4795 4796 4797 4798 4799 4800

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

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