BusinessTemplate.py 91.9 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
Aurel's avatar
Aurel committed
66 67 68
import tarfile


69 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
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
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
  """  

  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

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
  def _importFile(self, klass, file_name, file, ext):
    """
      Import one file depending on its nature
    """
    class_name = klass.__class__.__name__

    if ext == '.xml' and class_name == 'ModuleTemplateItem':
      # module object
      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)
      klass._objects[file_name[:-4]] = dict

    elif ext == '.xml' and class_name == 'RoleTemplateItem':
      # role list
      xml = parse(file)
      role_list = xml.getElementsByTagName('role')
      for role in role_list:
        node = role.childNodes[0]
        value = node.data
        klass._objects[str(value)] = 1

    elif ext == '.xml' and (class_name == 'CatalogResultKeyTemplateItem' or \
                          class_name == 'CatalogRelatedKeyTemplateItem' or \
                          class_name == 'CatalogResultTableTemplateItem'):
      # catalog key or table object
      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))
      klass._objects[file_name[:-4]] = list

    elif ext == '.xml' and class_name == 'PortalTypeTemplateItem' and \
             '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)
      klass._workflow_chain_archive = dict

    elif ext == '.xml' and class_name == 'SitePropertyTemplateItem':
      # recreate list of site property from text 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:
          value = str(chain.getElementsByTagName('value')[0].childNodes[0].data)
        klass._objects[str(id)] = (str(type), value)

    elif ext == '.xml' and class_name == 'CatalogMethodTemplateItem':
      if not '.catalog_keys' in file_name and not '.filter_instance' in file_name:
        # just import xml object
        obj = klass
        connection = None
        while connection is None:
          obj=obj.aq_parent
          connection=obj._p_jar
        obj = connection.importFile(file, customImporters=customImporters)
        klass._objects[file_name[:-4]] = obj
      elif not '.filter_instance' in file_name and '.catalog_keys' in file_name:
        # recreate data mapping specific to catalog method
        path, name = os.path.split(file_name)
        id = string.split(name, '.')[0]
        xml = parse(file)
        method_list = xml.getElementsByTagName('method')
        for method in method_list:                
          key = method.getElementsByTagName('key')[0].childNodes[0].data
          value = method.getElementsByTagName('value')[0].childNodes[0].data
          key = str(key)
          if key in catalog_method_list:
            value = int(value)
          else:
            value = str(value)
          dict = getattr(klass, key)
          dict[id] = value
      elif '.filter_instance' in file_name:
        # get filter expression instance object from xml file
        path, name = os.path.split(file_name)
        id = string.split(name, '.')[0]
        obj = klass
        connection = None
        while connection is None:
          obj=obj.aq_parent
          connection=obj._p_jar
        obj = connection.importFile(file, customImporters=customImporters)
        klass._filter_expression_instance_archive[id]=obj

    elif ext == '.xml':
      # import xml file
      obj = klass
      connection = None
      while connection is None:
        obj=obj.aq_parent
        connection=obj._p_jar
      obj = connection.importFile(file, customImporters=customImporters)
      klass._objects[file_name[:-4]] = obj

    elif ext == '.py' or ext == '.po':
      # make a copy of python code or translation file
      text = file.read()
      klass._objects[file_name[:-3]]=text  

Aurel's avatar
Aurel committed
261 262 263 264 265 266 267 268 269 270 271 272 273
  def finishCreation(self, **kw):
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
    Class archiving businnes template into a folder tree
  """  
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
274
      removeAll(self.path)
Aurel's avatar
Aurel committed
275 276 277 278 279
      os.makedirs(self.path)

  def addFolder(self, name=''):
    if name !='':
      path = os.path.join(self.path, name)
280
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
281 282 283 284 285 286 287 288 289
        os.makedirs(path)
      return path

  def addObject(self, object, name, path=None, ext='.xml'):
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
290
    f.write(str(object))
Aurel's avatar
Aurel committed
291 292 293 294
    f.close()

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

298
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
299 300 301 302
    """
      Import file from a local folder
    """
    class_name = klass.__class__.__name__
303 304 305 306
    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
307
          # get object id
308 309 310 311
          folders = file_path.split(os.sep)
          file_name = string.join(folders[self.root_path_len:], os.sep)
          name, ext = os.path.splitext(folders[-1])
          self._importFile(klass, file_name, file, ext)                    
Aurel's avatar
Aurel committed
312
          # close file
313
          file.close()
Aurel's avatar
Aurel committed
314 315 316 317 318 319 320
        
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
321
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
322 323 324 325 326
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
327
      removeAll(self.path)
Aurel's avatar
Aurel committed
328 329 330 331 332 333
      os.makedirs(self.path)
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)

  def addFolder(self, name=''):
334
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
335 336 337 338 339 340 341 342
      os.makedirs(name)

  def addObject(self, object, name, path=None, ext='.xml'):
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
      object_path = os.path.join(path, name)
    f = open(object_path+ext, 'wt')
343
    f.write(str(object))
Aurel's avatar
Aurel committed
344 345 346 347 348
    f.close()

  def finishCreation(self):
    self.tar.add(self.path)
    self.tar.close()
349
    removeAll(self.path)
Aurel's avatar
Aurel committed
350 351 352 353 354
    return self.fobj

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

355
  def importFiles(self, klass, **kw):
Aurel's avatar
Aurel committed
356 357 358 359 360 361 362 363 364 365 366 367 368
    """
      Import all file from the archive to the site
    """    
    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)
          folder, name = os.path.split(info.name)
369 370
          n, ext = os.path.splitext(name)
          self._importFile(klass, info.name, file, ext)          
Aurel's avatar
Aurel committed
371 372 373
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
374

375 376
class TemplateConflictError(Exception): pass

