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

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

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


Aurel's avatar
Aurel committed
80 81
catalog_method_list = ('_is_catalog_list_method_archive',
                       '_is_uncatalog_method_archive',
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
                       '_is_clear_method_archive', '_is_filtered_archive')

catalog_method_filter_list = ('_filter_expression_archive', '_filter_expression_instance_archive',
                              '_filter_type_archive')


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

Aurel's avatar
Aurel committed
109 110 111
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
112
  """
Aurel's avatar
Aurel committed
113 114 115 116 117 118 119 120 121 122 123 124

  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
125

Aurel's avatar
Aurel committed
126 127 128 129 130 131
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
    Class archiving businnes template into a folder tree
132
  """
Aurel's avatar
Aurel committed
133 134 135 136 137 138
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
139
      removeAll(self.path)
Aurel's avatar
Aurel committed
140 141 142
      os.makedirs(self.path)

  def addFolder(self, name=''):
143
     if name !='':
Aurel's avatar
Aurel committed
144
      path = os.path.join(self.path, name)
145
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
146 147 148
        os.makedirs(path)
      return path

149
  def addObject(self, obj, name, path=None, ext='.xml'):
150
    name = pathname2url(name)
Aurel's avatar
Aurel committed
151 152 153
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
154 155
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
156 157
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
158
    f.write(str(obj))
Aurel's avatar
Aurel committed
159 160 161 162
    f.close()

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

166
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
167 168 169 170
    """
      Import file from a local folder
    """
    class_name = klass.__class__.__name__
171
    for file_path in self.file_list:
172
      if class_name in file_path.split(os.sep):
173 174
        if os.path.isfile(file_path):
          file = open(file_path, 'r')
Aurel's avatar
Aurel committed
175
          # get object id
176 177
          folders = file_path.split(os.sep)
          file_name = string.join(folders[self.root_path_len:], os.sep)
178 179
          if '%' in file_name:
            file_name = url2pathname(file_name)
180
          klass._importFile(file_name, file)
Aurel's avatar
Aurel committed
181
          # close file
182
          file.close()
183

Aurel's avatar
Aurel committed
184 185 186 187 188 189
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
190
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
191 192 193 194 195
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
196
      removeAll(self.path)
Aurel's avatar
Aurel committed
197 198 199 200 201 202
      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
203
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
204 205
      os.makedirs(name)

206
  def addObject(self, obj, name, path=None, ext='.xml'):
207
    name = pathname2url(name)
Aurel's avatar
Aurel committed
208 209 210
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
211 212
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
213 214
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
215
    f.write(str(obj))
Aurel's avatar
Aurel committed
216 217 218 219 220
    f.close()

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
221
    removeAll(self.path)
Aurel's avatar
Aurel committed
222 223 224 225 226
    return self.fobj

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

227
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
228 229
    """
      Import all file from the archive to the site
230
    """
Aurel's avatar
Aurel committed
231 232 233 234 235 236
    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
237 238
      if 'CVS' in info.name.split('/'):
        continue
239
      if class_name in info.name.split('/'):
Aurel's avatar
Aurel committed
240 241
        if info.isreg():
          file = tar.extractfile(info)
242 243 244
          tar_file_name = info.name.startswith('./') and info.name[2:] or \
              info.name
          folders = string.split(tar_file_name, os.sep)
245 246 247 248
          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
249 250 251
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
252

253 254
class TemplateConditionError(Exception): pass

255 256
class TemplateConflictError(Exception): pass

257
class BaseTemplateItem(Implicit, Persistent):
258
  """
259
    This class is the base class for all template items.
260
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
261

262
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
263
    self.__dict__.update(kw)
264
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
265
    self._objects = PersistentMapping()
266 267 268 269 270 271 272
    for id in id_list:
      if not id: continue
      self._archive[id] = None

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

273
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
274 275
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
276
      new_keys = self._objects.keys()
Aurel's avatar
Aurel committed
277
      for path in new_keys:
278 279
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
280 281
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
282 283 284 285 286 287 288 289 290 291 292 293
          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):
294
    pass
295 296 297

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

299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
  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)
        

316 317 318 319
  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
320
  def export(self, context, bta, **kw):
321
    pass
Aurel's avatar
Aurel committed
322 323

  def importFile(self, bta, **kw):
324
    bta.importFiles(klass=self)
325

326 327 328 329 330 331 332 333 334 335 336
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
    """  
    if hasattr(obj, '__ac_local_roles__'):
      # remove local roles
      obj.__ac_local_roles__ = None
    if hasattr(obj, '_owner'):
      obj._owner = None
    if hasattr(aq_base(obj), 'uid'):
      obj.uid = None
337 338 339 340 341
    if getattr(obj, 'meta_type', None) == 'Script (Python)':
      if hasattr(aq_base(obj), '_code'):
        obj._code = None
    return obj

