BusinessTemplate.py 184 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
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
114

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
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)

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
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
159 160 161
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
162
  """
Aurel's avatar
Aurel committed
163 164 165 166 167 168 169 170 171 172 173 174

  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
175

Aurel's avatar
Aurel committed
176 177 178 179 180
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
181
    Class archiving business template into a folder tree
182
  """
Aurel's avatar
Aurel committed
183 184 185 186 187 188
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
189
      removeAll(self.path)
Aurel's avatar
Aurel committed
190 191 192
      os.makedirs(self.path)

  def addFolder(self, name=''):
193
     if name !='':
Aurel's avatar
Aurel committed
194
      path = os.path.join(self.path, name)
195
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
196 197 198
        os.makedirs(path)
      return path

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

  def _initImport(self, file=None, path=None, **kw):
212 213 214
    # 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)
215
    # to make id consistent, must remove a part of path while importing
216
    self.root_path_len = len(string.split(path, os.sep)) + 1
Aurel's avatar
Aurel committed
217

218
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
219 220 221 222
    """
      Import file from a local folder
    """
    class_name = klass.__class__.__name__
223
    for file_path in self.file_list:
224
      if class_name in file_path.split(os.sep):
225 226
        if os.path.isfile(file_path):
          file = open(file_path, 'r')
Aurel's avatar
Aurel committed
227
          # get object id
228 229
          folders = file_path.split(os.sep)
          file_name = string.join(folders[self.root_path_len:], os.sep)
230 231
          if '%' in file_name:
            file_name = url2pathname(file_name)
232
          klass._importFile(file_name, file)
Aurel's avatar
Aurel committed
233
          # close file
234
          file.close()
235

Aurel's avatar
Aurel committed
236 237 238 239 240 241
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
242
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
243 244 245 246 247
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
248
      removeAll(self.path)
Aurel's avatar
Aurel committed
249 250 251 252 253 254
      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
255
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
256 257
      os.makedirs(name)

258
  def addObject(self, obj, name, path=None, ext='.xml'):
259
    name = pathname2url(name)
Aurel's avatar
Aurel committed
260 261 262
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
263 264
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
265 266
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
267
    f.write(str(obj))
Aurel's avatar
Aurel committed
268 269 270 271 272
    f.close()

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
273
    removeAll(self.path)
Aurel's avatar
Aurel committed
274 275 276 277 278
    return self.fobj

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

279
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
280 281
    """
      Import all file from the archive to the site
282
    """
Aurel's avatar
Aurel committed
283 284 285 286 287 288
    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
289 290
      if 'CVS' in info.name.split('/'):
        continue
Yoshinori Okuji's avatar
Yoshinori Okuji committed
291 292
      if '.svn' in info.name.split('/'):
        continue
293
      if class_name in info.name.split('/'):
Aurel's avatar
Aurel committed
294 295
        if info.isreg():
          file = tar.extractfile(info)
296 297 298
          tar_file_name = info.name.startswith('./') and info.name[2:] or \
              info.name
          folders = string.split(tar_file_name, os.sep)
299 300 301 302
          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
303 304 305
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
306

307
class TemplateConditionError(Exception): pass
308
class TemplateConflictError(Exception): pass
309
class BusinessTemplateMissingDependency(Exception): pass
310

311
class BaseTemplateItem(Implicit, Persistent):
312
  """
313
    This class is the base class for all template items.
314
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
315

316
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
317
    self.__dict__.update(kw)
318
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
319
    self._objects = PersistentMapping()
320
    for id in id_list:
321 322
      if id is not None and id != '':
        self._archive[id] = None
323 324 325 326

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

327
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
328 329
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
330
      new_keys = self._objects.keys()
331
      for path in new_keys:
332 333
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
334 335
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
336 337 338 339 340 341 342 343 344 345 346 347
          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):
348
    pass
349 350 351

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

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
  def remove(self, context, **kw):
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
    # if you choose remove, the object and all its subobjects will be removed
    # even if you choose backup or keep for subobjects
    # it is same behaviour for backup_and_remove, all we be save
    for path in keys:
      if remove_dict.has_key(path):
        action = remove_dict[path]
        if action == 'save_and_remove':
          # like trash
          self.uninstall(context, trash=1, object_path=path, **kw)
        elif action == 'remove':
          self.uninstall(context, trash=0, object_path=path, **kw)
368

369

370 371 372 373
  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
374
  def export(self, context, bta, **kw):
375
    pass
Aurel's avatar
Aurel committed
376

377 378
  def getKeys(self):
    return self._objects.keys()
379

Aurel's avatar
Aurel committed
380
  def importFile(self, bta, **kw):
381
    bta.importFiles(klass=self)
382

383 384 385
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
386
    """
387 388 389 390 391 392 393
    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
394 395
    if hasattr(aq_base(obj), '_filepath'):
      obj._filepath = None
396
    if hasattr(aq_base(obj), 'workflow_history'):
397 398 399 400
      if hasattr(obj.__class__, 'workflow_history'):
        obj.workflow_history = None
      else:
        del obj.workflow_history
401 402 403
    if getattr(obj, 'meta_type', None) == 'Script (Python)':
      if hasattr(aq_base(obj), '_code'):
        obj._code = None
404 405
      if hasattr(aq_base(obj), 'Python_magic'):
        obj.Python_magic = None
406 407 408
    elif getattr(obj, 'meta_type', None) == 'ERP5 PDF Form' :
      if not obj.getProperty('business_template_include_content', 1) :
        obj.deletePdfContent()
409 410
    return obj

