BusinessTemplate.py 112 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 163 164 165
    for file_path in self.file_list:
      if class_name in file_path:
        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
Aurel's avatar
Aurel committed
230 231 232
      if class_name in info.name:
        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 266 267 268
      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
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
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
318
  """
319

320 321 322 323
  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()
324
      self._archive.clear()
325 326 327
      for id in id_list:
        self._archive["%s/%s" % (tool_id, id)] = None

328 329 330 331 332
  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():
333
      obj = self._objects[key]
334 335
      # create folder and subfolders
      folders, id = os.path.split(key)
Aurel's avatar
Aurel committed
336 337 338 339 340 341 342
      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))
343 344 345
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
346 347
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
348

Aurel's avatar
Aurel committed
349 350 351 352
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
353
      relative_url = '/'.join([url,id])
354 355 356 357
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
      id_list = obj.objectIds()
      if hasattr(obj, '__ac_local_roles__'):
358
        # remove local roles
359 360 361
        obj.__ac_local_roles__ = None
      if hasattr(obj, '_owner'):
        obj._owner = None
362
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
363
        # we must keep groups because it's ereased when we delete subobjects
364
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
365 366
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
367 368 369
        obj.manage_delObjects(list(id_list))
      if hasattr(aq_base(obj), 'uid'):
        obj.uid = None
370
      if hasattr(aq_base(obj), 'groups'):
371 372 373
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
374 375
    return sub_list

376 377 378 379
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
380 381 382 383
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
      id_list = obj.objectIds()
      if hasattr(obj, '__ac_local_roles__'):
384
        # remove local roles
385 386 387
        obj.__ac_local_roles__ = None
      if hasattr(obj, '_owner'):
        obj._owner = None
388
      if hasattr(aq_base(obj), 'groups'):
Aurel's avatar
Aurel committed
389
        # we must keep groups because it's ereased when we delete subobjects
390
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
391 392
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
393 394 395
        obj.manage_delObjects(list(id_list))
      if hasattr(aq_base(obj), 'uid'):
        obj.uid = None
396
      if hasattr(aq_base(obj), 'groups'):
397 398 399
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
400

401 402 403 404 405 406 407 408 409 410
  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

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

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

586 587 588 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

  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
601

602 603 604 605 606 607 608 609 610
      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.
611 612
      obj = folder._getOb(id)
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
613 614 615 616
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
      path_list.extend(self._resolvePath(folder._getOb(object_id), relative_url_list + [object_id], id_list[1:]))
    return path_list
Aurel's avatar
Aurel committed
617

618 619 620
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
621 622 623
    keys = self._path_archive.keys()
    keys.sort()    
    for path in keys:
624 625 626
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
627
      for relative_url in self._resolvePath(p, [], path.split('/')):
628 629 630 631
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
        id_list = obj.objectIds()
        if hasattr(obj, '__ac_local_roles__'):
632
          # remove local roles
633 634 635
          obj.__ac_local_roles__ = None
        if hasattr(obj, '_owner'):
          obj._owner = None
636
        if hasattr(aq_base(obj), 'uid'):
637
          obj.uid = None
638
        if hasattr(aq_base(obj), 'groups'):
639
          # we must keep groups because it's ereased when we delete subobjects
640
          groups = deepcopy(obj.groups)
641
        if len(id_list) > 0:
642 643
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
644
          obj.manage_delObjects(list(id_list))
645
        if hasattr(aq_base(obj), 'groups'):
646 647 648
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
649
      
650 651
class CategoryTemplateItem(ObjectTemplateItem):

652 653
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
654

655 656 657 658
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
659 660 661
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
      if hasattr(obj, '__ac_local_roles__'):
662
        # remove local roles
663 664 665 666
        obj.__ac_local_roles__ = None
      if hasattr(obj, '_owner'):
        obj._owner = None
      id_list = obj.objectIds()
667 668
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
669 670 671 672 673
        obj.manage_delObjects(list(id_list))
      if hasattr(aq_base(obj), 'uid'):
        obj.uid = None
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
674 675 676 677 678

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

796

797 798
class SkinTemplateItem(ObjectTemplateItem):

799 800
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
801

802
  def install(self, context, trashbin, **kw):
803
    ObjectTemplateItem.install(self, context, trashbin, **kw)
804 805
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
806 807 808 809 810
    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)
811 812 813
      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]
814 815 816 817 818 819
    # 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
820
        if context.getTemplateFormatVersion() == 1:
821 822
          if update_dict.has_key(relative_url) or force:
            if not force:
823
              if update_dict[relative_url] == 'nothing':
824
                continue
825
          obj = self._objects[relative_url]
826
        else:
827
          obj = self._archive[relative_url]
828
        skin_id = relative_url.split('/')[-1]
829
        selection_list = obj.getProperty('business_template_registered_skin_selections', None)
830 831 832 833 834 835 836 837 838 839 840 841 842
        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)
843 844 845

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
846 847 848 849 850
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()    
851
    ps = context.portal_skins
852
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
853 854 855 856 857 858 859
    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)
860
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
861
    context.getPortalObject().changeSkin(None)
862 863 864
    ObjectTemplateItem.uninstall(self, context, **kw)


865
class WorkflowTemplateItem(ObjectTemplateItem):
866

867 868
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
869

870
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
871 872
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
      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
901
    if context.getTemplateFormatVersion() == 1:
902 903 904 905 906 907 908 909 910 911 912 913 914 915
      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:
916
            action = 'backup'
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
          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])
932 933 934 935 936 937
          obj = self._objects[path]
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
938 939 940 941 942
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)

  

943 944 945 946 947 948 949 950
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
951
    This is only useful in order to use
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
    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)

976 977
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
978 979 980
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
981 982
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
983 984 985
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
      id_list = obj.objectIds()
Aurel's avatar
Aurel committed
986
      # remove optional actions
987
      optional_action_list = []
988
      for index,ai in enumerate(obj.listActions()):
989 990 991
        if ai.getOption():
          optional_action_list.append(index)
      if len(optional_action_list) > 0:
992 993
        obj.deleteActions(selections=optional_action_list)
      if hasattr(obj, '__ac_local_roles__'):
994
        # remove local roles
995 996 997
        obj.__ac_local_roles__ = None
      if hasattr(obj, '_owner'):
        obj._owner = None
998
      if hasattr(aq_base(obj), 'uid'):
999 1000 1001
        obj.uid = None
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
1002
    # also export workflow chain
1003
    (default_chain, chain_dict) = self._getChainByType(context)
1004 1005
    for obj in self._objects.values():
      portal_type = obj.id
1006 1007
      self._workflow_chain_archive[portal_type] = chain_dict['chain_%s' % portal_type]

Aurel's avatar
Aurel committed
1008 1009 1010 1011
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
1012
    # export portal type object
1013
    ObjectTemplateItem.export(self, context, bta, **kw)
1014 1015
    # export workflow chain
    xml_data = '<workflow_chain>'
1016 1017 1018
    keys = self._workflow_chain_archive.keys()
    keys.sort()
    for key in keys:
1019 1020 1021
      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],)
1022
      xml_data += os.linesep+' </chain>'
1023
    xml_data += os.linesep+'</workflow_chain>'
1024
    bta.addObject(obj=xml_data, name='workflow_chain_type',  path=root_path)
1025

1026 1027 1028 1029
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1030 1031 1032 1033 1034 1035
    # 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
1036
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1037
    if context.getTemplateFormatVersion() == 1:
1038
      object_list = self._objects
1039
    else:
1040 1041
      object_list = self._archive
    for path in object_list.keys():
1042 1043 1044 1045 1046
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
            continue          
1047 1048
        obj = object_list[path]
        portal_type = obj.id
1049 1050 1051 1052 1053 1054
        chain_dict['chain_%s' % portal_type] = \
                              self._workflow_chain_archive[portal_type]
        context.portal_workflow.manage_changeWorkflows(default_chain,
                                                       props=chain_dict)

  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
1055 1056 1057
    """
      Backup portal type and keep the workflow chain.
    """
1058
    subobjects_dict = {}
1059 1060
    # XXX btsave is for backward compatibility
    if action == 'backup' or action == 'btsave':
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
      # Get the chain value
#       (default_chain, chain_dict) = self._getChainByType(self)
#       chain = chain_dict['chain_%s' % object_id]
      # Backup the portal type    
      subobjects_dict = ObjectTemplateItem._backupObject(self, action, trashbin, container_path,
                                                        object_id, **kw)
    return subobjects_dict
      # Restore the chain to the backuped portal type
#       (default_chain, chain_dict) = self._getChainByType(self)
#       chain_dict['chain_%s' % backup_id] = chain
#       self.portal_workflow.manage_changeWorkflows(default_chain,
#                                                   props=chain_dict)
1073

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


1093 1094
class CatalogMethodTemplateItem(ObjectTemplateItem):

1095 1096
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
Aurel's avatar
Aurel committed
1097
#     self._is_catalog_method_archive = PersistentMapping()
1098
    self._is_catalog_list_method_archive = PersistentMapping()
1099
    self._is_uncatalog_method_archive = PersistentMapping()
Aurel's avatar
Aurel committed
1100
#     self._is_update_method_archive = PersistentMapping()
1101 1102 1103 1104 1105 1106 1107 1108
    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)
1109 1110
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1111 1112
    except KeyError:
      catalog = None
1113
    if catalog is None:
1114
      LOG('BusinessTemplate build', 0, 'catalog not found')
1115
      return
1116 1117
    for obj in self._objects.values():
      method_id = obj.id
Aurel's avatar
Aurel committed
1118
#       self._is_catalog_method_archive[method_id] = method_id in catalog.sql_catalog_object
1119 1120
      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
Aurel's avatar
Aurel committed
1121
#       self._is_update_method_archive[method_id] = method_id in catalog.sql_update_object
1122
      self._is_clear_method_archive[method_id] = method_id in catalog.sql_clear_catalog
1123
      self._is_filtered_archive[method_id] = 0
1124 1125 1126 1127 1128
      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']
1129

Aurel's avatar
Aurel committed
1130 1131 1132 1133 1134
  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():
1135
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1136 1137 1138 1139 1140 1141
      # 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()
1142 1143
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1144 1145
      # add all datas specific to catalog inside one file
      catalog = context.portal_catalog.getSQLCatalog()
1146
      method_id = obj.id
1147 1148
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1149
      f = open(object_path, 'wt')
1150 1151 1152
      xml_data = '<catalog_method>'
      for method in catalog_method_list:
        value = getattr(self, method, 0)[method_id]
1153
        xml_data += os.linesep+' <item key="%s" type="int">' %(method,)
1154
        xml_data += os.linesep+'  <value>%s</value>' %(str(int(value)))
1155
        xml_data += os.linesep+' </item>'
Aurel's avatar
Aurel committed
1156
      if catalog.filter_dict.has_key(method_id):
1157 1158 1159
        for method in catalog_method_filter_list:
          value = getattr(self, method, '')[method_id]
          if method == '_filter_expression_instance_archive':
1160
            pass
1161
          else:
1162
            if type(value) in (type(''), type(u'')):
1163
              xml_data += os.linesep+' <item key="%s" type="str">' %(method,)
1164
              xml_data += os.linesep+'  <value>%s</value>' %(str(value))
1165
              xml_data += os.linesep+' </item>'
1166
            elif type(value) in (type(()), type([])):
1167
              xml_data += os.linesep+' <item key="%s" type="tuple">'%(method)
1168 1169
              for item in value:
                xml_data += os.linesep+'  <value>%s</value>' %(str(item))
1170
              xml_data += os.linesep+' </item>'
1171 1172
      xml_data += os.linesep+'</catalog_method>'
      f.write(str(xml_data))
Aurel's avatar
Aurel committed
1173
      f.close()
1174

1175 1176
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1177 1178
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1179
    except KeyError:
1180 1181 1182 1183 1184
      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.
Aurel's avatar
Aurel committed
1185
#     sql_catalog_object = list(catalog.sql_catalog_object)
1186 1187
    sql_catalog_object_list = list(catalog.sql_catalog_object_list)
    sql_uncatalog_object = list(catalog.sql_uncatalog_object)
Aurel's avatar
Aurel committed
1188
#     sql_update_object = list(catalog.sql_update_object)
1189
    sql_clear_catalog = list(catalog.sql_clear_catalog)
1190

1191 1192 1193
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1194
    new_bt_format = context.getTemplateFormatVersion()
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216

    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])
          
1217 1218
    for obj in values:
      method_id = obj.id
1219

Aurel's avatar
Aurel committed
1220
#       is_catalog_method = int(self._is_catalog_method_archive[method_id])
Aurel's avatar
Aurel committed
1221 1222
      is_catalog_list_method = int(self._is_catalog_list_method_archive[method_id])
      is_uncatalog_method = int(self._is_uncatalog_method_archive[method_id])
Aurel's avatar
Aurel committed
1223
#       is_update_method = int(self._is_update_method_archive[method_id])
Aurel's avatar
Aurel committed
1224 1225
      is_clear_method = int(self._is_clear_method_archive[method_id])
      is_filtered = int(self._is_filtered_archive[method_id])
1226

Aurel's avatar
Aurel committed
1227 1228 1229 1230
#       if is_catalog_method and method_id not in sql_catalog_object:
#         sql_catalog_object.append(method_id)
#       elif not is_catalog_method and method_id in sql_catalog_object:
#         sql_catalog_object.remove(method_id)
1231

1232 1233 1234 1235 1236
      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)

1237
      if is_uncatalog_method and method_id not in sql_uncatalog_object:
1238
        sql_uncatalog_object.append(method_id)
1239
      elif not is_uncatalog_method and method_id in sql_uncatalog_object:
1240 1241
        sql_uncatalog_object.remove(method_id)

Aurel's avatar
Aurel committed
1242 1243 1244 1245
#       if is_update_method and method_id not in sql_update_object:
#         sql_update_object.append(method_id)
#       elif not is_update_method and method_id in sql_update_object:
#         sql_update_object.remove(method_id)
1246 1247 1248 1249 1250 1251 1252

      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:
1253
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1254
        if context.getTemplateFormatVersion() == 1:
1255 1256 1257
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1258
        filter_type = self._filter_type_archive[method_id]
1259 1260 1261
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1262
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1263
        catalog.filter_dict[method_id]['type'] = filter_type
1264
      elif method_id in catalog.filter_dict.keys():
1265
        catalog.filter_dict[method_id]['filtered'] = 0
1266

Aurel's avatar
Aurel committed
1267 1268
#     sql_catalog_object.sort()
#     catalog.sql_catalog_object = tuple(sql_catalog_object)
1269 1270
    sql_catalog_object_list.sort()
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
1271
    sql_uncatalog_object.sort()
1272
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
Aurel's avatar
Aurel committed
1273 1274
#     sql_update_object.sort()
#     catalog.sql_update_object = tuple(sql_update_object)
1275
    sql_clear_catalog.sort()
1276
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1277 1278

  def uninstall(self, context, **kw):
1279

1280
    ObjectTemplateItem.uninstall(self, context, **kw)
1281 1282
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1283
    except KeyError:
1284 1285 1286 1287 1288 1289
      catalog = None

    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return

1290 1291 1292 1293 1294 1295 1296 1297
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
      values = self._archive.values()
    else:      
      values.append(self._archive[object_path])

1298
    # Make copies of attributes of the default catalog of portal_catalog.
Aurel's avatar
Aurel committed
1299
#     sql_catalog_object = list(catalog.sql_catalog_object)
1300 1301
    sql_catalog_object_list = list(catalog.sql_catalog_object_list)
    sql_uncatalog_object = list(catalog.sql_uncatalog_object)
Aurel's avatar
Aurel committed
1302
#     sql_update_object = list(catalog.sql_update_object)
1303
    sql_clear_catalog = list(catalog.sql_clear_catalog)
1304

1305 1306
    for obj in values:
      method_id = obj.id
1307

Aurel's avatar
Aurel committed
1308 1309
#       if method_id in sql_catalog_object:
#         sql_catalog_object.remove(method_id)
1310

1311 1312 1313
      if method_id in sql_catalog_object_list:
        sql_catalog_object_list.remove(method_id)

1314 1315 1316
      if method_id in sql_uncatalog_object:
        sql_uncatalog_object.remove(method_id)

Aurel's avatar
Aurel committed
1317 1318
#       if method_id in sql_update_object:
#         sql_update_object.remove(method_id)
1319 1320 1321 1322

      if method_id in sql_clear_catalog:
        sql_clear_catalog.remove(method_id)

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1323
      if catalog.filter_dict.has_key(method_id):
1324
        del catalog.filter_dict[method_id]
1325

Aurel's avatar
Aurel committed
1326
#     catalog.sql_catalog_object = tuple(sql_catalog_object)
1327 1328
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
Aurel's avatar
Aurel committed
1329
#     catalog.sql_update_object = tuple(sql_update_object)
1330
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1331 1332

    ObjectTemplateItem.uninstall(self, context, **kw)
1333

1334
  def _importFile(self, file_name, file):
1335
    if not '.catalog_keys' in file_name:
1336 1337 1338 1339 1340 1341 1342 1343
      # 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
1344
    elif '.catalog_keys' in file_name:
1345 1346 1347 1348
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1349
      method_list = xml.getElementsByTagName('item')
1350
      for method in method_list:
1351
        key = method.getAttribute('key')
1352 1353
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1354 1355
          value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          key = str(key)
1356
        elif key_type == "int":
1357
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1358
          key = str(key)
1359
        elif key_type == "tuple":
1360 1361 1362 1363
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1364
        else:
1365
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1366
          continue
1367 1368 1369 1370
        dict = getattr(self, key)
        dict[id] = value

class ActionTemplateItem(ObjectTemplateItem):
1371 1372 1373 1374

  def _splitPath(self, path):
    """
      Split path tries to split a complexe path such as:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1375

