ERP5Site.py 77.3 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 19
import threading
from weakref import ref as weakref
20 21
from Products.ERP5Type import Globals
from Products.ERP5Type.Globals import package_home
22

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

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

49

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

107 108 109 110 111 112 113 114 115 116
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
117
    if item.endswith('.bt5') and os.path.isfile(item):
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
      # 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
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153

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()
154

155 156 157 158 159 160 161
    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
162

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
    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()

182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197

class _site(threading.local):
  """Class for getting and setting the site in the thread global namespace
  """
  site = ()

  def __new__(cls):
    self = threading.local.__new__(cls)
    return self.__get, self.__set

  def __get(self):
    """Returns the currently processed site

    XXX The returned site is not wrapped in a request.
    """
    app, site_id = self.site[-1]
198
    return getattr(app(), site_id)
199 200 201 202 203 204 205 206 207 208 209 210 211 212

  def __set(self, site):
    app = aq_base(site.aq_parent)
    self.site = [x for x in self.site if x[0]() is not app]
    # Use weak references for automatic cleanup. In practice, this is probably
    # useless, because there is no reason a thread reopen the database.
    self.site.append((weakref(app, self.__del), site.id))

  def __del(self, app):
    self.site = [x for x in self.site if x[0] is not app]

getSite, setSite = _site()


213
class ERP5Site(FolderMixIn, CMFSite, CacheCookieMixin):
214
  """
215 216
  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.
217
  """
218
  meta_type = 'ERP5 Site'
219
  portal_type = 'ERP5 Site'
220
  constructors = (('addERP5Site', manage_addERP5SiteForm), manage_addERP5Site, )
221 222 223
  uid = 0
  last_id = 0
  icon = 'portal.gif'
224 225
  # Default value, prevents error during upgrade
  isIndexable = ConstantGetter('isIndexable', value=True)
226 227

  _properties = (
228
      { 'id':'title',
229
        'type':'string'},
230
      { 'id':'description',
231 232
        'type':'text'},
      )
233 234 235 236 237 238 239 240 241
  title = ''
  description = ''

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

  security.declareProtected(Permissions.View, 'view')
  def view(self):
242 243 244 245 246
    """
      Returns the default view.
      Implemented for consistency
    """
    return self.index_html()
247

248 249 250 251 252 253 254 255 256 257 258
  def __of__(self, parent):
    self = CMFSite.__of__(self, parent)
    # Use a transactional variable for performance reason,
    # since ERP5Site.__of__ is called quite often.
    tv = getTransactionalVariable()
    if 'ERP5Site.__of__' not in tv:
      tv['ERP5Site.__of__'] = None
      setSite(self)
      synchronizeDynamicModules(self)
    return self

259 260 261 262 263 264 265 266 267 268 269
  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)

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
  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)

305 306 307 308 309 310 311
  def _getAcquireLocalRoles(self):
    """
      Prevent local roles from being acquired outside of Portal object.
      See ERP5Security/__init__.py:mergedLocalRoles .
    """
    return False

312 313 314 315 316 317 318
  security.declareProtected(Permissions.ManagePortal, 'enableRefererCheck')
  def enableRefererCheck(self):
    """Enable a ReferCheckerBeforeTraverseHook to check users have valid
    HTTP_REFERER
    """
    BeforeTraverse.registerBeforeTraverse(self,
                                        ReferCheckerBeforeTraverseHook(),
319 320 321
                                        ReferCheckerBeforeTraverseHook.handle,
                             # we want to be registered _after_ CookieCrumbler
                                        100)
322

323 324 325 326
  def _disableRefererCheck(self):
    """Disable the HTTP_REFERER check."""
    BeforeTraverse.unregisterBeforeTraverse(self,
                                        ReferCheckerBeforeTraverseHook.handle)
327

328
  def hasObject(self, id):
329
    """
330
    Check if the portal has an id.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
331
    """
332
    return id in self.objectIds()
333

334
  security.declareProtected(Permissions.AccessContentsInformation,
335
                            'getPortalObject')
336 337
  def getPortalObject(self):
    return self
Jean-Paul Smets's avatar
Jean-Paul Smets committed
338

339 340 341 342 343
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalType')
  def getPortalType(self):
    return self.portal_type

344
  security.declareProtected(Permissions.AccessContentsInformation,
345
                            'getTitle')
346 347 348 349 350
  def getTitle(self):
    """
      Return the title.
    """
    return self.title
351

352 353 354 355 356 357
  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
358

359 360 361
      WARNING : must be updates for circular references issues
    """
    return getattr(self, 'uid', 0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
362

363
  security.declareProtected(Permissions.AccessContentsInformation,
364
                            'getParentUid')
365 366 367 368 369
  def getParentUid(self):
    """
      A portal has no parent
    """
    return self.getUid()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
370

371 372 373 374
  # 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
375

376 377 378 379
  # 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
380

381 382
  security.declareProtected(Permissions.AccessContentsInformation, 'getUrl')
  def getUrl(self, REQUEST=None):
383 384 385 386
    """
      Returns the absolute path of an object
    """
    return join(self.getPhysicalPath(),'/')
Sebastien Robin's avatar
Sebastien Robin committed
387

388 389 390 391 392 393 394
  security.declareProtected(Permissions.AccessContentsInformation, 'getRelativeUrl')
  def getRelativeUrl(self):
    """
      Returns the url of an object relative to the portal site.
    """
    return self.getPortalObject().portal_url.getRelativeUrl(self)

395 396 397 398
  # Old name - for compatibility
  security.declareProtected(Permissions.AccessContentsInformation, 'getPath')
  getPath = getUrl

399 400 401 402 403 404
  security.declareProtected(Permissions.AccessContentsInformation, 'opaqueValues')
  def opaqueValues(self, *args, **kw):
    # XXX nonsense of inheriting from CMFSite that calls __before_traversal__
    # and tries to load subobjects of the portal too early
    return []

405
  security.declareProtected(Permissions.AccessContentsInformation, 'searchFolder')
406 407 408 409 410 411 412
  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
413
    return self.portal_catalog.searchResults(**kw)
414 415 416 417 418 419 420 421 422

  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
423
    return self.portal_catalog.countResults(**kw)
424 425 426 427 428 429 430 431

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

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

434
    This should absolutely be rewritten by using clean
435
    concepts to separate worklists XXX
436 437 438 439 440 441
    """
    sorted_workflow_actions = {}
    sorted_global_actions = []
    other_global_actions = []
    for action in action_list:
      action['disabled'] = 0
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
442 443 444 445 446 447 448 449 450 451
      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)
