BusinessTemplate.py 152 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 40 41 42 43 44 45
from Products.ERP5Type.Utils import readLocalPropertySheet, \
                                    writeLocalPropertySheet, \
                                    importLocalPropertySheet, \
                                    removeLocalPropertySheet
from Products.ERP5Type.Utils import readLocalExtension, writeLocalExtension, \
                                    removeLocalExtension
from Products.ERP5Type.Utils import readLocalTest, writeLocalTest, \
                                    removeLocalTest
from Products.ERP5Type.Utils import readLocalDocument, writeLocalDocument, \
                                    importLocalDocument, removeLocalDocument
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46
from Products.ERP5Type.XMLObject import XMLObject
47
import fnmatch
Aurel's avatar
Aurel committed
48
import re, os, sys, string, tarfile
Yoshinori Okuji's avatar
Yoshinori Okuji committed
49
from Products.ERP5Type.Cache import clearCache
50
from DateTime import DateTime
Aurel's avatar
Aurel committed
51
from OFS.Traversable import NotFound
52 53
from OFS import XMLExportImport
from cStringIO import StringIO
Aurel's avatar
Aurel committed
54 55 56 57 58 59
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
60 61

from zLOG import LOG
Aurel's avatar
Aurel committed
62 63
from OFS.ObjectManager import customImporters
from gzip import GzipFile
64
from xml.dom.minidom import parse
65
from Products.CMFCore.Expression import Expression
Aurel's avatar
Aurel committed
66
import tarfile
67
from urllib import pathname2url, url2pathname
68
from difflib import unified_diff
Aurel's avatar
Aurel committed
69 70


Aurel's avatar
Aurel committed
71 72
catalog_method_list = ('_is_catalog_list_method_archive',
                       '_is_uncatalog_method_archive',
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
                       '_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
100 101 102
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
103
  """
Aurel's avatar
Aurel committed
104 105 106 107 108 109 110 111 112 113 114 115

  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
116

Aurel's avatar
Aurel committed
117 118 119 120 121 122
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
    Class archiving businnes template into a folder tree
123
  """
Aurel's avatar
Aurel committed
124 125 126 127 128 129
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
130
      removeAll(self.path)
Aurel's avatar
Aurel committed
131 132 133
      os.makedirs(self.path)

  def addFolder(self, name=''):
134
     if name !='':
Aurel's avatar
Aurel committed
135
      path = os.path.join(self.path, name)
136
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
137 138 139
        os.makedirs(path)
      return path

140
  def addObject(self, obj, name, path=None, ext='.xml'):
141
    name = pathname2url(name)
Aurel's avatar
Aurel committed
142 143 144
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
145 146
      if '%' not in path:
        path = pathname2url(path)
Aurel's avatar
Aurel committed
147 148
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
149
    f.write(str(obj))
Aurel's avatar
Aurel committed
150 151 152 153
    f.close()

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

157
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
158 159 160 161
    """
      Import file from a local folder
    """
    class_name = klass.__class__.__name__
162
    for file_path in self.file_list:
163
      if class_name in file_path.split(os.sep):
164 165
        if os.path.isfile(file_path):
          file = open(file_path, 'r')
Aurel's avatar
Aurel committed
166
          # get object id
167 168
          folders = file_path.split(os.sep)
          file_name = string.join(folders[self.root_path_len:], os.sep)
169 170
          if '%' in file_name:
            file_name = url2pathname(file_name)
171
          klass._importFile(file_name, file)
Aurel's avatar
Aurel committed
172
          # close file
173
          file.close()
174

Aurel's avatar
Aurel committed
175 176 177 178 179 180
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
181
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
182 183 184 185 186
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
187
      removeAll(self.path)
Aurel's avatar
Aurel committed
188 189 190 191 192 193
      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
194
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
195 196
      os.makedirs(name)

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

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
212
    removeAll(self.path)
Aurel's avatar
Aurel committed
213 214 215 216 217
    return self.fobj

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

218
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
219 220
    """
      Import all file from the archive to the site
221
    """
Aurel's avatar
Aurel committed
222 223 224 225 226 227
    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
228 229
      if 'CVS' in info.name.split('/'):
        continue
230
      if class_name in info.name.split('/'):
Aurel's avatar
Aurel committed
231 232
        if info.isreg():
          file = tar.extractfile(info)
233
          folders = string.split(info.name, os.sep)
234 235 236 237
          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
238 239 240
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
241

242 243
class TemplateConditionError(Exception): pass

244 245
class TemplateConflictError(Exception): pass

246
class BaseTemplateItem(Implicit, Persistent):
247
  """
248
    This class is the base class for all template items.
249
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
250

251
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
252
    self.__dict__.update(kw)
253
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
254
    self._objects = PersistentMapping()
255 256 257 258 259 260 261
    for id in id_list:
      if not id: continue
      self._archive[id] = None

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

262
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
263 264
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
265
      new_keys = self._objects.keys()
Aurel's avatar
Aurel committed
266
      for path in new_keys:
267 268
        if installed_bt._objects.has_key(path):
          # compare object to see it there is changes
269 270
          new_obj_xml = self.generateXml(path=path)
          old_obj_xml = installed_bt.generateXml(path=path)
271 272 273 274 275 276 277 278 279 280 281 282
          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):
283
    pass
284 285 286

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

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
  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)
        

305 306 307 308
  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
309
  def export(self, context, bta, **kw):
310
    pass
Aurel's avatar
Aurel committed
311 312

  def importFile(self, bta, **kw):
313
    bta.importFiles(klass=self)
314

315 316 317 318 319 320 321 322 323 324 325
  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
326 327 328 329 330
    if getattr(obj, 'meta_type', None) == 'Script (Python)':
      if hasattr(aq_base(obj), '_code'):
        obj._code = None
    return obj

331 332 333
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
334
  """
335

336 337 338 339
  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()
340
      self._archive.clear()
341 342 343
      for id in id_list:
        self._archive["%s/%s" % (tool_id, id)] = None

344 345 346 347 348
  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():
349
      obj = self._objects[key]
350 351
      # create folder and subfolders
      folders, id = os.path.split(key)
Aurel's avatar
Aurel committed
352 353 354 355 356 357 358
      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))
359 360 361
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
362 363
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
364

Aurel's avatar
Aurel committed
365 366 367 368
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
369
      relative_url = '/'.join([url,id])
370 371
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
372
      obj = self.removeProperties(obj)
373
      id_list = obj.objectIds()
