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

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


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

89 90 91
catalog_method_filter_list = ('_filter_expression_archive',
                              '_filter_expression_instance_archive',
                              '_filter_type_archive',)
92

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
def _getCatalog(acquisition_context):
  """
    Return the id of the SQLCatalog which correspond to the current BT.
  """
  catalog_method_id_list = acquisition_context.getTemplateCatalogMethodIdList()
  if len(catalog_method_id_list) == 0:
    return None
  catalog_method_id = catalog_method_id_list[0]
  return catalog_method_id.split('/')[0]

def _getCatalogValue(acquisition_context):
  """
    Returns the catalog object which correspond to the ZSQLMethods
    stored/to store in the business template.

    NB: acquisition_context must make possible to reach portal object
        and getTemplateCatalogMethodIdList.
  """
  catalog_id = _getCatalog(acquisition_context)
  if catalog_id is None:
    return None
  try:
    return acquisition_context.getPortalObject().portal_catalog[catalog_id]
  except KeyError:
    return None

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
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
140

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
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)

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
def fixZSQLMethod(portal, method):
  """Make sure the ZSQLMethod uses a valid connection.
  """
  if not isinstance(getattr(portal, method.connection_id, None),
                      RDBConnection):
    # if not valid, we assign to the first valid connection found
    sql_connection_list = portal.objectIds(
                          spec=('Z MySQL Database Connection',))
    if (method.connection_id not in sql_connection_list) and \
       (len(sql_connection_list) != 0):
      LOG('BusinessTemplate', WARNING,
          'connection_id for Z SQL Method %s is invalid, using %s' % (
                    method.getId(), sql_connection_list[0]))
      method.connection_id = sql_connection_list[0]

Aurel's avatar
Aurel committed
185 186 187
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
188
  """
Aurel's avatar
Aurel committed
189 190 191 192 193 194 195 196 197 198 199 200

  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
201

Aurel's avatar
Aurel committed
202 203 204 205 206
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
207
    Class archiving business template into a folder tree
208
  """
Aurel's avatar
Aurel committed
209 210 211 212 213 214
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
215
      removeAll(self.path)
Aurel's avatar
Aurel committed
216 217 218
      os.makedirs(self.path)

  def addFolder(self, name=''):
219
     if name !='':
Aurel's avatar
Aurel committed
220
      path = os.path.join(self.path, name)
221
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
222 223 224
        os.makedirs(path)
      return path

225
  def addObject(self, obj, name, path=None, ext='.xml'):
226
    name = pathname2url(name)
Aurel's avatar
Aurel committed
227 228 229
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
230 231
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
232 233
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
234
    f.write(str(obj))
Aurel's avatar
Aurel committed
235 236 237
    f.close()

  def _initImport(self, file=None, path=None, **kw):
238 239 240
    # Normalize the paths to eliminate the effect of double-slashes.
    self.file_list = [os.path.normpath(f) for f in file]
    path = os.path.normpath(path)
241
    # to make id consistent, must remove a part of path while importing
242
    self.root_path_len = len(string.split(path, os.sep)) + 1
Aurel's avatar
Aurel committed
243

244
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
245 246 247 248
    """
      Import file from a local folder
    """
    class_name = klass.__class__.__name__
249
    for file_path in self.file_list:
250
      if class_name in file_path.split(os.sep):
251 252
        if os.path.isfile(file_path):
          file = open(file_path, 'r')
Aurel's avatar
Aurel committed
253
          # get object id
254 255
          folders = file_path.split(os.sep)
          file_name = string.join(folders[self.root_path_len:], os.sep)
256 257
          if '%' in file_name:
            file_name = url2pathname(file_name)
258
          klass._importFile(file_name, file)
Aurel's avatar
Aurel committed
259
          # close file
260
          file.close()
261

Aurel's avatar
Aurel committed
262 263 264 265 266 267
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
268
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
269 270 271 272 273
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
274
      removeAll(self.path)
Aurel's avatar
Aurel committed
275 276 277 278 279 280
      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
281
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
282 283
      os.makedirs(name)

284
  def addObject(self, obj, name, path=None, ext='.xml'):
285
    name = pathname2url(name)
Aurel's avatar
Aurel committed
286 287 288
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
289 290
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
291 292
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
293
    f.write(str(obj))
Aurel's avatar
Aurel committed
294 295 296 297 298
    f.close()

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
299
    removeAll(self.path)
Aurel's avatar
Aurel committed
300 301 302 303 304
    return self.fobj

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

305
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
306 307
    """
      Import all file from the archive to the site
308
    """
Aurel's avatar
Aurel committed
309 310 311 312 313 314
    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
315 316
      if 'CVS' in info.name.split('/'):
        continue
Yoshinori Okuji's avatar
Yoshinori Okuji committed
317 318
      if '.svn' in info.name.split('/'):
        continue
319
      if class_name in info.name.split('/'):
Aurel's avatar
Aurel committed
320 321
        if info.isreg():
          file = tar.extractfile(info)
322 323 324
          tar_file_name = info.name.startswith('./') and info.name[2:] or \
              info.name
          folders = string.split(tar_file_name, os.sep)
325 326 327 328
          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
329 330 331
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
332

333
class TemplateConditionError(Exception): pass
334
class TemplateConflictError(Exception): pass
335
class BusinessTemplateMissingDependency(Exception): pass
336

337
class BaseTemplateItem(Implicit, Persistent):
338
  """
339
    This class is the base class for all template items.
340
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
341

342
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
343
    self.__dict__.update(kw)
344
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
345
    self._objects = PersistentMapping()
346
    for id in id_list:
347 348
      if id is not None and id != '':
        self._archive[id] = None
349 350 351 352

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

353
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
354 355
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
356
      new_keys = self._objects.keys()
357
      for path in new_keys:
358 359
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
360 361
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
362 363 364 365 366 367 368 369 370 371 372 373
          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):
374
    pass
375 376 377

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

379 380 381 382
  def remove(self, context, **kw):
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
383
    keys.reverse()
384 385 386 387 388 389 390 391 392 393 394
    # 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)
395

396

397 398 399 400
  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
401
  def export(self, context, bta, **kw):
402
    pass
Aurel's avatar
Aurel committed
403

404 405
  def getKeys(self):
    return self._objects.keys()
406

Aurel's avatar
Aurel committed
407
  def importFile(self, bta, **kw):
408
    bta.importFiles(klass=self)
409

410 411 412
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
413
    """
414 415
    if hasattr(aq_base(obj), '_dav_writelocks'):
      del aq_base(obj)._dav_writelocks
416 417 418 419 420 421 422
    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
423 424
    if hasattr(aq_base(obj), '_filepath'):
      obj._filepath = None
425
    if hasattr(aq_base(obj), 'workflow_history'):
426 427 428 429
      if hasattr(obj.__class__, 'workflow_history'):
        obj.workflow_history = None
      else:
        del obj.workflow_history
430 431 432
    if getattr(obj, 'meta_type', None) == 'Script (Python)':
      if hasattr(aq_base(obj), '_code'):
        obj._code = None
433 434
      if hasattr(aq_base(obj), 'Python_magic'):
        obj.Python_magic = None
435 436 437
    elif getattr(obj, 'meta_type', None) == 'ERP5 PDF Form' :
      if not obj.getProperty('business_template_include_content', 1) :
        obj.deletePdfContent()
438 439
    return obj