377
class BaseTemplateItem(Implicit, Persistent):
378
  """
379
    This class is the base class for all template items.
380
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
381

382
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
383
    self.__dict__.update(kw)
384
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
385
    self._objects = PersistentMapping()
386 387 388 389 390 391 392
    for id in id_list:
      if not id: continue
      self._archive[id] = None

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

393 394
  def install(self, context, **kw):
    pass
395 396 397

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

399 400 401 402
  def trash(self, context, new_item, **kw):
    # trash is quite similar to uninstall.
    return self.uninstall(context, new_item=new_item, trash=1, **kw)

403 404
  def diff(self, **kw):
    return ''
Aurel's avatar
Aurel committed
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
  
  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)

  def importFile(self, bta, **kw):
422
    bta.importFiles(klass=self)
Aurel's avatar
Aurel committed
423
            
424 425 426
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
427
  """
Aurel's avatar
Aurel committed
428
  
429 430 431 432
  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()
433
      self._archive.clear()
434 435 436
      for id in id_list:
        self._archive["%s/%s" % (tool_id, id)] = None

Aurel's avatar
Aurel committed
437 438 439 440
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    sub_list = {}
    for id in id_list:
441
      relative_url = '/'.join([url,id])
Aurel's avatar
Aurel committed
442 443 444 445 446 447 448 449 450
      object = p.unrestrictedTraverse(relative_url)      
      object = object._getCopy(context)
      id_list = object.objectIds()
      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))
451
      if hasattr(aq_base(object), 'uid'):
Aurel's avatar
Aurel committed
452 453 454 455 456 457 458
        object.uid = None
      if hasattr(object, 'groups'):
        object.groups = groups
      self._objects[relative_url] = object
      object.wl_clearLocks()
    return sub_list

459 460 461 462 463 464
  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
465 466 467 468 469 470 471
      id_list = object.objectIds()
      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))
472
      if hasattr(aq_base(object), 'uid'):
Aurel's avatar
Aurel committed
473 474 475 476
        object.uid = None
      if hasattr(object, 'groups'):
        object.groups = groups
      self._objects[relative_url] = object
477 478
      object.wl_clearLocks()

479
  def _backupObject(self, container, object_id, **kw):
480
    container_ids = container.objectIds()
481 482 483 484 485
    n = 0
    new_object_id = object_id
    while new_object_id in container_ids:
      n = n + 1
      new_object_id = '%s_btsave_%s' % (object_id, n)
486
    # XXX manage_renameObject is not in ERP5 API. Use setId.
487
    container.manage_renameObject(object_id, new_object_id)
488 489
    # Returned ID of the backuped object
    return new_object_id
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 516 517 518 519 520 521 522 523
  def install(self, context, **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()
      for path in keys:
        container_path = path.split('/')[2:-1]
        object_id = path.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
        if object_id in container_ids:    # Object already exists
          self._backupObject(container, object_id)
        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)
        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',):
          # 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]            
      # now put original order group
      for path in groups.keys():
        object = portal.unrestrictedTraverse(path.split('/')[2:])
        object.groups = groups[path]
Aurel's avatar
Aurel committed
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
    else:
      BaseTemplateItem.install(self, context, **kw)
      portal = context.getPortalObject()
      for relative_url,object in self._archive.items():
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
        if object_id in container_ids:    # Object already exists
          self._backupObject(container, object_id)
        # 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',):
          # 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]
547 548 549

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
550
    trash = kw.get('trash', 0)
551 552 553
    for relative_url in self._archive.keys():
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
554 555 556 557 558 559 560
      try:
        container = portal.unrestrictedTraverse(container_path)
        if trash:
          self._backupObject(container, object_id)
        else:
          if object_id in container.objectIds():
            container.manage_delObjects([object_id])
561
      # get exception ObjectNot found
562
      except:
563
        pass      
564 565
    BaseTemplateItem.uninstall(self, context, **kw)

