BusinessTemplate.py 120 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 54
from OFS import XMLExportImport
from cStringIO import StringIO
import difflib
Aurel's avatar
Aurel committed
55 56 57 58 59 60
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
61 62

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


72 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 100
catalog_method_list = ('_is_catalog_method_archive', '_is_catalog_list_method_archive',
                       '_is_uncatalog_method_archive', '_is_update_method_archive',
                       '_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
101 102 103
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
104
  """
Aurel's avatar
Aurel committed
105 106 107 108 109 110 111 112 113 114 115 116

  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
117

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

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

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

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

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

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

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

  def _initCreation(self, path):
182
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
183 184 185 186 187
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
188
      removeAll(self.path)
Aurel's avatar
Aurel committed
189 190 191 192 193 194
      os.makedirs(self.path)
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)

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

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

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

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

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

241 242
class TemplateConditionError(Exception): pass

243 244
class TemplateConflictError(Exception): pass

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

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

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

261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
  def preinstall(self, context, installed_bt, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
      modified_object_list = {}
      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_obj_xml = self.generate_xml(path=path)
          old_obj_xml = installed_bt.generate_xml(path=path)
          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)

309 310
  def diff(self, **kw):
    return ''
311

Aurel's avatar
Aurel committed
312
  def export(self, context, bta, **kw):
313
    pass
Aurel's avatar
Aurel committed
314 315

  def importFile(self, bta, **kw):
316
    bta.importFiles(klass=self)
317

318 319 320
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
321
  """
322

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

331 332 333 334 335 336 337 338 339 340 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():
      object=self._objects[key]
      # 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()
      XMLExportImport.exportXML(object._p_jar, object._p_oid, f)
      bta.addObject(object=f.getvalue(), name=id, path=path)

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

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

398 399 400 401 402 403 404 405 406 407
  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

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

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
549
    trash = kw.get('trash', 0)
550 551 552 553 554 555 556
    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._archive.keys()
    for relative_url in object_keys:
557 558
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
559
      try:        
560 561
        container = portal.unrestrictedTraverse(container_path)
        if trash:
562 563 564 565
          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
566
        pass
567 568
    BaseTemplateItem.uninstall(self, context, **kw)

569 570
  def _compareObjects(self, object1, object2, btsave_object_included=0):
    """
571
      Execute a diff between 2 objects,
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
      and return a string diff.
    """
    xml_dict = {
      str(object1): None,
      str(object2): None,
    }
    # Generate XML
    for object in (object1, object2):
      string_io = StringIO()
      XMLExportImport.exportXML(object._p_jar, object._p_oid, string_io)
      object_xml = string_io.getvalue()
      string_io.close()
      object_xml_lines = object_xml.splitlines(1)
      xml_dict[str(object)] = object_xml_lines
    # Make diff between XML
    diff_instance = difflib.Differ()
    diff_list = list(diff_instance.compare(xml_dict[str(object1)],
                                           xml_dict[str(object2)]))
    diff_list = [x for x in diff_list if x[0] != ' ']
591 592 593 594 595
#     # Dirty patch to remove useless diff message (id different)
#     if btsave_object_included==1:
#       if len(diff_list) == 3:
#         if '_btsave_' in diff_list[1]:
#           diff_list = []
596
    # Return string
597 598 599 600 601 602 603 604 605 606
    result = '%s' % ''.join(diff_list)
    return result

  def diff(self, archive_variable='_archive', max_deep=0, verbose=0):
    """
      Show all __btsave__ created, and make a diff between
      the current and the old version.
    """
    result = ''
    portal = self.getPortalObject()
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
    if (getattr(self, 'template_format_version', 0)) == 0:
      object_list = getattr(self, archive_variable).items()
    else:
      try:
        object_list = []
        keys = self._objects.keys()
        keys.sort()
        for path in keys:
          container_path = path.split('/')[2:-1]
          object_id = path.split('/')[-1]
          container = portal.unrestrictedTraverse(container_path)
          object = self._objects[path]
          object_list.append(('/'.join(path.split('/')[2:]), object))
      except:
        import pdb
        pdb.set_trace()

    for relative_url, object in object_list:
      # Browse all items stored
626 627 628 629 630 631 632 633 634 635 636 637 638 639
      object = portal.unrestrictedTraverse(relative_url)
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
      container = portal.unrestrictedTraverse(container_path)
      container_ids = container.objectIds()
      # Search _btsave_ object
      compare_object_couple_list = []
      btsave_id_list = []
      n = 1
      new_object_id = '%s_btsave_%s' % (object_id, n)
      while new_object_id in container_ids:
        # Found _btsave_ object
        btsave_id_list.append(new_object_id)
        compare_object_couple_list.append(
640 641 642 643
              (portal.unrestrictedTraverse(container_path+[object_id]),
               portal.unrestrictedTraverse(container_path+[new_object_id])))
#               (object, portal.unrestrictedTraverse(
#                                   container_path+[new_object_id])))
644 645
        n += 1
        new_object_id = '%s_btsave_%s' % (object_id, n)
646 647 648 649
#       if n == 1:
#         result += "$$$ Added: %s $$$\n" % \
#               ('/'.join(container_path+[object_id]))
#         result += '%s\n' % ('-'*80)
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
      # Find all objects to compare
      deep = 0
      while deep != max_deep:
        new_compare_object_couple_list = []
        for new_object, btsave_object in compare_object_couple_list:
          btsave_object_content_id_list = btsave_object.objectIds()
          for new_object_content_id in new_object.objectIds():
            if new_object_content_id in btsave_object_content_id_list:
              new_compare_object_couple_list.append(
                  (getattr(new_object, new_object_content_id),
                   getattr(btsave_object, new_object_content_id)))
              btsave_object_content_id_list.remove(new_object_content_id)
            else:
              result += "$$$ Added: %s/%s $$$\n" % \
                    (new_object.absolute_url(), new_object_content_id)
              result += '%s\n' % ('-'*80)
          for btsave_object_id in btsave_object_content_id_list:
            result += "$$$ Removed: %s/%s $$$\n" % \
                  (btsave_object.absolute_url(), btsave_object_id)
            result += '%s\n' % ('-'*80)
        if new_compare_object_couple_list == []:
          deep = max_deep
        else:
          compare_object_couple_list = new_compare_object_couple_list
          deep += 1
      # Now, we can compare all objects requested
      for new_object, btsave_object in compare_object_couple_list:
        tmp_diff = self._compareObjects(new_object, btsave_object,
                                        btsave_object_included=1)
        if tmp_diff != '':
          result += "$$$ %s $$$\n$$$ %s $$$\n" % \
              (new_object.absolute_url(),
               btsave_object.absolute_url())
          if verbose == 1:
684
            result += tmp_diff
685 686
          result += '%s\n' % ('-'*80)
    return result
687

688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
class PathTemplateItem(ObjectTemplateItem):
  """
    This class is used to store objects with wildcards supported.
  """
  def __init__(self, id_list, tool_id=None, **kw):
    BaseTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
    id_list = self._archive.keys()
    self._archive.clear()
    self._path_archive = PersistentMapping()
    for id in id_list:
      self._path_archive[id] = None

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

704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
      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.
      object = folder._getOb(id)
      return self._resolvePath(object, relative_url_list + [id], id_list[1:])
    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
719

720 721 722
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
723 724 725
    keys = self._path_archive.keys()
    keys.sort()    
    for path in keys:
726 727 728
      include_subobjects = 0
      if '**' in path:
        include_subobjects = 1
729 730 731
      for relative_url in self._resolvePath(p, [], path.split('/')):
        object = p.unrestrictedTraverse(relative_url)
        object = object._getCopy(context)
732
        id_list = object.objectIds()
733 734 735 736 737
        if hasattr(object, '__ac_local_roles__'):
          # remove local roles
          object.__ac_local_roles__ = None
        if hasattr(object, '_owner'):
          object._owner = None
Aurel's avatar
Aurel committed
738 739
        if hasattr(object, 'uid'):
          object.uid = None
740 741 742 743
        if hasattr(object, 'groups'):
          # we must keep groups because it's ereased when we delete subobjects
          groups = deepcopy(object.groups)
        if len(id_list) > 0:
744 745
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
746 747 748
          object.manage_delObjects(list(id_list))
        if hasattr(object, 'groups'):
          object.groups = groups          
Aurel's avatar
Aurel committed
749
        self._objects[relative_url] = object
750
        object.wl_clearLocks()
751
      
752 753
class CategoryTemplateItem(ObjectTemplateItem):

754 755
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
756

757 758 759 760
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
761
      object = p.unrestrictedTraverse(relative_url)
762
      object_copy = object._getCopy(context)
763 764 765 766 767
      if hasattr(object, '__ac_local_roles__'):
        # remove local roles
        object.__ac_local_roles__ = None
      if hasattr(object, '_owner'):
        object._owner = None
768 769 770 771
      id_list = object_copy.objectIds()
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
        object_copy.manage_delObjects(list(id_list))
772
      if hasattr(aq_base(object_copy), 'uid'):
773
        object_copy.uid = None        
774 775 776 777 778 779 780 781 782
      self._objects[relative_url] = object_copy
      object.wl_clearLocks()

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      object = p.unrestrictedTraverse(relative_url)
      object_copy = object._getCopy(context)
783 784 785 786 787
      if hasattr(object, '__ac_local_roles__'):
        # remove local roles
        object.__ac_local_roles__ = None
      if hasattr(object, '_owner'):
        object._owner = None
788 789 790 791 792 793 794 795 796 797 798
      include_sub_categories = object.getProperty('business_template_include_sub_categories', 0)
      id_list = object_copy.objectIds()
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
        object_copy.manage_delObjects(list(id_list))
      else:
        object_copy.manage_delObjects(list(id_list))
      if hasattr(aq_base(object_copy), 'uid'):
        object_copy.uid = None
      self._objects[relative_url] = object_copy
      object.wl_clearLocks()
799 800 801 802
      
  def install(self, context, trashbin, light_install = 0, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
803
    if (getattr(self, 'template_format_version', 0)) == 1:
804 805
      if light_install == 0:
        ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
806 807 808 809 810 811 812
      else:
        portal = context.getPortalObject()
        category_tool = portal.portal_categories
        tool_id = self.tool_id
        keys = self._objects.keys()
        keys.sort()
        for path in keys:
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
          if update_dict.has_key(path) or force:
            if not force:
              action = update_dict[path]
              if action == 'nothing':
                continue
            else:
              action = 'btsave'
            # Wrap the object by an aquisition wrapper for _aq_dynamic.
            object = self._objects[path]
            object = object.__of__(category_tool)
            container_path = path.split('/')[:-1]
            category_id = path.split('/')[-1]
            try:
              container = category_tool.unrestrictedTraverse(container_path)
            except KeyError:
              # parent object can be set to nothing, in this case just go on
              container_url = '/'.join(container_path)            
              if update_dict.has_key(container_url):
                if update_dict[container_url] == 'nothing':
                  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])
            category = container.newContent(portal_type=object.getPortalType(), id=category_id)
            for property in object.propertyIds():
              if property not in ('id', 'uid'):
                category.setProperty(property, object.getProperty(property, evaluate=0))
            # import sub objects if there is
            if len(subobjects_dict) > 0:
              # get a jar
              connection = object._p_jar
              obj = category
              while connection is None:
                obj = obj.aq_parent
                connection = obj._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)
