ERP5Site.py 76.9 KB
Newer Older
1
# -*- coding: utf-8 -*-
2
##############################################################################
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3 4 5 6 7 8 9 10 11 12 13
#
# Copyright (c) 2001 Zope Corporation and Contributors. All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE
#
##############################################################################
14 15
"""
  Portal class
Jean-Paul Smets's avatar
Jean-Paul Smets committed
16 17
"""

18
from Products.ERP5Type import Globals
19
import AccessControl
20
from Products.ERP5Type.Globals import package_home
21

22
from Products.SiteErrorLog.SiteErrorLog import manage_addErrorLog
23
from ZPublisher import BeforeTraverse
Jean-Paul Smets's avatar
Jean-Paul Smets committed
24
from AccessControl import ClassSecurityInfo
25
from Products.CMFDefault.Portal import CMFSite
Jean-Paul Smets's avatar
Jean-Paul Smets committed
26
from Products.CMFCore.utils import getToolByName, _getAuthenticatedUser
27
from Products.ERP5Type import Permissions, PropertySheet, Constraint
Jean-Paul Smets's avatar
Jean-Paul Smets committed
28
from Products.ERP5Type.Core.Folder import FolderMixIn
Jean-Paul Smets's avatar
Jean-Paul Smets committed
29
from Acquisition import aq_base, aq_parent, aq_inner, aq_acquire
30
from Products.ERP5Type import allowClassTool
31 32
from Products.ERP5Type.Accessor.Constant import PropertyGetter as ConstantGetter
from Products.ERP5Type.Cache import caching_instance_method
33
from Products.ERP5Type.Cache import CachingMethod
34 35
from Products.ERP5Type.ERP5Type import ERP5TypeInformation
from Products.ERP5.Document.BusinessTemplate import BusinessTemplate
36
from Products.ERP5Type.Log import log as unrestrictedLog
37
from Products.CMFActivity.Errors import ActivityPendingError
38
import ERP5Defaults
39
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40

41
from zLOG import LOG, INFO
Sebastien Robin's avatar
Sebastien Robin committed
42
from string import join
43
import os, traceback
44
import warnings
45
import transaction
46 47
MARKER = []

48

Jean-Paul Smets's avatar
Jean-Paul Smets committed
49
# Site Creation DTML
50 51 52 53 54 55 56 57 58
manage_addERP5SiteFormDtml = Globals.HTMLFile('dtml/addERP5Site', globals())

def manage_addERP5SiteForm(*args, **kw):
  """
    Make getCatalogStorageList available from inside the dtml.
  """
  kw['getCatalogStorageList'] = getCatalogStorageList
  return manage_addERP5SiteFormDtml(*args, **kw)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
59
# ERP5Site Constructor
60 61 62
def manage_addERP5Site(self,
                       id,
                       title='ERP5',
63 64
                       description='',
                       create_userfolder=1,
65
                       create_activities=True,
66 67 68
                       email_from_address='postmaster@localhost',
                       email_from_name='Portal Administrator',
                       validate_email=0,
69
                       erp5_catalog_storage='',
70 71
                       erp5_sql_connection_type='Z MySQL Database Connection',
                       erp5_sql_connection_string='test test',
72 73
                       erp5_sql_deferred_connection_type=\
                           'Z MySQL Deferred Database Connection',
74 75 76 77 78 79 80 81 82
                       cmf_activity_sql_connection_type= \
                           'Z MySQL Database Connection',
                       cmf_activity_sql_connection_string='test test',
                       light_install=0,
                       reindex=1,
                       RESPONSE=None):
  '''
  Adds a portal instance.
  '''
83
  gen = ERP5Generator()
84
  id = str(id).strip()
85 86
  p = gen.create(self,
                 id,
87
                 create_userfolder,
88
                 erp5_catalog_storage,
89 90
                 erp5_sql_connection_type,
                 erp5_sql_connection_string,
91
                 erp5_sql_deferred_connection_type,
92 93 94 95 96
                 cmf_activity_sql_connection_type,
                 cmf_activity_sql_connection_string,
                 create_activities=create_activities,
                 light_install=light_install,
                 reindex=reindex)
97 98
  gen.setupDefaultProperties(p,
                             title,
99
                             description,
100
                             email_from_address,
101 102
                             email_from_name,
                             validate_email)
103
  if RESPONSE is not None:
104 105
    RESPONSE.redirect(p.absolute_url())

106 107 108 109 110 111 112 113 114 115
def getCatalogStorageList(*args, **kw):
  """
    Returns the list of business templates available at install which can be
    used to setup a catalog storage.
  """
  result = []
  bootstrap_dir = getBootstrapDirectory()
  for item in os.listdir(bootstrap_dir):
    if item == '.svn':
      continue
116
    if item.endswith('.bt5') and os.path.isfile(item):
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
      # Simple heuristic to make it faster than extracting the whole bt
      if item.endswith('_catalog.bt5'):
        result.append((item, item))
    elif os.path.isdir(os.path.join(bootstrap_dir, item)):
      # Find if the business temlate provides erp5_catalog
      try:
        provides_file = open(os.path.join(bootstrap_dir, item, 'bt', 'provision_list'), 'r')
        provides_list = provides_file.readlines()
        provides_file.close()
      except IOError:
        provides_list = []
      if 'erp5_catalog' in provides_list:
        # Get a nice title (the first line of the description).
        try:
          title_file = open(os.path.join(bootstrap_dir, item, 'bt', 'description'), 'r')
          title = title_file.readline()
          title_file.close()
        except IOError:
          title = item
        result.append((item, title))
  return result
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152

class ReferCheckerBeforeTraverseHook:
  """This before traverse hook checks the HTTP_REFERER argument in the request
  and refuses access to anything else that portal_url.

  This is enabled by calling the method enableRefererCheck on the portal.
  """
  handle = '_erp5_referer_check'

  def __call__(self, container, request):
    """Checks the request contains a valid referrer.
    """
    response = request.RESPONSE
    http_url = request.get('ACTUAL_URL', '').strip()
    http_referer = request.get('HTTP_REFERER', '').strip()
153

154 155 156 157 158 159 160
    user_password = request._authUserPW()
    if user_password:
      user = container.acl_users.getUserById(user_password[0]) or\
              container.aq_parent.acl_users.getUserById(user_password[0])
      # Manager can do anything
      if user is not None and 'Manager' in user.getRoles():
        return
161

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
    portal_url = container.portal_url.getPortalObject().absolute_url()
    if http_referer != '':
      # if HTTP_REFERER is set, user can acces the object if referer is ok
      if http_referer.startswith(portal_url):
        return
      LOG('HTTP_REFERER_CHECK : BAD REFERER !', INFO,
          'request : "%s", referer : "%s"' % (http_url, http_referer))
      response.unauthorized()
    else:
      # no HTTP_REFERER, we only allow to reach portal_url
      for i in ('/', '/index_html', '/login_form', '/view'):
        if http_url.endswith(i):
          http_url = http_url[:-len(i)]
          break
      if len(http_url) == 0 or not portal_url.startswith(http_url):
        LOG('HTTP_REFERER_CHECK : NO REFERER !', INFO,
            'request : "%s"' % http_url)
        response.unauthorized()

181
class ERP5Site(FolderMixIn, CMFSite):
182
  """
183 184
  The *only* function this class should have is to help in the setup
  of a new ERP5.  It should not assist in the functionality at all.
185
  """
186
  meta_type = 'ERP5 Site'
187
  portal_type = 'ERP5 Site'
188
  constructors = (('addERP5Site', manage_addERP5SiteForm), manage_addERP5Site, )
189 190 191
  uid = 0
  last_id = 0
  icon = 'portal.gif'
192 193
  # Default value, prevents error during upgrade
  isIndexable = ConstantGetter('isIndexable', value=True)
194 195

  _properties = (
196
      { 'id':'title',
197
        'type':'string'},
198
      { 'id':'description',
199 200
        'type':'text'},
      )
201 202 203 204 205 206 207 208 209
  title = ''
  description = ''

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  security.declareProtected(Permissions.View, 'view')
  def view(self):
210 211 212 213 214
    """
      Returns the default view.
      Implemented for consistency
    """
    return self.index_html()
215

216 217 218 219 220 221 222 223 224 225 226
  def manage_beforeDelete(self, item, container):
    # On Zope 2.8, skin is setup during Acquisition (in the .__of__() method).
    # On Zope 2.12, skin is setup during __before_publishing_traverse__, which
    # doesn't happen when the object is being deleted from the management
    # interface, but we need it to be set for portal_activities when we're
    # being deleted. 
    self.setupCurrentSkin(self.REQUEST)
    return ERP5Site.inheritedAttribute('manage_beforeDelete')(self,
                                                              item,
                                                              container)

227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
  security.declareProtected( Permissions.ModifyPortalContent, 'manage_renameObject' )
  def manage_renameObject(self, id=None, new_id=None, REQUEST=None):
    """manage renaming an object while keeping coherency for contained
    and linked to objects inside the renamed object.

    XXX this is nearly a copy-and-paste from CopySupport.

    XXX this is not good enough when the module or the objects inside
    the module are referred to by outer objects. But addressing this problem
    requires a full traversal of the object tree, and the current
    implementation is not efficient enough for this.
    """
    ob = self.restrictedTraverse(id)
    if getattr(aq_base(ob), '_updateInternalRelatedContent', None) is not None:
      # Make sure there is no activities pending on that object
      try:
        portal_activities = getToolByName(self, 'portal_activities')
      except AttributeError:
        # There is no activity tool
        portal_activities = None
      if portal_activities is not None:
        if portal_activities.countMessage(path=ob.getPath())>0:
          raise ActivityPendingError, 'Sorry, pending activities prevent ' \
                         +  'changing id at this current stage'

      # Search for categories that have to be updated in sub objects.
      ob._recursiveSetActivityAfterTag(ob)
      path_item_list = ob.getRelativeUrl().split('/')
      ob._updateInternalRelatedContent(object=ob,
                                       path_item_list=path_item_list,
                                       new_id=new_id)
    # Rename the object
    return CMFSite.manage_renameObject(self, id=id, new_id=new_id,
                                       REQUEST=REQUEST)