411 412 413
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
414
  """
415

416 417 418 419
  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()
420
      self._archive.clear()
421 422 423
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
424

425 426 427 428 429
  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():
430
      obj = self._objects[key]
431 432
      # create folder and subfolders
      folders, id = os.path.split(key)
Aurel's avatar
Aurel committed
433 434 435 436 437 438 439
      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))
440 441 442
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
443 444
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
445

Aurel's avatar
Aurel committed
446 447 448 449
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
450
      relative_url = '/'.join([url,id])
451 452
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
453
      obj = self.removeProperties(obj)
454
      id_list = obj.objectIds()
455
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
456
        # we must keep groups because it's ereased when we delete subobjects
457
        groups = deepcopy(obj.groups)
458
      if id_list:
Aurel's avatar
Aurel committed
459
        self.build_sub_objects(context, id_list, relative_url)
460
        for id_ in list(id_list):
461
          obj._delObject(id_)
462
      if hasattr(aq_base(obj), 'groups'):
463 464 465
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
466 467
    return sub_list

468 469 470 471
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
472 473
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
474
      obj = self.removeProperties(obj)
475
      id_list = obj.objectIds()
476
      if hasattr(aq_base(obj), 'groups'):
Christophe Dumez's avatar
Christophe Dumez committed
477
        # we must keep groups because it's erased when we delete subobjects
478
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
479 480
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
481
        for id_ in list(id_list):
482
          obj._delObject(id_)
483
      if hasattr(aq_base(obj), 'groups'):
484 485 486
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
487

488 489 490 491 492 493 494
  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
495 496
    __traceback_info__ = 'Importing %s' % file_name
    obj = connection.importFile(file, customImporters=customImporters)
497 498
    self._objects[file_name[:-4]] = obj

499
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
500 501
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
502 503 504 505 506 507 508
      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]
509 510
          new_object = self.removeProperties(new_object)
          old_object = self.removeProperties(old_object)
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
          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

530
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
531 532 533
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
534
    subobjects_dict = {}
535
    if trashbin is None: # must return subobjects
536 537 538 539 540 541
      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)
542
        subobjects_dict[subobject_id] = subobject_copy
543
      return subobjects_dict
544 545
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
546
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, **kw)
547
    elif action == 'install':
548
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0, **kw)
549
    return subobjects_dict
550

551 552 553
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
554
    if context.getTemplateFormatVersion() == 1:
555
      groups = {}
556
      old_groups = {}
557 558 559 560 561
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
562 563 564 565 566 567 568
        if update_dict.has_key(path) or force:
          # get action for the oject
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          else:
569
            action = 'backup'
570
          # get subobjects in path
571 572 573
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
574 575 576 577
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
578
            container_url = '/'.join(container_path)
579 580 581 582 583 584 585
            if update_dict.has_key(container_url):
              if update_dict[container_url] == 'nothing':
                continue
            raise
          container_ids = container.objectIds()
          subobjects_dict = {}
          # Object already exists
586
          if object_id in container_ids:     
587
            old_obj = container._getOb(object_id)
588 589 590 591 592 593
            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)
594
            subobjects_dict = self._backupObject(action, trashbin,
595
                                                 container_path, object_id)
596 597
            container.manage_delObjects([object_id])
          # install object
598
          obj = self._objects[path]
599 600 601
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
602
          if hasattr(aq_base(obj), 'groups'):
603
            # we must keep original order groups
604
            # because they change when we add subobjects
605
            groups[path] = deepcopy(obj.groups)
606
          # copy the object
607 608 609 610 611
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
612
          # if portal types upgrade, set backup properties
613 614
          if getattr(obj, 'meta_type', None) == 'ERP5 Type Information' and \
              len(subobjects_dict) > 0:
615
            setattr(obj, 'allowed_content_types',
616
                    subobjects_dict['allowed_content_type_list'] or [])
617
            setattr(obj, 'hidden_content_type_list',
618
                    subobjects_dict['hidden_content_type_list'] or [])
619
            setattr(obj, 'property_sheet_list',
620
                    subobjects_dict['property_sheet_list'] or [])
621
            setattr(obj, 'base_category_list',
622
                    subobjects_dict['base_category_list'] or [])
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
            setattr(obj, '_roles', subobjects_dict['roles_list'] or [])
            # set actions
            action_list = subobjects_dict['action_list']
            for action in action_list:
              obj.addAction(id = action.id
                            , name = action.title
                            , action = action.action.text
                            , condition = action.getCondition()
                            , permission = action.permissions
                            , category = action.category
                            , visible = action.visible
                            , icon = getattr(action, 'icon', None) and action.icon.text or ''
                            , priority = action.priority
                            )
            # set workflow chain
            wf_chain = subobjects_dict['workflow_chain']
            chain_dict = getChainByType(context)[1]
            default_chain = ''
            chain_dict['chain_%s' %(object_id)] = wf_chain
642
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
643
          # import sub objects if there is
644
          elif len(subobjects_dict) > 0:
645
            # get a jar
646 647
            connection = obj._p_jar
            o = obj
648
            while connection is None:
649 650
              o = o.aq_parent
              connection = o._p_jar
651 652 653 654 655
            # import subobjects
            for subobject_id in subobjects_dict.keys():
              subobject_data = subobjects_dict[subobject_id]
              subobject_data.seek(0)
              subobject = connection.importFile(subobject_data)
656
              if subobject_id not in obj.objectIds():
657
                obj._setObject(subobject_id, subobject)
658
          if obj.meta_type in ('Z SQL Method',):
659
            fixZSQLMethod(portal, obj)
660
      # now put original order group
661 662
      # we remove object not added in forms
      # we put old objects we have kept
663
      for path in groups.keys():
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
        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,]
          # 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
          obj.groups = new_groups_dict            
Aurel's avatar
Aurel committed
712
    else:
713 714
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
715
      portal = context.getPortalObject()
716
      for relative_url in self._archive.keys():
717
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
718 719 720 721
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
722
        if object_id in container_ids:    # Object already exists
723
          self._backupObject('backup', trashbin, container_path, object_id)
724
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
725
        # Set a hard link
726 727 728 729 730 731
        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',):
732
          fixZSQLMethod(portal, obj)
733 734 735

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
736
    trash = kw.get('trash', 0)
737 738 739 740 741
    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
742
      object_keys = self._archive.keys()
743
    for relative_url in object_keys:
744 745
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
746
      try:
747
        container = portal.unrestrictedTraverse(container_path)
748
        if trash and trashbin is not None:
749 750
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
        container.manage_delObjects([object_id])
751
      except (NotFound, KeyError, BadRequest):
752
        # object is already backup and/or removed
753
        pass
754 755
    BaseTemplateItem.uninstall(self, context, **kw)

756 757 758 759 760 761 762 763 764 765 766 767
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

768 769 770 771 772 773 774 775 776
  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()
777 778
    object_keys.sort()
    object_keys.reverse()
779
    p = context.getPortalObject()
780 781
    object_keys.sort()
    object_keys.reverse()
782 783
    for path in object_keys:
      for relative_url in self._resolvePath(p, [], path.split('/')):
784
        try:
Aurel's avatar
Aurel committed
785 786
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
787 788
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
789 790
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
791
                                           keep_subobjects=1)
792 793 794 795 796 797
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

798 799 800
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
801

802 803 804 805 806 807 808 809 810
      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.
811 812 813
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
814
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
815 816
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
817
      if object_id != "":
818
        path_list.extend(self._resolvePath(
819
            folder._getOb(object_id),
820
            relative_url_list + [object_id], id_list[1:]))
821
    return path_list
Aurel's avatar
Aurel committed
822

823 824 825
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
826
    keys = self._path_archive.keys()
827
    keys.sort()
Aurel's avatar
Aurel committed
828
    for path in keys:
829 830 831
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
832
      for relative_url in self._resolvePath(p, [], path.split('/')):
833 834
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
835
        obj = obj.__of__(context)
836
        id_list = obj.objectIds()
837
        obj = self.removeProperties(obj)
838
        if hasattr(aq_base(obj), 'groups'):
839
          # we must keep groups because it's ereased when we delete subobjects
840
          groups = deepcopy(obj.groups)
841
        if len(id_list) > 0:
842 843
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
844
          for id_ in list(id_list):
845
            obj._delObject(id_)
846
        if hasattr(aq_base(obj), 'groups'):
847 848 849
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
850

851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
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")
866
    if len(id_list) != 1:
867 868 869 870 871 872 873 874 875 876 877 878
      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():
879
      pref = portal.unrestrictedTraverse(object_path)
880
      # XXX getPreferenceState is a bad name
881 882 883
      if pref.getPreferenceState() == 'disabled':
        portal.portal_workflow.doActionFor(
                      pref,
884 885 886 887 888
                      'enable_action',
                      wf_id='preference_workflow',
                      comment="Initialized during Business Template " \
                              "installation.")

889 890
class CategoryTemplateItem(ObjectTemplateItem):

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

894 895 896 897
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
898 899
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
900
      obj = self.removeProperties(obj)
901
      id_list = obj.objectIds()
902
      if id_list:
903
        self.build_sub_objects(context, id_list, relative_url)
904
        for id_ in list(id_list):
905
          obj._delObject(id_)
906 907
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
908 909 910 911 912

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
913 914
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
915
      obj = self.removeProperties(obj)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
916
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
917
      id_list = obj.objectIds()
918 919
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
920
        for id_ in list(id_list):
921
          obj._delObject(id_)
922
      else:
923
        for id_ in list(id_list):
924
          obj._delObject(id_)
925 926
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
927

928
  def install(self, context, trashbin, **kw):
929 930
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
931
    if context.getTemplateFormatVersion() == 1:
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
      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':
957
                continue
958 959 960 961 962 963 964 965 966 967 968 969
            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)
970 971 972 973
          for prop in obj.propertyIds():
            if prop not in ('id', 'uid'):
              try:
                prop_value = obj.getProperty(prop, evaluate=0)
974
              except TypeError: # the getter doesn't support evaluate=
975 976
                prop_value = obj.getProperty(prop)
              category.setProperty(prop, prop_value)
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
          # 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)
992
    else:
993
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
994 995 996 997
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      if light_install==0:
998
        ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
999
      else:
1000
        for relative_url in self._archive.keys():
1001
          obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
1002
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
1003
          obj = obj.__of__(category_tool)
Aurel's avatar
Aurel committed
1004 1005 1006 1007 1008
          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
1009 1010
            # XXX call backup here
            subobjects_dict = self._backupObject('backup', trashbin, container_path, category_id)
1011
            container.manage_delObjects([category_id])
1012
          category = container.newContent(portal_type=obj.getPortalType(), id=category_id)
1013 1014 1015 1016
          for prop in obj.propertyIds():
            if prop not in ('id', 'uid'):
              try:
                prop_value = obj.getProperty(prop, evaluate=0)
1017
              except TypeError: # the getter doesn't support evaluate=
1018 1019
                prop_value = obj.getProperty(prop)
              category.setProperty(prop, prop_value)
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
          # 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)

1036

1037 1038
class SkinTemplateItem(ObjectTemplateItem):

1039 1040
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1041

1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
  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

1057
  def install(self, context, trashbin, **kw):
1058
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1059 1060
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1061 1062 1063
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1064
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1065 1066
        fixZSQLMethod(p, obj)

1067 1068 1069 1070 1071 1072
    # 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
1073
        if context.getTemplateFormatVersion() == 1:
1074 1075
          if update_dict.has_key(relative_url) or force:
            if not force:
1076
              if update_dict[relative_url] == 'nothing':
1077
                continue
1078
          obj = self._objects[relative_url]
1079
        else:
1080
          obj = self._archive[relative_url]
1081
        skin_id = relative_url.split('/')[-1]
1082
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
        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)
1096 1097 1098

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
1099 1100 1101 1102
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1103
      object_keys = self._archive.keys()
1104
    ps = context.portal_skins
1105
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
1106 1107 1108 1109 1110 1111 1112
    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)
1113
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
1114
    context.getPortalObject().changeSkin(None)
1115 1116 1117
    ObjectTemplateItem.uninstall(self, context, **kw)


1118
class WorkflowTemplateItem(ObjectTemplateItem):
1119

1120 1121
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1122

1123
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1124 1125
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1126 1127 1128
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
1129
        if installed_bt._objects.has_key(path):
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
          # 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']})
1146 1147 1148 1149 1150 1151 1152 1153
      # 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
1154
    if context.getTemplateFormatVersion() == 1:
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
      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:
1169
            action = 'backup'
1170 1171 1172 1173 1174 1175
          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
1176
            container_url = '/'.join(container_path)
1177 1178 1179 1180 1181 1182
            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
1183
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1184
            container.manage_delObjects([object_id])
1185
          obj = self._objects[path]
1186 1187 1188
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
1189 1190 1191 1192 1193
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1194 1195 1196 1197
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


1198 1199
class PortalTypeTemplateItem(ObjectTemplateItem):

1200 1201
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1202 1203
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1204 1205 1206
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1207 1208
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1209 1210
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1211 1212 1213
      # remove actions and properties
      action_len = len(obj.listActions())
      obj.deleteActions(selections=range(action_len))
1214
      obj = self.removeProperties(obj)
1215 1216 1217 1218 1219 1220 1221 1222 1223
      # 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
1224 1225
      if hasattr(obj, '_roles'):
        setattr(obj, '_roles', [])
1226 1227
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1228

1229 1230
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1231 1232 1233 1234
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1235 1236
    # We now need to setup the list of workflows corresponding to
    # each portal type
1237
    (default_chain, chain_dict) = getChainByType(context)
1238
    # Set the default chain to the empty string is probably the
1239
    # best solution, by default it is 'default_workflow', which is
1240
    # not very usefull
1241
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1242
    if context.getTemplateFormatVersion() == 1:
1243
      object_list = self._objects
1244
    else:
1245 1246
      object_list = self._archive
    for path in object_list.keys():
1247 1248 1249 1250
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1251
            continue
1252 1253
        obj = object_list[path]
        portal_type = obj.id
1254 1255 1256
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1257 1258
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1259

1260 1261
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1262 1263 1264 1265 1266 1267 1268
  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:
1269
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1270 1271 1272 1273 1274
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1275
        dict[str(ptype)] = str(workflow)
1276 1277 1278 1279
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1280
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1281 1282

  def build(self, context, **kw):
1283 1284 1285 1286 1287
    # 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
1288
    p = context.getPortalObject()
1289
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1290
    for key in self._archive.keys():
1291 1292 1293
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1294
        workflow = wflist[1]
1295
      else:
1296
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1297
        portal_type = wflist[0][:-2]
1298 1299
        workflow = ''
      if chain_dict.has_key('chain_%s' % portal_type):
1300 1301 1302 1303
        if workflow[0] in ['+', '-', '=']:
          workflow_name = workflow[1:]
        else:
          workflow_name = workflow
1304
        if workflow[0] != '-' and \
1305
            workflow_name not in chain_dict['chain_%s' % portal_type]:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1306
          raise NotFound, 'workflow %s not found in chain for portal_type %s'\
1307
                % (workflow, portal_type)
1308
        if self._objects.has_key(portal_type):
1309 1310
          # other workflow id already defined for this portal type
          self._objects[portal_type].append(workflow)
1311
        else:
1312
          self._objects[portal_type] = [workflow,]
1313
      else:
Aurel's avatar
Aurel committed
1314
        LOG('BusinessTemplate build', 100, 'portal type %s not found in workflow chain' %(portal_type))
1315

Christophe Dumez's avatar
Christophe Dumez committed
1316
  # Function to generate XML Code Manually
1317 1318 1319 1320 1321
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
1322
      workflow_list = self._objects[key]
1323 1324 1325
      # XXX Not always a list
      if isinstance(workflow_list, str):
        workflow_list = [workflow_list]
1326 1327
      xml_data += os.linesep+' <chain>'
      xml_data += os.linesep+'  <type>%s</type>' %(key,)
1328
      xml_data += os.linesep+'  <workflow>%s</workflow>' %(', '.join(workflow_list))
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
      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
1347
    (default_chain, chain_dict) = getChainByType(context)
1348
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
1349
    # best solution, by default it is 'default_workflow', which is
1350 1351 1352 1353 1354 1355 1356
    # 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':
1357
            continue
Jérome Perrin's avatar
Jérome Perrin committed
1358 1359 1360 1361
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
        if len(path_splitted) < 2:
          continue
1362
        portal_type = path_splitted[1]
1363
        if chain_dict.has_key('chain_%s' % portal_type):
Aurel's avatar
Aurel committed
1364 1365 1366
          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 != '':
1367
            old_chain_workflow_id_set = {}
1368
            # get existent workflow id list
1369 1370
            for wf_id in old_chain_dict.split(', '):
              old_chain_workflow_id_set[wf_id] = 1
1371
            # get new workflow id list
1372
            for wf_id in self._objects[path].split(', '):
1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
              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
1387 1388
            chain_dict['chain_%s' % portal_type] = ', '.join(
                                              old_chain_workflow_id_set.keys())
Aurel's avatar
Aurel committed
1389
          else:
1390
            chain_dict['chain_%s' % portal_type] = self._objects[path]
Aurel's avatar
Aurel committed
1391 1392
        else:
          chain_dict['chain_%s' % portal_type] = self._objects[path]
1393 1394
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1395 1396
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
1397 1398 1399 1400 1401 1402
    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:
1403 1404 1405 1406 1407 1408 1409 1410
      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)
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423

  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
1424 1425
      if 'portal_type_workflow_chain/' not in str(ptype):
        ptype = 'portal_type_workflow_chain/' + str(ptype)
1426 1427 1428
      dict[str(ptype)] = str(workflow)
    self._objects = dict

1429 1430
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
1431

1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
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
1447
  # Function to generate XML Code Manually
1448
  def generateXml(self, path=None):
1449
    dictio = self._objects
1450
    xml_data = '<%s>' %(self.xml_tag,)
1451
    keys = dictio.keys()
1452 1453
    keys.sort()
    for key in keys:
1454
      allowed_list = dictio[key]
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
      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)

1471 1472 1473 1474 1475 1476
  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':
1477
        #must rename keys in dict if reinstall
1478 1479 1480 1481 1482 1483 1484 1485 1486
        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]
1487
          old_object = installed_bt._objects[path]
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
          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

1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
  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)
1526
        except AttributeError:
1527 1528 1529 1530 1531 1532 1533 1534
          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:
1535 1536
            if id not in property_list:
              property_list.append(id)
1537 1538
        setattr(portal_type, self.class_property, list(property_list))

Aurel's avatar
Aurel committed
1539
  def uninstall(self, context, **kw):
1540
    object_path = kw.get('object_path', None)
1541
    p = context.getPortalObject()
1542
    pt = p.unrestrictedTraverse('portal_types')
1543 1544 1545 1546 1547 1548 1549 1550
    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)
1551
      except AttributeError:
1552 1553 1554
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
1555 1556
      original_property_list = list(getattr(portal_type,
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
1557 1558
      for id in property_list:
        if id in original_property_list:
1559
          original_property_list.remove(id)
1560
      setattr(portal_type, self.class_property, list(original_property_list))
1561

1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
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'

1577
class CatalogMethodTemplateItem(ObjectTemplateItem):
1578
  """Template Item for catalog methods.
