BusinessTemplate.py 206 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.PythonScripts.PythonScript import PythonScript
39
from Products.ERP5Type.Accessor.Constant import PropertyGetter as ConstantGetter
40
from Products.ERP5Type.Base import WorkflowMethod, _aq_reset
Nicolas Dumazet's avatar
Nicolas Dumazet committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
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
59
from Products.ERP5Type.Utils import convertToUpperCase
60
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
61
from Products.ERP5Type.XMLObject import XMLObject
Aurel's avatar
Aurel committed
62
from OFS.Traversable import NotFound
63
from OFS import SimpleItem, XMLExportImport
64
from cStringIO import StringIO
Aurel's avatar
Aurel committed
65
from copy import deepcopy
66
from zExceptions import BadRequest
Aurel's avatar
Aurel committed
67
import OFS.XMLExportImport
68
from Products.ERP5Type.patches.ppml import importXML
Aurel's avatar
Aurel committed
69
customImporters={
70
    XMLExportImport.magic: importXML,
Aurel's avatar
Aurel committed
71
    }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
72

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

85 86 87 88 89 90
import threading

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

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

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

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

113 114 115 116 117 118
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:
119 120 121 122
    try:
      return acquisition_context.getPortalObject().portal_catalog.objectIds('SQLCatalog')[0]
    except IndexError:
      return None
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
  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

142 143 144 145 146
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.
  """
147
  if getattr(aq_base(obj), 'uid', _MARKER) is not _MARKER:
148
    obj.uid = None
149 150 151
  for subobj in obj.objectValues():
    _recursiveRemoveUid(subobj)

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

157 158 159 160 161 162 163
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
  """
164
  pw = context.getPortalObject().portal_workflow
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
  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)

186 187 188 189 190 191 192 193 194 195 196 197 198 199
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]
200 201 202
  # recompile the method
  method._arg = Aqueduct.parse(method.arguments_src)
  method.template = method.template_class(method.src)
203

204 205
def registerSkinFolder(skin_tool, skin_folder):
  request = skin_tool.REQUEST
206 207 208
  # 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)
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
  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()

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

227 228 229 230 231 232 233
  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

234 235 236 237 238 239 240 241 242
  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 ''
243
    selection_list = selection.split(',')
244
    if (skin_folder_id not in selection_list):
245
      selection_list.insert(0, skin_folder_id)
246
    if reorder_skin_selection:
247 248
      # Sort by skin priority and ID
      selection_list.sort(key=skin_sort_key)
249
    if (skin_name in skin_layer_list):
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 308
      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
309 310 311
class BusinessTemplateArchive:
  """
    This is the base class for all Business Template archives
312
  """
Aurel's avatar
Aurel committed
313 314 315 316 317 318 319 320 321 322 323 324

  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
325

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

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

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

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

  def _initImport(self, file=None, path=None, **kw):
370
    # Normalize the paths to eliminate the effect of double-slashes.
371 372 373 374 375 376 377 378
    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
379

380
  def importFiles(self, item, **kw):
Aurel's avatar
Aurel committed
381 382 383
    """
      Import file from a local folder
    """
384
    class_name = item.__class__.__name__
385 386
    root_path_len = self.root_path_len
    prefix_len = root_path_len + len(class_name) + len(os.sep)
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
    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
407

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

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

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

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

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

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

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

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

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

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

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

509
  def preinstall(self, context, installed_item, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
510 511
    """
      Build a list of added/removed/changed files between the BusinessTemplate
512
      being installed (self) and the installed one (installed_item).
Vincent Pelletier's avatar
Vincent Pelletier committed
513 514 515 516 517
      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
518 519
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
520
      new_keys = self._objects.keys()
521
      for path in new_keys:
522
        if installed_item._objects.has_key(path):
Vincent Pelletier's avatar
Vincent Pelletier committed
523
          # compare objects to see it there are changes
524
          new_obj_xml = self.generateXml(path=path)
525
          old_obj_xml = installed_item.generateXml(path=path)
526 527
          if new_obj_xml != old_obj_xml:
            modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
528
          # else, compared versions are identical, don't overwrite the old one
529 530
        else: # new object
          modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
Vincent Pelletier's avatar
Vincent Pelletier committed
531
      # list removed objects
532
      old_keys = installed_item._objects.keys()
533 534 535 536 537 538
      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):
539
    pass
540 541 542

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

544
  def remove(self, context, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
545 546 547 548 549 550
    """
      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.
    """
551 552 553
    remove_dict = kw.get('remove_object_dict', {})
    keys = self._objects.keys()
    keys.sort()
554
    keys.reverse()
555 556 557 558 559 560 561 562 563 564 565
    # 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)
566 567 568 569
        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
570

571

572 573 574 575
  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
576
  def export(self, context, bta, **kw):
577
    pass
Aurel's avatar
Aurel committed
578

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

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

585
  def removeProperties(self, obj, export):
586 587
    """
    Remove unneeded properties for export
588
    """
589
    obj._p_activate()
590 591
    klass = obj.__class__
    classname = klass.__name__
592

593 594
    attr_set = set(('_dav_writelocks', '_filepath', '_owner', 'uid',
                    'workflow_history', '__ac_local_roles__'))
595
    if export:
596 597
      # PythonScript covers both Zope Python scripts
      # and ERP5 Python Scripts
598 599 600 601
      if isinstance(obj, PythonScript):
        # XXX forward compatibility: set to None instead of deleting '_code'
        #     so that old BT code can import recent BT
        obj._code = None
602 603 604 605 606
        attr_set.update((#'func_code', 'func_defaults', '_code',
                         '_lazy_compilation', 'Python_magic'))
      #elif classname == 'SQL' and klass.__module__== 'Products.ZSQLMethods':
      #  attr_set.update(('_arg', 'template'))
      elif interfaces.IIdGenerator.providedBy(obj):
Nicolas Dumazet's avatar
Nicolas Dumazet committed
607
        attr_set.update(('last_max_id_dict', 'last_id_dict'))
608

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

613
    if classname == 'PDFForm':
614
      if not obj.getProperty('business_template_include_content', 1):
615
        obj.deletePdfContent()
616 617
    return obj

618 619 620 621 622 623 624 625 626
  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]

627
  def restrictedResolveValue(self, context=None, path='', default=_MARKER):
628 629 630 631
    """
      Get the value with checking the security.
      This method does not acquire the parent.
    """
632 633
    return self.unrestrictedResolveValue(context, path, default=default,
                                         restricted=1)
634

635 636
  def unrestrictedResolveValue(self, context=None, path='', default=_MARKER,
                               restricted=0):
637 638 639 640 641 642 643 644 645 646 647
    """
      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:
648
        portal = aq_inner(self.getPortalObject())
649 650 651 652
        container = portal
      else:
        container = context

653 654 655 656
      if restricted:
        validate = getSecurityManager().validate

      while stack:
657
        key = stack.pop()
658 659 660 661 662 663 664 665
        try:
          value = container[key]
        except KeyError:
          LOG('BusinessTemplate', WARNING, 
              'Could not access object %s' % (path,))
          if default is _MARKER:
            raise
          return default
666

667 668 669 670 671 672 673 674 675 676 677 678
        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
679

680 681 682
      return value
    else:
      return context
683

684 685 686
class ObjectTemplateItem(BaseTemplateItem):
  """
    This class is used for generic objects and as a subclass.
687
  """
688

689 690 691 692
  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()
693
      self._archive.clear()
694 695 696
      for id in id_list :
        if id != '':
          self._archive["%s/%s" % (tool_id, id)] = None
697

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

Aurel's avatar
Aurel committed
722
  def build_sub_objects(self, context, id_list, url, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
723
    # XXX duplicates code from build
Aurel's avatar
Aurel committed
724 725
    p = context.getPortalObject()
    for id in id_list:
726
      relative_url = '/'.join([url,id])
727 728
      obj = p.unrestrictedTraverse(relative_url)
      obj = obj._getCopy(context)
729
      obj = self.removeProperties(obj, 1)
Vincent Pelletier's avatar
Vincent Pelletier committed
730 731 732
      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
733
        groups = deepcopy(obj.groups)
734
      if id_list:
Aurel's avatar
Aurel committed
735
        self.build_sub_objects(context, id_list, relative_url)
736
        for id_ in list(id_list):
737
          obj._delObject(id_)
738
      if hasattr(aq_base(obj), 'groups'):
739 740 741
        obj.groups = groups
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
Aurel's avatar
Aurel committed
742

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

770
  def _compileXML(self, file):
771 772 773 774 775 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
    # 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
830

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

850
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
851 852
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
Julien Muchembled's avatar
Julien Muchembled committed
853 854 855
      upgrade_list = []
      type_name = self.__class__.__name__.split('TemplateItem')[-2]
      for path in self._objects:
856
        if installed_item._objects.has_key(path):
857
          upgrade_list.append((path, installed_item._objects[path]))
858
        else: # new object
Julien Muchembled's avatar
Julien Muchembled committed
859 860 861 862 863 864 865 866 867 868
          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()
869 870 871 872 873
        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
874 875 876 877
        new_io.close()
        old_io.close()
        if new_obj_xml != old_obj_xml:
          modified_object_list[path] = 'Modified', type_name
878
      # get removed object
879
      for path in set(installed_item._objects) - set(self._objects):
Julien Muchembled's avatar
Julien Muchembled committed
880
        modified_object_list[path] = 'Removed', type_name
881 882
    return modified_object_list

883
  def _backupObject(self, action, trashbin, container_path, object_id, **kw):
884 885 886
    """
      Backup the object in portal trash if necessery and return its subobjects
    """
887
    subobjects_dict = {}
888
    if trashbin is None: # must return subobjects
889 890 891 892 893 894
      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)
895
        subobjects_dict[subobject_id] = subobject_copy
896
      return subobjects_dict
897
    # XXX btsave is for backward compatibility
898
    if action == 'backup' or action == 'btsave' or action == 'save_and_remove':
899 900 901
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=1, **kw)
902
    elif action == 'install':