452 453
      else:
        other_global_actions.append(action)
454
    for key in sorted(sorted_workflow_actions):
455 456 457 458 459 460
      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,
461 462 463
                             email_from_address, email_from_name,
                             validate_email
                             ):
464
    CMFSite.setupDefaultProperties(self, p, title, description,
465 466
                           email_from_address, email_from_name,
                           validate_email)
467

468 469 470
  # 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
471
  # to customize the settings for each portal site.
472 473
  def _getPortalConfiguration(self, id):
    """
474
    Get a portal-specific configuration.
475

476 477
    Current implementation is using properties in a portal object.
    If not found, try to get a default value for backward compatibility.
478

479 480
    This implementation can be improved by gathering information
    from appropriate places, such as portal_types, portal_categories
481
    and portal_workflow.
482 483 484
    """
    if self.hasProperty(id):
      return self.getProperty(id)
485

486 487
    # Fall back to the default.
    return getattr(ERP5Defaults, id, None)
488

489
  def _getPortalGroupedTypeList(self, group, enable_sort=True):
490
    """
491
    Return a list of portal types classified to a specific group.
492 493
    The result is sorted by language (using the user language
    as default)
494 495 496

    Enable_sort parameter was added in order to allows looking groups
    of portal type without sorting. This is better for performance
497 498 499
    """
    def getTypeList(group):
      type_list = []
Jérome Perrin's avatar
Jérome Perrin committed
500
      for pt in self.portal_types.listTypeInfo():
501 502
        if group in getattr(pt, 'group_list', ()):
          type_list.append(pt.getId())
503

504 505 506 507
      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
508 509
        translate = localizer_tool.translate
        type_list.sort(key=lambda x:translate('ui', x))
510 511
      return tuple(type_list)

512 513 514 515
    localizer_tool = getToolByName(self, 'Localizer')
    language = localizer_tool.get_selected_language()
    # language should be cached in Transaction Cache if performance issue

516
    getTypeList = CachingMethod(getTypeList,
517 518 519 520
                                id=(('_getPortalGroupedTypeList', language), group,
                                    enable_sort),
                                cache_factory='erp5_content_medium',
                                )
521 522 523

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

525 526 527 528 529 530 531 532 533
  @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))

534
  def _getPortalGroupedCategoryList(self, group):
535
    """
536
    Return a list of base categories classified to a specific group.
537 538 539 540 541 542 543 544
    """
    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)

545 546
    getCategoryList = CachingMethod(
                            getCategoryList,
547
                            id=('_getPortalGroupedCategoryList', group),
Aurel's avatar
Aurel committed
548
                            cache_factory='erp5_content_medium')
549 550 551
    return getCategoryList(group)

  def _getPortalGroupedStateList(self, group):
552
    """
553
    Return a list of workflow states classified to a specific group.
554 555 556 557 558 559 560 561 562 563
    """
    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())

564
    getStateList = CachingMethod(getStateList,
565
                                 id=('_getPortalGroupedStateList', group),
Aurel's avatar
Aurel committed
566
                                 cache_factory='erp5_content_medium')
567 568
    return getStateList(group)

569 570
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDefaultSectionCategory')
571 572
  def getPortalDefaultSectionCategory(self):
    """
573
    Return a default section category. This method is deprecated.
574 575 576 577
    """
    LOG('ERP5Site', 0, 'getPortalDefaultSectionCategory is deprecated;'+
        ' use portal_preferences.getPreferredSectionCategory instead.')
    section_category = self.portal_preferences.getPreferredSectionCategory()
578

579 580 581 582
    # XXX This is only for backward-compatibility.
    if not section_category:
      section_category = self._getPortalConfiguration(
                                'portal_default_section_category')
583

584
    return section_category
585

586 587 588 589 590 591
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalResourceTypeList')
  def getPortalResourceTypeList(self):
    """
      Return resource types.
    """
592 593 594
    return self._getPortalGroupedTypeList('resource') or \
           self._getPortalConfiguration('portal_resource_type_list')

595 596 597 598 599 600 601
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSubVariationTypeList')
  def getPortalSubVariationTypeList(self):
    """
      Return resource types.
    """
    return self._getPortalGroupedTypeList('sub_variation')
602

603 604 605 606 607 608 609
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSubVariationBaseCategoryList')
  def getPortalSubVariationBaseCategoryList(self):
    """
      Return variation base categories.
    """
    return self._getPortalGroupedCategoryList('sub_variation')
610

611 612 613 614 615 616
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalVariationTypeList')
  def getPortalVariationTypeList(self):
    """
      Return variation types.
    """
617 618 619
    return self._getPortalGroupedTypeList('variation') or \
           self._getPortalConfiguration('portal_variation_type_list')

620 621 622 623 624 625
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalNodeTypeList')
  def getPortalNodeTypeList(self):
    """
      Return node types.
    """
626 627 628
    return self._getPortalGroupedTypeList('node') or \
           self._getPortalConfiguration('portal_node_type_list')

629 630 631 632 633 634
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPaymentNodeTypeList')
  def getPortalPaymentNodeTypeList(self):
    """
      Return payment node types.
    """
635 636 637
    return self._getPortalGroupedTypeList('payment_node') or \
           self._getPortalConfiguration('portal_payment_node_type_list')

638 639 640 641 642 643
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInvoiceTypeList')
  def getPortalInvoiceTypeList(self):
    """
      Return invoice types.
    """
644 645 646
    return self._getPortalGroupedTypeList('invoice') or \
           self._getPortalConfiguration('portal_invoice_type_list')