440 441 442
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
443
  """
444

445 446 447 448
  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()
449
      self._archive.clear()
450 451 452
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
453

454 455 456 457 458
  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():
459
      obj = self._objects[key]
460 461
      # create folder and subfolders
      folders, id = os.path.split(key)
Aurel's avatar
Aurel committed
462 463 464 465 466 467 468
      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))
469 470 471
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
472 473
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
474

Aurel's avatar
Aurel committed
475 476 477 478
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
479
      relative_url = '/'.join([url,id])
480 481
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
482
      obj = self.removeProperties(obj)
483
      id_list = obj.objectIds()
484
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
485
        # we must keep groups because it's ereased when we delete subobjects
486
        groups = deepcopy(obj.groups)
487
      if id_list:
Aurel's avatar
Aurel committed
488
        self.build_sub_objects(context, id_list, relative_url)
489
        for id_ in list(id_list):
490
          obj._delObject(id_)
491
      if hasattr(aq_base(obj), 'groups'):
492 493 494
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
495 496
    return sub_list

497 498 499 500
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
501
      obj = p.unrestrictedTraverse(relative_url)
502 503 504 505
      try:
        obj = obj._getCopy(context)
      except AttributeError:
        raise AttributeError, "Could not find object '%s' during business template processing." % relative_url
506
      obj = self.removeProperties(obj)
507
      id_list = obj.objectIds()
508
      if hasattr(aq_base(obj), 'groups'):
Christophe Dumez's avatar
Christophe Dumez committed
509
        # we must keep groups because it's erased when we delete subobjects
510
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
511 512
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
513
        for id_ in list(id_list):
514
          obj._delObject(id_)
515
      if hasattr(aq_base(obj), 'groups'):
516 517 518
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
519

520 521 522 523 524 525 526
  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
527 528
    __traceback_info__ = 'Importing %s' % file_name
    obj = connection.importFile(file, customImporters=customImporters)
529 530
    self._objects[file_name[:-4]] = obj

531
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
532 533
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
534 535 536 537 538 539 540
      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]
541 542
          new_object = self.removeProperties(new_object)
          old_object = self.removeProperties(old_object)
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
          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

562
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
563 564 565
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
566
    subobjects_dict = {}
567
    if trashbin is None: # must return subobjects
568 569 570 571 572 573
      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)
574
        subobjects_dict[subobject_id] = subobject_copy
575
      return subobjects_dict
576 577
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
578
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, **kw)
579
    elif action == 'install':
580
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0, **kw)
581
    return subobjects_dict
582

583 584 585
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
586
    if context.getTemplateFormatVersion() == 1:
587
      groups = {}
588
      old_groups = {}
589 590 591 592 593
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
594 595 596 597 598 599
        if update_dict.has_key(path) or force:
          # get action for the oject
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
600
          action = 'backup'
601
          # get subobjects in path
602 603 604
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
605 606 607 608
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
609
            container_url = '/'.join(container_path)
610 611 612 613
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
614
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
615 616
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
617
              container_container = portal.unrestrictedTraverse(container_path[:-1])
618 619 620 621 622
              if container_container.meta_type == 'ERP5 Catalog':
                container_container.manage_addProduct['ZSQLCatalog'].manage_addSQLCatalog(id=container_path[-1], title='')
                if len(container_container.objectIds()) == 1:
                  container_container.default_sql_catalog_id = container_path[-1]
                container = portal.unrestrictedTraverse(container_path)
623 624
            else:
              raise
625 626 627
          container_ids = container.objectIds()
          subobjects_dict = {}
          # Object already exists
628
          if object_id in container_ids:     
629
            old_obj = container._getOb(object_id)
630 631 632 633 634 635
            if hasattr(aq_base(old_obj), 'groups'):
              # we must keep original order groups
              # from old form in case we keep some
              # old widget, thus we can readd them in
              # the right order group
              old_groups[path] = deepcopy(old_obj.groups)
636
            subobjects_dict = self._backupObject(action, trashbin,
637
                                                 container_path, object_id)
638 639
            container.manage_delObjects([object_id])
          # install object
640
          obj = self._objects[path]
641 642 643
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
644
          if hasattr(aq_base(obj), 'groups'):
645
            # we must keep original order groups
646
            # because they change when we add subobjects
647
            groups[path] = deepcopy(obj.groups)
648
          # copy the object
649 650 651 652 653
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
654
          # if portal types upgrade, set backup properties
655 656
          if getattr(obj, 'meta_type', None) == 'ERP5 Type Information' and \
              len(subobjects_dict) > 0:
657
            setattr(obj, 'allowed_content_types',
658
                    subobjects_dict['allowed_content_type_list'] or [])
659
            setattr(obj, 'hidden_content_type_list',
660
                    subobjects_dict['hidden_content_type_list'] or [])
661
            setattr(obj, 'property_sheet_list',
662
                    subobjects_dict['property_sheet_list'] or [])
663
            setattr(obj, 'base_category_list',
664
                    subobjects_dict['base_category_list'] or [])
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
            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 = ''
683
            chain_dict['chain_%s' % (object_id)] = wf_chain
684
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
685
          # import sub objects if there is
686
          elif len(subobjects_dict) > 0:
687
            # get a jar
688 689
            connection = obj._p_jar
            o = obj
690
            while connection is None:
691 692
              o = o.aq_parent
              connection = o._p_jar
693 694 695 696 697
            # import subobjects
            for subobject_id in subobjects_dict.keys():
              subobject_data = subobjects_dict[subobject_id]
              subobject_data.seek(0)
              subobject = connection.importFile(subobject_data)
698
              if subobject_id not in obj.objectIds():
699
                obj._setObject(subobject_id, subobject)
700
          if obj.meta_type in ('Z SQL Method',):
701
            fixZSQLMethod(portal, obj)
702
      # now put original order group
703 704
      # we remove object not added in forms
      # we put old objects we have kept
705
      for path in groups.keys():
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
        new_groups_dict = groups[path]        
        if not old_groups.has_key(path):
          # installation of a new form
          obj = portal.unrestrictedTraverse(path)
          obj.groups = new_groups_dict
        else:
          # upgrade of a form
          old_groups_dict = old_groups[path]
          obj = portal.unrestrictedTraverse(path)
          # first check that all widgets are in new order
          # excetp the one that had to be removed          
          widget_id_list = obj.objectIds()
          for widget_id in widget_id_list:
            widget_path = path+'/'+widget_id
            if update_dict.has_key(widget_path) and update_dict[widget_path] in ('remove', 'save_and_remove'):
              continue              
            widget_in_form = 0            
            for group_id in new_groups_dict.keys():
              group_values = new_groups_dict[group_id]
              if widget_id in group_values:
                widget_in_form = 1
                break
            # if not, add it in the same groups
            # defined on the former form
            previous_group_id = None
            if not widget_in_form:
              for old_group_id in old_groups_dict.keys():
                old_group_values = old_groups_dict[old_group_id]
                if widget_id in old_group_values:
                  previous_group_id = old_group_id
              # if we find same group in new one, add widget to it
              if previous_group_id is not None and new_groups_dict.has_key(previous_group_id):
                new_groups_dict[previous_group_id].append(widget_id)
              # otherwise use a specific group
              else:
                if new_groups_dict.has_key('not_assigned'):
                  new_groups_dict['not_assigned'].append(widget_id)
                else:
                  new_groups_dict['not_assigned'] = [widget_id,]
745
                  obj.group_list = list(obj.group_list) + ['not_assigned']
746 747 748 749 750 751 752 753
          # second check all widget_id in order are in form
          for group_id in new_groups_dict.keys():
            for widget_id in new_groups_dict[group_id]:
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
                new_groups_dict[group_id].remove(widget_id)
          # now set new group object
754
          obj.groups = new_groups_dict
Aurel's avatar
Aurel committed
755
    else:
756 757
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
758
      portal = context.getPortalObject()
759
      for relative_url in self._archive.keys():
760
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
761 762 763 764
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
765
        if object_id in container_ids:    # Object already exists
766
          self._backupObject('backup', trashbin, container_path, object_id)
767
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
768
        # Set a hard link
769 770 771 772 773 774
        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',):
775
          fixZSQLMethod(portal, obj)
776 777 778

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
779
    trash = kw.get('trash', 0)
780 781 782 783 784
    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
785
      object_keys = self._archive.keys()
786
    for relative_url in object_keys:
787 788
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
789
      try:
790
        container = portal.unrestrictedTraverse(container_path)
791
        if trash and trashbin is not None:
792 793
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
        container.manage_delObjects([object_id])
794 795 796
        if container.aq_parent.meta_type == 'ERP5 Catalog' and len(container.objectIds()) == 0:
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
          container.aq_parent.manage_delObjects([container.id])
797
      except (NotFound, KeyError, BadRequest):
798
        # object is already backup and/or removed
799
        pass
800 801
    BaseTemplateItem.uninstall(self, context, **kw)

802 803 804 805 806 807 808 809 810 811 812 813
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

814 815 816 817 818 819 820 821 822
  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()
823 824
    object_keys.sort()
    object_keys.reverse()
825 826
    p = context.getPortalObject()
    for path in object_keys:
827 828 829 830
      path_list = self._resolvePath(p, [], path.split('/'))
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
831
        try:
Aurel's avatar
Aurel committed
832 833
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
834 835
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
836 837
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
838
                                           keep_subobjects=1)
839 840 841 842 843 844
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

845 846 847
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
848

849 850 851 852 853 854 855 856 857
      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.
858 859 860
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
861
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
862 863
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
864
      if object_id != "":
865
        path_list.extend(self._resolvePath(
866
            folder._getOb(object_id),
867
            relative_url_list + [object_id], id_list[1:]))
868
    return path_list
Aurel's avatar
Aurel committed
869

870 871 872
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
873
    keys = self._path_archive.keys()
874
    keys.sort()
Aurel's avatar
Aurel committed
875
    for path in keys:
876 877 878
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
879
      for relative_url in self._resolvePath(p, [], path.split('/')):
880 881
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
882
        obj = obj.__of__(context)
883
        id_list = obj.objectIds()
884
        obj = self.removeProperties(obj)
885
        if hasattr(aq_base(obj), 'groups'):
886
          # we must keep groups because it's ereased when we delete subobjects
887
          groups = deepcopy(obj.groups)
888
        if len(id_list) > 0:
889 890
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
891
          for id_ in list(id_list):
892
            obj._delObject(id_)
893
        if hasattr(aq_base(obj), 'groups'):
894 895 896
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
897

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
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")
913
    if len(id_list) != 1:
914 915 916 917 918 919 920 921 922 923 924 925
      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():
926
      pref = portal.unrestrictedTraverse(object_path)
927
      # XXX getPreferenceState is a bad name
928 929 930
      if pref.getPreferenceState() == 'disabled':
        portal.portal_workflow.doActionFor(
                      pref,
931 932 933 934 935
                      'enable_action',
                      wf_id='preference_workflow',
                      comment="Initialized during Business Template " \
                              "installation.")

936 937
class CategoryTemplateItem(ObjectTemplateItem):

938 939
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
940

941 942 943 944
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
945 946
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
947
      obj = self.removeProperties(obj)
948
      id_list = obj.objectIds()
949
      if id_list:
950
        self.build_sub_objects(context, id_list, relative_url)
951
        for id_ in list(id_list):
952
          obj._delObject(id_)
953 954
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
955 956 957 958 959

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
960 961
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
962
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
963
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
964
      id_list = obj.objectIds()
965 966
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
967
        for id_ in list(id_list):
968
          obj._delObject(id_)
969
      else:
970
        for id_ in list(id_list):
971
          obj._delObject(id_)
972 973
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
974

975
  def install(self, context, trashbin, **kw):
976 977
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
978
    if context.getTemplateFormatVersion() == 1:
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          else:
            action = 'backup'
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
          obj = self._objects[path]
          obj = obj.__of__(category_tool)
          container_path = path.split('/')[:-1]
          category_id = path.split('/')[-1]
          try:
            container = category_tool.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
            container_url = '/'.join(container_path)
            if update_dict.has_key(container_url):
              if update_dict[container_url] == 'nothing':
1004
                continue
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
            raise
          container_ids = container.objectIds()
          # Object already exists
          object_uid = None
          subobjects_dict = {}
          if category_id in container_ids:
            object_uid = container[category_id].getUid()
            subobjects_dict = self._backupObject(action, trashbin, container_path, category_id)
            container.manage_delObjects([category_id])
          category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
          if object_uid is not None:
            category.setUid(object_uid)
1017 1018 1019 1020
          for prop in obj.propertyIds():
            if prop not in ('id', 'uid'):
              try:
                prop_value = obj.getProperty(prop, evaluate=0)
1021
              except TypeError: # the getter doesn't support evaluate=
1022 1023
                prop_value = obj.getProperty(prop)
              category.setProperty(prop, prop_value)
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
          # 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)
1039
    else:
1040
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1041 1042 1043 1044
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      if light_install==0:
1045
        ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1046
      else:
1047
        for relative_url in self._archive.keys():
1048
          obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
1049
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
1050
          obj = obj.__of__(category_tool)
Aurel's avatar
Aurel committed
1051 1052 1053 1054 1055
          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
1056 1057
            # XXX call backup here
            subobjects_dict = self._backupObject('backup', trashbin, container_path, category_id)
1058
            container.manage_delObjects([category_id])
1059
          category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
1060 1061 1062 1063
          for prop in obj.propertyIds():
            if prop not in ('id', 'uid'):
              try:
                prop_value = obj.getProperty(prop, evaluate=0)
1064
              except TypeError: # the getter doesn't support evaluate=
1065 1066
                prop_value = obj.getProperty(prop)
              category.setProperty(prop, prop_value)
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
          # 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)

1083

1084 1085
class SkinTemplateItem(ObjectTemplateItem):

1086 1087
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1088

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
  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

1104
  def install(self, context, trashbin, **kw):
1105
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1106 1107
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1108 1109 1110
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1111
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1112 1113
        fixZSQLMethod(p, obj)

1114 1115 1116 1117 1118 1119
    # 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
1120
        if context.getTemplateFormatVersion() == 1:
1121 1122
          if update_dict.has_key(relative_url) or force:
            if not force:
1123
              if update_dict[relative_url] == 'nothing':
1124
                continue
1125
          obj = self._objects[relative_url]
1126
        else:
1127
          obj = self._archive[relative_url]
1128
        skin_id = relative_url.split('/')[-1]
1129
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
        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)
1143 1144 1145

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
1146 1147 1148 1149
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1150
      object_keys = self._archive.keys()
1151
    ps = context.portal_skins
1152
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
1153 1154 1155 1156 1157 1158 1159
    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)
1160
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
1161
    context.getPortalObject().changeSkin(None)
1162 1163 1164
    ObjectTemplateItem.uninstall(self, context, **kw)


1165
class WorkflowTemplateItem(ObjectTemplateItem):
1166

1167 1168
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1169

1170
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1171 1172
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1173 1174 1175
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
1176
        if installed_bt._objects.has_key(path):
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
          # 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']})
1193 1194 1195 1196 1197 1198 1199 1200
      # 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
1201
    if context.getTemplateFormatVersion() == 1:
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
      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:
1216
            action = 'backup'
1217 1218 1219 1220 1221 1222
          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
1223
            container_url = '/'.join(container_path)
1224 1225 1226 1227 1228 1229
            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
1230
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1231
            container.manage_delObjects([object_id])
1232
          obj = self._objects[path]
1233 1234 1235
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1236 1237 1238 1239 1240
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1241 1242 1243 1244
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1245 1246
class PortalTypeTemplateItem(ObjectTemplateItem):

1247 1248
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1249 1250
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1251 1252 1253
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1254 1255
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1256 1257
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1258 1259 1260
      # remove actions and properties
      action_len = len(obj.listActions())
      obj.deleteActions(selections=range(action_len))
1261
      obj = self.removeProperties(obj)
1262 1263 1264 1265 1266 1267 1268 1269 1270
      # 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
1271 1272
      if hasattr(obj, '_roles'):
        setattr(obj, '_roles', [])
1273 1274
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1275

1276 1277
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1278 1279 1280 1281
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1282 1283
    # We now need to setup the list of workflows corresponding to
    # each portal type
1284
    (default_chain, chain_dict) = getChainByType(context)
1285
    # Set the default chain to the empty string is probably the
1286
    # best solution, by default it is 'default_workflow', which is
1287
    # not very usefull
1288
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1289
    if context.getTemplateFormatVersion() == 1:
1290
      object_list = self._objects
1291
    else:
1292 1293
      object_list = self._archive
    for path in object_list.keys():
1294 1295 1296 1297
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1298
            continue
1299 1300
        obj = object_list[path]
        portal_type = obj.id
1301 1302 1303
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1304 1305
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1306

1307 1308
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1309 1310 1311 1312 1313 1314 1315
  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:
1316
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1317 1318 1319 1320 1321
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1322
        dict[str(ptype)] = str(workflow)
1323 1324 1325 1326
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1327
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1328 1329

  def build(self, context, **kw):
1330 1331 1332 1333 1334
    # 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
1335
    p = context.getPortalObject()
1336
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1337
    for key in self._archive.keys():
1338 1339 1340
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1341
        workflow = wflist[1]
1342
      else:
1343
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1344
        portal_type = wflist[0][:-2]
1345 1346
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1347 1348 1349 1350
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
1351
        if workflow[0] != '-' and \
1352
            workflow_name not in chain_dict['chain_%s' % portal_type]:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1353
          raise NotFound, 'workflow %s not found in chain for portal_type %s'\
1354
                % (workflow, portal_type)
1355
        if self._objects.has_key(portal_type):
1356 1357
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1358
        else:
1359
          self._objects[portal_type] = [workflow,]
1360
      else:
1361 1362
        raise NotFound, 'portal type %s not found in workflow chain'\
                                                    % portal_type
1363

Christophe Dumez's avatar
Christophe Dumez committed
1364
  # Function to generate XML Code Manually
1365 1366 1367 1368 1369
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1370
      workflow_list = self._objects[key]
1371 1372 1373
      # XXX Not always a list
      if isinstance(workflow_list, str):
        workflow_list = [workflow_list]
1374 1375
      xml_data += os.linesep+' <chain>'
      xml_data += os.linesep+'  <type>%s</type>' %(key,)
1376
      xml_data += os.linesep+'  <workflow>%s</workflow>' %(', '.join(workflow_list))
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
      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
1395
    (default_chain, chain_dict) = getChainByType(context)
1396
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1397
    # best solution, by default it is 'default_workflow', which is
1398 1399 1400 1401 1402 1403 1404
    # 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':
1405
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1406 1407 1408 1409
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
        if len(path_splitted) < 2:
          continue
1410
        portal_type = path_splitted[1]
1411
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1412 1413 1414
          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 != '':
1415
            old_chain_workflow_id_set = {}
1416
            # get existent workflow id list
1417 1418
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1419
            # get new workflow id list
1420
            for wf_id in self._objects[path].split(', '):
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
              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
1435 1436
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1437
          else:
1438
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1439 1440
        else:
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1441 1442
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1443

1444 1445
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1446 1447 1448 1449 1450 1451
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._objects.keys()
    for path in object_keys:
1452 1453 1454 1455 1456 1457 1458 1459
      path_splitted = path.split('/', 1)
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
      id = 'chain_%s' % portal_type
      if id in chain_dict.keys():
        del chain_dict[id]
    context.portal_workflow.manage_changeWorkflows('', props=chain_dict)
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472

  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
1473 1474
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1475 1476 1477
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1478 1479
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1480

1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495
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
1496
  # Function to generate XML Code Manually
1497
  def generateXml(self, path=None):
1498
    dictio = self._objects
1499
    xml_data = '<%s>' %(self.xml_tag,)
1500
    keys = dictio.keys()
1501 1502
    keys.sort()
    for key in keys:
1503
      allowed_list = dictio[key]
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
      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)

1520 1521 1522 1523 1524 1525
  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':
1526
        #must rename keys in dict if reinstall
1527 1528 1529 1530 1531 1532 1533 1534 1535
        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]
1536
          old_object = installed_bt._objects[path]
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
          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

1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
  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)
1575
        except AttributeError:
1576 1577 1578 1579 1580 1581 1582 1583
          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:
1584 1585
            if id not in property_list:
              property_list.append(id)
1586 1587
        setattr(portal_type, self.class_property, list(property_list))

Aurel's avatar
Aurel committed
1588
  def uninstall(self, context, **kw):
1589
    object_path = kw.get('object_path', None)
1590
    p = context.getPortalObject()
1591
    pt = p.unrestrictedTraverse('portal_types')
1592 1593 1594 1595 1596 1597 1598 1599
    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)
1600
      except AttributeError:
1601 1602 1603
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
1604 1605
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
1606 1607
      for id in property_list:
        if id in original_property_list:
1608
          original_property_list.remove(id)
1609
      setattr(portal_type, self.class_property, list(original_property_list))
1610

1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
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'

1626
class CatalogMethodTemplateItem(ObjectTemplateItem):
1627
  """Template Item for catalog methods.