566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
  def _compareObjects(self, object1, object2, btsave_object_included=0):
    """
      Execute a diff between 2 objects, 
      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] != ' ']
    # 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 = []
    # Return string 
    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()
    # Browse all items stored
    for relative_url, object in getattr(self, archive_variable).items():
      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(
              (object, portal.unrestrictedTraverse(
                                  container_path+[new_object_id])))
        n += 1
        new_object_id = '%s_btsave_%s' % (object_id, n)
      if n == 1:
        result += "$$$ Added: %s $$$\n" % \
              ('/'.join(container_path+[object_id]))
        result += '%s\n' % ('-'*80)
      # 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:
            result += tmp_diff  
          result += '%s\n' % ('-'*80)
    return result
665

666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
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.
      
      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
697

698 699 700 701 702 703 704
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for path in self._path_archive.keys():
      for relative_url in self._resolvePath(p, [], path.split('/')):
        object = p.unrestrictedTraverse(relative_url)
        object = object._getCopy(context)
Aurel's avatar
Aurel committed
705 706 707
        if hasattr(object, 'uid'):
          object.uid = None
        self._objects[relative_url] = object
708
        object.wl_clearLocks()
Aurel's avatar
Aurel committed
709
      
710 711
class CategoryTemplateItem(ObjectTemplateItem):

712 713
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
714

715 716
  def install(self, context, light_install = 0, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
Aurel's avatar
Aurel committed
717
      if light_install==0:
718
        ObjectTemplateItem.install(self, context, **kw)
Aurel's avatar
Aurel committed
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
      else:
        portal = context.getPortalObject()
        category_tool = portal.portal_categories
        tool_id = self.tool_id
        keys = self._objects.keys()
        keys.sort()
        for path in keys:
          # Wrap the object by an aquisition wrapper for _aq_dynamic.
          object = self._objects[path]
          object = object.__of__(category_tool)
          container_path = path.split('/')[2:-1]
          category_id = path.split('/')[-1]
          container = category_tool.unrestrictedTraverse(container_path)
          container_ids = container.objectIds()
          if category_id in container_ids:    # Object already exists
            self._backupObject(container, 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))
739
    else:
Aurel's avatar
Aurel committed
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
      BaseTemplateItem.install(self, context, **kw)
      portal = context.getPortalObject()
      category_tool = portal.portal_categories
      tool_id = self.tool_id
      if light_install==0:
        ObjectTemplateItem.install(self, context, **kw)
      else:
        for relative_url,object in self._archive.items():
          # 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
            self._backupObject(container, 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))
760

761 762 763

class SkinTemplateItem(ObjectTemplateItem):

764 765
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
766

767 768 769
  def install(self, context, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
      ObjectTemplateItem.install(self, context, **kw)
Aurel's avatar
Aurel committed
770 771 772 773 774 775
      p = context.getPortalObject()
      ps = p.portal_skins
      for skin_name, selection in ps.getSkinPaths():
        new_selection = []
        selection = selection.split(',')
        for relative_url, object in self._objects.items():
776 777
          skin_id = relative_url.split('/')[3]
          if hasattr(object, 'getProperty'):
Aurel's avatar
Aurel committed
778
            selection_list = object.getProperty('business_template_registered_skin_selections', None)
779
          else:
Aurel's avatar
Aurel committed
780 781 782 783 784 785
            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)
        new_selection.extend(selection)
        # sort the layer according to skin priorities
786
        new_selection.sort(lambda a, b : cmp( # separate functions here
Aurel's avatar
Aurel committed
787 788 789 790 791
          b in ps.objectIds() and ps[b].getProperty(
              'business_template_skin_layer_priority', 0) or 0, 
          a in ps.objectIds() and ps[a].getProperty(
              'business_template_skin_layer_priority', 0) or 0))
        ps.manage_skinLayers(skinpath = tuple(new_selection), skinname = skin_name, add_skin = 1)
792 793
      # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
      p.changeSkin(None)
Aurel's avatar
Aurel committed
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
    else:
      ObjectTemplateItem.install(self, context, **kw)
      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(',')
        for relative_url, object in self._archive.items():
          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(
              'business_template_skin_layer_priority', 0) or 0, 
          a in ps.objectIds() and ps[a].getProperty(
              'business_template_skin_layer_priority', 0) or 0))
        ps.manage_skinLayers(skinpath = tuple(new_selection), skinname = skin_name, add_skin = 1)
823 824
      # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
      p.changeSkin(None)
825 826 827 828 829 830 831 832 833 834 835 836

  def uninstall(self, context, **kw):
    # Remove folders from skin paths.
    ps = context.portal_skins
    skin_id_list = [relative_url.split('/')[-1] for relative_url in self._archive.keys()]
    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)
837
    # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py).
838
    context.getPortalObject().changeSkin(None)
839

840 841
    ObjectTemplateItem.uninstall(self, context, **kw)

842 843
  def diff(self, max_deep=1, **kw):
    return ObjectTemplateItem.diff(self, max_deep=max_deep, **kw)
844

845
class WorkflowTemplateItem(ObjectTemplateItem):
846

847 848
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
849 850 851 852 853 854 855 856 857

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
858
    This is only useful in order to use
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
    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)

883 884
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
885 886 887
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
888 889 890 891
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      object = p.unrestrictedTraverse(relative_url)
      object = object._getCopy(context)
Aurel's avatar
Aurel committed
892 893
      id_list = object.objectIds()
      # remove optional actions
894 895 896 897 898 899
      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)
Aurel's avatar
Aurel committed
900 901 902
      if hasattr(object, 'uid'):
        object.uid = None
      self._objects[relative_url] = object
903
      object.wl_clearLocks()
Aurel's avatar
Aurel committed
904
    # also export workflow chain
905
    (default_chain, chain_dict) = self._getChainByType(context)
Aurel's avatar
Aurel committed
906
    for object in self._objects.values():
907 908 909
      portal_type = object.id
      self._workflow_chain_archive[portal_type] = chain_dict['chain_%s' % portal_type]

Aurel's avatar
Aurel committed
910 911 912 913
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
914
    # export portal type object
Aurel's avatar
Aurel committed
915
    BaseTemplateItem.export(self, context, bta, **kw)
916 917
    # export workflow chain
    xml_data = '<workflow_chain>'
Aurel's avatar
Aurel committed
918
    for key in self._workflow_chain_archive.keys():
919 920 921 922 923 924
      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],)
      xml_data += os.linesep+' </chain>' 
    xml_data += os.linesep+'</workflow_chain>'
    bta.addObject(object=xml_data, name='workflow_chain_type',  path=root_path)
Aurel's avatar
Aurel committed
925
      
926 927 928
  def install(self, context, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
      ObjectTemplateItem.install(self, context, **kw)
Aurel's avatar
Aurel committed
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
      (default_chain, chain_dict) = self._getChainByType(context)
      default_chain = ''
      for object in self._objects.values():
        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)
    else:
      ObjectTemplateItem.install(self, context, **kw)
      # 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
      default_chain = ''
      for object in self._archive.values():
        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)
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992

  def _backupObject(self, container, object_id, **kw):
    """
      Backup portal type and keep the workflow chain.
    """
    # Get the chain value
    (default_chain, chain_dict) = self._getChainByType(self)
    chain = chain_dict['chain_%s' % object_id]
    # Backup the portal type
    backup_id = ObjectTemplateItem._backupObject(self, container, 
                                                 object_id, **kw)
    # 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)

  def diff(self, verbose=0, **kw):
    """
      Make a diff between portal type.  
      Also compare the workflow chain.
    """
    # Compare XML portal type
    result = ObjectTemplateItem.diff(self, verbose=verbose, **kw)
    # Compare chains
    container_ids = self.portal_types.objectIds()
    for object in self._archive.values():
      object_id = object.id
      object_chain = self.portal_workflow.getChainFor(object_id)
      n = 1
      new_object_id = '%s_btsave_%s' % (object_id, n)
      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)
    return result
993

994 995
class CatalogMethodTemplateItem(ObjectTemplateItem):

996 997
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
998
    self._is_catalog_method_archive = PersistentMapping()
999
    self._is_catalog_list_method_archive = PersistentMapping()
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
    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)
1010 1011 1012 1013 1014 1015
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except:
      return
    if catalog is None:
      return
Aurel's avatar
Aurel committed
1016
    for object in self._objects.values():
1017
      method_id = object.id
1018 1019 1020 1021 1022
      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
1023
      self._is_filtered_archive[method_id] = 0
1024 1025 1026 1027 1028
      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']
1029

Aurel's avatar
Aurel committed
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
  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
1047 1048
      object_path = os.path.join(path, method_id+'.catalog_keys.xml')

Aurel's avatar
Aurel committed
1049
      f = open(object_path, 'wt')
1050 1051 1052 1053 1054 1055 1056
      xml_data = '<catalog_method>'
      for method in catalog_method_list:
        value = getattr(self, method, 0)[method_id]
        xml_data += os.linesep+' <method>'
        xml_data += os.linesep+'  <key>%s</key>' %(method)
        xml_data += os.linesep+'  <value>%s</value>' %(str(int(value)))
        xml_data += os.linesep+' </method>'
Aurel's avatar
Aurel committed
1057
      if catalog.filter_dict.has_key(method_id):
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
        for method in catalog_method_filter_list:
          value = getattr(self, method, '')[method_id]
          if method == '_filter_expression_instance_archive':
            # convert instance to a xml file
            object = self._filter_expression_instance_archive[method_id]
            object_io = StringIO()
            XMLExportImport.exportXML(object._p_jar, object._p_oid, object_io)
            bta.addObject(object = object_io.getvalue(), name=id+'.filter_instance', path=path)
          else:
            xml_data += os.linesep+' <method>'
            xml_data += os.linesep+'  <key>%s</key>' %(method)
            xml_data += os.linesep+'  <value>%s</value>' %(str(value))
            xml_data += os.linesep+' </method>'
      xml_data += os.linesep+'</catalog_method>'
      f.write(str(xml_data))
Aurel's avatar
Aurel committed
1073 1074
      f.close()
        
1075 1076
  def install(self, context, **kw):
    ObjectTemplateItem.install(self, context, **kw)
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except:
      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)
1090

1091
    if (getattr(self, 'template_format_version', 0)) == 1:
Aurel's avatar
Aurel committed
1092 1093 1094 1095
      values = self._objects.values()
    else:
      values = self._archive.values()
    for object in values:
1096
      method_id = object.id
1097
      LOG('install catalog object id %r' %(method_id), 0, '')
Aurel's avatar
Aurel committed
1098 1099 1100 1101 1102 1103
      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])
1104 1105 1106 1107 1108 1109

      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)

1110 1111 1112 1113 1114
      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)

1115
      if is_uncatalog_method and method_id not in sql_uncatalog_object:
1116
        sql_uncatalog_object.append(method_id)
1117
      elif not is_uncatalog_method and method_id in sql_uncatalog_object:
1118 1119
        sql_uncatalog_object.remove(method_id)

1120
      if is_update_method and method_id not in sql_update_object:
1121
        sql_update_object.append(method_id)
1122
      elif not is_update_method and method_id in sql_update_object:
1123 1124 1125 1126 1127 1128 1129 1130
        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:
1131 1132 1133
        expression = self._filter_expression_archive[method_id]
        expression_instance = self._filter_expression_instance_archive[method_id]
        type = self._filter_type_archive[method_id]
1134

1135 1136 1137 1138 1139
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
        catalog.filter_dict[method_id]['expression_instance'] = expression_instance
        catalog.filter_dict[method_id]['type'] = type
1140
      elif method_id in catalog.filter_dict.keys():
1141
        catalog.filter_dict[method_id]['filtered'] = 0
1142 1143

    sql_catalog_object.sort()
1144 1145 1146
    catalog.sql_catalog_object = tuple(sql_catalog_object)
    sql_catalog_object_list.sort()
    catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
1147
    sql_uncatalog_object.sort()
1148
    catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
1149
    sql_update_object.sort()
1150
    catalog.sql_update_object = tuple(sql_update_object)
1151
    sql_clear_catalog.sort()
1152
    catalog.sql_clear_catalog = tuple(sql_clear_catalog)
1153 1154

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

1156 1157
    try:
      catalog = context.portal_catalog.getSQLCatalog()
1158
    except: # must catch the right error here
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
      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)
1171 1172 1173 1174 1175 1176 1177

    for object in self._archive.values():
      method_id = object.id

      if method_id in sql_catalog_object:
        sql_catalog_object.remove(method_id)

1178 1179 1180
      if method_id in sql_catalog_object_list:
        sql_catalog_object_list.remove(method_id)

1181 1182 1183 1184 1185 1186 1187 1188 1189
      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
1190
      if catalog.filter_dict.has_key(method_id):
1191
        del catalog.filter_dict[method_id]
1192

1193 1194 1195 1196 1197
    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)
1198 1199

    ObjectTemplateItem.uninstall(self, context, **kw)
Aurel's avatar
Aurel committed
1200
  
1201

1202
class ActionTemplateItem(BaseTemplateItem): # maybe inherit from ObjectTemplateItem for export
1203 1204 1205 1206

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

1208
      "foo/bar[id=zoo]"
1209

1210
      into
1211

1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
      "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):
1226
    # XXX It's look like ObjectTemplateItem __init__
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
    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:
1241
          url = os.path.split(relative_url)
Aurel's avatar
Aurel committed
1242 1243 1244 1245 1246 1247
          key = os.path.join(url[-2], url[-1], value)
          object = ai._getCopy(context)
          if hasattr(object, 'uid'):
            object.uid = None
          self._objects[key] = object
          self._objects[key].wl_clearLocks()
1248 1249
          break
      else:
1250
        raise notFound, 'Action %r not found' %(id,)
Aurel's avatar
Aurel committed
1251

1252 1253
  def install(self, context, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:    
Aurel's avatar
Aurel committed
1254 1255
      p = context.getPortalObject()
      for id in self._objects.keys():
1256
        path = id.split(os.sep)
Aurel's avatar
Aurel committed
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
        object = p.unrestrictedTraverse(path[2:-1])
        for ai in object.listActions():
          if getattr(ai, 'id') == path[-1]:
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (object.id, path[-1])
        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)
                    )
    else:
      BaseTemplateItem.install(self, context, **kw)
      p = context.getPortalObject()
      for id,action in self._archive.items():
        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)
                    )
1293 1294 1295 1296 1297 1298 1299 1300

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
    for id,action in self._archive.items():
      relative_url, key, value = self._splitPath(id)
      object = p.unrestrictedTraverse(relative_url)
      action_list = object.listActions()
      for index in range(len(action_list)):
1301
        if getattr(action_list[index], key) == value:
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
          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():
1312 1313
      for property in p.propertyMap():
        if property['id'] == id:
Aurel's avatar
Aurel committed
1314 1315
          object = p.getProperty(id)
          type = property['type']
1316 1317
          break
      else:
Aurel's avatar
Aurel committed
1318 1319
        object = None
      if object is None:
1320
        raise NotFound, 'the property %s is not found' % id
Aurel's avatar
Aurel committed
1321 1322
      self._objects[id] = (type, object)

1323 1324
  def install(self, context, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
Aurel's avatar
Aurel committed
1325 1326 1327 1328 1329
      p = context.getPortalObject()
      for path in self._objects.keys():
        dir, id = os.path.split(path)
        if p.hasProperty(id):
          continue
1330
        type, property = self._objects[path]
Aurel's avatar
Aurel committed
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
        p._setProperty(id, property, type=type)
    else:
      BaseTemplateItem.install(self, context, **kw)
      p = context.getPortalObject()
      for id,property in self._archive.items():
        if p.hasProperty(id):
          continue
          # Too much???
          #raise TemplateConflictError, 'the property %s already exists' % id
        p._setProperty(id, property['value'], type=property['type'])
1341 1342 1343 1344 1345 1346 1347 1348

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
    for id in self._archive.keys():
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
1349 1350 1351 1352 1353
  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)
1354 1355 1356 1357
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
Aurel's avatar
Aurel committed
1358
      type, object=self._objects[path]
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
      # save it as xml
      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:
          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),)
      xml_data += os.linesep+' </property>'
    xml_data += os.linesep+'</site_property>'
    bta.addObject(object=xml_data, name='properties', path=root_path)
Aurel's avatar
Aurel committed
1373
    
1374 1375
class ModuleTemplateItem(BaseTemplateItem):

1376 1377
  def diff(self, max_deep=1, **kw):
    return ''
Aurel's avatar
Aurel committed
1378

1379 1380 1381 1382 1383
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
      module = p.unrestrictedTraverse(id)
1384 1385 1386 1387 1388 1389 1390 1391
      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
1392

1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
  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)
    for id in self._objects.keys():
      dict = self._objects[id]
      xml_data = '<module>'
      for key in dict.keys():
        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])
            role_list = perm[1]
            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>'
      bta.addObject(object=xml_data, name=id, path=path)

  def install(self, context, **kw):
    portal = context.getPortalObject()    
    if (getattr(self, 'template_format_version', 0)) == 1:
      items = self._objects.items()
    else:
      items = self._archive.items()
    for id,mapping in items:
      path, id = os.path.split(id)
      if id in portal.objectIds():
        module = portal._getOb(id)
        module.portal_type = str(mapping['portal_type']) # XXX
      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:
          # Normally, an exception is raised when you don't install any Product which
          # has been in use when this business template is created.
          pass
        
1442 1443 1444 1445 1446
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
    id_list = p.objectIds()
    for id in self._archive.keys():
      if id in id_list:
1447 1448 1449 1450
        try:
          p.manage_delObjects([id])
        except:
          pass
1451 1452
    BaseTemplateItem.uninstall(self, context, **kw)

1453 1454 1455
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
1456 1457

class DocumentTemplateItem(BaseTemplateItem):
1458 1459 1460 1461
  local_file_reader_name = 'readLocalDocument'
  local_file_writer_name = 'writeLocalDocument'
  local_file_importer_name = 'importLocalDocument'
  local_file_remover_name = 'removeLocalDocument'
1462 1463 1464 1465

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

1468 1469
  def install(self, context, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
Aurel's avatar
Aurel committed
1470 1471 1472 1473
      for id in self._objects.keys():
        text = self._objects[id]
        path, name = os.path.split(id)
        # This raises an exception if the file already exists.
1474
        globals()[self.local_file_writer_name](name, text, create=1)
Aurel's avatar
Aurel committed
1475 1476 1477 1478 1479 1480
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](name)
    else:
      BaseTemplateItem.install(self, context, **kw)
      for id,text in self._archive.items():
        # This raises an exception if the file exists.
1481
        globals()[self.local_file_writer_name](id, text, create=1)
Aurel's avatar
Aurel committed
1482 1483
        if self.local_file_importer_name is not None:
          globals()[self.local_file_importer_name](id)
1484 1485 1486

  def uninstall(self, context, **kw):
    for id in self._archive.keys():
1487
      globals()[self.local_file_importer_name](id)
1488 1489
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
1490 1491 1492 1493 1494 1495 1496 1497 1498
  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')

1499 1500 1501 1502 1503 1504
class PropertySheetTemplateItem(DocumentTemplateItem):
  local_file_reader_name = 'readLocalPropertySheet'
  local_file_writer_name = 'writeLocalPropertySheet'
  local_file_importer_name = 'importLocalPropertySheet'
  local_file_remover_name = 'removeLocalPropertySheet'

Aurel's avatar
Aurel committed
1505
       
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
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
1520

1521 1522 1523
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
1524 1525 1526

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
1527 1528 1529 1530
  def build(self, context, **kw):
    role_list = []
    for key in self._archive.keys():
      role_list.append(key)
1531 1532
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+os.sep+'role_list'] = role_list
Aurel's avatar
Aurel committed
1533

1534 1535
  def install(self, context, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
Aurel's avatar
Aurel committed
1536 1537 1538
      p = context.getPortalObject()
      roles = {}
      for role in p.__ac_roles__:
1539
        roles[role] = 1      
Aurel's avatar
Aurel committed
1540 1541
      for role in self._objects.keys():
        roles[role] = 1
1542
      p.__ac_roles__ = tuple(roles.keys())
Aurel's avatar
Aurel committed
1543 1544 1545 1546 1547 1548 1549 1550 1551
    else:
      BaseTemplateItem.install(self, context, **kw)
      p = context.getPortalObject()
      roles = {}
      for role in p.__ac_roles__:
        roles[role] = 1
      for role in self._archive.keys():
        roles[role] = 1
      p.__ac_roles__ = tuple(roles.keys())
1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563

  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)

1564 1565 1566 1567 1568 1569 1570 1571 1572
  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
1573
      if role in roles and role not in new_roles:
1574 1575 1576
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Aurel's avatar
Aurel committed
1577 1578 1579 1580 1581 1582 1583
  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]
1584 1585 1586 1587 1588
      xml_data = '<role_list>'
      for role in object:
        xml_data += os.linesep+' <role>%s</role>' %(role)
      xml_data += os.linesep+'</role_list>'
      bta.addObject(object=xml_data, name=path, path=None,)
Aurel's avatar
Aurel committed
1589
  
1590 1591
class CatalogResultKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
1592
  def build(self, context, **kw):
1593 1594 1595 1596 1597 1598 1599
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1600
    sql_search_result_keys = list(catalog.sql_search_result_keys)
Aurel's avatar
Aurel committed
1601
    role_list = []
1602
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
1603 1604 1605 1606
      if key in sql_search_result_keys:
        role_list.append(key)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
1607 1608
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+'/key_list'] = role_list
Aurel's avatar
Aurel committed
1609

1610 1611 1612 1613
  def install(self, context, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
Aurel's avatar
Aurel committed
1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
      try:
        catalog = context.portal_catalog.getSQLCatalog()
      except:
        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)
      for key in self._objects.values().pop():
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
      catalog.sql_search_result_keys = sql_search_result_keys
    else:
      BaseTemplateItem.install(self, context, **kw)
      try:
        catalog = context.portal_catalog.getSQLCatalog()
      except:
        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)
      for key in self._archive.keys():
        if key not in sql_search_result_keys:
          sql_search_result_keys.append(key)
      catalog.sql_search_result_keys = sql_search_result_keys
1640 1641

  def uninstall(self, context, **kw):
1642 1643 1644 1645 1646 1647 1648 1649
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except:
      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)
1650 1651 1652
    for key in self._archive.keys():
      if key in sql_search_result_keys:
        sql_search_result_keys.remove(key)
1653
    catalog.sql_search_result_keys = sql_search_result_keys
1654 1655
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
1656 1657 1658 1659 1660
  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)
1661
    for path in self._objects.keys():      
Aurel's avatar
Aurel committed
1662
      object=self._objects[path]
1663 1664 1665 1666 1667
      xml_data = '<key_list>'
      for key in object:
        xml_data += os.linesep+' <key>%s</key>' %(key)
      xml_data += os.linesep+'</key_list>'      
      bta.addObject(object=xml_data, name=path, path=None)
Aurel's avatar
Aurel committed
1668
  
1669 1670
class CatalogRelatedKeyTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
1671
  def build(self, context, **kw):
1672 1673 1674 1675 1676 1677 1678
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
1679 1680
    sql_search_related_keys = list(catalog.sql_catalog_related_keys)
    role_list = []
1681
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
1682 1683 1684 1685
      if key in sql_search_related_keys:
        role_list.append(key)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
1686 1687
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+'/key_list'] = role_list
Aurel's avatar
Aurel committed
1688

1689 1690 1691
  def install(self, context, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718
        return
      try:
        catalog = context.portal_catalog.getSQLCatalog()
      except:
        catalog = None
      if catalog is None:
        LOG('BusinessTemplate', 0, 'no SQL catalog was available')
        return
      sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
      for key in self._objects.values().pop(): # because of list of list
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
      catalog.sql_catalog_related_keys = sql_catalog_related_keys
    else:
      BaseTemplateItem.install(self, context, **kw)
      try:
        catalog = context.portal_catalog.getSQLCatalog()
      except:
        catalog = None
      if catalog is None:
        LOG('BusinessTemplate', 0, 'no SQL catalog was available')
        return
      sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
      for key in self._archive.keys():
        if key not in sql_catalog_related_keys:
          sql_catalog_related_keys.append(key)
      catalog.sql_catalog_related_keys = sql_catalog_related_keys
1719 1720 1721 1722 1723 1724 1725 1726 1727

  def uninstall(self, context, **kw):
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
1728
    sql_catalog_related_keys = list(catalog.sql_catalog_related_keys)
1729 1730 1731 1732 1733 1734
    for key in self._archive.keys():
      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)

Aurel's avatar
Aurel committed
1735 1736 1737 1738 1739 1740 1741
  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]
1742 1743 1744 1745 1746
      xml_data = '<key_list>'
      for key in object:
        xml_data += os.linesep+' <key>%s</key>' %(key)
      xml_data += os.linesep+'</key_list>'      
      bta.addObject(object=xml_data, name=path, path=None)
1747

1748 1749
class CatalogResultTableTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
1750
  def build(self, context, **kw):
1751 1752 1753 1754 1755 1756 1757
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
Aurel's avatar
Aurel committed
1758 1759
    sql_search_result_tables = list(catalog.sql_search_tables)
    role_list = []
1760
    for key in self._archive.keys():
Aurel's avatar
Aurel committed
1761 1762 1763 1764
      if key in sql_search_result_tables:
        role_list.append(key)
      else:
        raise NotFound, 'key %r not found in catalog' %(key,)
1765 1766
    if len(role_list) > 0:
      self._objects[self.__class__.__name__+'/key_list'] = role_list
Aurel's avatar
Aurel committed
1767

1768 1769 1770
  def install(self, context, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
        return
      try:
        catalog = context.portal_catalog.getSQLCatalog()
      except:
        catalog = None
      if catalog is None:
        LOG('BusinessTemplate', 0, 'no SQL catalog was available')
        return
      sql_search_tables = list(catalog.sql_search_tables)
      for key in self._objects.values().pop():
        if key not in sql_search_tables:
          sql_search_tables.append(key)
      catalog.sql_search_tables = sql_search_tables
    else:
      BaseTemplateItem.install(self, context, **kw)
      try:
        catalog = context.portal_catalog.getSQLCatalog()
      except:
        catalog = None
      if catalog is None:
        LOG('BusinessTemplate', 0, 'no SQL catalog was available')
        return
      sql_search_tables = list(catalog.sql_search_tables)
      for key in self._archive.keys():
        if key not in sql_search_tables:
          sql_search_tables.append(key)
      catalog.sql_search_tables = sql_search_tables
1798 1799

  def uninstall(self, context, **kw):
1800 1801 1802 1803 1804 1805 1806 1807
    try:
      catalog = context.portal_catalog.getSQLCatalog()
    except:
      catalog = None
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    sql_search_tables = list(catalog.sql_search_tables)
1808 1809 1810
    for key in self._archive.keys():
      if key in sql_search_tables:
        sql_search_tables.remove(key)
1811
    catalog.sql_search_tables = sql_search_tables
1812 1813
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
1814 1815 1816 1817 1818 1819 1820
  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]
1821 1822 1823 1824 1825 1826
      xml_data = '<key_list>'
      for key in object:
        xml_data += os.linesep+' <key>%s</key>' %(key)
      xml_data += os.linesep+'</key_list>'      
      bta.addObject(object=xml_data, name=path, path=None)
        
1827 1828 1829 1830 1831
class MessageTranslationTemplateItem(BaseTemplateItem):

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

1839 1840
  def install(self, context, **kw):
    if (getattr(self, 'template_format_version', 0)) == 1:
Aurel's avatar
Aurel committed
1841 1842 1843 1844 1845 1846 1847
      localizer = context.getPortalObject().Localizer
      for path, po in self._objects.items():
        path = string.split(path, '/')
        lang = path[-3]
        catalog = path[-2]
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
1848 1849 1850 1851
        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
1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875
    else:
      BaseTemplateItem.install(self, context, **kw)
      localizer = context.getPortalObject().Localizer
      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()
1876

1877
class BusinessTemplate(XMLObject): 
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1878 1879
    """
    A business template allows to construct ERP5 modules