342 343 344
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
345
  """
346

347 348 349 350
  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()
351
      self._archive.clear()
352 353 354
      for id in id_list:
        self._archive["%s/%s" % (tool_id, id)] = None

355 356 357 358 359
  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():
360
      obj = self._objects[key]
361 362
      # create folder and subfolders
      folders, id = os.path.split(key)
Aurel's avatar
Aurel committed
363 364 365 366 367 368 369
      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))
370 371 372
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
373 374
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
375

Aurel's avatar
Aurel committed
376 377 378 379
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
380
      relative_url = '/'.join([url,id])
381 382
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
383
      obj = self.removeProperties(obj)
384
      id_list = obj.objectIds()
385
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
386
        # we must keep groups because it's ereased when we delete subobjects
387
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
388 389
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
390
        obj.manage_delObjects(list(id_list))
391
      if hasattr(aq_base(obj), 'groups'):
392 393 394
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
395 396
    return sub_list

397 398 399 400
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
401 402
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
403
      obj = self.removeProperties(obj)
404
      id_list = obj.objectIds()
405
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
406
        # we must keep groups because it's ereased when we delete subobjects
407
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
408 409
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
410
        obj.manage_delObjects(list(id_list))
411
      if hasattr(aq_base(obj), 'groups'):
412 413 414
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
415

416 417 418 419 420 421 422 423 424 425
  def _importFile(self, file_name, file):
    # import xml file
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
    obj = connection.importFile(file, customImporters=customImporters)
    self._objects[file_name[:-4]] = obj

426
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
427 428
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
429 430 431 432 433 434 435
      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]
436 437
          new_object = self.removeProperties(new_object)
          old_object = self.removeProperties(old_object)
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
          new_io = StringIO()
          old_io = StringIO()
          OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, new_io)
          OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
          new_obj_xml = new_io.getvalue()
          old_obj_xml = old_io.getvalue()
          new_io.close()
          old_io.close()
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def _backupObject(self, action, trashbin, container_path, object_id):
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
461
    subobjects_dict = {}
462
    if trashbin is None: # must return subobjects
463 464 465 466 467 468 469 470
      object_path = container_path + [object_id]
      obj = self.unrestrictedTraverse(object_path)
      for subobject_id in list(obj.objectIds()):
        subobject_path = object_path + [subobject_id]
        subobject = self.unrestrictedTraverse(subobject_path)
        subobject_copy = subobject._p_jar.exportFile(subobject._p_oid)
        subobjects_dict[subobject_id] = subobject_copy      
      return subobjects_dict
471 472
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
473 474 475 476 477 478 479 480
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=1)
    elif action == 'install':
      subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, object_id, save=0)
    return subobjects_dict
    
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
481
    if context.getTemplateFormatVersion() == 1:
482 483 484 485 486 487
      groups = {}
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
488 489 490 491 492 493 494
        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:
495
            action = 'backup'
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
          # get subobjects in path
          container_path = path.split('/')[:-1]
          object_id = path.split('/')[-1]
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
            container_url = '/'.join(container_path)            
            if update_dict.has_key(container_url):
              if update_dict[container_url] == 'nothing':
                continue
            raise
          container_ids = container.objectIds()
          subobjects_dict = {}
          # Object already exists
          if object_id in container_ids:
            subobjects_dict = self._backupObject(action, trashbin, container_path, object_id)
            container.manage_delObjects([object_id])
          # install object
515
          obj = self._objects[path]          
516 517 518
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
519
          if hasattr(aq_base(obj), 'groups'):
520
            # we must keep original order groups because they change when we add subobjects
521
            groups[path] = deepcopy(obj.groups)
522
          # copy the object
523 524 525 526 527
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
528 529 530
          # import sub objects if there is
          if len(subobjects_dict) > 0:
            # get a jar
531 532
            connection = obj._p_jar
            o = obj
533
            while connection is None:
534 535
              o = o.aq_parent
              connection = o._p_jar
536 537 538 539 540
            # import subobjects
            for subobject_id in subobjects_dict.keys():
              subobject_data = subobjects_dict[subobject_id]
              subobject_data.seek(0)
              subobject = connection.importFile(subobject_data)
541 542 543
              if subobject_id not in obj.objectIds():
                obj._setObject(subobject_id, subobject)
          if obj.meta_type in ('Z SQL Method',):
544 545 546
            # It is necessary to make sure that the sql connection
            # in this method is valid.
            sql_connection_list = portal.objectIds(spec=('Z MySQL Database Connection',))
547 548
            if obj.connection_id not in sql_connection_list:
              obj.connection_id = sql_connection_list[0]
549 550
      # now put original order group
      for path in groups.keys():
551 552
        obj = portal.unrestrictedTraverse(path)
        obj.groups = groups[path]
Aurel's avatar
Aurel committed
553
    else:
554 555
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
556
      portal = context.getPortalObject()
557
      for relative_url in self._archive.keys():
558
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
559 560 561 562
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
563
        if object_id in container_ids:    # Object already exists          
564
          self._backupObject('backup', trashbin, container_path, object_id)
565
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
566
        # Set a hard link
567 568 569 570 571 572
        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',):
573
          # It is necessary to make sure that the sql connection
Aurel's avatar
Aurel committed
574 575 576
          # in this method is valid.
          sql_connection_list = portal.objectIds(
                                   spec=('Z MySQL Database Connection',))
577 578
          if obj.connection_id not in sql_connection_list:
            obj.connection_id = sql_connection_list[0]
579 580 581

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
582
    trash = kw.get('trash', 0)
583 584 585 586 587
    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
588
      object_keys = self._archive.keys()
589
    for relative_url in object_keys:
590 591
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
592
      try:        
593
        container = portal.unrestrictedTraverse(container_path)
594
        if trash and trashbin is not None:
595 596 597 598
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
        container.manage_delObjects([object_id])
      except (NotFound, KeyError):
        # object is already backup and/or removed
599
        pass
600 601
    BaseTemplateItem.uninstall(self, context, **kw)

602 603 604 605 606 607 608 609 610 611 612 613
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

614 615 616 617 618 619 620 621 622
  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()
623 624
    object_keys.sort()
    object_keys.reverse()
625
    p = context.getPortalObject()
626 627
    object_keys.sort()
    object_keys.reverse()
628 629 630
    for path in object_keys:
      for relative_url in self._resolvePath(p, [], path.split('/')):
        try:        
Aurel's avatar
Aurel committed
631 632
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
633 634 635 636 637 638 639 640 641
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
            self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

642 643 644
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
645

646 647 648 649 650 651 652 653 654
      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.
655 656
      obj = folder._getOb(id)
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
657 658
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
659 660
      if object_id != "":
        path_list.extend(self._resolvePath(folder._getOb(object_id), relative_url_list + [object_id], id_list[1:]))
661
    return path_list
Aurel's avatar
Aurel committed
662

663 664 665
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
666 667 668
    keys = self._path_archive.keys()
    keys.sort()    
    for path in keys:
669 670 671
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
672
      for relative_url in self._resolvePath(p, [], path.split('/')):
673 674 675
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
        id_list = obj.objectIds()
676
        obj = self.removeProperties(obj)
677
        if hasattr(aq_base(obj), 'groups'):
678
          # we must keep groups because it's ereased when we delete subobjects
679
          groups = deepcopy(obj.groups)
680
        if len(id_list) > 0:
681 682
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
683
          obj.manage_delObjects(list(id_list))
684
        if hasattr(aq_base(obj), 'groups'):
685 686 687
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
688
      
689 690
class CategoryTemplateItem(ObjectTemplateItem):

691 692
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
693

694 695 696 697
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
698 699
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
700
      obj = self.removeProperties(obj)
701
      id_list = obj.objectIds()
702 703
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
704 705 706
        obj.manage_delObjects(list(id_list))
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
707 708 709 710 711

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

823

824 825
class SkinTemplateItem(ObjectTemplateItem):

826 827
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
828

829
  def install(self, context, trashbin, **kw):
830
    ObjectTemplateItem.install(self, context, trashbin, **kw)
831 832
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
833 834 835 836 837
    p = context.getPortalObject()
    # It is necessary to make sure that the sql connections in Z SQL Methods are valid.
    sql_connection_list = p.objectIds(spec=('Z MySQL Database Connection',))
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
838 839 840
      for obj in folder.objectValues(spec=('Z SQL Method',)):
        if obj.connection_id not in sql_connection_list:
          obj.connection_id = sql_connection_list[0]
841 842 843 844 845 846
    # 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
847
        if context.getTemplateFormatVersion() == 1:
848 849
          if update_dict.has_key(relative_url) or force:
            if not force:
850
              if update_dict[relative_url] == 'nothing':
851
                continue
852
          obj = self._objects[relative_url]
853
        else:
854
          obj = self._archive[relative_url]
855
        skin_id = relative_url.split('/')[-1]
856
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
857 858 859 860 861 862 863 864 865 866 867 868 869
        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)
870 871 872

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
873 874 875 876 877
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()    
878
    ps = context.portal_skins
879
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
880 881 882 883 884 885 886
    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)
887
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
888
    context.getPortalObject().changeSkin(None)
889 890 891
    ObjectTemplateItem.uninstall(self, context, **kw)


892
class WorkflowTemplateItem(ObjectTemplateItem):
893

894 895
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
896

897
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
898 899
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
      portal = context.getPortalObject()
      new_keys = self._objects.keys()
      for path in new_keys:
        if len(path.split('/')) == 2:
          if installed_bt._objects.has_key(path):          
            # compare object to see it there is changes
            new_object = self._objects[path]
            old_object = installed_bt._objects[path]
            new_io = StringIO()
            old_io = StringIO()
            OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, new_io)
            OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
            new_obj_xml = new_io.getvalue()
            old_obj_xml = old_io.getvalue()
            new_io.close()
            old_io.close()
            if new_obj_xml != old_obj_xml:
              modified_object_list.update({path : ['Modified', 'Workflow']})
          else: # new object
            modified_object_list.update({path : ['New', 'Workflow']})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
928
    if context.getTemplateFormatVersion() == 1:
929 930 931 932 933 934 935 936 937 938 939 940 941 942
      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:
943
            action = 'backup'
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
          container_path = path.split('/')[:-1]
          object_id = path.split('/')[-1]
          try:
            container = portal.unrestrictedTraverse(container_path)
          except KeyError:
            # parent object can be set to nothing, in this case just go on
            container_url = '/'.join(container_path)            
            if update_dict.has_key(container_url):
              if update_dict[container_url] == 'nothing':
                continue
            raise
          container_ids = container.objectIds()
          if object_id in container_ids:    # Object already exists
            self._backupObject(action, trashbin, container_path, object_id)
            container.manage_delObjects([object_id])
959
          obj = self._objects[path]
960 961 962
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
963 964 965 966 967
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
968 969 970 971
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)


972 973 974 975 976 977 978 979
class PortalTypeTemplateItem(ObjectTemplateItem):

  workflow_chain = None

  def _getChainByType(self, context):
    """
    This is used in order to construct the full list
    of mapping between type and list of workflow associated
980
    This is only useful in order to use
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
    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)

1005 1006
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1007 1008 1009
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1010 1011
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1012 1013 1014
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
      id_list = obj.objectIds()
1015 1016 1017
      # remove actions and properties
      action_len = len(obj.listActions())
      obj.deleteActions(selections=range(action_len))
1018
      obj = self.removeProperties(obj)
1019 1020 1021 1022 1023 1024 1025 1026 1027
      # 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
1028 1029
      if hasattr(obj, '_roles'):
        setattr(obj, '_roles', [])
1030 1031
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
1032
    # also export workflow chain
1033
    (default_chain, chain_dict) = self._getChainByType(context)
1034 1035
    for obj in self._objects.values():
      portal_type = obj.id
1036 1037
      self._workflow_chain_archive[portal_type] = chain_dict['chain_%s' % portal_type]

Aurel's avatar
Aurel committed
1038 1039 1040 1041
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
1042
    # export portal type object
1043
    ObjectTemplateItem.export(self, context, bta, **kw)
1044 1045
    # export workflow chain
    xml_data = '<workflow_chain>'
1046 1047 1048
    keys = self._workflow_chain_archive.keys()
    keys.sort()
    for key in keys:
1049 1050 1051
      xml_data += os.linesep+' <chain>'
      xml_data += os.linesep+'  <type>%s</type>' %(key,)
      xml_data += os.linesep+'  <workflow>%s</workflow>' %(self._workflow_chain_archive[key],)
1052
      xml_data += os.linesep+' </chain>'
1053
    xml_data += os.linesep+'</workflow_chain>'
1054
    bta.addObject(obj=xml_data, name='workflow_chain_type',  path=root_path)
1055

1056 1057 1058 1059
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1060 1061 1062 1063 1064 1065
    # We now need to setup the list of workflows corresponding to
    # each portal type
    (default_chain, chain_dict) = self._getChainByType(context)
    # Set the default chain to the empty string is probably the
    # best solution, by default it is 'default_workflow', wich is
    # not very usefull
1066
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1067
    if context.getTemplateFormatVersion() == 1:
1068
      object_list = self._objects
1069
    else:
1070 1071
      object_list = self._archive
    for path in object_list.keys():
1072 1073 1074 1075 1076
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
            continue          
1077 1078
        obj = object_list[path]
        portal_type = obj.id
1079 1080 1081 1082 1083
        chain_dict['chain_%s' % portal_type] = \
                              self._workflow_chain_archive[portal_type]
        context.portal_workflow.manage_changeWorkflows(default_chain,
                                                       props=chain_dict)

1084 1085 1086 1087 1088 1089 1090
  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:
1091
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1092 1093 1094 1095 1096
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1097
        dict[str(ptype)] = str(workflow)
1098 1099 1100 1101 1102
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)


1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):

  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'

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

  def generateXml(self, path=None):