1628

1629 1630 1631 1632 1633
    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.
  """
1634

1635 1636
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1637
    # a mapping to store properties of methods.
1638 1639 1640 1641 1642
    # 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()
1643

1644 1645 1646 1647 1648
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
  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

1663 1664
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1665

1666
    catalog = _getCatalogValue(self)
1667
    if catalog is None:
1668
      LOG('BusinessTemplate build', 0, 'catalog not found')
1669
      return
1670

1671 1672 1673
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
1674

1675 1676
    for obj in self._objects.values():
      method_id = obj.id
1677 1678
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
1679
      self._is_filtered_archive[method_id] = 0
1680
      if catalog.filter_dict.has_key(method_id):
1681 1682 1683 1684 1685 1686 1687 1688 1689
        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']
1690

Aurel's avatar
Aurel committed
1691
  def export(self, context, bta, **kw):
1692
    catalog = _getCatalogValue(self)
1693 1694 1695 1696
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

Aurel's avatar
Aurel committed
1697 1698 1699 1700
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
1701
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1702 1703 1704 1705 1706 1707
      # 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()
1708 1709
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1710
      # add all datas specific to catalog inside one file
1711
      method_id = obj.id
1712 1713
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1714
      f = open(object_path, 'wt')
1715
      xml_data = '<catalog_method>'
1716

1717 1718 1719
      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,)
1720
        xml_data += os.linesep+' </item>'
1721

Aurel's avatar
Aurel committed
1722
      if catalog.filter_dict.has_key(method_id):
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
        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>'
1739
      xml_data += os.linesep+'</catalog_method>'
1740
      f.write(xml_data)
Aurel's avatar
Aurel committed
1741
      f.close()
1742

Christophe Dumez's avatar
Christophe Dumez committed
1743 1744 1745 1746 1747 1748 1749 1750 1751
  # 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
1752

1753 1754
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1755
    catalog = _getCatalogValue(self)
1756 1757 1758 1759 1760 1761 1762
    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)
1763

1764 1765 1766
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1767
    new_bt_format = context.getTemplateFormatVersion()
1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783

    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':
1784
              continue
1785 1786 1787 1788
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
1789

1790 1791
    for obj in values:
      method_id = obj.id
1792

1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803
      # 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))
1804

1805 1806
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
1807
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1808
        if context.getTemplateFormatVersion() == 1:
1809 1810 1811
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1812
        filter_type = self._filter_type_archive[method_id]
1813 1814 1815
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1816
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1817
        catalog.filter_dict[method_id]['type'] = filter_type
1818
      elif method_id in catalog.filter_dict.keys():
1819
        catalog.filter_dict[method_id]['filtered'] = 0
1820

1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846
      # 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)
1847

1848 1849 1850 1851 1852 1853
        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)
1854

1855
  def uninstall(self, context, **kw):
1856
    catalog = _getCatalogValue(self)
1857 1858 1859
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1860

1861 1862 1863 1864
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
1865 1866 1867 1868
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
1869 1870 1871 1872
    else:
      value = self._archive[object_path]
      if value is not None:
        values.append(value)
1873

1874
    for obj in values:
1875
      method_id = obj.id
1876 1877 1878 1879 1880 1881 1882 1883 1884
      # 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)
1885

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1886
      if catalog.filter_dict.has_key(method_id):
1887
        del catalog.filter_dict[method_id]
1888

1889
    # uninstall objects
1890
    ObjectTemplateItem.uninstall(self, context, **kw)
1891

1892
  def _importFile(self, file_name, file):
1893
    if not '.catalog_keys' in file_name:
1894 1895 1896 1897 1898 1899 1900 1901
      # 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
1902
    else:
1903 1904 1905 1906
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1907
      method_list = xml.getElementsByTagName('item')
1908
      for method in method_list:
1909
        key = method.getAttribute('key')
1910 1911
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1912 1913 1914 1915
          if len(method.getElementsByTagName('value')[0].childNodes):
            value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          else:
            value = ''
1916
          key = str(key)
1917
        elif key_type == "int":
1918
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1919
          key = str(key)
1920
        elif key_type == "tuple":
1921 1922 1923 1924
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1925
        else:
1926
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1927
          continue
1928
        if key in catalog_method_list or key in catalog_method_filter_list:
1929
          dict = getattr(self, key, {})
1930
          dict[id] = value
1931 1932 1933
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
1934

1935
class ActionTemplateItem(ObjectTemplateItem):
1936 1937

  def __init__(self, id_list, **kw):
1938
    # XXX It's look like ObjectTemplateItem __init__
1939 1940 1941 1942 1943 1944
    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

1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965
  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

1966 1967 1968 1969
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1970
      relative_url, value = id.split(' | ')
1971 1972
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1973
        if getattr(ai, 'id') == value:
1974
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1975
          key = os.path.join(url[-2], url[-1], value)
1976
          action = ai._getCopy(context)
1977
          action = self.removeProperties(action)
1978
          self._objects[key] = action
Aurel's avatar
Aurel committed
1979
          self._objects[key].wl_clearLocks()
1980 1981
          break
      else:
1982
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1983

1984 1985 1986
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1987
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1988 1989
      p = context.getPortalObject()
      for id in self._objects.keys():
1990 1991 1992 1993 1994 1995
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
1996 1997
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
1998
          for index in range(len(action_list)):
1999
            if getattr(action_list[index], 'id') == path[-1]:
2000
              # remove previous action
2001
              obj.deleteActions(selections=(index,))
2002
          action = self._objects[id]
2003 2004 2005
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2006
          obj.addAction(
2007 2008
                        id = action.id
                      , name = action.title
2009
                      , action = action_text
2010 2011 2012 2013
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2014 2015
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2016
                      , priority = action.priority
Aurel's avatar
Aurel committed
2017
                    )
2018
          # sort action based on the priority define on it
2019 2020 2021 2022 2023 2024 2025 2026 2027
          # 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
2028
    else:
2029
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2030
      p = context.getPortalObject()
2031 2032
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2033
        relative_url, key, value = self._splitPath(id)
2034 2035
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2036
          if getattr(ai, key) == value:
2037
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2038 2039 2040
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2041
        obj.addAction(
Aurel's avatar
Aurel committed
2042 2043
                      id = action.id
                    , name = action.title
2044
                    , action = action_text
Aurel's avatar
Aurel committed
2045 2046 2047 2048
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2049 2050
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2051
                    )
Aurel's avatar
Aurel committed
2052 2053 2054 2055 2056 2057 2058
        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))
2059 2060
          obj.moveDownActions(selections=tuple(move_down_list))

2061 2062
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2063 2064 2065 2066
    object_path = kw.get("object_path", None)
    if object_path is not None:
      keys = [object_path]
    else:
2067
      keys = self._archive.keys()
2068
    for id in keys:
2069 2070 2071 2072
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083
        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 )
2084 2085
    BaseTemplateItem.uninstall(self, context, **kw)

2086 2087 2088
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2089
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
    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
2102
        for property in ('id', 'title', 'description',
2103 2104 2105 2106
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
2107 2108 2109 2110
        # condition
        prop_value = getattr(role, 'condition')
        if prop_value:
          type_role_dict['condition'] = prop_value.text
2111 2112 2113 2114 2115 2116 2117 2118 2119
        # 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
2120
  # Function to generate XML Code Manually
2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134
  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'):
2135
        for prop_value in role.get(property, []):
2136 2137 2138 2139 2140
          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
2141

2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154
  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)
2155
    xml_type_roles_list = xml.getElementsByTagName('role')
2156 2157 2158 2159 2160 2161 2162 2163
    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():
2164
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2165 2166 2167 2168 2169 2170 2171 2172 2173 2174
          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():
2175
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190
          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]
2191 2192 2193 2194 2195 2196
      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))
2197 2198 2199

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
2200 2201 2202 2203 2204 2205
    object_path = kw.get('object_path', None)
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
2206
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
2207 2208 2209 2210 2211 2212
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
      
2213 2214 2215 2216 2217 2218
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2219 2220
      for property in p.propertyMap():
        if property['id'] == id:
2221
          obj = p.getProperty(id)
2222
          prop_type = property['type']
2223 2224
          break
      else:
2225 2226
        obj = None
      if obj is None:
2227
        raise NotFound, 'the property %s is not found' % id
2228
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2229

2230 2231 2232 2233 2234 2235
  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
2236 2237
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2238 2239 2240 2241 2242 2243 2244
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2245
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2246
      self._objects[str(id)] = (str(prop_type), value)
2247

2248 2249 2250
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2251
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2252 2253
      p = context.getPortalObject()
      for path in self._objects.keys():
2254 2255 2256 2257
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2258
              continue
2259 2260 2261
          dir, id = os.path.split(path)
          if p.hasProperty(id):
            continue
2262 2263
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
2264
    else:
2265
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2266
      p = context.getPortalObject()
2267 2268
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
2269 2270 2271 2272 2273
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
2274 2275 2276

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2277 2278 2279 2280 2281 2282
    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:
2283 2284 2285 2286
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2287
  # Function to generate XML Code Manually
2288
  def generateXml(self, path=None):
2289
    xml_data = ''
2290
    prop_type, obj = self._objects[path]
2291 2292
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
2293 2294
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
2295
      xml_data += os.linesep+'  <value>'
2296
      for item in obj:
2297 2298 2299 2300
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
2301
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
2302
    xml_data += os.linesep+' </property>'
2303 2304
    return xml_data

Aurel's avatar
Aurel committed
2305 2306 2307 2308 2309
  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)
2310 2311 2312 2313
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2314
      xml_data += self.generateXml(path)
2315
    xml_data += os.linesep+'</site_property>'
2316
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2317

2318 2319 2320 2321 2322 2323 2324
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)
2325 2326 2327 2328 2329 2330 2331 2332
      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
2333

Christophe Dumez's avatar
Christophe Dumez committed
2334
  # Function to generate XML Code Manually
2335
  def generateXml(self, path=None):
2336 2337
    dict = self._objects[path]
    xml_data = '<module>'
2338 2339 2340 2341
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2342 2343 2344 2345 2346
      if key =='permission_list':
        # separe permission dict into xml
        xml_data += os.linesep+' <%s>' %(key,)
        permission_list = dict[key]
        for perm in permission_list:
2347 2348 2349 2350 2351 2352
          # 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,)
2353
          xml_data += os.linesep+'   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2354
          role_list = list(perm[1])
2355
          role_list.sort()
2356 2357 2358 2359 2360 2361 2362 2363 2364
          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

2365 2366 2367 2368 2369
  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)
2370 2371 2372
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
2373
      # expor module one by one
2374
      xml_data = self.generateXml(path=id)
2375
      bta.addObject(obj=xml_data, name=id, path=path)
2376

2377
  def install(self, context, trashbin, **kw):
2378
    portal = context.getPortalObject()
2379 2380
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2381
    if context.getTemplateFormatVersion() == 1:
2382
      items = self._objects
2383
    else:
2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395
      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)
2396
          module.portal_type = str(mapping['portal_type'])
2397 2398 2399 2400 2401 2402 2403 2404 2405 2406
        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
2407 2408 2409 2410 2411 2412 2413 2414 2415 2416

  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:
2417
          perm_type = perm.getAttribute('type').encode() or None
2418 2419 2420 2421 2422 2423 2424 2425 2426
          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))
2427 2428 2429 2430
          if perm_type == "list" or perm_type is None:
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441
          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

2442
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2443 2444 2445
    trash = kw.get('trash', 0)
    if trash:
      return
2446 2447 2448 2449 2450 2451
    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]
2452 2453
    p = context.getPortalObject()
    id_list = p.objectIds()
2454
    for id in keys:
2455
      if id in id_list:
2456
        try:
2457
          if trash and trashbin is not None:
2458 2459
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2460
          p.manage_delObjects([id])
2461
        except NotFound:
2462
          pass
2463 2464
    BaseTemplateItem.uninstall(self, context, **kw)

2465 2466 2467
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2468 2469

class DocumentTemplateItem(BaseTemplateItem):
2470 2471 2472 2473
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2474 2475 2476 2477

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

2480
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2481 2482
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502
      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
2503
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2504
      for id in self._objects.keys():
2505 2506 2507 2508 2509 2510 2511 2512 2513
        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:
2514
            globals()[self.local_file_writer_name](name, text, create=0)
2515
          except IOError, error:
2516
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
2517 2518
            if error.errno :
              raise
2519 2520 2521
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
2522
    else:
2523 2524 2525
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
2526
        # This raises an exception if the file exists.
2527
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
2528 2529
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
2530 2531

  def uninstall(self, context, **kw):
2532
    object_path = kw.get('object_path', None)
2533 2534 2535 2536 2537
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
2538
      globals()[self.local_file_remover_name](id)
2539 2540
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
2541 2542 2543 2544 2545 2546
  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():
2547 2548
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
2549

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

2554 2555 2556 2557 2558 2559
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

2560 2561 2562 2563 2564
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
2565

2566 2567 2568
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
2569 2570
  # Extension needs no import
  local_file_importer_name = None
2571 2572 2573 2574 2575
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
2576
  # Test needs no import
2577 2578 2579
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
2580

2581 2582 2583
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
2584 2585 2586

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2587 2588 2589 2590
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2591 2592
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
2593

2594
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2595 2596
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2597
      new_roles = self._objects.keys()
2598 2599 2600
      if installed_bt.id == 'installed_bt_for_diff':
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
2601 2602 2603
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
2604 2605
        for key in old_keys:
          new_dict[key] = ''
2606
        installed_bt._objects = new_dict
2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619
      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):
2620
    p = context.getPortalObject()
2621
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2622
    if context.getTemplateFormatVersion() == 1:
2623
      role_list = self._objects.keys()
2624
    else:
2625
      role_list = self._archive.keys()
2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637
    # 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
2638
    for role in role_list:
2639 2640 2641 2642 2643 2644 2645 2646 2647 2648
      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
2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660

  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)

2661 2662 2663 2664 2665 2666 2667 2668 2669
  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
2670
      if role in roles and role not in new_roles:
2671 2672 2673
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
2674
  # Function to generate XML Code Manually
2675
  def generateXml(self, path):
2676
    obj = self._objects[path]
2677
    xml_data = '<role_list>'
2678 2679
    obj.sort()
    for role in obj:
2680 2681 2682 2683
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

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

2693 2694
class CatalogResultKeyTemplateItem(BaseTemplateItem):

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

  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

2720
  def install(self, context, trashbin, **kw):
2721
    catalog = _getCatalogValue(self)
2722 2723 2724
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2725

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

2748
  def uninstall(self, context, **kw):
2749
    catalog = _getCatalogValue(self)
2750 2751 2752 2753
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2754
    object_path = kw.get('object_path', None)
2755 2756 2757 2758 2759
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2760 2761
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2762
    catalog.sql_search_result_keys = sql_search_result_keys
2763 2764
    BaseTemplateItem.uninstall(self, context, **kw)

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

Aurel's avatar
Aurel committed
2775 2776 2777 2778 2779
  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)
2780
    for path in self._objects.keys():
2781
      xml_data = self.generateXml(path=path)
2782
      bta.addObject(obj=xml_data, name=path, path=None)
2783

2784 2785
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

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

  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

2811
  def install(self, context, trashbin, **kw):
2812
    catalog = _getCatalogValue(self)
2813 2814 2815
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2816

2817
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2818
    if context.getTemplateFormatVersion() == 1:
2819
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2820
        return
2821 2822 2823
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2824
    else:
2825
      keys = self._archive.keys()
2826 2827
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
2828
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
2829
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
2830
      if not force:
Aurel's avatar
Aurel committed
2831 2832 2833 2834
        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
2835 2836 2837
        if action == 'nothing':
          return
      for key in keys:
2838 2839
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
2840
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
2841

2842
  def uninstall(self, context, **kw):
2843
    catalog = _getCatalogValue(self)
2844 2845 2846
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2847
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2848
    object_path = kw.get('object_path', None)
2849 2850 2851 2852 2853
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2854 2855 2856 2857 2858
      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
2859
  # Function to generate XML Code Manually
2860
  def generateXml(self, path=None):
2861
    obj = self._objects[path]
2862
    xml_data = '<key_list>'
2863 2864
    obj.sort()
    for key in obj:
2865 2866 2867 2868
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

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

2878 2879
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2880
  def build(self, context, **kw):
2881
    catalog = _getCatalogValue(self)
2882 2883 2884
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2885
    sql_search_result_tables = list(catalog.sql_search_tables)
2886
    key_list = []
2887
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2888
      if key in sql_search_result_tables:
2889
        key_list.append(key)
Aurel's avatar
Aurel committed
2890 2891
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2892
    if len(key_list) > 0:
2893
      self._objects[self.__class__.__name__+os.sep+'result_table_list'] = key_list
2894 2895 2896 2897 2898 2899 2900 2901 2902 2903

  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
2904

2905
  def install(self, context, trashbin, **kw):
2906
    catalog = _getCatalogValue(self)
2907 2908 2909
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2910

2911
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2912
    if context.getTemplateFormatVersion() == 1:
2913
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2914
        return
2915 2916 2917
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2918
    else:
2919
      keys = self._archive.keys()
2920 2921
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2922
    # XXX same as related keys
Aurel's avatar
Aurel committed
2923
    if update_dict.has_key('result_table_list') or force:
2924
      if not force:
Aurel's avatar
Aurel committed
2925
        action = update_dict['result_table_list']
2926
        if action == 'nothing':
Aurel's avatar
Aurel committed
2927
          return
2928
      for key in keys:
2929 2930
        if key not in sql_search_tables:
          sql_search_tables.append(key)
2931
      catalog.sql_search_tables = tuple(sql_search_tables)
2932 2933

  def uninstall(self, context, **kw):
2934
    catalog = _getCatalogValue(self)
2935 2936 2937 2938
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2939
    object_path = kw.get('object_path', None)
2940 2941 2942 2943 2944
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2945 2946
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2947
    catalog.sql_search_tables = sql_search_tables
2948 2949
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2950
  # Function to generate XML Code Manually
2951
  def generateXml(self, path=None):
2952
    obj = self._objects[path]
2953
    xml_data = '<key_list>'
2954 2955
    obj.sort()
    for key in obj:
2956
      xml_data += os.linesep+' <key>%s</key>' %(key)
2957
    xml_data += os.linesep+'</key_list>'
2958 2959
    return xml_data

Aurel's avatar
Aurel committed
2960 2961 2962 2963 2964 2965
  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():
2966
      xml_data = self.generateXml(path=path)
2967
      bta.addObject(obj=xml_data, name=path, path=None)
2968

2969 2970
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
2971 2972

  def build(self, context, **kw):
2973
    catalog = _getCatalogValue(self)
2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985
    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
2986

2987 2988 2989 2990 2991 2992 2993 2994 2995
  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
2996 2997

  def install(self, context, trashbin, **kw):
2998
    catalog = _getCatalogValue(self)
2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011
    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()
3012 3013
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025
    # 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):
3026
    catalog = _getCatalogValue(self)
3027 3028 3029 3030
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3031
    object_path = kw.get('object_path', None)
3032 3033
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3034
    else:
3035 3036 3037 3038 3039 3040 3041
      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
3042
  # Function to generate XML Code Manually
3043 3044 3045 3046 3047 3048 3049 3050
  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
3051 3052 3053 3054

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3055 3056 3057 3058 3059
    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)
3060

3061 3062
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3063

3064
  def build(self, context, **kw):
3065
    catalog = _getCatalogValue(self)
3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076
    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:
3077
      self._objects[self.__class__.__name__+os.sep+'full_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3078

3079 3080 3081 3082 3083 3084 3085 3086 3087
  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
3088

3089
  def install(self, context, trashbin, **kw):
3090
    catalog = _getCatalogValue(self)
3091 3092 3093
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3094

3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115
    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
3116

3117
  def uninstall(self, context, **kw):
3118
    catalog = _getCatalogValue(self)
3119 3120 3121 3122
    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)
3123
    object_path = kw.get('object_path', None)
3124 3125 3126 3127 3128 3129 3130 3131 3132 3133
    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
3134
  # Function to generate XML Code Manually
3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157
  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):
3158
    catalog = _getCatalogValue(self)
3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182
    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):
3183
    catalog = _getCatalogValue(self)
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
    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):
3211
    catalog = _getCatalogValue(self)
3212 3213 3214 3215
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
3216
    object_path = kw.get('object_path', None)
3217 3218 3219 3220 3221 3222 3223 3224 3225 3226
    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
3227
  # Function to generate XML Code Manually
3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249
  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):
3250
    catalog = _getCatalogValue(self)
3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274
    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):
3275
    catalog = _getCatalogValue(self)
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
    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):
3302
    catalog = _getCatalogValue(self)
3303 3304 3305 3306
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
3307
    object_path = kw.get('object_path', None)
3308 3309 3310 3311 3312 3313 3314 3315 3316 3317
    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
3318
  # Function to generate XML Code Manually
3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340
  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):
3341
    catalog = _getCatalogValue(self)
3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365
    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):
3366
    catalog = _getCatalogValue(self)
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
    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):
3394
    catalog = _getCatalogValue(self)
3395 3396 3397 3398
    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)
3399
    object_path = kw.get('object_path', None)
3400 3401 3402 3403 3404 3405 3406 3407 3408 3409
    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
3410
  # Function to generate XML Code Manually
3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432
  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
3433 3434 3435 3436 3437 3438 3439 3440 3441
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
      else: # XXX backward compatibilty
        lang = lang_key
        catalog = 'erp5_ui'
      path = os.path.join(lang, catalog)
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472

  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':
3473
              continue
3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502
          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
3503
      f = open(path+os.sep+'translation.po', 'wt')
3504 3505 3506 3507
      f.write(str(obj))
      f.close()

  def _importFile(self, file_name, file):
3508 3509 3510
    if os.path.split(file_name)[1] == 'translation.po':
      text = file.read()
      self._objects[file_name[:-3]] = text
3511

Aurel's avatar
Aurel committed
3512 3513
class LocalRolesTemplateItem(BaseTemplateItem):

3514
  def __init__(self, id_list, **kw):
3515
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
3516 3517
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
3518 3519 3520
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
3521
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
3522 3523 3524 3525
      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
3526 3527
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

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

Aurel's avatar
Aurel committed
3557 3558 3559 3560 3561 3562 3563 3564 3565 3566
  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 = []
3567
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
3568 3569 3570 3571
        if '%' not in folder:
          encode_folders.append(pathname2url(folder))
        else:
          encode_folders.append(folder)
3572
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
3573 3574 3575 3576 3577 3578 3579
      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]
3580
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3581 3582 3583 3584 3585 3586 3587 3588 3589 3590
    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]
3591
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624
    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__', {})
3625

3626 3627 3628
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
3629
    in part or completely. Each object is separated from its
3630 3631 3632 3633 3634 3635 3636 3637 3638 3639
    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
3640 3641
      - object without optimal actions
      - list of relation between portal type and workflow
3642 3643 3644 3645 3646 3647 3648 3649 3650 3651

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

    - site property definition
      - id
      - type
3652
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3653

3654 3655
    - document/propertysheet/extension/test definition
      - copy of the local file
3656

3657
    - message transalation definition
3658
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3659

3660 3661
    The Business Template properties are exported to the bt folder with
    one property per file
3662

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3663 3664
    Technology:

3665 3666
    - 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
3667

3668
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3669 3670 3671 3672

    Use case:

    - install core ERP5 (the minimum)
3673

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

3676 3677
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
3678
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3679 3680 3681 3682 3683
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
3684
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3685 3686 3687 3688 3689
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
3690
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3691 3692 3693 3694 3695 3696 3697

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
3698
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3699
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3700
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3701 3702 3703
                      , PropertySheet.BusinessTemplate
                      )

3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720
    # 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
      }

3721 3722
    # This is a global variable
    # Order is important for installation
3723 3724 3725 3726 3727 3728
    # We want to have:
    #  * path after module, because path can be module content
    #  * path after categories, because path can be categories content
    #  * skin after paths, because we can install a custom connection string as
    #       path and use it with SQLMethods in a skin.
    #    ( and more )
3729 3730 3731
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
3732
      '_constraint_item',
3733 3734 3735 3736 3737 3738 3739 3740
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
3741
      '_portal_type_workflow_chain_item',
3742 3743 3744 3745
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
3746 3747
      '_category_item',
      '_module_item',
3748
      '_path_item',
3749
      '_skin_item',
3750
      '_preference_item',
3751
      '_action_item',
3752
      '_portal_type_roles_item',
3753
      '_local_roles_item',
3754
      '_catalog_method_item',
3755 3756 3757
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
3758 3759 3760 3761 3762
      '_catalog_keyword_key_item',
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
3763 3764 3765 3766
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3767 3768 3769 3770 3771 3772
      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
3773
        self._baseGetTemplateFormatVersion()
3774

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3775 3776 3777
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
3778

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3779
      return 0
3780

3781
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
3782 3783 3784 3785 3786 3787 3788
    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".
3789 3790
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
3791
          # XXX Not good to access the attribute directly,
3792 3793 3794
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
3795

3796 3797
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
3798 3799 3800 3801 3802 3803
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

3804
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
3805 3806 3807 3808 3809 3810 3811 3812
        """Increment bt revision number.
        """
        revision_number = self.getRevision()
        if revision_number is None or revision_number.strip() == '':
          revision_number = 1
        else:
          revision_number = int(revision_number)+1
        self.setRevision(revision_number)
3813

3814
    security.declareProtected(Permissions.ManagePortal, 'build')
3815
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3816 3817 3818
      """
        Copy existing portal objects to self
      """
3819
      if no_action: return
3820
        # this is use at import of Business Template to get the status built
3821 3822
      # Make sure that everything is sane.
      self.clean()
3823

3824 3825 3826
      # Update revision number
      # <christophe@nexedi.com>
      self.updateRevisionNumber()
3827

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3828 3829
      self._setTemplateFormatVersion(1)

3830
      # Store all data
3831 3832
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
3833
      self._portal_type_workflow_chain_item = \
3834
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
3835 3836 3837 3838 3839 3840 3841 3842 3843 3844
      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())
3845 3846
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
3847 3848 3849 3850 3851 3852 3853 3854
      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())
3855 3856
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876
      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())
3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888
      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())
3889 3890
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
3891 3892
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
3893 3894
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
3895
               self.getTemplateCatalogKeywordKeyList())
3896 3897
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
3898
               self.getTemplateCatalogFullTextKeyList())
3899 3900
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
3901
               self.getTemplateCatalogRequestKeyList())
3902 3903
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
3904
               self.getTemplateCatalogMultivalueKeyList())
3905 3906 3907
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
3908 3909 3910
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
3911

3912 3913 3914
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
3915

3916
    build = WorkflowMethod(build)
3917 3918

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3919
      """
