BusinessTemplate.py 207 KB
Newer Older
Nicolas Delaby's avatar
Nicolas Delaby committed
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3 4
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
5
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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.
#
##############################################################################

30
import fnmatch, gc, imp, os, re, shutil, sys
31
from Shared.DC.ZRDB import Aqueduct
32
from Shared.DC.ZRDB.Connection import Connection as RDBConnection
33
from Products.ERP5Type.DiffUtils import DiffFile
34
from Products.ERP5Type.Globals import Persistent, PersistentMapping
35
from Acquisition import Implicit, aq_base, aq_inner, aq_parent
36
from AccessControl import ClassSecurityInfo, Unauthorized, getSecurityManager
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37
from Products.CMFCore.utils import getToolByName
38
from Products.ERP5Type.Accessor.Constant import PropertyGetter as ConstantGetter
39
from Products.ERP5Type.Base import WorkflowMethod, _aq_reset
Nicolas Dumazet's avatar
Nicolas Dumazet committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
from Products.ERP5Type.Utils import readLocalDocument, \
                                    writeLocalDocument, \
                                    importLocalDocument, \
                                    removeLocalDocument
from Products.ERP5Type.Utils import readLocalPropertySheet, \
                                    writeLocalPropertySheet, \
                                    importLocalPropertySheet, \
                                    removeLocalPropertySheet
from Products.ERP5Type.Utils import readLocalConstraint, \
                                    writeLocalConstraint, \
                                    importLocalConstraint, \
                                    removeLocalConstraint
from Products.ERP5Type.Utils import readLocalExtension, \
                                    writeLocalExtension, \
                                    removeLocalExtension
from Products.ERP5Type.Utils import readLocalTest, \
                                    writeLocalTest, \
                                    removeLocalTest
58
from Products.ERP5Type.Utils import convertToUpperCase
59
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
60
from Products.ERP5Type.XMLObject import XMLObject
Aurel's avatar
Aurel committed
61
from OFS.Traversable import NotFound
62
from OFS import SimpleItem, XMLExportImport
63
from cStringIO import StringIO
Aurel's avatar
Aurel committed
64
from copy import deepcopy
65
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
66
import OFS.XMLExportImport
67
from Products.ERP5Type.patches.ppml import importXML
Aurel's avatar
Aurel committed
68
customImporters={
69
    XMLExportImport.magic: importXML,
Aurel's avatar
Aurel committed
70
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
71

72
from zLOG import LOG, WARNING
73
from warnings import warn
Aurel's avatar
Aurel committed
74
from gzip import GzipFile
75
from lxml.etree import parse
76
from xml.sax.saxutils import escape
77
from Products.CMFCore.Expression import Expression
78
from Products.ERP5Type import tarfile
79
from urllib import quote, unquote
80
from difflib import unified_diff
81
import posixpath
Julien Muchembled's avatar
Julien Muchembled committed
82
import transaction
83

84 85 86 87 88 89
import threading

CACHE_DATABASE_PATH = None
try:
  if int(os.getenv('ERP5_BT5_CACHE', 0)):
    from App.config import getConfiguration
90
    import gdbm
91 92 93 94 95 96
    instancehome = getConfiguration().instancehome
    CACHE_DATABASE_PATH = os.path.join(instancehome, 'bt5cache.db')
except TypeError:
  pass
cache_database = threading.local()

97 98
# those attributes from CatalogMethodTemplateItem are kept for
# backward compatibility
Aurel's avatar
Aurel committed
99 100
catalog_method_list = ('_is_catalog_list_method_archive',
                       '_is_uncatalog_method_archive',
101 102
                       '_is_clear_method_archive',
                       '_is_filtered_archive',)
103

104 105
catalog_method_filter_list = ('_filter_expression_archive',
                              '_filter_expression_instance_archive',
106
                              '_filter_expression_cache_key_archive',
107
                              '_filter_type_archive',)
108

109
INSTALLED_BT_FOR_DIFF = 'installed_bt_for_diff'
110
_MARKER = []
111

112 113 114 115 116 117
def _getCatalog(acquisition_context):
  """
    Return the id of the SQLCatalog which correspond to the current BT.
  """
  catalog_method_id_list = acquisition_context.getTemplateCatalogMethodIdList()
  if len(catalog_method_id_list) == 0:
118 119 120 121
    try:
      return acquisition_context.getPortalObject().portal_catalog.objectIds('SQLCatalog')[0]
    except IndexError:
      return None
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
  catalog_method_id = catalog_method_id_list[0]
  return catalog_method_id.split('/')[0]

def _getCatalogValue(acquisition_context):
  """
    Returns the catalog object which correspond to the ZSQLMethods
    stored/to store in the business template.

    NB: acquisition_context must make possible to reach portal object
        and getTemplateCatalogMethodIdList.
  """
  catalog_id = _getCatalog(acquisition_context)
  if catalog_id is None:
    return None
  try:
    return acquisition_context.getPortalObject().portal_catalog[catalog_id]
  except KeyError:
    return None

141 142 143 144 145
def _recursiveRemoveUid(obj):
  """Recusivly set uid to None, to prevent (un)indexing.
  This is used to prevent unindexing real objects when we delete subobjects on
  a copy of this object.
  """
146 147
  if hasattr(aq_base(obj), 'uid'):
    obj.uid = None
148 149 150
  for subobj in obj.objectValues():
    _recursiveRemoveUid(subobj)

151
def removeAll(entry):
152 153 154
  warn('removeAll is deprecated; use shutil.rmtree instead.',
       DeprecationWarning)
  shutil.rmtree(entry, True)
Aurel's avatar
Aurel committed
155

156 157 158 159 160 161 162
def getChainByType(context):
  """
  This is used in order to construct the full list
  of mapping between type and list of workflow associated
  This is only useful in order to use
  portal_workflow.manage_changeWorkflows
  """
163
  pw = context.getPortalObject().portal_workflow
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
  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)

185 186 187 188 189 190 191 192 193 194 195 196 197 198
def fixZSQLMethod(portal, method):
  """Make sure the ZSQLMethod uses a valid connection.
  """
  if not isinstance(getattr(portal, method.connection_id, None),
                      RDBConnection):
    # if not valid, we assign to the first valid connection found
    sql_connection_list = portal.objectIds(
                          spec=('Z MySQL Database Connection',))
    if (method.connection_id not in sql_connection_list) and \
       (len(sql_connection_list) != 0):
      LOG('BusinessTemplate', WARNING,
          'connection_id for Z SQL Method %s is invalid, using %s' % (
                    method.getId(), sql_connection_list[0]))
      method.connection_id = sql_connection_list[0]
199 200 201
  # recompile the method
  method._arg = Aqueduct.parse(method.arguments_src)
  method.template = method.template_class(method.src)
202

203 204
def registerSkinFolder(skin_tool, skin_folder):
  request = skin_tool.REQUEST
205 206 207
  # XXX: Getting parameter from request instead of dialog is bad
  # XXX: This is even non consistent with rest of parameters selected by user
  #      (like update_translation or update_catalog)
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
  register_skin_selection = request.get('your_register_skin_selection', 1)
  reorder_skin_selection = request.get('your_reorder_skin_selection', 1)
  skin_layer_list = request.get('your_skin_layer_list', 
                                skin_tool.getSkinSelections()) 

  skin_folder_id = skin_folder.getId()

  try:
    skin_selection_list = skin_folder.getProperty(
                 'business_template_registered_skin_selections', 
                 skin_tool.getSkinSelections()
                 )
  except AttributeError:
    skin_selection_list = skin_tool.getSkinSelections()

223 224 225
  if isinstance(skin_selection_list, basestring):
    skin_selection_list = skin_selection_list.split()

226 227 228 229 230 231 232
  def skin_sort_key(skin_folder_id):
    obj = skin_tool._getOb(skin_folder_id, None)
    if obj is None:
      return 0, skin_folder_id
    return -obj.getProperty('business_template_skin_layer_priority',
      obj.meta_type == 'Filesystem Directory View' and -1 or 0), skin_folder_id

233 234 235 236 237 238 239 240 241
  for skin_name in skin_selection_list:

    if (skin_name not in skin_tool.getSkinSelections()) and \
                                          register_skin_selection:
      createSkinSelection(skin_tool, skin_name)
      # add newly created skins to list of skins we care for 
      skin_layer_list.append(skin_name)

    selection = skin_tool.getSkinPath(skin_name) or ''
242
    selection_list = selection.split(',')
243
    if (skin_folder_id not in selection_list):
244
      selection_list.insert(0, skin_folder_id)
245
    if reorder_skin_selection:
246 247
      # Sort by skin priority and ID
      selection_list.sort(key=skin_sort_key)
248
    if (skin_name in skin_layer_list):
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
      skin_tool.manage_skinLayers(skinpath=selection_list,
                                  skinname=skin_name, add_skin=1)
      skin_tool.getPortalObject().changeSkin(None)

def createSkinSelection(skin_tool, skin_name):
  # This skin selection does not exist, so we create a new one.
  # We'll initialize it with all skin folders, unless:
  #  - they explictly define a list of
  #    "business_template_registered_skin_selections", and we
  #    are not in this list.
  #  - they are not registred in the default skin selection
  skin_path = ''
  for skin_folder in skin_tool.objectValues():
    if skin_name in skin_folder.getProperty(
             'business_template_registered_skin_selections',
             (skin_name, )):
      if skin_folder.getId() in \
          skin_tool.getSkinPath(skin_tool.getDefaultSkin()):
        if skin_path:
          skin_path = '%s,%s' % (skin_path, skin_folder.getId())
        else:
          skin_path= skin_folder.getId()
  # add newly created skins to list of skins we care for 
  skin_tool.addSkinSelection(skin_name, skin_path)
  skin_tool.getPortalObject().changeSkin(None)

def deleteSkinSelection(skin_tool, skin_name):
  # Do not delete default skin
  if skin_tool.getDefaultSkin() != skin_name:

    skin_selection_registered = False
    for skin_folder in skin_tool.objectValues():
      try:
        skin_selection_list = skin_folder.getProperty(
               'business_template_registered_skin_selections', ())
        if skin_name in skin_selection_list:
          skin_selection_registered = True
          break
      except AttributeError:
        pass

    if (not skin_selection_registered):
      skin_tool.manage_skinLayers(chosen=[skin_name], 
                                  del_skin=1)
      skin_tool.getPortalObject().changeSkin(None)

def unregisterSkinFolder(skin_tool, skin_folder, skin_selection_list):
  skin_folder_id = skin_folder.getId()

  for skin_selection in skin_selection_list:
    selection = skin_tool.getSkinPath(skin_selection)
    selection = selection.split(',')
    if (skin_folder_id in selection):
      selection.remove(skin_folder_id)
      skin_tool.manage_skinLayers(skinpath=tuple(selection),
                                  skinname=skin_selection, add_skin=1)
      deleteSkinSelection(skin_tool, skin_selection)
      skin_tool.getPortalObject().changeSkin(None)

Aurel's avatar
Aurel committed
308 309 310
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
311
  """
Aurel's avatar
Aurel committed
312 313 314 315 316 317 318 319 320 321 322 323

  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
324

325
  def finishCreation(self, name=None, **kw):
Aurel's avatar
Aurel committed
326 327 328 329
    pass

class BusinessTemplateFolder(BusinessTemplateArchive):
  """
Christophe Dumez's avatar
Christophe Dumez committed
330
    Class archiving business template into a folder tree
331
  """
Aurel's avatar
Aurel committed
332 333 334 335 336 337
  def _initCreation(self, path):
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
338
      shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
339 340 341
      os.makedirs(self.path)

  def addFolder(self, name=''):
Jérome Perrin's avatar
Jérome Perrin committed
342
    if name != '':
343
      name = os.path.normpath(name)
Aurel's avatar
Aurel committed
344
      path = os.path.join(self.path, name)
345
      if not os.path.exists(path):
Aurel's avatar
Aurel committed
346 347 348
        os.makedirs(path)
      return path

349
  def addObject(self, obj, name, path=None, ext='.xml'):
350 351 352
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
353 354 355
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
356
      if '%' not in path:
357 358 359 360
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
Aurel's avatar
Aurel committed
361
      object_path = os.path.join(path, name)
362
    f = open(object_path+ext, 'wb')
363 364 365 366
    try:
      f.write(str(obj))
    finally:
      f.close()
Aurel's avatar
Aurel committed
367 368

  def _initImport(self, file=None, path=None, **kw):
369
    # Normalize the paths to eliminate the effect of double-slashes.
370 371 372 373 374 375 376 377
    root_path_len = len(os.path.normpath(path)) + len(os.sep)
    self.root_path_len = root_path_len
    d = {}
    for f in file:
      f = os.path.normpath(f)
      klass = f[root_path_len:].split(os.sep, 1)[0]
      d.setdefault(klass, []).append(f)
    self.file_list_dict = d
Aurel's avatar
Aurel committed
378

379
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
380 381 382
    """
      Import file from a local folder
    """
383
    class_name = item.__class__.__name__
384 385
    root_path_len = self.root_path_len
    prefix_len = root_path_len + len(class_name) + len(os.sep)
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
    if CACHE_DATABASE_PATH:
      try:
        cache_database.db = gdbm.open(CACHE_DATABASE_PATH, 'cf')
      except gdbm.error:
        cache_database.db = gdbm.open(CACHE_DATABASE_PATH, 'nf')
    try:
      for file_path in self.file_list_dict.get(class_name, ()):
        if os.path.isfile(file_path):
          file = open(file_path, 'rb')
          try:
            file_name = file_path[prefix_len:]
            if '%' in file_name:
              file_name = unquote(file_name)
            item._importFile(file_name, file)
          finally:
            file.close()
    finally:
      if hasattr(cache_database, 'db'):
        cache_database.db.close()
        del cache_database.db
406

Aurel's avatar
Aurel committed
407 408 409 410 411 412
class BusinessTemplateTarball(BusinessTemplateArchive):
  """
    Class archiving businnes template into a tarball file
  """

  def _initCreation(self, path):
413
    # make tmp dir, must use stringIO instead
Aurel's avatar
Aurel committed
414 415 416 417 418
    self.path = path
    try:
      os.makedirs(self.path)
    except OSError:
      # folder already exists, remove it
419
      shutil.rmtree(self.path)
Aurel's avatar
Aurel committed
420 421 422 423 424 425
      os.makedirs(self.path)
    # init tarfile obj
    self.fobj = StringIO()
    self.tar = tarfile.open('', 'w:gz', self.fobj)

  def addFolder(self, name=''):
426
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
427
    if not os.path.exists(name):
Aurel's avatar
Aurel committed
428 429
      os.makedirs(name)

430
  def addObject(self, obj, name, path=None, ext='.xml'):
431 432 433
    name = name.replace('\\', '/')
    name = quote(name)
    name = os.path.normpath(name)
Aurel's avatar
Aurel committed
434 435 436
    if path is None:
      object_path = os.path.join(self.path, name)
    else:
437
      if '%' not in path:
438 439 440 441
        tail, path = os.path.splitdrive(path)
        path = path.replace('\\', '/')
        path = tail + quote(path)
      path = os.path.normpath(path)
Aurel's avatar
Aurel committed
442
      object_path = os.path.join(path, name)
443
    f = open(object_path+ext, 'wb')
444 445 446 447
    try:
      f.write(str(obj))
    finally:
      f.close()
Aurel's avatar
Aurel committed
448

449 450
  def finishCreation(self, name):
    self.tar.add(name)
Aurel's avatar
Aurel committed
451
    self.tar.close()
452
    shutil.rmtree(name)
Aurel's avatar
Aurel committed
453 454 455 456 457
    return self.fobj

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

458
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
459 460
    """
      Import all file from the archive to the site
461
    """
462
    class_name = item.__class__.__name__
Aurel's avatar
Aurel committed
463 464 465 466 467
    self.f.seek(0)
    data = GzipFile(fileobj=self.f).read()
    io = StringIO(data)
    tar = tarfile.TarFile(fileobj=io)
    for info in tar.getmembers():
Yoshinori Okuji's avatar
Yoshinori Okuji committed
468 469
      if 'CVS' in info.name.split('/'):
        continue
Yoshinori Okuji's avatar
Yoshinori Okuji committed
470 471
      if '.svn' in info.name.split('/'):
        continue
472
      if class_name in info.name.split('/'):
Aurel's avatar
Aurel committed
473 474
        if info.isreg():
          file = tar.extractfile(info)
475 476
          tar_file_name = info.name.startswith('./') and info.name[2:] or \
              info.name
477
          folders = tar_file_name.split('/')
478
          file_name = ('/').join(folders[2:])
479
          if '%' in file_name:
480
            file_name = unquote(file_name)
481
          item._importFile(file_name, file)
Aurel's avatar
Aurel committed
482 483 484
          file.close()
    tar.close()
    io.close()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
485

486
class TemplateConditionError(Exception): pass
487
class TemplateConflictError(Exception): pass
488
class BusinessTemplateMissingDependency(Exception): pass
489

490
class BaseTemplateItem(Implicit, Persistent):
491
  """
492
    This class is the base class for all template items.
493
    is_bt_for_diff means This BT is used to compare self temporary BT with installed BT
494
  """
495
  is_bt_for_diff = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
496

497
  def __init__(self, id_list, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
498
    self.__dict__.update(kw)
499
    self._archive = PersistentMapping()
Aurel's avatar
Aurel committed
500
    self._objects = PersistentMapping()
501
    for id in id_list:
502 503
      if id is not None and id != '':
        self._archive[id] = None
504 505 506 507

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

508
  def preinstall(self, context, installed_item, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
509 510
    """
      Build a list of added/removed/changed files between the BusinessTemplate
511
      being installed (self) and the installed one (installed_item).
Vincent Pelletier's avatar
Vincent Pelletier committed
512 513 514 515 516
      Note : we compare files between BTs, *not* between the installed BT and
      the objects in the DataFS.

      XXX: -12 used here is -len('TemplateItem')
    """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
517 518
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
519
      new_keys = self._objects.keys()
520
      for path in new_keys:
521
        if installed_item._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
522
          # compare objects to see it there are changes
523
          new_obj_xml = self.generateXml(path=path)
524
          old_obj_xml = installed_item.generateXml(path=path)
525 526
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
527
          # else, compared versions are identical, don't overwrite the old one
528 529
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
530
      # list removed objects
531
      old_keys = installed_item._objects.keys()
532 533 534 535 536 537
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
538
    pass
539 540 541

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

543
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
544 545 546 547 548 549
    """
      If 'remove' is chosen on an object containing subobjects, all the
      subobjects will be removed too, even if 'backup' or 'keep' was chosen for
      the subobjects.
      Likewise, for 'save_and_remove' : subobjects will get saved too.
    """
550 551 552
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
553
    keys.reverse()
554 555 556 557 558 559 560 561 562 563 564
    # if you choose remove, the object and all its subobjects will be removed
    # even if you choose backup or keep for subobjects
    # it is same behaviour for backup_and_remove, all we be save
    for path in keys:
      if remove_dict.has_key(path):
        action = remove_dict[path]
        if action == 'save_and_remove':
          # like trash
          self.uninstall(context, trash=1, object_path=path, **kw)
        elif action == 'remove':
          self.uninstall(context, trash=0, object_path=path, **kw)
565 566 567 568
        else:
          # As the list of available actions is not strictly defined,
          # prevent mistake if an action is not handled
          raise ValueError, 'Unknown action "%s"' % action
569

570

571 572 573 574
  def trash(self, context, new_item, **kw):
    # trash is quite similar to uninstall.
    return self.uninstall(context, new_item=new_item, trash=1, **kw)

Aurel's avatar
Aurel committed
575
  def export(self, context, bta, **kw):
576
    pass
Aurel's avatar
Aurel committed
577

578 579
  def getKeys(self):
    return self._objects.keys()
580

Aurel's avatar
Aurel committed
581
  def importFile(self, bta, **kw):
582
    bta.importFiles(item=self)
583

584
  def removeProperties(self, obj, export):
585 586
    """
    Remove unneeded properties for export
587
    """
588
    meta_type = getattr(aq_base(obj), 'meta_type', None)
589 590
    if meta_type == 'Script (Python)':
      meta_type = 'ERP5 Python Script'
591

592 593
    attr_set = set(('_dav_writelocks', '_filepath', '_owner', 'uid',
                    'workflow_history', '__ac_local_roles__'))
594
    if export:
595
      attr_set.update({
596 597 598
        'ERP5 Python Script': (#'func_code', 'func_defaults', '_code',
                               '_lazy_compilation', 'Python_magic'),
        #'Z SQL Method': ('_arg', 'template',),
599
      }.get(meta_type, ()))
600

601 602 603 604 605
      if interfaces.IIdGenerator.providedBy(obj):
        for dict_name in ('last_max_id_dict', 'last_id_dict'):
          if getattr(obj, dict_name, None) is not None:
            delattr(obj, dict_name)

606 607
    for attr in obj.__dict__.keys():
      if attr in attr_set or attr.startswith('_cache_cookie_'):
608 609 610 611
        delattr(obj, attr)

    if meta_type == 'ERP5 PDF Form':
      if not obj.getProperty('business_template_include_content', 1):
612
        obj.deletePdfContent()
613
    elif meta_type == 'ERP5 Python Script':
614 615 616 617 618 619 620
      if export:
        # XXX forward compatibility: set to None instead of deleting '_code'
        #     so that old BT code can import recent BT
        obj._code = None
      else:
        # save result of automatic compilation
        obj._p_changed = 1
621 622
    return obj

623 624 625 626 627 628 629 630 631
  def getTemplateTypeName(self):
    """
     Get a meaningfull class Name without 'TemplateItem'. Used to 
     present to the user.

     XXX: -12 used here is -len('TemplateItem')
    """
    return self.__class__.__name__[:-12]

632
  def restrictedResolveValue(self, context=None, path='', default=_MARKER):
633 634 635 636
    """
      Get the value with checking the security.
      This method does not acquire the parent.
    """
637 638
    return self.unrestrictedResolveValue(context, path, default=default,
                                         restricted=1)
639

640 641
  def unrestrictedResolveValue(self, context=None, path='', default=_MARKER,
                               restricted=0):
642 643 644 645 646 647 648 649 650 651 652
    """
      Get the value without checking the security.
      This method does not acquire the parent.
    """
    if isinstance(path, basestring):
      stack = path.split('/')
    else:
      stack = list(path)
    stack.reverse()
    if stack:
      if context is None:
653
        portal = aq_inner(self.getPortalObject())
654 655 656 657
        container = portal
      else:
        container = context

658 659 660 661
      if restricted:
        validate = getSecurityManager().validate

      while stack:
662
        key = stack.pop()
663 664 665 666 667 668 669 670
        try:
          value = container[key]
        except KeyError:
          LOG('BusinessTemplate', WARNING, 
              'Could not access object %s' % (path,))
          if default is _MARKER:
            raise
          return default
671

672 673 674 675 676 677 678 679 680 681 682 683
        if restricted:
          try:
            if not validate(container, container, key, value):
              raise Unauthorized('unauthorized access to element %s' % key)
          except Unauthorized:
            LOG('BusinessTemplate', WARNING,
                'access to %s is forbidden' % (path,))
          if default is _MARKER:
            raise
          return default

        container = value
684

685 686 687
      return value
    else:
      return context
688

689 690 691
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
692
  """