374
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
375
        # we must keep groups because it's ereased when we delete subobjects
376
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
377 378
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
379
        obj.manage_delObjects(list(id_list))
380
      if hasattr(aq_base(obj), 'groups'):
381 382 383
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
384 385
    return sub_list

386 387 388 389
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
390 391
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
392
      obj = self.removeProperties(obj)
393
      id_list = obj.objectIds()
394
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
395
        # we must keep groups because it's ereased when we delete subobjects
396
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
397 398
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
399
        obj.manage_delObjects(list(id_list))
400
      if hasattr(aq_base(obj), 'groups'):
401 402 403
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
404

405 406 407 408 409 410 411 412 413 414
  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

415
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
416 417
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
      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]
          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
    """
448
    subobjects_dict = {}
449 450 451 452 453 454 455 456 457
    if trashbin is None: #m ust return subobjects
      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
458 459
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
460 461 462 463 464 465 466 467
      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
468
    if context.getTemplateFormatVersion() == 1:
469 470 471 472 473 474
      groups = {}
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
      for path in keys:
475 476 477 478 479 480 481
        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:
482
            action = 'backup'
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
          # 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
502
          obj = self._objects[path]          
503 504 505
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
506
          if hasattr(aq_base(obj), 'groups'):
507
            # we must keep original order groups because they change when we add subobjects
508
            groups[path] = deepcopy(obj.groups)
509
          # copy the object
510 511 512 513 514
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
515 516 517
          # import sub objects if there is
          if len(subobjects_dict) > 0:
            # get a jar
518 519
            connection = obj._p_jar
            o = obj
520
            while connection is None:
521 522
              o = o.aq_parent
              connection = o._p_jar
523 524 525 526 527
            # import subobjects
            for subobject_id in subobjects_dict.keys():
              subobject_data = subobjects_dict[subobject_id]
              subobject_data.seek(0)
              subobject = connection.importFile(subobject_data)
528 529 530
              if subobject_id not in obj.objectIds():
                obj._setObject(subobject_id, subobject)
          if obj.meta_type in ('Z SQL Method',):
531 532 533
            # 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',))
534 535
            if obj.connection_id not in sql_connection_list:
              obj.connection_id = sql_connection_list[0]
536 537
      # now put original order group
      for path in groups.keys():
538 539
        obj = portal.unrestrictedTraverse(path)
        obj.groups = groups[path]
Aurel's avatar
Aurel committed
540
    else:
541 542
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
543
      portal = context.getPortalObject()
544
      for relative_url in self._archive.keys():
545
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
546 547 548 549
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
550
        if object_id in container_ids:    # Object already exists          
551
          self._backupObject('backup', trashbin, container_path, object_id)
552
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
553
        # Set a hard link
554 555 556 557 558 559
        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',):
560
          # It is necessary to make sure that the sql connection
Aurel's avatar
Aurel committed
561 562 563
          # in this method is valid.
          sql_connection_list = portal.objectIds(
                                   spec=('Z MySQL Database Connection',))
564 565
          if obj.connection_id not in sql_connection_list:
            obj.connection_id = sql_connection_list[0]
566 567 568

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
569
    trash = kw.get('trash', 0)
570 571 572 573 574
    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
575
      object_keys = self._archive.keys()
576
    for relative_url in object_keys:
577 578
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
579
      try:        
580
        container = portal.unrestrictedTraverse(container_path)
581
        if trash and trashbin is not None:
582 583 584 585
          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
586
        pass
587 588
    BaseTemplateItem.uninstall(self, context, **kw)

589 590 591 592 593 594 595 596 597 598 599 600
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

601 602 603 604 605 606 607 608 609
  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()
610 611
    object_keys.sort()
    object_keys.reverse()
612
    p = context.getPortalObject()
613 614
    object_keys.sort()
    object_keys.reverse()
615 616 617
    for path in object_keys:
      for relative_url in self._resolvePath(p, [], path.split('/')):
        try:        
Aurel's avatar
Aurel committed
618 619
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
620 621 622 623 624 625 626 627 628
          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)

629 630 631
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
632

633 634 635 636 637 638 639 640 641
      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.
642 643
      obj = folder._getOb(id)
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
644 645
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
646 647
      if object_id != "":
        path_list.extend(self._resolvePath(folder._getOb(object_id), relative_url_list + [object_id], id_list[1:]))
648
    return path_list
Aurel's avatar
Aurel committed
649

650 651 652
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
653 654 655
    keys = self._path_archive.keys()
    keys.sort()    
    for path in keys:
656 657 658
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
659
      for relative_url in self._resolvePath(p, [], path.split('/')):
660 661 662
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
        id_list = obj.objectIds()
663
        obj = self.removeProperties(obj)
664
        if hasattr(aq_base(obj), 'groups'):
665
          # we must keep groups because it's ereased when we delete subobjects
666
          groups = deepcopy(obj.groups)
667
        if len(id_list) > 0:
668 669
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
670
          obj.manage_delObjects(list(id_list))
671
        if hasattr(aq_base(obj), 'groups'):
672 673 674
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
675
      
676 677
class CategoryTemplateItem(ObjectTemplateItem):

678 679
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
680

681 682 683 684
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
685 686
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
687
      obj = self.removeProperties(obj)
688
      id_list = obj.objectIds()
689 690
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
691 692 693
        obj.manage_delObjects(list(id_list))
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
694 695 696 697 698

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

810

811 812
class SkinTemplateItem(ObjectTemplateItem):

813 814
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
815

816
  def install(self, context, trashbin, **kw):
817
    ObjectTemplateItem.install(self, context, trashbin, **kw)
818 819
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
820 821 822 823 824
    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)
825 826 827
      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]
828 829 830 831 832 833
    # 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
834
        if context.getTemplateFormatVersion() == 1:
835 836
          if update_dict.has_key(relative_url) or force:
            if not force:
837
              if update_dict[relative_url] == 'nothing':
838
                continue
839
          obj = self._objects[relative_url]
840
        else:
841
          obj = self._archive[relative_url]
842
        skin_id = relative_url.split('/')[-1]
843
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
844 845 846 847 848 849 850 851 852 853 854 855 856
        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)
857 858 859

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
860 861 862 863 864
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()    
865
    ps = context.portal_skins
866
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
867 868 869 870 871 872 873
    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)
874
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
875
    context.getPortalObject().changeSkin(None)
876 877 878
    ObjectTemplateItem.uninstall(self, context, **kw)


879
class WorkflowTemplateItem(ObjectTemplateItem):
880

881 882
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
883

884
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
885 886
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
      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
915
    if context.getTemplateFormatVersion() == 1:
916 917 918 919 920 921 922 923 924 925 926 927 928 929
      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:
930
            action = 'backup'
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
          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])
946
          obj = self._objects[path]
947 948 949
          if getattr(obj, 'meta_type', None) == 'Script (Python)':
            if getattr(obj, '_code') is None:
              obj._compile()
950 951 952 953 954
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
955 956 957 958 959
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)

  

960 961 962 963 964 965 966 967
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
968
    This is only useful in order to use
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
    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)

993 994
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
995 996 997
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
998 999
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1000 1001 1002
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
      id_list = obj.objectIds()
1003 1004 1005
      # remove actions and properties
      action_len = len(obj.listActions())
      obj.deleteActions(selections=range(action_len))
1006
      obj = self.removeProperties(obj)
1007 1008 1009 1010 1011 1012 1013 1014 1015
      # 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', ())
1016 1017
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
1018
    # also export workflow chain
1019
    (default_chain, chain_dict) = self._getChainByType(context)
1020 1021
    for obj in self._objects.values():
      portal_type = obj.id
1022 1023
      self._workflow_chain_archive[portal_type] = chain_dict['chain_%s' % portal_type]

Aurel's avatar
Aurel committed
1024 1025 1026 1027
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
1028
    # export portal type object
1029
    ObjectTemplateItem.export(self, context, bta, **kw)
1030 1031
    # export workflow chain
    xml_data = '<workflow_chain>'
1032 1033 1034
    keys = self._workflow_chain_archive.keys()
    keys.sort()
    for key in keys:
1035 1036 1037
      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],)
1038
      xml_data += os.linesep+' </chain>'
1039
    xml_data += os.linesep+'</workflow_chain>'
1040
    bta.addObject(obj=xml_data, name='workflow_chain_type',  path=root_path)
1041

1042 1043 1044 1045
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1046 1047 1048 1049 1050 1051
    # 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
1052
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1053
    if context.getTemplateFormatVersion() == 1:
1054
      object_list = self._objects
1055
    else:
1056 1057
      object_list = self._archive
    for path in object_list.keys():
1058 1059 1060 1061 1062
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
            continue          
1063 1064
        obj = object_list[path]
        portal_type = obj.id
1065 1066 1067 1068 1069
        chain_dict['chain_%s' % portal_type] = \
                              self._workflow_chain_archive[portal_type]
        context.portal_workflow.manage_changeWorkflows(default_chain,
                                                       props=chain_dict)

1070 1071 1072 1073 1074 1075 1076
  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:
1077
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1078 1079 1080 1081 1082
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1083
        dict[str(ptype)] = str(workflow)
1084 1085 1086 1087 1088
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)


1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
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):
1105
    dict = self._objects
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
    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)

1127 1128 1129 1130 1131 1132
  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':
1133
        #must rename keys in dict if reinstall
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
        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

1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 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
  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
1195
  def uninstall(self, context, **kw):
1196
    object_path = kw.get('object_path', None)
1197
    p = context.getPortalObject()
1198
    pt = p.unrestrictedTraverse('portal_types')
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
    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
1212 1213 1214
      for id in property_list:
        if id in original_property_list:
          original_property_list.remove(id)        
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
      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'

1232 1233
class CatalogMethodTemplateItem(ObjectTemplateItem):

1234 1235
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1236
    self._is_catalog_list_method_archive = PersistentMapping()
1237 1238 1239 1240 1241 1242 1243 1244 1245
    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)
1246 1247
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1248 1249
    except KeyError:
      catalog = None
1250
    if catalog is None:
1251
      LOG('BusinessTemplate build', 0, 'catalog not found')
1252
      return
1253 1254
    for obj in self._objects.values():
      method_id = obj.id
1255 1256 1257
      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
1258
      self._is_filtered_archive[method_id] = 0
1259 1260 1261 1262 1263
      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']
1264

Aurel's avatar
Aurel committed
1265 1266 1267 1268 1269
  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():
1270
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1271 1272 1273 1274 1275 1276
      # 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()
1277 1278
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1279 1280
      # add all datas specific to catalog inside one file
      catalog = context.portal_catalog.getSQLCatalog()
1281
      method_id = obj.id
1282 1283
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1284
      f = open(object_path, 'wt')
1285 1286 1287
      xml_data = '<catalog_method>'
      for method in catalog_method_list:
        value = getattr(self, method, 0)[method_id]
1288
        xml_data += os.linesep+' <item key="%s" type="int">' %(method,)
1289
        xml_data += os.linesep+'  <value>%s</value>' %(str(int(value)))
1290
        xml_data += os.linesep+' </item>'
Aurel's avatar
Aurel committed
1291
      if catalog.filter_dict.has_key(method_id):
1292 1293 1294
        for method in catalog_method_filter_list:
          value = getattr(self, method, '')[method_id]
          if method == '_filter_expression_instance_archive':
1295
            pass
1296
          else:
1297
            if type(value) in (type(''), type(u'')):
1298
              xml_data += os.linesep+' <item key="%s" type="str">' %(method,)
1299
              xml_data += os.linesep+'  <value>%s</value>' %(str(value))
1300
              xml_data += os.linesep+' </item>'
1301
            elif type(value) in (type(()), type([])):
1302
              xml_data += os.linesep+' <item key="%s" type="tuple">'%(method)
1303 1304
              for item in value:
                xml_data += os.linesep+'  <value>%s</value>' %(str(item))
1305
              xml_data += os.linesep+' </item>'
1306 1307
      xml_data += os.linesep+'</catalog_method>'
      f.write(str(xml_data))
Aurel's avatar
Aurel committed
1308
      f.close()
1309

1310 1311
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1312 1313
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1314
    except KeyError:
1315 1316 1317 1318 1319 1320 1321 1322
      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)
1323

1324 1325 1326
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1327
    new_bt_format = context.getTemplateFormatVersion()
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348

    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])
1349

1350 1351
    for obj in values:
      method_id = obj.id
1352

Aurel's avatar
Aurel committed
1353 1354 1355 1356
      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])
1357

1358 1359 1360 1361 1362
      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)

1363
      if is_uncatalog_method and method_id not in sql_uncatalog_object:
1364
        sql_uncatalog_object.append(method_id)
1365
      elif not is_uncatalog_method and method_id in sql_uncatalog_object:
1366 1367 1368 1369 1370 1371 1372 1373
        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:
1374
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1375
        if context.getTemplateFormatVersion() == 1:
1376 1377 1378
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1379
        filter_type = self._filter_type_archive[method_id]
1380 1381 1382
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1383
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1384
        catalog.filter_dict[method_id]['type'] = filter_type
1385
      elif method_id in catalog.filter_dict.keys():
1386
        catalog.filter_dict[method_id]['filtered'] = 0
1387

1388 1389
    sql_catalog_object_list.sort()
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
1390
    sql_uncatalog_object.sort()
1391
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
1392
    sql_clear_catalog.sort()
1393
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1394 1395

  def uninstall(self, context, **kw):
1396 1397
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1398
    except KeyError:
1399 1400 1401 1402
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1403
    
1404 1405 1406 1407
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
1408 1409 1410 1411
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
1412 1413 1414 1415
    else:
      value = self._archive[object_path]
      if value is not None:
        values.append(value)
1416 1417 1418 1419
    # 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)
1420

1421
    for obj in values:      
1422
      method_id = obj.id
1423 1424
      if method_id in sql_catalog_object_list:
        sql_catalog_object_list.remove(method_id)
1425 1426 1427 1428
      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
1429
      if catalog.filter_dict.has_key(method_id):
1430
        del catalog.filter_dict[method_id]
1431
        
1432 1433 1434
    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)
1435
    # uninstall objects
1436
    ObjectTemplateItem.uninstall(self, context, **kw)
1437

1438
  def _importFile(self, file_name, file):
1439
    if not '.catalog_keys' in file_name:
1440 1441 1442 1443 1444 1445 1446 1447
      # 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
1448
    elif '.catalog_keys' in file_name:
1449 1450 1451 1452
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1453
      method_list = xml.getElementsByTagName('item')
1454
      for method in method_list:
1455
        key = method.getAttribute('key')
1456 1457
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1458 1459
          value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          key = str(key)
1460
        elif key_type == "int":
1461
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1462
          key = str(key)
1463
        elif key_type == "tuple":
1464 1465 1466 1467
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1468
        else:
1469
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1470
          continue
1471 1472 1473
        if key in catalog_method_list or key in catalog_method_filter_list:
          dict = getattr(self, key)
          dict[id] = value
1474 1475

class ActionTemplateItem(ObjectTemplateItem):
1476 1477

  def __init__(self, id_list, **kw):
1478
    # XXX It's look like ObjectTemplateItem __init__
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
    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

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1489
      relative_url, value = id.split(' | ')
1490 1491
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1492
        if getattr(ai, 'id') == value:
1493
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1494
          key = os.path.join(url[-2], url[-1], value)
1495
          action = ai._getCopy(context)
1496
          action = self.removeProperties(action)
1497
          self._objects[key] = action
Aurel's avatar
Aurel committed
1498
          self._objects[key].wl_clearLocks()
1499 1500
          break
      else:
1501
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1502

1503 1504 1505
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1506
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1507 1508
      p = context.getPortalObject()
      for id in self._objects.keys():
1509 1510 1511 1512 1513 1514
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
1515 1516
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
1517 1518 1519
          for index in range(len(action_list)):
            if getattr(action_list[index], 'id') == path[-1]:          
              # remove previous action
1520
              obj.deleteActions(selections=(index,))
1521
          action = self._objects[id]
1522
          obj.addAction(
1523 1524 1525 1526 1527 1528 1529 1530 1531
                        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)
1532
                      , priority = action.priority
Aurel's avatar
Aurel committed
1533
                    )
1534
          # sort action based on the priority define on it
1535 1536 1537 1538 1539 1540 1541 1542 1543
          # 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
1544
    else:
1545
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1546
      p = context.getPortalObject()
1547 1548
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
1549
        relative_url, key, value = self._splitPath(id)
1550 1551
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
1552
          if getattr(ai, key) == value:
1553 1554
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
        obj.addAction(
Aurel's avatar
Aurel committed
1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
                      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
1565 1566 1567 1568 1569 1570 1571
        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))
1572 1573
          obj.moveDownActions(selections=tuple(move_down_list))

1574 1575 1576

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1577 1578 1579 1580 1581 1582 1583
    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:
1584
      relative_url, value = id.split(' | ')
1585 1586
      obj = p.unrestrictedTraverse(relative_url)
      action_list = obj.listActions()
1587
      for index in range(len(action_list)):
1588
        if getattr(action_list[index], 'id') == value:
1589
          obj.deleteActions(selections=(index,))
1590 1591 1592 1593 1594 1595 1596 1597 1598
          break
    BaseTemplateItem.uninstall(self, context, **kw)

class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
1599 1600
      for property in p.propertyMap():
        if property['id'] == id:
1601
          obj = p.getProperty(id)
1602
          prop_type = property['type']
1603 1604
          break
      else:
1605 1606
        obj = None
      if obj is None:
1607
        raise NotFound, 'the property %s is not found' % id
1608
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
1609

1610 1611 1612 1613 1614 1615
  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
1616 1617
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
1618 1619 1620 1621 1622 1623 1624
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
1625
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
1626
      self._objects[str(id)] = (str(prop_type), value)
1627

1628 1629 1630
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1631
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1632 1633
      p = context.getPortalObject()
      for path in self._objects.keys():
1634 1635 1636 1637 1638 1639 1640 1641
        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
1642 1643
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
1644
    else:
1645
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1646
      p = context.getPortalObject()
1647 1648
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
1649 1650 1651 1652 1653
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
1654 1655 1656

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1657 1658 1659 1660 1661 1662
    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:
1663 1664 1665 1666
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

1667
  def generateXml(self, path=None):
1668
    xml_data = ''
1669
    prop_type, obj = self._objects[path]
1670 1671
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
1672 1673
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
1674
      xml_data += os.linesep+'  <value>'
1675
      for item in obj:
1676 1677 1678 1679
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
1680
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
1681
    xml_data += os.linesep+' </property>'
1682 1683
    return xml_data

Aurel's avatar
Aurel committed
1684 1685 1686 1687 1688
  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)
1689 1690 1691 1692
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
1693
      xml_data += self.generateXml(path)
1694
    xml_data += os.linesep+'</site_property>'
1695
    bta.addObject(obj=xml_data, name='properties', path=root_path)
1696

1697 1698 1699 1700 1701 1702 1703
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)
1704 1705 1706 1707 1708 1709 1710 1711
      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
1712

1713
  def generateXml(self, path=None):
1714 1715
    dict = self._objects[path]
    xml_data = '<module>'
1716 1717 1718 1719
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
1720 1721 1722 1723 1724 1725 1726
      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
1727
          role_list = list(perm[1])
1728
          role_list.sort()
1729 1730 1731 1732 1733 1734 1735 1736 1737
          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

1738 1739 1740 1741 1742
  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)
1743 1744 1745
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
1746
      # expor module one by one
1747
      xml_data = self.generateXml(path=id)
1748
      bta.addObject(obj=xml_data, name=id, path=path)
1749

1750
  def install(self, context, trashbin, **kw):
1751
    portal = context.getPortalObject()
1752 1753
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1754
    if context.getTemplateFormatVersion() == 1:
1755
      items = self._objects
1756
    else:
1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779
      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
1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810

  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

1811
  def uninstall(self, context, **kw):
1812 1813 1814 1815 1816 1817 1818
    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]
1819 1820
    p = context.getPortalObject()
    id_list = p.objectIds()
1821
    for id in keys:
1822
      if id in id_list:
1823
        try:
1824
          if trash and trashbin is not None:
1825 1826
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
1827
          p.manage_delObjects([id])
1828
        except NotFound:
1829
          pass
1830 1831
    BaseTemplateItem.uninstall(self, context, **kw)

1832 1833 1834
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
1835 1836

class DocumentTemplateItem(BaseTemplateItem):
1837 1838 1839 1840
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
1841 1842 1843 1844

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

1847
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1848 1849
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869
      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
1870
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1871
      for id in self._objects.keys():
1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885
        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
1886
    else:
1887 1888 1889
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
1890
        # This raises an exception if the file exists.
1891
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
1892 1893
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
1894 1895

  def uninstall(self, context, **kw):
1896 1897 1898 1899 1900 1901
    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:
1902
      globals()[self.local_file_remover_name](id)
1903 1904
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
1905 1906 1907 1908 1909 1910
  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():
1911 1912
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
1913

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

1918 1919 1920 1921 1922 1923
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

1924

1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938
class ExtensionTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalExtension'
  local_file_writer_name = 'writeLocalExtension'
  # XXX is this method a error or ?
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalExtension'

class TestTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalTest'
  local_file_writer_name = 'writeLocalTest'
  # XXX is this a error ?
  local_file_importer_name = None
  local_file_remover_name = 'removeLocalTest'

Aurel's avatar
Aurel committed
1939

1940 1941 1942
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
1943 1944 1945

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
1946 1947 1948 1949
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
1950 1951
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
1952

1953
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1954 1955
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1956
      new_roles = self._objects.keys()
1957 1958 1959
      if installed_bt.id == 'installed_bt_for_diff':
        #must rename keys in dict if reinstall
        new_dict = PersistentMapping()
Aurel's avatar
Aurel committed
1960 1961 1962
        old_keys = ()
        if len(installed_bt._objects.values()) > 0:
          old_keys = installed_bt._objects.values()[0]
1963 1964 1965
        for key in old_keys:
          new_dict[key] = ''
        installed_bt._objects = new_dict      
1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978
      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):
1979
    p = context.getPortalObject()
1980
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1981
    if context.getTemplateFormatVersion() == 1:
1982
      role_list = self._objects.keys()
1983
    else:
1984
      role_list = self._archive.keys()
1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996
    # 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
1997
    for role in role_list:
1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
      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
2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019

  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)

2020 2021 2022 2023 2024 2025 2026 2027 2028
  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
2029
      if role in roles and role not in new_roles:
2030 2031 2032
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

2033
  def generateXml(self, path):
2034
    obj = self._objects[path]
2035
    xml_data = '<role_list>'
2036 2037
    obj.sort()
    for role in obj:
2038 2039 2040 2041
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

Aurel's avatar
Aurel committed
2042 2043 2044 2045 2046 2047
  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():
2048
      xml_data = self.generateXml(path=path)
2049
      bta.addObject(obj=xml_data, name=path, path=None,)
2050

2051 2052
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2053
  def build(self, context, **kw):
2054 2055
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2056
    except KeyError:
2057 2058 2059 2060
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2061
    sql_search_result_keys = list(catalog.sql_search_result_keys)
2062
    key_list = []
2063
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2064
      if key in sql_search_result_keys:
2065
        key_list.append(key)
Aurel's avatar
Aurel committed
2066 2067
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2068
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2069
      self._objects[self.__class__.__name__+os.sep+'result_key_list'] = key_list
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080

  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

2081
  def install(self, context, trashbin, **kw):
2082 2083 2084 2085 2086 2087 2088
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2089

2090
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2091
    if context.getTemplateFormatVersion() == 1:
2092 2093
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
2094 2095 2096
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2097
    else:
2098
      keys = self._archive.keys()
2099 2100
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2101
    # XXX same as related key
Aurel's avatar
Aurel committed
2102
    if update_dict.has_key('result_key_list') or force:
2103
      if not force:
Aurel's avatar
Aurel committed
2104
        action = update_dict['result_key_list']
2105
        if action == 'nothing':
Aurel's avatar
Aurel committed
2106
          return
2107
      for key in keys:
2108 2109
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
2110
      catalog.sql_search_result_keys = sql_search_result_keys
2111

2112
  def uninstall(self, context, **kw):
2113 2114
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2115
    except KeyError:
2116 2117 2118 2119 2120
      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)
2121 2122 2123 2124 2125 2126
    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:
2127 2128
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2129
    catalog.sql_search_result_keys = sql_search_result_keys
2130 2131
    BaseTemplateItem.uninstall(self, context, **kw)

2132
  def generateXml(self, path=None):
2133
    obj = self._objects[path]
2134
    xml_data = '<key_list>'
2135 2136
    obj.sort()
    for key in obj:
2137 2138 2139 2140
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2141 2142 2143 2144 2145
  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)
2146
    for path in self._objects.keys():
2147
      xml_data = self.generateXml(path=path)
2148
      bta.addObject(obj=xml_data, name=path, path=None)
2149

2150 2151
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2152
  def build(self, context, **kw):
2153 2154
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2155
    except KeyError:
2156 2157 2158 2159
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2160
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2161
    key_list = []
2162
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2163
      if key in sql_search_related_keys:
2164
        key_list.append(key)
Aurel's avatar
Aurel committed
2165 2166
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2167
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2168
      self._objects[self.__class__.__name__+os.sep+'related_key_list'] = key_list
2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179

  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

2180
  def install(self, context, trashbin, **kw):
2181 2182 2183 2184 2185 2186 2187
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2188

2189
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2190
    if context.getTemplateFormatVersion() == 1:
2191
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2192
        return
2193 2194 2195
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2196
    else:
2197
      keys = self._archive.keys()
2198 2199
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
2200
    # XXX must a find a better way to manage related key
Aurel's avatar
Aurel committed
2201
    if update_dict.has_key('related_key_list') or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
2202
      if not force:
Aurel's avatar
Aurel committed
2203 2204 2205 2206
        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
2207 2208 2209
        if action == 'nothing':
          return
      for key in keys:
2210 2211
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
Aurel's avatar
Aurel committed
2212
      catalog.sql_catalog_related_keys = tuple(sql_catalog_related_keys)
2213

2214 2215 2216
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2217
    except KeyError:
2218 2219 2220 2221
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2222
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2223 2224 2225 2226 2227 2228
    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:
2229 2230 2231 2232 2233
      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)

2234
  def generateXml(self, path=None):
2235
    obj = self._objects[path]
2236
    xml_data = '<key_list>'
2237 2238
    obj.sort()
    for key in obj:
2239 2240 2241 2242
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2243 2244 2245 2246 2247 2248
  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():
2249
      xml_data = self.generateXml(path=path)
2250
      bta.addObject(obj=xml_data, name=path, path=None)
2251

2252 2253
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2254
  def build(self, context, **kw):
2255 2256
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2257
    except KeyError:
2258 2259 2260 2261
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2262
    sql_search_result_tables = list(catalog.sql_search_tables)
2263
    key_list = []
2264
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2265
      if key in sql_search_result_tables:
2266
        key_list.append(key)
Aurel's avatar
Aurel committed
2267 2268
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2269
    if len(key_list) > 0:
Aurel's avatar
Aurel committed
2270
      self._objects[self.__class__.__name__+os.sep+'resutl_table_list'] = key_list
2271 2272 2273 2274 2275 2276 2277 2278 2279 2280

  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
2281

2282
  def install(self, context, trashbin, **kw):
2283 2284 2285 2286 2287 2288 2289
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2290

2291
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2292
    if context.getTemplateFormatVersion() == 1:
2293
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2294
        return
2295 2296 2297
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2298
    else:
2299
      keys = self._archive.keys()
2300 2301
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2302
    # XXX same as related keys
Aurel's avatar
Aurel committed
2303
    if update_dict.has_key('result_table_list') or force:
2304
      if not force:
Aurel's avatar
Aurel committed
2305
        action = update_dict['result_table_list']
2306
        if action == 'nothing':
Aurel's avatar
Aurel committed
2307
          return
2308
      for key in keys:
2309 2310
        if key not in sql_search_tables:
          sql_search_tables.append(key)
2311
      catalog.sql_search_tables = sql_search_tables
2312 2313

  def uninstall(self, context, **kw):
2314 2315
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2316
    except KeyError:
2317 2318 2319 2320 2321
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2322 2323 2324 2325 2326 2327
    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:
2328 2329
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2330
    catalog.sql_search_tables = sql_search_tables
2331 2332
    BaseTemplateItem.uninstall(self, context, **kw)

2333
  def generateXml(self, path=None):
2334
    obj = self._objects[path]
2335
    xml_data = '<key_list>'
2336 2337
    obj.sort()
    for key in obj:
2338 2339 2340 2341
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'    
    return xml_data

Aurel's avatar
Aurel committed
2342 2343 2344 2345 2346 2347
  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():
2348
      xml_data = self.generateXml(path=path)
2349
      bta.addObject(obj=xml_data, name=path, path=None)
2350 2351 2352
      
# keyword
class CatalogKeywordKeyTemplateItem(BaseTemplateItem):
2353 2354

  def build(self, context, **kw):
2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370
    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
2371

2372 2373 2374 2375 2376 2377 2378 2379 2380
  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
2381 2382

  def install(self, context, trashbin, **kw):
2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399
    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()
2400 2401
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424
    # 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
2425
    else:
2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440
      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
2441 2442 2443 2444

  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
2445 2446 2447 2448 2449
    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)
2450

2451 2452
# full text
class CatalogFullTextKeyTemplateItem(BaseTemplateItem):
2453

2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470
  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
2471

2472 2473 2474 2475 2476 2477 2478 2479 2480
  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
2481

2482 2483 2484 2485 2486 2487 2488 2489
  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
2490

2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511
    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
2512

2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 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
  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
2923
      f = open(path+os.sep+'translation.po', 'wt')
2924 2925 2926 2927 2928 2929 2930
      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
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
class LocalRolesTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
      obj = p.unrestrictedTraverse(path)
      local_roles_dict = getattr(obj, '__ac_local_roles__', {})
      group_local_roles_dict = getattr(obj, '__ac_local_group_roles__', {})
      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 = []
      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))    
      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__', {})
    
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
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
3064
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3065

3066 3067
    - document/propertysheet/extension/test definition
      - copy of the local file
3068

3069
    - message transalation definition
3070
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3071

3072 3073
    The Business Template properties are exported to the bt folder with
    one property per file
3074

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3075 3076
    Technology:

3077 3078
    - 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
3079

3080
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3081 3082 3083 3084

    Use case:

    - install core ERP5 (the minimum)
3085

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

3088 3089
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
3090
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3091 3092 3093 3094 3095
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
3096
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3097 3098 3099 3100 3101
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
3102
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3103 3104 3105 3106 3107 3108 3109

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
3110
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3111
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3112
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3113 3114 3115
                      , PropertySheet.BusinessTemplate
                      )

3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132
    # 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
      }

3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146
    # This is a global variable
    # Order is important for installation
    _item_name_list = [
      '_product_item',
      '_property_sheet_item',
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
      '_message_translation_item',
      '_workflow_item',
      '_catalog_method_item',
      '_site_property_item',
      '_portal_type_item',
3147 3148 3149 3150
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
3151 3152 3153
      '_category_item',
      '_module_item',
      '_skin_item',
3154
      '_path_item',
3155
      '_action_item',
Aurel's avatar
Aurel committed
3156
      '_local_roles_item', 
3157 3158 3159
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
3160 3161 3162 3163 3164
      '_catalog_keyword_key_item',
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
3165 3166 3167 3168
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3169 3170 3171 3172 3173 3174
      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
3175
        self._baseGetTemplateFormatVersion()
3176

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3177 3178 3179
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
3180
      
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3181 3182
      return 0
        
3183
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
3184 3185 3186 3187 3188 3189 3190
    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".
3191 3192
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
3193
          # XXX Not good to access the attribute directly,
3194 3195 3196
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
3197

3198
    security.declareProtected(Permissions.ManagePortal, 'build')
3199
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3200 3201 3202
      """
        Copy existing portal objects to self
      """
3203 3204
      if no_action: return # this is use at import of Business Template to get the status built
      
3205 3206
      # Make sure that everything is sane.
      self.clean()
3207

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3208 3209 3210
      # Set the format version.
      self._setTemplateFormatVersion(1)

3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251
      # 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())
      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())
      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())
3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263
      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())
3264 3265
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280
      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
3281 3282 3283 3284
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
            
3285 3286 3287
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
3288

3289
    build = WorkflowMethod(build)
3290 3291

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3292
      """