647 648 649 650 651 652
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOrderTypeList')
  def getPortalOrderTypeList(self):
    """
      Return order types.
    """
653 654 655
    return self._getPortalGroupedTypeList('order') or \
           self._getPortalConfiguration('portal_order_type_list')

656 657 658 659 660 661
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDeliveryTypeList')
  def getPortalDeliveryTypeList(self):
    """
      Return delivery types.
    """
662 663 664
    return self._getPortalGroupedTypeList('delivery') or \
           self._getPortalConfiguration('portal_delivery_type_list')

665 666 667 668 669 670
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTransformationTypeList')
  def getPortalTransformationTypeList(self):
    """
      Return transformation types.
    """
671 672 673
    return self._getPortalGroupedTypeList('transformation') or \
           self._getPortalConfiguration('portal_transformation_type_list')

674 675 676 677 678 679 680 681 682
  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')

683 684 685 686 687 688
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalVariationBaseCategoryList')
  def getPortalVariationBaseCategoryList(self):
    """
      Return variation base categories.
    """
689 690 691
    return self._getPortalGroupedCategoryList('variation') or \
           self._getPortalConfiguration('portal_variation_base_category_list')

692 693 694 695 696 697
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOptionBaseCategoryList')
  def getPortalOptionBaseCategoryList(self):
    """
      Return option base categories.
    """
698 699 700
    return self._getPortalGroupedCategoryList('option') or \
           self._getPortalConfiguration('portal_option_base_category_list')

701 702 703 704 705 706
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInvoiceMovementTypeList')
  def getPortalInvoiceMovementTypeList(self):
    """
      Return invoice movement types.
    """
707 708 709
    return self._getPortalGroupedTypeList('invoice_movement') or \
           self._getPortalConfiguration('portal_invoice_movement_type_list')

710 711 712 713 714 715 716 717 718 719
  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')


720 721 722 723 724 725
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOrderMovementTypeList')
  def getPortalOrderMovementTypeList(self):
    """
      Return order movement types.
    """
726 727 728
    return self._getPortalGroupedTypeList('order_movement') or \
           self._getPortalConfiguration('portal_order_movement_type_list')

729 730 731 732 733 734
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDeliveryMovementTypeList')
  def getPortalDeliveryMovementTypeList(self):
    """
      Return delivery movement types.
    """
735 736 737
    return self._getPortalGroupedTypeList('delivery_movement') or \
           self._getPortalConfiguration('portal_delivery_movement_type_list')

738
  security.declareProtected(Permissions.AccessContentsInformation,
739
                            'getPortalSupplyTypeList')
740 741 742 743
  def getPortalSupplyTypeList(self):
    """
      Return supply types.
    """
744 745 746
    return self._getPortalGroupedTypeList('supply') or \
           self._getPortalConfiguration('portal_supply_type_list')

747 748 749 750 751 752 753 754
  security.declareProtected(Permissions.AccessContentsInformation,
                              'getPortalRuleTypeList')
  def getPortalRuleTypeList(self):
    """
      Return rule types.
    """
    return self._getPortalGroupedTypeList('rule')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
755 756 757 758
  security.declareProtected(Permissions.AccessContentsInformation,
                              'getPortalProjectTypeList')
  def getPortalProjectTypeList(self):
    """
759
      Return project types.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
760 761 762
    """
    return self._getPortalGroupedTypeList('project')

763
  security.declareProtected(Permissions.AccessContentsInformation,
764 765 766 767 768
                              'getPortalDocumentTypeList')
  def getPortalDocumentTypeList(self):
    """
      Return document types.
    """
769
    return self._getPortalGroupedTypeList('document')
770 771 772 773 774 775 776 777 778

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

779 780 781 782
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalFileDocumentTypeList')
  def getPortalFileDocumentTypeList(self):
    """
783
      Return file document types.
784 785 786 787 788 789 790
    """
    return self._getPortalGroupedTypeList('file_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalRecentDocumentTypeList')
  def getPortalRecentDocumentTypeList(self):
    """
791
      Return recent document types.
792 793 794 795 796 797 798
    """
    return self._getPortalGroupedTypeList('recent_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTemplateDocumentTypeList')
  def getPortalTemplateDocumentTypeList(self):
    """
799
      Return template document types.
800 801 802 803 804 805 806
    """
    return self._getPortalGroupedTypeList('template_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMyDocumentTypeList')
  def getPortalMyDocumentTypeList(self):
    """
807
      Return my document types.
808 809 810
    """
    return self._getPortalGroupedTypeList('my_document')

811 812 813 814
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalCrawlerIndexTypeList')
  def getPortalCrawlerIndexTypeList(self):
    """
815
      Return crawler index types.
816 817 818
    """
    return self._getPortalGroupedTypeList('crawler_index')

819 820 821 822 823 824 825 826
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBudgetVariationTypeList')
  def getPortalBudgetVariationTypeList(self):
    """
      Return budget variation types.
    """
    return self._getPortalGroupedTypeList('budget_variation')

827
  security.declareProtected(Permissions.AccessContentsInformation,
828
                            'getPortalSupplyPathTypeList')
829 830
  def getPortalSupplyPathTypeList(self):
    """
831
      Return supply path types.
832
    """
833 834 835
    return self._getPortalGroupedTypeList('supply_path') or \
           self._getPortalConfiguration('portal_supply_path_type_list')

836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
  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')

863 864 865 866 867 868 869
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAcquisitionMovementTypeList')
  def getPortalAcquisitionMovementTypeList(self):
    """
      Return acquisition movement types.
    """
    return tuple(list(self.getPortalOrderMovementTypeList()) +
870
                 list(self.getPortalDeliveryMovementTypeList()) +
871
                 list(self.getPortalTaxMovementTypeList()) +
872 873
                 list(self.getPortalInvoiceMovementTypeList()))