693

694 695 696 697
  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()
698
      self._archive.clear()
699 700 701
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
702

703
  def export(self, context, bta, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
704 705 706 707
    """
      Export the business template : fill the BusinessTemplateArchive with
      objects exported as XML, hierarchicaly organised.
    """
708 709 710
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
Vincent Pelletier's avatar
Vincent Pelletier committed
711
    for key, obj in self._objects.iteritems():
712
      # create folder and subfolders
713
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
714 715 716
      encode_folders = []
      for folder in folders.split('/'):
        if '%' not in folder:
717
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
718 719 720
        else:
          encode_folders.append(folder)
      path = os.path.join(root_path, (os.sep).join(encode_folders))
721 722
      bta.addFolder(name=path)
      # export object in xml
723
      f = StringIO()
724 725
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
726

Aurel's avatar
Aurel committed
727
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
728
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
729 730
    p = context.getPortalObject()
    for id in id_list:
731
      relative_url = '/'.join([url,id])
732 733
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
734
      obj = self.removeProperties(obj, 1)
Vincent Pelletier's avatar
Vincent Pelletier committed
735 736 737
      id_list = obj.objectIds() # FIXME duplicated variable name
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
738
        groups = deepcopy(obj.groups)
739
      if id_list:
Aurel's avatar
Aurel committed
740
        self.build_sub_objects(context, id_list, relative_url)
741
        for id_ in list(id_list):
742
          obj._delObject(id_)
743
      if hasattr(aq_base(obj), 'groups'):
744 745 746
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
747

748 749 750 751
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
752 753 754 755
      try:
        obj = p.unrestrictedTraverse(relative_url)
      except ValueError:
        raise ValueError, "Can not access to %s" % relative_url
756 757 758 759
      try:
        obj = obj._getCopy(context)
      except AttributeError:
        raise AttributeError, "Could not find object '%s' during business template processing." % relative_url
760
      _recursiveRemoveUid(obj)
761
      obj = self.removeProperties(obj, 1)
762
      id_list = obj.objectIds()
Vincent Pelletier's avatar
Vincent Pelletier committed
763 764
      if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
        # we must keep groups because they are deleted along with subobjects
765
        groups = deepcopy(obj.groups)
Aurel's avatar
Aurel committed
766 767
      if len(id_list) > 0:
        self.build_sub_objects(context, id_list, relative_url)
768
        for id_ in list(id_list):
769
          obj._delObject(id_)
770
      if hasattr(aq_base(obj), 'groups'):
771 772 773
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
774

775
  def _compileXML(self, file):
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 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 823 824 825 826 827 828 829 830 831 832 833 834
    # This method converts XML to ZEXP. Because the conversion
    # is quite heavy, a persistent cache database is used to
    # store ZEXP, so the second run wouldn't have to re-generate
    # identical data again.
    #
    # For now, a pair of the path to an XML file and its modification time
    # are used as a unique key. In theory, a checksum of the content could
    # be used instead, and it could be more reliable, as modification time
    # might not be updated in some insane filesystems correctly. However,
    # in practice, checksums consume a lot of CPU time, so when the cache
    # does not hit, the increased overhead is significant. In addition, it
    # does rarely happen that two XML files in Business Templates contain
    # the same data, so it may not be expected to have more cache hits
    # with this approach.
    #
    # The disadvantage is that this wouldn't work with the archive format,
    # because each entry in an archive does not have a mtime in itself.
    # However, the plan is to have an archive to retain ZEXP directly
    # instead of XML, so the idea of caching would be completely useless
    # with the archive format.
    name = file.name
    mtime = os.path.getmtime(file.name)
    key = '%s:%s' % (name, mtime)

    try:
      return StringIO(cache_database.db[key])
    except:
      pass

    #LOG('Business Template', 0, 'Compiling %s...' % (name,))
    from Shared.DC.xml import ppml
    from OFS.XMLExportImport import start_zopedata, save_record, save_zopedata
    import xml.parsers.expat
    outfile=StringIO()
    try:
      data=file.read()
      F=ppml.xmlPickler()
      F.end_handlers['record'] = save_record
      F.end_handlers['ZopeData'] = save_zopedata
      F.start_handlers['ZopeData'] = start_zopedata
      F.binary=1
      F.file=outfile
      p=xml.parsers.expat.ParserCreate('utf-8')
      p.returns_unicode = False
      p.CharacterDataHandler=F.handle_data
      p.StartElementHandler=F.unknown_starttag
      p.EndElementHandler=F.unknown_endtag
      r=p.Parse(data)

      try:
        cache_database.db[key] = outfile.getvalue()
      except:
        pass

      outfile.seek(0)
      return outfile
    except:
      outfile.close()
      raise
835

836
  def _importFile(self, file_name, file_obj):
837
    # import xml file
838
    if not file_name.endswith('.xml'):
839
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
840
      return
841 842 843 844 845
    obj = self
    connection = None
    while connection is None:
      obj=obj.aq_parent
      connection=obj._p_jar
846
    __traceback_info__ = 'Importing %s' % file_name
847 848
    if hasattr(cache_database, 'db') and isinstance(file_obj, file):
      obj = connection.importFile(self._compileXML(file_obj))
849
    else:
850 851
      # FIXME: Why not use the importXML function directly? Are there any BT5s
      # with actual .zexp files on the wild?
852
      obj = connection.importFile(file_obj, customImporters=customImporters)
853
    self.removeProperties(obj, 0)
854 855
    self._objects[file_name[:-4]] = obj

856
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
857 858
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
859 860 861
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
      for path in self._objects:
862
        if installed_item._objects.has_key(path):
Julien Muchembled's avatar
Julien Muchembled committed
863
          upgrade_list.append((path,
864
            self.removeProperties(installed_item._objects[path], 0)))
865
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
866 867 868 869 870 871 872 873 874 875
          modified_object_list[path] = 'New', type_name
      # update _p_jar property of objects cleaned by removeProperties
      transaction.savepoint(optimistic=True)
      for path, old_object in upgrade_list:
        # compare object to see it there is changes
        new_object = self._objects[path]
        new_io = StringIO()
        old_io = StringIO()
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, new_io)
        new_obj_xml = new_io.getvalue()
876 877 878 879 880
        try:
          OFS.XMLExportImport.exportXML(old_object._p_jar, old_object._p_oid, old_io)
          old_obj_xml = old_io.getvalue()
        except ImportError, e: # module is already removed etc.
          old_obj_xml = '(%s: %s)' % (e.__class__.__name__, e)
Julien Muchembled's avatar
Julien Muchembled committed
881 882 883 884
        new_io.close()
        old_io.close()
        if new_obj_xml != old_obj_xml:
          modified_object_list[path] = 'Modified', type_name
885
      # get removed object
886
      for path in set(installed_item._objects) - set(self._objects):
Julien Muchembled's avatar
Julien Muchembled committed
887
        modified_object_list[path] = 'Removed', type_name
888 889
    return modified_object_list

890
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
891 892 893
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
894
    subobjects_dict = {}
895
    if trashbin is None: # must return subobjects
896 897 898 899 900 901
      object_path = container_path + [object_id]
      obj = self.unrestrictedTraverse(object_path)
      for subobject_id in list(obj.objectIds()):
        subobject_path = object_path + [subobject_id]
        subobject = self.unrestrictedTraverse(subobject_path)
        subobject_copy = subobject._p_jar.exportFile(subobject._p_oid)
902
        subobjects_dict[subobject_id] = subobject_copy
903
      return subobjects_dict
904
    # XXX btsave is for backward compatibility
905
    if action == 'backup' or action == 'btsave' or action == 'save_and_remove':
906 907 908
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=1, **kw)
909
    elif action == 'install':
910 911 912
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=0, **kw)
913 914 915 916
    else:
      # As the list of available actions is not strictly defined,
      # prevent mistake if an action is not handled
      raise ValueError, 'Unknown action "%s"' % action
917
    return subobjects_dict
918

919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
  def beforeInstall(self):
    """
      Installation hook.
      Called right at the begining of "install" method.
      Can be overridden by subclasses.
    """
    pass

  def afterInstall(self):
    """
      Installation hook.
      Called right before returning in "install" method.
      Can be overridden by subclasses.
    """
    pass

935
  def onNewObject(self, obj):
936 937 938 939
    """
      Installation hook.
      Called when installation process determined that object to install is
      new on current site (it's not replacing an existing object).
940
      `obj` parameter is the newly created object in its acquisition context.
941 942 943 944
      Can be overridden by subclasses.
    """
    pass

945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
  def setSafeReindexationMode(self, context):
    """
      Postpone indexations after unindexations.
      This avoids alarming error messages about a single uid being used
      by "deleted" path and reindexed object. This can happen here for
      objects on which the uid was restored: previous object was deleted,
      hence the "deleted" path, and new object does have the same uid.
    """
    original_reindex_parameters = context.getPlacelessDefaultReindexParameters()
    if original_reindex_parameters is None:
      original_reindex_parameters = {}
    activate_kw = original_reindex_parameters.get('activate_kw', {}).copy()
    activate_kw['after_method_id'] = 'unindexObject'
    context.setPlacelessDefaultReindexParameters(activate_kw=activate_kw, \
                                                 **original_reindex_parameters)
    return original_reindex_parameters

962
  def install(self, context, trashbin, **kw):
963
    self.beforeInstall()
964 965
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
966
    if context.getTemplateFormatVersion() == 1:
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
      def recurse(hook, document, prefix=''):
        my_prefix = '%s/%s' % (prefix, document.id)
        if (hook(document, my_prefix)):
          for subdocument in document.objectValues():
            recurse(hook, subdocument, my_prefix)
      def saveHook(document, prefix):
        uid = getattr(document, 'uid', None)
        if uid is None:
          return 0
        else:
          saved_uid_dict[prefix] = uid
          return 1
      def restoreHook(document, prefix):
        uid = saved_uid_dict.get(prefix)
        if uid is None:
          return 0
        else:
          document.uid = uid
          return 1
986
      groups = {}
987
      old_groups = {}
988 989 990 991
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
992 993
      # set safe activities execution order
      original_reindex_parameters = self.setSafeReindexationMode(context)
994
      for path in keys:
995 996
        if update_dict.has_key(path) or force:
          # get action for the oject
Yoshinori Okuji's avatar
Yoshinori Okuji committed
997
          action = 'backup'
998 999 1000 1001 1002
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          # get subobjects in path
1003 1004 1005
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
1006
          try:
1007
            container = self.unrestrictedResolveValue(portal, container_path)
1008 1009
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1010
            container_url = '/'.join(container_path)
1011 1012 1013 1014
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
1015
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
1016 1017
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
1018
              container_container = portal.unrestrictedTraverse(container_path[:-1])
1019 1020 1021 1022 1023
              if container_container.meta_type == 'ERP5 Catalog':
                container_container.manage_addProduct['ZSQLCatalog'].manage_addSQLCatalog(id=container_path[-1], title='')
                if len(container_container.objectIds()) == 1:
                  container_container.default_sql_catalog_id = container_path[-1]
                container = portal.unrestrictedTraverse(container_path)
1024 1025
            else:
              raise
1026
          saved_uid_dict = {}
1027
          subobjects_dict = {}
Julien Muchembled's avatar
Julien Muchembled committed
1028
          portal_type_dict = {}
1029
          old_obj = container._getOb(object_id, None)
1030
          object_existed = old_obj is not None
1031
          if old_obj is not None:
1032
            # Object already exists
1033
            recurse(saveHook, old_obj)
1034
            if getattr(aq_base(old_obj), 'groups', None) is not None:
1035 1036 1037 1038 1039
              # we must keep original order groups
              # from old form in case we keep some
              # old widget, thus we can readd them in
              # the right order group
              old_groups[path] = deepcopy(old_obj.groups)
1040
            subobjects_dict = self._backupObject(action, trashbin,
1041
                                                 container_path, object_id)
Julien Muchembled's avatar
Julien Muchembled committed
1042
            # in case of portal types, we want to keep some properties
1043
            if getattr(old_obj, 'meta_type', None) == 'ERP5 Base Type':
1044
              for attr in ('allowed_content_types',
Julien Muchembled's avatar
Julien Muchembled committed
1045 1046 1047 1048 1049 1050
                           'hidden_content_type_list',
                           'property_sheet_list',
                           'base_category_list'):
                portal_type_dict[attr] = getattr(old_obj, attr, ())
              portal_type_dict['workflow_chain'] = \
                getChainByType(context)[1].get('chain_' + object_id, '')
1051
            container.manage_delObjects([object_id])
1052

1053
          # install object
1054
          obj = self._objects[path]
1055
          if getattr(aq_base(obj), 'groups', None) is not None:
1056
            # we must keep original order groups
1057
            # because they change when we add subobjects
1058
            groups[path] = deepcopy(obj.groups)
1059
          # copy the object
1060 1061 1062 1063 1064 1065 1066
          if (getattr(aq_base(obj), '_mt_index', None) is not None and
              obj._count() == 0):
            # some btrees were exported in a corrupted state. They're empty but
            # their metadata-index (._mt_index) contains entries which in
            # Zope 2.12 are used for .objectIds(), .objectValues() and
            # .objectItems(). In these cases, force the 
            LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
Łukasz Nowak's avatar
Łukasz Nowak committed
1067
                'Cleaning corrupted BTreeFolder2 object at %r.' % (path,))
1068
            obj._initBTrees()
1069
          obj = obj._getCopy(container)
1070 1071 1072 1073 1074
          try:
            container._setObject(object_id, obj)
          except AttributeError:
            LOG("BT, install", 0, object_id)
            raise
1075
          obj = container._getOb(object_id)
1076 1077 1078 1079 1080

          if not object_existed:
            # A new object was added, call the hook
            self.onNewObject(obj)

1081 1082
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
1083
          self.REQUEST.set('is_business_template_installation', 1)
1084 1085 1086 1087
          # We set isIndexable to 0 before calling
          # manage_afterClone in order to not call recursiveReindex, this is
          # useless because we will already reindex every created object, so
          # we avoid duplication of reindexation
1088
          obj.isIndexable = ConstantGetter('isIndexable', value=False)
1089
          obj.manage_afterClone(obj)
1090 1091 1092
          del obj.isIndexable
          if getattr(aq_base(obj), 'reindexObject', None) is not None:
            obj.reindexObject()
1093
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
1094
          if portal_type_dict:
1095
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
1096
            wf_chain = portal_type_dict.pop('workflow_chain')
1097 1098
            chain_dict = getChainByType(context)[1]
            default_chain = ''
1099
            chain_dict['chain_%s' % (object_id)] = wf_chain
1100
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
1101 1102
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
1103
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
1104
          if subobjects_dict:
1105
            # get a jar
1106 1107
            connection = obj._p_jar
            o = obj
1108
            while connection is None:
1109 1110
              o = o.aq_parent
              connection = o._p_jar
1111
            # import subobjects
1112
            for subobject_id, subobject_data in subobjects_dict.iteritems():
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
              try:
                if obj._getOb(subobject_id, None) is None:
                  subobject_data.seek(0)
                  subobject = connection.importFile(subobject_data)
                  obj._setObject(subobject_id, subobject)
              except AttributeError:
                # XXX this may happen when an object which can contain
                # sub-objects (e.g. ERP5 Form) has been replaced with
                # an object which cannot (e.g. External Method).
                LOG('BusinessTemplate', WARNING,
                    'could not restore %r in %r' % (subobject_id, obj))
1124
          if obj.meta_type in ('Z SQL Method',):
1125
            fixZSQLMethod(portal, obj)
1126 1127 1128
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
1129 1130 1131
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
1132
          elif obj.meta_type in ('ERP5 Ram Cache',
1133
                                 'ERP5 Distributed Ram Cache',):
1134 1135
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
1136 1137
          elif (container.meta_type == 'CMF Skins Tool') and \
              (old_obj is not None):
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
            # Keep compatibility with previous export format of
            # business_template_registered_skin_selections
            # and do not modify exported value
            if obj.getProperty('business_template_registered_skin_selections', 
                               None) is None:
              # Keep previous value of register skin selection for skin folder
              skin_selection_list = old_obj.getProperty(
                  'business_template_registered_skin_selections', None)
              if skin_selection_list is not None:
                if isinstance(skin_selection_list, basestring):
                  skin_selection_list = skin_selection_list.split(' ')
                obj._setProperty(
                    'business_template_registered_skin_selections',
                    skin_selection_list, type='tokens')
1152 1153 1154 1155 1156 1157 1158 1159
          # in case the portal ids, we want keep the property dict
          elif interfaces.IIdGenerator.providedBy(obj) and \
            old_obj is not None:
            for dict_name in ('last_max_id_dict', 'last_id_dict'):
              # Keep previous last id dict
              if getattr(old_obj, dict_name, None) is not None:
                old_dict = getattr(old_obj, dict_name, None)
                setattr(obj, dict_name, old_dict)
1160

1161
          recurse(restoreHook, obj)
1162
      # now put original order group
1163 1164
      # we remove object not added in forms
      # we put old objects we have kept
1165
      for path, new_groups_dict in groups.iteritems():
1166 1167 1168 1169 1170 1171 1172 1173 1174
        if not old_groups.has_key(path):
          # installation of a new form
          obj = portal.unrestrictedTraverse(path)
          obj.groups = new_groups_dict
        else:
          # upgrade of a form
          old_groups_dict = old_groups[path]
          obj = portal.unrestrictedTraverse(path)
          # first check that all widgets are in new order
1175
          # excetp the one that had to be removed
1176 1177 1178 1179
          widget_id_list = obj.objectIds()
          for widget_id in widget_id_list:
            widget_path = path+'/'+widget_id
            if update_dict.has_key(widget_path) and update_dict[widget_path] in ('remove', 'save_and_remove'):
1180 1181
              continue
            widget_in_form = 0
1182 1183
            for group_id, group_value_list in new_groups_dict.iteritems():
              if widget_id in group_value_list:
1184 1185 1186 1187 1188 1189
                widget_in_form = 1
                break
            # if not, add it in the same groups
            # defined on the former form
            previous_group_id = None
            if not widget_in_form:
1190
              for old_group_id, old_group_values in old_groups_dict.iteritems():
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
                if widget_id in old_group_values:
                  previous_group_id = old_group_id
              # if we find same group in new one, add widget to it
              if previous_group_id is not None and new_groups_dict.has_key(previous_group_id):
                new_groups_dict[previous_group_id].append(widget_id)
              # otherwise use a specific group
              else:
                if new_groups_dict.has_key('not_assigned'):
                  new_groups_dict['not_assigned'].append(widget_id)
                else:
                  new_groups_dict['not_assigned'] = [widget_id,]
1202
                  obj.group_list = list(obj.group_list) + ['not_assigned']
1203
          # second check all widget_id in order are in form
1204 1205
          for group_id, group_value_list in new_groups_dict.iteritems():
            for widget_id in tuple(group_value_list):
1206 1207 1208
              if widget_id not in widget_id_list:
                # if we don't find the widget id in the form
                # remove it fro the group
1209
                group_value_list.remove(widget_id)
1210
          # now set new group object
1211
          obj.groups = new_groups_dict
1212
      # restore previous activities execution order
1213
      context.setPlacelessDefaultReindexParameters(**original_reindex_parameters)
1214
      # Do not forget to delete all remaining objects if asked by user
1215 1216 1217 1218 1219 1220
      # Fetch all sub objects path recursively
      recursive_path_list = []
      def fillRecursivePathList(from_path_list):
        for from_path in from_path_list:
          container = portal.unrestrictedTraverse(from_path, None)
          if container is not None:
1221 1222
            if from_path in recursive_path_list:
              continue
1223 1224 1225 1226 1227 1228
            recursive_path_list.append(from_path)
            # Check that container support iteration of sub_content_id
            if getattr(aq_base(container), 'objectIds', None) is not None:
              fillRecursivePathList(['%s/%s' % (from_path, sub_content_id) for\
                                        sub_content_id in container.objectIds()])
      fillRecursivePathList(self._objects.keys())
1229 1230 1231
      for recursive_path in recursive_path_list:
        if recursive_path in update_dict:
          action = update_dict[recursive_path]
1232
          if action in ('remove', 'save_and_remove'):
1233
            document = self.unrestrictedResolveValue(portal, recursive_path, None)
1234 1235 1236
            if document is None:
              # It happens if the parent of target path is removed before
              continue
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
            if getattr(aq_base(document), 'getParentValue', None) is not None:
              # regular ERP5 object
              parent = document.getParentValue()
            else:
              parent = document.aq_parent
            document_id = document.getId()
            container_path_list = recursive_path.split('/')[:-1]
            self._backupObject(action, trashbin, container_path_list,
                               document_id)
            parent.manage_delObjects([document_id])
Aurel's avatar
Aurel committed
1247
    else:
1248 1249
      # for old business template format
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
1250
      portal = context.getPortalObject()
1251
      for relative_url in self._archive.keys():
1252
        obj = self._archive[relative_url]
Aurel's avatar
Aurel committed
1253 1254 1255 1256
        container_path = relative_url.split('/')[0:-1]
        object_id = relative_url.split('/')[-1]
        container = portal.unrestrictedTraverse(container_path)
        container_ids = container.objectIds()
1257
        if object_id in container_ids:    # Object already exists
1258
          self._backupObject('backup', trashbin, container_path, object_id)
1259
          container.manage_delObjects([object_id])
Aurel's avatar
Aurel committed
1260
        # Set a hard link
1261 1262 1263 1264 1265 1266
        obj = obj._getCopy(container)
        container._setObject(object_id, obj)
        obj = container._getOb(object_id)
        obj.manage_afterClone(obj)
        obj.wl_clearLocks()
        if obj.meta_type in ('Z SQL Method',):
1267
          fixZSQLMethod(portal, obj)
1268
    self.afterInstall()
1269 1270 1271

  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
1272
    trash = kw.get('trash', 0)
1273 1274 1275 1276 1277
    trashbin = kw.get('trashbin', None)
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
Aurel's avatar
Aurel committed
1278
      object_keys = self._archive.keys()
1279
    for relative_url in object_keys:
1280 1281
      container_path = relative_url.split('/')[0:-1]
      object_id = relative_url.split('/')[-1]
1282
      try:
1283
        container = self.unrestrictedResolveValue(portal, container_path)
1284
        object = container._getOb(object_id) # We force access to the object to be sure
1285 1286
                                        # that appropriate exception is thrown
                                        # in case object is already backup and/or removed
1287
        if trash and trashbin is not None:
1288
          self.portal_trash.backupObject(trashbin, container_path, object_id, save=1, keep_subobjects=1)