858
    else:
859
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
860 861 862 863
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      if light_install==0:
864
        ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
865
      else:
866 867
        for relative_url in self._archive.keys():
          object = self._archive[relative_url]
Aurel's avatar
Aurel committed
868 869 870 871 872 873 874
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
          object = object.__of__(category_tool)
          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
875 876
            subobjects_dict = self.portal_trash.backupObject(trashbin, container_path, category_id, save=1)
            container.manage_delObjects([category_id])
Aurel's avatar
Aurel committed
877 878 879 880
          category = container.newContent(portal_type=object.getPortalType(), id=category_id)
          for property in object.propertyIds():
            if property not in ('id', 'uid'):
              category.setProperty(property, object.getProperty(property, evaluate=0))
881

882 883
class SkinTemplateItem(ObjectTemplateItem):

884 885
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
886

887 888 889
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
890
    if (getattr(self, 'template_format_version', 0)) == 1:
891
      ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
892 893 894 895 896
      p = context.getPortalObject()
      ps = p.portal_skins
      for skin_name, selection in ps.getSkinPaths():
        new_selection = []
        selection = selection.split(',')
897 898 899 900 901 902
        for relative_url in self._objects.keys():
          if update_dict.has_key(relative_url) or force:
            if not force:
              action = update_dict[relative_url]
              if action == 'nothing':
                continue
903 904 905
            object_path = relative_url.split('/')
            if len(object_path) > 2:
              continue # not a skin folder
906
            object = self._objects[relative_url]
907 908
            skin_id = object_path[1]
            if hasattr(aq_base(object), 'getProperty'):              