1579

1580 1581 1582 1583 1584
    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.
  """
1585

1586 1587
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1588
    # a mapping to store properties of methods.
1589 1590 1591 1592 1593
    # 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()
1594

1595 1596 1597 1598 1599
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
  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

1614 1615
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1616

1617 1618
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1619 1620
    except KeyError:
      catalog = None
1621
    if catalog is None:
1622
      LOG('BusinessTemplate build', 0, 'catalog not found')
1623
      return
1624

1625 1626 1627
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
1628

1629 1630
    for obj in self._objects.values():
      method_id = obj.id
1631 1632
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
1633
      self._is_filtered_archive[method_id] = 0
1634
      if catalog.filter_dict.has_key(method_id):
1635 1636 1637 1638 1639 1640 1641 1642 1643
        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']
1644

Aurel's avatar
Aurel committed
1645
  def export(self, context, bta, **kw):
1646 1647 1648 1649 1650 1651 1652 1653
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

Aurel's avatar
Aurel committed
1654 1655 1656 1657
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
1658
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1659 1660 1661 1662 1663 1664
      # 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()
1665 1666
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1667 1668
      # add all datas specific to catalog inside one file
      catalog = context.portal_catalog.getSQLCatalog()
1669
      method_id = obj.id
1670 1671
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1672
      f = open(object_path, 'wt')
1673
      xml_data = '<catalog_method>'
1674

1675 1676 1677
      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,)
1678
        xml_data += os.linesep+' </item>'
1679

Aurel's avatar
Aurel committed
1680
      if catalog.filter_dict.has_key(method_id):
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
        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>'
1697
      xml_data += os.linesep+'</catalog_method>'
1698
      f.write(xml_data)
Aurel's avatar
Aurel committed
1699
      f.close()
1700

Christophe Dumez's avatar
Christophe Dumez committed
1701 1702 1703 1704 1705 1706 1707 1708 1709
  # 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
1710

1711 1712
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1713 1714
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1715
    except KeyError:
1716 1717 1718 1719 1720 1721 1722 1723
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    # Make copies of attributes of the default catalog of portal_catalog.
    sql_catalog_object_list = list(catalog.sql_catalog_object_list)
    sql_uncatalog_object = list(catalog.sql_uncatalog_object)
    sql_clear_catalog = list(catalog.sql_clear_catalog)
1724

1725 1726 1727
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1728
    new_bt_format = context.getTemplateFormatVersion()
1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744

    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':
1745
              continue
1746 1747 1748 1749
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
1750

1751 1752
    for obj in values:
      method_id = obj.id
1753

1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764
      # 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))
1765

1766 1767
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
1768
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1769
        if context.getTemplateFormatVersion() == 1:
1770 1771 1772
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1773
        filter_type = self._filter_type_archive[method_id]
1774 1775 1776
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1777
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1778
        catalog.filter_dict[method_id]['type'] = filter_type
1779
      elif method_id in catalog.filter_dict.keys():
1780
        catalog.filter_dict[method_id]['filtered'] = 0
1781

1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807
      # 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)
1808

1809 1810 1811 1812 1813 1814
        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)
1815

1816
  def uninstall(self, context, **kw):
1817 1818
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1819
    except KeyError:
1820 1821 1822 1823
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1824

1825 1826 1827 1828
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
1829 1830 1831 1832
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
1833 1834 1835 1836
    else:
      value = self._archive[object_path]
      if value is not None:
        values.append(value)
1837

1838
    for obj in values:
1839
      method_id = obj.id
1840 1841 1842 1843 1844 1845 1846 1847 1848
      # 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)
1849

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1850
      if catalog.filter_dict.has_key(method_id):
1851
        del catalog.filter_dict[method_id]
1852

1853
    # uninstall objects
1854
    ObjectTemplateItem.uninstall(self, context, **kw)
1855

1856
  def _importFile(self, file_name, file):
1857
    if not '.catalog_keys' in file_name:
1858 1859 1860 1861 1862 1863 1864 1865
      # 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
1866
    else:
1867 1868 1869 1870
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1871
      method_list = xml.getElementsByTagName('item')
1872
      for method in method_list:
1873
        key = method.getAttribute('key')
1874 1875
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1876 1877 1878 1879
          if len(method.getElementsByTagName('value')[0].childNodes):
            value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          else:
            value = ''
1880
          key = str(key)
1881
        elif key_type == "int":
1882
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1883
          key = str(key)
1884
        elif key_type == "tuple":
1885 1886 1887 1888
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1889
        else:
1890
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1891
          continue
1892
        if key in catalog_method_list or key in catalog_method_filter_list:
1893
          dict = getattr(self, key, {})
1894
          dict[id] = value
1895 1896 1897
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
1898

1899
class ActionTemplateItem(ObjectTemplateItem):
1900 1901

  def __init__(self, id_list, **kw):
1902
    # XXX It's look like ObjectTemplateItem __init__
1903 1904 1905 1906 1907 1908
    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

1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929
  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

1930 1931 1932 1933
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1934
      relative_url, value = id.split(' | ')
1935 1936
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1937
        if getattr(ai, 'id') == value:
1938
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1939
          key = os.path.join(url[-2], url[-1], value)
1940
          action = ai._getCopy(context)
1941
          action = self.removeProperties(action)
1942
          self._objects[key] = action
Aurel's avatar
Aurel committed
1943
          self._objects[key].wl_clearLocks()
1944 1945
          break
      else:
1946
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1947

1948 1949 1950
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1951
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1952 1953
      p = context.getPortalObject()
      for id in self._objects.keys():
1954 1955 1956 1957 1958 1959
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
1960 1961
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
1962
          for index in range(len(action_list)):
1963
            if getattr(action_list[index], 'id') == path[-1]:
1964
              # remove previous action
1965
              obj.deleteActions(selections=(index,))
1966
          action = self._objects[id]
1967 1968 1969
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
1970
          obj.addAction(
1971 1972
                        id = action.id
                      , name = action.title
1973
                      , action = action_text
1974 1975 1976 1977
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
1978 1979
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
1980
                      , priority = action.priority
Aurel's avatar
Aurel committed
1981
                    )
1982
          # sort action based on the priority define on it
1983 1984 1985 1986 1987 1988 1989 1990 1991
          # 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
1992
    else:
1993
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1994
      p = context.getPortalObject()
1995 1996
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
1997
        relative_url, key, value = self._splitPath(id)
1998 1999
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2000
          if getattr(ai, key) == value:
2001
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2002 2003 2004
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2005
        obj.addAction(
Aurel's avatar
Aurel committed
2006 2007
                      id = action.id
                    , name = action.title
2008
                    , action = action_text
Aurel's avatar
Aurel committed
2009 2010 2011 2012
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2013 2014
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2015
                    )
Aurel's avatar
Aurel committed
2016 2017 2018 2019 2020 2021 2022
        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))
2023 2024
          obj.moveDownActions(selections=tuple(move_down_list))

2025 2026
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2027 2028 2029 2030
    object_path = kw.get("object_path", None)
    if object_path is not None:
      keys = [object_path]
    else:
2031
      keys = self._archive.keys()
2032
    for id in keys:
2033 2034 2035 2036
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047
        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 )
2048 2049
    BaseTemplateItem.uninstall(self, context, **kw)

2050 2051 2052
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2053
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065
    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
2066
        for property in ('id', 'title', 'description',
2067 2068 2069 2070
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
2071 2072 2073 2074
        # condition
        prop_value = getattr(role, 'condition')
        if prop_value:
          type_role_dict['condition'] = prop_value.text
2075 2076 2077 2078 2079 2080 2081 2082 2083
        # 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
2084
  # Function to generate XML Code Manually
2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098
  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'):
2099
        for prop_value in role.get(property, []):
2100 2101 2102 2103 2104
          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
2105

2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118
  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)
2119
    xml_type_roles_list = xml.getElementsByTagName('role')
2120 2121 2122 2123 2124 2125 2126 2127
    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():
2128
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2129 2130 2131 2132 2133 2134 2135 2136 2137 2138
          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():
2139
          property_value = property.childNodes[0].data.encode('utf_8', 'backslashreplace')
2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154
          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]
2155 2156 2157 2158 2159 2160
      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))
2161 2162 2163 2164 2165 2166 2167 2168

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

2169 2170 2171 2172 2173 2174
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2175 2176
      for property in p.propertyMap():
        if property['id'] == id:
2177
          obj = p.getProperty(id)
2178
          prop_type = property['type']
2179 2180
          break
      else:
2181 2182
        obj = None
      if obj is None:
2183
        raise NotFound, 'the property %s is not found' % id
2184
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
2185

2186 2187 2188 2189 2190 2191
  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
2192 2193
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
2194 2195 2196 2197 2198 2199 2200
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
2201
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
2202
      self._objects[str(id)] = (str(prop_type), value)
2203

2204 2205 2206
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2207
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2208 2209
      p = context.getPortalObject()
      for path in self._objects.keys():
2210 2211 2212 2213
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
2214
              continue
2215 2216 2217
          dir, id = os.path.split(path)
          if p.hasProperty(id):
            continue
2218 2219
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
2220
    else:
2221
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2222
      p = context.getPortalObject()
2223 2224
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
2225 2226 2227 2228 2229
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
2230 2231 2232

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2233 2234 2235 2236 2237 2238
    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:
2239 2240 2241 2242
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2243
  # Function to generate XML Code Manually
2244
  def generateXml(self, path=None):
2245
    xml_data = ''
2246
    prop_type, obj = self._objects[path]
2247 2248
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
2249 2250
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
2251
      xml_data += os.linesep+'  <value>'
2252
      for item in obj:
2253 2254 2255 2256
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
2257
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
2258
    xml_data += os.linesep+' </property>'
2259 2260
    return xml_data

Aurel's avatar
Aurel committed
2261 2262 2263 2264 2265
  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)
2266 2267 2268 2269
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
2270
      xml_data += self.generateXml(path)
2271
    xml_data += os.linesep+'</site_property>'
2272
    bta.addObject(obj=xml_data, name='properties', path=root_path)
2273

2274 2275 2276 2277 2278 2279 2280
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)
2281 2282 2283 2284 2285 2286 2287 2288
      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
2289

Christophe Dumez's avatar
Christophe Dumez committed
2290
  # Function to generate XML Code Manually
2291
  def generateXml(self, path=None):
2292 2293
    dict = self._objects[path]
    xml_data = '<module>'
2294 2295 2296 2297
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
2298 2299 2300 2301 2302
      if key =='permission_list':
        # separe permission dict into xml
        xml_data += os.linesep+' <%s>' %(key,)
        permission_list = dict[key]
        for perm in permission_list:
2303 2304 2305 2306 2307 2308
          # 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,)
2309
          xml_data += os.linesep+'   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
2310
          role_list = list(perm[1])
2311
          role_list.sort()
2312 2313 2314 2315 2316 2317 2318 2319 2320
          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

2321 2322 2323 2324 2325
  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)
2326 2327 2328
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
2329
      # expor module one by one
2330
      xml_data = self.generateXml(path=id)
2331
      bta.addObject(obj=xml_data, name=id, path=path)
2332

2333
  def install(self, context, trashbin, **kw):
2334
    portal = context.getPortalObject()
2335 2336
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2337
    if context.getTemplateFormatVersion() == 1:
2338
      items = self._objects
2339
    else:
2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351
      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)
2352
          module.portal_type = str(mapping['portal_type'])
2353 2354 2355 2356 2357 2358 2359 2360 2361 2362
        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
2363 2364 2365 2366 2367 2368 2369 2370 2371 2372

  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:
2373
          perm_type = perm.getAttribute('type').encode() or None
2374 2375 2376 2377 2378 2379 2380 2381 2382
          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))
2383 2384 2385 2386
          if perm_type == "list" or perm_type is None:
            perm_tuple = (str(name), list(rlist))
          else:
            perm_tuple = (str(name), tuple(rlist))
2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397
          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

2398
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
2399 2400 2401
    trash = kw.get('trash', 0)
    if trash:
      return
2402 2403 2404 2405 2406 2407
    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]
2408 2409
    p = context.getPortalObject()
    id_list = p.objectIds()
2410
    for id in keys:
2411
      if id in id_list:
2412
        try:
2413
          if trash and trashbin is not None:
2414 2415
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
2416
          p.manage_delObjects([id])
2417
        except NotFound:
2418
          pass
2419 2420
    BaseTemplateItem.uninstall(self, context, **kw)

2421 2422 2423
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
2424 2425

class DocumentTemplateItem(BaseTemplateItem):
2426 2427 2428 2429
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
2430 2431 2432 2433

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

2436
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2437 2438
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
      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
2459
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2460
      for id in self._objects.keys():
2461 2462 2463 2464 2465 2466 2467 2468 2469
        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:
2470
            globals()[self.local_file_writer_name](name, text, create=0)
2471
          except IOError, error:
2472
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
2473 2474
            if error.errno :
              raise
2475 2476 2477
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
2478
    else:
2479 2480 2481
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
2482
        # This raises an exception if the file exists.
2483
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
2484 2485
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
2486 2487

  def uninstall(self, context, **kw):
2488
    object_path = kw.get('object_path', None)
2489 2490 2491 2492 2493
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
2494
      globals()[self.local_file_remover_name](id)
2495 2496
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
2497 2498 2499 2500 2501 2502
  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():
2503 2504
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
2505

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

2510 2511 2512 2513 2514 2515
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

2516 2517 2518 2519 2520
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
2521

2522 2523 2524
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
2525 2526
  # Extension needs no import
  local_file_importer_name = None
2527 2528 2529 2530 2531
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
2532
  # Test needs no import
2533 2534 2535
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
2536

2537 2538 2539
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
2540 2541 2542

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2543 2544 2545 2546
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2547 2548
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
2549

2550
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2551 2552
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2553
      new_roles = self._objects.keys()
2554 2555 2556
      if installed_bt.id == 'installed_bt_for_diff':
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
2557 2558 2559
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
2560 2561
        for key in old_keys:
          new_dict[key] = ''
2562
        installed_bt._objects = new_dict
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575
      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):
2576
    p = context.getPortalObject()
2577
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2578
    if context.getTemplateFormatVersion() == 1:
2579
      role_list = self._objects.keys()
2580
    else:
2581
      role_list = self._archive.keys()
2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593
    # 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
2594
    for role in role_list:
2595 2596 2597 2598 2599 2600 2601 2602 2603 2604
      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
2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616

  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)

2617 2618 2619 2620 2621 2622 2623 2624 2625
  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
2626
      if role in roles and role not in new_roles:
2627 2628 2629
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
2630
  # Function to generate XML Code Manually
2631
  def generateXml(self, path):
2632
    obj = self._objects[path]
2633
    xml_data = '<role_list>'
2634 2635
    obj.sort()
    for role in obj:
2636 2637 2638 2639
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

Aurel's avatar
Aurel committed
2640 2641 2642 2643 2644 2645
  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():
2646
      xml_data = self.generateXml(path=path)
2647
      bta.addObject(obj=xml_data, name=path, path=None,)
2648

2649 2650
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2651
  def build(self, context, **kw):
2652 2653
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2654
    except KeyError:
2655 2656 2657 2658
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2659
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2660
    key_list = []
2661
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2662
      if key in sql_search_result_keys:
2663
        key_list.append(key)
Aurel's avatar
Aurel committed
2664 2665
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2666
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2667
      self._objects[self.__class__.__name__+os.sep+'result_key_list'] = key_list
2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678

  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

2679
  def install(self, context, trashbin, **kw):
2680 2681 2682 2683 2684 2685 2686
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2687

2688
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2689
    if context.getTemplateFormatVersion() == 1:
2690 2691
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
2692 2693 2694
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2695
    else:
2696
      keys = self._archive.keys()
2697 2698
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2699
    # XXX same as related key
Aurel's avatar
Aurel committed
2700
    if update_dict.has_key('result_key_list') or force:
2701
      if not force:
Aurel's avatar
Aurel committed
2702
        action = update_dict['result_key_list']
2703
        if action == 'nothing':
Aurel's avatar
Aurel committed
2704
          return
2705
      for key in keys:
2706 2707
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
2708
      catalog.sql_search_result_keys = sql_search_result_keys
2709

2710
  def uninstall(self, context, **kw):
2711 2712
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2713
    except KeyError:
2714 2715 2716 2717 2718
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2719
    object_path = kw.get('object_path', None)
2720 2721 2722 2723 2724
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2725 2726
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2727
    catalog.sql_search_result_keys = sql_search_result_keys
2728 2729
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2730
  # Function to generate XML Code Manually
2731
  def generateXml(self, path=None):
2732
    obj = self._objects[path]
2733
    xml_data = '<key_list>'
2734 2735
    obj.sort()
    for key in obj:
2736 2737 2738 2739
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2740 2741 2742 2743 2744
  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)
2745
    for path in self._objects.keys():
2746
      xml_data = self.generateXml(path=path)
2747
      bta.addObject(obj=xml_data, name=path, path=None)
2748

2749 2750
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2751
  def build(self, context, **kw):
2752 2753
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2754
    except KeyError:
2755 2756 2757 2758
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2759
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2760
    key_list = []
2761
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2762
      if key in sql_search_related_keys:
2763
        key_list.append(key)
Aurel's avatar
Aurel committed
2764 2765
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2766
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2767
      self._objects[self.__class__.__name__+os.sep+'related_key_list'] = key_list
2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778

  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

2779
  def install(self, context, trashbin, **kw):
2780 2781 2782 2783 2784 2785 2786
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2787

2788
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2789
    if context.getTemplateFormatVersion() == 1:
2790
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2791
        return
2792 2793 2794
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2795
    else:
2796
      keys = self._archive.keys()
2797 2798
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
2799
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
2800
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
2801
      if not force:
Aurel's avatar
Aurel committed
2802 2803 2804 2805
        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
2806 2807 2808
        if action == 'nothing':
          return
      for key in keys:
2809 2810
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
2811
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
2812

2813 2814 2815
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2816
    except KeyError:
2817 2818 2819 2820
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2821
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2822
    object_path = kw.get('object_path', None)
2823 2824 2825 2826 2827
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2828 2829 2830 2831 2832
      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
2833
  # Function to generate XML Code Manually
2834
  def generateXml(self, path=None):
2835
    obj = self._objects[path]
2836
    xml_data = '<key_list>'
2837 2838
    obj.sort()
    for key in obj:
2839 2840 2841 2842
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2843 2844 2845 2846 2847 2848
  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():
2849
      xml_data = self.generateXml(path=path)
2850
      bta.addObject(obj=xml_data, name=path, path=None)
2851

2852 2853
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2854
  def build(self, context, **kw):
2855 2856
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2857
    except KeyError:
2858 2859 2860 2861
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2862
    sql_search_result_tables = list(catalog.sql_search_tables)
2863
    key_list = []
2864
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2865
      if key in sql_search_result_tables:
2866
        key_list.append(key)
Aurel's avatar
Aurel committed
2867 2868
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2869
    if len(key_list) > 0:
2870
      self._objects[self.__class__.__name__+os.sep+'result_table_list'] = key_list
2871 2872 2873 2874 2875 2876 2877 2878 2879 2880

  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
2881

2882
  def install(self, context, trashbin, **kw):
2883 2884 2885 2886 2887 2888 2889
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2890

2891
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2892
    if context.getTemplateFormatVersion() == 1:
2893
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2894
        return
2895 2896 2897
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2898
    else:
2899
      keys = self._archive.keys()
2900 2901
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2902
    # XXX same as related keys
Aurel's avatar
Aurel committed
2903
    if update_dict.has_key('result_table_list') or force:
2904
      if not force:
Aurel's avatar
Aurel committed
2905
        action = update_dict['result_table_list']
2906
        if action == 'nothing':
Aurel's avatar
Aurel committed
2907
          return
2908
      for key in keys:
2909 2910
        if key not in sql_search_tables:
          sql_search_tables.append(key)
2911
      catalog.sql_search_tables = tuple(sql_search_tables)
2912 2913

  def uninstall(self, context, **kw):
2914 2915
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2916
    except KeyError:
2917 2918 2919 2920 2921
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2922
    object_path = kw.get('object_path', None)
2923 2924 2925 2926 2927
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2928 2929
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2930
    catalog.sql_search_tables = sql_search_tables
2931 2932
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
2933
  # Function to generate XML Code Manually
2934
  def generateXml(self, path=None):
2935
    obj = self._objects[path]
2936
    xml_data = '<key_list>'
2937 2938
    obj.sort()
    for key in obj:
2939
      xml_data += os.linesep+' <key>%s</key>' %(key)
2940
    xml_data += os.linesep+'</key_list>'
2941 2942
    return xml_data

Aurel's avatar
Aurel committed
2943 2944 2945 2946 2947 2948
  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():
2949
      xml_data = self.generateXml(path=path)
2950
      bta.addObject(obj=xml_data, name=path, path=None)
2951

2952 2953
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
2954 2955

  def build(self, context, **kw):
2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_keyword_keys:
        key_list.append(key)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'keyword_key_list'] = key_list
Aurel's avatar
Aurel committed
2972

2973 2974 2975 2976 2977 2978 2979 2980 2981
  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
2982 2983

  def install(self, context, trashbin, **kw):
2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
3001 3002
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022
    # XXX same as related key
    if update_dict.has_key('keyword_key_list') or force:
      if not force:
        action = update_dict['keyword_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_keyword_keys:
          sql_keyword_keys.append(key)
      catalog.sql_catalog_keyword_search_keys = sql_keyword_keys

  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
3023
    object_path = kw.get('object_path', None)
3024 3025
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
3026
    else:
3027 3028 3029 3030 3031 3032 3033
      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
3034
  # Function to generate XML Code Manually
3035 3036 3037 3038 3039 3040 3041 3042
  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
3043 3044 3045 3046

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
3047 3048 3049 3050 3051
    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)
3052

3053 3054
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
3055

3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072
  def build(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_full_text_keys = list(catalog.sql_catalog_full_text_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_full_text_keys:
        key_list.append(key)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'ful_text_key_list'] = key_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3073

3074 3075 3076 3077 3078 3079 3080 3081 3082
  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
3083

3084 3085 3086 3087 3088 3089 3090 3091
  def install(self, context, trashbin, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3092

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

3115 3116 3117 3118 3119 3120 3121 3122 3123
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_full_text_keys = list(catalog.sql_catalog_full_text_search_keys)
3124
    object_path = kw.get('object_path', None)
3125 3126 3127 3128 3129 3130 3131 3132 3133 3134
    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
3135
  # Function to generate XML Code Manually
3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)


# request
class CatalogRequestKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_request_keys = list(catalog.sql_catalog_request_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_request_keys:
        key_list.append(key)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'request_key_list'] = key_list

  def _importFile(self, file_name, file):
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX must a find a better way to manage related key
    if update_dict.has_key('request_key_list') or force:
      if not force:
        action = update_dict['request_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_request_keys:
          sql_catalog_request_keys.append(key)
      catalog.sql_catalog_request_keys = tuple(sql_catalog_request_keys)

  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
3226
    object_path = kw.get('object_path', None)
3227 3228 3229 3230 3231 3232 3233 3234 3235 3236
    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
3237
  # Function to generate XML Code Manually
3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)

# multivalue
class CatalogMultivalueKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_multivalue_keys:
        key_list.append(key)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'multivalue_key_list'] = key_list

  def _importFile(self, file_name, file):
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    if update_dict.has_key('multivalue_key_list') or force:
      if not force:
        action = update_dict['multivalue_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_multivalue_keys:
          sql_catalog_multivalue_keys.append(key)
      catalog.sql_catalog_multivalue_keys = tuple(sql_catalog_multivalue_keys)

  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
3326
    object_path = kw.get('object_path', None)
3327 3328 3329 3330 3331 3332 3333 3334 3335 3336
    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
3337
  # Function to generate XML Code Manually
3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426
  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
    for path in self._objects.keys():
      xml_data = self.generateXml(path=path)
      bta.addObject(obj=xml_data, name=path, path=None)

# topic
class CatalogTopicKeyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
    key_list = []
    for key in self._archive.keys():
      if key in sql_catalog_topic_search_keys:
        key_list.append(key)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'topic_key_list'] = key_list

  def _importFile(self, file_name, file):
    list = []
    xml = parse(file)
    key_list = xml.getElementsByTagName('key')
    for key in key_list:
      node = key.childNodes[0]
      value = node.data
      list.append(str(value))
    self._objects[file_name[:-4]] = list

  def install(self, context, trashbin, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
    if context.getTemplateFormatVersion() == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
    else:
      keys = self._archive.keys()
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # XXX same as related key
    if update_dict.has_key('topic_key_list') or force:
      if not force:
        action = update_dict['topic_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_catalog_topic_search_keys:
          sql_catalog_topic_search_keys.append(key)
      catalog.sql_catalog_topic_search_keys = sql_catalog_topic_search_keys

  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
3427
    object_path = kw.get('object_path', None)
3428 3429 3430 3431 3432 3433 3434 3435 3436 3437
    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
3438
  # Function to generate XML Code Manually
3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460
  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
3461 3462 3463 3464 3465 3466 3467 3468 3469
    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)
3470 3471 3472 3473 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

  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':
3501
              continue
3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530
          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
3531
      f = open(path+os.sep+'translation.po', 'wt')
3532 3533 3534 3535 3536 3537 3538
      f.write(str(obj))
      f.close()

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

Aurel's avatar
Aurel committed
3539 3540
class LocalRolesTemplateItem(BaseTemplateItem):

3541
  def __init__(self, id_list, **kw):
3542
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
3543 3544
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
3545 3546 3547
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
3548
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
3549 3550 3551 3552
      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
3553 3554
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

Christophe Dumez's avatar
Christophe Dumez committed
3555
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582
  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
3583

Aurel's avatar
Aurel committed
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593
  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 = []
3594
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
3595 3596 3597 3598
        if '%' not in folder:
          encode_folders.append(pathname2url(folder))
        else:
          encode_folders.append(folder)
3599
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
3600 3601 3602 3603 3604 3605 3606
      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]
3607
    local_roles_list = local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3608 3609 3610 3611 3612 3613 3614 3615 3616 3617
    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]
3618
    local_roles_list = group_local_roles.getElementsByTagName('role')
Aurel's avatar
Aurel committed
3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651
    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__', {})
3652

3653 3654 3655
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
3656
    in part or completely. Each object is separated from its
3657 3658 3659 3660 3661 3662 3663 3664 3665 3666
    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
3667 3668
      - object without optimal actions
      - list of relation between portal type and workflow
3669 3670 3671 3672 3673 3674 3675 3676 3677 3678

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

    - site property definition
      - id
      - type
3679
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3680

3681 3682
    - document/propertysheet/extension/test definition
      - copy of the local file
3683

3684
    - message transalation definition
3685
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3686

3687 3688
    The Business Template properties are exported to the bt folder with
    one property per file
3689

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3690 3691
    Technology:

3692 3693
    - 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
3694

3695
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3696 3697 3698 3699

    Use case:

    - install core ERP5 (the minimum)
3700

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

3703 3704
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
3705
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3706 3707 3708 3709 3710
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
3711
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3712 3713 3714 3715 3716
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
3717
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3718 3719 3720 3721 3722 3723 3724

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
3725
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3726
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3727
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3728 3729 3730
                      , PropertySheet.BusinessTemplate
                      )

3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747
    # 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
      }

3748 3749
    # This is a global variable
    # Order is important for installation
3750 3751 3752 3753 3754 3755
    # 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 )
3756 3757 3758
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
3759
      '_constraint_item',
3760 3761 3762 3763 3764 3765 3766 3767
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
3768
      '_portal_type_workflow_chain_item',
3769 3770 3771 3772
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
3773 3774
      '_category_item',
      '_module_item',
3775
      '_path_item',
3776
      '_skin_item',
3777
      '_preference_item',
3778
      '_action_item',
3779
      '_portal_type_roles_item',
3780
      '_local_roles_item',
3781
      '_catalog_method_item',
3782 3783 3784
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
3785 3786 3787 3788 3789
      '_catalog_keyword_key_item',
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
3790 3791 3792 3793
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3794 3795 3796 3797 3798 3799
      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
3800
        self._baseGetTemplateFormatVersion()
3801

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3802 3803 3804
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
3805

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3806
      return 0
3807

3808
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
3809 3810 3811 3812 3813 3814 3815
    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".
3816 3817
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
3818
          # XXX Not good to access the attribute directly,
3819 3820 3821
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
3822

3823 3824
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
3825 3826 3827 3828 3829 3830
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

3831
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
3832 3833 3834 3835 3836 3837 3838 3839
        """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)