1289
        if container.meta_type == 'CMF Skins Tool':
1290 1291
          # we are removing a skin folder, check and 
          # remove if registered skin selection
1292
          skin_folder = container[object_id]
1293 1294 1295
          unregisterSkinFolder(container, skin_folder,
              container.getSkinSelections())

1296
        container.manage_delObjects([object_id])
1297
        if container.aq_parent.meta_type == 'ERP5 Catalog' and not len(container):
1298
          # We are removing a ZSQLMethod, remove the SQLCatalog if empty
1299
          container.getParentValue().manage_delObjects([container.id])
1300
      except (NotFound, KeyError, BadRequest, AttributeError):
1301
        # object is already backup and/or removed
1302
        pass
1303 1304
    BaseTemplateItem.uninstall(self, context, **kw)

1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
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

1317 1318 1319 1320 1321 1322 1323 1324 1325
  def uninstall(self, context, **kw):
    portal = context.getPortalObject()
    trash = kw.get('trash', 0)
    trashbin = kw.get('trashbin', None)
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._path_archive.keys()
1326 1327
    object_keys.sort()
    object_keys.reverse()
1328 1329
    p = context.getPortalObject()
    for path in object_keys:
1330 1331 1332 1333 1334
      try:
        path_list = self._resolvePath(p, [], path.split('/'))
      except AttributeError:
        # path seems to not exist anymore
        continue
1335 1336 1337
      path_list.sort()
      path_list.reverse()
      for relative_url in path_list:
1338
        try:
Aurel's avatar
Aurel committed
1339 1340
          container_path = relative_url.split('/')[0:-1]
          object_id = relative_url.split('/')[-1]
1341
          container = self.unrestrictedResolveValue(portal, container_path)
1342
          if trash and trashbin is not None:
1343 1344
            self.portal_trash.backupObject(trashbin, container_path,
                                           object_id, save=1,
1345
                                           keep_subobjects=1)
1346 1347 1348 1349 1350 1351
          container.manage_delObjects([object_id])
        except (NotFound, KeyError):
          # object is already backup and/or removed
          pass
    BaseTemplateItem.uninstall(self, context, **kw)

1352 1353 1354
  def _resolvePath(self, folder, relative_url_list, id_list):
    """
      This method calls itself recursively.
1355

1356 1357 1358 1359 1360 1361 1362 1363 1364
      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.
1365 1366 1367
      obj = folder._getOb(id, None)
      if obj is None:
        raise AttributeError, "Could not resolve '%s' during business template processing." % id
1368
      return self._resolvePath(obj, relative_url_list + [id], id_list[1:])
1369 1370
    path_list = []
    for object_id in fnmatch.filter(folder.objectIds(), id):
1371
      if object_id != "":
1372
        path_list.extend(self._resolvePath(
1373
            folder._getOb(object_id),
1374
            relative_url_list + [object_id], id_list[1:]))
1375
    return path_list
Aurel's avatar
Aurel committed
1376

1377 1378 1379
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
1380
    keys = self._path_archive.keys()
1381
    keys.sort()
Aurel's avatar
Aurel committed
1382
    for path in keys:
1383
      include_subobjects = 0
Aurel's avatar
Aurel committed
1384
      if path.endswith("**"):
1385
        include_subobjects = 1
1386
      for relative_url in self._resolvePath(p, [], path.split('/')):
1387 1388
        obj = p.unrestrictedTraverse(relative_url)
        obj = obj._getCopy(context)
1389
        obj = obj.__of__(context)
1390
        _recursiveRemoveUid(obj)
1391
        id_list = obj.objectIds()
1392
        obj = self.removeProperties(obj, 1)
1393
        if hasattr(aq_base(obj), 'groups'):
1394
          # we must keep groups because it's ereased when we delete subobjects
1395
          groups = deepcopy(obj.groups)
1396
        if len(id_list) > 0:
1397 1398
          if include_subobjects:
            self.build_sub_objects(context, id_list, relative_url)
1399
          for id_ in list(id_list):
1400
            obj._delObject(id_)
1401
        if hasattr(aq_base(obj), 'groups'):
1402 1403 1404
          obj.groups = groups
        self._objects[relative_url] = obj
        obj.wl_clearLocks()
1405

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1406 1407 1408 1409 1410 1411 1412 1413
class ToolTemplateItem(PathTemplateItem):
  """This class is used only for making a distinction between other objects
  and tools, because tools may not be backed up."""
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
    """Fake as if a trashbin is not available."""
    return PathTemplateItem._backupObject(self, action, None, container_path,
                                          object_id, **kw)

1414
  def install(self, context, trashbin, **kw):
1415
    """ When we install a tool that is a type provider not
1416
    registered on types tool, register it into the type provider.
1417
    """
1418 1419 1420 1421
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    for type_container_id, obj in self._objects.iteritems():
1422
      if interfaces.ITypeProvider.providedBy(obj) and \
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
          type_container_id not in types_tool.type_provider_list:
        types_tool.type_provider_list = tuple(types_tool.type_provider_list) + \
                                        (type_container_id,)

  def uninstall(self, context, **kw):
    """ When we uninstall a tool, unregister it from the type provider. """
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._path_archive.keys()
    for tool_id in object_keys:
      types_tool.type_provider_list = tuple([ \
        x for x in types_tool.type_provider_list \
        if x != tool_id])
    PathTemplateItem.uninstall(self, context, **kw)

  def remove(self, context, **kw):
    """ When we remove a tool, unregister it from the type provider. """
    portal = context.getPortalObject()
1445
    types_tool = portal.portal_types
1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    for tool_id in keys:
      if remove_dict.has_key(tool_id):
        action = remove_dict[tool_id]
        if 'remove' in action:
          types_tool.type_provider_list = tuple([ \
            x for x in types_tool.type_provider_list \
            if x != tool_id])
    PathTemplateItem.remove(self, context, **kw)
1456

1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471
class PreferenceTemplateItem(PathTemplateItem):
  """
  This class is used to store preference objects
  """
  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 relative_url_list != []:
      LOG("PreferenceTemplateItem, _resolvePath", WARNING,
          "Should be empty")
1472
    if len(id_list) != 1:
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484
      LOG("PreferenceTemplateItem, _resolvePath", WARNING,
          "Should contain only one element")
    # XXX hardcoded
    return ['portal_preferences/%s' % id_list[0]]

  def install(self, context, trashbin, **kw):
    """
    Enable Preference
    """
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    for object_path in self._objects.keys():
1485
      pref = portal.unrestrictedTraverse(object_path)
1486
      # XXX getPreferenceState is a bad name
1487
      if pref.getPreferenceState() == 'disabled':
1488 1489
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1490 1491
        portal.portal_workflow.doActionFor(
                      pref,
1492 1493 1494
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1495 1496
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1497

1498 1499
class CategoryTemplateItem(ObjectTemplateItem):

1500 1501
  def __init__(self, id_list, tool_id='portal_categories', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1502

1503 1504 1505 1506
  def build_sub_objects(self, context, id_list, url, **kw):
    p = context.getPortalObject()
    for id in id_list:
      relative_url = '/'.join([url,id])
1507 1508
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1509
      obj = self.removeProperties(obj, 1)
1510
      id_list = obj.objectIds()
1511
      if id_list:
1512
        self.build_sub_objects(context, id_list, relative_url)
1513
        for id_ in list(id_list):
1514
          obj._delObject(id_)
1515 1516
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1517 1518 1519 1520 1521

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1522 1523
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
1524
      _recursiveRemoveUid(obj)
1525
      obj = self.removeProperties(obj, 1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1526
      include_sub_categories = obj.__of__(context).getProperty('business_template_include_sub_categories', 0)
1527
      id_list = obj.objectIds()
1528 1529
      if len(id_list) > 0 and include_sub_categories:
        self.build_sub_objects(context, id_list, relative_url)
1530
        for id_ in list(id_list):
1531
          obj._delObject(id_)
1532
      else:
1533
        for id_ in list(id_list):
1534
          obj._delObject(id_)
1535 1536
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1537

1538 1539 1540
  def beforeInstall(self):
    self._installed_new_category = False

1541
  def onNewObject(self, obj):
1542 1543 1544 1545
    self._installed_new_category = True

  def afterInstall(self):
    if self._installed_new_category:
1546 1547
      # reset accessors if we installed a new category
      _aq_reset()
1548

1549 1550
class SkinTemplateItem(ObjectTemplateItem):

1551 1552
  def __init__(self, id_list, tool_id='portal_skins', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1553

1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
    for relative_url in self._objects.keys():
      obj = self._objects[relative_url]
      if (getattr(obj, 'meta_type', None) == 'Folder') and \
        (obj.getProperty('business_template_registered_skin_selections', None) \
            is not None):
          obj._delProperty(
              'business_template_registered_skin_selections')

1564 1565
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578
    # We must install/update an ERP5 Form if one of its widget is modified.
    # This allow to keep the widget order and the form layout after an update
    #   from a BT to another one.
    for (bt_obj_path, bt_obj) in self._objects.items():
      if getattr(bt_obj, 'meta_type', None) == 'ERP5 Form':
        # search sub-objects of ERP5 Forms that are marked as "modified"
        for upd_obj_path in modified_object_list.keys():
          if upd_obj_path.startswith(bt_obj_path):
            # a child of the ERP5 Form must be updated, so the form too
            if not modified_object_list.has_key(bt_obj_path):
              modified_object_list.update({bt_obj_path: ['Modified', self.__class__.__name__[:-12]]})
    return modified_object_list

1579
  def install(self, context, trashbin, **kw):
1580
    ObjectTemplateItem.install(self, context, trashbin, **kw)
1581 1582
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1583
    p = context.getPortalObject()
1584
    skin_tool = p.portal_skins
1585 1586
    for relative_url in self._archive.keys():
      folder = p.unrestrictedTraverse(relative_url)
1587
      for obj in folder.objectValues(spec=('Z SQL Method',)):
1588 1589
        fixZSQLMethod(p, obj)

1590
      # Do not register skin which were explicitely ask not to be installed
1591 1592 1593 1594 1595
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611
      if folder.aq_parent.meta_type == 'CMF Skins Tool':
        registerSkinFolder(skin_tool, folder)

class RegisteredSkinSelectionTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

    for key in self._archive.keys():
      skin_folder_id, skin_selection_id = key.split(' | ')

      skin_folder = skin_tool[skin_folder_id]
      selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections',
          [])
1612 1613 1614
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1615
      if skin_selection_id in selection_list:
1616
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1617
      else:
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636
        raise NotFound, 'No skin selection %s found for skin folder %s.' \
                          % (skin_selection_id, skin_folder_id)

  # Function to generate XML Code Manually
  def generateXml(self, path=None):
    xml_data = '<registered_skin_selection>'
    keys = self._objects.keys()
    keys.sort()
    for key in keys:
      skin_selection_list = self._objects[key]
      xml_data += '\n <skin_folder_selection>'
      xml_data += '\n  <skin_folder>%s</skin_folder>' % key
      xml_data += '\n  <skin_selection>%s</skin_selection>' \
                      % ','.join(skin_selection_list)
      xml_data += '\n </skin_folder_selection>'
    xml_data += '\n</registered_skin_selection>'
    return xml_data

  def export(self, context, bta, **kw):
1637
    if not self._objects:
1638 1639 1640 1641
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
1642 1643 1644
    bta.addObject(obj=self.generateXml(), 
                  name='registered_skin_selection',  
                  path=root_path)
1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

    for skin_folder_id in self._objects.keys():

      if update_dict.has_key(skin_folder_id) or force:
        if not force:
          action = update_dict[skin_folder_id]
          if action == 'nothing':
            continue
        skin_folder = skin_tool[skin_folder_id]
1660 1661 1662
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1663

1664
        if selection_list is default_value:
1665
          create_property = True
1666
          selection_list = self._objects[skin_folder_id]
1667
        else:
1668
          create_property = False
1669 1670 1671 1672 1673
          if isinstance(selection_list, basestring):
            selection_list = selection_list.replace(',', ' ').split(' ')
          elif isinstance(selection_list, tuple):
            selection_list = list(selection_list)
          selection_list.extend(self._objects[skin_folder_id])
1674 1675

        # Remove duplicate
1676
        selection_list = list(set(selection_list))
1677 1678 1679
        if create_property:
          skin_folder._setProperty(
              'business_template_registered_skin_selections',
1680
              selection_list, type='tokens')
1681 1682 1683
        else:
          skin_folder._updateProperty(
              'business_template_registered_skin_selections',
1684
              selection_list)
1685 1686

        unregisterSkinFolder(skin_tool, skin_folder,
1687
                             skin_tool.getSkinSelections())
1688
        registerSkinFolder(skin_tool, skin_folder)
1689 1690

  def uninstall(self, context, **kw):
1691 1692 1693
    portal = context.getPortalObject()
    skin_tool = getToolByName(portal, 'portal_skins')

1694 1695 1696 1697
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
1698 1699 1700 1701
      object_keys = self._objects.keys()

    for skin_folder_id in object_keys:
      skin_folder = skin_tool[skin_folder_id]
1702
      current_selection_list = skin_folder.getProperty(
1703
        'business_template_registered_skin_selections', [])
1704
      current_selection_set = set(current_selection_list)
1705

1706 1707 1708
      skin_selection_list = workflow_id = self._objects[skin_folder_id]
      if isinstance(skin_selection_list, str):
        skin_selection_list = skin_selection_list.replace(',', ' ').split(' ')
1709 1710 1711 1712 1713
      for skin_selection in skin_selection_list:
        current_selection_set.remove(skin_selection)

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1714
        skin_folder._updateProperty(
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
            'business_template_registered_skin_selections',
            current_selection_list)

        # Unregister skin folder from skin selection
        unregisterSkinFolder(skin_tool, skin_folder, skin_selection_list)
      else:
        delattr(skin_folder, 'business_template_registered_skin_selections')

        # Delete all skin selection
        for skin_selection in skin_selection_list:
          deleteSkinSelection(skin_tool, skin_selection)
        # Register to all other skin selection
        registerSkinFolder(skin_tool, skin_folder)

1729
  def preinstall(self, context, installed_item, **kw):
1730 1731 1732 1733 1734
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      for path in new_keys:
1735
        if installed_item._objects.has_key(path):
1736 1737
          # compare object to see it there is changes
          new_object = self._objects[path]
1738
          old_object = installed_item._objects[path]
1739 1740 1741 1742 1743
          if new_object != old_object:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
1744
      old_keys = installed_item._objects.keys()
1745 1746 1747 1748 1749 1750 1751
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def _importFile(self, file_name, file):
    if not file_name.endswith('.xml'):
1752
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1753 1754 1755 1756
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
1757 1758 1759
    for skin_folder_selection in xml.getroot():
      skin_folder_id = skin_folder_selection.find('skin_folder').text
      selection_string = skin_folder_selection.find('skin_selection').text
1760 1761
      if not selection_string:
        selection_list = []
1762
      else:
1763 1764
        selection_list = selection_string.split(',')
      skin_selection_dict[skin_folder_id] = selection_list
1765
    self._objects = skin_selection_dict
1766 1767


1768
class WorkflowTemplateItem(ObjectTemplateItem):
1769

1770 1771
  def __init__(self, id_list, tool_id='portal_workflow', **kw):
    return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1772

1773 1774 1775 1776 1777
  # When the root object of a workflow is modified, the entire workflow is
  # recreated: all subobjects are discarded and must be reinstalled.
  # So we hide modified subobjects to the user and we always reinstall
  # (or remove) everything.

1778
  def preinstall(self, context, installed_item, installed_bt, **kw):
1779
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
1780
                                                         installed_item, **kw)
1781 1782 1783 1784
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1785
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1786 1787
      else:
        modified_workflow_dict[modified_object] = state
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809
    removed_workflow_id_list = [x[0].split('/', 1)[1] \
                                for x in modified_workflow_dict.iteritems() \
                                if x[1][0] == 'Removed']
    if len(removed_workflow_id_list) > 0:
      installed_chain_list = [[y.strip() for y in x.split('|')] for x in \
                                installed_bt.getTemplatePortalTypeWorkflowChainList()]
      new_chain_list = [[y.strip() for y in x.split('|')] for x in \
                          context.getTemplatePortalTypeWorkflowChainList()]
      chain_dict = getChainByType(context)[1]
      for workflow_id in removed_workflow_id_list:
        affected_portal_type_set = set([x[0][6:] for x in \
                                        chain_dict.iteritems() \
                                        if workflow_id in \
                                        [y.strip() for y in x[1].split(',')]])
        safe_portal_type_set = set([x[0] for x in installed_chain_list \
                                    if x[1] == workflow_id]) - \
                               set([x[0] for x in new_chain_list \
                                    if x[1] == workflow_id])
        if affected_portal_type_set - safe_portal_type_set:
          value = modified_workflow_dict['portal_workflow/%s' % workflow_id]
          modified_workflow_dict['portal_workflow/%s' % workflow_id] = \
              ('Removed but used', value[1])
1810 1811
    return modified_workflow_dict

1812
  def install(self, context, trashbin, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1813
    if context.getTemplateFormatVersion() == 1:
1814 1815 1816
      portal = context.getPortalObject()
      update_dict = kw.get('object_to_update')
      force = kw.get('force')
Julien Muchembled's avatar
Julien Muchembled committed
1817 1818 1819
      # sort to add objects before their subobjects
      for path in sorted(self._objects):
          if force:
1820
            action = 'backup'
Julien Muchembled's avatar
Julien Muchembled committed
1821
          else:
1822
            action = update_dict.get('/'.join(path.split('/')[:2]))
Julien Muchembled's avatar
Julien Muchembled committed
1823 1824
            if action in (None, 'nothing'):
              continue
1825 1826 1827
          container_path = path.split('/')[:-1]
          object_id = path.split('/')[-1]
          try:
1828
            container = self.unrestrictedResolveValue(portal, container_path)
1829 1830
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1831
            container_url = '/'.join(container_path)
1832 1833 1834 1835 1836 1837
            if update_dict.has_key(container_url):
              if update_dict[container_url] == 'nothing':
                continue
            raise
          container_ids = container.objectIds()
          if object_id in container_ids:    # Object already exists
1838
            self._backupObject(action, trashbin, container_path, object_id, keep_subobjects=1)
1839
            container.manage_delObjects([object_id])
1840 1841 1842 1843 1844 1845
          obj = self._objects[path]
          obj = obj._getCopy(container)
          container._setObject(object_id, obj)
          obj = container._getOb(object_id)
          obj.manage_afterClone(obj)
          obj.wl_clearLocks()
1846 1847 1848
    else:
      ObjectTemplateItem.install(self, context, trashbin, **kw)

1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
  def uninstall(self, context, **kw):
    object_path = kw.get('object_path', None)
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    removed_workflow_id_list = set([x.split('/', 1)[1] for x in object_keys])
    (default_chain, chain_dict) = getChainByType(context)
    for portal_type, workflow_ids in chain_dict.iteritems():
      workflow_ids = set([x.strip() for x in workflow_ids.split(',')]) - \
                     removed_workflow_id_list
      chain_dict[portal_type] = ', '.join(workflow_ids)
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
    ObjectTemplateItem.uninstall(self, context, **kw)
1864

1865 1866
class PortalTypeTemplateItem(ObjectTemplateItem):

1867 1868
  def __init__(self, id_list, tool_id='portal_types', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
1869 1870
    # XXX : this statement can be removed once all bt5 have separated
    # workflow-chain information
1871 1872 1873
    self._workflow_chain_archive = PersistentMapping()

  def build(self, context, **kw):
1874 1875
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
1876
      obj = p.unrestrictedTraverse(relative_url)
1877 1878 1879 1880
      # normalize relative_url, not all type informations are stored in
      # "portal_types"
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])

1881
      obj = obj._getCopy(context)
1882 1883
      # obj is in ghost state and an attribute must be accessed
      # so that obj.__dict__ does not return an empty dict
1884
      obj.meta_type
1885
      for attr in obj.__dict__.keys():
1886 1887 1888 1889 1890 1891 1892 1893
        if attr == '_property_domain_dict':
          continue
        if attr[0] == '_' or attr in ('allowed_content_types',
                                      'hidden_content_type_list',
                                      'property_sheet_list',
                                      'base_category_list',
                                      'last_id', 'uid', 'workflow_history'):
          delattr(obj, attr)
1894 1895
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1896

1897 1898
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1899 1900 1901 1902
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
1903 1904
    # We now need to setup the list of workflows corresponding to
    # each portal type
1905
    (default_chain, chain_dict) = getChainByType(context)
1906
    # Set the default chain to the empty string is probably the
1907
    # best solution, by default it is 'default_workflow', which is
1908
    # not very usefull
1909
    default_chain = ''
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1910
    if context.getTemplateFormatVersion() == 1:
1911
      object_list = self._objects
1912
    else:
1913 1914
      object_list = self._archive
    for path in object_list.keys():
1915 1916 1917 1918
      if update_dict.has_key(path) or force:
        if not force:
          action = update_dict[path]
          if action == 'nothing':
1919
            continue
1920 1921
        obj = object_list[path]
        portal_type = obj.id
1922 1923 1924
        if self._workflow_chain_archive.has_key(portal_type):
          chain_dict['chain_%s' % portal_type] = \
              self._workflow_chain_archive[portal_type]
1925 1926
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
1927

1928 1929
  # XXX : this method is kept temporarily, but can be removed once all bt5 are
  # re-exported with separated workflow-chain information
1930 1931 1932
  def _importFile(self, file_name, file):
    if 'workflow_chain_type.xml' in file_name:
      # import workflow chain for portal_type
1933
      result_dict = {}
1934
      xml = parse(file)
1935
      chain_list = xml.findall('//chain')
1936
      for chain in chain_list:
1937 1938 1939 1940
        portal_type = chain.find('type').text
        workflow = chain.find('workflow').text or ''
        result_dict[portal_type] = workflow
      self._workflow_chain_archive = result_dict
1941 1942 1943
    else:
      ObjectTemplateItem._importFile(self, file_name, file)

1944
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1945

1946 1947 1948
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

1949
  def build(self, context, **kw):
1950 1951 1952 1953 1954
    # we can either specify nothing, +, - or = before the chain
    # this is used to know how to manage the chain
    # if nothing or +, chain is added to the existing one
    # if - chain is removed from the exisiting one
    # if = chain replaced the existing one
1955
    p = context.getPortalObject()
1956
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1957
    for key in self._archive.keys():
1958 1959 1960
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1961
        workflow = wflist[1]
1962
      else:
1963
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1964
        portal_type = wflist[0][:-2]
1965
        workflow = ''
1966 1967 1968 1969 1970
      portal_type_key = '%s%s' % (self._chain_string_prefix, portal_type)
      if portal_type_key in chain_dict:
        workflow_name = workflow.lstrip('+-=')
        if workflow[0] != '-' and workflow_name not in \
           chain_dict[portal_type_key].split(self._chain_string_separator):
1971
          if not self.is_bt_for_diff:
1972 1973 1974
            # here, we use 'LOG' instead of 'raise', because it can
            # happen when a workflow is removed from the chain by
            # another business template.
Jérome Perrin's avatar
Jérome Perrin committed
1975
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
1976
                       'in chain for portal_type %s' % (workflow_name, portal_type))
1977
        self._objects.setdefault(portal_type, []).append(workflow)
1978
      elif not self.is_bt_for_diff:
1979
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1980
                        'is probably a sign of a missing dependency.'\
1981
                                                    % portal_type
1982

Christophe Dumez's avatar
Christophe Dumez committed
1983
  # Function to generate XML Code Manually
1984 1985
  def generateXml(self, path=None):
    xml_data = '<workflow_chain>'
1986 1987 1988
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
1989
      workflow_list = self._objects[key]
1990 1991
      xml_data += '\n <chain>'
      xml_data += '\n  <type>%s</type>' %(key,)
1992 1993
      xml_data += '\n  <workflow>%s</workflow>' %(
        self._chain_string_separator.join(sorted(workflow_list)))
1994 1995
      xml_data += '\n </chain>'
    xml_data += '\n</workflow_chain>'
1996 1997 1998
    return xml_data

  def export(self, context, bta, **kw):
1999
    if not self._objects:
2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
    xml_data = self.generateXml()
    bta.addObject(obj=xml_data, name='workflow_chain_type',  path=root_path)

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    # We now need to setup the list of workflows corresponding to
    # each portal type
2012
    (default_chain, chain_dict) = getChainByType(context)
2013
    # First convert all workflow_ids into list.
2014 2015
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
2016
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
2017
    # best solution, by default it is 'default_workflow', which is
2018 2019
    # not very usefull
    default_chain = ''
2020 2021
    for path in self._objects:
      if path in update_dict or force:
2022 2023 2024
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2025
            continue
Jérome Perrin's avatar
Jérome Perrin committed
2026 2027
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
2028
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
2029
          continue
2030
        portal_type = path_splitted[-1]
2031 2032
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
2033
          # XXX we don't use the chain (Default) in erp5 so don't keep it
2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053
          old_chain_list = [workflow_id for workflow_id in\
                            chain_dict[chain_key] if workflow_id not in\
                            ('(Default)', '',)]
          old_chain_workflow_id_set = set(old_chain_list)
          # get new workflow id list
          workflow_id_list = self._objects[path]
          for wf_id in workflow_id_list:
            if wf_id[0] == '-':
              # remove wf id if already present
              if wf_id[1:] in old_chain_workflow_id_set:
                old_chain_workflow_id_set.remove(wf_id[1:])
            elif wf_id[0] == '=':
              # replace existing chain by this one
              old_chain_workflow_id_set = set()
              old_chain_workflow_id_set.add(wf_id[1:])
            # then either '+' or nothing, add wf id to the list
            elif wf_id[0] == '+':
              old_chain_workflow_id_set.add(wf_id[1:])
            else:
              old_chain_workflow_id_set.add(wf_id)
2054
            # create the new chain
2055 2056
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
2057 2058
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
2059
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
2060 2061 2062
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
2063
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
2064
        else:
2065
          if context.portal_types.getTypeInfo(portal_type) is None:
2066
            raise ValueError('Cannot chain workflow %r to non existing '
2067 2068 2069 2070 2071
                           'portal type %r' % (self._chain_string_separator\
                                                     .join(self._objects[path])
                                               , portal_type))
          chain_dict[chain_key] = self._objects[path]
    # convert workflow list into string only at the end.
2072 2073
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
2074 2075
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2076

2077 2078
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
2079 2080
    object_path = kw.get('object_path', None)
    if object_path is not None:
2081
      object_key_list = [object_path]
2082
    else:
2083 2084 2085
      object_key_list = self._objects.keys()
    for object_key in object_key_list:
      path_splitted = object_key.split('/', 1)
2086 2087 2088
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
2089 2090 2091 2092 2093 2094 2095 2096 2097 2098
      path = '%s%s' % (self._chain_string_prefix, portal_type)
      if path in chain_dict:
        workflow_id_list = chain_dict[path].\
                                            split(self._chain_string_separator)
        removed_workflow_id_list = self._objects[object_key]
        for workflow_id in removed_workflow_id_list:
          for i in range(workflow_id_list.count(workflow_id)):
            workflow_id_list.remove(workflow_id)
        if not workflow_id_list:
          del chain_dict[path]
2099
        else:
2100 2101 2102 2103
          chain_dict[path] = self._chain_string_separator.\
                                                  join(workflow_id_list)
    context.getPortalObject().portal_workflow.\
                                   manage_changeWorkflows('', props=chain_dict)
2104

2105
  def preinstall(self, context, installed_item, **kw):
2106 2107
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
2108
      new_key_list = self._objects.keys()
2109 2110
      new_dict = PersistentMapping()
      # Fix key from installed bt if necessary
2111
      for key, value in installed_item._objects.iteritems():
2112 2113
        if not 'portal_type_workflow_chain/' in key:
          key = 'portal_type_workflow_chain/%s' % (key)
2114
        new_dict[key] = value
2115
      if new_dict:
2116
        installed_item._objects = new_dict
2117 2118
      for path in new_key_list:
        if path in installed_item._objects:
2119 2120
          # compare object to see it there is changes
          new_object = self._objects[path]
2121
          old_object = installed_item._objects[path]
2122 2123 2124 2125 2126 2127
          if isinstance(new_object, str):
            new_object = new_object.split(self._chain_string_separator)
          if isinstance(old_object, str):
            old_object = old_object.split(self._chain_string_separator)
          new_object.sort()
          old_object.sort()
2128
          if new_object != old_object:
2129
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2130
        else: # new object
2131
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2132
      # get removed object
2133 2134 2135
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2136 2137
    return modified_object_list

2138
  def _importFile(self, file_name, file):
2139
    if not file_name.endswith('.xml'):
2140
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2141
      return
2142
    # import workflow chain for portal_type
2143
    result_dict = {}
2144
    xml = parse(file)
2145
    chain_list = xml.findall('chain')
2146
    for chain in chain_list:
2147
      portal_type = chain.find('type').text
2148
      workflow_chain = chain.find('workflow').text or ''
2149
      if 'portal_type_workflow_chain/' not in portal_type:
2150 2151 2152 2153
        key = 'portal_type_workflow_chain/%s' % (portal_type,)
      else:
        key = portal_type
      result_dict[key] = workflow_chain.split(self._chain_string_separator)
2154
    self._objects = result_dict
2155

2156 2157
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2158

2159
class PortalTypeAllowedContentTypeTemplateItem(BaseTemplateItem):
2160 2161 2162
  # XXX This class is subclassed for hidden types, propertysheets, base
  # categories ...
  name = 'Allowed Content Type'
2163 2164
  xml_tag = 'allowed_content_type_list'
  class_property = 'allowed_content_types'
2165
  business_template_class_property = '_portal_type_allowed_content_type_item'
2166 2167

  def build(self, context, **kw):
2168
    types_tool = getToolByName(self.getPortalObject(), 'portal_types')
2169
    for key in self._archive.keys():
2170 2171 2172 2173
      try:
        portal_type, allowed_type = key.split(' | ')
      except ValueError:
        raise ValueError('Invalid item %r in %s' % (key, self.name))
2174
      ob = types_tool.getTypeInfo(portal_type)
2175
      # check properties corresponds to what is defined in site
2176
      if ob is None:
2177 2178
        raise ValueError, "Portal Type %s not found in site" %(portal_type,)
      prop_value = getattr(ob, self.class_property, ())
2179
      if not allowed_type in prop_value and not self.is_bt_for_diff:
Jérome Perrin's avatar
Jérome Perrin committed
2180
        raise ValueError, "%s %s not found in portal type %s" % (
2181 2182
                             getattr(self, 'name', self.__class__.__name__),
                             allowed_type, portal_type)
2183 2184
      if self.class_property not in portal_type:
        key = '%s/%s' % (self.class_property, portal_type)
2185
      else:
2186 2187
        key = portal_type
      self._objects.setdefault(key, []).append(allowed_type)
2188

Christophe Dumez's avatar
Christophe Dumez committed
2189
  # Function to generate XML Code Manually
2190 2191
  def generateXml(self, path=None):
    xml_data = '<%s>' %(self.xml_tag,)
2192 2193 2194
    key_list = self._objects.keys()
    key_list.sort()
    for key in key_list:
2195
      id_value = key.replace('%s/' % self.class_property, '')
2196
      allowed_item_list = sorted(self._objects[key])
2197
      xml_data += '\n <portal_type id="%s">' % (id_value)
2198
      for allowed_item in allowed_item_list:
2199 2200 2201
        xml_data += '\n  <item>%s</item>' %(allowed_item,)
      xml_data += '\n </portal_type>'
    xml_data += '\n</%s>' %(self.xml_tag,)
2202 2203 2204
    return xml_data

  def export(self, context, bta, **kw):
2205
    if not self._objects:
2206 2207 2208
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
2209
    path = os.sep.join((self.__class__.__name__, self.class_property,))
2210 2211 2212
    xml_data = self.generateXml(path=None)
    bta.addObject(obj=xml_data, name=path, path=None)

2213
  def preinstall(self, context, installed_item, **kw):
2214 2215 2216
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      portal = context.getPortalObject()
2217
      new_key_list = self._objects.keys()
2218 2219
      new_dict = PersistentMapping()
      # fix key if necessary in installed bt for diff
Nicolas Delaby's avatar
Nicolas Delaby committed
2220
      for key, value in installed_item._objects.iteritems():
2221
        if self.class_property not in key:
2222
          key = '%s/%s' % (self.class_property, key)
Nicolas Delaby's avatar
Nicolas Delaby committed
2223
        new_dict[key] = value
2224
      if new_dict:
2225
        installed_item._objects = new_dict
2226 2227
      for path in new_key_list:
        if path in installed_item._objects:
2228 2229
          # compare object to see it there is changes
          new_object = self._objects[path]
2230
          old_object = installed_item._objects[path]
2231 2232
          new_object.sort()
          old_object.sort()
2233
          if new_object != old_object:
2234
            modified_object_list.update({path : ['Modified', self.getTemplateTypeName()]})
2235
        else: # new object
2236
          modified_object_list.update({path : ['New', self.getTemplateTypeName()]})
2237
      # get removed object
2238 2239 2240
      for path in installed_item._objects:
        if path not in new_key_list:
          modified_object_list.update({path : ['Removed', self.getTemplateTypeName()]})
2241 2242
    return modified_object_list

2243
  def _importFile(self, file_name, file):
2244
    if not file_name.endswith('.xml'):
2245
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2246
      return
2247
    path, name = posixpath.split(file_name)
2248
    xml = parse(file)
2249
    portal_type_list = xml.findall('portal_type')
2250
    for portal_type in portal_type_list:
2251 2252
      id = portal_type.get('id')
      item_type_list = [item.text for item in portal_type.findall('item')]
Nicolas Delaby's avatar
typo  
Nicolas Delaby committed
2253
      if self.class_property not in id:
2254 2255 2256 2257
        key = '%s/%s' % (self.class_property, id,)
      else:
        key = id
      self._objects[key] = item_type_list
2258 2259

  def install(self, context, trashbin, **kw):
Nicolas Delaby's avatar
Nicolas Delaby committed
2260 2261
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2262 2263
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2264 2265 2266 2267 2268 2269 2270
    installed_bt = kw.get('installed_bt')
    if installed_bt is not None:
      old_objects = getattr(installed_bt,
                            self.business_template_class_property)._objects
    else:
      old_objects = {}
    for key in set(self._objects.keys()).union(set(old_objects.keys())):
Nicolas Delaby's avatar
Nicolas Delaby committed
2271
      if key in update_dict or force:
2272 2273 2274 2275
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2276 2277 2278
        portal_id = key.split('/')[-1]
        type_information = types_tool.getTypeInfo(portal_id)
        if type_information is None:
2279 2280
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2281 2282
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
2283
        object_property_list = getattr(type_information, self.class_property, ())
Nicolas Delaby's avatar
Nicolas Delaby committed
2284 2285 2286 2287 2288 2289 2290 2291 2292
        # merge differences between portal types properties
        # for example:
        # * current value : [A,B,C]
        # * in new BT : [A,D]
        # * in old BT : [A,B]
        # -> [A,D,C] i.e. C is merged but B is not merged
        for id in object_property_list:
          if id not in property_list and id not in old_property_list:
            property_list.append(id)
2293
        setattr(type_information, self.class_property, tuple(property_list))
2294

Aurel's avatar
Aurel committed
2295
  def uninstall(self, context, **kw):
2296
    object_path = kw.get('object_path', None)
Nicolas Delaby's avatar
Nicolas Delaby committed
2297 2298
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2299
    if object_path is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
2300
      object_key_list = [object_path]
2301
    else:
Nicolas Delaby's avatar
Nicolas Delaby committed
2302 2303
      object_key_list = self._objects.keys()
    for key in object_key_list:
2304 2305 2306 2307 2308
      portal_id = key.split('/')[-1]
      type_information = types_tool.getTypeInfo(portal_id)
      if type_information is None:
        LOG("BusinessTemplate", WARNING,
            "Portal type %r not found while uninstalling" % (portal_id,))
2309 2310
        continue
      property_list = self._objects[key]
2311
      original_property_list = list(getattr(type_information,
2312
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2313 2314
      for id in property_list:
        if id in original_property_list:
2315
          original_property_list.remove(id)
2316
      setattr(type_information, self.class_property, tuple(original_property_list))
2317

2318

2319 2320
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2321
  name = 'Hidden Content Type'
2322 2323
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2324
  business_template_class_property = '_portal_type_hidden_content_type_item'
2325

2326

2327 2328
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2329
  name = 'Property Sheet'
2330 2331
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2332
  business_template_class_property = '_portal_type_property_sheet_item'
2333

2334

2335 2336
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2337
  name = 'Base Category'
2338 2339
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2340
  business_template_class_property = '_portal_type_base_category_item'
2341

2342

2343
class CatalogMethodTemplateItem(ObjectTemplateItem):
2344
  """Template Item for catalog methods.