909 910 911 912 913 914
              selection_list = object.getProperty('business_template_registered_skin_selections', None)
            else:
              continue
            if selection_list is None or skin_name in selection_list:
              if skin_id not in selection and skin_id not in new_selection:
                new_selection.append(skin_id)
Aurel's avatar
Aurel committed
915 916
        new_selection.extend(selection)
        # sort the layer according to skin priorities
917
        new_selection.sort(lambda a, b : cmp( # separate functions here
Aurel's avatar
Aurel committed
918
          b in ps.objectIds() and ps[b].getProperty(
919
              'business_template_skin_layer_priority', 0) or 0,
Aurel's avatar
Aurel committed
920 921 922
          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)
923 924
      # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
      p.changeSkin(None)
Aurel's avatar
Aurel committed
925
    else:
926
      ObjectTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
927 928 929 930 931 932 933 934 935 936 937 938 939
      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)
        for object in folder.objectValues(spec=('Z SQL Method',)):
          if object.connection_id not in sql_connection_list:
            object.connection_id = sql_connection_list[0]
      # Add new folders into skin paths.
      ps = p.portal_skins
      for skin_name, selection in ps.getSkinPaths():
        new_selection = []
        selection = selection.split(',')
940 941
        for relative_url in self._archive.keys():
          object = self._archive[relative_url]
Aurel's avatar
Aurel committed
942 943 944 945 946 947 948 949 950
          skin_id = relative_url.split('/')[-1]
          selection_list = object.getProperty('business_template_registered_skin_selections', None)
          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(
951
              'business_template_skin_layer_priority', 0) or 0,
Aurel's avatar
Aurel committed
952 953 954
          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)
955 956
      # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
      p.changeSkin(None)
957 958 959

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
960 961 962 963 964
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()    
965
    ps = context.portal_skins
966
    skin_id_list = [relative_url.split('/')[-1] for relative_url in object_keys]
967 968 969 970 971 972 973
    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)
974
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
975
    context.getPortalObject().changeSkin(None)
976

977 978
    ObjectTemplateItem.uninstall(self, context, **kw)

979 980
  def diff(self, max_deep=1, **kw):
    return ObjectTemplateItem.diff(self, max_deep=max_deep, **kw)
981

982
class WorkflowTemplateItem(ObjectTemplateItem):
983

984 985
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
986

987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
  def preinstall(self, context, installed_bt, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
      modified_object_list = {}
      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):
    if (getattr(self, 'template_format_version', 0)) == 1:
      groups = {}
      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:
            action = 'btsave'
          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])
          object = self._objects[path]
          object = object._getCopy(container)
          container._setObject(object_id, object)
          object = container._getOb(object_id)
          object.manage_afterClone(object)
          object.wl_clearLocks()
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)

  

1061 1062 1063 1064 1065 1066 1067 1068
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
1069
    This is only useful in order to use
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
    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)

1094 1095
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1096 1097 1098
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1099 1100 1101 1102
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      object = p.unrestrictedTraverse(relative_url)
      object = object._getCopy(context)
Aurel's avatar
Aurel committed
1103 1104
      id_list = object.objectIds()
      # remove optional actions
1105 1106 1107 1108 1109 1110
      optional_action_list = []
      for index,ai in enumerate(object.listActions()):
        if ai.getOption():
          optional_action_list.append(index)
      if len(optional_action_list) > 0:
        object.deleteActions(selections=optional_action_list)
1111 1112 1113 1114 1115
      if hasattr(object, '__ac_local_roles__'):
        # remove local roles
        object.__ac_local_roles__ = None
      if hasattr(object, '_owner'):
        object._owner = None
Aurel's avatar
Aurel committed
1116 1117 1118
      if hasattr(object, 'uid'):
        object.uid = None
      self._objects[relative_url] = object
1119
      object.wl_clearLocks()
Aurel's avatar
Aurel committed
1120
    # also export workflow chain
1121
    (default_chain, chain_dict) = self._getChainByType(context)
Aurel's avatar
Aurel committed
1122
    for object in self._objects.values():
1123 1124 1125
      portal_type = object.id
      self._workflow_chain_archive[portal_type] = chain_dict['chain_%s' % portal_type]

Aurel's avatar
Aurel committed
1126 1127 1128 1129
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
1130
    # export portal type object
1131
    ObjectTemplateItem.export(self, context, bta, **kw)
1132 1133
    # export workflow chain
    xml_data = '<workflow_chain>'
1134 1135 1136
    keys = self._workflow_chain_archive.keys()
    keys.sort()
    for key in keys:
1137 1138 1139
      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],)
1140
      xml_data += os.linesep+' </chain>'
1141 1142
    xml_data += os.linesep+'</workflow_chain>'
    bta.addObject(object=xml_data, name='workflow_chain_type',  path=root_path)
1143

1144 1145 1146 1147
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1148 1149 1150 1151 1152 1153
    # 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
1154 1155
    default_chain = ''
    if (getattr(self, 'template_format_version', 0)) == 1:
1156
      objects_list = self._objects
1157
    else:
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
      objects_list = self._archive
    for path in objects_list.keys():
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
            continue          
        object = objects_list[path]
        portal_type = object.id
        chain_dict['chain_%s' % portal_type] = \
                              self._workflow_chain_archive[portal_type]
        context.portal_workflow.manage_changeWorkflows(default_chain,
                                                       props=chain_dict)

  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
1173 1174 1175
    """
      Backup portal type and keep the workflow chain.
    """
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
    subobjects_dict = {}
    if action == 'btsave':
      # Get the chain value
#       (default_chain, chain_dict) = self._getChainByType(self)
#       chain = chain_dict['chain_%s' % object_id]
      # Backup the portal type    
      subobjects_dict = ObjectTemplateItem._backupObject(self, action, trashbin, container_path,
                                                        object_id, **kw)
    return subobjects_dict
      # Restore the chain to the backuped portal type
#       (default_chain, chain_dict) = self._getChainByType(self)
#       chain_dict['chain_%s' % backup_id] = chain
#       self.portal_workflow.manage_changeWorkflows(default_chain,
#                                                   props=chain_dict)
1190 1191 1192

  def diff(self, verbose=0, **kw):
    """
1193
      Make a diff between portal type.
1194 1195 1196 1197 1198 1199
      Also compare the workflow chain.
    """
    # Compare XML portal type
    result = ObjectTemplateItem.diff(self, verbose=verbose, **kw)
    # Compare chains
    container_ids = self.portal_types.objectIds()