1119
    dict = self._objects
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
    xml_data = '<%s>' %(self.xml_tag,)
    keys = dict.keys()
    keys.sort()
    for key in keys:
      allowed_list = dict[key]
      xml_data += os.linesep+' <portal_type id="%s">' %(key,)
      for allowed_item in allowed_list:
        xml_data += os.linesep+'  <item>%s</item>' %(allowed_item,)
      xml_data += os.linesep+' </portal_type>'
    xml_data += os.linesep+'</%s>' %(self.xml_tag,)
    return xml_data

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

1141 1142 1143 1144 1145 1146
  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':
1147
        #must rename keys in dict if reinstall
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
        new_dict = PersistentMapping()
        for key in installed_bt._objects.keys():
          new_key = self.class_property+'/'+key
          new_dict[new_key] = installed_bt._objects[key]
        installed_bt._objects = new_dict
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
          new_object = self._objects[path]
          old_object = installed_bt._objects[path]          
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
  def _importFile(self, file_name, file):
    path, name = os.path.split(file_name)
    id = string.split(name, '.')[0]
    xml = parse(file)
    portal_type_list = xml.getElementsByTagName('portal_type')
    for portal_type in portal_type_list:
      id = portal_type.getAttribute('id')
      item_type_list = []
      item_list = portal_type.getElementsByTagName('item')
      for item in item_list:
        item_type_list.append(str(item.childNodes[0].data))
      self._objects[self.class_property+'/'+id] = item_type_list

  def install(self, context, trashbin, **kw):
    p = context.getPortalObject()
    pt = p.unrestrictedTraverse('portal_types')
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    for key in self._objects.keys():
      if update_dict.has_key(key) or force:
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
        try:
          portal_id = key.split('/')[-1]
          portal_type = pt._getOb(portal_id)
        except KeyError:
          LOG("portal types not found : ", 100, portal_id)
          continue
        property_list = self._objects[key]
        object_property_list = getattr(portal_type, self.class_property, ())
        if len(object_property_list) > 0:
          # merge differences between portal types properties
          # only add new, do not remove
          for id in object_property_list:
            if id not in property_list:              
              property_list.append(id)        
        setattr(portal_type, self.class_property, list(property_list))

Aurel's avatar
Aurel committed
1209
  def uninstall(self, context, **kw):
1210
    object_path = kw.get('object_path', None)
1211
    p = context.getPortalObject()
1212
    pt = p.unrestrictedTraverse('portal_types')
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._objects.keys()
    for key in object_keys:
      try:
        portal_id = key.split('/')[-1]
        portal_type = pt._getOb(portal_id)
      except KeyError:
        LOG("portal types not found : ", 100, portal_id)
        continue
      property_list = self._objects[key]
      original_property_list = getattr(portal_type, self.class_property, ())
Aurel's avatar
Aurel committed
1226 1227 1228
      for id in property_list:
        if id in original_property_list:
          original_property_list.remove(id)        
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
      setattr(portal_type, self.class_property, list(original_property_list))
    
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'

class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'

class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

  xml_tag = 'base_category_list'
  class_property = 'base_category_list'

1246 1247
class CatalogMethodTemplateItem(ObjectTemplateItem):

1248 1249
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1250
    self._is_catalog_list_method_archive = PersistentMapping()
1251 1252 1253 1254 1255 1256 1257 1258 1259
    self._is_uncatalog_method_archive = PersistentMapping()
    self._is_clear_method_archive = PersistentMapping()
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1260 1261
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1262 1263
    except KeyError:
      catalog = None
1264
    if catalog is None:
1265
      LOG('BusinessTemplate build', 0, 'catalog not found')
1266
      return
1267 1268
    for obj in self._objects.values():
      method_id = obj.id
1269 1270 1271
      self._is_catalog_list_method_archive[method_id] = method_id in catalog.sql_catalog_object_list
      self._is_uncatalog_method_archive[method_id] = method_id in catalog.sql_uncatalog_object
      self._is_clear_method_archive[method_id] = method_id in catalog.sql_clear_catalog
1272
      self._is_filtered_archive[method_id] = 0
1273 1274 1275 1276 1277
      if catalog.filter_dict.has_key(method_id):
        self._is_filtered_archive[method_id] = catalog.filter_dict[method_id]['filtered']
        self._filter_expression_archive[method_id] = catalog.filter_dict[method_id]['expression']
        self._filter_expression_instance_archive[method_id] = catalog.filter_dict[method_id]['expression_instance']
        self._filter_type_archive[method_id] = catalog.filter_dict[method_id]['type']
1278

Aurel's avatar
Aurel committed
1279 1280 1281 1282 1283
  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():
1284
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1285 1286 1287 1288 1289 1290
      # 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()
1291 1292
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1293 1294
      # add all datas specific to catalog inside one file
      catalog = context.portal_catalog.getSQLCatalog()
1295
      method_id = obj.id
1296 1297
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1298
      f = open(object_path, 'wt')
1299 1300 1301
      xml_data = '<catalog_method>'
      for method in catalog_method_list:
        value = getattr(self, method, 0)[method_id]
1302
        xml_data += os.linesep+' <item key="%s" type="int">' %(method,)
1303
        xml_data += os.linesep+'  <value>%s</value>' %(str(int(value)))
1304
        xml_data += os.linesep+' </item>'
Aurel's avatar
Aurel committed
1305
      if catalog.filter_dict.has_key(method_id):
1306 1307 1308
        for method in catalog_method_filter_list:
          value = getattr(self, method, '')[method_id]
          if method == '_filter_expression_instance_archive':
1309
            pass
1310
          else:
1311
            if type(value) in (type(''), type(u'')):
1312
              xml_data += os.linesep+' <item key="%s" type="str">' %(method,)
1313
              xml_data += os.linesep+'  <value>%s</value>' %(str(value))
1314
              xml_data += os.linesep+' </item>'
1315
            elif type(value) in (type(()), type([])):
1316
              xml_data += os.linesep+' <item key="%s" type="tuple">'%(method)
1317 1318
              for item in value:
                xml_data += os.linesep+'  <value>%s</value>' %(str(item))
1319
              xml_data += os.linesep+' </item>'
1320 1321
      xml_data += os.linesep+'</catalog_method>'
      f.write(str(xml_data))
Aurel's avatar
Aurel committed
1322
      f.close()
1323

1324 1325
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1326 1327
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1328
    except KeyError:
1329 1330 1331 1332 1333 1334 1335 1336
      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)
1337

1338 1339 1340
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1341
    new_bt_format = context.getTemplateFormatVersion()
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362

    if force: # get all objects
      if new_bt_format:
        values = self._objects.values()
      else:
        values = self._archive.values()
    else: # get only selected object
      if new_bt_format == 1:
        keys = self._objects.keys()
      else:
        keys = self._archive.keys()
      for key in keys:
        if update_dict.has_key(key) or force:
          if not force:
            action = update_dict[key]
            if action == 'nothing':
              continue          
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
1363

1364 1365
    for obj in values:
      method_id = obj.id
1366

Aurel's avatar
Aurel committed
1367 1368 1369 1370
      is_catalog_list_method = int(self._is_catalog_list_method_archive[method_id])
      is_uncatalog_method = int(self._is_uncatalog_method_archive[method_id])
      is_clear_method = int(self._is_clear_method_archive[method_id])
      is_filtered = int(self._is_filtered_archive[method_id])
1371

1372 1373 1374 1375 1376
      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)

1377
      if is_uncatalog_method and method_id not in sql_uncatalog_object:
1378
        sql_uncatalog_object.append(method_id)
1379
      elif not is_uncatalog_method and method_id in sql_uncatalog_object:
1380 1381 1382 1383 1384 1385 1386 1387
        sql_uncatalog_object.remove(method_id)

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

      if is_filtered:
1388
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1389
        if context.getTemplateFormatVersion() == 1:
1390 1391 1392
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1393
        filter_type = self._filter_type_archive[method_id]
1394 1395 1396
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1397
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1398
        catalog.filter_dict[method_id]['type'] = filter_type
1399
      elif method_id in catalog.filter_dict.keys():
1400
        catalog.filter_dict[method_id]['filtered'] = 0
1401

1402 1403
    sql_catalog_object_list.sort()
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
1404
    sql_uncatalog_object.sort()
1405
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
1406
    sql_clear_catalog.sort()
1407
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1408 1409

  def uninstall(self, context, **kw):
1410 1411
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1412
    except KeyError:
1413 1414 1415 1416
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1417
    
1418 1419 1420 1421
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
1422 1423 1424 1425
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
1426 1427 1428 1429
    else:
      value = self._archive[object_path]
      if value is not None:
        values.append(value)
1430 1431 1432 1433
    # 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)
1434

1435
    for obj in values:      
1436
      method_id = obj.id
1437 1438
      if method_id in sql_catalog_object_list:
        sql_catalog_object_list.remove(method_id)
1439 1440 1441 1442
      if method_id in sql_uncatalog_object:
        sql_uncatalog_object.remove(method_id)
      if method_id in sql_clear_catalog:
        sql_clear_catalog.remove(method_id)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1443
      if catalog.filter_dict.has_key(method_id):
1444
        del catalog.filter_dict[method_id]
1445
        
1446 1447 1448
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1449
    # uninstall objects
1450
    ObjectTemplateItem.uninstall(self, context, **kw)
1451

1452
  def _importFile(self, file_name, file):
1453
    if not '.catalog_keys' in file_name:
1454 1455 1456 1457 1458 1459 1460 1461
      # 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
1462
    elif '.catalog_keys' in file_name:
1463 1464 1465 1466
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1467
      method_list = xml.getElementsByTagName('item')
1468
      for method in method_list:
1469
        key = method.getAttribute('key')
1470 1471
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1472 1473
          value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          key = str(key)
1474
        elif key_type == "int":
1475
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1476
          key = str(key)
1477
        elif key_type == "tuple":
1478 1479 1480 1481
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1482
        else:
1483
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1484
          continue
1485 1486 1487
        if key in catalog_method_list or key in catalog_method_filter_list:
          dict = getattr(self, key)
          dict[id] = value
1488 1489

class ActionTemplateItem(ObjectTemplateItem):
1490 1491

  def __init__(self, id_list, **kw):
1492
    # XXX It's look like ObjectTemplateItem __init__
1493 1494 1495 1496 1497 1498
    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

1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
  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

1520 1521 1522 1523
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1524
      relative_url, value = id.split(' | ')
1525 1526
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1527
        if getattr(ai, 'id') == value:
1528
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1529
          key = os.path.join(url[-2], url[-1], value)
1530
          action = ai._getCopy(context)
1531
          action = self.removeProperties(action)
1532
          self._objects[key] = action
Aurel's avatar
Aurel committed
1533
          self._objects[key].wl_clearLocks()
1534 1535
          break
      else:
1536
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1537

1538 1539 1540
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1541
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1542 1543
      p = context.getPortalObject()
      for id in self._objects.keys():
1544 1545 1546 1547 1548 1549
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
1550 1551
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
1552 1553 1554
          for index in range(len(action_list)):
            if getattr(action_list[index], 'id') == path[-1]:          
              # remove previous action
1555
              obj.deleteActions(selections=(index,))
1556
          action = self._objects[id]
1557
          obj.addAction(
1558 1559 1560 1561 1562 1563 1564 1565 1566
                        id = action.id
                      , name = action.title
                      , action = action.action.text
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
                      , icon = getattr(action, 'icon', None) and action.icon.text or ''
                      , optional = getattr(action, 'optional', 0)
1567
                      , priority = action.priority
Aurel's avatar
Aurel committed
1568
                    )
1569
          # sort action based on the priority define on it
1570 1571 1572 1573 1574 1575 1576 1577 1578
          # 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
1579
    else:
1580
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1581
      p = context.getPortalObject()
1582 1583
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
1584
        relative_url, key, value = self._splitPath(id)
1585 1586
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
1587
          if getattr(ai, key) == value:
1588 1589
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
        obj.addAction(
Aurel's avatar
Aurel committed
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
                      id = action.id
                    , name = action.title
                    , action = action.action.text
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
                    , icon = getattr(action, 'icon', None) and action.icon.text or ''
                    , optional = getattr(action, 'optional', 0)
                    )
Aurel's avatar
Aurel committed
1600 1601 1602 1603 1604 1605 1606
        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))
1607 1608
          obj.moveDownActions(selections=tuple(move_down_list))

1609 1610
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1611 1612 1613 1614
    object_path = kw.get("object_path", None)
    if object_path is not None:
      keys = [object_path]
    else:
1615
      keys = self._archive.keys()  
1616
    for id in keys:
1617 1618 1619 1620 1621
      if  '|' in id:
        relative_url, value = id.split(' | ')
        key = 'id'
      else:
        relative_url, key, value = self._splitPath(id)        
1622 1623
      obj = p.unrestrictedTraverse(relative_url)
      action_list = obj.listActions()
1624
      for index in range(len(action_list)):
1625
        if getattr(action_list[index], key) == value:
1626
          obj.deleteActions(selections=(index,))
1627 1628 1629
          break
    BaseTemplateItem.uninstall(self, context, **kw)

1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702
class PortalTypeRolesTemplateItem(BaseTemplateItem):

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

  def build(self, context, **kw):
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      obj = p.unrestrictedTraverse("portal_types/%s" %
          relative_url.split('/', 1)[1])
      type_roles_obj = getattr(obj, '_roles', ())
      type_role_list = []
      for role in type_roles_obj:
        type_role_dict = {}
        # uniq
        for property in ('id', 'title', 'description', 'condition',
            'priority', 'base_category_script'):
          prop_value = getattr(role, property)
          if prop_value:
            type_role_dict[property] = prop_value
        # 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

  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
      xml_data += os.linesep+"  <role id='%s'>" % role['id']
      # uniq
      for property in ('title', 'description', 'condition', 'priority',
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
          xml_data += os.linesep+"   <property id='%s'>%s</property>" % \
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
        for prop_value in role.get(property):
          xml_data += os.linesep+"   <multi_property "\
          "id='%s'>%s</multi_property>" % (property, prop_value)
      xml_data += os.linesep+"  </role>"
    xml_data += os.linesep+'</type_roles>'
    return xml_data
      
  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)
    xml_type_roles_list = xml.getElementsByTagName('role')    
    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():
1703
          property_value = property.childNodes[0].data.encode()
1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
          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():
1714
          property_value = property.childNodes[0].data.encode()
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731
          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]
      obj = p.unrestrictedTraverse(path)
      setattr(obj, '_roles', []) # reset roles before applying
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1732
      type_roles_list = self._objects[roles_path] or []
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742
      for type_role_property_dict in type_roles_list:
        obj._roles.append(RoleInformation(**type_role_property_dict))

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

1743 1744 1745 1746 1747 1748
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1749 1750
      for property in p.propertyMap():
        if property['id'] == id:
1751
          obj = p.getProperty(id)
1752
          prop_type = property['type']
1753 1754
          break
      else:
1755 1756
        obj = None
      if obj is None:
1757
        raise NotFound, 'the property %s is not found' % id
1758
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
1759

1760 1761 1762 1763 1764 1765
  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
1766 1767
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
1768 1769 1770 1771 1772 1773 1774
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
1775
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
1776
      self._objects[str(id)] = (str(prop_type), value)
1777

1778 1779 1780
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1781
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1782 1783
      p = context.getPortalObject()
      for path in self._objects.keys():
1784 1785 1786 1787 1788 1789 1790 1791
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue          
          dir, id = os.path.split(path)
          if p.hasProperty(id):
            continue
1792 1793
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
1794
    else:
1795
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1796
      p = context.getPortalObject()
1797 1798
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
1799 1800 1801 1802 1803
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
1804 1805 1806

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1807 1808 1809 1810 1811 1812
    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:
1813 1814 1815 1816
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

1817
  def generateXml(self, path=None):
1818
    xml_data = ''
1819
    prop_type, obj = self._objects[path]
1820 1821
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
1822 1823
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
1824
      xml_data += os.linesep+'  <value>'
1825
      for item in obj:
1826 1827 1828 1829
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
1830
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
1831
    xml_data += os.linesep+' </property>'
1832 1833
    return xml_data

Aurel's avatar
Aurel committed
1834 1835 1836 1837 1838
  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)
1839 1840 1841 1842
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
1843
      xml_data += self.generateXml(path)
1844
    xml_data += os.linesep+'</site_property>'
1845
    bta.addObject(obj=xml_data, name='properties', path=root_path)
1846

1847 1848 1849 1850 1851 1852 1853
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)
1854 1855 1856 1857 1858 1859 1860 1861
      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
1862

1863
  def generateXml(self, path=None):
1864 1865
    dict = self._objects[path]
    xml_data = '<module>'
1866 1867 1868 1869
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
1870 1871 1872 1873 1874 1875 1876
      if key =='permission_list':
        # separe permission dict into xml
        xml_data += os.linesep+' <%s>' %(key,)
        permission_list = dict[key]
        for perm in permission_list:
          xml_data += os.linesep+'  <permission>'
          xml_data += os.linesep+'   <name>%s</name>' %(perm[0])
Aurel's avatar
Aurel committed
1877
          role_list = list(perm[1])
1878
          role_list.sort()
1879 1880 1881 1882 1883 1884 1885 1886 1887
          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

1888 1889 1890 1891 1892
  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)
1893 1894 1895
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
1896
      # expor module one by one
1897
      xml_data = self.generateXml(path=id)
1898
      bta.addObject(obj=xml_data, name=id, path=path)
1899

1900
  def install(self, context, trashbin, **kw):
1901
    portal = context.getPortalObject()
1902 1903
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1904
    if context.getTemplateFormatVersion() == 1:
1905
      items = self._objects
1906
    else:
1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929
      items = self._archive

    for id in items.keys():
      if update_dict.has_key(id) or force:
        if not force:
          action = update_dict[id]
          if action == 'nothing':
            continue
        mapping = items[id]
        path, id = os.path.split(id)
        if id in portal.objectIds():
          module = portal._getOb(id)
          module.portal_type = str(mapping['portal_type']) 
        else:
          module = portal.newContent(id=id, portal_type=str(mapping['portal_type']))
        module.setTitle(str(mapping['title']))
        for name,role_list in list(mapping['permission_list']):
          acquire = (type(role_list) == type([]))
          try:
            module.manage_permission(name, roles=role_list, acquire=acquire)
          except ValueError:
            # Ignore a permission not present in this system.
            pass
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960

  def _importFile(self, file_name, file):
    dict = {}
    xml = parse(file)
    for id in ('portal_type', 'id', 'title', 'permission_list'):
      elt = xml.getElementsByTagName(id)[0]
      if id == 'permission_list':
        plist = []
        perm_list = elt.getElementsByTagName('permission')
        for perm in perm_list:
          name_elt = perm.getElementsByTagName('name')[0]
          name_node = name_elt.childNodes[0]
          name = name_node.data
          role_list = perm.getElementsByTagName('role')
          rlist = []
          for role in role_list:
            role_node = role.childNodes[0]
            role = role_node.data
            rlist.append(str(role))
          perm_tuple = (str(name), rlist)
          plist.append(perm_tuple)
        dict[id] = plist
      else:
        node_list = elt.childNodes
        if len(node_list) == 0:
          value=''
        else:
          value = node_list[0].data
        dict[id] = str(value)
    self._objects[file_name[:-4]] = dict