2345

2346 2347 2348 2349 2350
    This template item stores catalog method and install them in the
    default catalog.
    The use Catalog makes for methods is saved as well and recreated on
    installation.
  """
2351

2352 2353
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2354
    # a mapping to store properties of methods.
2355 2356 2357 2358 2359
    # the mapping contains an entry for each method, and this entry is
    # another mapping having the id of the catalog property as key and a
    # boolean value to say wether the method is part of this catalog
    # configuration property.
    self._method_properties = PersistentMapping()
2360

2361
    self._is_filtered_archive = PersistentMapping()
2362 2363
    for method in catalog_method_filter_list:
      setattr(self, method, PersistentMapping())
2364

2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378
  def _extractMethodProperties(self, catalog, method_id):
    """Extracts properties for a given method in the catalog.
    Returns a mapping of property name -> boolean """
    method_properties = PersistentMapping()
    for prop in catalog._properties:
      if prop.get('select_variable') == 'getCatalogMethodIds':
        if prop['type'] == 'selection' and \
            getattr(catalog, prop['id']) == method_id:
          method_properties[prop['id']] = 1
        elif prop['type'] == 'multiple selection' and \
            method_id in getattr(catalog, prop['id']):
          method_properties[prop['id']] = 1
    return method_properties

2379 2380
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2381

2382
    catalog = _getCatalogValue(self)
2383
    if catalog is None:
2384
      LOG('BusinessTemplate build', 0, 'catalog not found')
2385
      return
2386

2387 2388 2389
    # upgrade old
    if not hasattr(self, '_method_properties'):
      self._method_properties = PersistentMapping()
2390

2391 2392
    for obj in self._objects.values():
      method_id = obj.id
2393 2394
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2395 2396 2397 2398 2399 2400
      filter = catalog.filter_dict.get(method_id, {})
      self._is_filtered_archive[method_id] = filter.get('filtered', 0)
      for method in catalog_method_filter_list:
        property = method[8:-8]
        if property in filter:
          getattr(self, method)[method_id] = filter[property]
2401

2402 2403 2404 2405 2406
  def generateXml(self, path):
    obj = self._objects[path]
    method_id = obj.id
    xml_data = '<catalog_method>'
    if self._method_properties.has_key(method_id):
2407
      for method_property, value in self._method_properties[method_id].items():
2408 2409 2410
        xml_data += '\n <item key="%s" type="int">' %(method_property,)
        xml_data += '\n  <value>%s</value>' %(value,)
        xml_data += '\n </item>'
2411

2412
      if self._is_filtered_archive.get(method_id):
2413 2414 2415
          xml_data += '\n <item key="_is_filtered_archive" type="int">'
          xml_data += '\n  <value>1</value>'
          xml_data += '\n </item>'
2416 2417
          for method in catalog_method_filter_list:
            if method != '_filter_expression_instance_archive':
2418 2419
              value = getattr(self, method, {}).get(method_id)
              if isinstance(value, basestring):
2420 2421 2422
                xml_data += '\n <item key="%s" type="str">' %(method,)
                xml_data += '\n  <value>%s</value>' %(str(value))
                xml_data += '\n </item>'
2423
              elif value:
2424
                xml_data += '\n <item key="%s" type="tuple">'%(method)
2425
                for item in value:
2426 2427
                  xml_data += '\n  <value>%s</value>' %(str(item))
                xml_data += '\n </item>'
2428
    xml_data += '\n</catalog_method>\n'
Christophe Dumez's avatar
Christophe Dumez committed
2429
    return xml_data
2430

2431 2432 2433
  def preinstall(self, context, installed_item, **kw):
    modified_object_dict = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
    modified_object_dict.update(BaseTemplateItem.preinstall(self, context, installed_item, **kw))
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
    return modified_object_dict

  def export(self, context, bta, **kw):
    catalog = _getCatalogValue(self)
    if catalog is None:
      LOG('BusinessTemplate, export', 0, 'no SQL catalog was available')
      return

    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    for key in self._objects.keys():
      obj = self._objects[key]
      # create folder and subfolders
      folders, id = posixpath.split(key)
      path = os.path.join(root_path, folders)
      bta.addFolder(name=path)
      # export object in xml
      f=StringIO()
      XMLExportImport.exportXML(obj._p_jar, obj._p_oid, f)
      bta.addObject(obj=f.getvalue(), name=id, path=path)
      # add all datas specific to catalog inside one file
      key_name = os.path.join(obj.id+'.catalog_keys')
      xml_data = self.generateXml(key)
      bta.addObject(obj=xml_data, name=key_name, path=path)

2460 2461
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2462
    catalog = _getCatalogValue(self)
2463 2464 2465 2466 2467 2468 2469
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
    # Make copies of attributes of the default catalog of portal_catalog.
    sql_catalog_object_list = list(catalog.sql_catalog_object_list)
    sql_uncatalog_object = list(catalog.sql_uncatalog_object)
    sql_clear_catalog = list(catalog.sql_clear_catalog)
2470

2471 2472 2473
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    values = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2474
    new_bt_format = context.getTemplateFormatVersion()
2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490

    if force: # get all objects
      if new_bt_format:
        values = self._objects.values()
      else:
        values = self._archive.values()
    else: # get only selected object
      if new_bt_format == 1:
        keys = self._objects.keys()
      else:
        keys = self._archive.keys()
      for key in keys:
        if update_dict.has_key(key) or force:
          if not force:
            action = update_dict[key]
            if action == 'nothing':
2491
              continue
2492 2493 2494 2495
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2496

2497 2498
    for obj in values:
      method_id = obj.id
2499

2500 2501 2502 2503 2504 2505
      # Restore catalog properties for methods
      if hasattr(self, '_method_properties'):
        for key in self._method_properties.get(method_id, {}).keys():
          old_value = getattr(catalog, key, None)
          if isinstance(old_value, str):
            setattr(catalog, key, method_id)
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2506
          elif isinstance(old_value, (list, tuple)):
2507 2508 2509 2510
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2511

2512 2513
      # Restore filter
      if self._is_filtered_archive.get(method_id, 0):
2514
        expression = self._filter_expression_archive[method_id]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2515
        if context.getTemplateFormatVersion() == 1:
2516 2517 2518 2519 2520
          if expression and expression.strip():
            # only compile non-empty expressions
            expr_instance = Expression(expression)
          else:
            expr_instance = None
2521 2522
        else:
          expr_instance = self._filter_expression_instance_archive[method_id]
2523 2524 2525
        catalog.filter_dict[method_id] = PersistentMapping()
        catalog.filter_dict[method_id]['filtered'] = 1
        catalog.filter_dict[method_id]['expression'] = expression
2526
        catalog.filter_dict[method_id]['expression_instance'] = expr_instance
2527 2528 2529 2530
        catalog.filter_dict[method_id]['expression_cache_key'] = \
          self._filter_expression_cache_key_archive.get(method_id, ())
        catalog.filter_dict[method_id]['type'] = \
          self._filter_type_archive.get(method_id, ())
2531
      elif method_id in catalog.filter_dict.keys():
2532
        catalog.filter_dict[method_id]['filtered'] = 0
2533

2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559
      # backward compatibility
      if hasattr(self, '_is_catalog_list_method_archive'):
        LOG("BusinessTemplate.CatalogMethodTemplateItem", 0,
            "installing old style catalog method configuration")
        is_catalog_list_method = int(
                  self._is_catalog_list_method_archive[method_id])
        is_uncatalog_method = int(
                  self._is_uncatalog_method_archive[method_id])
        is_clear_method = int(
                  self._is_clear_method_archive[method_id])

        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)

        if is_uncatalog_method and method_id not in sql_uncatalog_object:
          sql_uncatalog_object.append(method_id)
        elif not is_uncatalog_method and method_id in sql_uncatalog_object:
          sql_uncatalog_object.remove(method_id)

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

2561 2562 2563 2564 2565 2566
        sql_catalog_object_list.sort()
        catalog.sql_catalog_object_list = tuple(sql_catalog_object_list)
        sql_uncatalog_object.sort()
        catalog.sql_uncatalog_object = tuple(sql_uncatalog_object)
        sql_clear_catalog.sort()
        catalog.sql_clear_catalog = tuple(sql_clear_catalog)
2567

2568
  def uninstall(self, context, **kw):
2569
    catalog = _getCatalogValue(self)
2570 2571 2572
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
2573

2574 2575 2576 2577
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2578 2579 2580 2581
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2582
    else:
2583
      try:
2584 2585 2586 2587
        if context.getTemplateFormatVersion() == 1:
          value = self._objects[object_path]
        else:
          value = self._archive[object_path]
2588 2589
      except KeyError:
        value = None
2590 2591
      if value is not None:
        values.append(value)
2592
    for obj in values:
2593
      method_id = obj.id
2594 2595 2596 2597 2598 2599 2600 2601 2602
      # remove method references in portal_catalog
      for catalog_prop in catalog._properties:
        if catalog_prop.get('select_variable') == 'getCatalogMethodIds'\
            and catalog_prop['type'] == 'multiple selection':
          old_value = getattr(catalog, catalog_prop['id'], ())
          if method_id in old_value:
            new_value = list(old_value)
            new_value.remove(method_id)
            setattr(catalog, catalog_prop['id'], new_value)
2603

Yoshinori Okuji's avatar
Yoshinori Okuji committed
2604
      if catalog.filter_dict.has_key(method_id):
2605
        del catalog.filter_dict[method_id]
2606

2607
    # uninstall objects
2608
    ObjectTemplateItem.uninstall(self, context, **kw)
2609

2610
  def _importFile(self, file_name, file):
2611
    if file_name.endswith('.catalog_keys.xml'):
2612
      # recreate data mapping specific to catalog method
2613 2614
      name = os.path.basename(file_name)
      id = name.split('.', 1)[0]
2615
      xml = parse(file)
2616
      method_list = xml.findall('item')
2617
      for method in method_list:
2618 2619 2620
        key = method.get('key')
        key_type = method.get('type')
        value_node = method.find('value')
2621
        if key_type == "str":
2622
          value = value_node.text or ''
2623
        elif key_type == "int":
2624
          value = int(value_node.text)
2625
        elif key_type == "tuple":
2626
          value = tuple([value_node.text for value_node in method.findall('value')])
2627
        else:
2628
          LOG('BusinessTemplate import CatalogMethod, type unknown', 0, key_type)
2629
          continue
2630
        if key in catalog_method_list or key in catalog_method_filter_list:
2631
          getattr(self, key)[id] = value
2632 2633 2634
        else:
          # new style key
          self._method_properties.setdefault(id, PersistentMapping())[key] = 1
2635 2636 2637 2638 2639 2640 2641 2642
    elif file_name.endswith('.xml'):
      # just import xml object
      obj = self
      connection = None
      while connection is None:
        obj=obj.aq_parent
        connection=obj._p_jar
      obj = connection.importFile(file, customImporters=customImporters)
2643
      self.removeProperties(obj, 0)
2644 2645 2646
      self._objects[file_name[:-4]] = obj
    else:
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2647

2648
class ActionTemplateItem(ObjectTemplateItem):
2649 2650

  def __init__(self, id_list, **kw):
2651
    # XXX It's look like ObjectTemplateItem __init__
2652 2653 2654 2655 2656 2657
    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

2658 2659
  def _splitPath(self, path):
    """