1200 1201 1202 1203 1204 1205 1206 1207 1208
    if (getattr(self, 'template_format_version', 0)) == 0:
      for object in self._archive.values():
        try:
          object_id = object.id
        except:
          import pdb
          pdb.set_trace()
        object_chain = self.portal_workflow.getChainFor(object_id)
        n = 1
1209
        new_object_id = '%s_btsave_%s' % (object_id, n)
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
        while new_object_id in container_ids:
          backuped_object_chain = self.portal_workflow.getChainFor(new_object_id)
          if object_chain != backuped_object_chain:
            result += "$$$ Workflow chains: " \
                       "%s and %s $$$\n" % \
                        (object_id, new_object_id)
            if verbose:
              result += '"%s" != "%s"\n' % (object_chain, backuped_object_chain)
            result += '%s\n' % ('-'*80)
          n += 1
          new_object_id = '%s_btsave_%s' % (object_id, n)
1221
    return result
1222

1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
  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:
        type = chain.getElementsByTagName('type')[0].childNodes[0].data
        workflow_list = chain.getElementsByTagName('workflow')[0].childNodes
        if len(workflow_list) == 0:
          workflow = ''
        else:
          workflow = workflow_list[0].data
        dict[str(type)] = str(workflow)
      self._workflow_chain_archive = dict
    else:
      ObjectTemplateItem._importFile(self, file_name, file)


1242 1243
class CatalogMethodTemplateItem(ObjectTemplateItem):

1244 1245
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1246
    self._is_catalog_method_archive = PersistentMapping()
1247
    self._is_catalog_list_method_archive = PersistentMapping()
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
    self._is_uncatalog_method_archive = PersistentMapping()
    self._is_update_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)
1258 1259
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1260 1261
    except KeyError:
      catalog = None
1262
    if catalog is None:
1263
      LOG('BusinessTemplate build', 0, 'catalog not found')
1264
      return
1265
    for onbject in self._objects.values():
1266
      method_id = object.id
1267 1268 1269 1270 1271
      self._is_catalog_method_archive[method_id] = method_id in catalog.sql_catalog_object
      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_update_method_archive[method_id] = method_id in catalog.sql_update_object
      self._is_clear_method_archive[method_id] = method_id in catalog.sql_clear_catalog
1272
      self._is_filtered_archive[method_id] = 0
1273 1274 1275 1276 1277
      if catalog.filter_dict.has_key(method_id):
        self._is_filtered_archive[method_id] = catalog.filter_dict[method_id]['filtered']
        self._filter_expression_archive[method_id] = catalog.filter_dict[method_id]['expression']
        self._filter_expression_instance_archive[method_id] = catalog.filter_dict[method_id]['expression_instance']
        self._filter_type_archive[method_id] = catalog.filter_dict[method_id]['type']
1278

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

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

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

1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
    new_bt_format = getattr(self, 'template_format_version', 0)

    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])
          
Aurel's avatar
Aurel committed
1366
    for object in values:
1367
      method_id = object.id
1368

Aurel's avatar
Aurel committed
1369 1370 1371 1372 1373 1374
      is_catalog_method = int(self._is_catalog_method_archive[method_id])
      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_update_method = int(self._is_update_method_archive[method_id])
      is_clear_method = int(self._is_clear_method_archive[method_id])
      is_filtered = int(self._is_filtered_archive[method_id])
1375 1376 1377 1378 1379 1380

      if is_catalog_method and method_id not in sql_catalog_object:
        sql_catalog_object.append(method_id)
      elif not is_catalog_method and method_id in sql_catalog_object:
        sql_catalog_object.remove(method_id)

1381 1382 1383 1384 1385
      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)

1386
      if is_uncatalog_method and method_id not in sql_uncatalog_object:
1387
        sql_uncatalog_object.append(method_id)
1388
      elif not is_uncatalog_method and method_id in sql_uncatalog_object:
1389 1390
        sql_uncatalog_object.remove(method_id)

1391
      if is_update_method and method_id not in sql_update_object:
1392
        sql_update_object.append(method_id)
1393
      elif not is_update_method and method_id in sql_update_object:
1394 1395 1396 1397 1398 1399 1400 1401
        sql_update_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:
1402
        expression = self._filter_expression_archive[method_id]
1403 1404 1405 1406
        if (getattr(self, 'template_format_version', 0)) == 1:
          expr_instance = Expression(expression)
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
1407
        type = self._filter_type_archive[method_id]
1408 1409 1410
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
1411
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
1412
        catalog.filter_dict[method_id]['type'] = type
1413
      elif method_id in catalog.filter_dict.keys():
1414
        catalog.filter_dict[method_id]['filtered'] = 0
1415 1416

    sql_catalog_object.sort()
1417 1418 1419
    catalog.sql_catalog_object = tuple(sql_catalog_object)
    sql_catalog_object_list.sort()
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
1420
    sql_uncatalog_object.sort()
1421
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
1422
    sql_update_object.sort()
1423
    catalog.sql_update_object = tuple(sql_update_object)
1424
    sql_clear_catalog.sort()
1425
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1426 1427

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

1429
    ObjectTemplateItem.uninstall(self, context, **kw)
1430 1431
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1432
    except KeyError:
1433 1434 1435 1436 1437 1438
      catalog = None

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

1439 1440 1441 1442 1443 1444 1445 1446
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
      values = self._archive.values()
    else:      
      values.append(self._archive[object_path])

1447 1448 1449 1450 1451 1452
    # Make copies of attributes of the default catalog of portal_catalog.
    sql_catalog_object = list(catalog.sql_catalog_object)
    sql_catalog_object_list = list(catalog.sql_catalog_object_list)
    sql_uncatalog_object = list(catalog.sql_uncatalog_object)
    sql_update_object = list(catalog.sql_update_object)
    sql_clear_catalog = list(catalog.sql_clear_catalog)
1453

1454
    for object in values:
1455 1456 1457 1458 1459
      method_id = object.id

      if method_id in sql_catalog_object:
        sql_catalog_object.remove(method_id)

1460 1461 1462
      if method_id in sql_catalog_object_list:
        sql_catalog_object_list.remove(method_id)

1463 1464 1465 1466 1467 1468 1469 1470 1471
      if method_id in sql_uncatalog_object:
        sql_uncatalog_object.remove(method_id)

      if method_id in sql_update_object:
        sql_update_object.remove(method_id)

      if method_id in sql_clear_catalog:
        sql_clear_catalog.remove(method_id)

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1472
      if catalog.filter_dict.has_key(method_id):
1473
        del catalog.filter_dict[method_id]
1474

1475 1476 1477 1478 1479
    catalog.sql_catalog_object = tuple(sql_catalog_object)
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
    catalog.sql_update_object = tuple(sql_update_object)
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1480 1481

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