874 875 876 877 878 879 880
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMovementTypeList')
  def getPortalMovementTypeList(self):
    """
      Return movement types.
    """
    return tuple(list(self.getPortalOrderMovementTypeList()) +
881 882
                 list(self.getPortalDeliveryMovementTypeList()) +
                 list(self.getPortalInvoiceMovementTypeList()) +
883
                 list(self.getPortalTaxMovementTypeList()) +
884
                 list(self.getPortalAccountingMovementTypeList()) +
885
                 ['Simulation Movement'])
886

887 888 889 890 891 892
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSimulatedMovementTypeList')
  def getPortalSimulatedMovementTypeList(self):
    """
      Return simulated movement types.
    """
893
    return tuple([x for x in self.getPortalMovementTypeList() \
894
                  if x not in self.getPortalContainerTypeList()])
895

896 897 898 899 900 901
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalContainerTypeList')
  def getPortalContainerTypeList(self):
    """
      Return container types.
    """
902 903 904
    return self._getPortalGroupedTypeList('container') or \
           self._getPortalConfiguration('portal_container_type_list')

905 906 907 908 909 910
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalContainerLineTypeList')
  def getPortalContainerLineTypeList(self):
    """
      Return container line types.
    """
911 912 913
    return self._getPortalGroupedTypeList('container_line') or \
           self._getPortalConfiguration('portal_container_line_type_list')

914 915 916 917 918 919
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalItemTypeList')
  def getPortalItemTypeList(self):
    """
      Return item types.
    """
920 921 922
    return self._getPortalGroupedTypeList('item') or \
           self._getPortalConfiguration('portal_item_type_list')

923 924 925 926 927 928
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDiscountTypeList')
  def getPortalDiscountTypeList(self):
    """
      Return discount types.
    """
929 930 931
    return self._getPortalGroupedTypeList('discount') or \
           self._getPortalConfiguration('portal_discount_type_list')

932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
  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')

950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSaleTypeList')
  def getPortalSaleTypeList(self):
    """
    Return sale types.
    """
    return self._getPortalGroupedTypeList('sale')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPurchaseTypeList')
  def getPortalPurchaseTypeList(self):
    """
    Return purchase types.
    """
    return self._getPortalGroupedTypeList('purchase')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInternalTypeList')
  def getPortalInternalTypeList(self):
    """
    Return internal types.
    """
    return self._getPortalGroupedTypeList('internal')

974 975 976 977 978 979
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAlarmTypeList')
  def getPortalAlarmTypeList(self):
    """
      Return alarm types.
    """
980 981 982
    return self._getPortalGroupedTypeList('alarm') or \
           self._getPortalConfiguration('portal_alarm_type_list')

983 984 985 986 987 988
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPaymentConditionTypeList')
  def getPortalPaymentConditionTypeList(self):
    """
      Return payment condition types.
    """
989 990 991
    return self._getPortalGroupedTypeList('payment_condition') or \
           self._getPortalConfiguration('portal_payment_condition_type_list')

992 993 994 995 996 997
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBalanceTransactionLineTypeList')
  def getPortalBalanceTransactionLineTypeList(self):
    """
      Return balance transaction line types.
    """
998
    return self._getPortalGroupedTypeList('balance_transaction_line') or \
999 1000
           self._getPortalConfiguration(
                  'portal_balance_transaction_line_type_list')
1001

1002 1003 1004 1005 1006 1007
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalCurrentInventoryStateList')
  def getPortalCurrentInventoryStateList(self):
    """
      Return current inventory states.
    """
1008 1009 1010
    return self._getPortalGroupedStateList('current_inventory') or \
           self._getPortalConfiguration('portal_current_inventory_state_list')

1011 1012 1013 1014 1015 1016 1017 1018 1019
  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')

1020 1021 1022 1023 1024 1025
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDraftOrderStateList')
  def getPortalDraftOrderStateList(self):
    """
      Return draft order states.
    """
1026 1027 1028
    return self._getPortalGroupedStateList('draft_order') or \
           self._getPortalConfiguration('portal_draft_order_state_list')

1029 1030 1031 1032 1033 1034
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPlannedOrderStateList')
  def getPortalPlannedOrderStateList(self):
    """
      Return planned order states.
    """
1035 1036 1037
    return self._getPortalGroupedStateList('planned_order') or \
           self._getPortalConfiguration('portal_planned_order_state_list')

1038 1039 1040 1041 1042 1043
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalReservedInventoryStateList')
  def getPortalReservedInventoryStateList(self):
    """
      Return reserved inventory states.
    """
1044
    return self._getPortalGroupedStateList('reserved_inventory') or \
1045
        self._getPortalConfiguration('portal_reserved_inventory_state_list')
1046

1047 1048 1049 1050 1051 1052
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalFutureInventoryStateList')
  def getPortalFutureInventoryStateList(self):
    """
      Return future inventory states.
    """
1053 1054 1055
    return self._getPortalGroupedStateList('future_inventory') or \
           self._getPortalConfiguration('portal_future_inventory_state_list')

1056
  security.declareProtected(Permissions.AccessContentsInformation,
1057
                          'getPortalUpdatableAmortisationTransactionStateList')
1058 1059
  def getPortalUpdatableAmortisationTransactionStateList(self):
    """
1060
      Return states when Amortisation Transaction can be updated
1061
      by amortisation_transaction_builder.
1062
    """
1063 1064
    return self._getPortalConfiguration(
        'portal_updatable_amortisation_transaction_state_list')
1065

1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
  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()

1088 1089 1090 1091 1092 1093
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalColumnBaseCategoryList')
  def getPortalColumnBaseCategoryList(self):
    """
      Return column base categories.
    """
1094 1095 1096
    return self._getPortalGroupedCategoryList('column') or \
           self._getPortalConfiguration('portal_column_base_category_list')

1097 1098 1099 1100 1101 1102
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalLineBaseCategoryList')
  def getPortalLineBaseCategoryList(self):
    """
      Return line base categories.
    """
1103 1104 1105
    return self._getPortalGroupedCategoryList('line') or \
           self._getPortalConfiguration('portal_line_base_category_list')

1106 1107 1108 1109 1110 1111
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTabBaseCategoryList')
  def getPortalTabBaseCategoryList(self):
    """
      Return tab base categories.
    """