3920
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3921
      """
3922
      return self.portal_templates.publish(self, url, username=username,
3923
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3924

3925
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3926
      """
3927
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3928
      """
3929
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3930

3931
    def preinstall(self, check_dependencies=1, **kw):
3932 3933 3934
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
3935
      """
3936

3937 3938 3939 3940 3941
      if check_dependencies:
        # required because in multi installation, dependencies has already
        # been checked before and it will failed here as dependencies can be
        # installed at the same time
        self.checkDependencies()
3942

3943 3944
      modified_object_list = {}
      bt_title = self.getTitle()
3945 3946 3947 3948 3949 3950 3951

      #  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)
3952 3953 3954
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3955
        installed_bt_format = installed_bt.getTemplateFormatVersion()
3956

3957
      # if reinstall business template, must compare to object in ZODB
3958
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
3959
      # same if we make a diff and select only one business template
3960
      reinstall = 0
3961 3962
      if installed_bt == self:
        reinstall = 1
3963 3964 3965
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
3966 3967 3968
        bt2.edit(description='tmp bt generated for diff')
        bt2.build()
        installed_bt = bt2
3969

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3970
      new_bt_format = self.getTemplateFormatVersion()
3971 3972 3973 3974 3975 3976
      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:
3977
          item = getattr(self, item_name, None)