1376
      "foo/bar[id=zoo]"
1377

1378
      into
1379

1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393
      "foo/bar", "id", "zoo"

      This is used mostly for generic objects
    """
    # Add error checking here
    if path.find('[') >= 0 and path.find(']') > path.find('=') and path.find('=') > path.find('['):
      relative_url = path[0:path.find('[')]
      id_block = path[path.find('[')+1:path.find(']')]
      key = id_block.split('=')[0]
      value = id_block.split('=')[1]
      return relative_url, key, value
    return path, None, None

  def __init__(self, id_list, **kw):
1394
    # XXX It's look like ObjectTemplateItem __init__
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
    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():
      relative_url, key, value = self._splitPath(id)
1406 1407
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1408
        if getattr(ai, key) == value:
1409
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1410
          key = os.path.join(url[-2], url[-1], value)
1411 1412
          action = ai._getCopy(context)
          if hasattr(action, '__ac_local_roles__'):
1413
            # remove local roles
1414 1415 1416
            action.__ac_local_roles__ = None
          if hasattr(action, '_owner'):
            action._owner = None
1417
          if hasattr(aq_base(action), 'uid'):
1418 1419
            action.uid = None
          self._objects[key] = action
Aurel's avatar
Aurel committed
1420
          self._objects[key].wl_clearLocks()
1421 1422
          break
      else:
1423
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1424

1425 1426 1427
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1428
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1429 1430
      p = context.getPortalObject()
      for id in self._objects.keys():
1431 1432 1433 1434 1435 1436
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
1437 1438
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
1439 1440 1441
          for index in range(len(action_list)):
            if getattr(action_list[index], 'id') == path[-1]:          
              # remove previous action
1442
              obj.deleteActions(selections=(index,))
1443
          action = self._objects[id]
1444
          obj.addAction(
1445 1446 1447 1448 1449 1450 1451 1452 1453
                        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
1454 1455
                    )
    else:
1456
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1457
      p = context.getPortalObject()
1458 1459
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
1460
        relative_url, key, value = self._splitPath(id)
1461 1462
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
1463
          if getattr(ai, key) == value:
1464 1465
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
        obj.addAction(
Aurel's avatar
Aurel committed
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
                      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)
                    )
1476 1477 1478

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1479 1480 1481 1482 1483 1484 1485 1486
    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:
      action = self._archive[id]
1487
      relative_url, key, value = self._splitPath(id)
1488 1489
      obj = p.unrestrictedTraverse(relative_url)
      action_list = obj.listActions()
1490
      for index in range(len(action_list)):
1491
        if getattr(action_list[index], key) == value:
1492
          obj.deleteActions(selections=(index,))
1493 1494 1495 1496 1497 1498 1499 1500 1501
          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():
1502 1503
      for property in p.propertyMap():
        if property['id'] == id:
1504
          obj = p.getProperty(id)
1505
          prop_type = property['type']
1506 1507
          break
      else:
1508 1509
        obj = None
      if obj is None:
1510
        raise NotFound, 'the property %s is not found' % id
1511
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
1512

1513 1514 1515 1516 1517 1518
  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
1519 1520
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
1521 1522 1523 1524 1525 1526 1527
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
1528
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
1529
      self._objects[str(id)] = (str(prop_type), value)
1530

1531 1532 1533
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1534
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1535 1536
      p = context.getPortalObject()
      for path in self._objects.keys():
1537 1538 1539 1540 1541 1542 1543 1544
        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
1545 1546
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
1547
    else:
1548
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1549
      p = context.getPortalObject()
1550 1551
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
1552 1553 1554 1555 1556
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
1557 1558 1559

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1560 1561 1562 1563 1564 1565
    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:
1566 1567 1568 1569
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

1570
  def generateXml(self, path=None):
1571
    xml_data = ''
1572
    prop_type, obj = self._objects[path]
1573 1574
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
1575 1576
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
1577
      xml_data += os.linesep+'  <value>'
1578
      for item in obj:
1579 1580 1581 1582
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
1583
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
1584
    xml_data += os.linesep+' </property>'
1585 1586
    return xml_data

Aurel's avatar
Aurel committed
1587 1588 1589 1590 1591
  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)
1592 1593 1594 1595
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
1596
      xml_data += self.generateXml(path)
1597
    xml_data += os.linesep+'</site_property>'
1598
    bta.addObject(obj=xml_data, name='properties', path=root_path)
1599

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

1616
  def generateXml(self, path=None):
1617 1618
    dict = self._objects[path]
    xml_data = '<module>'
1619 1620 1621 1622
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
1623 1624 1625 1626 1627 1628 1629
      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
1630
          role_list = list(perm[1])
1631
          role_list.sort()
1632 1633 1634 1635 1636 1637 1638 1639 1640
          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

1641 1642 1643 1644 1645
  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)
1646 1647 1648
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
1649
      # expor module one by one
1650
      xml_data = self.generateXml(path=id)
1651
      bta.addObject(obj=xml_data, name=id, path=path)
1652

1653
  def install(self, context, trashbin, **kw):
1654
    portal = context.getPortalObject()
1655 1656
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1657
    if context.getTemplateFormatVersion() == 1:
1658
      items = self._objects
1659
    else:
1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682
      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
1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713

  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

1714
  def uninstall(self, context, **kw):
1715 1716 1717 1718 1719 1720 1721
    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]
1722 1723
    p = context.getPortalObject()
    id_list = p.objectIds()
1724
    for id in keys:
1725
      if id in id_list:
1726
        try:
1727
          if trash and trashbin is not None:
1728 1729
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
1730
          p.manage_delObjects([id])
1731
        except NotFound:
1732
          pass
1733 1734
    BaseTemplateItem.uninstall(self, context, **kw)

1735 1736 1737
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
1738 1739

class DocumentTemplateItem(BaseTemplateItem):
1740 1741 1742 1743
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
1744 1745 1746 1747

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

1750
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1751 1752
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772
      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
1773
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1774
      for id in self._objects.keys():
1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788
        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
1789
    else:
1790 1791 1792
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
1793
        # This raises an exception if the file exists.
1794
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
1795 1796
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
1797 1798

  def uninstall(self, context, **kw):
1799 1800 1801 1802 1803 1804
    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:
1805
      globals()[self.local_file_remover_name](id)
1806 1807
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
1808 1809 1810 1811 1812 1813
  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():
1814 1815
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
1816

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

1821 1822 1823 1824 1825 1826
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

1827

1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841
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
1842

1843 1844 1845
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
1846 1847 1848

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
1849 1850 1851 1852
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
1853 1854
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
1855

1856
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1857 1858
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872
      new_roles = self._objects.keys()
      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):
1873
    p = context.getPortalObject()
1874
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1875
    if context.getTemplateFormatVersion() == 1:
1876
      role_list = self._objects.keys()
1877
    else:
1878
      role_list = self._archive.keys()
1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
    # 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
1891
    for role in role_list:
1892 1893 1894 1895 1896 1897 1898 1899 1900 1901
      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
1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913

  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)

1914 1915 1916 1917 1918 1919 1920 1921 1922
  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
1923
      if role in roles and role not in new_roles:
1924 1925 1926
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

1927
  def generateXml(self, path):
1928
    obj = self._objects[path]
1929
    xml_data = '<role_list>'
1930 1931
    obj.sort()
    for role in obj:
1932 1933 1934 1935
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

Aurel's avatar
Aurel committed
1936 1937 1938 1939 1940 1941
  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():
1942
      xml_data = self.generateXml(path=path)
1943
      bta.addObject(obj=xml_data, name=path, path=None,)
1944

1945 1946
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
1947
  def build(self, context, **kw):
1948 1949
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1950
    except KeyError:
1951 1952 1953 1954
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1955
    sql_search_result_keys = list(catalog.sql_search_result_keys)
1956
    key_list = []
1957
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
1958
      if key in sql_search_result_keys:
1959
        key_list.append(key)
Aurel's avatar
Aurel committed
1960 1961
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
1962 1963
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'key_list'] = key_list
1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974

  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

1975
  def install(self, context, trashbin, **kw):
1976 1977 1978 1979 1980 1981 1982
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1983

1984
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1985
    if context.getTemplateFormatVersion() == 1:
1986 1987
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
1988 1989 1990
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
1991
    else:
1992
      keys = self._archive.keys()
1993 1994
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1995
    for key in keys:
1996 1997 1998 1999 2000 2001 2002
      if update_dict.has_key(key) or force:
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue          
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
2003 2004
    catalog.sql_search_result_keys = sql_search_result_keys

2005
  def uninstall(self, context, **kw):
2006 2007
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2008
    except KeyError:
2009 2010 2011 2012 2013
      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)
2014 2015 2016 2017 2018 2019
    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:
2020 2021
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2022
    catalog.sql_search_result_keys = sql_search_result_keys
2023 2024
    BaseTemplateItem.uninstall(self, context, **kw)

2025
  def generateXml(self, path=None):
2026
    obj = self._objects[path]
2027
    xml_data = '<key_list>'
2028 2029
    obj.sort()
    for key in obj:
2030 2031 2032 2033
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2034 2035 2036 2037 2038
  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)
2039
    for path in self._objects.keys():
2040
      xml_data = self.generateXml(path=path)
2041
      bta.addObject(obj=xml_data, name=path, path=None)
2042

2043 2044
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2045
  def build(self, context, **kw):
2046 2047
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2048
    except KeyError:
2049 2050 2051 2052
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2053
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2054
    key_list = []
2055
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2056
      if key in sql_search_related_keys:
2057
        key_list.append(key)
Aurel's avatar
Aurel committed
2058 2059
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2060 2061
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'key_list'] = key_list
2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072

  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

2073
  def install(self, context, trashbin, **kw):
2074 2075 2076 2077 2078 2079 2080
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2081

2082
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2083
    if context.getTemplateFormatVersion() == 1:
2084
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2085
        return
2086 2087 2088
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2089
    else:
2090
      keys = self._archive.keys()
2091 2092
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2093
    for key in keys:
2094 2095 2096 2097 2098 2099 2100
      if update_dict.has_key(key) or force:
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue          
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
2101
    catalog.sql_catalog_related_keys = sql_catalog_related_keys
2102

2103 2104 2105
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2106
    except KeyError:
2107 2108 2109 2110
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2111
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2112 2113 2114 2115 2116 2117
    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:
2118 2119 2120 2121 2122
      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)

2123
  def generateXml(self, path=None):
2124
    obj = self._objects[path]
2125
    xml_data = '<key_list>'
2126 2127
    obj.sort()
    for key in obj:
2128 2129 2130 2131
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2132 2133 2134 2135 2136 2137
  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():
2138
      xml_data = self.generateXml(path=path)
2139
      bta.addObject(obj=xml_data, name=path, path=None)
2140

2141 2142
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2143
  def build(self, context, **kw):
2144 2145
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2146
    except KeyError:
2147 2148 2149 2150
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2151
    sql_search_result_tables = list(catalog.sql_search_tables)
2152
    key_list = []
2153
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2154
      if key in sql_search_result_tables:
2155
        key_list.append(key)
Aurel's avatar
Aurel committed
2156 2157
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2158 2159
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'key_list'] = key_list
2160 2161 2162 2163 2164 2165 2166 2167 2168 2169

  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
2170

2171
  def install(self, context, trashbin, **kw):
2172 2173 2174 2175 2176 2177 2178
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2179

2180
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2181
    if context.getTemplateFormatVersion() == 1:
2182
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2183
        return
2184 2185 2186
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2187
    else:
2188
      keys = self._archive.keys()
2189 2190
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2191
    for key in keys:
2192 2193 2194 2195 2196 2197 2198
      if update_dict.has_key(key) or force:
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue          
        if key not in sql_search_tables:
          sql_search_tables.append(key)
2199
    catalog.sql_search_tables = sql_search_tables
2200 2201

  def uninstall(self, context, **kw):
2202 2203
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2204
    except KeyError:
2205 2206 2207 2208 2209
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2210 2211 2212 2213 2214 2215
    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:
2216 2217
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2218
    catalog.sql_search_tables = sql_search_tables
2219 2220
    BaseTemplateItem.uninstall(self, context, **kw)

2221
  def generateXml(self, path=None):
2222
    obj = self._objects[path]
2223
    xml_data = '<key_list>'
2224 2225
    obj.sort()
    for key in obj:
2226 2227 2228 2229
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'    
    return xml_data

Aurel's avatar
Aurel committed
2230 2231 2232 2233 2234 2235
  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():
2236
      xml_data = self.generateXml(path=path)
2237
      bta.addObject(obj=xml_data, name=path, path=None)
2238

2239 2240 2241 2242 2243
class MessageTranslationTemplateItem(BaseTemplateItem):

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

2251
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2252 2253
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271
      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):
2272
    localizer = context.getPortalObject().Localizer
2273 2274
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2275
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2276
      for path, po in self._objects.items():
2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290
        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)
Aurel's avatar
Aurel committed
2291
    else:
2292
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307
      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():
2308
      obj = self._objects[key]
Aurel's avatar
Aurel committed
2309 2310 2311
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
      f = open(path+'/translation.po', 'wt')
2312
      f.write(str(obj))
Aurel's avatar
Aurel committed
2313
      f.close()
2314

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

2319
class BusinessTemplate(XMLObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2320 2321
    """
    A business template allows to construct ERP5 modules