1961
  def uninstall(self, context, **kw):
1962 1963 1964 1965 1966 1967 1968
    trash = kw.get('trash', 0)      
    object_path = kw.get('object_path', None)
    trashbin = kw.get('trashbin', None)
    if object_path is None:
      keys = self._archive.keys()
    else:
      keys = [object_path]
1969 1970
    p = context.getPortalObject()
    id_list = p.objectIds()
1971
    for id in keys:
1972
      if id in id_list:
1973
        try:
1974
          if trash and trashbin is not None:
1975 1976
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
1977
          p.manage_delObjects([id])
1978
        except NotFound:
1979
          pass
1980 1981
    BaseTemplateItem.uninstall(self, context, **kw)

1982 1983 1984
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
1985 1986

class DocumentTemplateItem(BaseTemplateItem):
1987 1988 1989 1990
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
1991 1992 1993 1994

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

1997
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1998 1999
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019
      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
2020
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2021
      for id in self._objects.keys():
2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
          path, name = os.path.split(id)
          # This raises an exception if the file already exists.
          try:
            globals()[self.local_file_writer_name](name, text, create=1)
          except IOError:
            continue
          if self.local_file_importer_name is not None:
            globals()[self.local_file_importer_name](name)
Aurel's avatar
Aurel committed
2036
    else:
2037 2038 2039
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
2040
        # This raises an exception if the file exists.
2041
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
2042 2043
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
2044 2045

  def uninstall(self, context, **kw):
2046 2047 2048 2049 2050 2051
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for id in object_keys:
2052
      globals()[self.local_file_remover_name](id)
2053 2054
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
2055 2056 2057 2058 2059 2060
  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():
2061 2062
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
2063

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

2068 2069 2070 2071 2072 2073
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

2074 2075 2076 2077 2078
class ConstraintTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalConstraint'
  local_file_writer_name = 'writeLocalConstraint'
  local_file_importer_name = 'importLocalConstraint'
  local_file_remover_name = 'removeLocalConstraint'
2079

2080 2081 2082
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
2083 2084
  # Extension needs no import
  local_file_importer_name = None
2085 2086 2087 2088 2089
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
2090
  # Test needs no import
2091 2092 2093
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
2094

2095 2096 2097
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
2098 2099 2100

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2101 2102 2103 2104
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2105 2106
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
2107

2108
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2109 2110
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2111
      new_roles = self._objects.keys()
2112 2113 2114
      if installed_bt.id == 'installed_bt_for_diff':
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
2115 2116 2117
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
2118 2119 2120
        for key in old_keys:
          new_dict[key] = ''
        installed_bt._objects = new_dict      
2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133
      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):
2134
    p = context.getPortalObject()
2135
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2136
    if context.getTemplateFormatVersion() == 1:
2137
      role_list = self._objects.keys()
2138
    else:
2139
      role_list = self._archive.keys()
2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151
    # 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
2152
    for role in role_list:
2153 2154 2155 2156 2157 2158 2159 2160 2161 2162
      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
2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174

  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)

2175 2176 2177 2178 2179 2180 2181 2182 2183
  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
2184
      if role in roles and role not in new_roles:
2185 2186 2187
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

2188
  def generateXml(self, path):
2189
    obj = self._objects[path]
2190
    xml_data = '<role_list>'
2191 2192
    obj.sort()
    for role in obj:
2193 2194 2195 2196
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

Aurel's avatar
Aurel committed
2197 2198 2199 2200 2201 2202
  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():
2203
      xml_data = self.generateXml(path=path)
2204
      bta.addObject(obj=xml_data, name=path, path=None,)
2205

2206 2207
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2208
  def build(self, context, **kw):
2209 2210
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2211
    except KeyError:
2212 2213 2214 2215
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2216
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2217
    key_list = []
2218
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2219
      if key in sql_search_result_keys:
2220
        key_list.append(key)
Aurel's avatar
Aurel committed
2221 2222
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2223
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2224
      self._objects[self.__class__.__name__+os.sep+'result_key_list'] = key_list
2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235

  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

2236
  def install(self, context, trashbin, **kw):
2237 2238 2239 2240 2241 2242 2243
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2244

2245
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2246
    if context.getTemplateFormatVersion() == 1:
2247 2248
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
2249 2250 2251
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2252
    else:
2253
      keys = self._archive.keys()
2254 2255
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2256
    # XXX same as related key
Aurel's avatar
Aurel committed
2257
    if update_dict.has_key('result_key_list') or force:
2258
      if not force:
Aurel's avatar
Aurel committed
2259
        action = update_dict['result_key_list']
2260
        if action == 'nothing':
Aurel's avatar
Aurel committed
2261
          return
2262
      for key in keys:
2263 2264
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
2265
      catalog.sql_search_result_keys = sql_search_result_keys
2266

2267
  def uninstall(self, context, **kw):
2268 2269
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2270
    except KeyError:
2271 2272 2273 2274 2275
      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)
2276 2277 2278 2279 2280 2281
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2282 2283
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2284
    catalog.sql_search_result_keys = sql_search_result_keys
2285 2286
    BaseTemplateItem.uninstall(self, context, **kw)

2287
  def generateXml(self, path=None):
2288
    obj = self._objects[path]
2289
    xml_data = '<key_list>'
2290 2291
    obj.sort()
    for key in obj:
2292 2293 2294 2295
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2296 2297 2298 2299 2300
  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)
2301
    for path in self._objects.keys():
2302
      xml_data = self.generateXml(path=path)
2303
      bta.addObject(obj=xml_data, name=path, path=None)
2304

2305 2306
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2307
  def build(self, context, **kw):
2308 2309
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2310
    except KeyError:
2311 2312 2313 2314
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2315
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2316
    key_list = []
2317
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2318
      if key in sql_search_related_keys:
2319
        key_list.append(key)
Aurel's avatar
Aurel committed
2320 2321
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2322
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2323
      self._objects[self.__class__.__name__+os.sep+'related_key_list'] = key_list
2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334

  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

2335
  def install(self, context, trashbin, **kw):
2336 2337 2338 2339 2340 2341 2342
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2343

2344
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2345
    if context.getTemplateFormatVersion() == 1:
2346
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2347
        return
2348 2349 2350
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2351
    else:
2352
      keys = self._archive.keys()
2353 2354
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
2355
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
2356
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
2357
      if not force:
Aurel's avatar
Aurel committed
2358 2359 2360 2361
        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
2362 2363 2364
        if action == 'nothing':
          return
      for key in keys:
2365 2366
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
2367
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
2368

2369 2370 2371
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2372
    except KeyError:
2373 2374 2375 2376
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2377
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2378 2379 2380 2381 2382 2383
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2384 2385 2386 2387 2388
      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)

2389
  def generateXml(self, path=None):
2390
    obj = self._objects[path]
2391
    xml_data = '<key_list>'
2392 2393
    obj.sort()
    for key in obj:
2394 2395 2396 2397
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2398 2399 2400 2401 2402 2403
  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():
2404
      xml_data = self.generateXml(path=path)
2405
      bta.addObject(obj=xml_data, name=path, path=None)
2406

2407 2408
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2409
  def build(self, context, **kw):
2410 2411
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2412
    except KeyError:
2413 2414 2415 2416
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2417
    sql_search_result_tables = list(catalog.sql_search_tables)
2418
    key_list = []
2419
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2420
      if key in sql_search_result_tables:
2421
        key_list.append(key)
Aurel's avatar
Aurel committed
2422 2423
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2424
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2425
      self._objects[self.__class__.__name__+os.sep+'resutl_table_list'] = key_list
2426 2427 2428 2429 2430 2431 2432 2433 2434 2435

  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
2436

2437
  def install(self, context, trashbin, **kw):
2438 2439 2440 2441 2442 2443 2444
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2445

2446
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2447
    if context.getTemplateFormatVersion() == 1:
2448
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2449
        return
2450 2451 2452
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2453
    else:
2454
      keys = self._archive.keys()
2455 2456
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2457
    # XXX same as related keys
Aurel's avatar
Aurel committed
2458
    if update_dict.has_key('result_table_list') or force:
2459
      if not force:
Aurel's avatar
Aurel committed
2460
        action = update_dict['result_table_list']
2461
        if action == 'nothing':
Aurel's avatar
Aurel committed
2462
          return
2463
      for key in keys:
2464 2465
        if key not in sql_search_tables:
          sql_search_tables.append(key)
2466
      catalog.sql_search_tables = sql_search_tables
2467 2468

  def uninstall(self, context, **kw):
2469 2470
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2471
    except KeyError:
2472 2473 2474 2475 2476
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2477 2478 2479 2480 2481 2482
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
2483 2484
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2485
    catalog.sql_search_tables = sql_search_tables