3840

3841
    security.declareProtected(Permissions.ManagePortal, 'build')
3842
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3843 3844 3845
      """
        Copy existing portal objects to self
      """
3846
      if no_action: return
3847
        # this is use at import of Business Template to get the status built
3848 3849
      # Make sure that everything is sane.
      self.clean()
3850

3851 3852 3853
      # Update revision number
      # <christophe@nexedi.com>
      self.updateRevisionNumber()
3854

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3855 3856
      self._setTemplateFormatVersion(1)

3857
      # Store all data
3858 3859
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
3860
      self._portal_type_workflow_chain_item = \
3861
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
3862 3863 3864 3865 3866 3867 3868 3869 3870 3871
      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())
3872 3873
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
3874 3875 3876 3877 3878 3879 3880 3881
      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())
3882 3883
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903
      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())
3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915
      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())
3916 3917
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
3918 3919
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
3920 3921
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
3922
               self.getTemplateCatalogKeywordKeyList())
3923 3924
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
3925
               self.getTemplateCatalogFullTextKeyList())
3926 3927
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
3928
               self.getTemplateCatalogRequestKeyList())
3929 3930
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
3931
               self.getTemplateCatalogMultivalueKeyList())
3932 3933 3934
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
3935 3936 3937
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
3938

3939 3940 3941
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
3942