3293
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3294
      """
3295
      return self.portal_templates.publish(self, url, username=username,
3296
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3297

3298
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3299
      """
3300
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3301
      """
3302
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3303

3304 3305 3306 3307
    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
3308 3309
      """
                
3310 3311
      modified_object_list = {}
      bt_title = self.getTitle()
3312 3313 3314 3315 3316 3317 3318

      #  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)
3319 3320 3321
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3322
        installed_bt_format = installed_bt.getTemplateFormatVersion()
3323

3324
      # if reinstall business template, must compare to object in ZODB
3325 3326 3327
      # 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      
3328 3329
      if installed_bt == self:
        reinstall = 1
3330 3331 3332
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, id='installed_bt_for_diff')
        # update portal types properties to get last modifications
        bt2.getPortalTypesProperties()
3333 3334 3335 3336
        bt2.edit(description='tmp bt generated for diff')
        bt2.build()
        installed_bt = bt2
      
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3337
      new_bt_format = self.getTemplateFormatVersion()
3338 3339 3340 3341 3342 3343
      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:
3344
          item = getattr(self, item_name, None)
3345 3346 3347 3348
          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
3349

3350 3351 3352 3353
      # 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:
3354
        new_item = getattr(self, item_name, None)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3355
        old_item = getattr(installed_bt, item_name, None)
