BusinessTemplate.py 111 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 318 319 320 321 322 323 324 325 326 327
  def removeProperties(self, obj):
    """
    Remove unneeded properties for export
    """  
    if hasattr(obj, '__ac_local_roles__'):
      # remove local roles
      obj.__ac_local_roles__ = None
    if hasattr(obj, '_owner'):
      obj._owner = None
    if hasattr(aq_base(obj), 'uid'):
      obj.uid = None
    return obj      
    
328 329 330
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
331
  """
332

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

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

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

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

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

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

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

584 585 586 587 588 589 590 591 592 593 594 595
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

596 597 598 599 600 601 602 603 604
  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
    trash = kw.get('trash', 0)
    trashbin = kw.get('trashbin', None)
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._path_archive.keys()
605 606
    object_keys.sort()
    object_keys.reverse()
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
    p = context.getPortalObject()
    for path in object_keys:
      for relative_url in self._resolvePath(p, [], path.split('/')):
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        try:        
          container = portal.unrestrictedTraverse(container_path)
          if trash and trashbin is not None:
            self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

622 623 624
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
625

626 627 628 629 630 631 632 633 634
      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.
635 636
      obj = folder._getOb(id)
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
637 638 639 640
    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
641

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

670 671
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
672

673 674 675 676
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
677 678
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
679
      obj = self.removeProperties(obj)
680
      id_list = obj.objectIds()
681 682
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
683 684 685
        obj.manage_delObjects(list(id_list))
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
686 687 688 689 690

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

802

803 804
class SkinTemplateItem(ObjectTemplateItem):

805 806
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
807

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

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


871
class WorkflowTemplateItem(ObjectTemplateItem):
872

873 874
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
875

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

  

949 950 951 952 953 954 955 956
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
957
    This is only useful in order to use
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
    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)

982 983
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
984 985 986
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
987 988
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
989 990 991
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
      id_list = obj.objectIds()
Aurel's avatar
Aurel committed
992
      # remove optional actions
993
      optional_action_list = []
994
      for index,ai in enumerate(obj.listActions()):
995 996 997
        if ai.getOption():
          optional_action_list.append(index)
      if len(optional_action_list) > 0:
998
        obj.deleteActions(selections=optional_action_list)
999
      obj = self.removeProperties(obj)
1000 1001
      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
        chain_dict['chain_%s' % portal_type] = \
                              self._workflow_chain_archive[portal_type]
        context.portal_workflow.manage_changeWorkflows(default_chain,
                                                       props=chain_dict)

1054 1055 1056 1057 1058 1059 1060
  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:
1061
        ptype = chain.getElementsByTagName('type')[0].childNodes[0].data
1062 1063 1064 1065 1066
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
1067
        dict[str(ptype)] = str(workflow)
1068 1069 1070 1071 1072
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)


1073 1074
class CatalogMethodTemplateItem(ObjectTemplateItem):

1075 1076
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1077
    self._is_catalog_list_method_archive = PersistentMapping()
1078 1079 1080 1081 1082 1083 1084 1085 1086
    self._is_uncatalog_method_archive = PersistentMapping()
    self._is_clear_method_archive = PersistentMapping()
    self._is_filtered_archive = PersistentMapping()
    self._filter_expression_archive = PersistentMapping()
    self._filter_expression_instance_archive = PersistentMapping()
    self._filter_type_archive = PersistentMapping()

  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
1087 1088
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1089 1090
    except KeyError:
      catalog = None
1091
    if catalog is None:
1092
      LOG('BusinessTemplate build', 0, 'catalog not found')
1093
      return
1094 1095
    for obj in self._objects.values():
      method_id = obj.id
1096 1097 1098
      self._is_catalog_list_method_archive[method_id] = method_id in catalog.sql_catalog_object_list
      self._is_uncatalog_method_archive[method_id] = method_id in catalog.sql_uncatalog_object
      self._is_clear_method_archive[method_id] = method_id in catalog.sql_clear_catalog
1099
      self._is_filtered_archive[method_id] = 0
1100 1101 1102 1103 1104
      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']
1105

Aurel's avatar
Aurel committed
1106 1107 1108 1109 1110
  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():
1111
      obj = self._objects[key]
Aurel's avatar
Aurel committed
1112 1113 1114 1115 1116 1117
      # 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()
1118 1119
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
Aurel's avatar
Aurel committed
1120 1121
      # add all datas specific to catalog inside one file
      catalog = context.portal_catalog.getSQLCatalog()
1122
      method_id = obj.id
1123 1124
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1125
      f = open(object_path, 'wt')
1126 1127 1128
      xml_data = '<catalog_method>'
      for method in catalog_method_list:
        value = getattr(self, method, 0)[method_id]
1129
        xml_data += os.linesep+' <item key="%s" type="int">' %(method,)
1130
        xml_data += os.linesep+'  <value>%s</value>' %(str(int(value)))
1131
        xml_data += os.linesep+' </item>'
Aurel's avatar
Aurel committed
1132
      if catalog.filter_dict.has_key(method_id):
1133 1134 1135
        for method in catalog_method_filter_list:
          value = getattr(self, method, '')[method_id]
          if method == '_filter_expression_instance_archive':
1136
            pass
1137
          else:
1138
            if type(value) in (type(''), type(u'')):
1139
              xml_data += os.linesep+' <item key="%s" type="str">' %(method,)
1140
              xml_data += os.linesep+'  <value>%s</value>' %(str(value))
1141
              xml_data += os.linesep+' </item>'
1142
            elif type(value) in (type(()), type([])):
1143
              xml_data += os.linesep+' <item key="%s" type="tuple">'%(method)
1144 1145
              for item in value:
                xml_data += os.linesep+'  <value>%s</value>' %(str(item))
1146
              xml_data += os.linesep+' </item>'
1147 1148
      xml_data += os.linesep+'</catalog_method>'
      f.write(str(xml_data))
Aurel's avatar
Aurel committed
1149
      f.close()
1150

1151 1152
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1153 1154
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1155
    except KeyError:
1156 1157 1158 1159 1160 1161 1162 1163
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    # Make copies of attributes of the default catalog of portal_catalog.
    sql_catalog_object_list = list(catalog.sql_catalog_object_list)
    sql_uncatalog_object = list(catalog.sql_uncatalog_object)
    sql_clear_catalog = list(catalog.sql_clear_catalog)
1164

1165 1166 1167
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1168
    new_bt_format = context.getTemplateFormatVersion()
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190

    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])
          
1191 1192
    for obj in values:
      method_id = obj.id
1193

Aurel's avatar
Aurel committed
1194 1195 1196 1197
      is_catalog_list_method = int(self._is_catalog_list_method_archive[method_id])
      is_uncatalog_method = int(self._is_uncatalog_method_archive[method_id])
      is_clear_method = int(self._is_clear_method_archive[method_id])
      is_filtered = int(self._is_filtered_archive[method_id])
1198

1199 1200 1201 1202 1203
      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)

1204
      if is_uncatalog_method and method_id not in sql_uncatalog_object:
1205
        sql_uncatalog_object.append(method_id)
1206
      elif not is_uncatalog_method and method_id in sql_uncatalog_object:
1207 1208 1209 1210 1211 1212 1213 1214
        sql_uncatalog_object.remove(method_id)

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

      if is_filtered:
1215
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1216
        if context.getTemplateFormatVersion() == 1:
1217 1218 1219
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1220
        filter_type = self._filter_type_archive[method_id]
1221 1222 1223
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1224
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1225
        catalog.filter_dict[method_id]['type'] = filter_type
1226
      elif method_id in catalog.filter_dict.keys():
1227
        catalog.filter_dict[method_id]['filtered'] = 0
1228

1229 1230
    sql_catalog_object_list.sort()
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
1231
    sql_uncatalog_object.sort()
1232
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
1233
    sql_clear_catalog.sort()
1234
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1235 1236

  def uninstall(self, context, **kw):
1237 1238
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1239
    except KeyError:
1240 1241 1242 1243
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1244
    
1245 1246 1247 1248
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
1249 1250 1251 1252
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
1253 1254
    else:      
      values.append(self._archive[object_path])
1255 1256 1257 1258
    # Make copies of attributes of the default catalog of portal_catalog.
    sql_catalog_object_list = list(catalog.sql_catalog_object_list)
    sql_uncatalog_object = list(catalog.sql_uncatalog_object)
    sql_clear_catalog = list(catalog.sql_clear_catalog)
1259

1260 1261
    for obj in values:
      method_id = obj.id
1262 1263
      if method_id in sql_catalog_object_list:
        sql_catalog_object_list.remove(method_id)
1264 1265 1266 1267
      if method_id in sql_uncatalog_object:
        sql_uncatalog_object.remove(method_id)
      if method_id in sql_clear_catalog:
        sql_clear_catalog.remove(method_id)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1268
      if catalog.filter_dict.has_key(method_id):
1269
        del catalog.filter_dict[method_id]
1270
        
1271 1272 1273
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1274
    # uninstall objects
1275
    ObjectTemplateItem.uninstall(self, context, **kw)
1276

1277
  def _importFile(self, file_name, file):
1278
    if not '.catalog_keys' in file_name:
1279 1280 1281 1282 1283 1284 1285 1286
      # 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
1287
    elif '.catalog_keys' in file_name:
1288 1289 1290 1291
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1292
      method_list = xml.getElementsByTagName('item')
1293
      for method in method_list:
1294
        key = method.getAttribute('key')
1295 1296
        key_type = str(method.getAttribute('type'))
        if key_type == "str":
1297 1298
          value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          key = str(key)
1299
        elif key_type == "int":
1300
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1301
          key = str(key)
1302
        elif key_type == "tuple":
1303 1304 1305 1306
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1307
        else:
1308
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
1309
          continue
1310 1311 1312
        if key in catalog_method_list or key in catalog_method_filter_list:
          dict = getattr(self, key)
          dict[id] = value
1313 1314

class ActionTemplateItem(ObjectTemplateItem):
1315 1316 1317 1318

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

1320
      "foo/bar[id=zoo]"
1321

1322
      into
1323

1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
      "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):
1338
    # XXX It's look like ObjectTemplateItem __init__
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
    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)
1350 1351
      obj = p.unrestrictedTraverse(relative_url)
      for ai in obj.listActions():
1352
        if getattr(ai, key) == value:
1353
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1354
          key = os.path.join(url[-2], url[-1], value)
1355
          action = ai._getCopy(context)
1356
          action = self.removeProperties(action)
1357
          self._objects[key] = action
Aurel's avatar
Aurel committed
1358
          self._objects[key].wl_clearLocks()
1359 1360
          break
      else:
1361
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1362

1363 1364 1365
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1366
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1367 1368
      p = context.getPortalObject()
      for id in self._objects.keys():
1369 1370 1371 1372 1373 1374
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
1375 1376
          obj = p.unrestrictedTraverse(path[:-1])
          action_list = obj.listActions()
1377 1378 1379
          for index in range(len(action_list)):
            if getattr(action_list[index], 'id') == path[-1]:          
              # remove previous action
1380
              obj.deleteActions(selections=(index,))
1381
          action = self._objects[id]
1382
          obj.addAction(
1383 1384 1385 1386 1387 1388 1389 1390 1391
                        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)
1392
                      , priority = action.priority
Aurel's avatar
Aurel committed
1393
                    )
1394
          # sort action based on the priority define on it
1395 1396 1397 1398 1399 1400 1401 1402 1403
          # XXX suppose that priority are properly on actions
          new_priority = action.priority
          action_list = obj.listActions()
          move_down_list = []
          for index in range(len(action_list)):
            action = action_list[index]
            if action.priority > new_priority:
              move_down_list.append(str(index))
          obj.moveDownActions(selections=tuple(move_down_list))
Aurel's avatar
Aurel committed
1404
    else:
1405
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1406
      p = context.getPortalObject()
1407 1408
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
1409
        relative_url, key, value = self._splitPath(id)
1410 1411
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
1412
          if getattr(ai, key) == value:
1413 1414
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
        obj.addAction(
Aurel's avatar
Aurel committed
1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
                      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
1425 1426 1427 1428 1429 1430 1431
        new_priority = action.priority
        action_list = obj.listActions()
        move_down_list = []
        for index in range(len(action_list)):
          action = action_list[index]
          if action.priority > new_priority:
            move_down_list.append(str(index))
1432 1433
          obj.moveDownActions(selections=tuple(move_down_list))

1434 1435 1436

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1437 1438 1439 1440 1441 1442 1443 1444
    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]
1445
      relative_url, key, value = self._splitPath(id)
1446 1447
      obj = p.unrestrictedTraverse(relative_url)
      action_list = obj.listActions()
1448
      for index in range(len(action_list)):
1449
        if getattr(action_list[index], key) == value:
1450
          obj.deleteActions(selections=(index,))
1451 1452 1453 1454 1455 1456 1457 1458 1459
          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():
1460 1461
      for property in p.propertyMap():
        if property['id'] == id:
1462
          obj = p.getProperty(id)
1463
          prop_type = property['type']
1464 1465
          break
      else:
1466 1467
        obj = None
      if obj is None:
1468
        raise NotFound, 'the property %s is not found' % id
1469
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
1470

1471 1472 1473 1474 1475 1476
  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
1477 1478
      prop_type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if prop_type in ('lines', 'tokens'):
1479 1480 1481 1482 1483 1484 1485
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
1486
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
1487
      self._objects[str(id)] = (str(prop_type), value)
1488

1489 1490 1491
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1492
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1493 1494
      p = context.getPortalObject()
      for path in self._objects.keys():
1495 1496 1497 1498 1499 1500 1501 1502
        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
1503 1504
          prop_type, property = self._objects[path]
          p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
1505
    else:
1506
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1507
      p = context.getPortalObject()
1508 1509
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
1510 1511 1512 1513 1514
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
1515 1516 1517

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1518 1519 1520 1521 1522 1523
    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:
1524 1525 1526 1527
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

1528
  def generateXml(self, path=None):
1529
    xml_data = ''
1530
    prop_type, obj = self._objects[path]
1531 1532
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
1533 1534
    xml_data += os.linesep+'  <type>%s</type>' %(prop_type,)
    if prop_type in ('lines', 'tokens'):
1535
      xml_data += os.linesep+'  <value>'
1536
      for item in obj:
1537 1538 1539 1540
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
1541
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(obj),)
1542
    xml_data += os.linesep+' </property>'
1543 1544
    return xml_data

Aurel's avatar
Aurel committed
1545 1546 1547 1548 1549
  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)
1550 1551 1552 1553
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
1554
      xml_data += self.generateXml(path)
1555
    xml_data += os.linesep+'</site_property>'
1556
    bta.addObject(obj=xml_data, name='properties', path=root_path)
1557

1558 1559 1560 1561 1562 1563 1564
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)
1565 1566 1567 1568 1569 1570 1571 1572
      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
1573

1574
  def generateXml(self, path=None):
1575 1576
    dict = self._objects[path]
    xml_data = '<module>'
1577 1578 1579 1580
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
1581 1582 1583 1584 1585 1586 1587
      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
1588
          role_list = list(perm[1])
1589
          role_list.sort()
1590 1591 1592 1593 1594 1595 1596 1597 1598
          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

1599 1600 1601 1602 1603
  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)
1604 1605 1606
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
1607
      # expor module one by one
1608
      xml_data = self.generateXml(path=id)
1609
      bta.addObject(obj=xml_data, name=id, path=path)
1610

1611
  def install(self, context, trashbin, **kw):
1612
    portal = context.getPortalObject()
1613 1614
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1615
    if context.getTemplateFormatVersion() == 1:
1616
      items = self._objects
1617
    else:
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640
      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
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671

  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

1672
  def uninstall(self, context, **kw):
1673 1674 1675 1676 1677 1678 1679
    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]
1680 1681
    p = context.getPortalObject()
    id_list = p.objectIds()
1682
    for id in keys:
1683
      if id in id_list:
1684
        try:
1685
          if trash and trashbin is not None:
1686 1687
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
1688
          p.manage_delObjects([id])
1689
        except NotFound:
1690
          pass
1691 1692
    BaseTemplateItem.uninstall(self, context, **kw)

1693 1694 1695
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
1696 1697

class DocumentTemplateItem(BaseTemplateItem):
1698 1699 1700 1701
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
1702 1703 1704 1705

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

1708
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1709 1710
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
      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
1731
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
1732
      for id in self._objects.keys():
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746
        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
1747
    else:
1748 1749 1750
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
1751
        # This raises an exception if the file exists.
1752
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
1753 1754
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
1755 1756

  def uninstall(self, context, **kw):
1757 1758 1759 1760 1761 1762
    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:
1763
      globals()[self.local_file_remover_name](id)
1764 1765
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
1766 1767 1768 1769 1770 1771
  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():
1772 1773
      obj = self._objects[path]
      bta.addObject(obj=obj, name=path, path=None, ext='.py')
Aurel's avatar
Aurel committed
1774

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

1779 1780 1781 1782 1783 1784
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

1785

1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
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
1800

1801 1802 1803
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
1804 1805 1806

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
1807 1808 1809 1810
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
1811 1812
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
1813

1814
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1815 1816
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830
      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):
1831
    p = context.getPortalObject()
1832
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1833
    if context.getTemplateFormatVersion() == 1:
1834
      role_list = self._objects.keys()
1835
    else:
1836
      role_list = self._archive.keys()
1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848
    # 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
1849
    for role in role_list:
1850 1851 1852 1853 1854 1855 1856 1857 1858 1859
      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
1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871

  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)

1872 1873 1874 1875 1876 1877 1878 1879 1880
  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
1881
      if role in roles and role not in new_roles:
1882 1883 1884
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

1885
  def generateXml(self, path):
1886
    obj = self._objects[path]
1887
    xml_data = '<role_list>'
1888 1889
    obj.sort()
    for role in obj:
1890 1891 1892 1893
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

Aurel's avatar
Aurel committed
1894 1895 1896 1897 1898 1899
  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():
1900
      xml_data = self.generateXml(path=path)
1901
      bta.addObject(obj=xml_data, name=path, path=None,)
1902

1903 1904
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
1905
  def build(self, context, **kw):
1906 1907
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1908
    except KeyError:
1909 1910 1911 1912
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1913
    sql_search_result_keys = list(catalog.sql_search_result_keys)
1914
    key_list = []
1915
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
1916
      if key in sql_search_result_keys:
1917
        key_list.append(key)
Aurel's avatar
Aurel committed
1918 1919
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
1920 1921
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'key_list'] = key_list
1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932

  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

1933
  def install(self, context, trashbin, **kw):
1934 1935 1936 1937 1938 1939 1940
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1941

1942
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1943
    if context.getTemplateFormatVersion() == 1:
1944 1945
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
1946 1947 1948
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
1949
    else:
1950
      keys = self._archive.keys()
1951 1952
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1953
    for key in keys:
1954 1955 1956 1957 1958 1959 1960
      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)
1961 1962
    catalog.sql_search_result_keys = sql_search_result_keys

1963
  def uninstall(self, context, **kw):
1964 1965
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1966
    except KeyError:
1967 1968 1969 1970 1971
      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)
1972 1973 1974 1975 1976 1977
    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:
1978 1979
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
1980
    catalog.sql_search_result_keys = sql_search_result_keys
1981 1982
    BaseTemplateItem.uninstall(self, context, **kw)

1983
  def generateXml(self, path=None):
1984
    obj = self._objects[path]
1985
    xml_data = '<key_list>'
1986 1987
    obj.sort()
    for key in obj:
1988 1989 1990 1991
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
1992 1993 1994 1995 1996
  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)
1997
    for path in self._objects.keys():
1998
      xml_data = self.generateXml(path=path)
1999
      bta.addObject(obj=xml_data, name=path, path=None)
2000

2001 2002
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2003
  def build(self, context, **kw):
2004 2005
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2006
    except KeyError:
2007 2008 2009 2010
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2011
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2012
    key_list = []
2013
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2014
      if key in sql_search_related_keys:
2015
        key_list.append(key)
Aurel's avatar
Aurel committed
2016 2017
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2018 2019
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'key_list'] = key_list
2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030

  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

2031
  def install(self, context, trashbin, **kw):
2032 2033 2034 2035 2036 2037 2038
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2039

2040
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2041
    if context.getTemplateFormatVersion() == 1:
2042
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2043
        return
2044 2045 2046
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2047
    else:
2048
      keys = self._archive.keys()
2049 2050
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2051
    for key in keys:
2052 2053 2054 2055 2056 2057 2058
      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)
2059
    catalog.sql_catalog_related_keys = sql_catalog_related_keys
2060

2061 2062 2063
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2064
    except KeyError:
2065 2066 2067 2068
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2069
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2070 2071 2072 2073 2074 2075
    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:
2076 2077 2078 2079 2080
      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)

2081
  def generateXml(self, path=None):
2082
    obj = self._objects[path]
2083
    xml_data = '<key_list>'
2084 2085
    obj.sort()
    for key in obj:
2086 2087 2088 2089
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2090 2091 2092 2093 2094 2095
  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():
2096
      xml_data = self.generateXml(path=path)
2097
      bta.addObject(obj=xml_data, name=path, path=None)
2098

2099 2100
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2101
  def build(self, context, **kw):
2102 2103
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2104
    except KeyError:
2105 2106 2107 2108
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2109
    sql_search_result_tables = list(catalog.sql_search_tables)
2110
    key_list = []
2111
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2112
      if key in sql_search_result_tables:
2113
        key_list.append(key)
Aurel's avatar
Aurel committed
2114 2115
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2116 2117
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'key_list'] = key_list
2118 2119 2120 2121 2122 2123 2124 2125 2126 2127

  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
2128

2129
  def install(self, context, trashbin, **kw):
2130 2131 2132 2133 2134 2135 2136
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2137

2138
    sql_search_tables = list(catalog.sql_search_tables)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2139
    if context.getTemplateFormatVersion() == 1:
2140
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2141
        return
2142 2143 2144
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2145
    else:
2146
      keys = self._archive.keys()
2147 2148
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2149
    for key in keys:
2150 2151 2152 2153 2154 2155 2156
      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)
2157
    catalog.sql_search_tables = sql_search_tables
2158 2159

  def uninstall(self, context, **kw):
2160 2161
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2162
    except KeyError:
2163 2164 2165 2166 2167
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2168 2169 2170 2171 2172 2173
    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:
2174 2175
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2176
    catalog.sql_search_tables = sql_search_tables
2177 2178
    BaseTemplateItem.uninstall(self, context, **kw)

2179
  def generateXml(self, path=None):
2180
    obj = self._objects[path]
2181
    xml_data = '<key_list>'
2182 2183
    obj.sort()
    for key in obj:
2184 2185 2186 2187
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'    
    return xml_data

Aurel's avatar
Aurel committed
2188 2189 2190 2191 2192 2193
  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():
2194
      xml_data = self.generateXml(path=path)
2195
      bta.addObject(obj=xml_data, name=path, path=None)
2196

2197 2198 2199 2200 2201
class MessageTranslationTemplateItem(BaseTemplateItem):

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

2209
  def preinstall(self, context, installed_bt, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2210 2211
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229
      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):
2230
    localizer = context.getPortalObject().Localizer
2231 2232
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2233
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
2234
      for path, po in self._objects.items():
2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248
        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
2249
    else:
2250
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265
      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():
2266
      obj = self._objects[key]
Aurel's avatar
Aurel committed
2267 2268 2269
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
      f = open(path+'/translation.po', 'wt')
2270
      f.write(str(obj))
Aurel's avatar
Aurel committed
2271
      f.close()
2272

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

2277
class BusinessTemplate(XMLObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2278 2279
    """
    A business template allows to construct ERP5 modules