903 904 905
      subobjects_dict = self.portal_trash.backupObject(trashbin, 
                                                container_path, object_id, 
                                                save=0, **kw)
906 907 908 909
    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
910
    return subobjects_dict
911

912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
  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

928
  def onNewObject(self, obj):
929 930 931 932
    """
      Installation hook.
      Called when installation process determined that object to install is
      new on current site (it's not replacing an existing object).
933
      `obj` parameter is the newly created object in its acquisition context.
934 935 936 937
      Can be overridden by subclasses.
    """
    pass

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
  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

955
  def install(self, context, trashbin, **kw):
956
    self.beforeInstall()
957 958
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
Yoshinori Okuji's avatar
Yoshinori Okuji committed
959
    if context.getTemplateFormatVersion() == 1:
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
      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
979
      groups = {}
980
      old_groups = {}
981 982 983 984
      portal = context.getPortalObject()
      # sort to add objects before their subobjects
      keys = self._objects.keys()
      keys.sort()
985 986
      # set safe activities execution order
      original_reindex_parameters = self.setSafeReindexationMode(context)
987
      for path in keys:
988 989
        if update_dict.has_key(path) or force:
          # get action for the oject
Yoshinori Okuji's avatar
Yoshinori Okuji committed
990
          action = 'backup'
991 992 993 994 995
          if not force:
            action = update_dict[path]
            if action == 'nothing':
              continue
          # get subobjects in path
996 997 998
          path_list = path.split('/')
          container_path = path_list[:-1]
          object_id = path_list[-1]
999
          try:
1000
            container = self.unrestrictedResolveValue(portal, container_path)
1001 1002
          except KeyError:
            # parent object can be set to nothing, in this case just go on
1003
            container_url = '/'.join(container_path)
1004 1005 1006 1007
            if update_dict.get(container_url) == 'nothing':
              continue
            # If container's container is portal_catalog,
            # then automatically create the container.
1008
            elif len(container_path) > 1 and container_path[-2] == 'portal_catalog':
1009 1010
              # The id match, but better double check with the meta type
              # while avoiding the impact of systematic check
1011
              container_container = portal.unrestrictedTraverse(container_path[:-1])
1012 1013 1014 1015 1016
              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)
1017 1018
            else:
              raise
1019
          saved_uid_dict = {}
1020
          subobjects_dict = {}
Julien Muchembled's avatar
Julien Muchembled committed
1021
          portal_type_dict = {}
1022
          old_obj = container._getOb(object_id, None)
1023
          object_existed = old_obj is not None
1024
          if old_obj is not None:
1025
            # Object already exists
1026
            recurse(saveHook, old_obj)
1027
            if getattr(aq_base(old_obj), 'groups', None) is not None:
1028 1029 1030 1031 1032
              # 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)
1033
            subobjects_dict = self._backupObject(action, trashbin,
1034
                                                 container_path, object_id)
Julien Muchembled's avatar
Julien Muchembled committed
1035
            # in case of portal types, we want to keep some properties
1036
            if getattr(old_obj, 'meta_type', None) == 'ERP5 Base Type':
1037
              for attr in ('allowed_content_types',
Julien Muchembled's avatar
Julien Muchembled committed
1038 1039 1040 1041 1042 1043
                           '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, '')
1044
            container.manage_delObjects([object_id])
1045

1046
          # install object
1047
          obj = self._objects[path]
1048 1049 1050 1051
          # XXX Following code make Python Scripts compile twice, because
          #     _getCopy returns a copy without the result of the compilation.
          #     A solution could be to add a specific _getCopy method to
          #     Python Scripts.
1052
          if getattr(aq_base(obj), 'groups', None) is not None:
1053
            # we must keep original order groups
1054
            # because they change when we add subobjects
1055
            groups[path] = deepcopy(obj.groups)
1056
          # copy the object
1057 1058 1059 1060 1061 1062 1063
          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
1064
                'Cleaning corrupted BTreeFolder2 object at %r.' % (path,))
1065
            obj._initBTrees()
1066
          obj = obj._getCopy(container)
1067
          self.removeProperties(obj, 0)
1068 1069 1070 1071 1072
          try:
            container._setObject(object_id, obj)
          except AttributeError:
            LOG("BT, install", 0, object_id)
            raise
1073
          obj = container._getOb(object_id)
1074 1075 1076 1077 1078

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

1079 1080
          # mark a business template installation so in 'PortalType_afterClone' scripts
          # we can implement logical for reseting or not attributes (i.e reference).
1081
          self.REQUEST.set('is_business_template_installation', 1)
1082 1083 1084 1085
          # 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
1086
          obj.isIndexable = ConstantGetter('isIndexable', value=False)
1087
          obj.manage_afterClone(obj)
1088 1089 1090
          del obj.isIndexable
          if getattr(aq_base(obj), 'reindexObject', None) is not None:
            obj.reindexObject()
1091
          obj.wl_clearLocks()
Julien Muchembled's avatar
Julien Muchembled committed
1092
          if portal_type_dict:
1093
            # set workflow chain
Julien Muchembled's avatar
Julien Muchembled committed
1094
            wf_chain = portal_type_dict.pop('workflow_chain')
1095 1096
            chain_dict = getChainByType(context)[1]
            default_chain = ''
1097
            chain_dict['chain_%s' % (object_id)] = wf_chain
1098
            context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict)
Julien Muchembled's avatar
Julien Muchembled committed
1099 1100
            # restore some other properties
            obj.__dict__.update(portal_type_dict)
1101
          # import sub objects if there is
Julien Muchembled's avatar
Julien Muchembled committed
1102
          if subobjects_dict:
1103
            # get a jar
1104 1105
            connection = obj._p_jar
            o = obj
1106
            while connection is None:
1107 1108
              o = o.aq_parent
              connection = o._p_jar
1109
            # import subobjects
1110
            for subobject_id, subobject_data in subobjects_dict.iteritems():
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
              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))
1122
          if obj.meta_type in ('Z SQL Method',):
1123
            fixZSQLMethod(portal, obj)
1124 1125 1126
          # portal transforms specific initialization
          elif obj.meta_type in ('Transform', 'TransformsChain'):
            assert container.meta_type == 'Portal Transforms'
1127 1128 1129
            # skip transforms that couldn't have been initialized
            if obj.title != 'BROKEN':
              container._mapTransform(obj)
1130
          elif obj.meta_type in ('ERP5 Ram Cache',
1131
                                 'ERP5 Distributed Ram Cache',):
1132 1133
            assert container.meta_type == 'ERP5 Cache Factory'
            container.getParentValue().updateCache()
1134 1135
          elif (container.meta_type == 'CMF Skins Tool') and \
              (old_obj is not None):
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
            # 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')
1150 1151 1152 1153 1154 1155 1156 1157
          # 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)
1158

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

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

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

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

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

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

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

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1404 1405 1406 1407 1408 1409 1410 1411
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)

1412
  def install(self, context, trashbin, **kw):
1413
    """ When we install a tool that is a type provider not
1414
    registered on types tool, register it into the type provider.
1415
    """
1416 1417 1418 1419
    PathTemplateItem.install(self, context, trashbin, **kw)
    portal = context.getPortalObject()
    types_tool = portal.portal_types
    for type_container_id, obj in self._objects.iteritems():
1420
      if interfaces.ITypeProvider.providedBy(obj) and \
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
          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()