3356
        if new_item is not None:
3357
          if old_item is not None:
3358
            LOG('compare object item', 0, item_name)
3359 3360 3361 3362 3363 3364 3365 3366
            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:
3367
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
3368
      
3369 3370 3371 3372 3373 3374 3375
      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
      """
3376 3377
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
3378
      if installed_bt is not None:        
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3379
        if installed_bt.getTemplateFormatVersion() == 0:
3380 3381 3382
          # maybe another to uninstall old format bt, maybe not needed
          installed_bt.trash(self)
          force = 1
3383
        installed_bt.replace(self)
3384
        
3385 3386 3387 3388 3389 3390 3391 3392
      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')
        gen.setupLastTools(site, update=1, create_activities=1)
             
3393 3394
      if not force:
        if len(object_to_update) == 0:
3395 3396 3397 3398 3399
          # 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():
3400
            LOG('Business Template', 0, 'Updating Business Template Workflows')
3401
            gen.setupWorkflow(site)
3402
          return
3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431

      # 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)
      if catalog_method is not None:
        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()
              
3432 3433
      # 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
3434
      trash_tool = getToolByName(self, 'portal_trash', None)
3435
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates.objectIds()) > 1):
3436
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
3437 3438
      else:
        trashbin = None
3439
              
3440 3441 3442 3443 3444 3445 3446
      # 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)

3447
      # get objects to remove
3448
      # do remove after because we may need backup object from installation
3449 3450 3451 3452 3453 3454 3455 3456 3457
      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:
3458
          item = getattr(installed_bt, item_name, None)
3459 3460
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
3461

3462 3463 3464 3465 3466 3467 3468 3469

      # 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():
3470
        LOG('Business Template', 0, 'Updating Business Template Workflows')
3471 3472 3473 3474 3475 3476 3477 3478
        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
3479 3480 3481
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
3482

3483
    security.declareProtected(Permissions.ManagePortal, 'install')
3484 3485 3486 3487 3488
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
      """
      return self._install(**kw)