2322 2323 2324
    in part or completely. Each object are separated from its
    subobjects and exported in xml format.
    It may include:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2325

2326 2327
    - catalog definition
      - SQL method objects
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2328 2329 2330 2331
      - SQL methods including:
        - purpose (catalog, uncatalog, etc.)
        - filter definition

2332 2333 2334
    - portal_types definition
      - object without optinal actions
      - list of relation between portal type and worklfow
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2335

2336
    - module definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2337
      - id
2338 2339
      - title
      - portal type
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2340 2341
      - roles/security

2342 2343 2344 2345
    - site property definition
      - id
      - type
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2346

2347 2348
    - document/propertysheet/extension/test definition
      - copy of the local file
2349

2350
    - message transalation definition
2351
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2352

2353 2354
    The Business Template properties are exported to the bt folder with
    one property per file
2355

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2356 2357
    Technology:

2358 2359
    - 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
2360

2361
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2362 2363 2364 2365

    Use case:

    - install core ERP5 (the minimum)
2366

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

2369 2370
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
2371
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2372 2373 2374 2375 2376
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
2377
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
    security.declareObjectProtected(Permissions.View)

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
2391
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2392
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2393
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2394 2395 2396
                      , PropertySheet.BusinessTemplate
                      )

2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464
    # 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
         , 'actions'        :
        ( { 'id'            : 'view'
          , 'name'          : 'View'
          , 'category'      : 'object_view'
          , 'action'        : 'BusinessTemplate_view'
          , 'permissions'   : (
              Permissions.View, )
          }
        , { 'id'            : 'history'
          , 'name'          : 'History'
          , 'category'      : 'object_view'
          , 'action'        : 'Base_viewHistory'
          , 'permissions'   : (
              Permissions.View, )
          }
        , { 'id'            : 'metadata'
          , 'name'          : 'Metadata'
          , 'category'      : 'object_view'
          , 'action'        : 'Base_viewMetadata'
          , 'permissions'   : (
              Permissions.ManageProperties, )
          }
        , { 'id'            : 'update'
          , 'name'          : 'Update Business Template'
          , 'category'      : 'object_action'
          , 'action'        : 'BusinessTemplate_update'
          , 'permissions'   : (
              Permissions.ModifyPortalContent, )
          }
        , { 'id'            : 'save'
          , 'name'          : 'Save Business Template'
          , 'category'      : 'object_action'
          , 'action'        : 'BusinessTemplate_save'
          , 'permissions'   : (
              Permissions.ManagePortal, )
          }
        , { 'id'            : 'export'
          , 'name'          : 'Export Business Template'
          , 'category'      : 'object_action'
          , 'action'        : 'BusinessTemplate_export'
          , 'permissions'   : (
              Permissions.ManagePortal, )
          }
        , { 'id'            : 'unittest_run'
          , 'name'          : 'Run Unit Tests'
          , 'category'      : 'object_action'
          , 'action'        : 'BusinessTemplate_viewUnitTestRunDialog'
          , 'permissions'   : (
              Permissions.ManagePortal, )
          }
        )
      }