1443
    types_tool = portal.portal_types
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
    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)
1454

1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
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")
1470
    if len(id_list) != 1:
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
      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():
1483
      pref = portal.unrestrictedTraverse(object_path)
1484
      # XXX getPreferenceState is a bad name
1485
      if pref.getPreferenceState() == 'disabled':
1486 1487
        # set safe activities execution order
        original_reindex_parameters = self.setSafeReindexationMode(context)
1488 1489
        portal.portal_workflow.doActionFor(
                      pref,
1490 1491 1492
                      'enable_action',
                      comment="Initialized during Business Template " \
                              "installation.")
1493 1494
        # restore previous activities execution order
        context.setPlacelessDefaultReindexParameters(**original_reindex_parameters) 
1495

1496 1497
class CategoryTemplateItem(ObjectTemplateItem):

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

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

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

1536 1537 1538
  def beforeInstall(self):
    self._installed_new_category = False

1539
  def onNewObject(self, obj):
1540 1541 1542 1543
    self._installed_new_category = True

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

1547 1548
class SkinTemplateItem(ObjectTemplateItem):

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

1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
  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')

1562 1563
  def preinstall(self, context, installed_item, **kw):
    modified_object_list = ObjectTemplateItem.preinstall(self, context, installed_item, **kw)
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
    # 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

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

1588
      # Do not register skin which were explicitely ask not to be installed
1589 1590 1591 1592 1593
      if context.getTemplateFormatVersion() == 1:
        if update_dict.has_key(relative_url) or force:
          if not force:
            if update_dict[relative_url] == 'nothing':
              continue
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609
      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',
          [])
1610 1611 1612
      # Backward compatibility, some values can be string
      if isinstance(selection_list, str):
        selection_list = selection_list.replace(',', ' ').split(' ')
1613
      if skin_selection_id in selection_list:
1614
        self._objects.setdefault(skin_folder_id, []).append(skin_selection_id)
1615
      else:
1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
        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):
1635
    if not self._objects:
1636 1637 1638 1639
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
    # export workflow chain
1640 1641 1642
    bta.addObject(obj=self.generateXml(), 
                  name='registered_skin_selection',  
                  path=root_path)
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657

  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]
1658 1659 1660
        default_value = []
        selection_list = skin_folder.getProperty(
          'business_template_registered_skin_selections', default_value)
1661

1662
        if selection_list is default_value:
1663
          create_property = True
1664
          selection_list = self._objects[skin_folder_id]
1665
        else:
1666
          create_property = False
1667 1668 1669 1670 1671
          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])
1672 1673

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

        unregisterSkinFolder(skin_tool, skin_folder,
1685
                             skin_tool.getSkinSelections())
1686
        registerSkinFolder(skin_tool, skin_folder)
1687 1688

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

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

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

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

      current_selection_list = list(current_selection_set)
      if current_selection_list:
1712
        skin_folder._updateProperty(
1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726
            '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)

1727
  def preinstall(self, context, installed_item, **kw):
1728 1729 1730 1731 1732
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      new_dict = PersistentMapping()
      for path in new_keys:
1733
        if installed_item._objects.has_key(path):
1734 1735
          # compare object to see it there is changes
          new_object = self._objects[path]
1736
          old_object = installed_item._objects[path]
1737 1738 1739 1740 1741
          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
1742
      old_keys = installed_item._objects.keys()
1743 1744 1745 1746 1747 1748 1749
      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'):
1750
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
1751 1752 1753 1754
      return
    # import workflow chain for portal_type
    skin_selection_dict = {}
    xml = parse(file)
1755 1756 1757
    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
1758 1759
      if not selection_string:
        selection_list = []
1760
      else:
1761 1762
        selection_list = selection_string.split(',')
      skin_selection_dict[skin_folder_id] = selection_list
1763
    self._objects = skin_selection_dict
1764 1765


1766
class WorkflowTemplateItem(ObjectTemplateItem):
1767

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

1771 1772 1773 1774 1775
  # 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.

1776
  def preinstall(self, context, installed_item, installed_bt, **kw):
1777
    modified_object_dict = ObjectTemplateItem.preinstall(self, context,
1778
                                                         installed_item, **kw)
1779 1780 1781 1782
    modified_workflow_dict = {}
    for modified_object, state in modified_object_dict.iteritems():
      path = modified_object.split('/')
      if len(path) > 2:
1783
        modified_workflow_dict.setdefault('/'.join(path[:2]), ('Modified', state[1]))
1784 1785
      else:
        modified_workflow_dict[modified_object] = state
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807
    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])
1808 1809
    return modified_workflow_dict

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

1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
  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)
1863

1864 1865
class PortalTypeTemplateItem(ObjectTemplateItem):

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

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

1880
      obj = obj._getCopy(context)
1881
      obj._p_activate()
1882
      for attr in obj.__dict__.keys():
1883 1884 1885 1886 1887 1888 1889 1890
        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)
1891 1892
      self._objects[relative_url] = obj
      obj.wl_clearLocks()
1893

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

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

1941
class PortalTypeWorkflowChainTemplateItem(BaseTemplateItem):
1942

1943 1944 1945
  _chain_string_prefix = 'chain_'
  _chain_string_separator = ', '

1946
  def build(self, context, **kw):
1947 1948 1949 1950 1951
    # 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
1952
    p = context.getPortalObject()
1953
    (default_chain, chain_dict) = getChainByType(context)
Aurel's avatar
Aurel committed
1954
    for key in self._archive.keys():
1955 1956 1957
      wflist = key.split(' | ')
      if len(wflist) == 2:
        portal_type = wflist[0]
Aurel's avatar
Aurel committed
1958
        workflow = wflist[1]
1959
      else:
1960
        # portal type with no workflow defined
Aurel's avatar
Aurel committed
1961
        portal_type = wflist[0][:-2]
1962
        workflow = ''
1963 1964 1965 1966 1967
      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):
1968
          if not self.is_bt_for_diff:
1969 1970 1971
            # 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
1972
            LOG('BusinessTemplate', WARNING, 'workflow %s not found '\
1973
                       'in chain for portal_type %s' % (workflow_name, portal_type))
1974
        self._objects.setdefault(portal_type, []).append(workflow)
1975
      elif not self.is_bt_for_diff:
1976
        raise NotFound, 'No workflow chain found for portal type %s. This '\
Vincent Pelletier's avatar
Vincent Pelletier committed
1977
                        'is probably a sign of a missing dependency.'\
1978
                                                    % portal_type
1979

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

  def export(self, context, bta, **kw):
1996
    if not self._objects:
1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008
      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
2009
    (default_chain, chain_dict) = getChainByType(context)
2010
    # First convert all workflow_ids into list.
2011 2012
    for key, value in chain_dict.iteritems():
      chain_dict[key] = value.split(self._chain_string_separator)
2013
    # Set the default chain to the empty string is probably the
Christophe Dumez's avatar
Christophe Dumez committed
2014
    # best solution, by default it is 'default_workflow', which is
2015 2016
    # not very usefull
    default_chain = ''
2017 2018
    for path in self._objects:
      if path in update_dict or force:
2019 2020 2021
        if not force:
          action = update_dict[path]
          if action == 'nothing':
2022
            continue
Jérome Perrin's avatar
Jérome Perrin committed
2023 2024
        path_splitted = path.split('/', 1)
        # XXX: to avoid crashing when no portal_type
2025
        if not path_splitted:
Jérome Perrin's avatar
Jérome Perrin committed
2026
          continue
2027
        portal_type = path_splitted[-1]
2028 2029
        chain_key = '%s%s' % (self._chain_string_prefix, portal_type)
        if chain_key in chain_dict:
Aurel's avatar
Aurel committed
2030
          # XXX we don't use the chain (Default) in erp5 so don't keep it
2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050
          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)
2051
            # create the new chain
2052 2053
            chain_dict[chain_key] = list(old_chain_workflow_id_set)
          if not workflow_id_list:
Romain Courteaud's avatar
Romain Courteaud committed
2054 2055
            # Check if it has normally to remove a workflow chain, in order to
            # improve the error message
2056
            for wf_id in self._objects[path]:
Romain Courteaud's avatar
Romain Courteaud committed
2057 2058 2059
              if wf_id.startswith('-'):
                raise ValueError, '"%s" is not a workflow ID for %s' % \
                                  (wf_id, portal_type)
2060
            chain_dict[chain_key] = self._objects[path]
Aurel's avatar
Aurel committed
2061
        else:
2062
          if context.portal_types.getTypeInfo(portal_type) is None:
2063
            raise ValueError('Cannot chain workflow %r to non existing '
2064 2065 2066 2067 2068
                           '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.
2069 2070
    for key, value in chain_dict.iteritems():
      chain_dict[key] =  self._chain_string_separator.join(value)
2071 2072
    context.portal_workflow.manage_changeWorkflows(default_chain,
                                                   props=chain_dict)
2073

2074 2075
  def uninstall(self, context, **kw):
    (default_chain, chain_dict) = getChainByType(context)
2076 2077
    object_path = kw.get('object_path', None)
    if object_path is not None:
2078
      object_key_list = [object_path]
2079
    else:
2080 2081 2082
      object_key_list = self._objects.keys()
    for object_key in object_key_list:
      path_splitted = object_key.split('/', 1)
2083 2084 2085
      if len(path_splitted) < 2:
        continue
      portal_type = path_splitted[1]
2086 2087 2088 2089 2090 2091 2092 2093 2094 2095
      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]
2096
        else:
2097 2098 2099 2100
          chain_dict[path] = self._chain_string_separator.\
                                                  join(workflow_id_list)
    context.getPortalObject().portal_workflow.\
                                   manage_changeWorkflows('', props=chain_dict)
2101

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

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

2153 2154
# just for backward compatibility
PortalTypeTemplateWorkflowChainItem = PortalTypeWorkflowChainTemplateItem
2155

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

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

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

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

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

2241
  def _importFile(self, file_name, file):
2242
    if not file_name.endswith('.xml'):
2243
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
2244
      return
2245
    path, name = posixpath.split(file_name)
2246
    xml = parse(file)
2247
    portal_type_list = xml.findall('portal_type')
2248
    for portal_type in portal_type_list:
2249 2250
      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
2251
      if self.class_property not in id:
2252 2253 2254 2255
        key = '%s/%s' % (self.class_property, id,)
      else:
        key = id
      self._objects[key] = item_type_list
2256 2257

  def install(self, context, trashbin, **kw):
Nicolas Delaby's avatar
Nicolas Delaby committed
2258 2259
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2260 2261
    update_dict = kw.get('object_to_update')
    force = kw.get('force')
2262 2263 2264 2265 2266 2267 2268
    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
2269
      if key in update_dict or force:
2270 2271 2272 2273
        if not force:
          action = update_dict[key]
          if action == 'nothing':
            continue
2274 2275 2276
        portal_id = key.split('/')[-1]
        type_information = types_tool.getTypeInfo(portal_id)
        if type_information is None:
2277 2278
          raise AttributeError, "Portal type '%s' not found while " \
              "installing %s" % (portal_id, self.getTitle())
2279 2280
        property_list = self._objects.get(key, [])
        old_property_list = old_objects.get(key, ())
2281
        object_property_list = getattr(type_information, self.class_property, ())
Nicolas Delaby's avatar
Nicolas Delaby committed
2282 2283 2284 2285 2286 2287 2288 2289 2290
        # 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)
2291
        setattr(type_information, self.class_property, tuple(property_list))
2292

Aurel's avatar
Aurel committed
2293
  def uninstall(self, context, **kw):
2294
    object_path = kw.get('object_path', None)
Nicolas Delaby's avatar
Nicolas Delaby committed
2295 2296
    portal = context.getPortalObject()
    types_tool = getToolByName(portal, 'portal_types')
2297
    if object_path is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
2298
      object_key_list = [object_path]
2299
    else:
Nicolas Delaby's avatar
Nicolas Delaby committed
2300 2301
      object_key_list = self._objects.keys()
    for key in object_key_list:
2302 2303 2304 2305 2306
      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,))
2307 2308
        continue
      property_list = self._objects[key]
2309
      original_property_list = list(getattr(type_information,
2310
                                    self.class_property, ()))
Aurel's avatar
Aurel committed
2311 2312
      for id in property_list:
        if id in original_property_list:
2313
          original_property_list.remove(id)
2314
      setattr(type_information, self.class_property, tuple(original_property_list))
2315

2316

2317 2318
class PortalTypeHiddenContentTypeTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2319
  name = 'Hidden Content Type'
2320 2321
  xml_tag = 'hidden_content_type_list'
  class_property = 'hidden_content_type_list'
2322
  business_template_class_property = '_portal_type_hidden_content_type_item'
2323

2324

2325 2326
class PortalTypePropertySheetTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2327
  name = 'Property Sheet'
2328 2329
  xml_tag = 'property_sheet_list'
  class_property = 'property_sheet_list'
2330
  business_template_class_property = '_portal_type_property_sheet_item'
2331

2332

2333 2334
class PortalTypeBaseCategoryTemplateItem(PortalTypeAllowedContentTypeTemplateItem):

2335
  name = 'Base Category'
2336 2337
  xml_tag = 'base_category_list'
  class_property = 'base_category_list'
2338
  business_template_class_property = '_portal_type_base_category_item'
2339

2340

2341
class CatalogMethodTemplateItem(ObjectTemplateItem):
2342
  """Template Item for catalog methods.
2343

2344 2345 2346 2347 2348
    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.
  """
2349

2350 2351
  def __init__(self, id_list, tool_id='portal_catalog', **kw):
    ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw)
2352
    # a mapping to store properties of methods.
2353 2354 2355 2356 2357
    # 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()
2358

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

2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376
  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

2377 2378
  def build(self, context, **kw):
    ObjectTemplateItem.build(self, context, **kw)
2379

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

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

2389 2390
    for obj in self._objects.values():
      method_id = obj.id
2391 2392
      self._method_properties[method_id] = self._extractMethodProperties(
                                                          catalog, method_id)
2393 2394 2395 2396 2397 2398
      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]
2399

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

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

2429 2430 2431
  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))
2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457
    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)

2458 2459
  def install(self, context, trashbin, **kw):
    ObjectTemplateItem.install(self, context, trashbin, **kw)
2460
    catalog = _getCatalogValue(self)
2461 2462 2463 2464 2465 2466 2467
    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)
2468

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

    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':
2489
              continue
2490 2491 2492 2493
          if new_bt_format:
            values.append(self._objects[key])
          else:
            values.append(self._archive[key])
2494

2495 2496
    for obj in values:
      method_id = obj.id
2497

2498 2499 2500 2501 2502 2503
      # 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
2504
          elif isinstance(old_value, (list, tuple)):
2505 2506 2507 2508
            if method_id not in old_value:
              new_value = list(old_value) + [method_id]
              new_value.sort()
              setattr(catalog, key, tuple(new_value))
2509

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

2532 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
      # 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)
2558

2559 2560 2561 2562 2563 2564
        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)
2565

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

2572 2573 2574 2575
    values = []
    object_path = kw.get('object_path', None)
    # get required values
    if object_path is None:
2576 2577 2578 2579
      if context.getTemplateFormatVersion() == 1:
        values = self._objects.values()
      else:
        values = self._archive.values()
2580
    else:
2581
      try:
2582 2583 2584 2585
        if context.getTemplateFormatVersion() == 1:
          value = self._objects[object_path]
        else:
          value = self._archive[object_path]
2586 2587
      except KeyError:
        value = None
2588 2589
      if value is not None:
        values.append(value)
2590
    for obj in values:
2591
      method_id = obj.id
2592 2593 2594 2595 2596 2597 2598 2599 2600
      # 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)
2601

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

2605
    # uninstall objects
2606
    ObjectTemplateItem.uninstall(self, context, **kw)
2607

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

2646
class ActionTemplateItem(ObjectTemplateItem):
2647 2648

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

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

      "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

2677 2678 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
  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
2710
    if interfaces.ITypeProvider.providedBy(obj.getParentValue()):
2711 2712 2713 2714
      return self._getPortalTypeActionCopy(obj, value)
    else:
      return self._getPortalToolActionCopy(obj, context, value)

2715 2716 2717 2718
  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
    for id in self._archive.keys():
2719 2720 2721
      url, value = id.split(' | ')
      url = posixpath.split(url)
      obj = p.unrestrictedTraverse(url)
2722
      # normalize url
2723 2724 2725 2726 2727
      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]
2728 2729
      action = self._getActionCopy(obj, context, value)
      if action is None:
2730 2731 2732
        if self.is_bt_for_diff:
          continue
        raise NotFound('Action %r not found' % id)
2733
      key = posixpath.join(url[-2], url[-1], value)
2734
      self._objects[key] = self.removeProperties(action, 1)
2735
      self._objects[key].wl_clearLocks()
Aurel's avatar
Aurel committed
2736

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

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

Julien Muchembled's avatar
Julien Muchembled committed
2759 2760
          # Following code is for actions outside Types Tool.
          # It will be removed when they are also converted to ERP5 actions.
2761 2762 2763
          try:
            from Products.CMFCore.interfaces import IActionProvider
          except ImportError:
2764
              # BACK:
2765 2766 2767 2768 2769 2770 2771 2772
              # 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,