1483
  def _importFile(self, file_name, file):
1484
    if not '.catalog_keys' in file_name:
1485 1486 1487 1488 1489 1490 1491 1492
      # 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
1493
    elif '.catalog_keys' in file_name:
1494 1495 1496 1497
      # recreate data mapping specific to catalog method
      path, name = os.path.split(file_name)
      id = string.split(name, '.')[0]
      xml = parse(file)
1498
      method_list = xml.getElementsByTagName('item')
1499
      for method in method_list:
1500 1501 1502 1503 1504 1505 1506
        key = method.getAttribute('key')
        type = str(method.getAttribute('type'))
        if type == "str":
          value = str(method.getElementsByTagName('value')[0].childNodes[0].data)
          key = str(key)
        elif type == "int":
          value = int(method.getElementsByTagName('value')[0].childNodes[0].data)
1507 1508 1509 1510 1511 1512
          key = str(key)
        elif type == "tuple":
          value = []
          value_list = method.getElementsByTagName('value')
          for item in value_list:
            value.append(item.childNodes[0].data)
1513
        else:
1514 1515
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, type)
          continue
1516 1517 1518 1519
        dict = getattr(self, key)
        dict[id] = value

class ActionTemplateItem(ObjectTemplateItem):
1520 1521 1522 1523

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

1525
      "foo/bar[id=zoo]"
1526

1527
      into
1528

1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
      "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):
1543
    # XXX It's look like ObjectTemplateItem __init__
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
    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)
      object = p.unrestrictedTraverse(relative_url)
      for ai in object.listActions():
        if getattr(ai, key) == value:
1558
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1559 1560
          key = os.path.join(url[-2], url[-1], value)
          object = ai._getCopy(context)
1561 1562 1563 1564 1565
          if hasattr(object, '__ac_local_roles__'):
            # remove local roles
            object.__ac_local_roles__ = None
          if hasattr(object, '_owner'):
            object._owner = None
Aurel's avatar
Aurel committed
1566 1567 1568 1569
          if hasattr(object, 'uid'):
            object.uid = None
          self._objects[key] = object
          self._objects[key].wl_clearLocks()
1570 1571
          break
      else:
1572
        raise NotFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1573

1574 1575 1576
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1577
    if (getattr(self, 'template_format_version', 0)) == 1:
Aurel's avatar
Aurel committed
1578 1579
      p = context.getPortalObject()
      for id in self._objects.keys():
1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          path = id.split(os.sep)
          object = p.unrestrictedTraverse(path[:-1])
          action_list = object.listActions()
          for index in range(len(action_list)):
            if getattr(action_list[index], 'id') == path[-1]:          
              # remove previous action
              object.deleteActions(selections=(index,))
          action = self._objects[id]
          object.addAction(
                        id = action.id
                      , name = action.title
                      , action = action.action.text
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
                      , icon = getattr(action, 'icon', None) and action.icon.text or ''
                      , optional = getattr(action, 'optional', 0)
Aurel's avatar
Aurel committed
1603 1604
                    )
    else:
1605
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1606
      p = context.getPortalObject()
1607 1608
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
        relative_url, key, value = self._splitPath(id)
        object = p.unrestrictedTraverse(relative_url)
        for ai in object.listActions():
          if getattr(ai, key) == value:
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (object.id, value)
        object.addAction(
                      id = action.id
                    , name = action.title
                    , action = action.action.text
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
                    , icon = getattr(action, 'icon', None) and action.icon.text or ''
                    , optional = getattr(action, 'optional', 0)
                    )
1625 1626 1627

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1628 1629 1630 1631 1632 1633 1634 1635
    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]
1636 1637 1638 1639
      relative_url, key, value = self._splitPath(id)
      object = p.unrestrictedTraverse(relative_url)
      action_list = object.listActions()
      for index in range(len(action_list)):
1640
        if getattr(action_list[index], key) == value:
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
          object.deleteActions(selections=(index,))
          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():
1651 1652
      for property in p.propertyMap():
        if property['id'] == id:
Aurel's avatar
Aurel committed
1653 1654
          object = p.getProperty(id)
          type = property['type']
1655 1656
          break
      else:
Aurel's avatar
Aurel committed
1657 1658
        object = None
      if object is None:
1659
        raise NotFound, 'the property %s is not found' % id
Aurel's avatar
Aurel committed
1660 1661
      self._objects[id] = (type, object)

1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
  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
      type = prop.getElementsByTagName('type')[0].childNodes[0].data
      if type in ('lines', 'tokens'):
        value = []
        values = prop.getElementsByTagName('value')[0]
        items = values.getElementsByTagName('item')
        for item in items:
          i = item.childNodes[0].data
          value.append(str(i))
      else:
1677
        value = str(prop.getElementsByTagName('value')[0].childNodes[0].data)
1678 1679
      self._objects[str(id)] = (str(type), value)

1680 1681 1682
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1683
    if (getattr(self, 'template_format_version', 0)) == 1:
Aurel's avatar
Aurel committed
1684 1685
      p = context.getPortalObject()
      for path in self._objects.keys():
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
        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
          type, property = self._objects[path]
          p._setProperty(id, property, type=type)
Aurel's avatar
Aurel committed
1696
    else:
1697
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1698
      p = context.getPortalObject()
1699 1700
      for id,property in self._archive.keys():
        property = self._archive[id]
Aurel's avatar
Aurel committed
1701 1702 1703 1704 1705
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
1706 1707 1708

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
1709 1710 1711 1712 1713 1714
    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:
1715 1716 1717 1718
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732
  def generate_xml(self, path=None):
    xml_data = ''
    type, object=self._objects[path]
    xml_data += os.linesep+' <property>'
    xml_data += os.linesep+'  <id>%s</id>' %(path,)
    xml_data += os.linesep+'  <type>%s</type>' %(type,)
    if type in ('lines', 'tokens'):
      xml_data += os.linesep+'  <value>'
      for item in object:
        if item != '':
          xml_data += os.linesep+'   <item>%s</item>' %(item,)
      xml_data += os.linesep+'  </value>'
    else:
      xml_data += os.linesep+'  <value>%r</value>' %((os.linesep).join(object),)
1733
    xml_data += os.linesep+' </property>'
1734 1735
    return xml_data

Aurel's avatar
Aurel committed
1736 1737 1738 1739 1740
  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)
1741 1742 1743 1744
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
1745
      xml_data += self.generate_xml(path)
1746 1747
    xml_data += os.linesep+'</site_property>'
    bta.addObject(object=xml_data, name='properties', path=root_path)