1112 1113 1114
    return self._getPortalGroupedCategoryList('tab') or \
           self._getPortalConfiguration('portal_tab_base_category_list')

1115 1116 1117 1118
  def getPortalDefaultGapRoot(self):
    """
      Return the Accounting Plan to use by default (return the root node)
    """
1119
    LOG('ERP5Site', 0,
1120 1121 1122
        'getPortalDefaultGapRoot is deprecated; ' \
        'use portal_preferences.getPreferredAccountingTransactionGap instead.')

1123 1124
    return self.portal_preferences.getPreferredAccountingTransactionGap() or \
           self._getPortalConfiguration('portal_default_gap_root')
1125

1126 1127 1128 1129
  def getPortalAccountingMovementTypeList(self) :
    """
      Return accounting movement type list.
    """
1130
    return self._getPortalGroupedTypeList('accounting_movement') or \
1131
        self._getPortalConfiguration('portal_accounting_movement_type_list')
1132

1133 1134 1135 1136
  def getPortalAccountingTransactionTypeList(self) :
    """
      Return accounting transaction movement type list.
    """
1137
    return self._getPortalGroupedTypeList('accounting_transaction') or \
1138
      self._getPortalConfiguration('portal_accounting_transaction_type_list')
1139

1140 1141 1142 1143
  def getPortalAssignmentBaseCategoryList(self):
    """
      Return List of category values to generate security groups.
    """
1144
    return self._getPortalGroupedCategoryList('assignment') or \
1145
        self._getPortalConfiguration('portal_assignment_base_category_list')
1146

1147 1148
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTicketTypeList')
1149 1150 1151 1152 1153
  def getPortalTicketTypeList(self):
    """
    Return ticket types.
    """
    return self._getPortalGroupedTypeList('ticket')
1154

1155 1156
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalEventTypeList')
1157 1158 1159 1160 1161
  def getPortalEventTypeList(self):
    """
    Return event types.
    """
    return self._getPortalGroupedTypeList('event')
1162

1163 1164 1165 1166 1167 1168 1169 1170
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDivergenceTesterTypeList')
  def getPortalDivergenceTesterTypeList(self):
    """
    Return divergence tester types.
    """
    return self._getPortalGroupedTypeList('divergence_tester')

1171 1172 1173 1174 1175 1176 1177 1178
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTargetSolverTypeList')
  def getPortalTargetSolverTypeList(self):
    """
    Return target solver types.
    """
    return self._getPortalGroupedTypeList('target_solver')

1179 1180 1181 1182 1183 1184 1185 1186
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTargetSolverTypeList')
  def getPortalDeliverySolverTypeList(self):
    """
    Return delivery solver types.
    """
    return self._getPortalGroupedTypeList('delivery_solver')

1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
  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')

1211 1212 1213 1214 1215 1216 1217 1218
  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
1219 1220 1221 1222 1223 1224 1225 1226
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalModuleTypeList')
  def getPortalModuleTypeList(self):
    """
    Return module types.
    """
    return self._getPortalGroupedTypeList('module')

1227 1228 1229 1230 1231 1232 1233 1234
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInventoryMovementTypeList')
  def getPortalInventoryMovementTypeList(self):
    """
    Return inventory movement types.
    """
    return self._getPortalGroupedTypeList('inventory_movement')

1235 1236 1237 1238 1239 1240 1241 1242
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInventoryTypeList')
  def getPortalInventoryTypeList(self):
    """
    Return inventory types.
    """
    return self._getPortalGroupedTypeList('inventory')

1243 1244 1245 1246 1247 1248 1249 1250
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMovementGroupTypeList')
  def getPortalMovementGroupTypeList(self):
    """
    Return movement group types.
    """
    return self._getPortalGroupedTypeList('movement_group')

1251 1252
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDefaultModuleId')
1253 1254
  def getDefaultModuleId(self, portal_type, default=MARKER):
    """
Romain Courteaud's avatar
Romain Courteaud committed
1255 1256
    Return default module id where a object with portal_type can
    be created.
1257 1258
    """
    portal_object = self
Romain Courteaud's avatar
Romain Courteaud committed
1259 1260 1261 1262 1263
    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
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
    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
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289

    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
1290

1291 1292
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDefaultModule')
1293
  def getDefaultModule(self, portal_type, default=MARKER):
1294 1295 1296
    """
      Return default module where a object with portal_type can be created
    """
1297 1298 1299 1300
    module_id = self.getDefaultModuleId(portal_type, default)
    if module_id:
      return getattr(self, module_id, None)
    return None
1301

1302
  security.declareProtected(Permissions.AddPortalContent, 'newContent')
1303
  def newContent(self, id=None, portal_type=None, **kw):