3943
    build = WorkflowMethod(build)
3944 3945

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3946
      """
3947
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3948
      """
3949
      return self.portal_templates.publish(self, url, username=username,
3950
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3951

3952
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3953
      """
3954
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3955
      """
3956
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3957

3958 3959 3960 3961
    def preinstall(self, **kw):
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
3962
      """
3963

3964 3965
      modified_object_list = {}
      bt_title = self.getTitle()
3966 3967 3968 3969 3970 3971 3972

      #  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)
3973 3974 3975
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3976
        installed_bt_format = installed_bt.getTemplateFormatVersion()
3977

3978
      # if reinstall business template, must compare to object in ZODB
3979
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
3980
      # same if we make a diff and select only one business template
3981
      reinstall = 0
3982 3983
      if installed_bt == self:
        reinstall = 1
3984 3985 3986
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
3987 3988 3989
        bt2.edit(description='tmp bt generated for diff')
        bt2.build()
        installed_bt = bt2
3990

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3991
      new_bt_format = self.getTemplateFormatVersion()
3992 3993 3994 3995 3996 3997
      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:
3998
          item = getattr(self, item_name, None)
3999 4000 4001 4002
          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
4003

4004 4005 4006 4007
      # 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:
4008
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4009
        old_item = getattr(installed_bt, item_name, None)
4010
        if new_item is not None:
4011
          if old_item is not None and hasattr(old_item, '_objects'):
4012 4013 4014 4015 4016 4017 4018 4019
            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:
4020
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4021

4022 4023
      return modified_object_list

4024
    def _install(self, force=1, object_to_update=None, **kw):
4025
      """
Christophe Dumez's avatar
Christophe Dumez committed
4026
        Install a new Business Template, if force, all will be upgraded or installed
4027 4028
        otherwise depends of dict object_to_update
      """
4029 4030 4031 4032
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4033

4034 4035
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
4036
      if installed_bt is not None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4037
        if installed_bt.getTemplateFormatVersion() == 0:
4038
          force = 1
4039
        installed_bt.replace(self)
4040

4041 4042 4043 4044
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4045 4046 4047
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4048

4049 4050 4051 4052 4053 4054
      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')
4055
        gen.setupLastTools(site, update=1, create_activities=1)
4056 4057
      if not force:
        if len(object_to_update) == 0:
4058 4059 4060 4061 4062
          # 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():
4063
            LOG('Business Template', 0, 'Updating Business Template Workflows')
4064
            gen.setupWorkflow(site)
4065
          return
4066 4067 4068 4069

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

4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084
      # 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)
4085

4086 4087 4088
      # update catalog if necessary
      update_catalog=0
      catalog_method = getattr(self, '_catalog_method_item', None)
4089
      if catalog_method is not None and self.getTemplateFormatVersion() == 1:
4090 4091 4092 4093 4094 4095 4096 4097 4098
        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
4099
              break
4100 4101
      if update_catalog:
        catalog = local_configuration.portal_catalog.getSQLCatalog()
4102
        if (catalog is None) or (not site.isIndexable):
4103 4104 4105 4106 4107
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4108

4109
      # get objects to remove
4110
      # do remove after because we may need backup object from installation
4111 4112 4113 4114 4115 4116 4117 4118 4119
      remove_object_dict = {}
      for path in object_to_update.keys():
        action = object_to_update[path]
        if action == 'remove' or action == 'save_and_remove':
          remove_object_dict[path] = action
          object_to_update.pop(path)
      # remove object from old business template
      if len(remove_object_dict) > 0:
        for item_name in installed_bt._item_name_list:
4120
          item = getattr(installed_bt, item_name, None)
4121 4122
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
4123

4124 4125 4126 4127 4128 4129

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

4130
      # check if we have to update business template workflow
4131
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4132
        LOG('Business Template', 0, 'Updating Business Template Workflows')
4133 4134 4135 4136 4137
        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)

4138 4139 4140 4141 4142
      # remove trashbin if empty
      if trashbin is not None:
        if len(trashbin.objectIds()) == 0:
          trash_tool.manage_delObjects([trashbin.getId(),])

4143 4144
      if update_catalog:
        site.ERP5Site_reindexAll()
4145

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4146 4147 4148
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
4149

4150
    security.declareProtected(Permissions.ManagePortal, 'install')
4151 4152 4153
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4154
      """
4155
      return self._install(**kw)
4156

4157
    install = WorkflowMethod(install)
4158

4159
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4160
    def reinstall(self, **kw):
4161 4162 4163 4164
      """Reinstall Business Template.
      """
      return self._install(**kw)

4165
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4166

4167
    security.declareProtected(Permissions.ManagePortal, 'trash')
4168 4169
    def trash(self, new_bt, **kw):
      """
4170
        Trash unnecessary items before upgrading to a new business
4171
        template.
4172
        This is similar to uninstall, but different in that this does
4173
        not remove all items.
4174 4175 4176 4177 4178
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4179 4180
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4181
        item = getattr(self, item_name, None)
4182 4183 4184 4185
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
4186

4187
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
4188
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4189
      """
4190
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4191
      """
4192 4193 4194 4195
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
4196 4197 4198
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4199
        item = getattr(self, item_name, None)
4200 4201
        if item is not None:
          item.uninstall(local_configuration)
4202
      # It is better to clear cache because the uninstallation of a
4203
      # template deletes many things from the portal.
4204
      clearCache()
4205

4206 4207
    uninstall = WorkflowMethod(uninstall)

4208
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4209
    def _clean(self):
4210
      """
4211
        Clean built information.
4212
      """
4213
      # First, remove obsolete attributes if present.
4214 4215 4216 4217
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4218
                    '_module_archive',
4219 4220 4221
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4222
                    '_property_sheet_archive'):
4223 4224 4225
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4226 4227
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4228

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

4231
    security.declareProtected(Permissions.AccessContentsInformation,
4232
                              'getBuildingState')
4233
    def getBuildingState(self, default=None, id_only=1):
4234
      """
4235
        Returns the current state in building
4236
      """
4237
      portal_workflow = getToolByName(self, 'portal_workflow')
4238 4239
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4240
      return wf._getWorkflowStateOf(self, id_only=id_only )
4241

4242
    security.declareProtected(Permissions.AccessContentsInformation,
4243
                              'getInstallationState')
4244
    def getInstallationState(self, default=None, id_only=1):
4245
      """
4246
        Returns the current state in installation
4247
      """
4248
      portal_workflow = getToolByName(self, 'portal_workflow')
4249 4250
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4251
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4252

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4253 4254 4255 4256 4257 4258
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4259
      export_string = portal_templates.manage_exportObject(
4260 4261
                                               id=self.getId(),
                                               toxml=1,
4262
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4263
      return export_string
4264

4265
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4266
      """
4267 4268
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4269
      """
4270
      result = getattr(self, id, ())
4271 4272 4273 4274
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4275
        # XXX Why do we need to return a tuple ?
4276 4277
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4278

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

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

4293
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4294
      """
4295 4296
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4297
      """
4298
      return self._getOrderedList('template_workflow_id')
4299

4300
    def getTemplatePortalTypeIdList(self):
4301
      """
4302 4303
      We have to set this method because we want an
      ordered list
4304
      """
4305
      return self._getOrderedList('template_portal_type_id')
4306

4307 4308 4309 4310 4311 4312 4313
    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
4314 4315 4316 4317 4318 4319 4320
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

4321 4322 4323 4324 4325 4326 4327
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

4328 4329 4330 4331 4332 4333
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4334

4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355
    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')

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

4363 4364 4365 4366 4367 4368 4369
    def getTemplatePortalTypeRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_roles')

4370
    def getTemplateSkinIdList(self):
4371
      """
4372 4373
      We have to set this method because we want an
      ordered list
4374
      """
4375
      return self._getOrderedList('template_skin_id')
4376

4377
    def getTemplateModuleIdList(self):
4378
      """
4379 4380
      We have to set this method because we want an
      ordered list
4381
      """
4382
      return self._getOrderedList('template_module_id')
4383 4384 4385 4386 4387 4388 4389

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

4391
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
4392 4393 4394 4395
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
4396
      if self.getBuildingState() != 'built':
4397
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
4398
              'Business Template must be built before export'
4399 4400 4401
      if self.getInstallationState() == 'installed':
        raise TemplateConditionError, \
              'Can not export installed Business Template'
4402

Aurel's avatar
Aurel committed
4403 4404 4405 4406 4407 4408 4409
      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)

4410
      # export bt
4411
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
4412
      for prop in self.propertyMap():
4413
        prop_type = prop['type']
Aurel's avatar
Aurel committed
4414
        id = prop['id']
4415
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
4416
                  'install_object_list_list', 'id_generator'):
4417
          continue
Aurel's avatar
Aurel committed
4418
        value = self.getProperty(id)
4419
        if prop_type in ('text', 'string', 'int', 'boolean'):
4420
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
4421
        elif prop_type in ('lines', 'tokens'):
4422
          bta.addObject(obj=str(os.linesep).join(value), name=id,
4423
                        path=path+os.sep+'bt', ext='')
4424

Aurel's avatar
Aurel committed
4425 4426 4427
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
4428

Aurel's avatar
Aurel committed
4429 4430
      return bta.finishCreation()

4431
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
4432 4433
    def importFile(self, dir = 0, file=None, root_path=None):
      """
4434
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
4435 4436 4437 4438 4439
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
4440

Aurel's avatar
Aurel committed
4441 4442
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4443
      self._portal_type_workflow_chain_item = \
4444
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
Aurel's avatar
Aurel committed
4445 4446 4447 4448 4449 4450 4451 4452 4453 4454
      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())