2486 2487
    BaseTemplateItem.uninstall(self, context, **kw)

2488
  def generateXml(self, path=None):
2489
    obj = self._objects[path]
2490
    xml_data = '<key_list>'
2491 2492
    obj.sort()
    for key in obj:
2493 2494 2495 2496
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'    
    return xml_data

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
      xml_data = self.generateXml(path=path)
2504
      bta.addObject(obj=xml_data, name=path, path=None)
2505 2506 2507
      
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
2508 2509

  def build(self, context, **kw):
2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525
    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
2526

2527 2528 2529 2530 2531 2532 2533 2534 2535
  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
2536 2537

  def install(self, context, trashbin, **kw):
2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554
    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()
2555 2556
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579
    # XXX same as related key
    if update_dict.has_key('keyword_key_list') or force:
      if not force:
        action = update_dict['keyword_key_list']
        if action == 'nothing':
          return
      for key in keys:
        if key not in sql_keyword_keys:
          sql_keyword_keys.append(key)
      catalog.sql_catalog_keyword_search_keys = sql_keyword_keys

  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_keyword_keys = list(catalog.sql_catalog_keyword_search_keys)
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
Aurel's avatar
Aurel committed
2580
    else:
2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_keyword_keys:
        sql_keyword_keys.remove(key)
    catalog.sql_catalog_keyword_search_keys = sql_keyword_keys
    BaseTemplateItem.uninstall(self, context, **kw)

  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data
Aurel's avatar
Aurel committed
2596 2597 2598 2599

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
2600 2601 2602 2603 2604
    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)
2605

2606 2607
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
2608

2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625
  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
2626

2627 2628 2629 2630 2631 2632 2633 2634 2635
  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
2636

2637 2638 2639 2640 2641 2642 2643 2644
  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
2645

2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666
    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
2667

2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_full_text_keys = list(catalog.sql_catalog_full_text_search_keys)
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_full_text_keys:
        sql_full_text_keys.remove(key)
    catalog.sql_catalog_full_text_search_keys = sql_full_text_keys
    BaseTemplateItem.uninstall(self, context, **kw)

  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

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


# request
class CatalogRequestKeyTemplateItem(BaseTemplateItem):

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

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

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

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

  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_request_keys = list(catalog.sql_catalog_request_keys)
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_request_keys:
        sql_catalog_request_keys.remove(key)
    catalog.sql_catalog_request_keys = sql_catalog_request_keys
    BaseTemplateItem.uninstall(self, context, **kw)

  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

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

# multivalue
class CatalogMultivalueKeyTemplateItem(BaseTemplateItem):

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

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

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

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

  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_multivalue_keys = list(catalog.sql_catalog_multivalue_keys)
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_multivalue_keys:
        sql_catalog_multivalue_keys.remove(key)
    catalog.sql_catalog_multivalue_keys = sql_catalog_multivalue_keys
    BaseTemplateItem.uninstall(self, context, **kw)

  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

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

# topic
class CatalogTopicKeyTemplateItem(BaseTemplateItem):

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

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

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

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

  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_catalog_topic_search_keys = list(catalog.sql_catalog_topic_search_keys)
    object_path = kw.get('object_path', None)    
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
      if key in sql_catalog_topic_search_keys:
        sql_catalog_topic_search_keys.remove(key)
    catalog.sql_catalog_topic_search_keys = sql_catalog_topic_search_keys
    BaseTemplateItem.uninstall(self, context, **kw)

  def generateXml(self, path=None):
    obj = self._objects[path]
    xml_data = '<key_list>'
    obj.sort()
    for key in obj:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

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

class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
    for lang in self._archive.keys():
      # Export only erp5_ui at the moment.
      # This is safer against information leak.
      for catalog in ('erp5_ui', ):
        path = os.path.join(lang, catalog)
        mc = localizer._getOb(catalog)
        self._objects[path] = mc.manage_export(lang)

  def preinstall(self, context, installed_bt, **kw):
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
        if installed_bt._objects.has_key(path):
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
          old_obj_code = installed_bt._objects[path]
          if new_obj_code != old_obj_code:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
      old_keys = installed_bt._objects.keys()
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
    localizer = context.getPortalObject().Localizer
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
      for path, po in self._objects.items():
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue          
          path = string.split(path, '/')
          lang = path[-3]
          catalog = path[-2]
          if lang not in localizer.get_languages():
            localizer.manage_addLanguage(lang)
          mc = localizer._getOb(catalog)
          if lang not in mc.get_languages():
            mc.manage_addLanguage(lang)
          mc.manage_import(lang, po)
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for lang, catalogs in self._archive.items():
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
          mc = localizer._getOb(catalog)
          if lang not in mc.get_languages():
            mc.manage_addLanguage(lang)
          mc.manage_import(lang, po)

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      obj = self._objects[key]
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
Aurel's avatar
Aurel committed
3078
      f = open(path+os.sep+'translation.po', 'wt')
3079 3080 3081 3082 3083 3084 3085
      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
3086 3087
class LocalRolesTemplateItem(BaseTemplateItem):

3088 3089 3090 3091
  def __init__(self, id_list, **kw):
    id_list = ['local_roles/%s' % id for id in id_list]
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
3092 3093 3094
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
3095
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
3096 3097 3098 3099
      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
3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139
      self._objects[path] = (local_roles_dict, group_local_roles_dict)

  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
      
  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 = []
3140
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
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
        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))    
      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]
    local_roles_list = local_roles.getElementsByTagName('role')    
    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]
    local_roles_list = group_local_roles.getElementsByTagName('role')    
    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__', {})
    
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
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
    in part or completely. Each object are separated from its
    subobjects and exported in xml format.
    It may include:

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

    - portal_types definition
      - object without optinal actions
      - list of relation between portal type and worklfow

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

    - site property definition
      - id
      - type
3225
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3226

3227 3228
    - document/propertysheet/extension/test definition
      - copy of the local file
3229

3230
    - message transalation definition
3231
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3232

3233 3234
    The Business Template properties are exported to the bt folder with
    one property per file
3235

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3236 3237
    Technology:

3238 3239
    - 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
3240

3241
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3242 3243 3244 3245

    Use case:

    - install core ERP5 (the minimum)
3246

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

3249 3250
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
3251
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3252 3253 3254 3255 3256
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
3257
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3258 3259 3260 3261 3262
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
3263
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3264 3265 3266 3267 3268 3269 3270

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
3271
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3272
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3273
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3274 3275 3276
                      , PropertySheet.BusinessTemplate
                      )

3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293
    # 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
      }

3294 3295 3296 3297 3298
    # This is a global variable
    # Order is important for installation
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
3299
      '_constraint_item',
3300 3301 3302 3303 3304 3305 3306 3307 3308
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
      '_message_translation_item',
      '_workflow_item',
      '_catalog_method_item',
      '_site_property_item',
      '_portal_type_item',
3309 3310 3311 3312
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
3313 3314 3315
      '_category_item',
      '_module_item',
      '_skin_item',
3316
      '_path_item',
3317
      '_action_item',
3318
      '_portal_type_roles_item',
Aurel's avatar
Aurel committed
3319
      '_local_roles_item', 
3320 3321 3322
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
3323 3324 3325 3326 3327
      '_catalog_keyword_key_item',
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
3328 3329 3330 3331
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3332 3333 3334 3335 3336 3337
      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
3338
        self._baseGetTemplateFormatVersion()
3339

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3340 3341 3342
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
3343
      
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3344 3345
      return 0
        
3346
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
3347 3348 3349 3350 3351 3352 3353
    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".
3354 3355
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
3356
          # XXX Not good to access the attribute directly,
3357 3358 3359
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
3360

3361
    security.declareProtected(Permissions.ManagePortal, 'build')
3362
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3363 3364 3365
      """
        Copy existing portal objects to self
      """
3366 3367
      if no_action: return # this is use at import of Business Template to get the status built
      
3368 3369
      # Make sure that everything is sane.
      self.clean()
3370

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3371 3372 3373
      # Set the format version.
      self._setTemplateFormatVersion(1)

3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386
      # Store all datas
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
3387 3388
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
3389 3390 3391 3392 3393 3394 3395 3396
      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())
3397 3398
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418
      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())
3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430
      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())
3431 3432
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
               self.getTemplateCatalogKeywordKeyList())      
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
               self.getTemplateCatalogFullTextKeyList())      
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
               self.getTemplateCatalogRequestKeyList())    
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
               self.getTemplateCatalogMultivalueKeyList())      
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
3448 3449 3450 3451
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
            
3452 3453 3454
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
3455

3456
    build = WorkflowMethod(build)
3457 3458

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3459
      """
3460
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3461
      """