3978 3979 3980 3981
          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
3982

3983 3984 3985 3986
      # 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:
3987
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3988
        old_item = getattr(installed_bt, item_name, None)
3989
        if new_item is not None:
3990
          if old_item is not None and hasattr(old_item, '_objects'):
3991 3992 3993 3994 3995 3996 3997 3998
            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:
3999
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4000

4001 4002
      return modified_object_list

4003
    def _install(self, force=1, object_to_update=None, **kw):
4004
      """
Christophe Dumez's avatar
Christophe Dumez committed
4005
        Install a new Business Template, if force, all will be upgraded or installed
4006 4007
        otherwise depends of dict object_to_update
      """
4008 4009 4010 4011
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4012

4013 4014
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
4015
      if installed_bt is not None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4016
        if installed_bt.getTemplateFormatVersion() == 0:
4017
          force = 1
4018
        installed_bt.replace(self)
4019

4020 4021 4022 4023
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4024 4025 4026
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4027

4028 4029 4030
      if not force:
        self.checkDependencies()

4031 4032 4033 4034 4035 4036
      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')
4037
        gen.setupLastTools(site, update=1, create_activities=1)
4038 4039
      if not force:
        if len(object_to_update) == 0:
4040 4041 4042 4043 4044
          # 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():
4045
            LOG('Business Template', 0, 'Updating Business Template Workflows')