4455 4456
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
4457 4458 4459 4460 4461 4462 4463 4464
      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())
4465 4466
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488
      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())
4489 4490
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504
      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(
4505
               self.getTemplateCatalogKeywordKeyList())
4506 4507
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4508
               self.getTemplateCatalogFullTextKeyList())
4509 4510
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4511
               self.getTemplateCatalogRequestKeyList())
4512 4513
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4514
               self.getTemplateCatalogMultivalueKeyList())
4515 4516 4517
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4518 4519 4520
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
4521

Aurel's avatar
Aurel committed
4522 4523
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4524

4525 4526 4527 4528 4529 4530 4531 4532 4533
    #By christophe Dumez <christophe@nexedi.com>
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
        item = getattr(self, item_name)
        items_list.extend(item.getKeys())
      return items_list
4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547
    
    #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]
4548 4549
          if dependency in (None, ''):
            continue
4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560
          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) \
                  or (version_restriction is not None and 
                     (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)
4561

Aurel's avatar
Aurel committed
4562
    def diffObject(self, REQUEST, **kw):
4563 4564
      """
        Make a diff between an object in the Business Template
4565
        and the same in the Business Template installed in the site
4566 4567 4568 4569
      """

      class_name_dict = {
        'Product' : '_product_item',
4570
        'PropertySheet' : '_property_sheet_item',
4571
        'Constraint' : '_constraint_item',
4572 4573 4574 4575 4576 4577 4578 4579 4580
        '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',
4581
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
4582 4583 4584 4585
        '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',
4586 4587 4588 4589
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
4590
        'Preference' : '_preference_item',
4591
        'Action' : '_action_item',
4592
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4593
        'LocalRoles' : '_local_roles_item',
4594 4595 4596
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4597 4598 4599 4600 4601
        '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',
4602
        }
4603

4604 4605
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
4606

Christophe Dumez's avatar
Christophe Dumez committed
4607
      # Get objects
4608
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4609

Aurel's avatar
Aurel committed
4610
      new_bt =self
Christophe Dumez's avatar
Christophe Dumez committed
4611
      # Compare with a given business template
4612
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
4613 4614
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
4615 4616
        if bt2_id == self.getId():
          compare_to_zodb = 1
4617
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
4618 4619
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
4620 4621 4622
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
4623 4624 4625
          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
4626
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
4627 4628 4629
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
4630

4631 4632
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
4633
      if compare_to_zodb:
Aurel's avatar
Aurel committed
4634
        # XXX maybe only build for the given object to gain time
4635
        installed_item.build(self)
4636 4637 4638
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
4639

Christophe Dumez's avatar
Christophe Dumez committed
4640
      # Real Zope Objects (can be exported into XML directly by Zope)
4641 4642
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
4643
                     '_category_item', '_path_item', '_preference_tem',
Christophe Dumez's avatar
Christophe Dumez committed
4644
                     '_skin_item', '_action_item',]