1304 1305 1306 1307 1308 1309 1310
    """
      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'
1311 1312 1313 1314
    self.portal_types.constructContent(type_name=portal_type,
                                       container=self,
                                       id=id,
                                       ) # **kw) removed due to CMF bug
1315
    new_instance = self[id]
1316

1317
    if kw:
1318
      new_instance._edit(force_update=1, **kw)
1319 1320
    return new_instance

1321 1322 1323 1324 1325 1326
  security.declarePublic('getVisibleAllowedContentTypeList')
  def getVisibleAllowedContentTypeList(self):
    """Users cannot add anything in an ERP5Site using standard interface.
    """
    return ()

1327 1328 1329 1330 1331 1332
  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)
1333

1334 1335 1336 1337 1338
  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.
1339
    tv = getTransactionalVariable()
1340 1341 1342 1343 1344 1345 1346 1347
    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.
1348
    tv = getTransactionalVariable()
1349 1350 1351 1352 1353 1354 1355
    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.
1356
    tv = getTransactionalVariable()
1357 1358 1359 1360 1361 1362 1363
    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.
1364
    tv = getTransactionalVariable()
1365 1366 1367
    key = ('default_activate_parameter', )
    return tv.get(key)

1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
  security.declareProtected(Permissions.ManagePortal, 'getERP5SiteGlobalId')
  def getERP5SiteGlobalId(self):
    """Returns site global ID without any fallback"""
    return getattr(self, 'erp5_site_global_id', None)

  security.declareProtected(Permissions.ManagePortal, 'setERP5SiteGlobalId')
  def setERP5SiteGlobalId(self, global_id):
    """Sets site global ID, only in case if not set yet
    
    Such id should be very big and random, for example uuid version 4, as
    defined in RFC 4122.
    """
    if self.getERP5SiteGlobalId() in [None, '']:
      self.erp5_site_global_id = global_id

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1383 1384
Globals.InitializeClass(ERP5Site)

1385 1386 1387 1388 1389 1390 1391
def getBootstrapDirectory():
  """
    Return the name of the bootstrap directory
  """
  product_path = package_home(globals())
  return os.path.join(product_path, 'bootstrap')

1392 1393 1394 1395 1396 1397 1398 1399
def getBootstrapBusinessTemplateUrl(bt_title):
  """
    Return the path to download the given bootstrap business template
  """
  path = os.path.join(getBootstrapDirectory(), bt_title)
  if not os.path.exists(path):
    path += '.bt5'
  return path
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 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493

# 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 setupRoles(self, p):
        # Set up the suggested roles.
        p.__ac_roles__ = ('Member', 'Reviewer',)

    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 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
1494 1495
class ERP5Generator(PortalGenerator):

1496
  klass = ERP5Site
1497

1498 1499 1500
  def create(self,
             parent,
             id,
1501
             create_userfolder,
1502
             erp5_catalog_storage,
1503
             erp5_sql_connection_type,
1504
             erp5_sql_connection_string,
1505
             erp5_sql_deferred_connection_type,
1506 1507
             cmf_activity_sql_connection_type,
             cmf_activity_sql_connection_string,
1508
             create_activities=True,
1509 1510
             reindex=1,
             **kw):
1511 1512
    id = str(id)
    portal = self.klass(id=id)
1513 1514
    # Make sure reindex will not be called until business templates
    # will be installed
1515
    setattr(portal, 'isIndexable', ConstantGetter('isIndexable', value=False))
1516 1517 1518
    parent._setObject(id, portal)
    # Return the fully wrapped object.
    p = parent.this()._getOb(id)
1519 1520

    erp5_sql_deferred_connection_string = erp5_sql_connection_string
1521 1522
    p._setProperty('erp5_catalog_storage',
                   erp5_catalog_storage, 'string')
1523
    p._setProperty('erp5_sql_connection_type',
1524
                   erp5_sql_connection_type, 'string')
1525
    p._setProperty('erp5_sql_connection_string',
1526
                   erp5_sql_connection_string, 'string')
1527
    p._setProperty('erp5_sql_deferred_connection_type',
1528
                   erp5_sql_deferred_connection_type, 'string')
1529
    p._setProperty('erp5_sql_deferred_connection_string',
1530
                   erp5_sql_deferred_connection_string, 'string')
1531
    p._setProperty('cmf_activity_sql_connection_type',
1532
                   cmf_activity_sql_connection_type, 'string')
1533
    p._setProperty('cmf_activity_sql_connection_string',
1534
                   cmf_activity_sql_connection_string, 'string')
1535
    p._setProperty('management_page_charset', 'UTF-8', 'string')
1536 1537
    self.setup(p, create_userfolder, create_activities=create_activities,
        reindex=reindex, **kw)
1538 1539 1540 1541
    return p

  def setupLastTools(self, p, **kw):
    """
1542 1543 1544
    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
1545 1546
    """
    # Add Activity Tool
1547
    if kw.get('create_activities', False):
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558
      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)
1559

1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
    # 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)


1573 1574
  def setupTemplateTool(self, p, **kw):
    """
1575
    Setup the Template Tool. Security must be set strictly.
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
    """
    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):
    """
1586
    Set up initial tools.