4046
            gen.setupWorkflow(site)
4047
          return
4048 4049 4050 4051

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

4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066
      # 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)
4067

4068 4069 4070
      # update catalog if necessary
      update_catalog=0
      catalog_method = getattr(self, '_catalog_method_item', None)
4071 4072 4073
      if catalog_method is not None and self.getTemplateFormatVersion() == 1 \
        and _getCatalogValue(self) is self.getPortalObject().portal_catalog.getSQLCatalog():
        # It is needed to update the catalog only if the default SQLCatalog is modified.
4074 4075 4076 4077 4078 4079 4080 4081 4082
        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
4083
              break
4084
      if update_catalog:
4085
        catalog = _getCatalogValue(self)
4086
        if (catalog is None) or (not site.isIndexable):
4087 4088 4089 4090 4091
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4092

4093
      # get objects to remove
4094
      # do remove after because we may need backup object from installation
4095 4096 4097 4098 4099 4100
      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)
4101

4102 4103 4104
      # remove object from old business template
      if len(remove_object_dict) > 0:
        for item_name in installed_bt._item_name_list:
4105
          item = getattr(installed_bt, item_name, None)
4106 4107
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
4108

4109 4110 4111 4112 4113 4114

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

4115
      # check if we have to update business template workflow
4116
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4117
        LOG('Business Template', 0, 'Updating Business Template Workflows')