3489

3490
    install = WorkflowMethod(install)
3491

3492
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
3493
    def reinstall(self, **kw):
3494 3495 3496 3497
      """Reinstall Business Template.
      """
      return self._install(**kw)

3498
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3499

3500
    security.declareProtected(Permissions.ManagePortal, 'trash')
3501 3502
    def trash(self, new_bt, **kw):
      """
3503
        Trash unnecessary items before upgrading to a new business
3504
        template.
3505
        This is similar to uninstall, but different in that this does
3506
        not remove all items.
3507 3508 3509 3510 3511
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3512 3513
      # Trash everything
      for item_name in self._item_name_list[::-1]:
3514
        item = getattr(self, item_name, None)
3515 3516 3517 3518
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
3519

3520
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
3521
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3522
      """
3523
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3524
      """
3525 3526 3527 3528
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
3529 3530 3531
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
3532
        item = getattr(self, item_name, None)
3533 3534
        if item is not None:
          item.uninstall(local_configuration)
3535
      # It is better to clear cache because the uninstallation of a
3536
      # template deletes many things from the portal.
3537
      clearCache()
3538

3539 3540
    uninstall = WorkflowMethod(uninstall)

3541
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3542
    def _clean(self):
3543
      """
3544
        Clean built information.
3545
      """
3546
      # First, remove obsolete attributes if present.
3547 3548 3549 3550
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
3551
                    '_module_archive',
3552 3553 3554
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
3555
                    '_property_sheet_archive'):
3556 3557 3558
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
3559 3560
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
3561

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

3564
    security.declareProtected(Permissions.AccessContentsInformation,
3565
                              'getBuildingState')
3566
    def getBuildingState(self, id_only=1):
3567
      """