2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481
    # 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',
      '_category_item',
      '_module_item',
      '_skin_item',
2482
      '_path_item',
2483 2484 2485 2486 2487 2488 2489 2490
      '_action_item',
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Aurel's avatar
Aurel committed
2491
      self._objects = PersistentMapping()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2492 2493 2494 2495 2496 2497
      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
2498
        self._baseGetTemplateFormatVersion()
2499

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2500 2501 2502 2503 2504 2505
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
        
      return 0
        
2506
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
2507 2508 2509 2510 2511 2512 2513
    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".
2514 2515
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
2516
          # XXX Not good to access the attribute directly,
2517 2518 2519
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
2520

2521
    security.declareProtected(Permissions.ManagePortal, 'build')
2522
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2523 2524 2525
      """
        Copy existing portal objects to self
      """
2526 2527
      if no_action: return # this is use at import of Business Template to get the status built
      
2528 2529
      # Make sure that everything is sane.
      self.clean()
2530

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2531 2532 2533
      # Set the format version.
      self._setTemplateFormatVersion(1)

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
      # 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())
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
      # Build each part
      for item_name in self._item_name_list:
        getattr(self, item_name).build(self)
2580

2581
    build = WorkflowMethod(build)
2582 2583

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2584
      """
2585
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2586
      """