4118 4119 4120 4121 4122
        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)

4123 4124 4125 4126 4127
      # remove trashbin if empty
      if trashbin is not None:
        if len(trashbin.objectIds()) == 0:
          trash_tool.manage_delObjects([trashbin.getId(),])

4128 4129
      if update_catalog:
        site.ERP5Site_reindexAll()
4130

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4131 4132 4133
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
4134

4135
    security.declareProtected(Permissions.ManagePortal, 'install')
4136 4137 4138
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4139
      """
4140
      return self._install(**kw)
4141

4142
    install = WorkflowMethod(install)
4143

4144
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4145
    def reinstall(self, **kw):
4146 4147 4148 4149
      """Reinstall Business Template.
      """
      return self._install(**kw)

4150
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4151

4152
    security.declareProtected(Permissions.ManagePortal, 'trash')
4153 4154
    def trash(self, new_bt, **kw):
      """
4155
        Trash unnecessary items before upgrading to a new business
4156
        template.
4157
        This is similar to uninstall, but different in that this does
4158
        not remove all items.
4159 4160 4161 4162 4163
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4164 4165
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4166
        item = getattr(self, item_name, None)
4167 4168 4169 4170
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
4171

4172
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
4173
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4174
      """
4175
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4176
      """
4177 4178 4179 4180
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4181 4182 4183
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4184
        item = getattr(self, item_name, None)
4185 4186
        if item is not None:
          item.uninstall(local_configuration)
4187
      # It is better to clear cache because the uninstallation of a
4188
      # template deletes many things from the portal.
4189
      clearCache()
4190

4191 4192
    uninstall = WorkflowMethod(uninstall)

4193
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4194
    def _clean(self):
4195
      """
4196
        Clean built information.
4197
      """
4198
      # First, remove obsolete attributes if present.
4199 4200 4201 4202
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4203
                    '_module_archive',
4204 4205 4206
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4207
                    '_property_sheet_archive'):
4208 4209 4210
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4211 4212
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4213

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

4216
    security.declareProtected(Permissions.AccessContentsInformation,
4217
                              'getBuildingState')
4218
    def getBuildingState(self, default=None, id_only=1):
4219
      """
4220
        Returns the current state in building
4221
      """
4222
      portal_workflow = getToolByName(self, 'portal_workflow')
4223 4224
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4225
      return wf._getWorkflowStateOf(self, id_only=id_only )
4226

4227
    security.declareProtected(Permissions.AccessContentsInformation,
4228
                              'getInstallationState')
4229
    def getInstallationState(self, default=None, id_only=1):
4230
      """
4231
        Returns the current state in installation
4232
      """
4233
      portal_workflow = getToolByName(self, 'portal_workflow')
4234 4235
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4236
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4237

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4238 4239 4240 4241 4242 4243
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4244
      export_string = portal_templates.manage_exportObject(
4245 4246
                                               id=self.getId(),
                                               toxml=1,
4247
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4248
      return export_string
4249

4250
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4251
      """
4252 4253
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4254
      """
4255
      result = getattr(self, id, ())
4256 4257 4258 4259
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4260
        # XXX Why do we need to return a tuple ?
4261 4262
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4263

4264
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4265
      """
4266 4267
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4268
      """
4269
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4270

4271
    def getTemplateBaseCategoryList(self):
4272
      """
4273 4274
      We have to set this method because we want an
      ordered list
4275
      """
4276
      return self._getOrderedList('template_base_category')
4277

4278
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4279
      """
4280 4281
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4282
      """
4283
      return self._getOrderedList('template_workflow_id')
4284

4285
    def getTemplatePortalTypeIdList(self):
4286
      """
4287 4288
      We have to set this method because we want an
      ordered list
4289
      """
4290
      return self._getOrderedList('template_portal_type_id')
4291

4292 4293 4294 4295 4296 4297 4298
    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
4299 4300 4301 4302 4303 4304 4305
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

4306 4307 4308 4309 4310 4311 4312
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

4313 4314 4315 4316 4317 4318
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4319

4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340
    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')

4341
    def getTemplateActionPathList(self):
4342
      """
4343 4344
      We have to set this method because we want an
      ordered list
4345
      """
4346
      return self._getOrderedList('template_action_path')
4347

4348 4349 4350 4351 4352 4353 4354
    def getTemplatePortalTypeRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_roles')

4355
    def getTemplateSkinIdList(self):
4356
      """
4357 4358
      We have to set this method because we want an
      ordered list
4359
      """
4360
      return self._getOrderedList('template_skin_id')
4361

4362
    def getTemplateModuleIdList(self):
4363
      """
4364 4365
      We have to set this method because we want an
      ordered list
4366
      """
4367
      return self._getOrderedList('template_module_id')
4368 4369 4370 4371 4372 4373 4374

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

4376
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
4377 4378 4379 4380
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
4381
      if self.getBuildingState() != 'built':
4382
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
4383
              'Business Template must be built before export'
4384 4385 4386
      if self.getInstallationState() == 'installed':
        raise TemplateConditionError, \
              'Can not export installed Business Template'
4387

Aurel's avatar
Aurel committed
4388 4389 4390 4391 4392 4393 4394
      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)