4645

Christophe Dumez's avatar
Christophe Dumez committed
4646
      # Not considered as objects by Zope (will be exported into XML manually)
4647
      # XXX Bad naming
4648
      item_list_2 = ['_site_property_item', '_module_item',
4649
                     '_catalog_result_key_item', '_catalog_related_key_item',
4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661
                     '_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',
4662
                     '_portal_type_workflow_chain_item',]
4663

Christophe Dumez's avatar
Christophe Dumez committed
4664
      # Text objects (no need to export them into XML)
4665
      # XXX Bad naming
4666 4667
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
4668
                     '_test_item', '_message_translation_item',]
4669

4670
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
4671 4672 4673
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
4674 4675
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
4676
        # XML Export in memory
4677 4678 4679
        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()
4680
        f1.close()
4681 4682 4683 4684
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
4685
        # End of XML export
4686

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

4695
      elif item_name in item_list_2:
4696
        # Generate XML code manually
4697 4698
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
4699 4700
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
4701
        # End of XML Code Generation
4702

4703
        # Diff between XML objects
4704 4705
        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
4706
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4707 4708 4709
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
4710

4711
      elif item_name in item_list_3:
4712
        # Diff between text objects
4713 4714 4715 4716
        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
4717
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
4718 4719
          diff_msg += '\n'.join(diff_list)
        else:
4720
          diff_msg = 'No diff'
4721

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

4725 4726
      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4727

4728
      return diff_msg
4729

4730

4731 4732 4733 4734
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
4735 4736
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
4737 4738 4739 4740 4741 4742 4743
      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 [])
4744 4745
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

4746
      p = self.getPortalObject()
4747
      for id in bt_portal_types_id_list:
4748 4749
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
4750
          continue
4751
        if len(getattr(portal_type, '_roles', ())) > 0:
4752 4753
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
4754

4755 4756 4757 4758
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
4759
        action_list = []
4760 4761 4762 4763 4764 4765 4766
        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'):
4767
          base_category_list = portal_type.base_category_list
4768 4769
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
4770

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

4776
        for h_id in hidden_content_type_list:
4777 4778 4779
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
4780

4781 4782 4783 4784
        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)
4785

4786 4787 4788 4789
        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)
4790

4791 4792 4793 4794
        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)
4795

4796
        for workflow_id in [chain for chain in wtool.getChainFor(id)
4797
                                    if chain != '(Default)']:
4798 4799 4800
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
4801

4802 4803 4804 4805
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
4806
      bt_action_list.sort()
4807
      bt_wf_chain_list.sort()
4808

4809 4810 4811 4812 4813 4814 4815
      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)
4816 4817 4818 4819 4820 4821 4822 4823 4824
      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:
4825 4826
        raise TemplateConditionError, 'No module defined in business template'

4827 4828 4829 4830 4831 4832 4833 4834
      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:
4835
          return type_list
4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849

        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():
4850
            type_list.update(getChildPortalType(hidden_ptype_id))
4851
        return type_list
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 4886 4887 4888 4889 4890 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 4918 4919 4920 4921 4922 4923 4924 4925 4926
      p = self.getPortalObject()
      portal_dict = {}
      for module_id in bt_module_id_list:
        module = p.unrestrictedTraverse(module_id)
        portal_type_id = module.getPortalType()
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+portal_type_id)
        except KeyError:
          continue
        allowed_content_type_list = []
        hidden_content_type_list = []
        if hasattr(portal_type, 'allowed_content_types'):
          allowed_content_type_list = portal_type.allowed_content_types
        if hasattr(portal_type, 'hidden_content_type_list'):
          hidden_content_type_list = portal_type.hidden_content_type_list

        portal_dict[portal_type_id] = ()

        for allowed_type_id in allowed_content_type_list:
          if allowed_type_id not in portal_dict.keys():
            portal_dict.update(getChildPortalType(allowed_type_id))

        for hidden_type_id in hidden_content_type_list:
          if hidden_type_id not in portal_dict.keys():
            portal_dict.update(getChildPortalType(hidden_type_id))

      # construct portal type list, keep already present portal types
      for id in portal_dict.keys():
        if id not in bt_portal_types_id_list:
          bt_portal_types_id_list.append(id)

      bt_portal_types_id_list.sort()

      setattr(self, 'template_portal_type_id', bt_portal_types_id_list)
      return

    def clearPortalTypes(self, **kw):
      """
      clear id list register for portal types
      """
      setattr(self, 'template_portal_type_id', ())
      setattr(self, 'template_portal_type_allowed_content_type', ())
      setattr(self, 'template_portal_type_hidden_content_type', ())
      setattr(self, 'template_portal_type_property_sheet', ())
      setattr(self, 'template_portal_type_base_category', ())
      return

# Transaction Manager used for update of business template workflow
# XXX update seems to works without it

# from Shared.DC.ZRDB.TM import TM

# class WorkflowUpdateTM(TM):

#   _p_oid=_p_changed=_registered=None
#   _update = 0

#   def __init__(self, ):
#     LOG('init TM', 0, '')

#   def register(self, update=0, gen=None, site=None):
#     LOG('register TM', 0, update)
#     self._gen = gen
#     self._site = site
#     self._update = update
#     self._register()

#   def tpc_prepare(self, *d, **kw):
#     LOG("tpc_prepare", 0, self._update)
#     if self._update:
#       # do it one time
#       self._update = 0
#       LOG('call update of wf', 0, '')
#       self._gen.setupWorkflow(self._site)
4927

4928 4929 4930 4931 4932 4933 4934 4935

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

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