Leonardo Rochael Almeida's avatar
typo  
Leonardo Rochael Almeida committed
2660
      Split path tries to split a complex path such as:
2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678

      "foo/bar[id=zoo]"

      into

      "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

2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711
  def _getPortalTypeActionCopy(self, obj, value):
    id_id = 'reference'
    for action in obj.getActionInformationList():
      if getattr(action, id_id, None) == value:
        return obj._exportOldAction(action)

  def _getPortalToolActionCopy(self, obj, context, value):
    try:
      from Products.CMFCore.interfaces import IActionProvider
    except ImportError:
      # BACK:
      # we still don't load ZCML on tests on 2.8, but on 2.8 actions from other
      # tools are not redirected to portal_actions
      pass
    else:
      if not IActionProvider.providedBy(obj):
        # look for the action in portal_actions, instead of the original object
        LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
            'Redirected action export',
            'Attempted to retrieve action %r from %r which is no longer an '
            'IActionProvided. Retrieving action from portal_actions instead' %
            (value, obj.getId()))
        obj = context.getPortalObject().portal_actions
    id_id = 'id'
    for action in obj.listActions():
      if getattr(action, id_id, None) == value:
        return action._getCopy(context)

  def _getActionCopy(self, obj, context, value):
    """
    Gets action copy from action provider given the action id or reference
    """
    # Several tools still use CMF actions
2712
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2713 2714 2715 2716
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2717 2718 2719 2720
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2721 2722 2723
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2724
      # normalize url
2725 2726 2727 2728 2729
      url = p.portal_url.getRelativeContentPath(obj)
      if len(url) == 1:
        # global actions are stored under 'portal_types', mostly for
        # compatibility
        url = 'portal_types', url[0]
2730 2731
      action = self._getActionCopy(obj, context, value)
      if action is None:
2732 2733 2734
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2735
      key = posixpath.join(url[-2], url[-1], value)
2736
      self._objects[key] = self.removeProperties(action, 1)
2737
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2738

2739 2740 2741
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2742
    if context.getTemplateFormatVersion() == 1:
2743
      portal_type_dict = {}
Aurel's avatar
Aurel committed
2744 2745
      p = context.getPortalObject()
      for id in self._objects.keys():
2746 2747 2748 2749 2750
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
2751 2752 2753
          obj = self._objects[id]
          path, id = id.rsplit('/', 1)
          container = p.unrestrictedTraverse(path)
2754

2755
          if interfaces.ITypeProvider.providedBy(aq_parent(aq_inner(container))):
2756 2757 2758
            # XXX future BT should use 'reference' instead of 'id'
            reference = getattr(obj, 'reference', None) or obj.id
            portal_type_dict.setdefault(path, {})[reference] = obj
2759 2760
            continue

Julien Muchembled's avatar
Julien Muchembled committed
2761 2762
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2763 2764 2765
          try:
            from Products.CMFCore.interfaces import IActionProvider
          except ImportError:
2766
              # BACK:
2767 2768 2769 2770 2771 2772 2773 2774
              # we still don't load ZCML on tests on 2.8, but on 2.8 we don't
              # need to redirect actions to portal_actions.
              pass
          else:
            if not IActionProvider.providedBy(container):
              # some tools stopped being ActionProviders in CMF 2.x. Drop the
              # action into portal_actions.
              LOG('Products.ERP5.Document.BusinessTemplate', WARNING,
2775
                  'Redirected action import',
2776 2777 2778 2779
                  'Attempted to store action %r in %r which is no longer an '
                  'IActionProvided. Storing action on portal_actions instead' %
                  (id, path))
              container = p.portal_actions
2780
          obj, action = container, obj
2781
          action_list = obj.listActions()
2782
          for index in range(len(action_list)):
2783
            if action_list[index].id == id:
2784
              # remove previous action
2785
              obj.deleteActions(selections=(index,))
2786 2787 2788
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2789
          obj.addAction(
2790 2791
                        id = action.id
                      , name = action.title
2792
                      , action = action_text
2793 2794 2795 2796
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2797 2798
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2799
                      , priority = action.priority
2800
                      , description = action.description
Aurel's avatar
Aurel committed
2801
                    )
2802
          # sort action based on the priority define on it
2803 2804 2805 2806 2807 2808 2809 2810 2811
          # XXX suppose that priority are properly on actions
          new_priority = action.priority
          action_list = obj.listActions()
          move_down_list = []
          for index in range(len(action_list)):
            action = action_list[index]
            if action.priority > new_priority:
              move_down_list.append(str(index))
          obj.moveDownActions(selections=tuple(move_down_list))
2812 2813
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2814
        container.manage_delObjects([obj.id
2815
          for obj in container.getActionInformationList()
2816
          if obj.getReference() in action_dict])
2817 2818
        for obj in action_dict.itervalues():
          container._importOldAction(obj)
Aurel's avatar
Aurel committed
2819
    else:
2820
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2821
      p = context.getPortalObject()
2822 2823
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2824
        relative_url, key, value = self._splitPath(id)
2825 2826
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2827
          if getattr(ai, key) == value:
2828
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2829 2830 2831
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2832
        obj.addAction(
Aurel's avatar
Aurel committed
2833 2834
                      id = action.id
                    , name = action.title
2835
                    , action = action_text
Aurel's avatar
Aurel committed
2836 2837 2838 2839
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2840 2841
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2842
                    )
Aurel's avatar
Aurel committed
2843 2844 2845 2846 2847 2848 2849
        new_priority = action.priority
        action_list = obj.listActions()
        move_down_list = []
        for index in range(len(action_list)):
          action = action_list[index]
          if action.priority > new_priority:
            move_down_list.append(str(index))
2850 2851
          obj.moveDownActions(selections=tuple(move_down_list))

2852 2853
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2854 2855
    object_path = kw.get("object_path", None)
    if object_path is not None:
2856 2857 2858 2859 2860 2861 2862 2863
      if '/' in object_path:
        # here object_path is the path of the actions, something like
        # portal_type/Person/view
        ti, action_id = object_path.rsplit('/', 1)
        keys = ['%s | %s' % (ti, action_id)]
      else:
        # compatibility ?
        keys = [object_path]
2864
    else:
2865
      keys = self._archive.keys()
2866
    for id in keys:
2867 2868
      if  '|' in id:
        relative_url, value = id.split(' | ')
2869 2870 2871
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
2872
          is_new_action = interfaces.ITypeProvider.providedBy(obj.getParentValue())
2873
          key = is_new_action and 'reference' or 'id'
2874
      else:
2875
        relative_url, key, value = self._splitPath(id)
2876
        obj = p.unrestrictedTraverse(relative_url, None)
2877 2878 2879
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2880
          if getattr(action_list[index], key, None) == value:
2881 2882
            obj.deleteActions(selections=(index,))
            break
2883 2884
      LOG('BusinessTemplate', WARNING,
          'Unable to uninstall action at %s, ignoring' % relative_url )
2885 2886
    BaseTemplateItem.uninstall(self, context, **kw)

2887 2888 2889
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2890
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2891 2892 2893 2894 2895 2896 2897
    BaseTemplateItem.__init__(self, id_list, **kw)

  def build(self, context, **kw):
    p = context.getPortalObject()
    for relative_url in self._archive.keys():
      obj = p.unrestrictedTraverse("portal_types/%s" %
          relative_url.split('/', 1)[1])
2898 2899
      # normalize url
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])
2900
      self._objects[relative_url] = type_role_list = []
2901
      for role in obj.getRoleInformationList():
2902
        type_role_dict = {}
2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919
        for k, v in aq_base(role).__getstate__().iteritems():
          if k == 'condition':
            if not v:
              continue
            v = v.text
          elif k in ('role_base_category', 'role_category'):
            k = k[5:]
          elif k == 'role_name':
            k, v = 'id', '; '.join(v)
          elif k not in ('title', 'description'):
            k = {'id': 'object_id', # for stable sort
                 'role_base_category': 'base_category',
                 'role_base_category_script_id': 'base_category_script',
                 'role_category': 'category'}.get(k)
            if not k:
              continue
          type_role_dict[k] = v
2920
        type_role_list.append(type_role_dict)
2921
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2922

Christophe Dumez's avatar
Christophe Dumez committed
2923
  # Function to generate XML Code Manually
2924 2925 2926 2927
  def generateXml(self, path=None):
    type_role_list = self._objects[path]
    xml_data = '<type_roles>'
    for role in type_role_list:
2928
      xml_data += "\n  <role id='%s'>" % role['id']
2929
      # uniq
2930
      for property in ('title', 'description', 'condition',
2931 2932 2933
          'base_category_script'):
        prop_value = role.get(property)
        if prop_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
2934 2935
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2936
          xml_data += "\n   <property id='%s'>%s</property>" % \
2937 2938 2939
              (property, prop_value)
      # multi
      for property in ('category', 'base_category'):
2940
        for prop_value in role.get(property, []):
Nicolas Delaby's avatar
Nicolas Delaby committed
2941 2942
          if isinstance(prop_value, str):
            prop_value = prop_value.decode('utf-8')
2943
          xml_data += "\n   <multi_property "\
2944
          "id='%s'>%s</multi_property>" % (property, prop_value)
2945 2946
      xml_data += "\n  </role>"
    xml_data += '\n</type_roles>'
2947
    return xml_data
2948

2949 2950 2951 2952 2953 2954 2955
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      xml_data = self.generateXml(key)
2956 2957
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2958 2959 2960 2961
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

  def _importFile(self, file_name, file):
2962 2963 2964
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
2965 2966
    type_roles_list = []
    xml = parse(file)
2967
    xml_type_roles_list = xml.findall('role')
2968
    for role in xml_type_roles_list:
2969 2970 2971 2972
      id = role.get('id')
      if isinstance(id, unicode):
        id = id.encode('utf_8', 'backslashreplace')
      type_role_property_dict = {'id': id}
2973
      # uniq
2974 2975 2976 2977 2978 2979 2980 2981
      property_list = role.findall('property')
      for property_node in property_list:
        property_id = property_node.get('id')
        if property_node.text:
          value = property_node.text
          if isinstance(value, unicode):
            value = value.encode('utf_8', 'backslashreplace')
          type_role_property_dict[property_id] = value
2982
      # multi
2983 2984 2985 2986 2987 2988 2989 2990
      multi_property_list = role.findall('multi_property')
      for property_node in multi_property_list:
        property_id = property_node.get('id')
        if property_node.text:
          value = property_node.text
          if isinstance(value, unicode):
            value = value.encode('utf_8', 'backslashreplace')
          type_role_property_dict.setdefault(property_id, []).append(value)
2991
      type_roles_list.append(type_role_property_dict)
2992
    self._objects['portal_type_roles/%s' % (file_name[:-4],)] = type_roles_list
2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    p = context.getPortalObject()
    for roles_path in self._objects.keys():
      if update_dict.has_key(roles_path) or force:
        if not force:
          action = update_dict[roles_path]
          if action == 'nothing':
            continue
3004 3005 3006
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
3007
          # reset roles before applying
3008
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
3009
          type_roles_list = self._objects[roles_path] or []
3010 3011
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
3012 3013 3014
        else:
          raise AttributeError("Path '%r' not found while "
                               "installing roles" % (path, ))
3015 3016 3017

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
3018 3019 3020 3021 3022 3023
    object_path = kw.get('object_path', None)
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
3024
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
3025 3026 3027 3028 3029
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
3030

3031 3032 3033 3034 3035 3036
class SitePropertyTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
3037 3038
      for property in p.propertyMap():
        if property['id'] == id:
3039
          obj = p.getProperty(id)
3040
          prop_type = property['type']
3041 3042
          break
      else:
3043
        obj = None
3044
      if obj is None and not self.is_bt_for_diff:
3045
        raise NotFound, 'the property %s is not found' % id
3046
      self._objects[id] = (prop_type, obj)
Aurel's avatar
Aurel committed
3047

3048 3049
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
3050
    if not file_name.endswith('.xml'):
3051
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3052
      return
3053
    xml = parse(file)
3054 3055 3056 3057 3058 3059 3060 3061 3062
    property_node = xml.getroot()[0]
    property_id = property_node.find('id').text
    prop_type = property_node.find('type').text
    value_node = property_node.find('value')
    if prop_type in ('lines', 'tokens'):
      value = [item.text for item in value_node.findall('item')]
    else:
      value = value_node.text
    self._objects[property_id] = (prop_type, value)
3063

3064 3065 3066
  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3067
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3068 3069
      p = context.getPortalObject()
      for path in self._objects.keys():
3070 3071 3072 3073
        if update_dict.has_key(path) or force:
          if not force:
            action = update_dict[path]
            if action == 'nothing':
3074
              continue
3075
          dir, id = posixpath.split(path)
3076
          prop_type, property = self._objects[path]
3077 3078 3079 3080 3081 3082 3083 3084
          if p.hasProperty(id):
            if p.getPropertyType(id) != prop_type:
              p._delProperty(id)
              p._setProperty(id, property, type=prop_type)
            else:
              p._updateProperty(id, property)
          else:
            p._setProperty(id, property, type=prop_type)
Aurel's avatar
Aurel committed
3085
    else:
3086
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
3087
      p = context.getPortalObject()
3088
      for id, property in self._archive.keys():
3089
        property = self._archive[id]
Aurel's avatar
Aurel committed
3090
        if p.hasProperty(id):
3091 3092 3093 3094 3095 3096 3097
          if p.getPropertyType(id) != property['type']:
            p._delProperty(id)
            p._setProperty(id, property['value'], type=property['type'])
          else:
            p._updateProperty(id, property['value'])
        else:
          p._setProperty(id, property['value'], type=property['type'])
3098 3099 3100

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3101 3102 3103 3104 3105 3106
    object_path = kw.get('object_path', None)
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._archive.keys()
    for id in keys:
3107 3108 3109 3110
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3111
  # Function to generate XML Code Manually
3112
  def generateXml(self, path=None):
3113
    xml_data = ''
3114
    prop_type, obj = self._objects[path]
3115
    xml_data += '\n <property>'
3116 3117
    xml_data += '\n  <id>%s</id>' % escape(str(path))
    xml_data += '\n  <type>%s</type>' % escape(str(prop_type))
3118
    if prop_type in ('lines', 'tokens'):
3119
      xml_data += '\n  <value>'
3120
      for item in obj:
3121
        if item != '':
3122
          xml_data += '\n   <item>%s</item>' % escape(str(item))
3123
      xml_data += '\n  </value>'
3124
    else:
3125
      xml_data += '\n  <value>%s</value>' % escape(str(obj))
3126
    xml_data += '\n </property>'
3127 3128
    return xml_data

Aurel's avatar
Aurel committed
3129 3130 3131 3132 3133
  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)
3134 3135 3136 3137
    xml_data = '<site_property>'
    keys = self._objects.keys()
    keys.sort()
    for path in keys:
3138
      xml_data += self.generateXml(path)
3139
    xml_data += '\n</site_property>'
3140
    bta.addObject(obj=xml_data, name='properties', path=root_path)
3141

3142 3143 3144 3145 3146
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3147 3148 3149 3150 3151 3152
    for module_id in self._archive.keys():
      module = p.unrestrictedTraverse(module_id)
      mapping = {}
      mapping['id'] = module.getId()
      mapping['title'] = module.getTitle()
      mapping['portal_type'] = module.getPortalType()
3153
      permission_list = []
3154
      mapping['permission_list'] = module.showPermissions()
3155
      mapping['category_list'] = module.getCategoryList()
3156
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3157

Christophe Dumez's avatar
Christophe Dumez committed
3158
  # Function to generate XML Code Manually
3159
  def generateXml(self, path=None):
3160
    mapping = self._objects[path]
3161
    xml_data = ['<module>']
3162
    keys = mapping.keys()
3163 3164
    for key in sorted(keys):
      if key == 'permission_list':
3165
        # separe permission dict into xml
3166
        xml_data.append(' <%s>' % (key, ))
3167
        permission_list = mapping[key]
3168
        for perm in permission_list:
3169
          # the type of the permission defined if we use acquired or not
3170
          if isinstance(perm[1], list):
3171 3172 3173
            ptype = "list"
          else:
            ptype = "tuple"
Aurel's avatar
Aurel committed
3174
          role_list = list(perm[1])
3175 3176 3177
          # Skip if permission is not configured (i.e. no role at all
          # with acquire permission, or Manager only without acquire
          # permission).
3178
          if (len(role_list) == 0 and ptype == 'list') or \
3179 3180
                 (role_list == ['Manager'] and ptype == 'tuple'):
            continue
3181
          role_list.sort()
3182 3183
          xml_data.append("  <permission type='%s'>" % (ptype, ))
          xml_data.append('   <name>%s</name>' % (perm[0], ))
3184
          for role in role_list:
3185 3186 3187
            xml_data.append('   <role>%s</role>' % (role, ))
          xml_data.append('  </permission>')
        xml_data.append(' </%s>' % (key, ))
3188 3189 3190 3191 3192 3193 3194 3195
      elif key == 'category_list':
        category_list = mapping[key]
        if not category_list:
          continue
        xml_data.append(' <%s>' % (key, ))
        for category in category_list:
          xml_data.append('  <category>%s</category>' % (category, ))
        xml_data.append(' </%s>' % (key, ))
3196
      else:
3197
        xml_data.append(' <%s>%s</%s>' % (key, mapping[key], key))
3198 3199
    xml_data.append('</module>')
    return '\n'.join(xml_data)
3200

3201
  def export(self, context, bta, **kw):
3202
    if len(self._objects) == 0:
3203 3204 3205
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(path)
3206 3207
    keys = self._objects.keys()
    keys.sort()
3208
    for key in keys:
Jérome Perrin's avatar
typo  
Jérome Perrin committed
3209
      # export modules one by one
3210 3211
      xml_data = self.generateXml(path=key)
      bta.addObject(obj=xml_data, name=key, path=path)
3212

3213
  def install(self, context, trashbin, **kw):
3214
    portal = context.getPortalObject()
3215 3216
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3217
    if context.getTemplateFormatVersion() == 1:
3218
      items = self._objects
3219
    else:
3220 3221
      items = self._archive

3222 3223
    valid_permissions = dict.fromkeys([x[0] for x in
                                       context.ac_inherited_permissions(all=1)])
3224 3225
    for path, mapping in items.iteritems():
      if update_dict.has_key(path) or force:
3226
        if not force:
3227
          action = update_dict[path]
3228 3229
          if action == 'nothing':
            continue
3230 3231
        path, module_id = posixpath.split(path)
        portal_type = str(mapping['portal_type'])
3232
        module = portal._getOb(module_id, None)
3233 3234
        if module is not None:
          module.portal_type = portal_type
3235
        else:
3236
          module = portal.newContent(id=module_id, portal_type=portal_type)
3237
        module.setTitle(str(mapping['title']))
3238 3239
        permission_dict = dict(mapping['permission_list'])
        for name in valid_permissions.iterkeys():
3240
          # By default, Manager only without acquire permission
3241 3242
          role_list = permission_dict.get(name, ('Manager',))
          acquire = isinstance(role_list, list)
3243
          module.manage_permission(name, roles=role_list, acquire=acquire)
3244 3245
        if 'category_list' in mapping:
          module.setCategoryList(mapping['category_list'])
3246 3247

  def _importFile(self, file_name, file):
3248 3249 3250
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3251
    mapping = {}
3252
    xml = parse(file)
3253
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3254
      key_node = xml.find(key)
3255
      if key == 'permission_list':
3256 3257 3258 3259 3260 3261 3262
        permission_list = []
        for permission in key_node:
          permission_type = permission.get('type', None)
          name = permission.find('name').text
          role_list = [role.text for role in permission.findall('role')]
          if permission_type in ('list', None):
            perm_tuple = (name, list(role_list))
3263
          else:
3264 3265 3266
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3267
      else:
3268
        mapping[key] = key_node.text or ''
3269 3270

    category_list = []
3271 3272 3273 3274
    category_list_node = xml.find('category_list')
    if category_list_node is not None:
      category_list.extend(node.text for node\
                            in category_list_node.findall('category'))
3275 3276
    mapping['category_list'] = category_list

3277
    self._objects[file_name[:-4]] = mapping
3278

3279
  def uninstall(self, context, **kw):
Aurel's avatar
Aurel committed
3280 3281 3282
    trash = kw.get('trash', 0)
    if trash:
      return
3283 3284 3285 3286 3287 3288
    object_path = kw.get('object_path', None)
    trashbin = kw.get('trashbin', None)
    if object_path is None:
      keys = self._archive.keys()
    else:
      keys = [object_path]
3289 3290
    p = context.getPortalObject()
    id_list = p.objectIds()