2280 2281 2282
    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
2283

2284 2285
    - catalog definition
      - SQL method objects
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2286 2287 2288 2289
      - SQL methods including:
        - purpose (catalog, uncatalog, etc.)
        - filter definition

2290 2291 2292
    - portal_types definition
      - object without optinal actions
      - list of relation between portal type and worklfow
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2293

2294
    - module definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2295
      - id
2296 2297
      - title
      - portal type
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2298 2299
      - roles/security

2300 2301 2302 2303
    - site property definition
      - id
      - type
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2304

2305 2306
    - document/propertysheet/extension/test definition
      - copy of the local file
2307

2308
    - message transalation definition
2309
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2310

2311 2312
    The Business Template properties are exported to the bt folder with
    one property per file
2313

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2314 2315
    Technology:

2316 2317
    - 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
2318

2319
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2320 2321 2322 2323

    Use case:

    - install core ERP5 (the minimum)
2324

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

2327 2328
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
2329
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2330 2331 2332 2333 2334
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
2335
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348
    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
2349
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2350
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2351
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2352 2353 2354
                      , PropertySheet.BusinessTemplate
                      )

2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 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
    # 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, )
          }
        )
      }

2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439
    # 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',
2440
      '_path_item',
2441 2442 2443 2444 2445 2446 2447 2448
      '_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