3568
        Returns the current state in building
3569
      """
3570
      portal_workflow = getToolByName(self, 'portal_workflow')
3571 3572
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
3573
      return wf._getWorkflowStateOf(self, id_only=id_only )
3574

3575
    security.declareProtected(Permissions.AccessContentsInformation,
3576
                              'getInstallationState')
3577
    def getInstallationState(self, id_only=1):
3578
      """
3579
        Returns the current state in installation
3580
      """
3581
      portal_workflow = getToolByName(self, 'portal_workflow')
3582 3583
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
3584
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3585

Yoshinori Okuji's avatar
Yoshinori Okuji committed
3586 3587 3588 3589 3590 3591
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
3592
      export_string = portal_templates.manage_exportObject(
3593 3594
                                               id=self.getId(),
                                               toxml=1,
3595
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3596
      return export_string
3597

3598
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3599
      """
3600 3601
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3602
      """
3603
      result = getattr(self, id, ())
3604 3605 3606 3607 3608 3609
      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
3610

3611
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3612
      """
3613 3614
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3615
      """
3616
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3617

3618
    def getTemplateBaseCategoryList(self):
3619
      """
3620 3621
      We have to set this method because we want an
      ordered list
3622
      """
3623
      return self._getOrderedList('template_base_category')
3624

3625
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3626
      """