1587 1588 1589
    """
    if not 'portal_actions' in p.objectIds():
      PortalGenerator.setupTools(self, p)
1590
      p._delObject('portal_types')
1591

1592
    # It is better to remove portal_catalog
1593
    # which is ZCatalog as soon as possible,
1594
    # because the API is not the completely same as ERP5Catalog,
1595
    # and ZCatalog is useless for ERP5 after all.
1596 1597
    update = kw.get('update', 0)
    portal_catalog = getToolByName(p, 'portal_catalog', None)
1598 1599 1600
    if portal_catalog is not None and \
       portal_catalog.meta_type != 'ZSQLCatalog' and \
       not update:
1601 1602 1603 1604
      p._delObject('portal_catalog')

    # Add CMF Report Tool
    if not p.hasObject('portal_report'):
1605 1606 1607 1608 1609
      try:
        addTool = p.manage_addProduct['CMFReportTool'].manage_addTool
        addTool('CMF Report Tool', None)
      except AttributeError:
        pass
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624

    # 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)
1625 1626
    if not p.hasObject('portal_tests'):
      addTool('ERP5 Test Tool', None)
1627 1628
    if not p.hasObject('portal_password'):
      addTool('ERP5 Password Tool', None)
1629 1630
    if not p.hasObject('portal_acknowledgements'):
      addTool('ERP5 Acknowledgement Tool', None)
Aurel's avatar
Aurel committed
1631

1632 1633
    # Add ERP5Type Tool
    addTool = p.manage_addProduct['ERP5Type'].manage_addTool
1634 1635
    if not p.hasObject('portal_caches'):
      addTool('ERP5 Cache Tool', None)
1636 1637
    if not p.hasObject('portal_memcached'):
      addTool('ERP5 Memcached Tool', None)
1638 1639
    if not p.hasObject('portal_types'):
      addTool('ERP5 Types Tool', None)
1640

1641 1642 1643 1644 1645 1646
    try:
      addTool = p.manage_addProduct['ERP5Subversion'].manage_addTool
      if not p.hasObject('portal_subversion'):
        addTool('ERP5 Subversion Tool', None)
    except AttributeError:
      pass
1647

1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
    # 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
1660

1661 1662 1663
    # Add Default SQL connection
    if p.erp5_sql_connection_type == 'Z MySQL Database Connection':
      if not p.hasObject('erp5_sql_connection'):
1664 1665
        addSQLConnection = p.manage_addProduct['ZMySQLDA'].\
                                     manage_addZMySQLConnection
1666 1667
        addSQLConnection('erp5_sql_connection',
                         'ERP5 SQL Server Connection',
1668
                         p.erp5_sql_connection_string)
1669 1670
    elif p.erp5_sql_connection_type == 'Z Gadfly':
      pass
1671 1672

    # Add Deferred SQL Connections
1673 1674
    if p.erp5_sql_deferred_connection_type == \
        'Z MySQL Deferred Database Connection':
1675
      if not p.hasObject('erp5_sql_deferred_connection'):
1676 1677
        addSQLConnection = p.manage_addProduct['ZMySQLDDA'].\
            manage_addZMySQLDeferredConnection
1678 1679
        addSQLConnection('erp5_sql_deferred_connection',
                         'ERP5 SQL Server Deferred Connection',
1680
                         p.erp5_sql_deferred_connection_string)
1681 1682 1683 1684
    elif p.erp5_sql_deferred_connection_type == 'Z Gadfly':
      pass

    # Add Activity SQL Connections
1685 1686
    if p.cmf_activity_sql_connection_type == 'Z MySQL Database Connection':
      if not p.hasObject('cmf_activity_sql_connection'):
1687 1688
        addSQLConnection = p.manage_addProduct['ZMySQLDA'].\
                                     manage_addZMySQLConnection
1689 1690
        addSQLConnection('cmf_activity_sql_connection',
                         'CMF Activity SQL Server Connection',
1691
                         p.cmf_activity_sql_connection_string)
1692 1693 1694 1695 1696
      # 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
1697
      # minus prepended to the connection string.
1698 1699 1700 1701 1702
      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
1703
                         '-%s' % p.cmf_activity_sql_connection_string)
1704 1705
    elif p.cmf_activity_sql_connection_type == 'Z Gadfly':
      pass
1706

1707 1708 1709 1710 1711 1712 1713
    # 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)

1714 1715 1716 1717 1718 1719 1720
    try:
      # Add ERP5SyncML Tools
      addTool = p.manage_addProduct['ERP5SyncML'].manage_addTool
      if not p.hasObject('portal_synchronizations'):
        addTool('ERP5 Synchronizations', None)
    except AttributeError:
      pass
1721 1722 1723 1724 1725 1726

    # Add Message Catalog
    if not 'Localizer' in p.objectIds():
      addLocalizer = p.manage_addProduct['Localizer'].manage_addLocalizer
      addLocalizer('', ('en',))
    localizer = getToolByName(p, 'Localizer')
1727 1728
    addMessageCatalog = localizer.manage_addProduct['Localizer']\
                                      .manage_addMessageCatalog
1729 1730 1731
    if 'erp5_ui' not in localizer.objectIds():
      if 'default' in localizer.objectIds():
        localizer.manage_delObjects('default')
1732 1733 1734
      addMessageCatalog('default', 'ERP5 Localized Messages', ('en',))
      addMessageCatalog('erp5_ui', 'ERP5 Localized Interface', ('en',))
      addMessageCatalog('erp5_content', 'ERP5 Localized Content', ('en',))
1735

1736 1737 1738
    # Add an error_log
    if 'error_log' not in p.objectIds():
      manage_addErrorLog(p)
1739 1740 1741 1742
      p.error_log.setProperties(keep_entries=20,
                                copy_to_zlog=True,
                                ignored_exceptions=('NotFound', 'Redirect'))

1743 1744 1745

    # Remove unused default actions
    def removeActionsFromTool(tool, remove_list):
1746 1747 1748 1749 1750 1751 1752
      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:
1753 1754
        # 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
1755
        # start loading ZCML. 
1756
        pass
1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769
      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',))
1770 1771
    # properties tool
    removeActionsFromTool(p.portal_properties, ('configPortal',))
1772 1773 1774 1775
    # remove unused action providers
    for i in ('portal_registration', 'portal_discussion', 'portal_syndication'):
      p.portal_actions.deleteActionProvider(i)

1776 1777
  def setupMembersFolder(self, p):
    """
1778
    ERP5 is not a CMS
1779 1780 1781
    """
    pass

1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
  # 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
1796 1797
      def generateKey(package, subdir):
        return _generateKey(package.__name__, subdir)
1798
    except ImportError:
1799 1800 1801
      # Means we're still on CMF 1.x, were they generate the DirectoryView
      # key using minimalpath
      # ( see Products.CMFCore.DirectoryView.addDirectoryViews() )
1802
      from Products.CMFCore.DirectoryView import minimalpath
1803
      def generateKey(package, subdir):
1804 1805 1806 1807 1808 1809 1810
        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:
1811 1812
      reg_key = generateKey(Products.CMFDefault,
                            'skins/' + cmfdefault_skin_layer)
1813 1814
      createDirectoryView(ps, reg_key)

1815 1816 1817 1818
  def setupDefaultSkins(self, p):
    from Products.CMFCore.DirectoryView import addDirectoryViews
    from Products.CMFActivity import cmfactivity_globals
    ps = getToolByName(p, 'portal_skins')
1819
    self.addCMFDefaultDirectoryViews(p)
1820 1821 1822
    addDirectoryViews(ps, 'skins', cmfactivity_globals)
    ps.manage_addProduct['OFSP'].manage_addFolder(id='external_method')
    ps.manage_addProduct['OFSP'].manage_addFolder(id='custom')
1823
    # Set the 'custom' layer a high priority, so it remains the first
1824 1825 1826 1827 1828
    #   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'
1829
                       ] + self.CMFDEFAULT_FOLDER_LIST
1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842
    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
                       )
1843 1844 1845 1846
    p.setupCurrentSkin()

  def setupWorkflow(self, p):
    """
1847
    Set up workflows for business templates