2449
      self._objects = PersistentMapping()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2450 2451 2452 2453 2454 2455
      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
2456
        self._baseGetTemplateFormatVersion()
2457

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2458 2459 2460 2461 2462 2463
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
        
      return 0
        
2464
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
2465 2466 2467 2468 2469 2470 2471
    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".
2472 2473
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
2474
          # XXX Not good to access the attribute directly,
2475 2476 2477
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
2478

2479
    security.declareProtected(Permissions.ManagePortal, 'build')
2480
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2481 2482 2483
      """
        Copy existing portal objects to self
      """
2484 2485
      if no_action: return # this is use at import of Business Template to get the status built
      
2486 2487
      # Make sure that everything is sane.
      self.clean()
2488

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2489 2490 2491
      # Set the format version.
      self._setTemplateFormatVersion(1)

2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537
      # 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)
2538

2539
    build = WorkflowMethod(build)
2540 2541

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2542
      """
2543
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2544
      """
2545
      return self.portal_templates.publish(self, url, username=username,
2546
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2547

2548
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2549
      """
2550
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2551
      """
2552
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2553

2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564
    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
2565
        installed_bt_format = installed_bt.getTemplateFormatVersion()
2566

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2567
      new_bt_format = self.getTemplateFormatVersion()
2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584
      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
2585
        old_item = getattr(installed_bt, item_name, None)
2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596
        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
      """
2597 2598
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
2599
      if installed_bt is not None:        
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2600
        if installed_bt.getTemplateFormatVersion() == 0:
2601 2602 2603
          # maybe another to uninstall old format bt, maybe not needed
          installed_bt.trash(self)
          force = 1
2604
        installed_bt.replace(self)
2605 2606 2607 2608 2609
        
      if not force:
        if len(object_to_update) == 0:
          # nothing to be done
          return
2610
      trash_tool = getToolByName(self, 'portal_trash', None)
2611 2612
      # 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
2613 2614
      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)
2615 2616 2617
      else:
        trashbin = None
        
2618
      # Update local dictionary containing all setup parameters
2619 2620 2621
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635
      
      # 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)
2636
      # Install everything
2637 2638 2639 2640 2641
      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
2642 2643 2644
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
2645

2646
    security.declareProtected(Permissions.ManagePortal, 'install')
2647 2648 2649 2650 2651
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
      """
      return self._install(**kw)
2652

2653
    install = WorkflowMethod(install)
2654

2655
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
2656
    def reinstall(self, **kw):
2657 2658 2659 2660
      """Reinstall Business Template.
      """
      return self._install(**kw)

2661
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2662

2663
    security.declareProtected(Permissions.ManagePortal, 'trash')
2664 2665
    def trash(self, new_bt, **kw):
      """
2666
        Trash unnecessary items before upgrading to a new business
2667
        template.
2668
        This is similar to uninstall, but different in that this does
2669
        not remove all items.
2670 2671 2672 2673 2674
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2675 2676 2677 2678 2679 2680 2681
      # 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))
2682

2683
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
2684
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2685
      """
2686
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2687
      """
2688 2689 2690 2691
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2692 2693 2694 2695 2696 2697
      # 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)
2698
      # It is better to clear cache because the uninstallation of a
2699
      # template deletes many things from the portal.
2700
      clearCache()
2701

2702 2703
    uninstall = WorkflowMethod(uninstall)

2704
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2705
    def _clean(self):
2706
      """
2707
        Clean built information.
2708
      """
2709
      # First, remove obsolete attributes if present.
Aurel's avatar
Aurel committed
2710
      self._objects = None
2711 2712 2713 2714
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
2715
                    '_module_archive',
2716 2717 2718
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
2719
                    '_property_sheet_archive'):
2720 2721 2722
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
2723 2724
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
2725

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

2728
    security.declareProtected(Permissions.AccessContentsInformation,
2729
                              'getBuildingState')
2730
    def getBuildingState(self, id_only=1):
2731
      """
2732
        Returns the current state in building
2733
      """
2734
      portal_workflow = getToolByName(self, 'portal_workflow')
2735 2736
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
2737
      return wf._getWorkflowStateOf(self, id_only=id_only )
2738

2739
    security.declareProtected(Permissions.AccessContentsInformation,
2740
                              'getInstallationState')
2741
    def getInstallationState(self, id_only=1):
2742
      """
2743
        Returns the current state in installation
2744
      """
2745
      portal_workflow = getToolByName(self, 'portal_workflow')
2746 2747
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
2748
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2749

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2750 2751 2752 2753 2754 2755
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
2756
      export_string = portal_templates.manage_exportObject(
2757 2758
                                               id=self.getId(),
                                               toxml=1,
2759
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2760
      return export_string
2761

2762
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2763
      """
2764 2765
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2766
      """
2767
      result = getattr(self, id, ())
2768 2769 2770 2771 2772 2773
      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
2774

2775
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2776
      """
2777 2778
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2779
      """
2780
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2781

2782
    def getTemplateBaseCategoryList(self):
2783
      """
2784 2785
      We have to set this method because we want an
      ordered list
2786
      """
2787
      return self._getOrderedList('template_base_category')
2788

2789
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2790
      """
2791 2792
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2793
      """
2794
      return self._getOrderedList('template_workflow_id')
2795

2796
    def getTemplatePortalTypeIdList(self):
2797
      """
2798 2799
      We have to set this method because we want an
      ordered list
2800
      """
2801
      return self._getOrderedList('template_portal_type_id')
2802

2803
    def getTemplateActionPathList(self):
2804
      """
2805 2806
      We have to set this method because we want an
      ordered list
2807
      """
2808
      return self._getOrderedList('template_action_path')
2809

2810
    def getTemplateSkinIdList(self):
2811
      """
2812 2813
      We have to set this method because we want an
      ordered list
2814
      """
2815
      return self._getOrderedList('template_skin_id')
2816

2817
    def getTemplateModuleIdList(self):
2818
      """
2819 2820
      We have to set this method because we want an
      ordered list
2821
      """
2822
      return self._getOrderedList('template_module_id')
2823 2824 2825 2826 2827 2828 2829

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

2831
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
2832 2833 2834 2835
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
2836 2837
      if self.getBuildingState() != 'built':
        raise TemplateConditionError, 'Business Template must be build before export'
2838
      
Aurel's avatar
Aurel committed
2839 2840 2841 2842 2843 2844 2845
      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)

2846
      # export bt
2847
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
2848
      for prop in self.propertyMap():
2849
        prop_type = prop['type']
Aurel's avatar
Aurel committed
2850
        id = prop['id']
2851
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id', 'install_object_list_list'):        
2852
          continue
Aurel's avatar
Aurel committed
2853
        value = self.getProperty(id)
2854
        if prop_type == 'text' or prop_type == 'string' or prop_type == 'int':
2855
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
2856
        elif prop_type == 'lines' or prop_type == 'tokens':
2857
          bta.addObject(obj=str(os.linesep).join(value), name=id, path=path+os.sep+'bt', ext='')
2858

Aurel's avatar
Aurel committed
2859 2860 2861
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
2862
        
Aurel's avatar
Aurel committed
2863 2864
      return bta.finishCreation()

2865
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
2866 2867
    def importFile(self, dir = 0, file=None, root_path=None):
      """
2868
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
2869 2870 2871 2872 2873 2874
      """

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

Aurel's avatar
Aurel committed
2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920
      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)
2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983


    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:
2984 2985
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005
        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