1880 1881 1882
    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
1883

1884 1885
    - catalog definition
      - SQL method objects
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1886 1887 1888 1889
      - SQL methods including:
        - purpose (catalog, uncatalog, etc.)
        - filter definition

1890 1891 1892
    - portal_types definition
      - object without optinal actions
      - list of relation between portal type and worklfow
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1893

1894
    - module definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1895
      - id
1896 1897
      - title
      - portal type
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1898 1899
      - roles/security

1900 1901 1902 1903
    - site property definition
      - id
      - type
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1904

1905 1906 1907 1908 1909
    - document/propertysheet/extension/test definition
      - copy of the local file
    
    - message transalation definition
      - .po file 
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1910

1911 1912 1913
    The Business Template properties are exported to the bt folder with
    one property per file
      
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1914 1915
    Technology:

1916 1917
    - 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
1918

1919
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1920 1921 1922 1923

    Use case:

    - install core ERP5 (the minimum)
1924 1925
    
    - go to "BT" menu. Import BT. Select imported BT. Click install.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1926

1927 1928
    - go to "BT" menu. Create new BT. 
      Define BT elements (workflow, methods, attributes, etc.). 
1929
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1930 1931 1932 1933 1934
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
1935
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948
    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
1949
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1950 1951 1952 1953
                      , PropertySheet.CategoryCore
                      , PropertySheet.BusinessTemplate
                      )