3291 3292
    for key in keys:
      if key in id_list:
3293
        try:
3294
          if trash and trashbin is not None:
3295
            container_path = key.split('/')
3296 3297
            self.portal_trash.backupObject(trashbin, container_path, 
                                           key, save=1, keep_subobjects=1)
3298
          p.manage_delObjects([key])
3299
        except NotFound:
3300
          pass
3301 3302
    BaseTemplateItem.uninstall(self, context, **kw)

3303 3304 3305
  def trash(self, context, new_item, **kw):
    # Do not remove any module for safety.
    pass
3306 3307

class DocumentTemplateItem(BaseTemplateItem):
3308 3309 3310 3311
  local_file_reader_name = staticmethod(readLocalDocument)
  local_file_writer_name = staticmethod(writeLocalDocument)
  local_file_importer_name = staticmethod(importLocalDocument)
  local_file_remover_name = staticmethod(removeLocalDocument)
3312 3313 3314

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
3315 3316
    for key in self._archive.iterkeys():
      self._objects[key] = self.local_file_reader_name(key)
Aurel's avatar
Aurel committed
3317

3318
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3319 3320
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3321
      new_keys = self._objects.keys()
3322
      # fix key if necessary in installed bt for diff
3323
      extra_prefix = self.__class__.__name__ + '/'
3324
      for key in installed_item._objects.keys():
3325 3326 3327 3328
        if key.startswith(extra_prefix):
          new_key = key[len(extra_prefix):]
          installed_item._objects[new_key] = installed_item._objects[key]
          del installed_item._objects[key]
3329
      for path in new_keys:
3330
        if installed_item._objects.has_key(path):
3331 3332
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3333
          old_obj_code = installed_item._objects[path]
3334
          if new_obj_code != old_obj_code:
3335 3336
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3337
        else: # new object
3338 3339
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3340
          # get removed object
3341
      old_keys = installed_item._objects.keys()
3342 3343
      for path in old_keys:
        if path not in new_keys:
3344 3345
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3346 3347 3348 3349 3350
    return modified_object_list

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3351
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3352
      for id in self._objects.keys():
3353 3354 3355 3356 3357 3358
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
3359
          path, name = posixpath.split(id)
3360 3361
          # This raises an exception if the file already exists.
          try:
3362
            self.local_file_writer_name(name, text, create=0)
3363
          except IOError, error:
3364
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
3365
            if error.errno:
3366
              raise
3367 3368
            continue
          if self.local_file_importer_name is not None:
3369
            self.local_file_importer_name(name)
3370 3371 3372 3373 3374 3375 3376 3377 3378 3379
            # after any import, flush all ZODB caches to force a DB reload
            # otherwise we could have objects trying to get commited while
            # holding reference to a class that is no longer the same one as
            # the class in its import location and pickle doesn't tolerate it.
            # First we do a savepoint to dump dirty objects to temporary
            # storage, so that all references to them can be freed.
            transaction.savepoint(optimistic=True)
            # Then we need to flush from all caches, not only the one from this
            # connection
            self.getPortalObject()._p_jar.db().cacheMinimize()
Aurel's avatar
Aurel committed
3380
    else:
3381 3382 3383
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3384
        # This raises an exception if the file exists.
3385
        self.local_file_writer_name(id, text, create=1)
Aurel's avatar
Aurel committed
3386
        if self.local_file_importer_name is not None:
3387
          self.local_file_importer_name(id)
3388 3389

  def uninstall(self, context, **kw):
3390
    object_path = kw.get('object_path', None)
3391 3392 3393 3394
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
3395 3396
    for key in object_keys:
      self.local_file_remover_name(key)
3397 3398
    BaseTemplateItem.uninstall(self, context, **kw)

Aurel's avatar
Aurel committed
3399 3400 3401 3402 3403
  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)
3404 3405 3406 3407 3408 3409 3410
    extra_prefix = self.__class__.__name__ + '/'
    for key in self._objects.keys():
      obj = self._objects[key]
      # BBB the prefix was put into each key in the previous implementation.
      if not key.startswith(extra_prefix):
        key = extra_prefix + key
      bta.addObject(obj=obj, name=key, ext='.py')
Aurel's avatar
Aurel committed
3411

3412
  def _importFile(self, file_name, file):
3413 3414 3415
    if not file_name.endswith('.py'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3416
    text = file.read()
3417
    self._objects[file_name[:-3]] = text
3418

3419
class PropertySheetTemplateItem(DocumentTemplateItem):
3420 3421 3422 3423
  local_file_reader_name = staticmethod(readLocalPropertySheet)
  local_file_writer_name = staticmethod(writeLocalPropertySheet)
  local_file_importer_name = staticmethod(importLocalPropertySheet)
  local_file_remover_name = staticmethod(removeLocalPropertySheet)
3424

3425
class ConstraintTemplateItem(DocumentTemplateItem):
3426 3427 3428 3429
  local_file_reader_name = staticmethod(readLocalConstraint)
  local_file_writer_name = staticmethod(writeLocalConstraint)
  local_file_importer_name = staticmethod(importLocalConstraint)
  local_file_remover_name = staticmethod(removeLocalConstraint)
3430

3431
class ExtensionTemplateItem(DocumentTemplateItem):
3432 3433
  local_file_reader_name = staticmethod(readLocalExtension)
  local_file_writer_name = staticmethod(writeLocalExtension)
3434 3435
  # Extension needs no import
  local_file_importer_name = None
3436
  local_file_remover_name = staticmethod(removeLocalExtension)
3437 3438

class TestTemplateItem(DocumentTemplateItem):
3439 3440
  local_file_reader_name = staticmethod(readLocalTest)
  local_file_writer_name = staticmethod(writeLocalTest)
3441
  # Test needs no import
3442
  local_file_importer_name = None
3443
  local_file_remover_name = staticmethod(removeLocalTest)
3444

Aurel's avatar
Aurel committed
3445

3446 3447 3448
class ProductTemplateItem(BaseTemplateItem):
  # XXX Not implemented yet
  pass
3449 3450 3451

class RoleTemplateItem(BaseTemplateItem):

Aurel's avatar
Aurel committed
3452
  def build(self, context, **kw):
3453 3454
    for key in self._archive.iterkeys():
      self._objects[key] = 1
Aurel's avatar
Aurel committed
3455

3456
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3457 3458
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3459
      new_roles = self._objects.keys()
3460 3461 3462 3463 3464 3465
      # BBB it might be necessary to change the data structure.
      obsolete_key = self.__class__.__name__ + '/role_list'
      if obsolete_key in installed_item._objects:
        for role in installed_item._objects[obsolete_key]:
          installed_item._objects[role] = 1
        del installed_item._objects[obsolete_key]
3466
      for role in new_roles:
3467
        if installed_item._objects.has_key(role):
3468 3469 3470 3471
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
3472
      old_roles = installed_item._objects.keys()
3473 3474 3475 3476 3477 3478
      for role in old_roles:
        if role not in new_roles:
          modified_object_list.update({role : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

  def install(self, context, trashbin, **kw):
3479
    p = context.getPortalObject()
3480
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3481
    if context.getTemplateFormatVersion() == 1:
3482
      role_set = set(self._objects)
3483
    else:
3484
      role_set = set(self._archive)
3485 3486 3487 3488
    # set roles in PAS
    if p.acl_users.meta_type == 'Pluggable Auth Service':
      role_manager_list = p.acl_users.objectValues('ZODB Role Manager')
      for role_manager in role_manager_list:
3489 3490
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
3491
    # set roles on portal
3492
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
3493 3494

  def _importFile(self, file_name, file):
3495
    if not file_name.endswith('.xml'):
3496
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3497
      return
3498
    xml = parse(file)
3499 3500 3501
    for role in xml.getroot():
      value = role.text
      self._objects[value] = 1
3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513

  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)

3514 3515 3516 3517 3518 3519 3520 3521 3522
  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
3523
      if role in roles and role not in new_roles:
3524 3525 3526
        del roles[role]
    p.__ac_roles__ = tuple(roles.keys())

Christophe Dumez's avatar
Christophe Dumez committed
3527
  # Function to generate XML Code Manually
3528 3529
  def generateXml(self):
    role_list = self._objects.keys()
3530
    xml_data = '<role_list>'
3531 3532
    for role in sorted(role_list):
      xml_data += '\n <role>%s</role>' % (role,)
3533
    xml_data += '\n</role_list>'
3534 3535
    return xml_data

Aurel's avatar
Aurel committed
3536
  def export(self, context, bta, **kw):
3537
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
3538 3539 3540
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
3541 3542 3543 3544 3545 3546 3547 3548 3549
    # BBB it might be necessary to change the data structure.
    obsolete_key = self.__class__.__name__ + '/role_list'
    if obsolete_key in self._objects:
      for role in self._objects[obsolete_key]:
        self._objects[role] = 1
      del self._objects[obsolete_key]
    xml_data = self.generateXml()
    path = obsolete_key
    bta.addObject(obj=xml_data, name=path)
3550

3551 3552 3553 3554
class CatalogSearchKeyTemplateItem(BaseTemplateItem):
  key_list_attr = 'sql_catalog_search_keys'
  key_list_title = 'search_key_list'
  key_title = 'Search key'
3555

Aurel's avatar
Aurel committed
3556
  def build(self, context, **kw):
3557
    catalog = _getCatalogValue(self)
3558 3559 3560
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3561
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
3562
    key_list = []
3563
    for key in self._archive.keys():
3564
      if key in catalog_key_list:
3565
        key_list.append(key)
3566
      elif not self.is_bt_for_diff:
3567
        raise NotFound, '%s %r not found in catalog' %(self.key_title, key)
3568
    if len(key_list) > 0:
3569
      self._objects['%s/%s' % (self.__class__.__name__, self.key_list_title)] = key_list
3570 3571

  def _importFile(self, file_name, file):
3572 3573 3574
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3575
    xml = parse(file)
3576 3577
    key_list = [key.text for key in xml.getroot()]
    self._objects[file_name[:-4]] = key_list
3578

3579
  def install(self, context, trashbin, **kw):
3580
    catalog = _getCatalogValue(self)
3581 3582 3583
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3584

3585
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3586
    if context.getTemplateFormatVersion() == 1:
3587 3588
      if len(self._objects.keys()) == 0: # needed because of pop()
        return
3589 3590 3591
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3592
    else:
3593
      keys = self._archive.keys()
3594 3595
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
3596
    # XXX same as related key
3597
    if update_dict.has_key(self.key_list_title) or force:
3598
      if not force:
3599
        action = update_dict[self.key_list_title]
3600
        if action == 'nothing':
Aurel's avatar
Aurel committed
3601
          return
3602
      for key in keys:
3603 3604 3605
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
3606

3607
  def uninstall(self, context, **kw):
3608
    catalog = _getCatalogValue(self)
3609 3610 3611
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3612
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
3613
    object_path = kw.get('object_path', None)
3614 3615 3616 3617 3618
    if object_path is not None:
      object_keys = [object_path]
    else:
      object_keys = self._archive.keys()
    for key in object_keys:
3619 3620 3621
      if key in catalog_key_list:
        catalog_key_list.remove(key)
    setattr(catalog, self.key_list_attr, catalog_key_list)
3622 3623
    BaseTemplateItem.uninstall(self, context, **kw)

Christophe Dumez's avatar
Christophe Dumez committed
3624
  # Function to generate XML Code Manually
3625
  def generateXml(self, path=None):
3626
    obj = self._objects[path]
3627
    xml_data = '<key_list>'
3628 3629
    obj.sort()
    for key in obj:
3630 3631
      xml_data += '\n <key>%s</key>' %(key)
    xml_data += '\n</key_list>'
3632 3633
    return xml_data

Aurel's avatar
Aurel committed
3634 3635 3636 3637 3638
  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)
3639
    for path in self._objects.keys():
3640
      xml_data = self.generateXml(path=path)
3641
      bta.addObject(obj=xml_data, name=path, path=None)
3642

3643 3644 3645 3646
class CatalogResultKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_result_keys'
  key_list_title = 'result_key_list'
  key_title = 'Result key'
3647

3648 3649 3650 3651
class CatalogRelatedKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_related_keys'
  key_list_title = 'related_key_list'
  key_title = 'Related key'
3652

3653
  # override this method to support 'key_list' for backward compatibility.
3654
  def install(self, context, trashbin, **kw):
3655
    catalog = _getCatalogValue(self)
3656 3657 3658
    if catalog is None:
      LOG('BusinessTemplate', 0, 'no SQL catalog was available')
      return
3659

3660
    catalog_key_list = list(getattr(catalog, self.key_list_attr, []))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3661
    if context.getTemplateFormatVersion() == 1:
3662
      if len(self._objects.keys()) == 0: # needed because of pop()
Aurel's avatar
Aurel committed
3663
        return
3664 3665 3666
      keys = []
      for k in self._objects.values().pop(): # because of list of list
        keys.append(k)
Aurel's avatar
Aurel committed
3667
    else:
3668
      keys = self._archive.keys()
3669 3670
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Aurel's avatar
Aurel committed
3671
    # XXX must a find a better way to manage related key
3672
    if update_dict.has_key(self.key_list_title) or update_dict.has_key('key_list') or force:
Aurel's avatar
Aurel committed
3673
      if not force:
3674 3675
        if update_dict.has_key(self.key_list_title):
          action = update_dict[self.key_list_title]
Aurel's avatar
Aurel committed
3676 3677
        else: # XXX for backward compatibility
          action = update_dict['key_list']
Aurel's avatar
Aurel committed
3678 3679 3680
        if action == 'nothing':
          return
      for key in keys:
3681 3682 3683
        if key not in catalog_key_list:
          catalog_key_list.append(key)
      setattr(catalog, self.key_list_attr, catalog_key_list)
3684

3685 3686 3687 3688
class CatalogResultTableTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_search_tables'
  key_list_title = 'result_table_list'
  key_title = 'Result table'
3689

3690
# keyword
3691 3692 3693 3694
class CatalogKeywordKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_keyword_search_keys'
  key_list_title = 'keyword_key_list'
  key_title = 'Keyword key'
3695

3696
# datetime
3697 3698 3699 3700
class CatalogDateTimeKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_datetime_search_keys'
  key_list_title = 'datetime_key_list'
  key_title = 'DateTime key'
3701

3702 3703 3704 3705 3706
# full text
class CatalogFullTextKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_full_text_search_keys'
  key_list_title = 'full_text_key_list'
  key_title = 'Fulltext key'
3707

3708 3709 3710 3711 3712
# request
class CatalogRequestKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_request_keys'
  key_list_title = 'request_key_list'
  key_title = 'Request key'
3713

3714 3715 3716 3717 3718
# multivalue
class CatalogMultivalueKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_multivalue_keys'
  key_list_title = 'multivalue_key_list'
  key_title = 'Multivalue key'
3719 3720

# topic
3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739
class CatalogTopicKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_topic_search_keys'
  key_list_title = 'topic_key_list'
  key_title = 'Topic key'

class CatalogScriptableKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_scriptable_keys'
  key_list_title = 'scriptable_key_list'
  key_title = 'Scriptable key'

class CatalogRoleKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_role_keys'
  key_list_title = 'role_key_list'
  key_title = 'Role key'

class CatalogLocalRoleKeyTemplateItem(CatalogSearchKeyTemplateItem):
  key_list_attr = 'sql_catalog_local_role_keys'
  key_list_title = 'local_role_key_list'
  key_title = 'LocalRole key'
3740

3741 3742 3743 3744
class MessageTranslationTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    localizer = context.getPortalObject().Localizer
3745 3746 3747
    for lang_key in self._archive.keys():
      if '|' in lang_key:
        lang, catalog = lang_key.split(' | ')
3748
      else: # XXX backward compatibility
3749 3750
        lang = lang_key
        catalog = 'erp5_ui'
3751
      path = posixpath.join(lang, catalog)
3752 3753
      mc = localizer._getOb(catalog)
      self._objects[path] = mc.manage_export(lang)
3754 3755 3756
      if lang not in self._objects:
        name = localizer.get_language_name(lang)
        self._objects[lang] = name
3757

3758
  def preinstall(self, context, installed_item, **kw):
3759 3760 3761 3762
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
3763
        if installed_item._objects.has_key(path):
3764 3765
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3766
          old_obj_code = installed_item._objects[path]
3767 3768 3769 3770 3771
          if new_obj_code != old_obj_code:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
      # get removed object
3772
      old_keys = installed_item._objects.keys()
3773 3774 3775 3776 3777
      for path in old_keys:
        if path not in new_keys:
          modified_object_list.update({path : ['Removed', self.__class__.__name__[:-12]]})
    return modified_object_list

3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805
  def _splitKey(self,key):
    path = key.split('/')
    if len(path) == 1:
      lang = path[0]
      catalog = None
    elif len(path) == 2:
      lang = path[0]
      catalog = path[1]
    else:
      lang = path[-3]
      catalog = path[-2]
    return lang, catalog

  def _importCatalogLanguage(self, localizer, catalog, lang, po):
    if catalog not in localizer.objectIds():
      dispatcher = localizer.manage_addProduct['Localizer']
      dispatcher.manage_addMessageCatalog(id=catalog, 
                                          title='Message Catalog',
                                          languages=['en'])
    mc = localizer._getOb(catalog)
    if lang not in mc.get_languages():
      mc.manage_addLanguage(lang)
    mc.manage_import(lang, po)

  def install(self, context, trashbin, localizer=None, **kw):
    if localizer is None:
      localizer = context.getPortalObject().Localizer
    update_dict = kw.get('object_to_update', {})
3806 3807
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
3808 3809
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
3810
          if not force:
3811
            action = update_dict[key]
3812
            if action == 'nothing':
3813
              continue
3814
          lang, catalog = self._splitKey(key)
3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830

          if catalog is None:
            name = self._objects[key]
            for lang_dict in localizer.get_all_languages():
              if lang_dict['code'] == lang:
                # When the Localizer has the language as a user-defined
                # language, make sure that the name is updated.
                old_name = localizer.get_user_defined_language_name(lang)
                if old_name is not None and old_name != name:
                  localizer._del_user_defined_language(lang)
                  localizer._add_user_defined_language(name, lang)
                break
            else:
              # if the Localizer does not know the language code, it must be
              # defined as a user-defined language.
              localizer._add_user_defined_language(name, lang)
3831 3832
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
3833 3834 3835 3836
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
3837
            self._importCatalogLanguage(localizer, catalog, lang, po)
3838 3839
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
3840
      for lang, catalogs in self._archive.iteritems():
3841 3842 3843
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873
          self._importCatalogLanguage(catalog, lang, po)

  def uninstall(self, context, remove_translations=False, **kw):
    if not remove_translations:
      return
    portal = context.getPortalObject()
    localizer = portal.Localizer
    from Products.Localizer.Localizer import Localizer
    fake_localizer = Localizer('Fake Localizer',
                               languages=['en']).__of__(portal)
    # roundabout way of keeping BW compatibility, allow install() to do the
    # heavy lifting so we can extract the original catalogs and messages:
    self.install(context, None, localizer=fake_localizer, force=True, **kw)
    # now scan the actual message_catalog to remove messages present in the
    # fake one.
    for fake_message_catalog in fake_localizer.objectValues():
      message_catalog = localizer._getOb(fake_message_catalog.getId())
      # get list of messages present in both the fake and the real catalog
      # UGH! direct attribute access... but there is no real API to access
      # all messages here.
      messages = set(fake_message_catalog._messages.keys())
      messages.intersection_update(message_catalog._messages.keys())
      for message in messages:
        # delete translations from the real catalog that are present in the
        # fake one
        fake_translations = fake_message_catalog.get_translations(message)
        translations = message_catalog.get_translations(message)
        for lang in fake_translations.keys():
          # XXX: should we check they're still the same before removing?
          translations.pop(lang, None)
3874 3875

  def export(self, context, bta, **kw):
3876
    if len(self._objects) == 0:
3877 3878 3879
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
3880
    for key, obj in self._objects.iteritems():
3881 3882
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
3883 3884 3885 3886 3887 3888 3889 3890
      if '/' in key:
        bta.addObject(obj, os.path.join(path, 'translation'), ext='.po')
      else:
        xml_data = ['<language>']
        xml_data.append(' <code>%s</code>' % (escape(key), ))
        xml_data.append(' <name>%s</name>' % (escape(obj), ))
        xml_data.append('</language>')
        bta.addObject('\n'.join(xml_data), os.path.join(path, 'language'))
3891 3892

  def _importFile(self, file_name, file):
3893 3894
    name = posixpath.split(file_name)[1]
    if name == 'translation.po':
3895 3896
      text = file.read()
      self._objects[file_name[:-3]] = text
3897 3898
    elif name == 'language.xml':
      xml = parse(file)
3899 3900
      name = xml.find('name').text
      code = xml.find('code').text
3901
      self._objects[code] = name
3902

Aurel's avatar
Aurel committed
3903 3904
class LocalRolesTemplateItem(BaseTemplateItem):

3905
  def __init__(self, id_list, **kw):
3906
    id_list = ['local_roles/%s' % id for id in id_list if id != '']
3907 3908
    BaseTemplateItem.__init__(self, id_list, **kw)

Aurel's avatar
Aurel committed
3909 3910 3911
  def build(self, context, **kw):
    p = context.getPortalObject()
    for path in self._archive.keys():
3912
      obj = p.unrestrictedTraverse(path.split('/', 1)[1])
3913 3914
      local_roles_dict = getattr(obj, '__ac_local_roles__',
                                        {}) or {}
3915
      self._objects[path] = (local_roles_dict, )
Aurel's avatar
Aurel committed
3916

Christophe Dumez's avatar
Christophe Dumez committed
3917
  # Function to generate XML Code Manually
Aurel's avatar
Aurel committed
3918
  def generateXml(self, path=None):
3919
    local_roles_dict = self._objects[path][0]
Aurel's avatar
Aurel committed
3920 3921
    # local roles
    xml_data = '<local_roles_item>'
3922
    xml_data += '\n <local_roles>'
3923
    for key in sorted(local_roles_dict):
3924
      xml_data += "\n  <role id='%s'>" %(key,)
Aurel's avatar
Aurel committed
3925 3926
      tuple = local_roles_dict[key]
      for item in tuple:
3927 3928 3929 3930
        xml_data += "\n   <item>%s</item>" %(item,)
      xml_data += '\n  </role>'
    xml_data += '\n </local_roles>'
    xml_data += '\n</local_roles_item>'
Aurel's avatar
Aurel committed
3931
    return xml_data
3932

Aurel's avatar
Aurel committed
3933 3934 3935 3936 3937 3938 3939 3940
  def export(self, context, bta, **kw):
    if len(self._objects.keys()) == 0:
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    for key in self._objects.keys():
      xml_data = self.generateXml(key)

3941
      folders, id = posixpath.split(key)
Aurel's avatar
Aurel committed
3942
      encode_folders = []
3943
      for folder in folders.split('/')[1:]:
Aurel's avatar
Aurel committed
3944
        if '%' not in folder:
3945
          encode_folders.append(quote(folder))
Aurel's avatar
Aurel committed
3946 3947
        else:
          encode_folders.append(folder)
3948
      path = os.path.join(root_path, (os.sep).join(encode_folders))
Aurel's avatar
Aurel committed
3949 3950 3951 3952
      bta.addFolder(name=path)
      bta.addObject(obj=xml_data, name=id, path=path)

  def _importFile(self, file_name, file):
3953 3954 3955
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
Aurel's avatar
Aurel committed
3956 3957
    xml = parse(file)
    # local roles
3958
    local_roles_list = xml.findall('//role')
Aurel's avatar
Aurel committed
3959 3960
    local_roles_dict = {}
    for role in local_roles_list:
3961 3962
      id = role.get('id')
      item_type_list = [item.text for item in role]
Aurel's avatar
Aurel committed
3963
      local_roles_dict[id] = item_type_list
3964
    self._objects['local_roles/%s' % (file_name[:-4],)] = (local_roles_dict, )
Aurel's avatar
Aurel committed
3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975

  def install(self, context, trashbin, **kw):
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
    p = context.getPortalObject()
    for roles_path in self._objects.keys():
      if update_dict.has_key(roles_path) or force:
        if not force:
          action = update_dict[roles_path]
          if action == 'nothing':
            continue
3976 3977
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
3978
        local_roles_dict = self._objects[roles_path][0]
3979
        setattr(obj, '__ac_local_roles__', local_roles_dict)
3980
        obj.reindexObject()
Aurel's avatar
Aurel committed
3981

3982
  def uninstall(self, context, object_path=None, **kw):
Aurel's avatar
Aurel committed
3983
    p = context.getPortalObject()
3984 3985 3986 3987 3988
    if object_path is not None:
      keys = [object_path]
    else:
      keys = self._objects.keys()
    for roles_path in keys:
Aurel's avatar
Aurel committed
3989 3990 3991
      path = roles_path.split('/')[1:]
      obj = p.unrestrictedTraverse(path)
      setattr(obj, '__ac_local_roles__', {})
3992
      obj.reindexObject()
3993

3994 3995 3996
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
3997
    in part or completely. Each object is separated from its
3998 3999 4000 4001 4002 4003 4004 4005 4006 4007
    subobjects and exported in xml format.
    It may include:

    - catalog definition
      - SQL method objects
      - SQL methods including:
        - purpose (catalog, uncatalog, etc.)
        - filter definition

    - portal_types definition
Christophe Dumez's avatar
Christophe Dumez committed
4008 4009
      - object without optimal actions
      - list of relation between portal type and workflow
4010 4011 4012 4013 4014 4015 4016 4017 4018 4019

    - module definition
      - id
      - title
      - portal type
      - roles/security

    - site property definition
      - id
      - type
4020
      - value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4021

4022 4023
    - document/propertysheet/extension/test definition
      - copy of the local file
4024

4025
    - message transalation definition
4026
      - .po file
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4027

4028 4029
    The Business Template properties are exported to the bt folder with
    one property per file
4030

Jean-Paul Smets's avatar
Jean-Paul Smets committed
4031 4032
    Technology:

4033 4034
    - 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
4035

4036
    - install files to the right location (install)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4037 4038 4039 4040

    Use case:

    - install core ERP5 (the minimum)
4041

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

4044 4045
    - go to "BT" menu. Create new BT.
      Define BT elements (workflow, methods, attributes, etc.).
4046
      Build BT and export or save it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4047 4048 4049 4050 4051
      Done.
    """

    meta_type = 'ERP5 Business Template'
    portal_type = 'Business Template'
4052
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4053 4054 4055

    # Declarative security
    security = ClassSecurityInfo()
4056
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4057 4058 4059 4060

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
4061
                      , PropertySheet.SimpleItem
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4062
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4063
                      , PropertySheet.Version
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4064
                      , PropertySheet.BusinessTemplate
4065
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4066 4067
                      )

4068 4069 4070 4071 4072 4073
    # 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."""
4074
         , 'icon'           : 'file_icon.gif'
4075 4076 4077 4078 4079 4080 4081 4082 4083
         , 'product'        : 'ERP5Type'
         , 'factory'        : 'addBusinessTemplate'
         , 'immediate_view' : 'BusinessTemplate_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': (
                                      )
         , 'filter_content_types' : 1
      }