1748

1749 1750
class ModuleTemplateItem(BaseTemplateItem):

1751 1752
  def diff(self, max_deep=1, **kw):
    return ''
Aurel's avatar
Aurel committed
1753

1754 1755 1756 1757 1758
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
      module = p.unrestrictedTraverse(id)
1759 1760 1761 1762 1763 1764 1765 1766
      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
1767

1768 1769 1770
  def generate_xml(self, path=None):
    dict = self._objects[path]
    xml_data = '<module>'
1771 1772 1773 1774
    # sort key
    keys = dict.keys()
    keys.sort()
    for key in keys:
1775 1776 1777 1778 1779 1780 1781
      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
1782
          role_list = list(perm[1])
1783
          role_list.sort()
1784 1785 1786 1787 1788 1789 1790 1791 1792
          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

1793 1794 1795 1796 1797
  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)
1798 1799 1800
    keys = self._objects.keys()
    keys.sort()
    for id in keys:
1801 1802
      # expor module one by one
      xml_data = self.generate_xml(path=id)
1803 1804
      bta.addObject(object=xml_data, name=id, path=path)

1805
  def install(self, context, trashbin, **kw):
1806
    portal = context.getPortalObject()
1807 1808
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1809
    if (getattr(self, 'template_format_version', 0)) == 1:
1810
      items = self._objects
1811
    else:
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834
      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
1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865

  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

1866
  def uninstall(self, context, **kw):
1867 1868 1869 1870 1871 1872 1873
    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]
1874 1875
    p = context.getPortalObject()
    id_list = p.objectIds()
1876
    for id in keys:
1877
      if id in id_list:
1878
        try:
1879 1880 1881
          if trash:
            container_path = id.split('/')
            self.portal_trash.backupObject(trashbin, container_path, id, save=1, keep_subobjects=1)
1882
          p.manage_delObjects([id])
1883
        except NotFound:
1884
          pass
1885 1886
    BaseTemplateItem.uninstall(self, context, **kw)

1887 1888 1889
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
1890 1891

class DocumentTemplateItem(BaseTemplateItem):
1892 1893 1894 1895
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
1896 1897 1898 1899

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

1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
  def preinstall(self, context, installed_bt, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
      modified_object_list = {}
      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')
1925
    if (getattr(self, 'template_format_version', 0)) == 1:
Aurel's avatar
Aurel committed
1926
      for id in self._objects.keys():
1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940
        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
1941
    else:
1942 1943 1944
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
1945
        # This raises an exception if the file exists.
1946
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
1947 1948
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
1949 1950

  def uninstall(self, context, **kw):
1951 1952 1953 1954 1955 1956
    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:
1957
      globals()[self.local_file_remover_name](id)
1958 1959
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
1960 1961 1962 1963 1964 1965 1966 1967 1968
  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():
      object=self._objects[path]
      bta.addObject(object=object, name=path, path=None, ext='.py')

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

1973 1974 1975 1976 1977 1978
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

1979

1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
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
1994

1995 1996 1997
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
1998 1999 2000

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2001 2002 2003 2004
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
2005 2006
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
2007

2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
  def preinstall(self, context, installed_bt, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
      modified_object_list = {}
      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):
2025
    p = context.getPortalObject()
2026
    # get roles
2027
    if (getattr(self, 'template_format_version', 0)) == 1:
2028
      role_list = self._objects.keys()
2029
    else:
2030
      role_list = self._archive.keys()
2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042
    # 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
2043
    for role in role_list:
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053
      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
2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065

  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)

2066 2067 2068 2069 2070 2071 2072 2073 2074
  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
2075
      if role in roles and role not in new_roles:
2076 2077 2078
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

2079 2080 2081
  def generate_xml(self, path):
    object=self._objects[path]
    xml_data = '<role_list>'
2082
    object.sort()
2083 2084 2085 2086 2087
    for role in object:
      xml_data += os.linesep+' <role>%s</role>' %(role)
    xml_data += os.linesep+'</role_list>'
    return xml_data

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

2097 2098
class CatalogResultKeyTemplateItem(BaseTemplateItem):

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

  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

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

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

2157
  def uninstall(self, context, **kw):
2158 2159
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2160
    except KeyError:
2161 2162 2163 2164 2165
      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)
2166 2167 2168 2169 2170 2171
    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:
2172 2173
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
2174
    catalog.sql_search_result_keys = sql_search_result_keys
2175 2176
    BaseTemplateItem.uninstall(self, context, **kw)

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

Aurel's avatar
Aurel committed
2186 2187 2188 2189 2190
  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)
2191
    for path in self._objects.keys():
2192
      xml_data = self.generate_xml(path=path)
2193
      bta.addObject(object=xml_data, name=path, path=None)
2194

2195 2196
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2197
  def build(self, context, **kw):
2198 2199
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2200
    except KeyError:
2201 2202 2203 2204
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2205
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
2206
    key_list = []
2207
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2208
      if key in sql_search_related_keys:
2209
        key_list.append(key)
Aurel's avatar
Aurel committed
2210 2211
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2212 2213
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'key_list'] = key_list
2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224

  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

2225
  def install(self, context, trashbin, **kw):
2226 2227 2228 2229 2230 2231 2232
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2233

2234
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2235 2236
    if (getattr(self, 'template_format_version', 0)) == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2237
        return
2238 2239 2240
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2241
    else:
2242
      keys = self._archive.keys()
2243 2244
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2245
    for key in keys:
2246 2247 2248 2249 2250 2251 2252
      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)
2253
    catalog.sql_catalog_related_keys = sql_catalog_related_keys
2254

2255 2256 2257
  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2258
    except KeyError:
2259 2260 2261 2262
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2263
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
2264 2265 2266 2267 2268 2269
    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:
2270 2271 2272 2273 2274
      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)

2275 2276 2277
  def generate_xml(self, path=None):
    object=self._objects[path]
    xml_data = '<key_list>'
2278
    object.sort()
2279 2280 2281 2282 2283
    for key in object:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'
    return xml_data

Aurel's avatar
Aurel committed
2284 2285 2286 2287 2288 2289
  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():
2290
      xml_data = self.generate_xml(path=path)
2291
      bta.addObject(object=xml_data, name=path, path=None)
2292

2293 2294
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
2295
  def build(self, context, **kw):
2296 2297
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2298
    except KeyError:
2299 2300 2301 2302
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
2303
    sql_search_result_tables = list(catalog.sql_search_tables)
2304
    key_list = []
2305
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
2306
      if key in sql_search_result_tables:
2307
        key_list.append(key)
Aurel's avatar
Aurel committed
2308 2309
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
2310 2311
    if len(key_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'key_list'] = key_list
2312 2313 2314 2315 2316 2317 2318 2319 2320 2321

  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
2322

2323
  def install(self, context, trashbin, **kw):
2324 2325 2326 2327 2328 2329 2330
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except KeyError:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2331

2332
    sql_search_tables = list(catalog.sql_search_tables)
2333 2334
    if (getattr(self, 'template_format_version', 0)) == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
2335
        return
2336 2337 2338
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
2339
    else:
2340
      keys = self._archive.keys()
2341 2342
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2343
    for key in keys:
2344 2345 2346 2347 2348 2349 2350
      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)
2351
    catalog.sql_search_tables = sql_search_tables
2352 2353

  def uninstall(self, context, **kw):
2354 2355
    try:
      catalog = context.portal_catalog.getSQLCatalog()
2356
    except KeyError:
2357 2358 2359 2360 2361
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
2362 2363 2364 2365 2366 2367
    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:
2368 2369
      if key in sql_search_tables:
        sql_search_tables.remove(key)
2370
    catalog.sql_search_tables = sql_search_tables
2371 2372
    BaseTemplateItem.uninstall(self, context, **kw)

2373 2374 2375
  def generate_xml(self, path=None):
    object=self._objects[path]
    xml_data = '<key_list>'
2376
    object.sort()
2377 2378 2379 2380 2381
    for key in object:
      xml_data += os.linesep+' <key>%s</key>' %(key)
    xml_data += os.linesep+'</key_list>'    
    return xml_data

Aurel's avatar
Aurel committed
2382 2383 2384 2385 2386 2387
  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():
2388
      xml_data = self.generate_xml(path=path)
2389
      bta.addObject(object=xml_data, name=path, path=None)
2390

2391 2392 2393 2394 2395
class MessageTranslationTemplateItem(BaseTemplateItem):

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

2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423
  def preinstall(self, context, installed_bt, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
      modified_object_list = {}
      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):
2424
    localizer = context.getPortalObject().Localizer
2425 2426
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2427
    if (getattr(self, 'template_format_version', 0)) == 1:
Aurel's avatar
Aurel committed
2428
      for path, po in self._objects.items():
2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442
        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
2443
    else:
2444
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465
      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():
      object = self._objects[key]
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
      f = open(path+'/translation.po', 'wt')
      f.write(str(object))
      f.close()
2466

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

2471
class BusinessTemplate(XMLObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2472 2473
    """
    A business template allows to construct ERP5 modules
2474 2475 2476
    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
2477

2478 2479
    - catalog definition
      - SQL method objects
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2480 2481 2482 2483
      - SQL methods including:
        - purpose (catalog, uncatalog, etc.)
        - filter definition

2484 2485 2486
    - portal_types definition
      - object without optinal actions
      - list of relation between portal type and worklfow
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2487

2488
    - module definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2489
      - id
2490 2491
      - title
      - portal type
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2492 2493
      - roles/security

2494 2495 2496 2497
    - site property definition
      - id
      - type
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2498

2499 2500
    - document/propertysheet/extension/test definition
      - copy of the local file
2501

2502
    - message transalation definition
2503
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2504

2505 2506
    The Business Template properties are exported to the bt folder with
    one property per file
2507

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2508 2509
    Technology:

2510 2511
    - 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
2512

2513
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2514 2515 2516 2517

    Use case:

    - install core ERP5 (the minimum)
2518

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

2521 2522
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
2523
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2524 2525 2526 2527 2528
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
2529
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542
    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
2543
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2544
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2545
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2546 2547 2548
                      , PropertySheet.BusinessTemplate
                      )

2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623
    # 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'            : 'diff'
          , 'name'          : 'Diff'
          , 'category'      : 'object_view'
          , 'action'        : 'BusinessTemplate_viewDiff'
          , '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, )
          }
        )
      }

2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640
    # 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',
2641
      '_path_item',
2642 2643 2644 2645 2646 2647 2648 2649 2650
      '_action_item',
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
      # Initialize all item to None
Aurel's avatar
Aurel committed
2651
      self._objects = PersistentMapping()
2652 2653
      for item_name in self._item_name_list:
        setattr(self, item_name, None)
2654

2655
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
2656 2657 2658 2659 2660 2661 2662
    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".
2663 2664
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
2665
          # XXX Not good to access the attribute directly,
2666 2667 2668
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
2669

2670
    security.declareProtected(Permissions.ManagePortal, 'build')
2671
    def build(self, no_action=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2672 2673 2674
      """
        Copy existing portal objects to self
      """
2675 2676
      if no_action: return # this is use at import of Business Template to get the status built
      
2677 2678
      # Make sure that everything is sane.
      self.clean()
2679

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2680 2681
      # XXX Trim down the history to prevent it from bloating the bt5 file.
      # XXX Is there any better way to shrink the size???
Aurel's avatar
Aurel committed
2682
      # XXX Is it still necessary as it is not saved in new bt format ??
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2683 2684
      portal_workflow = getToolByName(self, 'portal_workflow')
      wf_id_list = portal_workflow.getChainFor(self)
2685
      original_history_dict = {}
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2686 2687 2688 2689 2690 2691
      for wf_id in wf_id_list:
        history = portal_workflow.getHistoryOf(wf_id, self)
        if history is not None and len(history) > 30:
          original_history_dict[wf_id] = history
          LOG('Business Template', 0, 'trim down the history of %s' % (wf_id,))
          self.workflow_history[wf_id] = history[-30:]
2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737
      # 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)
2738

2739
    build = WorkflowMethod(build)
2740 2741

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2742
      """
2743
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2744
      """
2745
      return self.portal_templates.publish(self, url, username=username,
2746
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2747

2748
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2749
      """
2750
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2751
      """
2752
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2753

2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796
    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:
        installed_bt_format = getattr(installed_bt, 'template_format_version', 0)

      new_bt_format = getattr(self, 'template_format_version', 0)      
      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)
        old_item = getattr(installed_bt, item_name)
        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
      """
2797 2798
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
2799 2800 2801 2802 2803
      if installed_bt is not None:        
        if getattr(installed_bt, 'template_format_version', 0) == 0:
          # maybe another to uninstall old format bt, maybe not needed
          installed_bt.trash(self)
          force = 1
2804
        installed_bt.replace(self)
2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817
        
      if not force:
        if len(object_to_update) == 0:
          # nothing to be done
          return
        
      # always created a trash bin because we may to save object already present
      # but not in a previous business templates apart at creation of a new site
      if len(object_to_update) > 0 or len(self.portal_templates.objectIds()) > 1:
        trashbin = self.portal_trash.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None
        
2818
      # Update local dictionary containing all setup parameters
2819 2820 2821
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835
      
      # 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)
2836
      # Install everything
2837 2838 2839 2840 2841
      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
2842 2843 2844
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
2845

2846
    security.declareProtected(Permissions.ManagePortal, 'install')
2847 2848 2849 2850 2851
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
      """
      return self._install(**kw)
2852

2853
    install = WorkflowMethod(install)
2854

2855
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
2856
    def reinstall(self, **kw):
2857 2858 2859 2860
      """Reinstall Business Template.
      """
      return self._install(**kw)

2861
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2862

2863
    security.declareProtected(Permissions.ManagePortal, 'trash')
2864 2865
    def trash(self, new_bt, **kw):
      """
2866
        Trash unnecessary items before upgrading to a new business
2867
        template.
2868
        This is similar to uninstall, but different in that this does
2869
        not remove all items.
2870 2871 2872 2873 2874
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2875 2876 2877 2878 2879 2880 2881
      # 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))
2882

2883
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
2884
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2885
      """
2886
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2887
      """
2888 2889 2890 2891
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2892 2893 2894 2895 2896 2897
      # 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)
2898
      # It is better to clear cache because the uninstallation of a
2899
      # template deletes many things from the portal.
2900
      clearCache()
2901

2902 2903
    uninstall = WorkflowMethod(uninstall)

2904
    security.declareProtected(Permissions.ManagePortal, 'clean')
2905
    def clean(self):
2906
      """
2907
        Clean built information.
2908
      """
2909
      # First, remove obsolete attributes if present.
Aurel's avatar
Aurel committed
2910
      self._objects = None
2911 2912 2913 2914
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
2915
                    '_module_archive',
2916 2917 2918
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
2919
                    '_property_sheet_archive'):