262 263 264 265 266 267 268
  def _getAcquireLocalRoles(self):
    """
      Prevent local roles from being acquired outside of Portal object.
      See ERP5Security/__init__.py:mergedLocalRoles .
    """
    return False

269 270 271 272 273 274 275
  security.declareProtected(Permissions.ManagePortal, 'enableRefererCheck')
  def enableRefererCheck(self):
    """Enable a ReferCheckerBeforeTraverseHook to check users have valid
    HTTP_REFERER
    """
    BeforeTraverse.registerBeforeTraverse(self,
                                        ReferCheckerBeforeTraverseHook(),
276 277 278
                                        ReferCheckerBeforeTraverseHook.handle,
                             # we want to be registered _after_ CookieCrumbler
                                        100)
279

280 281 282 283
  def _disableRefererCheck(self):
    """Disable the HTTP_REFERER check."""
    BeforeTraverse.unregisterBeforeTraverse(self,
                                        ReferCheckerBeforeTraverseHook.handle)
284

285
  def hasObject(self, id):
286
    """
287
    Check if the portal has an id.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
288
    """
289
    return id in self.objectIds()
290

291
  security.declareProtected(Permissions.AccessContentsInformation,
292
                            'getPortalObject')
293 294
  def getPortalObject(self):
    return self
Jean-Paul Smets's avatar
Jean-Paul Smets committed
295

296 297 298 299 300
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalType')
  def getPortalType(self):
    return self.portal_type

301
  security.declareProtected(Permissions.AccessContentsInformation,
302
                            'getTitle')
303 304 305 306 307
  def getTitle(self):
    """
      Return the title.
    """
    return self.title
308