4084 4085
    # This is a global variable
    # Order is important for installation
4086 4087 4088 4089 4090 4091
    # We want to have:
    #  * path after module, because path can be module content
    #  * path after categories, because path can be categories content
    #  * skin after paths, because we can install a custom connection string as
    #       path and use it with SQLMethods in a skin.
    #    ( and more )
4092 4093
    _item_name_list = [
      '_product_item',
4094
      '_property_sheet_item',
4095
      '_constraint_item',
4096 4097 4098 4099
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4100
      '_tool_item',
4101 4102 4103 4104
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4105
      '_portal_type_workflow_chain_item',
4106 4107 4108 4109
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4110 4111
      '_category_item',
      '_module_item',
4112
      '_path_item',
4113
      '_skin_item',
4114
      '_registered_skin_selection_item',
4115
      '_preference_item',
4116
      '_action_item',
4117
      '_portal_type_roles_item',
4118
      '_local_roles_item',
4119
      '_catalog_method_item',
4120 4121 4122
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4123
      '_catalog_search_key_item',
4124
      '_catalog_keyword_key_item',
4125
      '_catalog_datetime_key_item',
4126 4127 4128 4129
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4130
      '_catalog_scriptable_key_item',
4131 4132
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4133 4134 4135 4136
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4137 4138 4139 4140 4141 4142
      self._clean()

    def getTemplateFormatVersion(self, **kw):
      """This is a workaround, because template_format_version was not set even for the new format.
      """
      if self.hasProperty('template_format_version'):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4143
        self._baseGetTemplateFormatVersion()
4144

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4145 4146 4147
      # the attribute _objects in BaseTemplateItem was added in the new format.
      if hasattr(self._path_item, '_objects'):
        return 1
4148

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4149
      return 0
4150

4151
    security.declareProtected(Permissions.ManagePortal, 'manage_afterAdd')
4152 4153 4154 4155 4156 4157 4158
    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".
4159 4160
        if portal_workflow.getStatusOf(
                'business_template_installation_workflow', self) is not None:
4161
          # XXX Not good to access the attribute directly,
4162 4163 4164
          # but there is no API for clearing the history.
          self.workflow_history[
                            'business_template_installation_workflow'] = None
4165

4166 4167
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRevision')
4168 4169 4170 4171 4172 4173
    def getRevision(self):
      """returns the revision property.
      This is a workaround for #461.
      """
      return self._baseGetRevision()

4174
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4175 4176 4177 4178 4179 4180 4181 4182
        """Increment bt revision number.
        """
        revision_number = self.getRevision()
        if revision_number is None or revision_number.strip() == '':
          revision_number = 1
        else:
          revision_number = int(revision_number)+1
        self.setRevision(revision_number)
4183

4184 4185
    security.declareProtected(Permissions.ManagePortal, 'storeTemplateItemData')
    def storeTemplateItemData(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4186
      """
4187
        Instanciate and Store Template items into properties.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4188
      """
4189
      # Store all Data
4190 4191
      self._portal_type_item = \
          PortalTypeTemplateItem(self.getTemplatePortalTypeIdList())
4192
      self._portal_type_workflow_chain_item = \
4193
          PortalTypeWorkflowChainTemplateItem(self.getTemplatePortalTypeWorkflowChainList())
4194 4195 4196 4197
      self._workflow_item = \
          WorkflowTemplateItem(self.getTemplateWorkflowIdList())
      self._skin_item = \
          SkinTemplateItem(self.getTemplateSkinIdList())
4198 4199 4200
      self._registered_skin_selection_item = \
          RegisteredSkinSelectionTemplateItem(
              self.getTemplateRegisteredSkinSelectionList())
4201 4202 4203 4204 4205 4206
      self._category_item = \
          CategoryTemplateItem(self.getTemplateBaseCategoryList())
      self._catalog_method_item = \
          CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList())
      self._action_item = \
          ActionTemplateItem(self.getTemplateActionPathList())
4207
      self._portal_type_roles_item = \
4208
          PortalTypeRolesTemplateItem(self.getTemplatePortalTypeRoleList())
4209 4210 4211 4212 4213 4214 4215 4216
      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())
4217 4218
      self._constraint_item = \
          ConstraintTemplateItem(self.getTemplateConstraintIdList())
4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238
      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())
4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250
      self._portal_type_allowed_content_type_item = \
           PortalTypeAllowedContentTypeTemplateItem(
               self.getTemplatePortalTypeAllowedContentTypeList())
      self._portal_type_hidden_content_type_item = \
           PortalTypeHiddenContentTypeTemplateItem(
               self.getTemplatePortalTypeHiddenContentTypeList())
      self._portal_type_property_sheet_item = \
           PortalTypePropertySheetTemplateItem(
               self.getTemplatePortalTypePropertySheetList())
      self._portal_type_base_category_item = \
           PortalTypeBaseCategoryTemplateItem(
               self.getTemplatePortalTypeBaseCategoryList())
4251 4252
      self._path_item = \
               PathTemplateItem(self.getTemplatePathList())
4253 4254
      self._preference_item = \
               PreferenceTemplateItem(self.getTemplatePreferenceList())
4255 4256 4257
      self._catalog_search_key_item = \
          CatalogSearchKeyTemplateItem(
               self.getTemplateCatalogSearchKeyList())
4258 4259
      self._catalog_keyword_key_item = \
          CatalogKeywordKeyTemplateItem(
4260
               self.getTemplateCatalogKeywordKeyList())
4261 4262 4263
      self._catalog_datetime_key_item = \
          CatalogDateTimeKeyTemplateItem(
               self.getTemplateCatalogDatetimeKeyList())
4264 4265
      self._catalog_full_text_key_item = \
          CatalogFullTextKeyTemplateItem(
4266
               self.getTemplateCatalogFullTextKeyList())
4267 4268
      self._catalog_request_key_item = \
          CatalogRequestKeyTemplateItem(
4269
               self.getTemplateCatalogRequestKeyList())
4270 4271
      self._catalog_multivalue_key_item = \
          CatalogMultivalueKeyTemplateItem(
4272
               self.getTemplateCatalogMultivalueKeyList())
4273 4274 4275
      self._catalog_topic_key_item = \
          CatalogTopicKeyTemplateItem(
               self.getTemplateCatalogTopicKeyList())
Aurel's avatar
Aurel committed
4276 4277
      self._local_roles_item = \
          LocalRolesTemplateItem(
4278
               self.getTemplateLocalRoleList())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4279 4280 4281
      self._tool_item = \
          ToolTemplateItem(
               self.getTemplateToolIdList())
4282 4283 4284
      self._catalog_scriptable_key_item = \
          CatalogScriptableKeyTemplateItem(
               self.getTemplateCatalogScriptableKeyList())
4285 4286 4287 4288 4289 4290
      self._catalog_role_key_item = \
          CatalogRoleKeyTemplateItem(
               self.getTemplateCatalogRoleKeyList())
      self._catalog_local_role_key_item = \
          CatalogLocalRoleKeyTemplateItem(
               self.getTemplateCatalogLocalRoleKeyList())
4291

4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305
    security.declareProtected(Permissions.ManagePortal, 'build')
    def build(self, no_action=0):
      """
        Copy existing portal objects to self
      """
      if no_action: return
        # this is use at import of Business Template to get the status built
      # Make sure that everything is sane.
      self.clean()

      self.updateRevisionNumber()
      self._setTemplateFormatVersion(1)
      self.storeTemplateItemData()

4306 4307
      # Build each part
      for item_name in self._item_name_list:
4308 4309 4310 4311
        item = getattr(self, item_name)
        if self.getBtForDiff():
          item.is_bt_for_diff = 1
        item.build(self)
4312

4313
    build = WorkflowMethod(build)