2773
                  'Redirected action import',
2774 2775 2776 2777
                  '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
2778
          obj, action = container, obj
2779
          action_list = obj.listActions()
2780
          for index in range(len(action_list)):
2781
            if action_list[index].id == id:
2782
              # remove previous action
2783
              obj.deleteActions(selections=(index,))
2784 2785 2786
          action_text = action.action
          if isinstance(action_text, Expression):
            action_text = action_text.text
2787
          obj.addAction(
2788
                        id = action.id
2789
                      , title = action.title
2790
                      , action = action_text
2791 2792 2793 2794
                      , condition = action.getCondition()
                      , permission = action.permissions
                      , category = action.category
                      , visible = action.visible
2795 2796
                      , icon = getattr(action, 'icon', None)\
                                and action.icon.text or ''
2797
                      , priority = action.priority
2798
                      , description = action.description
Aurel's avatar
Aurel committed
2799
                    )
2800
          # sort action based on the priority define on it
2801 2802 2803 2804 2805 2806 2807 2808 2809
          # 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))
2810 2811
      for path, action_dict in portal_type_dict.iteritems():
        container = p.unrestrictedTraverse(path)
2812
        container.manage_delObjects([obj.id
2813
          for obj in container.getActionInformationList()
2814
          if obj.getReference() in action_dict])
2815 2816
        for obj in action_dict.itervalues():
          container._importOldAction(obj)
Aurel's avatar
Aurel committed
2817
    else:
2818
      BaseTemplateItem.install(self, context, trashbin, **kw)
Aurel's avatar
Aurel committed
2819
      p = context.getPortalObject()
2820 2821
      for id in self._archive.keys():
        action = self._archive[id]
Aurel's avatar
Aurel committed
2822
        relative_url, key, value = self._splitPath(id)
2823 2824
        obj = p.unrestrictedTraverse(relative_url)
        for ai in obj.listActions():
Aurel's avatar
Aurel committed
2825
          if getattr(ai, key) == value:
2826
            raise TemplateConflictError, 'the portal type %s already has the action %s' % (obj.id, value)
2827 2828 2829
        action_text = action.action
        if isinstance(action_text, Expression):
          action_text = action_text.text
2830
        obj.addAction(
Aurel's avatar
Aurel committed
2831 2832
                      id = action.id
                    , name = action.title
2833
                    , action = action_text
Aurel's avatar
Aurel committed
2834 2835 2836 2837
                    , condition = action.getCondition()
                    , permission = action.permissions
                    , category = action.category
                    , visible = action.visible
2838 2839
                    , icon = getattr(action, 'icon', None) \
                                      and action.icon.text or ''
Aurel's avatar
Aurel committed
2840
                    )
Aurel's avatar
Aurel committed
2841 2842 2843 2844 2845 2846 2847
        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))
2848 2849
          obj.moveDownActions(selections=tuple(move_down_list))

2850 2851
  def uninstall(self, context, **kw):
    p = context.getPortalObject()
2852 2853
    object_path = kw.get("object_path", None)
    if object_path is not None:
2854 2855 2856 2857 2858 2859 2860 2861
      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]
2862
    else:
2863
      keys = self._archive.keys()
2864
    for id in keys:
2865 2866
      if  '|' in id:
        relative_url, value = id.split(' | ')
2867 2868 2869
        obj = p.unrestrictedTraverse(relative_url, None)
        # Several tools still use CMF actions
        if obj is not None:
2870
          is_new_action = interfaces.ITypeProvider.providedBy(obj.getParentValue())
2871
          key = is_new_action and 'reference' or 'id'
2872
      else:
2873
        relative_url, key, value = self._splitPath(id)
2874
        obj = p.unrestrictedTraverse(relative_url, None)
2875 2876 2877
      if obj is not None:
        action_list = obj.listActions()
        for index in range(len(action_list)):
2878
          if getattr(action_list[index], key, None) == value:
2879 2880
            obj.deleteActions(selections=(index,))
            break
2881 2882
      LOG('BusinessTemplate', WARNING,
          'Unable to uninstall action at %s, ignoring' % relative_url )
2883 2884
    BaseTemplateItem.uninstall(self, context, **kw)

2885 2886 2887
class PortalTypeRolesTemplateItem(BaseTemplateItem):

  def __init__(self, id_list, **kw):
2888
    id_list = ['portal_type_roles/%s' % id for id in id_list if id != '']
2889 2890 2891 2892 2893 2894 2895
    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])
2896 2897
      # normalize url
      relative_url = '%s/%s' % (obj.getPhysicalPath()[-2:])
2898
      self._objects[relative_url] = type_role_list = []
2899
      for role in obj.getRoleInformationList():
2900
        type_role_dict = {}
2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917
        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
2918
        type_role_list.append(type_role_dict)
2919
      type_role_list.sort(key=lambda x: (x.get('title'), x['object_id'],))
2920

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

2947 2948 2949 2950 2951 2952 2953
  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)
2954 2955
      if isinstance(xml_data, unicode):
        xml_data = xml_data.encode('utf-8')
2956 2957 2958 2959
      name = key.split('/', 1)[1]
      bta.addObject(obj=xml_data, name=name, path=root_path)

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

  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
3002 3003 3004
        path = 'portal_types/%s' % roles_path.split('/', 1)[1]
        obj = p.unrestrictedTraverse(path, None)
        if obj is not None:
3005
          # reset roles before applying
3006
          obj.manage_delObjects([x.id for x in obj.getRoleInformationList()])
3007
          type_roles_list = self._objects[roles_path] or []
3008 3009
          for role_property_dict in type_roles_list:
            obj._importRole(role_property_dict)
3010 3011 3012
        else:
          raise AttributeError("Path '%r' not found while "
                               "installing roles" % (path, ))
3013 3014 3015

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
Aurel's avatar
Aurel committed
3016 3017 3018 3019 3020 3021
    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:
3022
      path = 'portal_types/%s' % roles_path.split('/', 1)[1]
3023 3024 3025 3026 3027
      try:
        obj = p.unrestrictedTraverse(path)
        setattr(obj, '_roles', [])
      except (NotFound, KeyError):
        pass
3028

3029 3030 3031 3032 3033 3034
class SitePropertyTemplateItem(BaseTemplateItem):

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

3046 3047
  def _importFile(self, file_name, file):
    # recreate list of site property from xml file
3048
    if not file_name.endswith('.xml'):
3049
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
3050
      return
3051
    xml = parse(file)
3052 3053 3054 3055 3056 3057 3058 3059 3060
    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)
3061

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

  def uninstall(self, context, **kw):
    p = context.getPortalObject()
3099 3100 3101 3102 3103 3104
    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:
3105 3106 3107 3108
      if p.hasProperty(id):
        p._delProperty(id)
    BaseTemplateItem.uninstall(self, context, **kw)

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

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

3140 3141 3142 3143 3144
class ModuleTemplateItem(BaseTemplateItem):

  def build(self, context, **kw):
    BaseTemplateItem.build(self, context, **kw)
    p = context.getPortalObject()
3145 3146 3147 3148 3149 3150
    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()
3151
      permission_list = []
3152
      mapping['permission_list'] = module.showPermissions()
3153
      mapping['category_list'] = module.getCategoryList()
3154
      self._objects[module_id] = mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3155

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

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

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

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

  def _importFile(self, file_name, file):
3246 3247 3248
    if not file_name.endswith('.xml'):
      LOG('Business Template', 0, 'Skipping file "%s"' % (file_name, ))
      return
3249
    mapping = {}
3250
    xml = parse(file)
3251
    for key in ('portal_type', 'id', 'title', 'permission_list'):
3252
      key_node = xml.find(key)
3253
      if key == 'permission_list':
3254 3255 3256 3257 3258 3259 3260
        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))
3261
          else:
3262 3263 3264
            perm_tuple = (name, tuple(role_list))
          permission_list.append(perm_tuple)
        mapping[key] = permission_list
3265
      else:
3266
        mapping[key] = key_node.text or ''
3267 3268

    category_list = []
3269 3270 3271 3272
    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'))
3273 3274
    mapping['category_list'] = category_list

3275
    self._objects[file_name[:-4]] = mapping
3276

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

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

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

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

3316
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3317 3318
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3319
      new_keys = self._objects.keys()
3320
      # fix key if necessary in installed bt for diff
3321
      extra_prefix = self.__class__.__name__ + '/'
3322
      for key in installed_item._objects.keys():
3323 3324 3325 3326
        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]
3327
      for path in new_keys:
3328
        if installed_item._objects.has_key(path):
3329 3330
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3331
          old_obj_code = installed_item._objects[path]
3332
          if new_obj_code != old_obj_code:
3333 3334
            modified_object_list.update(
                {path : ['Modified', self.__class__.__name__[:-12]]})
3335
        else: # new object
3336 3337
          modified_object_list.update(
                {path : ['New', self.__class__.__name__[:-12]]})
3338
          # get removed object
3339
      old_keys = installed_item._objects.keys()
3340 3341
      for path in old_keys:
        if path not in new_keys:
3342 3343
          modified_object_list.update(
                {path : ['Removed', self.__class__.__name__[:-12]]})
3344 3345 3346 3347 3348
    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
3349
    if context.getTemplateFormatVersion() == 1:
Aurel's avatar
Aurel committed
3350
      for id in self._objects.keys():
3351 3352 3353 3354 3355 3356
        if update_dict.has_key(id) or force:
          if not force:
            action = update_dict[id]
            if action == 'nothing':
              continue
          text = self._objects[id]
3357
          path, name = posixpath.split(id)
3358 3359
          # This raises an exception if the file already exists.
          try:
3360
            self.local_file_writer_name(name, text, create=0)
3361
          except IOError, error:
3362
            LOG("BusinessTemplate.py", WARNING, "Cannot install class %s on file system" %(name,))
3363
            if error.errno:
3364
              raise
3365 3366
            continue
          if self.local_file_importer_name is not None:
3367
            # before any import, flush all ZODB caches to force a DB reload
3368 3369 3370 3371 3372 3373 3374 3375 3376
            # 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()
3377
            gc.collect()
3378
            self.local_file_importer_name(name)
Aurel's avatar
Aurel committed
3379
    else:
3380 3381 3382
      BaseTemplateItem.install(self, context, trashbin, **kw)
      for id in self._archive.keys():
        text = self._archive[id]
Aurel's avatar
Aurel committed
3383
        # This raises an exception if the file exists.
3384
        self.local_file_writer_name(id, text, create=1)
Aurel's avatar
Aurel committed
3385
        if self.local_file_importer_name is not None:
3386
          self.local_file_importer_name(id)
3387 3388

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

Aurel's avatar
Aurel committed
3398 3399 3400 3401 3402
  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)
3403 3404 3405 3406 3407 3408 3409
    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
3410

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

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

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

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

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

Aurel's avatar
Aurel committed
3444

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

class RoleTemplateItem(BaseTemplateItem):

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

3455
  def preinstall(self, context, installed_item, **kw):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3456 3457
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
3458
      new_roles = self._objects.keys()
3459 3460 3461 3462 3463 3464
      # 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]
3465
      for role in new_roles:
3466
        if installed_item._objects.has_key(role):
3467 3468 3469 3470
          continue
        else: # only show new roles
          modified_object_list.update({role : ['New', 'Role']})
      # get removed roles
3471
      old_roles = installed_item._objects.keys()
3472 3473 3474 3475 3476 3477
      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):
3478
    p = context.getPortalObject()
3479
    # get roles
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3480
    if context.getTemplateFormatVersion() == 1:
3481
      role_set = set(self._objects)
3482
    else:
3483
      role_set = set(self._archive)
3484 3485 3486 3487
    # 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:
3488 3489
        for role in role_set.difference(role_manager.listRoleIds()):
          role_manager.addRole(role)
3490
    # set roles on portal
3491
    p.__ac_roles__ = tuple(role_set.union(p.__ac_roles__))
3492 3493

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

  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)

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

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

Aurel's avatar
Aurel committed
3535
  def export(self, context, bta, **kw):
3536
    if len(self._objects) == 0:
Aurel's avatar
Aurel committed
3537 3538 3539
      return
    path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=path)
3540 3541 3542 3543 3544 3545 3546 3547 3548
    # 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)
3549

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3701 3702 3703 3704 3705
# 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'
3706

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

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

# topic
3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738
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'
3739

3740 3741 3742 3743
class MessageTranslationTemplateItem(BaseTemplateItem):

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

3757
  def preinstall(self, context, installed_item, **kw):
3758 3759 3760 3761
    modified_object_list = {}
    if context.getTemplateFormatVersion() == 1:
      new_keys = self._objects.keys()
      for path in new_keys:
3762
        if installed_item._objects.has_key(path):
3763 3764
          # compare object to see if there is changes
          new_obj_code = self._objects[path]
3765
          old_obj_code = installed_item._objects[path]
3766 3767 3768 3769 3770
          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
3771
      old_keys = installed_item._objects.keys()
3772 3773 3774 3775 3776
      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

3777 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
  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', {})
3805 3806
    force = kw.get('force')
    if context.getTemplateFormatVersion() == 1:
3807 3808
      for key in sorted(self._objects.keys()):
        if update_dict.has_key(key) or force:
3809
          if not force:
3810
            action = update_dict[key]
3811
            if action == 'nothing':
3812
              continue
3813
          lang, catalog = self._splitKey(key)
3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829

          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)
3830 3831
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
3832 3833 3834 3835
          else:
            po = self._objects[key]
            if lang not in localizer.get_languages():
              localizer.manage_addLanguage(lang)
3836
            self._importCatalogLanguage(localizer, catalog, lang, po)
3837 3838
    else:
      BaseTemplateItem.install(self, context, trashbin, **kw)
3839
      for lang, catalogs in self._archive.iteritems():
3840 3841 3842
        if lang not in localizer.get_languages():
          localizer.manage_addLanguage(lang)
        for catalog, po in catalogs.items():
3843 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
          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)
3873 3874

  def export(self, context, bta, **kw):
3875
    if len(self._objects) == 0:
3876 3877 3878
      return
    root_path = os.path.join(bta.path, self.__class__.__name__)
    bta.addFolder(name=root_path)
3879
    for key, obj in self._objects.iteritems():
3880 3881
      path = os.path.join(root_path, key)
      bta.addFolder(name=path)
3882 3883 3884 3885 3886 3887 3888 3889
      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'))
3890 3891

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

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

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

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

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

Aurel's avatar
Aurel committed
3932 3933 3934 3935 3936 3937 3938 3939
  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)

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

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

  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
3975 3976
        path = roles_path.split('/')[1:]
        obj = p.unrestrictedTraverse(path)
3977
        local_roles_dict = self._objects[roles_path][0]
3978
        setattr(obj, '__ac_local_roles__', local_roles_dict)
3979
        obj.reindexObject()
Aurel's avatar
Aurel committed
3980

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

3993 3994 3995
class BusinessTemplate(XMLObject):
    """
    A business template allows to construct ERP5 modules
Christophe Dumez's avatar
Christophe Dumez committed
3996
    in part or completely. Each object is separated from its
3997 3998 3999 4000 4001 4002 4003 4004 4005 4006
    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
4007 4008
      - object without optimal actions
      - list of relation between portal type and workflow
4009 4010 4011 4012 4013 4014 4015 4016 4017 4018

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

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

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

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

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

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

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

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

    Use case:

    - install core ERP5 (the minimum)
4040

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

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

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

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

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

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

4083 4084
    # This is a global variable
    # Order is important for installation
4085 4086 4087 4088 4089 4090
    # 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 )
4091 4092
    _item_name_list = [
      '_product_item',
4093
      '_property_sheet_item',
4094
      '_constraint_item',
4095 4096 4097 4098
      '_document_item',
      '_extension_item',
      '_test_item',
      '_role_item',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4099
      '_tool_item',
4100 4101 4102 4103
      '_message_translation_item',
      '_workflow_item',
      '_site_property_item',
      '_portal_type_item',
4104
      '_portal_type_workflow_chain_item',
4105 4106 4107 4108
      '_portal_type_allowed_content_type_item',
      '_portal_type_hidden_content_type_item',
      '_portal_type_property_sheet_item',
      '_portal_type_base_category_item',
4109 4110
      '_category_item',
      '_module_item',
4111
      '_path_item',
4112
      '_skin_item',
4113
      '_registered_skin_selection_item',
4114
      '_preference_item',
4115
      '_action_item',
4116
      '_portal_type_roles_item',
4117
      '_local_roles_item',
4118
      '_catalog_method_item',
4119 4120 4121
      '_catalog_result_key_item',
      '_catalog_related_key_item',
      '_catalog_result_table_item',
4122
      '_catalog_search_key_item',
4123
      '_catalog_keyword_key_item',
4124
      '_catalog_datetime_key_item',
4125 4126 4127 4128
      '_catalog_full_text_key_item',
      '_catalog_request_key_item',
      '_catalog_multivalue_key_item',
      '_catalog_topic_key_item',
4129
      '_catalog_scriptable_key_item',
4130 4131
      '_catalog_role_key_item',
      '_catalog_local_role_key_item',
4132 4133 4134 4135
    ]

    def __init__(self, *args, **kw):
      XMLObject.__init__(self, *args, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4136 4137 4138 4139 4140 4141
      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
4142
        self._baseGetTemplateFormatVersion()
4143

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

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

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

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

4173
    def updateRevisionNumber(self):
Jérome Perrin's avatar
Jérome Perrin committed
4174 4175 4176 4177 4178 4179 4180 4181
        """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)