2920 2921 2922
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
2923 2924
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
2925 2926

    clean = WorkflowMethod(clean)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2927

2928
    security.declareProtected(Permissions.AccessContentsInformation,
2929
                              'getBuildingState')
2930
    def getBuildingState(self, id_only=1):
2931
      """
2932
        Returns the current state in building
2933
      """
2934
      portal_workflow = getToolByName(self, 'portal_workflow')
2935 2936
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
2937
      return wf._getWorkflowStateOf(self, id_only=id_only )
2938

2939
    security.declareProtected(Permissions.AccessContentsInformation,
2940
                              'getInstallationState')
2941
    def getInstallationState(self, id_only=1):
2942
      """
2943
        Returns the current state in installation
2944
      """
2945
      portal_workflow = getToolByName(self, 'portal_workflow')
2946 2947
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
2948
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2949

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2950 2951 2952 2953 2954 2955
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
2956
      export_string = portal_templates.manage_exportObject(
2957 2958
                                               id=self.getId(),
                                               toxml=1,
2959
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2960
      return export_string
2961

2962
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2963
      """
2964 2965
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2966
      """
2967
      result = getattr(self, id, ())
2968 2969 2970 2971 2972 2973
      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
2974

2975
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2976
      """
2977 2978
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2979
      """
2980
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2981

2982
    def getTemplateBaseCategoryList(self):
2983
      """
2984 2985
      We have to set this method because we want an
      ordered list
2986
      """
2987
      return self._getOrderedList('template_base_category')
2988

2989
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2990
      """
2991 2992
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2993
      """
2994
      return self._getOrderedList('template_workflow_id')
2995

2996
    def getTemplatePortalTypeIdList(self):
2997
      """
2998 2999
      We have to set this method because we want an
      ordered list
3000
      """
3001
      return self._getOrderedList('template_portal_type_id')
3002

3003
    def getTemplateActionPathList(self):
3004
      """
3005 3006
      We have to set this method because we want an
      ordered list
3007
      """
3008
      return self._getOrderedList('template_action_path')
3009

3010
    def getTemplateSkinIdList(self):
3011
      """
3012 3013
      We have to set this method because we want an
      ordered list
3014
      """
3015
      return self._getOrderedList('template_skin_id')
3016

3017
    def getTemplateModuleIdList(self):
3018
      """
3019 3020
      We have to set this method because we want an
      ordered list
3021
      """
3022
      return self._getOrderedList('template_module_id')
3023 3024 3025 3026 3027 3028 3029

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

3031
    security.declareProtected(Permissions.AccessContentsInformation,
3032
                              'diff')
3033
    def diff(self, verbose=0):
3034
      """
3035
        Return a 'diff' of the business template compared to the
3036 3037
        __btsave__ version.
      """
3038 3039
      diff_message = '%s : %s\n%s\n' % (self.getPath(), DateTime(),
                                        '='*80)
3040
      # Diff everything
3041 3042 3043 3044 3045
      for item_name in self._item_name_list:
        item = getattr(self, item_name)
        if item is not None:
          diff_message += item.diff(verbose=verbose)
      return diff_message
Aurel's avatar
Aurel committed
3046

3047
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
3048 3049 3050 3051
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
3052 3053
      if self.getBuildingState() != 'built':
        raise TemplateConditionError, 'Business Template must be build before export'
3054
      
Aurel's avatar
Aurel committed
3055 3056 3057 3058 3059 3060 3061
      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)

3062
      # export bt
3063
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
3064 3065 3066
      for prop in self.propertyMap():
        type = prop['type']
        id = prop['id']
3067
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id', 'install_object_list_list'):        
3068
          continue
Aurel's avatar
Aurel committed
3069 3070
        value = self.getProperty(id)
        if type == 'text' or type == 'string' or type == 'int':
3071
          bta.addObject(object=value, name=id, path=path+os.sep+'bt', ext='')
Aurel's avatar
Aurel committed
3072
        elif type == 'lines' or type == 'tokens':
3073
          bta.addObject(object=str(os.linesep).join(value), name=id, path=path+os.sep+'bt', ext='')
3074

Aurel's avatar
Aurel committed
3075 3076 3077
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
3078
        
Aurel's avatar
Aurel committed
3079 3080
      return bta.finishCreation()

3081
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
3082 3083
    def importFile(self, dir = 0, file=None, root_path=None):
      """
3084
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
3085 3086 3087 3088 3089 3090
      """

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

Aurel's avatar
Aurel committed
3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136
      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)
3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221


    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:
        new_obj_xml = new_item.generate_xml(path= object_id)
        installed_obj_xml = installed_item.generate_xml(path= object_id)
        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