4314 4315

    def publish(self, url, username=None, password=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4316
      """
4317
        Publish in a format or another
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4318
      """
4319
      return self.portal_templates.publish(self, url, username=username,
4320
                                           password=password)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4321

4322
    def update(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4323
      """
4324
        Update template: download new template definition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4325
      """
4326
      return self.portal_templates.update(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4327

4328 4329 4330 4331 4332
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4333 4334 4335 4336 4337 4338 4339 4340 4341 4342
      default_catalog = self.getPortalObject().portal_catalog.getSQLCatalog()
      my_catalog = _getCatalogValue(self)
      if default_catalog is not None and my_catalog is not None \
             and catalog_method is not None and self.getTemplateFormatVersion() == 1:
        if default_catalog.getId() == my_catalog.getId():
          # It is needed to update the catalog only if the default SQLCatalog is modified.
          for method_id in catalog_method._objects.keys():
            if 'related' not in method_id:
              # must update catalog
              return True
4343 4344
      return False

4345
    def preinstall(self, check_dependencies=1, **kw):
4346 4347 4348
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4349
      """
4350 4351 4352 4353 4354
      if check_dependencies:
        # required because in multi installation, dependencies has already
        # been checked before and it will failed here as dependencies can be
        # installed at the same time
        self.checkDependencies()
4355

4356 4357
      modified_object_list = {}
      bt_title = self.getTitle()
4358 4359 4360 4361 4362 4363 4364

      #  can be call to diff two Business Template in template tool
      bt2 = kw.get('compare_to', None)
      if  bt2 is not None:
        installed_bt = bt2
      else:
        installed_bt = self.portal_templates.getInstalledBusinessTemplate(title=bt_title)
4365 4366 4367
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4368
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4369

4370
      # if reinstall business template, must compare to object in ZODB
4371
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4372
      # same if we make a diff and select only one business template
4373
      reinstall = 0
4374 4375
      if installed_bt == self:
        reinstall = 1
4376
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
4377 4378
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                   id=INSTALLED_BT_FOR_DIFF)
4379 4380 4381 4382 4383 4384 4385
          # update portal types properties to get last modifications
          bt2.getPortalTypesProperties()
          bt2.edit(description='tmp bt generated for diff', bt_for_diff=1)
          bt2.build()
          installed_bt = bt2
        else:
          installed_bt = self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF)
4386

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4387
      new_bt_format = self.getTemplateFormatVersion()
4388 4389 4390 4391 4392 4393
      if installed_bt_format == 0 and new_bt_format == 0:
        # still use old format, so install everything, no choice
        return modified_object_list
      elif installed_bt_format == 0 and new_bt_format == 1:
        # return list of all object in bt
        for item_name in self._item_name_list:
4394
          item = getattr(self, item_name, None)
4395 4396 4397 4398
          if item is not None:
            for path in item._objects.keys():
              modified_object_list.update({path : ['New', item.__class__.__name__[:-12]]})
        return modified_object_list
4399

4400
      for item_name in self._item_name_list:
4401
        new_item = getattr(self, item_name, None)
4402
        installed_item = getattr(installed_bt, item_name, None)
4403
        if new_item is not None:
4404
          if installed_item is not None and hasattr(installed_item, '_objects'):
4405
            modified_object = new_item.preinstall(context=self, 
4406 4407
                                                  installed_item=installed_item,
                                                  installed_bt=installed_bt)
4408 4409 4410 4411 4412 4413 4414
            if len(modified_object) > 0:
              modified_object_list.update(modified_object)
          else:
            for path in new_item._objects.keys():
              modified_object_list.update({path : ['New', new_item.__class__.__name__[:-12]]})

      if reinstall:
4415
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
4416

4417 4418
      return modified_object_list

4419
    def _install(self, force=1, object_to_update=None, update_translation=0,
4420
                 update_catalog=_MARKER, **kw):
4421
      """
Christophe Dumez's avatar
Christophe Dumez committed
4422
        Install a new Business Template, if force, all will be upgraded or installed
4423 4424
        otherwise depends of dict object_to_update
      """
4425 4426 4427 4428
      if object_to_update is not None:
        force=0
      else:
        object_to_update = {}
4429

4430 4431
      site = self.getPortalObject()
      installed_bt = site.portal_templates.getInstalledBusinessTemplate(
4432
                                                           self.getTitle())
4433 4434
      # When reinstalling, installation state should not change to replaced
      if installed_bt not in [None, self]:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4435
        if installed_bt.getTemplateFormatVersion() == 0:
4436
          force = 1
4437 4438 4439
        if site.portal_workflow.isTransitionPossible(
            installed_bt, 'replace'):
          installed_bt.replace(self)
4440

4441
      trash_tool = getToolByName(site, 'portal_trash', None)
4442 4443 4444
      if trash_tool is None and self.getTemplateFormatVersion() == 1:
        raise AttributeError, 'Trash Tool is not installed'

4445 4446 4447
      # Check the format of business template, if old, force install
      if self.getTemplateFormatVersion() == 0:
        force = 1
4448

4449 4450 4451
      if not force:
        self.checkDependencies()

4452 4453 4454
      from Products.ERP5.ERP5Site import ERP5Generator
      generator_class = getattr(site, '_generator_class', ERP5Generator)
      gen = generator_class()
4455 4456
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
4457 4458 4459 4460 4461 4462
        if not site.hasObject('portal_activities'):
          create_activities = True
          LOG('Business Template', 0, 'Updating Activity Tool')
        else:
          create_activities = False
        gen.setupLastTools(site, update=1, create_activities=create_activities)
4463 4464
      if not force:
        if len(object_to_update) == 0:
4465 4466 4467 4468 4469
          # check if we have to update tools
          if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
            LOG('Business Template', 0, 'Updating Tools')
            gen.setup(site, 0, update=1)
          if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4470
            LOG('Business Template', 0, 'Updating Business Template Workflows')
4471
            gen.setupWorkflow(site)
4472
          return
4473

4474 4475
      # always created a trash bin because we may to save object already present
      # but not in a previous business templates apart at creation of a new site
4476
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
4477 4478 4479 4480 4481
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

      # Install everything
4482
      if len(object_to_update) or force:
4483 4484 4485
        for item_name in self._item_name_list:
          item = getattr(self, item_name, None)
          if item is not None:
4486 4487
            item.install(self, force=force, object_to_update=object_to_update, 
                               trashbin=trashbin, installed_bt=installed_bt)
4488

4489
      # update catalog if necessary
4490 4491 4492
      if update_catalog is _MARKER and force and self.isCatalogUpdatable():
        # override update_catalog parameter only if value
        # is not explicitely passed.
4493
        update_catalog = 1
4494
      elif update_catalog is _MARKER:
4495
        update_catalog = 0
4496
      if update_catalog:
4497
        catalog = _getCatalogValue(self)
4498
        if (catalog is None) or (not site.isIndexable):
4499 4500 4501 4502 4503
          LOG('Business Template', 0, 'no SQL Catalog available')
          update_catalog = 0
        else:
          LOG('Business Template', 0, 'Updating SQL Catalog')
          catalog.manage_catalogClear()
4504

4505
      # get objects to remove
4506
      # do remove after because we may need backup object from installation
4507
      remove_object_dict = {}
4508 4509
      for path, action in object_to_update.iteritems():
        if action in ('remove', 'save_and_remove'):
4510
          remove_object_dict[path] = action
4511

4512
      # remove object from old business template
4513
      if len(remove_object_dict):
4514
        # XXX: this code assumes that there is an installed_bt
4515
        for item_name in reversed(installed_bt._item_name_list):
4516
          item = getattr(installed_bt, item_name, None)
4517
          if item is not None:
4518
            item.remove(self, remove_object_dict=remove_object_dict, trashbin=trashbin)
4519

4520 4521 4522 4523 4524 4525

      # update tools if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
        LOG('Business Template', 0, 'Updating Tools')
        gen.setup(site, 0, update=1)

4526
      # check if we have to update business template workflow
4527
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4528
        LOG('Business Template', 0, 'Updating Business Template Workflows')
4529 4530 4531 4532 4533
        gen.setupWorkflow(site)
        # XXX keep TM in case update of workflow doesn't work
        #         self._v_txn = WorkflowUpdateTM()
        #         self._v_txn.register(update=1, gen=gen, site=site)

4534 4535
      # remove trashbin if empty
      if trashbin is not None:
4536
        if len(trashbin) == 0:
4537 4538
          trash_tool.manage_delObjects([trashbin.getId(),])

4539 4540
      if update_catalog:
        site.ERP5Site_reindexAll()
4541

4542 4543
      # Update translation table, in case we added new portal types or
      # workflow states.
4544 4545
      if update_translation:
        site.ERP5Site_updateTranslationTable()
4546

4547 4548
      # Clear cache to avoid reusing cached values with replaced objects.
      site.portal_caches.clearAllCache()
4549

4550
    security.declareProtected(Permissions.ManagePortal, 'install')
4551 4552 4553
    def install(self, **kw):
      """
        For install based on paramaters provided in **kw
4554
      """
4555
      return self._install(**kw)
4556

4557
    install = WorkflowMethod(install)
4558

4559
    security.declareProtected(Permissions.ManagePortal, 'reinstall')
4560
    def reinstall(self, **kw):
4561 4562 4563 4564
      """Reinstall Business Template.
      """
      return self._install(**kw)

4565
    reinstall = WorkflowMethod(reinstall)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4566

4567
    security.declareProtected(Permissions.ManagePortal, 'trash')
4568 4569
    def trash(self, new_bt, **kw):
      """
4570
        Trash unnecessary items before upgrading to a new business
4571
        template.
4572
        This is similar to uninstall, but different in that this does
4573
        not remove all items.
4574
      """
4575 4576
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4577
        item = getattr(self, item_name, None)
4578 4579
        if item is not None:
          item.trash(
4580
                self,
4581
                getattr(new_bt, item_name))
4582

4583
    security.declareProtected(Permissions.ManagePortal, 'uninstall')
4584
    def uninstall(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4585
      """
4586
        For uninstall based on paramaters provided in **kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4587
      """
4588 4589 4590
      # Uninstall everything
      # Trash everything
      for item_name in self._item_name_list[::-1]:
4591
        item = getattr(self, item_name, None)
4592
        if item is not None:
4593
          item.uninstall(self, **kw)
4594
      # It is better to clear cache because the uninstallation of a
4595
      # template deletes many things from the portal.
Aurel's avatar
Aurel committed
4596
      self.getPortalObject().portal_caches.clearAllCache()
4597

4598 4599
    uninstall = WorkflowMethod(uninstall)

4600
    security.declareProtected(Permissions.ManagePortal, 'clean')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4601
    def _clean(self):
4602
      """
4603
        Clean built information.
4604
      """
4605
      # First, remove obsolete attributes if present.
4606 4607 4608 4609
      for attr in ( '_action_archive',
                    '_document_archive',
                    '_extension_archive',
                    '_test_archive',
4610
                    '_module_archive',
4611 4612 4613
                    '_object_archive',
                    '_portal_type_archive',
                    '_property_archive',
4614
                    '_property_sheet_archive'):
4615 4616 4617
        if hasattr(self, attr):
          delattr(self, attr)
      # Secondly, make attributes empty.
4618 4619
      for item_name in self._item_name_list:
        item = setattr(self, item_name, None)
4620

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

4623
    security.declareProtected(Permissions.AccessContentsInformation,
4624
                              'getBuildingState')
4625
    def getBuildingState(self, default=None, id_only=1):
4626
      """
4627
        Returns the current state in building
4628
      """
4629
      portal_workflow = getToolByName(self, 'portal_workflow')
4630 4631
      wf = portal_workflow.getWorkflowById(
                          'business_template_building_workflow')
4632
      return wf._getWorkflowStateOf(self, id_only=id_only )
4633

4634
    security.declareProtected(Permissions.AccessContentsInformation,
4635
                              'getInstallationState')
4636
    def getInstallationState(self, default=None, id_only=1):
4637
      """
4638
        Returns the current state in installation
4639
      """
4640
      portal_workflow = getToolByName(self.getPortalObject(), 'portal_workflow')
4641 4642
      wf = portal_workflow.getWorkflowById(
                           'business_template_installation_workflow')
4643
      return wf._getWorkflowStateOf(self, id_only=id_only )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4644

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4645 4646 4647 4648 4649 4650
    security.declareProtected(Permissions.AccessContentsInformation, 'toxml')
    def toxml(self):
      """
        Return this Business Template in XML
      """
      portal_templates = getToolByName(self, 'portal_templates')
4651
      export_string = portal_templates.manage_exportObject(
4652 4653
                                               id=self.getId(),
                                               toxml=1,
4654
                                               download=1)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4655
      return export_string
4656

4657
    def _getOrderedList(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4658
      """
4659 4660
        We have to set this method because we want an
        ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4661
      """
4662 4663
      method_id = '_baseGet%sList' % convertToUpperCase(id)
      result = getattr(self, method_id)(())
4664 4665 4666 4667
      if result is None: result = ()
      if result != ():
        result = list(result)
        result.sort()
4668
        # XXX Why do we need to return a tuple ?
4669 4670
        result = tuple(result)
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4671

4672
    def getTemplateCatalogMethodIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4673
      """
4674 4675
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4676
      """
4677
      return self._getOrderedList('template_catalog_method_id')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4678

4679
    def getTemplateBaseCategoryList(self):
4680
      """
4681 4682
      We have to set this method because we want an
      ordered list
4683
      """
4684
      return self._getOrderedList('template_base_category')
4685

4686
    def getTemplateWorkflowIdList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4687
      """
4688 4689
      We have to set this method because we want an
      ordered list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4690
      """
4691
      return self._getOrderedList('template_workflow_id')
4692

4693
    def getTemplatePortalTypeIdList(self):
4694
      """
4695 4696
      We have to set this method because we want an
      ordered list
4697
      """
4698
      return self._getOrderedList('template_portal_type_id')
4699

4700 4701 4702 4703 4704 4705 4706
    def getTemplatePortalTypeWorkflowChainList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_workflow_chain')

Alexandre Boeglin's avatar
Alexandre Boeglin committed
4707 4708 4709 4710 4711 4712 4713
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

4714 4715 4716 4717 4718 4719 4720
    def getTemplatePreferenceList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_preference')

4721 4722 4723 4724 4725 4726
    def getTemplatePortalTypeAllowedContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_allowed_content_type')
4727

4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748
    def getTemplatePortalTypeHiddenContentTypeList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_portal_type_hidden_content_type')

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

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

4749
    def getTemplateActionPathList(self):
4750
      """
4751 4752
      We have to set this method because we want an
      ordered list
4753
      """
4754
      return self._getOrderedList('template_action_path')
4755

4756
    def getTemplatePortalTypeRoleList(self):
4757 4758 4759 4760
      """
      We have to set this method because we want an
      ordered list
      """
4761
      return self._getOrderedList('template_portal_type_role')
4762

4763
    def getTemplateLocalRoleList(self):
4764 4765 4766 4767
      """
      We have to set this method because we want an
      ordered list
      """
4768
      return self._getOrderedList('template_local_role')
4769

4770
    def getTemplateSkinIdList(self):
4771
      """
4772 4773
      We have to set this method because we want an
      ordered list
4774
      """
4775
      return self._getOrderedList('template_skin_id')
4776

4777 4778 4779 4780 4781 4782 4783
    def getTemplateRegisteredSkinSelectionList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_registered_skin_selection')

4784
    def getTemplateModuleIdList(self):
4785
      """
4786 4787
      We have to set this method because we want an
      ordered list
4788
      """
4789
      return self._getOrderedList('template_module_id')
4790 4791 4792 4793 4794 4795 4796

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4798 4799 4800 4801 4802 4803 4804
    def getTemplateToolIdList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_tool_id')

4805
    security.declareProtected(Permissions.ManagePortal, 'export')
Aurel's avatar
Aurel committed
4806 4807 4808 4809
    def export(self, path=None, local=0, **kw):
      """
        Export this Business Template
      """
4810
      if self.getBuildingState() != 'built':
4811
        raise TemplateConditionError, \
Christophe Dumez's avatar
Christophe Dumez committed
4812
              'Business Template must be built before export'
4813

Aurel's avatar
Aurel committed
4814 4815 4816 4817 4818 4819 4820
      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)

4821
      # export bt
4822
      bta.addFolder(path+os.sep+'bt')
Aurel's avatar
Aurel committed
4823
      for prop in self.propertyMap():
4824
        prop_type = prop['type']
Aurel's avatar
Aurel committed
4825
        id = prop['id']
4826
        if id in ('id', 'uid', 'rid', 'sid', 'id_group', 'last_id',
4827
                  'install_object_list_list', 'id_generator', 'bt_for_diff'):
4828
          continue
Aurel's avatar
Aurel committed
4829
        value = self.getProperty(id)
4830 4831
        if value is None:
          continue
4832
        if prop_type in ('text', 'string', 'int', 'boolean'):
4833
          bta.addObject(obj=value, name=id, path=path+os.sep+'bt', ext='')
4834
        elif prop_type in ('lines', 'tokens'):
4835
          bta.addObject(obj=str('\n').join(value), name=id,
4836
                        path=path+os.sep+'bt', ext='')
4837

Aurel's avatar
Aurel committed
4838 4839 4840
      # Export each part
      for item_name in self._item_name_list:
        getattr(self, item_name).export(context=self, bta=bta)
4841

4842
      return bta.finishCreation(self.getTitle())
Aurel's avatar
Aurel committed
4843

4844
    security.declareProtected(Permissions.ManagePortal, 'importFile')
Aurel's avatar
Aurel committed
4845 4846
    def importFile(self, dir = 0, file=None, root_path=None):
      """
4847
        Import all xml files in Business Template
Aurel's avatar
Aurel committed
4848 4849 4850 4851 4852
      """
      if dir:
        bta = BusinessTemplateFolder(importing=1, file=file, path=root_path)
      else:
        bta = BusinessTemplateTarball(importing=1, file=file)
4853 4854

      self.storeTemplateItemData()
4855

4856 4857
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
4858
      orig_module_dict = {}
4859
      instance_oid_list = []
4860 4861
      for template_id in self.getTemplateDocumentIdList():
          module_id = 'Products.ERP5Type.Document.' + template_id
4862
          orig_module_dict[module_id] = sys.modules.get(module_id)
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872
          # Always redefine the module, so that 'instance_oid_list' contains
          # the full list of oid to remove from pickle cache.
          sys.modules[module_id] = module = imp.new_module(module_id)
          module.SimpleItem = SimpleItem.SimpleItem
          module.instance_oid_list = instance_oid_list
          exec """class %s(SimpleItem):
            def __setstate__(self, state):
              instance_oid_list.append(self._p_oid)
              return SimpleItem.__setstate__(self, state)""" % template_id \
            in module.__dict__
4873

Aurel's avatar
Aurel committed
4874 4875
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4876

4877 4878 4879 4880 4881 4882
      if instance_oid_list:
        # If a temporary class was used, we must force all instances using it
        # to be reloaded (i.e. unpickle) on next access (at installation).
        # Doing a savepoint will pickle them to a temporary storage so that all
        # references to it can be freed.
        transaction.savepoint(optimistic=True)
4883 4884
        self._p_jar.cacheMinimize()
        gc.collect()
4885

4886 4887
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
4888 4889 4890 4891 4892 4893
      # Restore original module if any, in case the new one is not installed.
      for module_id, module in orig_module_dict.iteritems():
        if module is None:
          del sys.modules[module_id]
        else:
          sys.modules[module_id] = module
4894

4895 4896 4897 4898 4899
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
4900 4901 4902
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
4903
      return items_list
4904

4905 4906 4907 4908 4909 4910 4911 4912 4913 4914
    def checkDependencies(self):
      """
       Check if all the dependencies of the business template
       are installed. Raise an exception with the list of
       missing dependencies if some are missing
      """
      missing_dep_list = []
      dependency_list = self.getDependencyList()
      if len(dependency_list)!=0:
        for dependency_couple in dependency_list:
4915
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
4916
          dependency = dependency_couple_list[0]
4917 4918
          if dependency in (None, ''):
            continue
4919 4920
          version_restriction = None
          if len(dependency_couple_list) > 1:
4921
            version_restriction = dependency_couple_list[1]
4922 4923 4924
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
4925 4926 4927
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
4928
                  or (version_restriction not in (None, '') and
4929 4930 4931 4932
                     (not self.portal_templates.compareVersionStrings(installed_bt.getVersion(), version_restriction)))):
            missing_dep_list.append((dependency, version_restriction or ''))
      if len(missing_dep_list) != 0:
        raise BusinessTemplateMissingDependency, 'Impossible to install, please install the following dependencies before: %s'%repr(missing_dep_list)
4933

4934 4935 4936 4937 4938 4939 4940 4941
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
        This is compatible with ERP5Subversion look and feel but
        it is preferred in future we use more difflib python library.
      """
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

Aurel's avatar
Aurel committed
4942
    def diffObject(self, REQUEST, **kw):
4943 4944
      """
        Make a diff between an object in the Business Template
4945
        and the same in the Business Template installed in the site
4946 4947 4948 4949
      """

      class_name_dict = {
        'Product' : '_product_item',
4950
        'PropertySheet' : '_property_sheet_item',
4951
        'Constraint' : '_constraint_item',
4952 4953 4954 4955 4956 4957 4958 4959 4960
        'Document' : '_document_item',
        'Extension' : '_extension_item',
        'Test' : '_test_item',
        'Role' : '_role_item',
        'MessageTranslation' : '_message_translation_item',
        'Workflow' : '_workflow_item',
        'CatalogMethod' : '_catalog_method_item',
        'SiteProperty' : '_site_property_item',
        'PortalType' : '_portal_type_item',
4961
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
4962 4963 4964 4965
        'PortalTypeAllowedContentType' : '_portal_type_allowed_content_type_item',
        'PortalHiddenAllowedContentType' : '_portal_type_hidden_content_type_item',
        'PortalTypePropertySheet' : '_portal_type_property_sheet_item',
        'PortalTypeBaseCategory' : '_portal_type_base_category_item',
4966 4967 4968
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
4969
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
4970
        'Path' : '_path_item',
4971
        'Preference' : '_preference_item',
4972
        'Action' : '_action_item',
4973
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4974
        'LocalRoles' : '_local_roles_item',
4975 4976 4977
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4978
        'CatalogSearchKey' : '_catalog_search_key_item',
4979
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
4980
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
4981 4982 4983 4984
        'CatalogFullTextKey' : '_catalog_full_text_key_item',
        'CatalogRequestKey' : '_catalog_request_key_item',
        'CatalogMultivalueKey' : '_catalog_multivalue_key_item',
        'CatalogTopicKey' : '_catalog_topic_key_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4985
        'Tool': '_tool_item',
4986
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
4987 4988
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
4989
        }
4990

4991 4992
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
4993

Christophe Dumez's avatar
Christophe Dumez committed
4994
      # Get objects
4995
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4996

4997
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
4998
      # Compare with a given business template
4999
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
5000 5001
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
5002 5003
        if bt2_id == self.getId():
          compare_to_zodb = 1
5004
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
5005 5006
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
5007 5008 5009
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
5010 5011
          compare_to_zodb = 1
      if compare_to_zodb:
5012 5013
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
5014
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
5015 5016 5017
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
5018

5019 5020
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5021
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5022
        # XXX maybe only build for the given object to gain time
5023
        installed_item.build(self)
5024 5025 5026
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5027

Christophe Dumez's avatar
Christophe Dumez committed
5028
      # Real Zope Objects (can be exported into XML directly by Zope)
5029 5030
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5031
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5032
                     '_skin_item', '_action_item', '_tool_item', ]
5033

Christophe Dumez's avatar
Christophe Dumez committed
5034
      # Not considered as objects by Zope (will be exported into XML manually)
5035
      # XXX Bad naming
5036 5037 5038 5039
      item_list_2 = ['_site_property_item',
                     '_module_item',
                     '_catalog_result_key_item', 
                     '_catalog_related_key_item',
5040
                     '_catalog_result_table_item',
5041
                     '_catalog_search_key_item',
5042
                     '_catalog_keyword_key_item',
5043
                     '_catalog_datetime_key_item',
5044 5045 5046 5047
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5048
                     '_catalog_scriptable_key_item',
5049 5050
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5051 5052 5053 5054 5055 5056
                     '_portal_type_allowed_content_type_item',
                     '_portal_type_hidden_content_type_item',
                     '_portal_type_property_sheet_item',
                     '_portal_type_roles_item',
                     '_portal_type_base_category_item',
                     '_local_roles_item',
5057
                     '_portal_type_workflow_chain_item',]
5058

Christophe Dumez's avatar
Christophe Dumez committed
5059
      # Text objects (no need to export them into XML)
5060
      # XXX Bad naming
5061 5062
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5063
                     '_test_item', '_message_translation_item',]
5064

5065
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5066 5067 5068
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5069 5070
        new_object = new_item.removeProperties(new_object, 1)
        installed_object = installed_item.removeProperties(installed_object, 1)
5071
        # XML Export in memory
5072
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5073 5074
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5075
        new_obj_xml = f1.getvalue()
5076
        f1.close()
5077 5078 5079 5080
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5081
        # End of XML export
5082

5083
        # Diff between XML objects
5084 5085
        diff_list = list(unified_diff(installed_ob_xml_lines, new_ob_xml_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
Christophe Dumez's avatar
Christophe Dumez committed
5086
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5087 5088 5089
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5090

5091
      elif item_name in item_list_2:
5092
        # Generate XML code manually
5093 5094
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5095 5096
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5097
        # End of XML Code Generation
5098

5099
        # Diff between XML objects
5100 5101
        diff_list = list(unified_diff(installed_obj_xml_lines, new_obj_xml_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
Christophe Dumez's avatar
Christophe Dumez committed
5102
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5103 5104 5105
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5106

5107
      elif item_name in item_list_3:
5108
        # Diff between text objects
5109 5110 5111 5112
        new_obj_lines = new_object.splitlines()
        installed_obj_lines = installed_object.splitlines()
        diff_list = list(unified_diff(installed_obj_lines, new_obj_lines, tofile=new_bt.getId(), fromfile=installed_bt.getId(), lineterm=''))
        if len(diff_list) != 0:
Christophe Dumez's avatar
Christophe Dumez committed
5113
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5114 5115
          diff_msg += '\n'.join(diff_list)
        else:
5116
          diff_msg = 'No diff'
5117

5118
      else:
5119
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5120

5121
      if compare_to_zodb:
5122
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5123

5124
      return diff_msg
5125

5126

5127 5128 5129 5130
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5131 5132
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5133 5134 5135 5136 5137 5138 5139
      bt_allowed_content_type_list = list(getattr(self, 'template_portal_type_allowed_content_type', []) or [])
      bt_hidden_content_type_list = list(getattr(self, 'template_portal_type_hidden_content_type', []) or [])
      bt_property_sheet_list = list(getattr(self, 'template_portal_type_property_sheet', []) or [])
      bt_base_category_list = list(getattr(self, 'template_portal_type_base_category', []) or [])
      bt_action_list = list(getattr(self, 'template_action_path', []) or [])
      bt_portal_types_id_list = list(self.getTemplatePortalTypeIdList())
      bt_portal_type_roles_list =  list(getattr(self, 'template_portal_type_roles', []) or [])
5140 5141
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5142
      p = self.getPortalObject()
5143
      for id in bt_portal_types_id_list:
5144 5145
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5146
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5147
        if portal_type.getRoleInformationList():
5148 5149
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5150

5151 5152 5153 5154
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5155
        action_list = []
5156 5157 5158 5159 5160 5161 5162
        if hasattr(portal_type, 'allowed_content_types'):
          allowed_content_type_list = portal_type.allowed_content_types
        if hasattr(portal_type, 'hidden_content_type_list'):
          hidden_content_type_list = portal_type.hidden_content_type_list
        if hasattr(portal_type, 'property_sheet_list'):
          property_sheet_list = portal_type.property_sheet_list
        if hasattr(portal_type, 'base_category_list'):
5163
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5164 5165
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5166

5167 5168 5169 5170
        for a_id in allowed_content_type_list:
          allowed_id = id+' | '+a_id
          if allowed_id not in bt_allowed_content_type_list:
            bt_allowed_content_type_list.append(allowed_id)
5171

5172
        for h_id in hidden_content_type_list:
5173 5174 5175
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5176

5177 5178 5179 5180
        for ps_id in property_sheet_list:
          p_sheet_id = id+' | '+ps_id
          if p_sheet_id not in bt_property_sheet_list:
            bt_property_sheet_list.append(p_sheet_id)
5181

5182 5183 5184 5185
        for bc_id in base_category_list:
          base_cat_id = id+' | '+bc_id
          if base_cat_id not in bt_base_category_list:
            bt_base_category_list.append(base_cat_id)
5186

5187 5188 5189 5190
        for act_id in action_list:
          action_id = id+' | '+act_id
          if action_id not in bt_action_list:
            bt_action_list.append(action_id)
5191

5192
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5193
                                    if chain != '(Default)']:
5194 5195 5196
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5197

5198 5199 5200 5201
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5202
      bt_action_list.sort()
5203
      bt_wf_chain_list.sort()
5204

5205 5206 5207 5208 5209 5210 5211
      self.setProperty('template_portal_type_workflow_chain', bt_wf_chain_list)
      self.setProperty('template_portal_type_roles', bt_portal_type_roles_list)
      self.setProperty('template_portal_type_allowed_content_type', bt_allowed_content_type_list)
      self.setProperty('template_portal_type_hidden_content_type', bt_hidden_content_type_list)
      self.setProperty('template_portal_type_property_sheet', bt_property_sheet_list)
      self.setProperty('template_portal_type_base_category', bt_base_category_list)
      self.setProperty('template_action_path', bt_action_list)
5212 5213 5214 5215 5216 5217 5218 5219 5220
      return


    def guessPortalTypes(self, **kw):
      """
      This method guesses portal types based on modules define in the Business Template
      """
      bt_module_id_list = list(self.getTemplateModuleIdList())
      if len(bt_module_id_list) == 0:
5221 5222
        raise TemplateConditionError, 'No module defined in business template'

5223 5224 5225 5226 5227 5228 5229 5230
      bt_portal_types_id_list = list(self.getTemplatePortalTypeIdList())

      def getChildPortalType(type_id):
        type_list = {}
        p = self.getPortalObject()
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+type_id)
        except KeyError:
5231
          return type_list
5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245

        allowed_content_type_list = []
        hidden_content_type_list = []
        if hasattr(portal_type, 'allowed_content_types'):
          allowed_content_type_list = portal_type.allowed_content_types
        if hasattr(portal_type, 'hidden_content_type_list'):
          hidden_content_type_list = portal_type.hidden_content_type_list
        type_list[type_id] = ()
        # get same info for allowed portal types and hidden portal types
        for allowed_ptype_id in allowed_content_type_list:
          if allowed_ptype_id not in type_list.keys():
            type_list.update(getChildPortalType(allowed_ptype_id))
        for hidden_ptype_id in hidden_content_type_list:
          if hidden_ptype_id not in type_list.keys():
5246
            type_list.update(getChildPortalType(hidden_ptype_id))
5247
        return type_list
5248

5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295
      p = self.getPortalObject()
      portal_dict = {}
      for module_id in bt_module_id_list:
        module = p.unrestrictedTraverse(module_id)
        portal_type_id = module.getPortalType()
        try:
          portal_type = p.unrestrictedTraverse('portal_types/'+portal_type_id)
        except KeyError:
          continue
        allowed_content_type_list = []
        hidden_content_type_list = []
        if hasattr(portal_type, 'allowed_content_types'):
          allowed_content_type_list = portal_type.allowed_content_types
        if hasattr(portal_type, 'hidden_content_type_list'):
          hidden_content_type_list = portal_type.hidden_content_type_list

        portal_dict[portal_type_id] = ()

        for allowed_type_id in allowed_content_type_list:
          if allowed_type_id not in portal_dict.keys():
            portal_dict.update(getChildPortalType(allowed_type_id))

        for hidden_type_id in hidden_content_type_list:
          if hidden_type_id not in portal_dict.keys():
            portal_dict.update(getChildPortalType(hidden_type_id))

      # construct portal type list, keep already present portal types
      for id in portal_dict.keys():
        if id not in bt_portal_types_id_list:
          bt_portal_types_id_list.append(id)

      bt_portal_types_id_list.sort()

      setattr(self, 'template_portal_type_id', bt_portal_types_id_list)
      return

    def clearPortalTypes(self, **kw):
      """
      clear id list register for portal types
      """
      setattr(self, 'template_portal_type_id', ())
      setattr(self, 'template_portal_type_allowed_content_type', ())
      setattr(self, 'template_portal_type_hidden_content_type', ())
      setattr(self, 'template_portal_type_property_sheet', ())
      setattr(self, 'template_portal_type_base_category', ())
      return

5296 5297 5298
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5299
  setattr(BusinessTemplate, key, None)
5300

5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327
# Transaction Manager used for update of business template workflow
# XXX update seems to works without it

# from Shared.DC.ZRDB.TM import TM

# class WorkflowUpdateTM(TM):

#   _p_oid=_p_changed=_registered=None
#   _update = 0

#   def __init__(self, ):
#     LOG('init TM', 0, '')

#   def register(self, update=0, gen=None, site=None):
#     LOG('register TM', 0, update)
#     self._gen = gen
#     self._site = site
#     self._update = update
#     self._register()

#   def tpc_prepare(self, *d, **kw):
#     LOG("tpc_prepare", 0, self._update)
#     if self._update:
#       # do it one time
#       self._update = 0
#       LOG('call update of wf', 0, '')
#       self._gen.setupWorkflow(self._site)
5328

5329 5330 5331 5332 5333 5334 5335 5336

#   def _finish(self, **kw):
#     LOG('finish TM', 0, '')
#     pass

#   def _abort(self, **kw):
#     LOG('abort TM', 0, '')
#     pass
5337