2587
      return self.portal_templates.publish(self, url, username=username,
2588
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2589

2590
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2591
      """
2592
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2593
      """
2594
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2595

2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606
    def preinstall(self, **kw):
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
      """      
      modified_object_list = {}
      bt_title = self.getTitle()
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(title=bt_title)
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2607
        installed_bt_format = installed_bt.getTemplateFormatVersion()
2608

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2609
      new_bt_format = self.getTemplateFormatVersion()
2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626
      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:
          item = getattr(self, item_name)
          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
        
      # 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:
        new_item = getattr(self, item_name)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2627
        old_item = getattr(installed_bt, item_name, None)
2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638
        if new_item is not None:
          modified_object = new_item.preinstall(context=local_configuration, installed_bt=old_item)
          if len(modified_object) > 0:
            modified_object_list.update(modified_object)
      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
      """
2639 2640
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
2641
      if installed_bt is not None:        
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2642
        if installed_bt.getTemplateFormatVersion() == 0:
2643 2644 2645
          # maybe another to uninstall old format bt, maybe not needed
          installed_bt.trash(self)
          force = 1
2646
        installed_bt.replace(self)
2647 2648 2649 2650 2651
        
      if not force:
        if len(object_to_update) == 0:
          # nothing to be done
          return
2652
      trash_tool = getToolByName(self, 'portal_trash', None)
2653 2654
      # 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
2655 2656
      if trash_tool is not None and len(object_to_update) > 0 or len(self.portal_templates.objectIds()) > 1:
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
2657 2658 2659
      else:
        trashbin = None
        
2660
      # Update local dictionary containing all setup parameters
2661 2662 2663
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677
      
      # get objects to remove
      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:
          item = getattr(installed_bt, item_name)
          if item is not None:
            item.remove(local_configuration, remove_object_dict=remove_object_dict, trashbin=trashbin)
2678
      # Install everything
2679 2680 2681 2682 2683
      if len(object_to_update) > 0 or force:
        for item_name in self._item_name_list:
          item = getattr(self, item_name)
          if item is not None:
            item.install(local_configuration, force=force, object_to_update=object_to_update, trashbin=trashbin)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2684 2685 2686
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
2687

2688
    security.declareProtected(Permissions.ManagePortal, 'install')
2689 2690 2691 2692 2693
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
      """
      return self._install(**kw)
2694

2695
    install = WorkflowMethod(install)
2696

2697
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
2698
    def reinstall(self, **kw):
2699 2700 2701 2702
      """Reinstall Business Template.
      """
      return self._install(**kw)

2703
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2704

2705
    security.declareProtected(Permissions.ManagePortal, 'trash')
2706 2707
    def trash(self, new_bt, **kw):
      """
2708
        Trash unnecessary items before upgrading to a new business
2709
        template.
2710
        This is similar to uninstall, but different in that this does
2711
        not remove all items.
2712 2713 2714 2715 2716
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2717 2718 2719 2720 2721 2722 2723
      # Trash everything
      for item_name in self._item_name_list[::-1]:
        item = getattr(self, item_name)
        if item is not None:
          item.trash(
                local_configuration,
                getattr(new_bt, item_name))
2724

2725
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
2726
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2727
      """
2728
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2729
      """
2730 2731 2732 2733
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2734 2735 2736 2737 2738 2739
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
        item = getattr(self, item_name)
        if item is not None:
          item.uninstall(local_configuration)
2740
      # It is better to clear cache because the uninstallation of a
2741
      # template deletes many things from the portal.
2742
      clearCache()
2743

2744 2745
    uninstall = WorkflowMethod(uninstall)

2746
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2747
    def _clean(self):
2748
      """
2749
        Clean built information.
2750
      """
2751
      # First, remove obsolete attributes if present.
Aurel's avatar
Aurel committed
2752
      self._objects = None
2753 2754 2755 2756
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
2757
                    '_module_archive',
2758 2759 2760
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
2761
                    '_property_sheet_archive'):