3462
      return self.portal_templates.publish(self, url, username=username,
3463
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3464

3465
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3466
      """
3467
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3468
      """
3469
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3470

3471 3472 3473 3474
    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
3475 3476
      """
                
3477 3478
      modified_object_list = {}
      bt_title = self.getTitle()
3479 3480 3481 3482 3483 3484 3485

      #  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)
3486 3487 3488
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3489
        installed_bt_format = installed_bt.getTemplateFormatVersion()
3490

3491
      # if reinstall business template, must compare to object in ZODB
3492 3493 3494
      # and not to those in the installed Business Template because it is itself.
      # same if we make a diff and selected only one business template
      reinstall = 0      
3495 3496
      if installed_bt == self:
        reinstall = 1
3497 3498 3499
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
3500 3501 3502 3503
        bt2.edit(description='tmp bt generated for diff')
        bt2.build()
        installed_bt = bt2
      
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3504
      new_bt_format = self.getTemplateFormatVersion()
3505 3506 3507 3508 3509 3510
      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:
3511
          item = getattr(self, item_name, None)
3512 3513 3514 3515
          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
3516

3517 3518 3519 3520
      # 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:
3521
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3522
        old_item = getattr(installed_bt, item_name, None)
3523
        if new_item is not None:
3524 3525 3526 3527 3528 3529 3530 3531 3532
          if old_item is not None:
            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:
3533
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
3534
      
3535 3536 3537 3538 3539 3540 3541
      return modified_object_list

    def _install(self, force=1, object_to_update={}, **kw):
      """
        Install a new Business Template, if force, all we be upgrade or installed
        otherwise depends of dict object_to_update
      """
3542
      
3543 3544
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
3545
      if installed_bt is not None:        
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3546
        if installed_bt.getTemplateFormatVersion() == 0:
3547
          force = 1
3548
        installed_bt.replace(self)
3549

3550 3551 3552 3553
      trash_tool = getToolByName(self, 'portal_trash', None)
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

3554 3555 3556
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
3557
        
3558 3559 3560 3561 3562 3563
      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')
3564
        gen.setupLastTools(site, update=1, create_activities=1)             
3565 3566
      if not force:
        if len(object_to_update) == 0:
3567 3568 3569 3570 3571
          # 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():
3572
            LOG('Business Template', 0, 'Updating Business Template Workflows')
3573
            gen.setupWorkflow(site)
3574
          return
3575 3576 3577 3578 3579 3580 3581 3582 3583

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

      # update catalog if necessary
      update_catalog=0
      catalog_method = getattr(self, '_catalog_method_item', None)
3584
      if catalog_method is not None and self.getTemplateFormatVersion() == 1:
3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603
        for id in catalog_method._objects.keys():
          if id in object_to_update.keys() or force:
            if not force:
              action = object_to_update[id]
              if action == 'nothing':
                continue
            if 'related' not in id:
              # must update catalog
              update_catalog = 1
              break            
      if update_catalog:
        catalog = local_configuration.portal_catalog.getSQLCatalog()
        if catalog is None:
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
              
3604 3605
      # 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
3606
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates.objectIds()) > 1):
3607
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
3608 3609
      else:
        trashbin = None
3610
        
3611 3612 3613 3614 3615 3616 3617
      # 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)

3618
      # get objects to remove
3619
      # do remove after because we may need backup object from installation
3620 3621 3622 3623 3624 3625 3626 3627 3628
      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:
3629
          item = getattr(installed_bt, item_name, None)
3630 3631
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
3632

3633 3634 3635 3636 3637 3638 3639 3640

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

      # check if we have to updater business template workflow
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
3641
        LOG('Business Template', 0, 'Updating Business Template Workflows')
3642 3643 3644 3645 3646 3647 3648 3649
        gen.setupWorkflow(site)
        # XXX keep TM in case update of workflow doesn't work
        #         self._v_txn = WorkflowUpdateTM()
        #         self._v_txn.register(update=1, gen=gen, site=site)

      if update_catalog:
        site.ERP5Site_reindexAll()
       
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3650 3651 3652
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
3653

3654
    security.declareProtected(Permissions.ManagePortal, 'install')
3655 3656 3657
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
3658
      """      
3659
      return self._install(**kw)
3660

3661
    install = WorkflowMethod(install)
3662

3663
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
3664
    def reinstall(self, **kw):
3665 3666 3667 3668
      """Reinstall Business Template.
      """
      return self._install(**kw)

3669
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3670

3671
    security.declareProtected(Permissions.ManagePortal, 'trash')
3672 3673
    def trash(self, new_bt, **kw):
      """
3674
        Trash unnecessary items before upgrading to a new business
3675
        template.
3676
        This is similar to uninstall, but different in that this does
3677
        not remove all items.
3678 3679 3680 3681 3682
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3683 3684
      # Trash everything
      for item_name in self._item_name_list[::-1]:
3685
        item = getattr(self, item_name, None)
3686 3687 3688 3689
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
3690

3691
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
3692
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3693
      """
3694
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3695
      """
3696 3697 3698 3699
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3700 3701 3702
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
3703
        item = getattr(self, item_name, None)
3704 3705
        if item is not None:
          item.uninstall(local_configuration)
3706
      # It is better to clear cache because the uninstallation of a
3707
      # template deletes many things from the portal.
3708
      clearCache()
3709

3710 3711
    uninstall = WorkflowMethod(uninstall)

3712
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3713
    def _clean(self):
3714
      """
3715
        Clean built information.
3716
      """
3717
      # First, remove obsolete attributes if present.
3718 3719 3720 3721
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
3722
                    '_module_archive',
3723 3724 3725
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
3726
                    '_property_sheet_archive'):
3727 3728 3729
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
3730 3731
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
3732

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

3735
    security.declareProtected(Permissions.AccessContentsInformation,
3736
                              'getBuildingState')
3737
    def getBuildingState(self, id_only=1):
3738
      """
3739
        Returns the current state in building
3740
      """
3741
      portal_workflow = getToolByName(self, 'portal_workflow')
3742 3743
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
3744
      return wf._getWorkflowStateOf(self, id_only=id_only )
3745

3746
    security.declareProtected(Permissions.AccessContentsInformation,
3747
                              'getInstallationState')
3748
    def getInstallationState(self, id_only=1):
3749
      """
3750
        Returns the current state in installation
3751
      """
3752
      portal_workflow = getToolByName(self, 'portal_workflow')
3753 3754
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
3755
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3756

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3757 3758 3759 3760 3761 3762
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
3763
      export_string = portal_templates.manage_exportObject(
3764 3765
                                               id=self.getId(),
                                               toxml=1,
3766
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3767
      return export_string
3768

3769
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3770
      """
3771 3772
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3773
      """
3774
      result = getattr(self, id, ())
3775 3776 3777 3778 3779 3780
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3781

3782
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3783
      """
3784 3785
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3786
      """
3787
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3788

3789
    def getTemplateBaseCategoryList(self):
3790
      """
3791 3792
      We have to set this method because we want an
      ordered list
3793
      """
3794
      return self._getOrderedList('template_base_category')
3795

3796
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3797
      """
3798 3799
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3800
      """
3801
      return self._getOrderedList('template_workflow_id')
3802

3803
    def getTemplatePortalTypeIdList(self):
3804
      """
3805 3806
      We have to set this method because we want an
      ordered list
3807
      """
3808
      return self._getOrderedList('template_portal_type_id')
3809

Alexandre Boeglin's avatar
Alexandre Boeglin committed
3810 3811 3812 3813 3814 3815 3816
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
    
    def getTemplatePortalTypeHiddenContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_hidden_content_type')

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

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

3845
    def getTemplateActionPathList(self):
3846
      """
3847 3848
      We have to set this method because we want an
      ordered list
3849
      """
3850
      return self._getOrderedList('template_action_path')
3851

3852 3853 3854 3855 3856 3857 3858
    def getTemplatePortalTypeRolesList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_roles')

3859
    def getTemplateSkinIdList(self):
3860
      """
3861 3862
      We have to set this method because we want an
      ordered list
3863
      """
3864
      return self._getOrderedList('template_skin_id')
3865

3866
    def getTemplateModuleIdList(self):
3867
      """
3868 3869
      We have to set this method because we want an
      ordered list
3870
      """
3871
      return self._getOrderedList('template_module_id')
3872 3873 3874 3875 3876 3877 3878

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

3880
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
3881 3882 3883 3884
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
3885 3886
      if self.getBuildingState() != 'built':
        raise TemplateConditionError, 'Business Template must be build before export'
3887
      
Aurel's avatar
Aurel committed
3888 3889 3890 3891 3892 3893 3894
      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)

3895
      # export bt
3896
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
3897
      for prop in self.propertyMap():
3898
        prop_type = prop['type']
Aurel's avatar
Aurel committed
3899
        id = prop['id']
3900
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id', 'install_object_list_list'):
3901
          continue
Aurel's avatar
Aurel committed
3902 3903
        if id in ('template_update_business_template_workflow', 'template_update_tool') and self.getTitle() != 'erp5_core':
          continue
Aurel's avatar
Aurel committed
3904
        value = self.getProperty(id)
3905
        if prop_type in ('text', 'string', 'int', 'boolean'):
3906
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
3907
        elif prop_type in ('lines', 'tokens'):
3908
          bta.addObject(obj=str(os.linesep).join(value), name=id, path=path+os.sep+'bt', ext='')
3909

Aurel's avatar
Aurel committed
3910 3911 3912
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
3913
        
Aurel's avatar
Aurel committed
3914 3915
      return bta.finishCreation()

3916
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
3917 3918
    def importFile(self, dir = 0, file=None, root_path=None):
      """
3919
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
3920 3921 3922 3923 3924
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
3925

Aurel's avatar
Aurel committed
3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
3938 3939
      self._portal_type_roles_item = \
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRolesList())
Aurel's avatar
Aurel committed
3940 3941 3942 3943 3944 3945 3946 3947
      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())
3948 3949
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
Aurel's avatar
Aurel committed
3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971
      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())