4182

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

4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304
    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()

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

4312
    build = WorkflowMethod(build)
4313 4314

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

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

4327 4328 4329 4330 4331
    def isCatalogUpdatable(self):
      """
      Return if catalog will be updated or not by business template installation
      """
      catalog_method = getattr(self, '_catalog_method_item', None)
4332 4333 4334 4335 4336 4337 4338 4339 4340 4341
      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
4342 4343
      return False

4344
    def preinstall(self, check_dependencies=1, **kw):
4345 4346 4347
      """
        Return the list of modified/new/removed object between a Business Template
        and the one installed if exists
Aurel's avatar
Aurel committed
4348
      """
4349 4350 4351 4352 4353
      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()
4354

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

      #  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)
4364 4365 4366
      if installed_bt is None:
        installed_bt_format = 0 # that will not check for modification
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
4367
        installed_bt_format = installed_bt.getTemplateFormatVersion()
4368

4369
      # if reinstall business template, must compare to object in ZODB
4370
      # and not to those in the installed Business Template because it is itself.
Christophe Dumez's avatar
Christophe Dumez committed
4371
      # same if we make a diff and select only one business template
4372
      reinstall = 0
4373 4374
      if installed_bt == self:
        reinstall = 1
4375
        if self.portal_templates._getOb(INSTALLED_BT_FOR_DIFF, None) is None:
4376 4377
          bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                   id=INSTALLED_BT_FOR_DIFF)
4378 4379 4380 4381 4382 4383 4384
          # 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)
4385

Yoshinori Okuji's avatar
Yoshinori Okuji committed
4386
      new_bt_format = self.getTemplateFormatVersion()
4387 4388 4389 4390 4391 4392
      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:
4393
          item = getattr(self, item_name, None)
4394 4395 4396 4397
          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
4398

4399
      for item_name in self._item_name_list:
4400
        new_item = getattr(self, item_name, None)
4401
        installed_item = getattr(installed_bt, item_name, None)
4402
        if new_item is not None:
4403
          if installed_item is not None and hasattr(installed_item, '_objects'):
4404
            modified_object = new_item.preinstall(context=self, 
4405 4406
                                                  installed_item=installed_item,
                                                  installed_bt=installed_bt)
4407 4408 4409 4410 4411 4412 4413
            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:
4414
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
4415

4416 4417
      return modified_object_list

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

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

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

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

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

4451 4452 4453
      from Products.ERP5.ERP5Site import ERP5Generator
      generator_class = getattr(site, '_generator_class', ERP5Generator)
      gen = generator_class()
4454 4455
      # update activity tool first if necessary
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateTool():
4456 4457 4458 4459 4460 4461
        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)
4462 4463
      if not force:
        if len(object_to_update) == 0:
4464 4465 4466 4467 4468
          # 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():
4469
            LOG('Business Template', 0, 'Updating Business Template Workflows')
4470
            gen.setupWorkflow(site)
4471
          return
4472

4473 4474
      # 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
4475
      if trash_tool is not None and (len(object_to_update) > 0 or len(self.portal_templates) > 1):
4476 4477 4478 4479 4480
        trashbin = trash_tool.newTrashBin(self.getTitle(), self)
      else:
        trashbin = None

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

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

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

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

4519 4520 4521 4522 4523 4524

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

4525
      # check if we have to update business template workflow
4526
      if self.getTitle() == 'erp5_core' and self.getTemplateUpdateBusinessTemplateWorkflow():
4527
        LOG('Business Template', 0, 'Updating Business Template Workflows')
4528 4529 4530 4531 4532
        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)

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

4538 4539
      if update_catalog:
        site.ERP5Site_reindexAll()
4540

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

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

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

4556
    install = WorkflowMethod(install)
4557

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

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

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

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

4597 4598
    uninstall = WorkflowMethod(uninstall)

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

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

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

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

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

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

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

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

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

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

4699 4700 4701 4702 4703 4704 4705
    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
4706 4707 4708 4709 4710 4711 4712
    def getTemplatePathList(self):
      """
      We have to set this method because we want an
      ordered list
      """
      return self._getOrderedList('template_path')

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

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

4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747
    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')

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      self.storeTemplateItemData()
4854

4855 4856
      # Create temporary modules/classes for classes defined by this BT.
      # This is required if the BT contains instances of one of these classes.
4857
      module_id_list = []
4858
      for template_id in self.getTemplateDocumentIdList():
4859 4860 4861
        module_id = 'Products.ERP5Type.Document.' + template_id
        if module_id not in sys.modules:
          module_id_list.append(module_id)
4862
          sys.modules[module_id] = module = imp.new_module(module_id)
4863 4864
          setattr(module, template_id, type(template_id,
            (SimpleItem.SimpleItem,), {'__module__': module_id}))
4865

Aurel's avatar
Aurel committed
4866 4867
      for item_name in self._item_name_list:
        getattr(self, item_name).importFile(bta)
4868

4869 4870
      # Remove temporary modules created above to allow import of real modules
      # (during the installation).
4871 4872
      for module_id in module_id_list:
        del sys.modules[module_id]
4873

4874 4875 4876 4877 4878
    def getItemsList(self):
      """Return list of items in business template
      """
      items_list = []
      for item_name in self._item_name_list:
4879 4880 4881
        item = getattr(self, item_name, None)
        if item is not None:
          items_list.extend(item.getKeys())
4882
      return items_list
4883

4884 4885 4886 4887 4888 4889 4890 4891 4892 4893
    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:
4894
          dependency_couple_list = dependency_couple.strip().split(' ', 1)
4895
          dependency = dependency_couple_list[0]
4896 4897
          if dependency in (None, ''):
            continue
4898 4899
          version_restriction = None
          if len(dependency_couple_list) > 1:
4900
            version_restriction = dependency_couple_list[1]
4901 4902 4903
            if version_restriction.startswith('('):
              # Something like "(>= 1.0rc6)".
              version_restriction = version_restriction[1:-1]