2762 2763 2764
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
2765 2766
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
2767

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

2770
    security.declareProtected(Permissions.AccessContentsInformation,
2771
                              'getBuildingState')
2772
    def getBuildingState(self, id_only=1):
2773
      """
2774
        Returns the current state in building
2775
      """
2776
      portal_workflow = getToolByName(self, 'portal_workflow')
2777 2778
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
2779
      return wf._getWorkflowStateOf(self, id_only=id_only )
2780

2781
    security.declareProtected(Permissions.AccessContentsInformation,
2782
                              'getInstallationState')
2783
    def getInstallationState(self, id_only=1):
2784
      """
2785
        Returns the current state in installation
2786
      """
2787
      portal_workflow = getToolByName(self, 'portal_workflow')
2788 2789
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
2790
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2791

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2792 2793 2794 2795 2796 2797
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
2798
      export_string = portal_templates.manage_exportObject(
2799 2800
                                               id=self.getId(),
                                               toxml=1,
2801
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2802
      return export_string
2803

2804
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2805
      """
2806 2807
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2808
      """
2809
      result = getattr(self, id, ())
2810 2811 2812 2813 2814 2815
      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
2816

2817
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2818
      """
2819 2820
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2821
      """
2822
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2823

2824
    def getTemplateBaseCategoryList(self):
2825
      """
2826 2827
      We have to set this method because we want an
      ordered list
2828
      """
2829
      return self._getOrderedList('template_base_category')
2830

2831
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2832
      """
2833 2834
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2835
      """
2836
      return self._getOrderedList('template_workflow_id')
2837

2838
    def getTemplatePortalTypeIdList(self):
2839
      """
2840 2841
      We have to set this method because we want an
      ordered list
2842
      """
2843
      return self._getOrderedList('template_portal_type_id')
2844

2845
    def getTemplateActionPathList(self):
2846
      """
2847 2848
      We have to set this method because we want an
      ordered list
2849
      """
2850
      return self._getOrderedList('template_action_path')
2851

2852
    def getTemplateSkinIdList(self):
2853
      """
2854 2855
      We have to set this method because we want an
      ordered list
2856
      """
2857
      return self._getOrderedList('template_skin_id')
2858

2859
    def getTemplateModuleIdList(self):
2860
      """
2861 2862
      We have to set this method because we want an
      ordered list
2863
      """
2864
      return self._getOrderedList('template_module_id')
2865 2866 2867 2868 2869 2870 2871

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

2873
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
2874 2875 2876 2877
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
2878 2879
      if self.getBuildingState() != 'built':
        raise TemplateConditionError, 'Business Template must be build before export'
2880
      
Aurel's avatar
Aurel committed
2881 2882 2883 2884 2885 2886 2887
      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)