3627 3628
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3629
      """
3630
      return self._getOrderedList('template_workflow_id')
3631

3632
    def getTemplatePortalTypeIdList(self):
3633
      """
3634 3635
      We have to set this method because we want an
      ordered list
3636
      """
3637
      return self._getOrderedList('template_portal_type_id')
3638

3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666
    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')

3667
    def getTemplateActionPathList(self):
3668
      """
3669 3670
      We have to set this method because we want an
      ordered list
3671
      """
3672
      return self._getOrderedList('template_action_path')
3673

3674
    def getTemplateSkinIdList(self):
3675
      """
3676 3677
      We have to set this method because we want an
      ordered list
3678
      """
3679
      return self._getOrderedList('template_skin_id')
3680

3681
    def getTemplateModuleIdList(self):
3682
      """
3683 3684
      We have to set this method because we want an
      ordered list
3685
      """
3686
      return self._getOrderedList('template_module_id')
3687 3688 3689 3690 3691 3692 3693

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

3695
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
3696 3697 3698 3699
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
3700 3701
      if self.getBuildingState() != 'built':
        raise TemplateConditionError, 'Business Template must be build before export'
3702
      
Aurel's avatar
Aurel committed
3703 3704 3705 3706 3707 3708 3709
      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)

3710
      # export bt
3711
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
3712
      for prop in self.propertyMap():
3713
        prop_type = prop['type']
Aurel's avatar
Aurel committed
3714
        id = prop['id']
3715
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id', 'install_object_list_list'):
3716
          continue
Aurel's avatar
Aurel committed
3717 3718
        if id in ('template_update_business_template_workflow', 'template_update_tool') and self.getTitle() != 'erp5_core':
          continue
Aurel's avatar
Aurel committed
3719
        value = self.getProperty(id)
3720
        if prop_type in ('text', 'string', 'int', 'boolean'):
3721
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
3722
        elif prop_type in ('lines', 'tokens'):
3723
          bta.addObject(obj=str(os.linesep).join(value), name=id, path=path+os.sep+'bt', ext='')
3724

Aurel's avatar
Aurel committed
3725 3726 3727
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
3728
        
Aurel's avatar
Aurel committed
3729 3730
      return bta.finishCreation()

3731
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
3732 3733
    def importFile(self, dir = 0, file=None, root_path=None):
      """