1848 1849 1850
    """
    tool = getToolByName(p, 'portal_workflow', None)
    if tool is None:
Jérome Perrin's avatar
Jérome Perrin committed
1851
      return
1852
    for wf_id in ('business_template_building_workflow',
1853
                  'business_template_installation_workflow'):
1854 1855
      if wf_id in tool.objectIds():
        tool.manage_delObjects([wf_id])
1856
    bootstrap_dir = getBootstrapDirectory()
1857 1858 1859
    business_template_building_workflow = os.path.join(
                                 bootstrap_dir,
                                 'business_template_building_workflow.xml')
1860
    tool._importObjectFromFile(business_template_building_workflow)
1861 1862 1863
    business_template_installation_workflow = os.path.join(
                                 bootstrap_dir,
                                 'business_template_installation_workflow.xml')
1864 1865
    tool._importObjectFromFile(business_template_installation_workflow)
    tool.setChainForPortalTypes( ( 'Business Template', ),
1866 1867
                                 ( 'business_template_building_workflow',
                                   'business_template_installation_workflow' ) )
1868 1869 1870

  def setupIndex(self, p, **kw):
    # Make sure all tools and folders have been indexed
1871
    if not kw.get('reindex', 1):
1872 1873 1874 1875
      return
    skins_tool = getToolByName(p, 'portal_skins', None)
    if skins_tool is None:
      return
1876
    # When no SQL connection was define on the site,
1877 1878
    # we don't want to make it crash
    if p.erp5_sql_connection_type is not None:
1879
      setattr(p, 'isIndexable', ConstantGetter('isIndexable', value=True))
1880 1881
      # Clear portal ids sql table, like this we do not take
      # ids for a previously created web site
1882
      p.portal_ids.clearGenerator(all=True)
1883
      # Then clear the catalog and reindex it
1884
      p.portal_catalog.manage_catalogClear()
1885
      # Calling ERP5Site_reindexAll is useless.
1886

1887 1888 1889
  def setupUserFolder(self, p):
      # Use Pluggable Auth Service instead of the standard acl_users.
      p.manage_addProduct['PluggableAuthService'].addPluggableAuthService()
1890
      pas_dispatcher = p.acl_users.manage_addProduct['PluggableAuthService']
1891
      # Add legacy ZODB support
1892 1893 1894
      pas_dispatcher.addZODBUserManager('zodb_users')
      pas_dispatcher.addZODBGroupManager('zodb_groups')
      pas_dispatcher.addZODBRoleManager('zodb_roles')
1895 1896 1897 1898
      # Add CMF Portal Roles
      p.acl_users.zodb_roles.addRole('Member')
      p.acl_users.zodb_roles.addRole('Reviewer')
      # Register ZODB Interface
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909
      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'))
1910
      # Add ERP5UserManager
1911 1912 1913 1914 1915
      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')
1916
      # Register ERP5UserManager Interface
1917 1918 1919
      p.acl_users.erp5_users.manage_activateInterfaces(
                                        ('IAuthenticationPlugin',
                                        'IUserEnumerationPlugin',))
1920 1921
      p.acl_users.erp5_groups.manage_activateInterfaces(('IGroupsPlugin',))
      p.acl_users.erp5_roles.manage_activateInterfaces(('IRolesPlugin',))
1922 1923
      p.acl_users.erp5_user_factory.manage_activateInterfaces(
                                        ('IUserFactoryPlugin',))
1924 1925 1926 1927 1928 1929 1930 1931

  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'),
1932
      'Change local roles'           : ('Manager', ),
1933 1934 1935 1936 1937 1938
      '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'),
1939
      'List undoable changes'        : ('Manager', ),
1940 1941 1942 1943 1944
      'Manage properties'            : ('Manager', 'Owner'),
      'Modify portal content'        : ('Manager', 'Owner'),
      'Reply to item'                : ('Manager', 'Member'),
      'Review portal content'        : ('Manager', 'Reviewer'),
      'Search ZCatalog'              : ('Manager', 'Member'),
1945
      'Set own password'             : ('Manager', ),
1946
      'Set own properties'           : ('Manager', 'Member'),
1947
      'Use mailhost services'        : ('Manager', 'Member'),
1948
      'Undo changes'                 : ('Manager', 'Owner'),
1949
      'View'                         : ('Manager', 'Member',
1950
                                        'Owner', 'Anonymous'),
1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961
      '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)

1962 1963 1964
    if getattr(p, 'setDefaultSorting', None) is not None:
      p.setDefaultSorting('id', 0)

1965 1966 1967 1968 1969
    self.setupTools(p, **kw)

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

Jérome Perrin's avatar
Jérome Perrin committed
1970 1971
    if create_userfolder and not p.hasObject('acl_users'):
      self.setupUserFolder(p)
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983

    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)

    # ERP5 Design Choice is that all content should be user defined
    # Content is disseminated through business templates
1984
    self.setupPortalTypes(p)
1985 1986 1987 1988 1989 1990 1991 1992 1993

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

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

1994 1995 1996
    # Make sure the cache is initialized
    p.portal_caches.updateCache()

1997 1998
    self.setupLastTools(p, **kw)

1999 2000 2001 2002 2003
    # 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)

2004
  def setupPortalTypes(self, p):
2005
    """
2006
    Install the portal_type of Business Template
2007 2008 2009 2010
    """
    tool = getToolByName(p, 'portal_types', None)
    if tool is None:
      return
2011
    for t in (BusinessTemplate, ):
2012 2013
      t = t.factory_type_information
      if not tool.hasObject(t['id']):
2014
        tool._setObject(t['id'], ERP5TypeInformation(uid=None, **t))
2015

2016
  def setupERP5Core(self,p,**kw):
2017
    """
2018
    Install the core part of ERP5
2019 2020 2021 2022 2023
    """
    template_tool = getToolByName(p, 'portal_templates', None)
    if template_tool is None:
      return
    if template_tool.getInstalledBusinessTemplate('erp5_core') is None:
2024
      for bt in ('erp5_core', p.erp5_catalog_storage, 'erp5_xhtml_style'):
2025 2026
        if not bt:
          continue
2027 2028 2029
        url = getBootstrapBusinessTemplateUrl(bt)
        bt = template_tool.download(url)
        bt.install(**kw)