309 310 311 312 313 314
  security.declareProtected(Permissions.AccessContentsInformation, 'getUid')
  def getUid(self):
    """
      Returns the UID of the object. Eventually reindexes
      the object in order to make sure there is a UID
      (useful for import / export).
Jean-Paul Smets's avatar
Jean-Paul Smets committed
315

316 317 318
      WARNING : must be updates for circular references issues
    """
    return getattr(self, 'uid', 0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
319

320
  security.declareProtected(Permissions.AccessContentsInformation,
321
                            'getParentUid')
322 323 324 325 326
  def getParentUid(self):
    """
      A portal has no parent
    """
    return self.getUid()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
327

328 329 330 331
  # Required to allow content creation outside folders
  security.declareProtected(Permissions.View, 'getIdGroup')
  def getIdGroup(self):
    return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
332

333 334 335 336
  # Required to allow content creation outside folders
  security.declareProtected(Permissions.ModifyPortalContent, 'setLastId')
  def setLastId(self, id):
    self.last_id = id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
337

338 339
  security.declareProtected(Permissions.AccessContentsInformation, 'getUrl')
  def getUrl(self, REQUEST=None):
340 341 342 343
    """
      Returns the absolute path of an object
    """
    return join(self.getPhysicalPath(),'/')
Sebastien Robin's avatar
Sebastien Robin committed
344

345 346 347 348 349
  # Old name - for compatibility
  security.declareProtected(Permissions.AccessContentsInformation, 'getPath')
  getPath = getUrl

  security.declareProtected(Permissions.AccessContentsInformation, 'searchFolder')
350 351 352 353 354 355 356
  def searchFolder(self, **kw):
    """
      Search the content of a folder by calling
      the portal_catalog.
    """
    if not kw.has_key('parent_uid'):
      kw['parent_uid'] = self.uid
357
    return self.portal_catalog.searchResults(**kw)
358 359 360 361 362 363 364 365 366

  security.declareProtected(Permissions.AccessContentsInformation, 'countFolder')
  def countFolder(self, **kw):
    """
      Count the content of a folder by calling
      the portal_catalog.
    """
    if not kw.has_key('parent_uid'):
      kw['parent_uid'] = self.uid
367
    return self.portal_catalog.countResults(**kw)
368 369 370 371 372 373 374 375

  # Proxy methods for security reasons
  def getOwnerInfo(self):
    return self.owner_info()

  security.declarePublic('getOrderedGlobalActionList')
  def getOrderedGlobalActionList(self, action_list):
    """
376 377
    Returns a dictionnary of actions, sorted by type of object

378
    This should absolutely be rewritten by using clean
379
    concepts to separate worklists XXX
380 381 382 383 384 385
    """
    sorted_workflow_actions = {}
    sorted_global_actions = []
    other_global_actions = []
    for action in action_list:
      action['disabled'] = 0
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
386 387 388 389 390 391 392 393 394 395
      workflow_title = action.get('workflow_title', None)
      if workflow_title is not None:
        if not sorted_workflow_actions.has_key(workflow_title):
          sorted_workflow_actions[workflow_title] = [
            {'title':workflow_title,
             'disabled':1,
             'workflow_id':action['workflow_id']
             }
            ]
        sorted_workflow_actions[workflow_title].append(action)
396 397
      else:
        other_global_actions.append(action)
398
    for key in sorted(sorted_workflow_actions):
399 400 401 402 403 404
      sorted_global_actions.extend(sorted_workflow_actions[key])
    sorted_global_actions.append({'title': 'Others', 'disabled': 1})
    sorted_global_actions.extend(other_global_actions)
    return sorted_global_actions

  def setupDefaultProperties(self, p, title, description,
405 406 407
                             email_from_address, email_from_name,
                             validate_email
                             ):
408
    CMFSite.setupDefaultProperties(self, p, title, description,
409 410
                           email_from_address, email_from_name,
                           validate_email)
411

412 413 414
  # Portal methods are based on the concept of having portal-specific
  # parameters for customization. In the past, we used global parameters,
  # but it was not very good because it was very difficult
415
  # to customize the settings for each portal site.
416 417
  def _getPortalConfiguration(self, id):
    """
418
    Get a portal-specific configuration.
419

420 421
    Current implementation is using properties in a portal object.
    If not found, try to get a default value for backward compatibility.
422

423 424
    This implementation can be improved by gathering information
    from appropriate places, such as portal_types, portal_categories
425
    and portal_workflow.
426 427 428
    """
    if self.hasProperty(id):
      return self.getProperty(id)
429

430 431
    # Fall back to the default.
    return getattr(ERP5Defaults, id, None)
432

433
  def _getPortalGroupedTypeList(self, group, enable_sort=True):
434
    """
435
    Return a list of portal types classified to a specific group.
436 437
    The result is sorted by language (using the user language
    as default)
438 439 440

    Enable_sort parameter was added in order to allows looking groups
    of portal type without sorting. This is better for performance
441 442 443 444 445 446
    """
    def getTypeList(group):
      type_list = []
      for pt in self.portal_types.objectValues():
        if group in getattr(pt, 'group_list', ()):
          type_list.append(pt.getId())
447

448 449 450 451
      if enable_sort and len(type_list) >= 2:
        # XXX (Seb), this code must be moved in another place.
        # It is inefficient to always sort here for some particular
        # needs of the user interface
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
452 453
        translate = localizer_tool.translate
        type_list.sort(key=lambda x:translate('ui', x))
454 455
      return tuple(type_list)

456 457 458 459
    localizer_tool = getToolByName(self, 'Localizer')
    language = localizer_tool.get_selected_language()
    # language should be cached in Transaction Cache if performance issue

460
    getTypeList = CachingMethod(getTypeList,
461 462 463 464
                                id=(('_getPortalGroupedTypeList', language), group,
                                    enable_sort),
                                cache_factory='erp5_content_medium',
                                )
465 466 467

    return getTypeList(group) # Although this method is called get*List, it
                              # returns a tuple - renaming to be considered
468

469 470 471 472 473 474 475 476 477
  @caching_instance_method(id='ERP5Site._getPortalGroupedTypeSet',
     cache_factory='erp5_content_long')
  def _getPortalGroupedTypeSet(self, group):
    """
    Same as _getPortalGroupedTypeList, but returns a set, better for
    performance when looking for matching portal types
    """
    return set(self._getPortalGroupedTypeList(group, enable_sort=False))

478
  def _getPortalGroupedCategoryList(self, group):
479
    """
480
    Return a list of base categories classified to a specific group.
481 482 483 484 485 486 487 488
    """
    def getCategoryList(group):
      category_list = []
      for bc in self.portal_categories.objectValues():
        if group in bc.getCategoryTypeList():
          category_list.append(bc.getId())
      return tuple(category_list)

489 490
    getCategoryList = CachingMethod(
                            getCategoryList,
491
                            id=('_getPortalGroupedCategoryList', group),
Aurel's avatar
Aurel committed
492
                            cache_factory='erp5_content_medium')
493 494 495
    return getCategoryList(group)

  def _getPortalGroupedStateList(self, group):
496
    """
497
    Return a list of workflow states classified to a specific group.
498 499 500 501 502 503 504 505 506 507
    """
    def getStateList(group):
      state_dict = {}
      for wf in self.portal_workflow.objectValues():
        if getattr(wf, 'states', None):
          for state in wf.states.objectValues():
            if group in getattr(state, 'type_list', ()):
              state_dict[state.getId()] = None
      return tuple(state_dict.keys())

508
    getStateList = CachingMethod(getStateList,
509
                                 id=('_getPortalGroupedStateList', group),
Aurel's avatar
Aurel committed
510
                                 cache_factory='erp5_content_medium')
511 512
    return getStateList(group)

513 514
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDefaultSectionCategory')
515 516
  def getPortalDefaultSectionCategory(self):
    """
517
    Return a default section category. This method is deprecated.
518 519 520 521
    """
    LOG('ERP5Site', 0, 'getPortalDefaultSectionCategory is deprecated;'+
        ' use portal_preferences.getPreferredSectionCategory instead.')
    section_category = self.portal_preferences.getPreferredSectionCategory()
522

523 524 525 526
    # XXX This is only for backward-compatibility.
    if not section_category:
      section_category = self._getPortalConfiguration(
                                'portal_default_section_category')
527

528
    return section_category
529

530 531 532 533 534 535
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalResourceTypeList')
  def getPortalResourceTypeList(self):
    """
      Return resource types.
    """
536 537 538
    return self._getPortalGroupedTypeList('resource') or \
           self._getPortalConfiguration('portal_resource_type_list')

539 540 541 542 543 544 545
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSubVariationTypeList')
  def getPortalSubVariationTypeList(self):
    """
      Return resource types.
    """
    return self._getPortalGroupedTypeList('sub_variation')
546

547 548 549 550 551 552 553
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSubVariationBaseCategoryList')
  def getPortalSubVariationBaseCategoryList(self):
    """
      Return variation base categories.
    """
    return self._getPortalGroupedCategoryList('sub_variation')
554

555 556 557 558 559 560
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalVariationTypeList')
  def getPortalVariationTypeList(self):
    """
      Return variation types.
    """
561 562 563
    return self._getPortalGroupedTypeList('variation') or \
           self._getPortalConfiguration('portal_variation_type_list')

564 565 566 567 568 569
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalNodeTypeList')
  def getPortalNodeTypeList(self):
    """
      Return node types.
    """
570 571 572
    return self._getPortalGroupedTypeList('node') or \
           self._getPortalConfiguration('portal_node_type_list')

573 574 575 576 577 578
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPaymentNodeTypeList')
  def getPortalPaymentNodeTypeList(self):
    """
      Return payment node types.
    """
579 580 581
    return self._getPortalGroupedTypeList('payment_node') or \
           self._getPortalConfiguration('portal_payment_node_type_list')

582 583 584 585 586 587
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInvoiceTypeList')
  def getPortalInvoiceTypeList(self):
    """
      Return invoice types.
    """
588 589 590
    return self._getPortalGroupedTypeList('invoice') or \
           self._getPortalConfiguration('portal_invoice_type_list')

591 592 593 594 595 596
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOrderTypeList')
  def getPortalOrderTypeList(self):
    """
      Return order types.
    """
597 598 599
    return self._getPortalGroupedTypeList('order') or \
           self._getPortalConfiguration('portal_order_type_list')

600 601 602 603 604 605
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDeliveryTypeList')
  def getPortalDeliveryTypeList(self):
    """
      Return delivery types.
    """
606 607 608
    return self._getPortalGroupedTypeList('delivery') or \
           self._getPortalConfiguration('portal_delivery_type_list')

609 610 611 612 613 614
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTransformationTypeList')
  def getPortalTransformationTypeList(self):
    """
      Return transformation types.
    """
615 616 617
    return self._getPortalGroupedTypeList('transformation') or \
           self._getPortalConfiguration('portal_transformation_type_list')

618 619 620 621 622 623 624 625 626
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalModelPathTypeList')
  def getPortalModelPathTypeList(self):
    """
      Return model_path types.
    """
    return self._getPortalGroupedTypeList('model_path') or \
           self._getPortalConfiguration('portal_model_path_type_list')

627 628 629 630 631 632
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalVariationBaseCategoryList')
  def getPortalVariationBaseCategoryList(self):
    """
      Return variation base categories.
    """
633 634 635
    return self._getPortalGroupedCategoryList('variation') or \
           self._getPortalConfiguration('portal_variation_base_category_list')

636 637 638 639 640 641
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOptionBaseCategoryList')
  def getPortalOptionBaseCategoryList(self):
    """
      Return option base categories.
    """
642 643 644
    return self._getPortalGroupedCategoryList('option') or \
           self._getPortalConfiguration('portal_option_base_category_list')

645 646 647 648 649 650
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInvoiceMovementTypeList')
  def getPortalInvoiceMovementTypeList(self):
    """
      Return invoice movement types.
    """
651 652 653
    return self._getPortalGroupedTypeList('invoice_movement') or \
           self._getPortalConfiguration('portal_invoice_movement_type_list')

654 655 656 657 658 659 660 661 662 663
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTaxMovementTypeList')
  def getPortalTaxMovementTypeList(self):
    """
      Return tax movement types.
    """
    return self._getPortalGroupedTypeList('tax_movement') or \
           self._getPortalConfiguration('portal_tax_movement_type_list')


664 665 666 667 668 669
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOrderMovementTypeList')
  def getPortalOrderMovementTypeList(self):
    """
      Return order movement types.
    """
670 671 672
    return self._getPortalGroupedTypeList('order_movement') or \
           self._getPortalConfiguration('portal_order_movement_type_list')

673 674 675 676 677 678
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDeliveryMovementTypeList')
  def getPortalDeliveryMovementTypeList(self):
    """
      Return delivery movement types.
    """
679 680 681
    return self._getPortalGroupedTypeList('delivery_movement') or \
           self._getPortalConfiguration('portal_delivery_movement_type_list')

682
  security.declareProtected(Permissions.AccessContentsInformation,
683
                            'getPortalSupplyTypeList')
684 685 686 687
  def getPortalSupplyTypeList(self):
    """
      Return supply types.
    """
688 689 690
    return self._getPortalGroupedTypeList('supply') or \
           self._getPortalConfiguration('portal_supply_type_list')

691 692 693 694 695 696 697 698
  security.declareProtected(Permissions.AccessContentsInformation,
                              'getPortalRuleTypeList')
  def getPortalRuleTypeList(self):
    """
      Return rule types.
    """
    return self._getPortalGroupedTypeList('rule')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
699 700 701 702
  security.declareProtected(Permissions.AccessContentsInformation,
                              'getPortalProjectTypeList')
  def getPortalProjectTypeList(self):
    """
703
      Return project types.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
704 705 706
    """
    return self._getPortalGroupedTypeList('project')

707
  security.declareProtected(Permissions.AccessContentsInformation,
708 709 710 711 712
                              'getPortalDocumentTypeList')
  def getPortalDocumentTypeList(self):
    """
      Return document types.
    """
713
    return self._getPortalGroupedTypeList('document')
714 715 716 717 718 719 720 721 722

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalWebDocumentTypeList')
  def getPortalWebDocumentTypeList(self):
    """
      Return web page types.
    """
    return self._getPortalGroupedTypeList('web_document')

723 724 725 726
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalFileDocumentTypeList')
  def getPortalFileDocumentTypeList(self):
    """
727
      Return file document types.
728 729 730 731 732 733 734
    """
    return self._getPortalGroupedTypeList('file_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalRecentDocumentTypeList')
  def getPortalRecentDocumentTypeList(self):
    """
735
      Return recent document types.
736 737 738 739 740 741 742
    """
    return self._getPortalGroupedTypeList('recent_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTemplateDocumentTypeList')
  def getPortalTemplateDocumentTypeList(self):
    """
743
      Return template document types.
744 745 746 747 748 749 750
    """
    return self._getPortalGroupedTypeList('template_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMyDocumentTypeList')
  def getPortalMyDocumentTypeList(self):
    """
751
      Return my document types.
752 753 754
    """
    return self._getPortalGroupedTypeList('my_document')

755 756 757 758
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalCrawlerIndexTypeList')
  def getPortalCrawlerIndexTypeList(self):
    """
759
      Return crawler index types.
760 761 762
    """
    return self._getPortalGroupedTypeList('crawler_index')

763 764 765 766 767 768 769 770
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBudgetVariationTypeList')
  def getPortalBudgetVariationTypeList(self):
    """
      Return budget variation types.
    """
    return self._getPortalGroupedTypeList('budget_variation')

771
  security.declareProtected(Permissions.AccessContentsInformation,
772
                            'getPortalSupplyPathTypeList')
773 774
  def getPortalSupplyPathTypeList(self):
    """
775
      Return supply path types.
776
    """
777 778 779
    return self._getPortalGroupedTypeList('supply_path') or \
           self._getPortalConfiguration('portal_supply_path_type_list')

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
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBusinessProcessTypeList')
  def getPortalBusinessProcessTypeList(self):
    """
      Return business process types.
    """
    return self._getPortalGroupedTypeList('business_process') or \
           self._getPortalConfiguration('portal_business_process_type_list')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBusinessStateTypeList')
  def getPortalBusinessStateTypeList(self):
    """
      Return business state types.
    """
    return self._getPortalGroupedTypeList('business_state') or \
           self._getPortalConfiguration('portal_business_state_type_list')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBusinessPathTypeList')
  def getPortalBusinessPathTypeList(self):
    """
      Return business path types.
    """
    return self._getPortalGroupedTypeList('business_path') or \
           self._getPortalConfiguration('portal_business_path_type_list')

807 808 809 810 811 812 813
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAcquisitionMovementTypeList')
  def getPortalAcquisitionMovementTypeList(self):
    """
      Return acquisition movement types.
    """
    return tuple(list(self.getPortalOrderMovementTypeList()) +
814
                 list(self.getPortalDeliveryMovementTypeList()) +
815
                 list(self.getPortalTaxMovementTypeList()) +
816 817
                 list(self.getPortalInvoiceMovementTypeList()))

818 819 820 821 822 823 824
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMovementTypeList')
  def getPortalMovementTypeList(self):
    """
      Return movement types.
    """
    return tuple(list(self.getPortalOrderMovementTypeList()) +
825 826
                 list(self.getPortalDeliveryMovementTypeList()) +
                 list(self.getPortalInvoiceMovementTypeList()) +
827
                 list(self.getPortalTaxMovementTypeList()) +
828
                 ['Simulation Movement'])
829

830 831 832 833 834 835
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSimulatedMovementTypeList')
  def getPortalSimulatedMovementTypeList(self):
    """
      Return simulated movement types.
    """
836
    return tuple([x for x in self.getPortalMovementTypeList() \
837
                  if x not in self.getPortalContainerTypeList()])
838

839 840 841 842 843 844
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalContainerTypeList')
  def getPortalContainerTypeList(self):
    """
      Return container types.
    """
845 846 847
    return self._getPortalGroupedTypeList('container') or \
           self._getPortalConfiguration('portal_container_type_list')

848 849 850 851 852 853
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalContainerLineTypeList')
  def getPortalContainerLineTypeList(self):
    """
      Return container line types.
    """
854 855 856
    return self._getPortalGroupedTypeList('container_line') or \
           self._getPortalConfiguration('portal_container_line_type_list')

857 858 859 860 861 862
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalItemTypeList')
  def getPortalItemTypeList(self):
    """
      Return item types.
    """
863 864 865
    return self._getPortalGroupedTypeList('item') or \
           self._getPortalConfiguration('portal_item_type_list')

866 867 868 869 870 871
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDiscountTypeList')
  def getPortalDiscountTypeList(self):
    """
      Return discount types.
    """
872 873 874
    return self._getPortalGroupedTypeList('discount') or \
           self._getPortalConfiguration('portal_discount_type_list')

875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalProductTypeList')
  def getPortalProductTypeList(self):
    """
      Return physical goods types.
    """
    return self._getPortalGroupedTypeList('product') or \
           self._getPortalConfiguration('portal_product_type_list')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalServiceTypeList')
  def getPortalServiceTypeList(self):
    """
      Return immaterial services types.
    """
    return self._getPortalGroupedTypeList('service') or \
           self._getPortalConfiguration('portal_service_type_list')

893 894 895 896 897 898
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAlarmTypeList')
  def getPortalAlarmTypeList(self):
    """
      Return alarm types.
    """
899 900 901
    return self._getPortalGroupedTypeList('alarm') or \
           self._getPortalConfiguration('portal_alarm_type_list')

902 903 904 905 906 907
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPaymentConditionTypeList')
  def getPortalPaymentConditionTypeList(self):
    """
      Return payment condition types.
    """
908 909 910
    return self._getPortalGroupedTypeList('payment_condition') or \
           self._getPortalConfiguration('portal_payment_condition_type_list')

911 912 913 914 915 916
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBalanceTransactionLineTypeList')
  def getPortalBalanceTransactionLineTypeList(self):
    """
      Return balance transaction line types.
    """
917
    return self._getPortalGroupedTypeList('balance_transaction_line') or \
918 919
           self._getPortalConfiguration(
                  'portal_balance_transaction_line_type_list')
920

921 922 923 924 925 926
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalCurrentInventoryStateList')
  def getPortalCurrentInventoryStateList(self):
    """
      Return current inventory states.
    """
927 928 929
    return self._getPortalGroupedStateList('current_inventory') or \
           self._getPortalConfiguration('portal_current_inventory_state_list')

930 931 932 933 934 935 936 937 938
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTransitInventoryStateList')
  def getPortalTransitInventoryStateList(self):
    """
      Return transit inventory states.
    """
    return self._getPortalGroupedStateList('transit_inventory') or \
           self._getPortalConfiguration('portal_transit_inventory_state_list')

939 940 941 942 943 944
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDraftOrderStateList')
  def getPortalDraftOrderStateList(self):
    """
      Return draft order states.
    """
945 946 947
    return self._getPortalGroupedStateList('draft_order') or \
           self._getPortalConfiguration('portal_draft_order_state_list')

948 949 950 951 952 953
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPlannedOrderStateList')
  def getPortalPlannedOrderStateList(self):
    """
      Return planned order states.
    """
954 955 956
    return self._getPortalGroupedStateList('planned_order') or \
           self._getPortalConfiguration('portal_planned_order_state_list')

957 958 959 960 961 962
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalReservedInventoryStateList')
  def getPortalReservedInventoryStateList(self):
    """
      Return reserved inventory states.
    """
963
    return self._getPortalGroupedStateList('reserved_inventory') or \
964
        self._getPortalConfiguration('portal_reserved_inventory_state_list')
965

966 967 968 969 970 971
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalFutureInventoryStateList')
  def getPortalFutureInventoryStateList(self):
    """
      Return future inventory states.
    """
972 973 974
    return self._getPortalGroupedStateList('future_inventory') or \
           self._getPortalConfiguration('portal_future_inventory_state_list')

975
  security.declareProtected(Permissions.AccessContentsInformation,
976
                          'getPortalUpdatableAmortisationTransactionStateList')
977 978
  def getPortalUpdatableAmortisationTransactionStateList(self):
    """
979
      Return states when Amortisation Transaction can be updated
980
      by amortisation_transaction_builder.
981
    """
982 983
    return self._getPortalConfiguration(
        'portal_updatable_amortisation_transaction_state_list')
984

985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalGroupedSimulationStateList')
  def getPortalGroupedSimulationStateList(self):
    """
      Return all states which is related to simulation state workflow and state type
    """
    def getStateList():
      state_dict = {}
      for wf in self.portal_workflow.objectValues():
        if getattr(wf, 'variables', None) and \
           wf.variables.getStateVar() == 'simulation_state':
          if getattr(wf, 'states', None):
            for state in wf.states.objectValues():
              if getattr(state, 'type_list', None):
                state_dict[state.getId()] = None
      return tuple(sorted(state_dict.keys()))

    getStateList = CachingMethod(getStateList,
                                 id=('getPortalGroupedSimulationStateList'),
                                 cache_factory='erp5_content_medium')
    return getStateList()

1007 1008 1009 1010 1011 1012
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalColumnBaseCategoryList')
  def getPortalColumnBaseCategoryList(self):
    """
      Return column base categories.
    """
1013 1014 1015
    return self._getPortalGroupedCategoryList('column') or \
           self._getPortalConfiguration('portal_column_base_category_list')

1016 1017 1018 1019 1020 1021
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalLineBaseCategoryList')
  def getPortalLineBaseCategoryList(self):
    """
      Return line base categories.
    """
1022 1023 1024
    return self._getPortalGroupedCategoryList('line') or \
           self._getPortalConfiguration('portal_line_base_category_list')

1025 1026 1027 1028 1029 1030
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTabBaseCategoryList')
  def getPortalTabBaseCategoryList(self):
    """
      Return tab base categories.
    """
1031 1032 1033
    return self._getPortalGroupedCategoryList('tab') or \
           self._getPortalConfiguration('portal_tab_base_category_list')

1034 1035 1036 1037
  def getPortalDefaultGapRoot(self):
    """
      Return the Accounting Plan to use by default (return the root node)
    """
1038
    LOG('ERP5Site', 0,
1039 1040 1041
        'getPortalDefaultGapRoot is deprecated; ' \
        'use portal_preferences.getPreferredAccountingTransactionGap instead.')

1042 1043
    return self.portal_preferences.getPreferredAccountingTransactionGap() or \
           self._getPortalConfiguration('portal_default_gap_root')
1044

1045 1046 1047 1048
  def getPortalAccountingMovementTypeList(self) :
    """
      Return accounting movement type list.
    """
1049
    return self._getPortalGroupedTypeList('accounting_movement') or \
1050
        self._getPortalConfiguration('portal_accounting_movement_type_list')
1051

1052 1053 1054 1055
  def getPortalAccountingTransactionTypeList(self) :
    """
      Return accounting transaction movement type list.
    """
1056
    return self._getPortalGroupedTypeList('accounting_transaction') or \
1057
      self._getPortalConfiguration('portal_accounting_transaction_type_list')
1058

1059 1060 1061 1062
  def getPortalAssignmentBaseCategoryList(self):
    """
      Return List of category values to generate security groups.
    """
1063
    return self._getPortalGroupedCategoryList('assignment') or \
1064
        self._getPortalConfiguration('portal_assignment_base_category_list')
1065

1066 1067
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTicketTypeList')
1068 1069 1070 1071 1072
  def getPortalTicketTypeList(self):
    """
    Return ticket types.
    """
    return self._getPortalGroupedTypeList('ticket')
1073

1074 1075
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalEventTypeList')
1076 1077 1078 1079 1080
  def getPortalEventTypeList(self):
    """
    Return event types.
    """
    return self._getPortalGroupedTypeList('event')
1081

1082 1083 1084 1085 1086 1087 1088 1089
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDivergenceTesterTypeList')
  def getPortalDivergenceTesterTypeList(self):
    """
    Return divergence tester types.
    """
    return self._getPortalGroupedTypeList('divergence_tester')

1090 1091 1092 1093 1094 1095 1096 1097
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTargetSolverTypeList')
  def getPortalTargetSolverTypeList(self):
    """
    Return target solver types.
    """
    return self._getPortalGroupedTypeList('target_solver')

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAmountGeneratorTypeList')
  def getPortalAmountGeneratorTypeList(self):
    """
    Return amount generator types.
    """
    return self._getPortalGroupedTypeList('amount_generator')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAmountGeneratorLineTypeList')
  def getPortalAmountGeneratorLineTypeList(self):
    """
    Return amount generator line types.
    """
    return self._getPortalGroupedTypeList('amount_generator_line')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAmountGeneratorCellTypeList')
  def getPortalAmountGeneratorCellTypeList(self):
    """
    Return amount generator cell types.
    """
    return self._getPortalGroupedTypeList('amount_generator_cell')

1122 1123 1124 1125 1126 1127 1128 1129
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalCalendarPeriodTypeList')
  def getPortalCalendarPeriodTypeList(self):
    """
    Return calendar period types.
    """
    return self._getPortalGroupedTypeList('calendar_period')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1130 1131 1132 1133 1134 1135 1136 1137
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalModuleTypeList')
  def getPortalModuleTypeList(self):
    """
    Return module types.
    """
    return self._getPortalGroupedTypeList('module')

1138 1139 1140 1141 1142 1143 1144 1145
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInventoryMovementTypeList')
  def getPortalInventoryMovementTypeList(self):
    """
    Return inventory movement types.
    """
    return self._getPortalGroupedTypeList('inventory_movement')

1146 1147 1148 1149 1150 1151 1152 1153
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMovementGroupTypeList')
  def getPortalMovementGroupTypeList(self):
    """
    Return movement group types.
    """
    return self._getPortalGroupedTypeList('movement_group')

1154 1155
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDefaultModuleId')
1156 1157
  def getDefaultModuleId(self, portal_type, default=MARKER):
    """
Romain Courteaud's avatar
Romain Courteaud committed
1158 1159
    Return default module id where a object with portal_type can
    be created.
1160 1161
    """
    portal_object = self
Romain Courteaud's avatar
Romain Courteaud committed
1162 1163 1164 1165 1166
    module_id = None
    # first try to find by naming convention
    expected_module_id = portal_type.lower().replace(' ','_')
    if portal_object._getOb(expected_module_id, None) is not None:
      module_id = expected_module_id
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
    else:
      expected_module_id += '_module'
      if portal_object._getOb(expected_module_id, None) is not None:
        module_id = expected_module_id
      # then look for module where the type is allowed
      else:
        for expected_module_id in portal_object.objectIds(spec=('ERP5 Folder',)):
          module = portal_object._getOb(expected_module_id, None)
          if module is not None:
            if portal_type in self.portal_types[module.getPortalType()].\
                                      allowed_content_types:
              module_id = expected_module_id
              break
Romain Courteaud's avatar
Romain Courteaud committed
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192

    if module_id is None:
      if default is not MARKER:
        return default
      else:
        # now we fail
        LOG('ERP5Site, getDefaultModuleId', 0,
            'Unable to find default module for portal_type: %s' % \
             portal_type)
        raise ValueError, 'Unable to find module for portal_type: %s' % \
               portal_type

    return module_id
1193

1194 1195
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDefaultModule')
1196
  def getDefaultModule(self, portal_type, default=MARKER):
1197 1198 1199
    """
      Return default module where a object with portal_type can be created
    """
1200 1201 1202 1203
    module_id = self.getDefaultModuleId(portal_type, default)
    if module_id:
      return getattr(self, module_id, None)
    return None
1204

1205 1206 1207 1208 1209 1210 1211 1212 1213
  security.declareProtected(Permissions.AddPortalContent, 'newContent')
  def newContent(self, id=None, portal_type=None, immediate_reindex=0, **kw):
    """
      Creates a new content
    """
    if id is None:
      raise ValueError, 'The id should not be None'
    if portal_type is None:
      raise ValueError, 'The portal_type should not be None'
1214 1215 1216 1217
    self.portal_types.constructContent(type_name=portal_type,
                                       container=self,
                                       id=id,
                                       ) # **kw) removed due to CMF bug
1218
    new_instance = self[id]
1219

1220 1221 1222 1223
    if kw is not None:
      new_instance._edit(force_update=1, **kw)
    if immediate_reindex:
      new_instance.immediateReindexObject()
1224 1225
    return new_instance

1226 1227 1228 1229 1230 1231
  security.declarePublic('getVisibleAllowedContentTypeList')
  def getVisibleAllowedContentTypeList(self):
    """Users cannot add anything in an ERP5Site using standard interface.
    """
    return ()

1232 1233 1234 1235 1236 1237
  def log(self, description, content='', level=INFO):
    """Put a log message """
    warnings.warn("The usage of ERP5Site.log is deprecated.\n"
                  "Please use Products.ERP5Type.Log.log instead.",
                  DeprecationWarning)
    unrestrictedLog(description, content = content, level = level)
1238

1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
  security.declarePublic('setPlacelessDefaultReindexParameters')
  def setPlacelessDefaultReindexParameters(self, **kw):
    # This method sets the default keyword parameters to reindex. This is useful
    # when you need to specify special parameters implicitly (e.g. to reindexObject).
    # Those parameters will affect all reindex calls, not just ones on self.
    tv = getTransactionalVariable(self)
    key = ('default_reindex_parameter', )
    tv[key] = kw

  security.declarePublic('setPlacelessDefaultActivateParameters')
  def setPlacelessDefaultActivateParameters(self, **kw):
    # This method sets the default keyword parameters to activate. This is useful
    # when you need to specify special parameters implicitly (e.g. to reindexObject).
    # Those parameters will affect all activate calls, not just ones on self.
    tv = getTransactionalVariable(self)
    key = ('default_activate_parameter', )
    tv[key] = kw

  security.declarePublic('getPlacelessDefaultReindexParameters')
  def getPlacelessDefaultReindexParameters(self):
    # This method returns default reindex parameters to self.
    # The result can be either a dict object or None.
    tv = getTransactionalVariable(self)
    key = ('default_reindex_parameter', )
    return tv.get(key)

  security.declarePublic('getPlacelessDefaultActivateParameters')
  def getPlacelessDefaultActivateParameters(self):
    # This method returns default activate parameters to self.
    # The result can be either a dict object or None.
    tv = getTransactionalVariable(self)
    key = ('default_activate_parameter', )
    return tv.get(key)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1273 1274
Globals.InitializeClass(ERP5Site)

1275 1276 1277 1278 1279 1280 1281
def getBootstrapDirectory():
  """
    Return the name of the bootstrap directory
  """
  product_path = package_home(globals())
  return os.path.join(product_path, 'bootstrap')

1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441

# This PortalGenerator class was copied wholesale from CMF 1.5 which is
# identical to the one on 1.6, and hasn't been used by CMF itself since even
# 1.5, as they already used CMFSetup by then (later replaced by GenericSetup).


factory_type_information = () # No original CMF portal_types installed by default

class PortalGenerator:

    klass = CMFSite

    def setupTools(self, p):
        """Set up initial tools"""

        addCMFCoreTool = p.manage_addProduct['CMFCore'].manage_addTool
        addCMFCoreTool('CMF Actions Tool', None)
        addCMFCoreTool('CMF Catalog', None)
        addCMFCoreTool('CMF Member Data Tool', None)
        addCMFCoreTool('CMF Skins Tool', None)
        addCMFCoreTool('CMF Types Tool', None)
        addCMFCoreTool('CMF Undo Tool', None)
        addCMFCoreTool('CMF URL Tool', None)
        addCMFCoreTool('CMF Workflow Tool', None)

        addCMFDefaultTool = p.manage_addProduct['CMFDefault'].manage_addTool
        addCMFDefaultTool('Default Discussion Tool', None)
        addCMFDefaultTool('Default Membership Tool', None)
        addCMFDefaultTool('Default Registration Tool', None)
        addCMFDefaultTool('Default Properties Tool', None)
        addCMFDefaultTool('Default Metadata Tool', None)
        addCMFDefaultTool('Default Syndication Tool', None)

        # try to install CMFUid without raising exceptions if not available
        try:
            addCMFUidTool = p.manage_addProduct['CMFUid'].manage_addTool
        except AttributeError:
            pass
        else:
            addCMFUidTool('Unique Id Annotation Tool', None)
            addCMFUidTool('Unique Id Generator Tool', None)
            addCMFUidTool('Unique Id Handler Tool', None)

    def setupMailHost(self, p):
        p.manage_addProduct['MailHost'].manage_addMailHost(
            'MailHost', smtp_host='localhost')

    def setupUserFolder(self, p):
        p.manage_addProduct['OFSP'].manage_addUserFolder()

    def setupCookieAuth(self, p):
        p.manage_addProduct['CMFCore'].manage_addCC(
            id='cookie_authentication')

    def setupMembersFolder(self, p):
        PortalFolder.manage_addPortalFolder(p, 'Members')
        p.Members.manage_addProduct['OFSP'].manage_addDTMLMethod(
            'index_html', 'Member list', '<dtml-return roster>')

    def setupRoles(self, p):
        # Set up the suggested roles.
        p.__ac_roles__ = ('Member', 'Reviewer',)

    def setupPermissions(self, p):
        # Set up some suggested role to permission mappings.
        mp = p.manage_permission

        mp(AccessFuturePortalContent, ['Reviewer','Manager',], 1)
        mp(AddPortalContent,          ['Owner','Manager',],    1)
        mp(AddPortalFolders,          ['Owner','Manager',],    1)
        mp(ListPortalMembers,         ['Member','Manager',],   1)
        mp(ListUndoableChanges,       ['Member','Manager',],   1)
        mp(ReplyToItem,               ['Member','Manager',],   1)
        mp(ReviewPortalContent,       ['Reviewer','Manager',], 1)
        mp(SetOwnPassword,            ['Member','Manager',],   1)
        mp(SetOwnProperties,          ['Member','Manager',],   1)

        # Add some other permissions mappings that may be helpful.
        mp(DeleteObjects,             ['Owner','Manager',],    1)
        mp(FTPAccess,                 ['Owner','Manager',],    1)
        mp(ManageProperties,          ['Owner','Manager',],    1)
        mp(UndoChanges,               ['Owner','Manager',],    1)
        mp(ViewManagementScreens,     ['Owner','Manager',],    1)

    def setupTypes(self, p, initial_types=factory_type_information):
        tool = getToolByName(p, 'portal_types', None)
        if tool is None:
            return
        for t in initial_types:
            fti = FactoryTypeInformation(**t)
            tool._setObject(t['id'], fti)

    def setupMimetypes(self, p):
        p.manage_addProduct[ 'CMFCore' ].manage_addRegistry()
        reg = p.content_type_registry

        reg.addPredicate( 'link', 'extension' )
        reg.getPredicate( 'link' ).edit( extensions="url, link" )
        reg.assignTypeName( 'link', 'Link' )

        reg.addPredicate( 'news', 'extension' )
        reg.getPredicate( 'news' ).edit( extensions="news" )
        reg.assignTypeName( 'news', 'News Item' )

        reg.addPredicate( 'document', 'major_minor' )
        reg.getPredicate( 'document' ).edit( major="text", minor="" )
        reg.assignTypeName( 'document', 'Document' )

        reg.addPredicate( 'image', 'major_minor' )
        reg.getPredicate( 'image' ).edit( major="image", minor="" )
        reg.assignTypeName( 'image', 'Image' )

        reg.addPredicate( 'file', 'major_minor' )
        reg.getPredicate( 'file' ).edit( major="application", minor="" )
        reg.assignTypeName( 'file', 'File' )

    def setup(self, p, create_userfolder):
        from Products.CMFTopic import Topic
        self.setupTools(p)
        self.setupMailHost(p)
        if int(create_userfolder) != 0:
            self.setupUserFolder(p)
        self.setupCookieAuth(p)
        self.setupMembersFolder(p)
        self.setupRoles(p)
        self.setupPermissions(p)
        self.setupDefaultSkins(p)

        #   SkinnedFolders are only for customization;
        #   they aren't a default type.
        default_types = tuple( filter( lambda x: x['id'] != 'Skinned Folder'
                                     , factory_type_information ) )
        self.setupTypes(p, default_types )

        self.setupTypes(p, PortalFolder.factory_type_information)
        self.setupTypes(p, Topic.factory_type_information)
        self.setupMimetypes(p)
        self.setupWorkflow(p)

    def create(self, parent, id, create_userfolder):
        id = str(id)
        portal = self.klass(id=id)
        parent._setObject(id, portal)
        # Return the fully wrapped object.
        p = parent.this()._getOb(id)
        self.setup(p, create_userfolder)
        return p

    def setupDefaultProperties(self, p, title, description,
                               email_from_address, email_from_name,
                               validate_email, default_charset=''):
        p._setProperty('email_from_address', email_from_address, 'string')
        p._setProperty('email_from_name', email_from_name, 'string')
        p._setProperty('validate_email', validate_email and 1 or 0, 'boolean')
        p._setProperty('default_charset', default_charset, 'string')
        p._setProperty('enable_permalink', 0, 'boolean')
        p.title = title
        p.description = description


Jean-Paul Smets's avatar
Jean-Paul Smets committed
1442 1443
class ERP5Generator(PortalGenerator):

1444
  klass = ERP5Site
1445

1446
  def getBootstrapDirectory(self):
1447
    return getBootstrapDirectory()
1448

1449 1450 1451
  def create(self,
             parent,
             id,
1452
             create_userfolder,
1453
             erp5_catalog_storage,
1454
             erp5_sql_connection_type,
1455
             erp5_sql_connection_string,
1456
             erp5_sql_deferred_connection_type,
1457 1458
             cmf_activity_sql_connection_type,
             cmf_activity_sql_connection_string,
1459
             create_activities=True,
1460 1461
             reindex=1,
             **kw):
1462 1463
    id = str(id)
    portal = self.klass(id=id)
1464 1465
    # Make sure reindex will not be called until business templates
    # will be installed
1466
    setattr(portal, 'isIndexable', ConstantGetter('isIndexable', value=False))
1467 1468 1469
    parent._setObject(id, portal)
    # Return the fully wrapped object.
    p = parent.this()._getOb(id)
1470 1471

    erp5_sql_deferred_connection_string = erp5_sql_connection_string
1472 1473
    p._setProperty('erp5_catalog_storage',
                   erp5_catalog_storage, 'string')
1474
    p._setProperty('erp5_sql_connection_type',
1475
                   erp5_sql_connection_type, 'string')
1476
    p._setProperty('erp5_sql_connection_string',
1477
                   erp5_sql_connection_string, 'string')
1478
    p._setProperty('erp5_sql_deferred_connection_type',
1479
                   erp5_sql_deferred_connection_type, 'string')
1480
    p._setProperty('erp5_sql_deferred_connection_string',
1481
                   erp5_sql_deferred_connection_string, 'string')
1482
    p._setProperty('cmf_activity_sql_connection_type',
1483
                   cmf_activity_sql_connection_type, 'string')
1484
    p._setProperty('cmf_activity_sql_connection_string',
1485
                   cmf_activity_sql_connection_string, 'string')
1486
    p._setProperty('management_page_charset', 'UTF-8', 'string')
1487 1488
    self.setup(p, create_userfolder, create_activities=create_activities,
        reindex=reindex, **kw)
1489 1490 1491 1492
    return p

  def setupLastTools(self, p, **kw):
    """
1493 1494 1495
    Set up finals tools
    We want to set the activity tool only at the end to
    make sure that we do not put un the queue the full reindexation
1496 1497
    """
    # Add Activity Tool
1498
    if kw.get('create_activities', False):
1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
      if not p.hasObject('portal_activities'):
        addTool = p.manage_addProduct['CMFActivity'].manage_addTool
        addTool('CMF Activity Tool', None) # Allow user to select active/passive
      # Initialize Activities
      portal_activities = getToolByName(p, 'portal_activities', None)
      if portal_activities is not None:
        if kw.get('update', 0):
          keep = 1
        else:
          keep = 0
        portal_activities.manageClearActivities(keep=keep)
1510

1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
    # Add several other tools, only at the end in order
    # to make sure that they will be reindexed
    addTool = p.manage_addProduct['ERP5'].manage_addTool
    if not p.hasObject('portal_rules'):
      addTool('ERP5 Rule Tool', None)
    if not p.hasObject('portal_simulation'):
      addTool('ERP5 Simulation Tool', None)
    if not p.hasObject('portal_deliveries'):
      addTool('ERP5 Delivery Tool', None)
    if not p.hasObject('portal_orders'):
      addTool('ERP5 Order Tool', None)


1524 1525
  def setupTemplateTool(self, p, **kw):
    """
1526
    Setup the Template Tool. Security must be set strictly.
1527 1528 1529 1530 1531 1532 1533 1534 1535 1536
    """
    addTool = p.manage_addProduct['ERP5'].manage_addTool
    addTool('ERP5 Template Tool', None)
    context = p.portal_templates
    permission_list = context.possible_permissions()
    for permission in permission_list:
      context.manage_permission(permission, ['Manager'], 0)

  def setupTools(self, p,**kw):
    """
1537
    Set up initial tools.
1538 1539 1540
    """
    if not 'portal_actions' in p.objectIds():
      PortalGenerator.setupTools(self, p)
1541
      p._delObject('portal_types')
1542

1543
    # It is better to remove portal_catalog
1544
    # which is ZCatalog as soon as possible,
1545
    # because the API is not the completely same as ERP5Catalog,
1546
    # and ZCatalog is useless for ERP5 after all.
1547 1548
    update = kw.get('update', 0)
    portal_catalog = getToolByName(p, 'portal_catalog', None)
1549 1550 1551
    if portal_catalog is not None and \
       portal_catalog.meta_type != 'ZSQLCatalog' and \
       not update:
1552 1553 1554 1555
      p._delObject('portal_catalog')

    # Add CMF Report Tool
    if not p.hasObject('portal_report'):
1556 1557 1558 1559 1560
      try:
        addTool = p.manage_addProduct['CMFReportTool'].manage_addTool
        addTool('CMF Report Tool', None)
      except AttributeError:
        pass
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575

    # Add ERP5 Tools
    addTool = p.manage_addProduct['ERP5'].manage_addTool
    if not p.hasObject('portal_categories'):
      addTool('ERP5 Categories', None)
    if not p.hasObject('portal_ids'):
      addTool('ERP5 Id Tool', None)
    if not p.hasObject('portal_templates'):
      self.setupTemplateTool(p)
    if not p.hasObject('portal_trash'):
      addTool('ERP5 Trash Tool', None)
    if not p.hasObject('portal_alarms'):
      addTool('ERP5 Alarm Tool', None)
    if not p.hasObject('portal_domains'):
      addTool('ERP5 Domain Tool', None)
1576 1577
    if not p.hasObject('portal_tests'):
      addTool('ERP5 Test Tool', None)
1578 1579
    if not p.hasObject('portal_password'):
      addTool('ERP5 Password Tool', None)
1580 1581
    if not p.hasObject('portal_acknowledgements'):
      addTool('ERP5 Acknowledgement Tool', None)
Aurel's avatar
Aurel committed
1582

1583 1584
    # Add ERP5Type Tool
    addTool = p.manage_addProduct['ERP5Type'].manage_addTool
1585 1586
    if not p.hasObject('portal_caches'):
      addTool('ERP5 Cache Tool', None)
1587 1588
    if not p.hasObject('portal_memcached'):
      addTool('ERP5 Memcached Tool', None)
1589 1590
    if not p.hasObject('portal_types'):
      addTool('ERP5 Types Tool', None)
1591 1592
      #transaction.get().beforeCommitHook(lambda:
      #  p.portal_types.Base_setDefaultSecurity())
1593

1594 1595 1596 1597 1598 1599
    try:
      addTool = p.manage_addProduct['ERP5Subversion'].manage_addTool
      if not p.hasObject('portal_subversion'):
        addTool('ERP5 Subversion Tool', None)
    except AttributeError:
      pass
1600

1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
    # Add ERP5Type Tools
    addTool = p.manage_addProduct['ERP5Type'].manage_addTool
    if not p.hasObject('portal_classes'):
      if allowClassTool():
        addTool('ERP5 Class Tool', None)
      else:
        addTool('ERP5 Dummy Class Tool', None)

    # Add ERP5 SQL Catalog Tool
    addTool = p.manage_addProduct['ERP5Catalog'].manage_addTool
    if not p.hasObject('portal_catalog'):
      addTool('ERP5 Catalog', None)
Aurel's avatar
Aurel committed
1613

1614 1615 1616
    # Add Default SQL connection
    if p.erp5_sql_connection_type == 'Z MySQL Database Connection':
      if not p.hasObject('erp5_sql_connection'):
1617 1618
        addSQLConnection = p.manage_addProduct['ZMySQLDA'].\
                                     manage_addZMySQLConnection
1619 1620
        addSQLConnection('erp5_sql_connection',
                         'ERP5 SQL Server Connection',
1621
                         p.erp5_sql_connection_string)
1622 1623
    elif p.erp5_sql_connection_type == 'Z Gadfly':
      pass
1624 1625

    # Add Deferred SQL Connections
1626 1627
    if p.erp5_sql_deferred_connection_type == \
        'Z MySQL Deferred Database Connection':
1628
      if not p.hasObject('erp5_sql_deferred_connection'):
1629 1630
        addSQLConnection = p.manage_addProduct['ZMySQLDDA'].\
            manage_addZMySQLDeferredConnection
1631 1632
        addSQLConnection('erp5_sql_deferred_connection',
                         'ERP5 SQL Server Deferred Connection',
1633
                         p.erp5_sql_deferred_connection_string)
1634 1635 1636 1637
    elif p.erp5_sql_deferred_connection_type == 'Z Gadfly':
      pass

    # Add Activity SQL Connections
1638 1639
    if p.cmf_activity_sql_connection_type == 'Z MySQL Database Connection':
      if not p.hasObject('cmf_activity_sql_connection'):
1640 1641
        addSQLConnection = p.manage_addProduct['ZMySQLDA'].\
                                     manage_addZMySQLConnection
1642 1643
        addSQLConnection('cmf_activity_sql_connection',
                         'CMF Activity SQL Server Connection',
1644
                         p.cmf_activity_sql_connection_string)
1645 1646 1647 1648 1649
      # Warning : This transactionless connection is created with
      # the activity connection string and not the catalog's because
      # it's not compatible with the hot reindexing feature.
      # Though, it has nothing to do with activities.
      # The only difference compared to activity connection is the
Vincent Pelletier's avatar
Vincent Pelletier committed
1650
      # minus prepended to the connection string.
1651 1652 1653 1654 1655
      if not p.hasObject('erp5_sql_transactionless_connection'):
        addSQLConnection = p.manage_addProduct['ZMySQLDA'].\
                                     manage_addZMySQLConnection
        addSQLConnection('erp5_sql_transactionless_connection',
                         'ERP5 Transactionless SQL Server Connection',
Vincent Pelletier's avatar
Typo.  
Vincent Pelletier committed
1656
                         '-%s' % p.cmf_activity_sql_connection_string)
1657 1658
    elif p.cmf_activity_sql_connection_type == 'Z Gadfly':
      pass
1659

1660 1661 1662 1663 1664 1665 1666
    # Add ERP5Form Tools
    addTool = p.manage_addProduct['ERP5Form'].manage_addTool
    if not p.hasObject('portal_selections'):
      addTool('ERP5 Selections', None)
    if not p.hasObject('portal_preferences'):
      addTool('ERP5 Preference Tool', None)

1667 1668 1669 1670 1671 1672 1673
    try:
      # Add ERP5SyncML Tools
      addTool = p.manage_addProduct['ERP5SyncML'].manage_addTool
      if not p.hasObject('portal_synchronizations'):
        addTool('ERP5 Synchronizations', None)
    except AttributeError:
      pass
1674 1675 1676 1677 1678 1679

    # Add Message Catalog
    if not 'Localizer' in p.objectIds():
      addLocalizer = p.manage_addProduct['Localizer'].manage_addLocalizer
      addLocalizer('', ('en',))
    localizer = getToolByName(p, 'Localizer')
1680 1681
    addMessageCatalog = localizer.manage_addProduct['Localizer']\
                                      .manage_addMessageCatalog
1682 1683 1684
    if 'erp5_ui' not in localizer.objectIds():
      if 'default' in localizer.objectIds():
        localizer.manage_delObjects('default')
1685 1686 1687
      addMessageCatalog('default', 'ERP5 Localized Messages', ('en',))
      addMessageCatalog('erp5_ui', 'ERP5 Localized Interface', ('en',))
      addMessageCatalog('erp5_content', 'ERP5 Localized Content', ('en',))
1688

1689 1690 1691
    # Add an error_log
    if 'error_log' not in p.objectIds():
      manage_addErrorLog(p)
1692 1693 1694 1695
      p.error_log.setProperties(keep_entries=20,
                                copy_to_zlog=True,
                                ignored_exceptions=('NotFound', 'Redirect'))

1696 1697 1698

    # Remove unused default actions
    def removeActionsFromTool(tool, remove_list):
1699 1700 1701 1702 1703 1704 1705
      try:
        from Products.CMFCore.interfaces import IActionProvider
        if not IActionProvider.providedBy(tool):
          # On CMF 2.x, some tools (portal_membership)
          # are no longer action providers
          return
      except ImportError:
1706 1707
        # BACK: Currently ERP5 tests don't load ZCML which is needed by the
        # above import on CMF 1.5. This "try" should be removed when ERP5 tests
1708
        # start loading ZCML. 
1709
        pass
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722
      action_id_list = [i.id for i in tool.listActions()]
      remove_index_list = []
      for i in remove_list:
        if i in action_id_list:
          remove_index_list.append(action_id_list.index(i))
      if remove_index_list:
        tool.deleteActions(remove_index_list)
    # membership tool
    removeActionsFromTool(p.portal_membership,
                          ('addFavorite', 'mystuff', 'favorites', 'logged_in',
                           'manage_members'))
    # actions tool
    removeActionsFromTool(p.portal_actions, ('folderContents',))
1723 1724
    # properties tool
    removeActionsFromTool(p.portal_properties, ('configPortal',))
1725 1726 1727 1728
    # remove unused action providers
    for i in ('portal_registration', 'portal_discussion', 'portal_syndication'):
      p.portal_actions.deleteActionProvider(i)

1729 1730
  def setupMembersFolder(self, p):
    """
1731
    ERP5 is not a CMS
1732 1733 1734
    """
    pass

1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
  # this lists only the skin layers of Products.CMFDefault we are actually
  # interested in.
  CMFDEFAULT_FOLDER_LIST = [ 'zpt_content'
                           , 'zpt_generic'
                           , 'zpt_control'
                           , 'Images'
                           ]
  def addCMFDefaultDirectoryViews(self, p):
    """Semi-manually create DirectoryViews since CMFDefault 2.X no longer
    registers the "skins" directory, only its subdirectories, making it
    unusable with Products.CMFCore.DirectoryView.addDirectoryViews."""
    from Products.CMFCore.DirectoryView import createDirectoryView
    try:
      from Products.CMFCore.DirectoryView import _generateKey
1749 1750
      def generateKey(package, subdir):
        return _generateKey(package.__name__, subdir)
1751
    except ImportError:
1752 1753 1754
      # Means we're still on CMF 1.x, were they generate the DirectoryView
      # key using minimalpath
      # ( see Products.CMFCore.DirectoryView.addDirectoryViews() )
1755
      from Products.CMFCore.DirectoryView import minimalpath
1756
      def generateKey(package, subdir):
1757 1758 1759 1760 1761 1762 1763
        package_path = os.path.dirname(package.__file__)
        return minimalpath(os.path.join(package_path, subdir))
    import Products.CMFDefault

    ps = getToolByName(p, 'portal_skins')
    # get the layer directories actually present
    for cmfdefault_skin_layer in self.CMFDEFAULT_FOLDER_LIST:
1764 1765
      reg_key = generateKey(Products.CMFDefault,
                            'skins/' + cmfdefault_skin_layer)
1766 1767
      createDirectoryView(ps, reg_key)

1768 1769 1770 1771
  def setupDefaultSkins(self, p):
    from Products.CMFCore.DirectoryView import addDirectoryViews
    from Products.CMFActivity import cmfactivity_globals
    ps = getToolByName(p, 'portal_skins')
1772
    self.addCMFDefaultDirectoryViews(p)
1773 1774 1775
    addDirectoryViews(ps, 'skins', cmfactivity_globals)
    ps.manage_addProduct['OFSP'].manage_addFolder(id='external_method')
    ps.manage_addProduct['OFSP'].manage_addFolder(id='custom')
1776
    # Set the 'custom' layer a high priority, so it remains the first
1777 1778 1779 1780 1781
    #   layer when installing new business templates.
    ps['custom'].manage_addProperty("business_template_skin_layer_priority", 100.0, "float")
    skin_folder_list = [ 'custom'
                       , 'external_method'
                       , 'activity'
1782
                       ] + self.CMFDEFAULT_FOLDER_LIST
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
    skin_folders = ', '.join(skin_folder_list)
    ps.addSkinSelection( 'View'
                       , skin_folders
                       , make_default = 1
                       )
    ps.addSkinSelection( 'Print'
                       , skin_folders
                       , make_default = 0
                       )
    ps.addSkinSelection( 'CSV'
                       , skin_folders
                       , make_default = 0
                       )
1796 1797 1798 1799
    p.setupCurrentSkin()

  def setupWorkflow(self, p):
    """
1800
    Set up workflows for business templates
1801 1802 1803
    """
    tool = getToolByName(p, 'portal_workflow', None)
    if tool is None:
Jérome Perrin's avatar
Jérome Perrin committed
1804
      return
1805
    for wf_id in ('business_template_building_workflow',
1806
                  'business_template_installation_workflow'):
1807 1808 1809
      if wf_id in tool.objectIds():
        tool.manage_delObjects([wf_id])
    bootstrap_dir = self.getBootstrapDirectory()
1810 1811 1812
    business_template_building_workflow = os.path.join(
                                 bootstrap_dir,
                                 'business_template_building_workflow.xml')
1813
    tool._importObjectFromFile(business_template_building_workflow)
1814 1815 1816
    business_template_installation_workflow = os.path.join(
                                 bootstrap_dir,
                                 'business_template_installation_workflow.xml')
1817 1818
    tool._importObjectFromFile(business_template_installation_workflow)
    tool.setChainForPortalTypes( ( 'Business Template', ),
1819 1820
                                 ( 'business_template_building_workflow',
                                   'business_template_installation_workflow' ) )
1821 1822 1823

  def setupIndex(self, p, **kw):
    # Make sure all tools and folders have been indexed
1824
    if not kw.get('reindex', 1):
1825 1826 1827 1828
      return
    skins_tool = getToolByName(p, 'portal_skins', None)
    if skins_tool is None:
      return
1829
    # When no SQL connection was define on the site,
1830 1831
    # we don't want to make it crash
    if p.erp5_sql_connection_type is not None:
1832
      setattr(p, 'isIndexable', ConstantGetter('isIndexable', value=True))
1833
      portal_catalog = p.portal_catalog
1834 1835
      # Clear portal ids sql table, like this we do not take
      # ids for a previously created web site
1836 1837 1838 1839
      # XXX It's temporary, a New API will be implemented soon
      #     the code will be change
      p.IdTool_zDropTable()
      p.IdTool_zCreateTable()
1840
      # Then clear the catalog and reindex it
1841
      portal_catalog.manage_catalogClear()
1842
      # Calling ERP5Site_reindexAll is useless.
1843

1844 1845 1846 1847 1848
  def setupUserFolder(self, p):
      from Products import ERP5Security
      from Products import PluggableAuthService
      # Use Pluggable Auth Service instead of the standard acl_users.
      p.manage_addProduct['PluggableAuthService'].addPluggableAuthService()
1849
      pas_dispatcher = p.acl_users.manage_addProduct['PluggableAuthService']
1850
      # Add legacy ZODB support
1851 1852 1853
      pas_dispatcher.addZODBUserManager('zodb_users')
      pas_dispatcher.addZODBGroupManager('zodb_groups')
      pas_dispatcher.addZODBRoleManager('zodb_roles')
1854 1855 1856 1857
      # Add CMF Portal Roles
      p.acl_users.zodb_roles.addRole('Member')
      p.acl_users.zodb_roles.addRole('Reviewer')
      # Register ZODB Interface
1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868
      p.acl_users.zodb_users.manage_activateInterfaces(
                                       ('IAuthenticationPlugin',
                                        'IUserEnumerationPlugin',
                                        'IUserAdderPlugin'))
      p.acl_users.zodb_groups.manage_activateInterfaces(
                                       ('IGroupsPlugin',
                                       'IGroupEnumerationPlugin'))
      p.acl_users.zodb_roles.manage_activateInterfaces(
                                       ('IRoleEnumerationPlugin',
                                        'IRolesPlugin',
                                        'IRoleAssignerPlugin'))
1869
      # Add ERP5UserManager
1870 1871 1872 1873 1874
      erp5security_dispatcher = p.acl_users.manage_addProduct['ERP5Security']
      erp5security_dispatcher.addERP5UserManager('erp5_users')
      erp5security_dispatcher.addERP5GroupManager('erp5_groups')
      erp5security_dispatcher.addERP5RoleManager('erp5_roles')
      erp5security_dispatcher.addERP5UserFactory('erp5_user_factory')
1875
      # Register ERP5UserManager Interface
1876 1877 1878
      p.acl_users.erp5_users.manage_activateInterfaces(
                                        ('IAuthenticationPlugin',
                                        'IUserEnumerationPlugin',))
1879 1880
      p.acl_users.erp5_groups.manage_activateInterfaces(('IGroupsPlugin',))
      p.acl_users.erp5_roles.manage_activateInterfaces(('IRolesPlugin',))
1881 1882
      p.acl_users.erp5_user_factory.manage_activateInterfaces(
                                        ('IUserFactoryPlugin',))
1883 1884 1885 1886 1887 1888 1889 1890

  def setupPermissions(self, p):
    permission_dict = {
      'Access Transient Objects'     : ('Manager', 'Anonymous'),
      'Access contents information'  : ('Manager', 'Member', 'Anonymous'),
      'Access future portal content' : ('Manager', 'Reviewer'),
      'Access session data'          : ('Manager', 'Anonymous'),
      'AccessContentsInformation'    : ('Manager', 'Member'),
1891
      'Change local roles'           : ('Manager', ),
1892 1893 1894 1895 1896 1897
      'Add portal content'           : ('Manager', 'Owner'),
      'Add portal folders'           : ('Manager', 'Owner'),
      'Delete objects'               : ('Manager', 'Owner'),
      'FTP access'                   : ('Manager', 'Owner'),
      'List folder contents'         : ('Manager', 'Member'),
      'List portal members'          : ('Manager', 'Member'),
1898
      'List undoable changes'        : ('Manager', ),
1899 1900 1901 1902 1903
      'Manage properties'            : ('Manager', 'Owner'),
      'Modify portal content'        : ('Manager', 'Owner'),
      'Reply to item'                : ('Manager', 'Member'),
      'Review portal content'        : ('Manager', 'Reviewer'),
      'Search ZCatalog'              : ('Manager', 'Member'),
1904
      'Set own password'             : ('Manager', ),
1905
      'Set own properties'           : ('Manager', 'Member'),
1906
      'Use mailhost services'        : ('Manager', 'Member'),
1907
      'Undo changes'                 : ('Manager', 'Owner'),
1908
      'View'                         : ('Manager', 'Member',
1909
                                        'Owner', 'Anonymous'),
1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920
      'View management screens'      : ('Manager', 'Owner')
    }

    for permission in p.ac_inherited_permissions(1):
      name = permission[0]
      role_list = permission_dict.get(name, ('Manager',))
      p.manage_permission(name, roles=role_list, acquire=0)

  def setup(self, p, create_userfolder, **kw):
    update = kw.get('update', 0)

1921 1922 1923
    if getattr(p, 'setDefaultSorting', None) is not None:
      p.setDefaultSorting('id', 0)

1924 1925 1926 1927 1928
    self.setupTools(p, **kw)

    if not p.hasObject('MailHost'):
      self.setupMailHost(p)

Jérome Perrin's avatar
Jérome Perrin committed
1929 1930
    if create_userfolder and not p.hasObject('acl_users'):
      self.setupUserFolder(p)
1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946

    if not p.hasObject('cookie_authentication'):
      self.setupCookieAuth(p)

    if 'Member' not in getattr(p, '__ac_roles__', ()):
      self.setupRoles(p)
    if not update:
      self.setupPermissions(p)
      self.setupDefaultSkins(p)

    # Finish setup
    if not p.hasObject('Members'):
      self.setupMembersFolder(p)

    # ERP5 Design Choice is that all content should be user defined
    # Content is disseminated through business templates
1947
    self.setupPortalTypes(p)
1948 1949 1950 1951 1952 1953 1954 1955 1956

    if not p.hasObject('content_type_registry'):
      self.setupMimetypes(p)
    if not update:
      self.setupWorkflow(p)

    if not update:
      self.setupERP5Core(p,**kw)

1957 1958 1959
    # Make sure the cache is initialized
    p.portal_caches.updateCache()

1960 1961
    self.setupLastTools(p, **kw)

1962 1963 1964 1965 1966
    # Make sure tools are cleanly indexed with a uid before creating children
    # XXX for some strange reason, member was indexed 5 times
    if not update:
      self.setupIndex(p, **kw)

1967
  def setupPortalTypes(self, p):
1968
    """
1969
    Install the portal_type of Business Template
1970 1971 1972 1973
    """
    tool = getToolByName(p, 'portal_types', None)
    if tool is None:
      return
1974
    for t in (BusinessTemplate, ):
1975 1976
      t = t.factory_type_information
      if not tool.hasObject(t['id']):
1977
        tool._setObject(t['id'], ERP5TypeInformation(uid=None, **t))
1978

1979
  def setupERP5Core(self,p,**kw):
1980
    """
1981
    Install the core part of ERP5
1982 1983 1984 1985 1986 1987
    """
    template_tool = getToolByName(p, 'portal_templates', None)
    if template_tool is None:
      return
    if template_tool.getInstalledBusinessTemplate('erp5_core') is None:
      bootstrap_dir = self.getBootstrapDirectory()
1988
      for bt in ('erp5_core', p.erp5_catalog_storage, 'erp5_xhtml_style'):
1989 1990
        if not bt:
          continue
1991 1992 1993 1994 1995 1996 1997
        template = os.path.join(bootstrap_dir, bt)
        if not os.path.exists(template):
          template = os.path.join(bootstrap_dir, '%s.bt5' % bt)

        id = template_tool.generateNewId()
        template_tool.download(template, id=id)
        template_tool[id].install(**kw)