3734
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
3735 3736 3737 3738 3739
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
3740

Aurel's avatar
Aurel committed
3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782
      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())
      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())
      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())
3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809
      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
3810 3811 3812
      self._local_roles_item = \
          LocalRolesTemplateItem(
               self.getTemplateLocalRolesList())
3813
      
Aurel's avatar
Aurel committed
3814 3815
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
3816 3817


Aurel's avatar
Aurel committed
3818
    def diffObject(self, REQUEST, **kw):
3819 3820
      """
        Make a diff between an object in the Business Template
3821
        and the same in the Business Template installed in the site
3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835
      """

      class_name_dict = {
        'Product' : '_product_item',
        'PropertySheet' : '_property_sheet_item', 
        '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',
3836 3837 3838 3839
        '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',
3840 3841 3842 3843 3844
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
        'Action' : '_action_item',
Aurel's avatar
Aurel committed
3845
        'LocalRoles' : '_local_roles_item',
3846 3847 3848
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
3849 3850 3851 3852 3853
        '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',
3854 3855 3856 3857 3858 3859
        }

      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
      # get objects
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
3860

Aurel's avatar
Aurel committed
3861
      new_bt =self
Aurel's avatar
Aurel committed
3862
      # compare with a given business template
3863
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
3864 3865
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
3866 3867 3868 3869
        if bt2_id == self.getId():
          compare_to_zodb = 1
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
3870 3871 3872
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
3873 3874 3875 3876 3877 3878 3879 3880
          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
        
3881 3882
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
3883
      if compare_to_zodb:
Aurel's avatar
Aurel committed
3884
        # XXX maybe only build for the given object to gain time
3885
        installed_item.build(self)
3886 3887 3888 3889
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      # make diff
      diff_msg = ''
3890 3891 3892 3893 3894 3895
      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',
Aurel's avatar
Aurel committed
3896
                     '_portal_type_property_sheet_item', '_portal_type_base_category_item', '_local_roles_item']
3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914
      item_list_3 = ['_document_item', '_property_sheet_item', '_extension_item', '_test_item', '_message_translation_item']
      if item_name in item_list_1:
        f1 = StringIO()
        f2 = StringIO()
        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
3915
          
3916
      elif item_name in item_list_2:
3917 3918
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
3919 3920 3921 3922 3923 3924 3925 3926
        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
3927
          
3928 3929 3930 3931 3932 3933 3934 3935 3936
      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'                
3937 3938 3939

      if compare_to_zodb:
        self.portal_templates.manage_delObjects(ids=['installed_bt_for_diff'])
3940 3941 3942
      
      return diff_msg

3943 3944 3945 3946 3947 3948 3949 3950 3951
    
    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 = []
3952
      bt_action_list = []
3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964
      
      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 = []
3965
        action_list = []
3966 3967 3968 3969 3970 3971 3972 3973
        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       
3974 3975 3976
        if hasattr(portal_type, 'listActions'):
          action_list = [x.getId() for x in portal_type.listActions()]
        
3977 3978 3979 3980 3981 3982 3983 3984
        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)
3985 3986 3987
        for act_id in action_list:            
          bt_action_list.append(id+' | '+act_id)
          
3988 3989 3990 3991
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
3992
      bt_action_list.sort()
3993 3994 3995 3996

      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)
3997 3998
      setattr(self, 'template_portal_type_base_category', bt_base_category_list)
      setattr(self, 'template_action_path', bt_action_list)  
3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119
      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