3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998
      self._portal_type_allowed_content_type_item = \
           PortalTypeAllowedContentTypeTemplateItem(
               self.getTemplatePortalTypeAllowedContentTypeList())
      self._portal_type_hidden_content_type_item = \
           PortalTypeHiddenContentTypeTemplateItem(
               self.getTemplatePortalTypeHiddenContentTypeList())
      self._portal_type_property_sheet_item = \
           PortalTypePropertySheetTemplateItem(
               self.getTemplatePortalTypePropertySheetList())
      self._portal_type_base_category_item = \
           PortalTypeBaseCategoryTemplateItem(
               self.getTemplatePortalTypeBaseCategoryList())
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
               self.getTemplateCatalogKeywordKeyList())      
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
               self.getTemplateCatalogFullTextKeyList())      
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
               self.getTemplateCatalogRequestKeyList())      
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
               self.getTemplateCatalogMultivalueKeyList())      
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
3999 4000 4001
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
4002
      
Aurel's avatar
Aurel committed
4003 4004
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4005 4006


Aurel's avatar
Aurel committed
4007
    def diffObject(self, REQUEST, **kw):
4008 4009
      """
        Make a diff between an object in the Business Template
4010
        and the same in the Business Template installed in the site
4011 4012 4013 4014 4015
      """

      class_name_dict = {
        'Product' : '_product_item',
        'PropertySheet' : '_property_sheet_item', 
4016
        'Constraint' : '_constraint_item',
4017 4018 4019 4020 4021 4022 4023 4024 4025
        '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',
4026 4027 4028 4029
        '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',
4030 4031 4032 4033 4034
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
        'Action' : '_action_item',
4035
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4036
        'LocalRoles' : '_local_roles_item',
4037 4038 4039
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4040 4041 4042 4043 4044
        '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',
4045
        }
Aurel's avatar
Aurel committed
4046
      
4047 4048 4049 4050
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
      # get objects
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4051

Aurel's avatar
Aurel committed
4052
      new_bt =self
Aurel's avatar
Aurel committed
4053
      # compare with a given business template
4054
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
4055 4056
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
4057 4058 4059 4060
        if bt2_id == self.getId():
          compare_to_zodb = 1
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
4061 4062 4063
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
4064 4065 4066 4067 4068 4069 4070 4071
          compare_to_zodb = 1
      if compare_to_zodb:
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
        
4072 4073
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
4074
      if compare_to_zodb:
Aurel's avatar
Aurel committed
4075
        # XXX maybe only build for the given object to gain time
4076
        installed_item.build(self)
4077 4078 4079 4080
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      # make diff
      diff_msg = ''
4081 4082 4083 4084 4085 4086
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item', '_category_item', '_path_item',
                     '_skin_item', '_action_item']
      item_list_2 = ['_site_property_item', '_module_item', '_catalog_result_key_item', '_catalog_related_key_item',
                     '_catalog_result_table_item',   '_catalog_keyword_key_item', '_catalog_full_text_key_item',
                     '_catalog_request_key_item', '_catalog_multivalue_key_item', '_catalog_topic_key_item',
                     '_portal_type_allowed_content_type_item', '_portal_type_hidden_content_type_item',
4087 4088
                     '_portal_type_property_sheet_item', '_portal_type_roles_item',
                     '_portal_type_base_category_item', '_local_roles_item',]
4089 4090 4091
      item_list_3 = ['_document_item', '_property_sheet_item',
          '_constraint_item', '_extension_item', '_test_item',
          '_message_translation_item']
4092
      
4093 4094 4095
      if item_name in item_list_1:
        f1 = StringIO()
        f2 = StringIO()
Aurel's avatar
Aurel committed
4096
        # remove uneeded property
4097 4098
        new_object = new_item.removeProperties(new_object)
        installed_object = installed_item.removeProperties(installed_object)
4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
        OFS.XMLExportImport.exportXML(installed_object._p_jar, installed_object._p_oid, f2)
        new_obj_xml = f1.getvalue()
        installed_obj_xml = f2.getvalue()
        f1.close()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
        diff_list = list(unified_diff(installed_ob_xml_lines, new_ob_xml_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
          diff_msg += '\n\nObject %s diff :\n' %( object_id)
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
Aurel's avatar
Aurel committed
4113
          
4114
      elif item_name in item_list_2:
4115 4116
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
4117 4118 4119 4120 4121 4122 4123 4124
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
        diff_list = list(unified_diff(installed_obj_xml_lines, new_obj_xml_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
          diff_msg += '\n\nObject %s diff :\n' %( object_id)
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
Aurel's avatar
Aurel committed
4125
          
4126 4127 4128 4129 4130 4131 4132 4133 4134
      elif item_name in item_list_3:
        new_obj_lines = new_object.splitlines()
        installed_obj_lines = installed_object.splitlines()
        diff_list = list(unified_diff(installed_obj_lines, new_obj_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
          diff_msg += '\n\nObject %s diff :\n' %( object_id)
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'                
4135 4136 4137

      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
4138 4139 4140
      
      return diff_msg

4141 4142 4143 4144 4145 4146 4147 4148 4149
    
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
      bt_allowed_content_type_list = []
      bt_hidden_content_type_list = []
      bt_property_sheet_list = []
      bt_base_category_list = []
Aurel's avatar
Aurel committed
4150
      bt_action_list = getattr(self, 'template_action_path', []) or []
4151
      bt_action_list = list(bt_action_list)
4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162
      bt_portal_types_id_list = list(self.getTemplatePortalTypeIdList())      
      p = self.getPortalObject()
      for id in bt_portal_types_id_list:        
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+id)
        except KeyError:
          continue
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
4163
        action_list = []
4164 4165 4166 4167 4168 4169 4170 4171
        if hasattr(portal_type, 'allowed_content_types'):
          allowed_content_type_list = portal_type.allowed_content_types
        if hasattr(portal_type, 'hidden_content_type_list'):
          hidden_content_type_list = portal_type.hidden_content_type_list
        if hasattr(portal_type, 'property_sheet_list'):
          property_sheet_list = portal_type.property_sheet_list
        if hasattr(portal_type, 'base_category_list'):
          base_category_list = portal_type.base_category_list       
4172 4173 4174
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
        
4175 4176 4177 4178 4179 4180 4181 4182
        for a_id in allowed_content_type_list:            
          bt_allowed_content_type_list.append(id+' | '+a_id)
        for h_id in hidden_content_type_list:
          bt_hidden_content_type_list.append(id+' | '+h_id)
        for ps_id in property_sheet_list:           
          bt_property_sheet_list.append(id+' | '+ps_id)
        for bc_id in base_category_list:            
          bt_base_category_list.append(id+' | '+bc_id)
4183 4184 4185 4186
        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)
4187
          
4188 4189 4190 4191
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
4192
      bt_action_list.sort()
4193 4194 4195 4196

      setattr(self, 'template_portal_type_allowed_content_type', bt_allowed_content_type_list)
      setattr(self, 'template_portal_type_hidden_content_type', bt_hidden_content_type_list)
      setattr(self, 'template_portal_type_property_sheet', bt_property_sheet_list)
4197 4198
      setattr(self, 'template_portal_type_base_category', bt_base_category_list)
      setattr(self, 'template_action_path', bt_action_list)  
4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319
      return


    def guessPortalTypes(self, **kw):
      """
      This method guesses portal types based on modules define in the Business Template
      """
      bt_module_id_list = list(self.getTemplateModuleIdList())
      if len(bt_module_id_list) == 0:
        raise TemplateConditionError, 'No module defined in business template'    
      
      bt_portal_types_id_list = list(self.getTemplatePortalTypeIdList())

      def getChildPortalType(type_id):
        type_list = {}
        p = self.getPortalObject()
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+type_id)
        except KeyError:
          return type_list        

        allowed_content_type_list = []
        hidden_content_type_list = []
        if hasattr(portal_type, 'allowed_content_types'):
          allowed_content_type_list = portal_type.allowed_content_types
        if hasattr(portal_type, 'hidden_content_type_list'):
          hidden_content_type_list = portal_type.hidden_content_type_list
        type_list[type_id] = ()
        # get same info for allowed portal types and hidden portal types
        for allowed_ptype_id in allowed_content_type_list:
          if allowed_ptype_id not in type_list.keys():
            type_list.update(getChildPortalType(allowed_ptype_id))
        for hidden_ptype_id in hidden_content_type_list:
          if hidden_ptype_id not in type_list.keys():
            type_list.update(getChildPortalType(hidden_ptype_id))        
        return type_list
      
      p = self.getPortalObject()
      portal_dict = {}
      for module_id in bt_module_id_list:
        module = p.unrestrictedTraverse(module_id)
        portal_type_id = module.getPortalType()
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+portal_type_id)
        except KeyError:
          continue
        allowed_content_type_list = []
        hidden_content_type_list = []
        if hasattr(portal_type, 'allowed_content_types'):
          allowed_content_type_list = portal_type.allowed_content_types
        if hasattr(portal_type, 'hidden_content_type_list'):
          hidden_content_type_list = portal_type.hidden_content_type_list

        portal_dict[portal_type_id] = ()

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

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

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

      bt_portal_types_id_list.sort()

      setattr(self, 'template_portal_type_id', bt_portal_types_id_list)
      return

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

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

# from Shared.DC.ZRDB.TM import TM

# class WorkflowUpdateTM(TM):

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

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

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

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

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

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