4904 4905 4906
          installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
          if (not self.portal_templates.IsOneProviderInstalled(dependency)) \
             and ((installed_bt is None) \
4907
                  or (version_restriction not in (None, '') and
4908 4909 4910 4911
                     (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)
4912

4913 4914 4915 4916 4917 4918 4919 4920
    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
4921
    def diffObject(self, REQUEST, **kw):
4922 4923
      """
        Make a diff between an object in the Business Template
4924
        and the same in the Business Template installed in the site
4925 4926 4927 4928
      """

      class_name_dict = {
        'Product' : '_product_item',
4929
        'PropertySheet' : '_property_sheet_item',
4930
        'Constraint' : '_constraint_item',
4931 4932 4933 4934 4935 4936 4937 4938 4939
        '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',
4940
        'PortalTypeWorkflowChain' : '_portal_type_workflow_chain_item',
4941 4942 4943 4944
        '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',
4945 4946 4947
        'Category' : '_category_item',
        'Module' : '_module_item',
        'Skin' : '_skin_item',
4948
        'RegisteredSkinSelection' : '_registered_skin_selection_item',
4949
        'Path' : '_path_item',
4950
        'Preference' : '_preference_item',
4951
        'Action' : '_action_item',
4952
        'PortalTypeRoles' : '_portal_type_roles_item',
Aurel's avatar
Aurel committed
4953
        'LocalRoles' : '_local_roles_item',
4954 4955 4956
        'CatalogResultKey' : '_catalog_result_key_item',
        'CatalogRelatedKey' : '_catalog_related_key_item',
        'CatalogResultTable' : '_catalog_result_table_item',
4957
        'CatalogSearchKey' : '_catalog_search_key_item',
4958
        'CatalogKeywordKey' : '_catalog_keyword_key_item',
4959
        'CatalogDateTimeKey' : '_catalog_datetime_key_item',
4960 4961 4962 4963
        '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
4964
        'Tool': '_tool_item',
4965
        'CatalogScriptableKey' : '_catalog_scriptable_key_item',
4966 4967
        'CatalogRoleKey' : '_catalog_role_key_item',
        'CatalogLocalRoleKey' : '_catalog_local_role_key_item',
4968
        }
4969

4970 4971
      object_id = REQUEST.object_id
      object_class = REQUEST.object_class
4972

Christophe Dumez's avatar
Christophe Dumez committed
4973
      # Get objects
4974
      item_name = class_name_dict[object_class]
Aurel's avatar
Aurel committed
4975

4976
      new_bt = self
Christophe Dumez's avatar
Christophe Dumez committed
4977
      # Compare with a given business template
4978
      compare_to_zodb = 0
Aurel's avatar
Aurel committed
4979 4980
      bt2_id = kw.get('compare_with', None)
      if bt2_id is not None:
4981 4982
        if bt2_id == self.getId():
          compare_to_zodb = 1
4983
          installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
4984 4985
        else:
          installed_bt = self.portal_templates._getOb(bt2_id)
Aurel's avatar
Aurel committed
4986 4987 4988
      else:
        installed_bt = self.getInstalledBusinessTemplate(title=self.getTitle())
        if installed_bt == new_bt:
Aurel's avatar
Aurel committed
4989 4990
          compare_to_zodb = 1
      if compare_to_zodb:
4991 4992
        bt2 = self.portal_templates.manage_clone(ob=installed_bt, 
                                                 id=INSTALLED_BT_FOR_DIFF)
Christophe Dumez's avatar
Christophe Dumez committed
4993
        # Update portal types properties to get last modifications
Aurel's avatar
Aurel committed
4994 4995 4996
        bt2.getPortalTypesProperties()
        bt2.edit(description='tmp bt generated for diff')
        installed_bt = bt2
4997

4998 4999
      new_item = getattr(new_bt, item_name)
      installed_item = getattr(installed_bt, item_name)
5000
      if compare_to_zodb:
Aurel's avatar
Aurel committed
5001
        # XXX maybe only build for the given object to gain time
5002
        installed_item.build(self)
5003 5004 5005
      new_object = new_item._objects[object_id]
      installed_object = installed_item._objects[object_id]
      diff_msg = ''
5006

Christophe Dumez's avatar
Christophe Dumez committed
5007
      # Real Zope Objects (can be exported into XML directly by Zope)
5008 5009
      # XXX Bad naming
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item',
5010
                     '_category_item', '_path_item', '_preference_tem',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
5011
                     '_skin_item', '_action_item', '_tool_item', ]
5012

Christophe Dumez's avatar
Christophe Dumez committed
5013
      # Not considered as objects by Zope (will be exported into XML manually)
5014
      # XXX Bad naming
5015 5016 5017 5018
      item_list_2 = ['_site_property_item',
                     '_module_item',
                     '_catalog_result_key_item', 
                     '_catalog_related_key_item',
5019
                     '_catalog_result_table_item',
5020
                     '_catalog_search_key_item',
5021
                     '_catalog_keyword_key_item',
5022
                     '_catalog_datetime_key_item',
5023 5024 5025 5026
                     '_catalog_full_text_key_item',
                     '_catalog_request_key_item',
                     '_catalog_multivalue_key_item',
                     '_catalog_topic_key_item',
5027
                     '_catalog_scriptable_key_item',
5028 5029
                     '_catalog_role_key_item',
                     '_catalog_local_role_key_item',
5030 5031 5032 5033 5034 5035
                     '_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',
5036
                     '_portal_type_workflow_chain_item',]
5037

Christophe Dumez's avatar
Christophe Dumez committed
5038
      # Text objects (no need to export them into XML)
5039
      # XXX Bad naming
5040 5041
      item_list_3 = ['_document_item', '_property_sheet_item',
                     '_constraint_item', '_extension_item',
5042
                     '_test_item', '_message_translation_item',]
5043

5044
      if item_name in item_list_1:
Christophe Dumez's avatar
Christophe Dumez committed
5045 5046 5047
        f1 = StringIO() # for XML export of New Object
        f2 = StringIO() # For XML export of Installed Object
        # Remove unneeded properties
5048 5049
        new_object = new_item.removeProperties(new_object, 1)
        installed_object = installed_item.removeProperties(installed_object, 1)
5050
        # XML Export in memory
5051
        OFS.XMLExportImport.exportXML(new_object._p_jar, new_object._p_oid, f1)
5052 5053
        OFS.XMLExportImport.exportXML(installed_object._p_jar, 
                                      installed_object._p_oid, f2)
5054
        new_obj_xml = f1.getvalue()
5055
        f1.close()
5056 5057 5058 5059
        installed_obj_xml = f2.getvalue()
        f2.close()
        new_ob_xml_lines = new_obj_xml.splitlines()
        installed_ob_xml_lines = installed_obj_xml.splitlines()
5060
        # End of XML export
5061

5062
        # Diff between XML objects
5063 5064
        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
5065
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5066 5067 5068
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5069

5070
      elif item_name in item_list_2:
5071
        # Generate XML code manually
5072 5073
        new_obj_xml = new_item.generateXml(path= object_id)
        installed_obj_xml = installed_item.generateXml(path= object_id)
5074 5075
        new_obj_xml_lines = new_obj_xml.splitlines()
        installed_obj_xml_lines = installed_obj_xml.splitlines()
5076
        # End of XML Code Generation
5077

5078
        # Diff between XML objects
5079 5080
        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
5081
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5082 5083 5084
          diff_msg += '\n'.join(diff_list)
        else:
          diff_msg = 'No diff'
5085

5086
      elif item_name in item_list_3:
5087
        # Diff between text objects
5088 5089 5090 5091
        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
5092
          diff_msg += '\n\nObject %s diff :\n' % (object_id,)
5093 5094
          diff_msg += '\n'.join(diff_list)
        else:
5095
          diff_msg = 'No diff'
5096

5097
      else:
5098
        diff_msg += 'Unsupported file !'
Christophe Dumez's avatar
Christophe Dumez committed
5099

5100
      if compare_to_zodb:
5101
        self.portal_templates.manage_delObjects(ids=[INSTALLED_BT_FOR_DIFF])
5102

5103
      return diff_msg
5104

5105

5106 5107 5108 5109
    def getPortalTypesProperties(self, **kw):
      """
      Fill field about properties for each portal type
      """
5110 5111
      wtool = self.getPortalObject().portal_workflow
      ttool = self.getPortalObject().portal_types
5112 5113 5114 5115 5116 5117 5118
      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 [])
5119 5120
      bt_wf_chain_list = list(getattr(self, 'template_portal_type_workflow_chain', []) or [])

5121
      p = self.getPortalObject()
5122
      for id in bt_portal_types_id_list:
5123 5124
        portal_type = ttool.getTypeInfo(id)
        if portal_type is None:
5125
          continue
Julien Muchembled's avatar
Julien Muchembled committed
5126
        if portal_type.getRoleInformationList():
5127 5128
          if id not in bt_portal_type_roles_list:
            bt_portal_type_roles_list.append(id)
5129

5130 5131 5132 5133
        allowed_content_type_list = []
        hidden_content_type_list = []
        property_sheet_list = []
        base_category_list = []
5134
        action_list = []
5135 5136 5137 5138 5139 5140 5141
        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'):
5142
          base_category_list = portal_type.base_category_list
Julien Muchembled's avatar
Julien Muchembled committed
5143 5144
        for action in portal_type.getActionInformationList():
          action_list.append(action.getReference())
5145

5146 5147 5148 5149
        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)
5150

5151
        for h_id in hidden_content_type_list:
5152 5153 5154
          hidden_id = id+' | '+h_id
          if hidden_id not in bt_hidden_content_type_list:
            bt_hidden_content_type_list.append(hidden_id)
5155

5156 5157 5158 5159
        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)
5160

5161 5162 5163 5164
        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)
5165

5166 5167 5168 5169
        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)
5170

5171
        for workflow_id in [chain for chain in wtool.getChainFor(id)
5172
                                    if chain != '(Default)']:
5173 5174 5175
          wf_id = id+' | '+workflow_id
          if wf_id not in bt_wf_chain_list:
            bt_wf_chain_list.append(wf_id)
5176

5177 5178 5179 5180
      bt_allowed_content_type_list.sort()
      bt_hidden_content_type_list.sort()
      bt_property_sheet_list.sort()
      bt_base_category_list.sort()
5181
      bt_action_list.sort()
5182
      bt_wf_chain_list.sort()
5183

5184 5185 5186 5187 5188 5189 5190
      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)
5191 5192 5193 5194 5195 5196 5197 5198 5199
      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:
5200 5201
        raise TemplateConditionError, 'No module defined in business template'

5202 5203 5204 5205 5206 5207 5208 5209
      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:
5210
          return type_list
5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224

        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():
5225
            type_list.update(getChildPortalType(hidden_ptype_id))
5226
        return type_list
5227

5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 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
      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

5275 5276 5277
# Block acquisition on all _item_name_list properties by setting
# a default class value to None
for key in BusinessTemplate._item_name_list:
5278
  setattr(BusinessTemplate, key, None)
5279

5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306
# 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)
5307

5308 5309 5310 5311 5312 5313 5314 5315

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

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