1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028
    # 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, )
          }
        )
      }

2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
    # 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',
      '_path_item',
      '_skin_item',
      '_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
2056
      self._objects = PersistentMapping()
2057 2058
      for item_name in self._item_name_list:
        setattr(self, item_name, None)
2059

2060
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
2061 2062 2063 2064 2065 2066 2067
    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".
2068 2069 2070 2071 2072 2073
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
          # XXX Not good to access the attribute directly, 
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
2074

2075
    security.declareProtected(Permissions.ManagePortal, 'build')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2076 2077 2078 2079
    def build(self):
      """
        Copy existing portal objects to self
      """
2080 2081
      # Make sure that everything is sane.
      self.clean()
Aurel's avatar
Aurel committed
2082
      
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2083 2084
      # 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
2085
      # XXX Is it still necessary as it is not saved in new bt format ??
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2086 2087
      portal_workflow = getToolByName(self, 'portal_workflow')
      wf_id_list = portal_workflow.getChainFor(self)
Aurel's avatar
Aurel committed
2088
      original_history_dict = {}      
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2089 2090 2091 2092 2093 2094
      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:]
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140
      # 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)
2141

2142
    build = WorkflowMethod(build)
2143 2144

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2145
      """
2146
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2147
      """
2148 2149
      return self.portal_templates.publish(self, url, username=username, 
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2150

2151
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2152
      """
2153
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2154
      """
2155
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2156

2157
    def _install(self, **kw):
2158 2159 2160 2161
      installed_bt = self.portal_templates.getInstalledBusinessTemplate(
                                                           self.getTitle())
      LOG('Business Template install', 0, 
          'self = %r, installed_bt = %r' % (self, installed_bt))
Aurel's avatar
Aurel committed
2162

2163
      if installed_bt is not None:
2164
        installed_bt.trash(self)
2165
        installed_bt.replace(self)
2166
      # Update local dictionary containing all setup parameters
2167 2168 2169
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2170 2171 2172 2173
      # Install everything
      for item_name in self._item_name_list:
        item = getattr(self, item_name)
        if item is not None:
2174
          item.install(local_configuration)          
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2175 2176 2177
      # It is better to clear cache because the installation of a template
      # adds many new things into the portal.
      clearCache()
2178

2179
    security.declareProtected(Permissions.ManagePortal, 'install')
2180 2181 2182 2183 2184 2185 2186
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
      """
      return self._install(**kw)
            
    install = WorkflowMethod(install)
2187

2188
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
2189
    def reinstall(self, **kw):
2190 2191 2192 2193
      """Reinstall Business Template.
      """
      return self._install(**kw)

2194
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2195

2196
    security.declareProtected(Permissions.ManagePortal, 'trash')
2197 2198
    def trash(self, new_bt, **kw):
      """
2199 2200 2201 2202
        Trash unnecessary items before upgrading to a new business 
        template.
        This is similar to uninstall, but different in that this does 
        not remove all items.
2203 2204 2205 2206 2207
      """
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2208 2209 2210 2211 2212 2213 2214
      # 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))
2215

2216
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
2217
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2218
      """
2219
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2220
      """
2221 2222 2223 2224
      # Update local dictionary containing all setup parameters
      # This may include mappings
      self.portal_templates.updateLocalConfiguration(self, **kw)
      local_configuration = self.portal_templates.getLocalConfiguration(self)
2225 2226 2227 2228 2229 2230 2231 2232
      # 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)
      # It is better to clear cache because the uninstallation of a 
      # template deletes many things from the portal.
2233
      clearCache()
2234

2235 2236
    uninstall = WorkflowMethod(uninstall)

2237
    security.declareProtected(Permissions.ManagePortal, 'clean')
2238
    def clean(self):
2239
      """
2240
        Clean built information.
2241
      """
2242
      # First, remove obsolete attributes if present.
Aurel's avatar
Aurel committed
2243
      self._objects = None
2244 2245 2246 2247 2248 2249 2250 2251 2252
      for attr in ( '_action_archive', 
                    '_document_archive', 
                    '_extension_archive', 
                    '_test_archive', 
                    '_module_archive',
                    '_object_archive', 
                    '_portal_type_archive', 
                    '_property_archive', 
                    '_property_sheet_archive'):
2253 2254 2255
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
2256 2257
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
2258 2259

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

2261 2262
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getBuildingState')
2263
    def getBuildingState(self, id_only=1):
2264
      """
2265
        Returns the current state in building
2266
      """
2267
      portal_workflow = getToolByName(self, 'portal_workflow')
2268 2269
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
2270
      return wf._getWorkflowStateOf(self, id_only=id_only )
2271

2272 2273
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getInstallationState')
2274
    def getInstallationState(self, id_only=1):
2275
      """
2276
        Returns the current state in installation
2277
      """
2278
      portal_workflow = getToolByName(self, 'portal_workflow')
2279 2280
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
2281
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2282

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2283 2284 2285 2286 2287 2288
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
2289 2290 2291 2292
      export_string = portal_templates.manage_exportObject(
                                               id=self.getId(), 
                                               toxml=1, 
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2293 2294
      return export_string
      
2295
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2296
      """
2297 2298
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2299
      """
2300
      result = getattr(self, id, ())
2301 2302 2303 2304 2305 2306
      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
2307

2308
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2309
      """
2310 2311
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2312
      """
2313
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2314

2315
    def getTemplateBaseCategoryList(self):
2316
      """
2317 2318
      We have to set this method because we want an
      ordered list
2319
      """
2320
      return self._getOrderedList('template_base_category')
2321

2322
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2323
      """
2324 2325
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2326
      """
2327
      return self._getOrderedList('template_workflow_id')
2328

2329
    def getTemplatePortalTypeIdList(self):
2330
      """
2331 2332
      We have to set this method because we want an
      ordered list
2333
      """
2334
      return self._getOrderedList('template_portal_type_id')
2335

2336
    def getTemplateActionPathList(self):
2337
      """
2338 2339
      We have to set this method because we want an
      ordered list
2340
      """
2341
      return self._getOrderedList('template_action_path')
2342

2343
    def getTemplateSkinIdList(self):
2344
      """
2345 2346
      We have to set this method because we want an
      ordered list
2347
      """
2348
      return self._getOrderedList('template_skin_id')
2349

2350
    def getTemplateModuleIdList(self):
2351
      """
2352 2353
      We have to set this method because we want an
      ordered list
2354
      """
2355
      return self._getOrderedList('template_module_id')
2356 2357 2358 2359 2360 2361 2362

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

2364 2365
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'diff')
2366
    def diff(self, verbose=0):
2367
      """
2368
        Return a 'diff' of the business template compared to the
2369 2370
        __btsave__ version.
      """
2371 2372
      diff_message = '%s : %s\n%s\n' % (self.getPath(), DateTime(),
                                        '='*80)
2373
      # Diff everything
2374 2375 2376 2377 2378
      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
2379

2380
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
      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)

2392 2393
      # export bt 
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
2394 2395 2396 2397
      for prop in self.propertyMap():
        type = prop['type']
        id = prop['id']
#        if id in ('uid', 'rid', 'sid', 'id_group', 'last_id'):
2398
        if id in ('uid'): # maybe remove rid, sid
Aurel's avatar
Aurel committed
2399 2400 2401
          continue        
        value = self.getProperty(id)
        if type == 'text' or type == 'string' or type == 'int':
2402
          bta.addObject(object=value, name=id, path=path+os.sep+'bt', ext='')
Aurel's avatar
Aurel committed
2403
        elif type == 'lines' or type == 'tokens':
2404
          bta.addObject(object=str(os.linesep).join(value), name=id, path=path+os.sep+'bt', ext='')
Aurel's avatar
Aurel committed
2405 2406 2407 2408 2409 2410 2411 2412
                                                      
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)


      return bta.finishCreation()

2413
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
2414 2415
    def importFile(self, dir = 0, file=None, root_path=None):
      """
2416
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468
      """

      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
      
      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)