2888
      # export bt
2889
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
2890
      for prop in self.propertyMap():
2891
        prop_type = prop['type']
Aurel's avatar
Aurel committed
2892
        id = prop['id']
2893
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id', 'install_object_list_list'):        
2894
          continue
Aurel's avatar
Aurel committed
2895
        value = self.getProperty(id)
2896
        if prop_type == 'text' or prop_type == 'string' or prop_type == 'int':
2897
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
2898
        elif prop_type == 'lines' or prop_type == 'tokens':
2899
          bta.addObject(obj=str(os.linesep).join(value), name=id, path=path+os.sep+'bt', ext='')
2900

Aurel's avatar
Aurel committed
2901 2902 2903
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
2904
        
Aurel's avatar
Aurel committed
2905 2906
      return bta.finishCreation()

2907
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
2908 2909
    def importFile(self, dir = 0, file=None, root_path=None):
      """
2910
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
2911 2912 2913 2914 2915 2916
      """

      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
2917

Aurel's avatar
Aurel committed
2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962
      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())

      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
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


    def diffObject(self, REQUEST):
      """
        Make a diff between an object in the Business Template
        and the same installed in the site
      """

      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',
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
        'Path' : '_path_item',
        'Action' : '_action_item',
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
        }

      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
      # get objects
      item_name = class_name_dict[object_class]
      new_bt =self
      installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      # make diff
      diff_msg = ''
      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']
      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'
      elif item_name in item_list_2:
3026 3027
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047
        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'
      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'                
      
      return diff_msg