4395
      # export bt
4396
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
4397
      for prop in self.propertyMap():
4398
        prop_type = prop['type']
Aurel's avatar
Aurel committed
4399
        id = prop['id']
4400
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
4401
                  'install_object_list_list', 'id_generator'):
4402
          continue
Aurel's avatar
Aurel committed
4403
        value = self.getProperty(id)
4404
        if prop_type in ('text', 'string', 'int', 'boolean'):
4405
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
4406
        elif prop_type in ('lines', 'tokens'):
4407
          bta.addObject(obj=str(os.linesep).join(value), name=id,
4408
                        path=path+os.sep+'bt', ext='')
4409

Aurel's avatar
Aurel committed
4410 4411 4412
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
4413

Aurel's avatar
Aurel committed
4414 4415
      return bta.finishCreation()

4416
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
4417 4418
    def importFile(self, dir = 0, file=None, root_path=None):
      """
4419
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
4420 4421 4422 4423 4424
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
4425

Aurel's avatar
Aurel committed
4426 4427
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4428
      self._portal_type_workflow_chain_item = \
4429
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
4430 4431 4432 4433 4434 4435 4436 4437 4438 4439
      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())
4440 4441
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
4442 4443 4444 4445 4446 4447 4448 4449
      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())
4450 4451
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473
      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())
4474 4475
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489
      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(
4490
               self.getTemplateCatalogKeywordKeyList())
4491 4492
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4493
               self.getTemplateCatalogFullTextKeyList())
4494 4495
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4496
               self.getTemplateCatalogRequestKeyList())
4497 4498
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4499
               self.getTemplateCatalogMultivalueKeyList())
4500 4501 4502
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4503 4504 4505
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
4506

Aurel's avatar
Aurel committed
4507 4508
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4509

4510 4511 4512 4513 4514 4515
    #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:
4516 4517 4518
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
4519
      return items_list
4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533
    
    #By christophe Dumez <christophe@nexedi.com>
    def checkDependencies(self):
      """
       Check if all the dependencies of the business template
       are installed. Raise an exception with the list of
       missing dependencies if some are missing
      """
      missing_dep_list = []
      dependency_list = self.getDependencyList()
      if len(dependency_list)!=0:
        for dependency_couple in dependency_list:
          dependency_couple_list = dependency_couple.split(' ')
          dependency = dependency_couple_list[0]
4534 4535
          if dependency in (None, ''):
            continue
4536 4537 4538 4539 4540 4541
          version_restriction = None
          if len(dependency_couple_list) > 1:
            version_restriction = dependency_couple_list[1][1:-1]
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
4542
                  or (version_restriction not in (None, '') and 
4543 4544 4545 4546
                     (not self.portal_templates.compareVersionStrings(installed_bt.getVersion(), version_restriction)))):
            missing_dep_list.append((dependency, version_restriction or ''))
      if len(missing_dep_list) != 0:
        raise BusinessTemplateMissingDependency, 'Impossible to install, please install the following dependencies before: %s'%repr(missing_dep_list)
4547

Aurel's avatar
Aurel committed
4548
    def diffObject(self, REQUEST, **kw):
4549 4550
      """
        Make a diff between an object in the Business Template
4551
        and the same in the Business Template installed in the site
4552 4553 4554 4555
      """

      class_name_dict = {
        'Product' : '_product_item',
4556
        'PropertySheet' : '_property_sheet_item',
4557
        'Constraint' : '_constraint_item',
4558 4559 4560 4561 4562 4563 4564 4565 4566
        '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',
4567
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
4568 4569 4570 4571
        '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',
4572 4573 4574 4575
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
4576
        'Preference' : '_preference_item',
4577
        'Action' : '_action_item',
4578
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4579
        'LocalRoles' : '_local_roles_item',
4580 4581 4582
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4583 4584 4585 4586 4587
        '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',
4588
        }
4589

4590 4591
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
4592

Christophe Dumez's avatar
Christophe Dumez committed
4593
      # Get objects
4594
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4595

Aurel's avatar
Aurel committed
4596
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
4597
      # Compare with a given business template
4598
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
4599 4600
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
4601 4602
        if bt2_id == self.getId():
          compare_to_zodb = 1
4603
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
4604 4605
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
4606 4607 4608
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
4609 4610 4611
          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
4612
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
4613 4614 4615
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
4616

4617 4618
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
4619
      if compare_to_zodb:
Aurel's avatar
Aurel committed
4620
        # XXX maybe only build for the given object to gain time
4621
        installed_item.build(self)
4622 4623 4624
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
4625

Christophe Dumez's avatar
Christophe Dumez committed
4626
      # Real Zope Objects (can be exported into XML directly by Zope)
4627 4628
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
4629
                     '_category_item', '_path_item', '_preference_tem',
Christophe Dumez's avatar
Christophe Dumez committed
4630
                     '_skin_item', '_action_item',]
4631

Christophe Dumez's avatar
Christophe Dumez committed
4632
      # Not considered as objects by Zope (will be exported into XML manually)
4633
      # XXX Bad naming
4634
      item_list_2 = ['_site_property_item', '_module_item',
4635
                     '_catalog_result_key_item', '_catalog_related_key_item',
4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647
                     '_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',
4648
                     '_portal_type_workflow_chain_item',]
4649

Christophe Dumez's avatar
Christophe Dumez committed
4650
      # Text objects (no need to export them into XML)
4651
      # XXX Bad naming
4652 4653
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
4654
                     '_test_item', '_message_translation_item',]
4655

4656
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
4657 4658 4659
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
4660 4661
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
4662
        # XML Export in memory
4663 4664 4665
        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()
4666
        f1.close()
4667 4668 4669 4670
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
4671
        # End of XML export
4672

4673
        # Diff between XML objects
4674 4675
        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
4676
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4677 4678 4679
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4680

4681
      elif item_name in item_list_2:
4682
        # Generate XML code manually
4683 4684
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
4685 4686
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
4687
        # End of XML Code Generation
4688

4689
        # Diff between XML objects
4690 4691
        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
4692
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4693 4694 4695
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4696

4697
      elif item_name in item_list_3:
4698
        # Diff between text objects
4699 4700 4701 4702
        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
4703
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4704 4705
          diff_msg += '\n'.join(diff_list)
        else:
4706
          diff_msg = 'No diff'
4707

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

4711 4712
      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4713

4714
      return diff_msg
4715

4716

4717 4718 4719 4720
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
4721 4722
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
4723 4724 4725 4726 4727 4728 4729
      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 [])
4730 4731
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

4732
      p = self.getPortalObject()
4733
      for id in bt_portal_types_id_list:
4734 4735
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
4736
          continue
4737
        if len(getattr(portal_type, '_roles', ())) > 0:
4738 4739
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
4740

4741 4742 4743 4744
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
4745
        action_list = []
4746 4747 4748 4749 4750 4751 4752
        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'):
4753
          base_category_list = portal_type.base_category_list
4754 4755
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
4756

4757 4758 4759 4760
        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)
4761

4762
        for h_id in hidden_content_type_list:
4763 4764 4765
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
4766

4767 4768 4769 4770
        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)
4771

4772 4773 4774 4775
        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)
4776

4777 4778 4779 4780
        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)
4781

4782
        for workflow_id in [chain for chain in wtool.getChainFor(id)
4783
                                    if chain != '(Default)']:
4784 4785 4786
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
4787

4788 4789 4790 4791
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
4792
      bt_action_list.sort()
4793
      bt_wf_chain_list.sort()
4794

4795 4796 4797 4798 4799 4800 4801
      self.setProperty('template_portal_type_workflow_chain', bt_wf_chain_list)
      self.setProperty('template_portal_type_roles', bt_portal_type_roles_list)
      self.setProperty('template_portal_type_allowed_content_type', bt_allowed_content_type_list)
      self.setProperty('template_portal_type_hidden_content_type', bt_hidden_content_type_list)
      self.setProperty('template_portal_type_property_sheet', bt_property_sheet_list)
      self.setProperty('template_portal_type_base_category', bt_base_category_list)
      self.setProperty('template_action_path', bt_action_list)
4802 4803 4804 4805 4806 4807 4808 4809 4810
      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:
4811 4812
        raise TemplateConditionError, 'No module defined in business template'

4813 4814 4815 4816 4817 4818 4819 4820
      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:
4821
          return type_list
4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835

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

4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885
      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

4886 4887 4888 4889 4890
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
  setattr(BusinessTemplate, key, None) 

4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917
# 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)
4918

4919 4920 4921 4922 4923 4924 4925 4926

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

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