ERP5Site.py 77.8 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
from OFS.Application import Application
21 22
from Products.ERP5Type import Globals
from Products.ERP5Type.Globals import package_home
23

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

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

50

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

108 109 110 111 112 113 114 115 116 117
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
118
    if item.endswith('.bt5') and os.path.isfile(item):
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
      # 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
140

141 142 143 144 145 146 147 148
def addERP5Tool(portal, id, portal_type):
  if portal.hasObject(id):
    return
  import erp5.portal_type
  klass = getattr(erp5.portal_type, portal_type)
  obj = klass()
  portal._setObject(id, obj)

149 150 151 152 153 154 155 156 157 158 159 160 161 162
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()
163

164 165 166 167 168 169 170
    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
171

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
    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()

191
import ZODB
192 193 194 195 196 197 198 199 200 201

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

202 203 204
  def __get(self, REQUEST=None,
            # XXX Compatibility code (ZODB >= 3.9 has no __version__ anymore)
            __opened='_opened'[getattr(ZODB, '__version__', '3.9') >= '3.9':]):
205
    """Returns the currently processed site, optionally wrapped in a request
206
    """
207 208 209
    while True:
      app, site_id = self.site[-1]
      app = app()
210
      if getattr(app._p_jar, __opened):
211 212 213 214
        if REQUEST is None:
          return getattr(app, site_id)
        return getattr(app.__of__(RequestContainer(REQUEST=REQUEST)), site_id)
      del self.site[-1]
215 216 217 218 219 220 221 222 223 224 225 226 227 228

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


229
class ERP5Site(FolderMixIn, CMFSite, CacheCookieMixin):
230
  """
231 232
  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.
233
  """
234
  meta_type = 'ERP5 Site'
235
  portal_type = 'ERP5 Site'
236
  constructors = (('addERP5Site', manage_addERP5SiteForm), manage_addERP5Site, )
237 238 239
  uid = 0
  last_id = 0
  icon = 'portal.gif'
240 241
  # Default value, prevents error during upgrade
  isIndexable = ConstantGetter('isIndexable', value=True)
242 243

  _properties = (
244
      { 'id':'title',
245
        'type':'string'},
246
      { 'id':'description',
247 248
        'type':'text'},
      )
249 250 251 252 253 254 255 256 257
  title = ''
  description = ''

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

  security.declareProtected(Permissions.View, 'view')
  def view(self):
258 259 260 261 262
    """
      Returns the default view.
      Implemented for consistency
    """
    return self.index_html()
263

264 265 266 267 268
  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()
269 270 271
    # Check 'parent' is the root because some objects like '_components'
    # store the site in '__parent__'.
    if 'ERP5Site.__of__' not in tv and type(parent) is Application:
272 273 274 275 276
      tv['ERP5Site.__of__'] = None
      setSite(self)
      synchronizeDynamicModules(self)
    return self

277 278 279 280 281 282 283 284 285 286 287
  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)

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
  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:
304
        portal_activities = self.portal_activities
305
      except AttributeError:
306 307
        pass
      else:
308 309 310 311 312 313 314 315 316 317 318 319 320 321
        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)

322

323 324 325 326 327 328 329
  def _getAcquireLocalRoles(self):
    """
      Prevent local roles from being acquired outside of Portal object.
      See ERP5Security/__init__.py:mergedLocalRoles .
    """
    return False

330 331 332 333 334 335 336
  security.declareProtected(Permissions.ManagePortal, 'enableRefererCheck')
  def enableRefererCheck(self):
    """Enable a ReferCheckerBeforeTraverseHook to check users have valid
    HTTP_REFERER
    """
    BeforeTraverse.registerBeforeTraverse(self,
                                        ReferCheckerBeforeTraverseHook(),
337 338 339
                                        ReferCheckerBeforeTraverseHook.handle,
                             # we want to be registered _after_ CookieCrumbler
                                        100)
340

341 342 343 344
  def _disableRefererCheck(self):
    """Disable the HTTP_REFERER check."""
    BeforeTraverse.unregisterBeforeTraverse(self,
                                        ReferCheckerBeforeTraverseHook.handle)
345

346
  def hasObject(self, id):
347
    """
348
    Check if the portal has an id.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
349
    """
350
    return id in self.objectIds()
351

352
  security.declareProtected(Permissions.AccessContentsInformation,
353
                            'getPortalObject')
354 355
  def getPortalObject(self):
    return self
Jean-Paul Smets's avatar
Jean-Paul Smets committed
356

357 358 359 360 361
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalType')
  def getPortalType(self):
    return self.portal_type

362
  security.declareProtected(Permissions.AccessContentsInformation,
363
                            'getTitle')
364 365 366 367 368
  def getTitle(self):
    """
      Return the title.
    """
    return self.title
369

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

377 378 379
      WARNING : must be updates for circular references issues
    """
    return getattr(self, 'uid', 0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
380

381
  security.declareProtected(Permissions.AccessContentsInformation,
382
                            'getParentUid')
383 384 385 386 387
  def getParentUid(self):
    """
      A portal has no parent
    """
    return self.getUid()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
388

389 390 391 392
  # 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
393

394 395 396 397
  # 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
398

399 400
  security.declareProtected(Permissions.AccessContentsInformation, 'getUrl')
  def getUrl(self, REQUEST=None):
401 402 403 404
    """
      Returns the absolute path of an object
    """
    return join(self.getPhysicalPath(),'/')
Sebastien Robin's avatar
Sebastien Robin committed
405

406 407 408 409 410 411 412
  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)

413 414 415 416
  # Old name - for compatibility
  security.declareProtected(Permissions.AccessContentsInformation, 'getPath')
  getPath = getUrl

417 418 419 420 421 422
  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 []

423
  security.declareProtected(Permissions.AccessContentsInformation, 'searchFolder')
424 425 426 427 428 429 430
  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
431
    return self.portal_catalog.searchResults(**kw)
432 433 434 435 436 437 438 439 440

  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
441
    return self.portal_catalog.countResults(**kw)
442 443 444 445 446 447 448 449

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

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

452
    This should absolutely be rewritten by using clean
453
    concepts to separate worklists XXX
454 455 456 457 458 459
    """
    sorted_workflow_actions = {}
    sorted_global_actions = []
    other_global_actions = []
    for action in action_list:
      action['disabled'] = 0
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
460 461 462 463 464 465 466 467 468 469
      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)
470 471
      else:
        other_global_actions.append(action)
472
    for key in sorted(sorted_workflow_actions):
473 474 475 476 477 478
      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,
479 480 481
                             email_from_address, email_from_name,
                             validate_email
                             ):
482
    CMFSite.setupDefaultProperties(self, p, title, description,
483 484
                           email_from_address, email_from_name,
                           validate_email)
485

486 487 488
  # 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
489
  # to customize the settings for each portal site.
490 491
  def _getPortalConfiguration(self, id):
    """
492
    Get a portal-specific configuration.
493

494 495
    Current implementation is using properties in a portal object.
    If not found, try to get a default value for backward compatibility.
496

497 498
    This implementation can be improved by gathering information
    from appropriate places, such as portal_types, portal_categories
499
    and portal_workflow.
500 501 502
    """
    if self.hasProperty(id):
      return self.getProperty(id)
503

504 505
    # Fall back to the default.
    return getattr(ERP5Defaults, id, None)
506

507
  def _getPortalGroupedTypeList(self, group, enable_sort=True):
508
    """
509
    Return a list of portal types classified to a specific group.
510 511
    The result is sorted by language (using the user language
    as default)
512 513 514

    Enable_sort parameter was added in order to allows looking groups
    of portal type without sorting. This is better for performance
515 516 517
    """
    def getTypeList(group):
      type_list = []
Sebastien Robin's avatar
Sebastien Robin committed
518
      for pt in self.portal_types.listTypeInfo():
519 520
        if group in getattr(pt, 'group_list', ()):
          type_list.append(pt.getId())
521

522 523 524 525
      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
526 527
        translate = localizer_tool.translate
        type_list.sort(key=lambda x:translate('ui', x))
528 529
      return tuple(type_list)

530 531
    if enable_sort:
      # language should be cached in Transaction Cache if performance issue
532
      localizer_tool = self.Localizer
533 534 535
      language = localizer_tool.get_selected_language()
    else:
      localizer_tool = language = None
536

537
    getTypeList = CachingMethod(getTypeList,
538 539 540 541
                                id=(('_getPortalGroupedTypeList', language), group,
                                    enable_sort),
                                cache_factory='erp5_content_medium',
                                )
542 543 544

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

546 547 548 549 550 551 552 553 554
  @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))

555
  def _getPortalGroupedCategoryList(self, group):
556
    """
557
    Return a list of base categories classified to a specific group.
558 559 560 561 562 563 564 565
    """
    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)

566 567
    getCategoryList = CachingMethod(
                            getCategoryList,
568
                            id=('_getPortalGroupedCategoryList', group),
Aurel's avatar
Aurel committed
569
                            cache_factory='erp5_content_medium')
570 571 572
    return getCategoryList(group)

  def _getPortalGroupedStateList(self, group):
573
    """
574
    Return a list of workflow states classified to a specific group.
575 576 577 578 579 580 581 582 583 584
    """
    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())

585
    getStateList = CachingMethod(getStateList,
586
                                 id=('_getPortalGroupedStateList', group),
Aurel's avatar
Aurel committed
587
                                 cache_factory='erp5_content_medium')
588 589
    return getStateList(group)

590 591
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDefaultSectionCategory')
592 593
  def getPortalDefaultSectionCategory(self):
    """
594
    Return a default section category. This method is deprecated.
595 596 597 598
    """
    LOG('ERP5Site', 0, 'getPortalDefaultSectionCategory is deprecated;'+
        ' use portal_preferences.getPreferredSectionCategory instead.')
    section_category = self.portal_preferences.getPreferredSectionCategory()
599

600 601 602 603
    # XXX This is only for backward-compatibility.
    if not section_category:
      section_category = self._getPortalConfiguration(
                                'portal_default_section_category')
604

605
    return section_category
606

607 608 609 610 611 612
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalResourceTypeList')
  def getPortalResourceTypeList(self):
    """
      Return resource types.
    """
613 614 615
    return self._getPortalGroupedTypeList('resource') or \
           self._getPortalConfiguration('portal_resource_type_list')

616 617 618 619 620 621 622
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSubVariationTypeList')
  def getPortalSubVariationTypeList(self):
    """
      Return resource types.
    """
    return self._getPortalGroupedTypeList('sub_variation')
623

624 625 626 627 628 629 630
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSubVariationBaseCategoryList')
  def getPortalSubVariationBaseCategoryList(self):
    """
      Return variation base categories.
    """
    return self._getPortalGroupedCategoryList('sub_variation')
631

632 633 634 635 636 637
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalVariationTypeList')
  def getPortalVariationTypeList(self):
    """
      Return variation types.
    """
638 639 640
    return self._getPortalGroupedTypeList('variation') or \
           self._getPortalConfiguration('portal_variation_type_list')

641 642 643 644 645 646
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalNodeTypeList')
  def getPortalNodeTypeList(self):
    """
      Return node types.
    """
647 648 649
    return self._getPortalGroupedTypeList('node') or \
           self._getPortalConfiguration('portal_node_type_list')

650 651 652 653 654 655
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPaymentNodeTypeList')
  def getPortalPaymentNodeTypeList(self):
    """
      Return payment node types.
    """
656 657 658
    return self._getPortalGroupedTypeList('payment_node') or \
           self._getPortalConfiguration('portal_payment_node_type_list')

659 660 661 662 663 664
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInvoiceTypeList')
  def getPortalInvoiceTypeList(self):
    """
      Return invoice types.
    """
665 666 667
    return self._getPortalGroupedTypeList('invoice') or \
           self._getPortalConfiguration('portal_invoice_type_list')

668 669 670 671 672 673
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOrderTypeList')
  def getPortalOrderTypeList(self):
    """
      Return order types.
    """
674 675 676
    return self._getPortalGroupedTypeList('order') or \
           self._getPortalConfiguration('portal_order_type_list')

677 678 679 680 681 682
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDeliveryTypeList')
  def getPortalDeliveryTypeList(self):
    """
      Return delivery types.
    """
683 684 685
    return self._getPortalGroupedTypeList('delivery') or \
           self._getPortalConfiguration('portal_delivery_type_list')

686 687 688 689 690 691
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTransformationTypeList')
  def getPortalTransformationTypeList(self):
    """
      Return transformation types.
    """
692 693 694
    return self._getPortalGroupedTypeList('transformation') or \
           self._getPortalConfiguration('portal_transformation_type_list')

695 696 697 698 699 700 701 702 703
  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')

704 705 706 707 708 709
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalVariationBaseCategoryList')
  def getPortalVariationBaseCategoryList(self):
    """
      Return variation base categories.
    """
710 711 712
    return self._getPortalGroupedCategoryList('variation') or \
           self._getPortalConfiguration('portal_variation_base_category_list')

713 714 715 716 717 718
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOptionBaseCategoryList')
  def getPortalOptionBaseCategoryList(self):
    """
      Return option base categories.
    """
719 720 721
    return self._getPortalGroupedCategoryList('option') or \
           self._getPortalConfiguration('portal_option_base_category_list')

722 723 724 725 726 727
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInvoiceMovementTypeList')
  def getPortalInvoiceMovementTypeList(self):
    """
      Return invoice movement types.
    """
728 729 730
    return self._getPortalGroupedTypeList('invoice_movement') or \
           self._getPortalConfiguration('portal_invoice_movement_type_list')

731 732 733 734 735 736 737 738 739 740
  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')


741 742 743 744 745 746
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOrderMovementTypeList')
  def getPortalOrderMovementTypeList(self):
    """
      Return order movement types.
    """
747 748 749
    return self._getPortalGroupedTypeList('order_movement') or \
           self._getPortalConfiguration('portal_order_movement_type_list')

750 751 752 753 754 755
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDeliveryMovementTypeList')
  def getPortalDeliveryMovementTypeList(self):
    """
      Return delivery movement types.
    """
756 757 758
    return self._getPortalGroupedTypeList('delivery_movement') or \
           self._getPortalConfiguration('portal_delivery_movement_type_list')

759
  security.declareProtected(Permissions.AccessContentsInformation,
760
                            'getPortalSupplyTypeList')
761 762 763 764
  def getPortalSupplyTypeList(self):
    """
      Return supply types.
    """
765 766 767
    return self._getPortalGroupedTypeList('supply') or \
           self._getPortalConfiguration('portal_supply_type_list')

768 769 770 771 772 773 774 775
  security.declareProtected(Permissions.AccessContentsInformation,
                              'getPortalConstraintTypeList')
  def getPortalConstraintTypeList(self):
    """
      Return rule types.
    """
    return self._getPortalGroupedTypeList('constraint')

776 777 778 779 780 781 782 783
  security.declareProtected(Permissions.AccessContentsInformation,
                              'getPortalRuleTypeList')
  def getPortalRuleTypeList(self):
    """
      Return rule types.
    """
    return self._getPortalGroupedTypeList('rule')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
784 785 786 787
  security.declareProtected(Permissions.AccessContentsInformation,
                              'getPortalProjectTypeList')
  def getPortalProjectTypeList(self):
    """
788
      Return project types.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
789 790 791
    """
    return self._getPortalGroupedTypeList('project')

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

800 801 802 803 804 805 806 807
  security.declareProtected(Permissions.AccessContentsInformation,
                              'getPortalEmbeddedDocumentTypeList')
  def getPortalEmbeddedDocumentTypeList(self):
    """
      Return embedded document types.
    """
    return self._getPortalGroupedTypeList('embedded_document')

808 809 810 811 812 813 814 815
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalWebDocumentTypeList')
  def getPortalWebDocumentTypeList(self):
    """
      Return web page types.
    """
    return self._getPortalGroupedTypeList('web_document')

816 817 818 819
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalFileDocumentTypeList')
  def getPortalFileDocumentTypeList(self):
    """
820
      Return file document types.
821 822 823 824 825 826 827
    """
    return self._getPortalGroupedTypeList('file_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalRecentDocumentTypeList')
  def getPortalRecentDocumentTypeList(self):
    """
828
      Return recent document types.
829 830 831 832 833 834 835
    """
    return self._getPortalGroupedTypeList('recent_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTemplateDocumentTypeList')
  def getPortalTemplateDocumentTypeList(self):
    """
836
      Return template document types.
837 838 839 840 841 842 843
    """
    return self._getPortalGroupedTypeList('template_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMyDocumentTypeList')
  def getPortalMyDocumentTypeList(self):
    """
844
      Return my document types.
845 846 847
    """
    return self._getPortalGroupedTypeList('my_document')

848 849 850 851
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalCrawlerIndexTypeList')
  def getPortalCrawlerIndexTypeList(self):
    """
852
      Return crawler index types.
853 854 855
    """
    return self._getPortalGroupedTypeList('crawler_index')

856 857 858 859 860 861 862 863
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBudgetVariationTypeList')
  def getPortalBudgetVariationTypeList(self):
    """
      Return budget variation types.
    """
    return self._getPortalGroupedTypeList('budget_variation')

864
  security.declareProtected(Permissions.AccessContentsInformation,
865
                            'getPortalSupplyPathTypeList')
866 867
  def getPortalSupplyPathTypeList(self):
    """
868
      Return supply path types.
869
    """
870 871 872
    return self._getPortalGroupedTypeList('supply_path') or \
           self._getPortalConfiguration('portal_supply_path_type_list')

873 874 875 876 877 878 879
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAcquisitionMovementTypeList')
  def getPortalAcquisitionMovementTypeList(self):
    """
      Return acquisition movement types.
    """
    return tuple(list(self.getPortalOrderMovementTypeList()) +
880
                 list(self.getPortalDeliveryMovementTypeList()) +
881
                 list(self.getPortalTaxMovementTypeList()) +
882 883
                 list(self.getPortalInvoiceMovementTypeList()))

884 885 886 887 888 889 890
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMovementTypeList')
  def getPortalMovementTypeList(self):
    """
      Return movement types.
    """
    return tuple(list(self.getPortalOrderMovementTypeList()) +
891 892
                 list(self.getPortalDeliveryMovementTypeList()) +
                 list(self.getPortalInvoiceMovementTypeList()) +
893
                 list(self.getPortalTaxMovementTypeList()) +
894
                 list(self.getPortalAccountingMovementTypeList()) +
895
                 ['Simulation Movement'])
896

897 898 899 900 901 902
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSimulatedMovementTypeList')
  def getPortalSimulatedMovementTypeList(self):
    """
      Return simulated movement types.
    """
903
    return tuple([x for x in self.getPortalMovementTypeList() \
904
                  if x not in self.getPortalContainerTypeList()])
905

906 907 908 909 910 911
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalContainerTypeList')
  def getPortalContainerTypeList(self):
    """
      Return container types.
    """
912 913 914
    return self._getPortalGroupedTypeList('container') or \
           self._getPortalConfiguration('portal_container_type_list')

915 916 917 918 919 920
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalContainerLineTypeList')
  def getPortalContainerLineTypeList(self):
    """
      Return container line types.
    """
921 922 923
    return self._getPortalGroupedTypeList('container_line') or \
           self._getPortalConfiguration('portal_container_line_type_list')

924 925 926 927 928 929
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalItemTypeList')
  def getPortalItemTypeList(self):
    """
      Return item types.
    """
930 931 932
    return self._getPortalGroupedTypeList('item') or \
           self._getPortalConfiguration('portal_item_type_list')

933 934 935 936 937 938
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDiscountTypeList')
  def getPortalDiscountTypeList(self):
    """
      Return discount types.
    """
939 940 941
    return self._getPortalGroupedTypeList('discount') or \
           self._getPortalConfiguration('portal_discount_type_list')

942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
  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')

960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
  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')

984 985 986 987 988 989
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAlarmTypeList')
  def getPortalAlarmTypeList(self):
    """
      Return alarm types.
    """
990 991 992
    return self._getPortalGroupedTypeList('alarm') or \
           self._getPortalConfiguration('portal_alarm_type_list')

993 994 995 996 997 998
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPaymentConditionTypeList')
  def getPortalPaymentConditionTypeList(self):
    """
      Return payment condition types.
    """
999 1000 1001
    return self._getPortalGroupedTypeList('payment_condition') or \
           self._getPortalConfiguration('portal_payment_condition_type_list')

1002 1003 1004 1005 1006 1007
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBalanceTransactionLineTypeList')
  def getPortalBalanceTransactionLineTypeList(self):
    """
      Return balance transaction line types.
    """
1008
    return self._getPortalGroupedTypeList('balance_transaction_line') or \
1009 1010
           self._getPortalConfiguration(
                  'portal_balance_transaction_line_type_list')
1011

1012 1013 1014 1015 1016 1017
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalCurrentInventoryStateList')
  def getPortalCurrentInventoryStateList(self):
    """
      Return current inventory states.
    """
1018 1019 1020
    return self._getPortalGroupedStateList('current_inventory') or \
           self._getPortalConfiguration('portal_current_inventory_state_list')

1021 1022 1023 1024 1025 1026 1027 1028 1029
  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')

1030 1031 1032 1033 1034 1035
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDraftOrderStateList')
  def getPortalDraftOrderStateList(self):
    """
      Return draft order states.
    """
1036 1037 1038
    return self._getPortalGroupedStateList('draft_order') or \
           self._getPortalConfiguration('portal_draft_order_state_list')

1039 1040 1041 1042 1043 1044
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPlannedOrderStateList')
  def getPortalPlannedOrderStateList(self):
    """
      Return planned order states.
    """
1045 1046 1047
    return self._getPortalGroupedStateList('planned_order') or \
           self._getPortalConfiguration('portal_planned_order_state_list')

1048 1049 1050 1051 1052 1053
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalReservedInventoryStateList')
  def getPortalReservedInventoryStateList(self):
    """
      Return reserved inventory states.
    """
1054
    return self._getPortalGroupedStateList('reserved_inventory') or \
1055
        self._getPortalConfiguration('portal_reserved_inventory_state_list')
1056

1057 1058 1059 1060 1061 1062
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalFutureInventoryStateList')
  def getPortalFutureInventoryStateList(self):
    """
      Return future inventory states.
    """
1063 1064 1065
    return self._getPortalGroupedStateList('future_inventory') or \
           self._getPortalConfiguration('portal_future_inventory_state_list')

1066
  security.declareProtected(Permissions.AccessContentsInformation,
1067
                          'getPortalUpdatableAmortisationTransactionStateList')
1068 1069
  def getPortalUpdatableAmortisationTransactionStateList(self):
    """
1070
      Return states when Amortisation Transaction can be updated
1071
      by amortisation_transaction_builder.
1072
    """
1073 1074
    return self._getPortalConfiguration(
        'portal_updatable_amortisation_transaction_state_list')
1075

1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
  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()

1098 1099 1100 1101 1102 1103
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalColumnBaseCategoryList')
  def getPortalColumnBaseCategoryList(self):
    """
      Return column base categories.
    """
1104 1105 1106
    return self._getPortalGroupedCategoryList('column') or \
           self._getPortalConfiguration('portal_column_base_category_list')

1107 1108 1109 1110 1111 1112
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalLineBaseCategoryList')
  def getPortalLineBaseCategoryList(self):
    """
      Return line base categories.
    """
1113 1114 1115
    return self._getPortalGroupedCategoryList('line') or \
           self._getPortalConfiguration('portal_line_base_category_list')

1116 1117 1118 1119 1120 1121
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTabBaseCategoryList')
  def getPortalTabBaseCategoryList(self):
    """
      Return tab base categories.
    """
1122 1123 1124
    return self._getPortalGroupedCategoryList('tab') or \
           self._getPortalConfiguration('portal_tab_base_category_list')

1125 1126 1127 1128
  def getPortalDefaultGapRoot(self):
    """
      Return the Accounting Plan to use by default (return the root node)
    """
1129
    LOG('ERP5Site', 0,
1130 1131 1132
        'getPortalDefaultGapRoot is deprecated; ' \
        'use portal_preferences.getPreferredAccountingTransactionGap instead.')

1133 1134
    return self.portal_preferences.getPreferredAccountingTransactionGap() or \
           self._getPortalConfiguration('portal_default_gap_root')
1135

1136 1137 1138 1139
  def getPortalAccountingMovementTypeList(self) :
    """
      Return accounting movement type list.
    """
1140
    return self._getPortalGroupedTypeList('accounting_movement') or \
1141
        self._getPortalConfiguration('portal_accounting_movement_type_list')
1142

1143 1144 1145 1146
  def getPortalAccountingTransactionTypeList(self) :
    """
      Return accounting transaction movement type list.
    """
1147
    return self._getPortalGroupedTypeList('accounting_transaction') or \
1148
      self._getPortalConfiguration('portal_accounting_transaction_type_list')
1149

1150 1151 1152 1153
  def getPortalAssignmentBaseCategoryList(self):
    """
      Return List of category values to generate security groups.
    """
1154
    return self._getPortalGroupedCategoryList('assignment') or \
1155
        self._getPortalConfiguration('portal_assignment_base_category_list')
1156

1157 1158
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTicketTypeList')
1159 1160 1161 1162 1163
  def getPortalTicketTypeList(self):
    """
    Return ticket types.
    """
    return self._getPortalGroupedTypeList('ticket')
1164

1165 1166
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalEventTypeList')
1167 1168 1169 1170 1171
  def getPortalEventTypeList(self):
    """
    Return event types.
    """
    return self._getPortalGroupedTypeList('event')
1172

1173 1174 1175 1176 1177 1178 1179 1180
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDivergenceTesterTypeList')
  def getPortalDivergenceTesterTypeList(self):
    """
    Return divergence tester types.
    """
    return self._getPortalGroupedTypeList('divergence_tester')

1181 1182 1183 1184 1185 1186 1187 1188
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTargetSolverTypeList')
  def getPortalTargetSolverTypeList(self):
    """
    Return target solver types.
    """
    return self._getPortalGroupedTypeList('target_solver')

Sebastien Robin's avatar
Sebastien Robin committed
1189 1190 1191 1192 1193 1194 1195 1196
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTargetSolverTypeList')
  def getPortalDeliverySolverTypeList(self):
    """
    Return delivery solver types.
    """
    return self._getPortalGroupedTypeList('delivery_solver')

1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
  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')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1221 1222 1223 1224 1225 1226 1227 1228
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBusinessProcessTypeList')
  def getPortalBusinessProcessTypeList(self):
    """
    Return amount generator types.
    """
    return self._getPortalGroupedTypeList('business_process')

1229

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1230
  security.declareProtected(Permissions.AccessContentsInformation,
1231 1232
                            'getPortalBusinessLinkTypeList')
  def getPortalBusinessLinkTypeList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1233
    """
1234 1235 1236 1237 1238 1239 1240 1241 1242
      Return business link types.
    """
    return self._getPortalGroupedTypeList('business_link')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTradeModelPathTypeList')
  def getPortalTradeModelPathTypeList(self):
    """
      Return trade model path types.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1243
    """
1244
    return self._getPortalGroupedTypeList('trade_model_path')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1245

1246 1247 1248 1249 1250 1251 1252 1253
  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
1254 1255 1256 1257 1258 1259 1260 1261
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalModuleTypeList')
  def getPortalModuleTypeList(self):
    """
    Return module types.
    """
    return self._getPortalGroupedTypeList('module')

1262 1263 1264 1265 1266 1267 1268 1269
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInventoryMovementTypeList')
  def getPortalInventoryMovementTypeList(self):
    """
    Return inventory movement types.
    """
    return self._getPortalGroupedTypeList('inventory_movement')

Sebastien Robin's avatar
Sebastien Robin committed
1270 1271 1272 1273 1274 1275 1276 1277
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInventoryTypeList')
  def getPortalInventoryTypeList(self):
    """
    Return inventory types.
    """
    return self._getPortalGroupedTypeList('inventory')

1278 1279 1280 1281 1282 1283 1284 1285
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMovementGroupTypeList')
  def getPortalMovementGroupTypeList(self):
    """
    Return movement group types.
    """
    return self._getPortalGroupedTypeList('movement_group')

1286 1287
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDefaultModuleId')
1288 1289
  def getDefaultModuleId(self, portal_type, default=MARKER):
    """
Romain Courteaud's avatar
Romain Courteaud committed
1290 1291
    Return default module id where a object with portal_type can
    be created.
1292 1293
    """
    portal_object = self
Romain Courteaud's avatar
Romain Courteaud committed
1294 1295 1296 1297 1298
    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
1299 1300 1301 1302 1303 1304
    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:
1305
        for expected_module_id in portal_object.objectIds(('ERP5 Folder',)):
1306 1307 1308 1309 1310 1311
          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
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324

    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
1325

1326 1327
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDefaultModule')
1328
  def getDefaultModule(self, portal_type, default=MARKER):
1329 1330 1331
    """
      Return default module where a object with portal_type can be created
    """
1332 1333 1334 1335
    module_id = self.getDefaultModuleId(portal_type, default)
    if module_id:
      return getattr(self, module_id, None)
    return None
1336

1337
  security.declareProtected(Permissions.AddPortalContent, 'newContent')
1338
  def newContent(self, id=None, portal_type=None, **kw):
1339 1340 1341 1342 1343 1344 1345
    """
      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'
1346 1347 1348 1349
    self.portal_types.constructContent(type_name=portal_type,
                                       container=self,
                                       id=id,
                                       ) # **kw) removed due to CMF bug
1350
    new_instance = self[id]
1351

1352
    if kw:
1353
      new_instance._edit(force_update=1, **kw)
1354 1355
    return new_instance

1356 1357 1358 1359 1360 1361
  security.declarePublic('getVisibleAllowedContentTypeList')
  def getVisibleAllowedContentTypeList(self):
    """Users cannot add anything in an ERP5Site using standard interface.
    """
    return ()

1362 1363 1364 1365 1366 1367
  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)
1368

1369 1370 1371 1372 1373
  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.
1374
    tv = getTransactionalVariable()
1375 1376 1377 1378 1379 1380 1381 1382
    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.
1383
    tv = getTransactionalVariable()
1384 1385 1386 1387 1388 1389 1390
    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.
1391
    tv = getTransactionalVariable()
1392 1393 1394 1395 1396 1397 1398
    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.
1399
    tv = getTransactionalVariable()
1400 1401 1402
    key = ('default_activate_parameter', )
    return tv.get(key)

1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
  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

1418
  security.declareProtected(Permissions.ManagePortal, 'migrateToPortalTypeClass')
1419
  def migrateToPortalTypeClass(self, REQUEST=None):
1420 1421 1422 1423
    """Compatibility code that allows migrating a site to portal type classes.
    
    We consider that a Site is migrated if its Types Tool is migrated
    (it will always be migrated last)"""
1424 1425 1426 1427 1428 1429
    types_tool = getattr(self, 'portal_types', None)
    if types_tool is None:
      # empty site
      return
    if types_tool.__class__.__module__ == 'erp5.portal_type':
      # nothing to do, already migrated
1430 1431 1432 1433 1434
      if REQUEST is not None:
        return REQUEST.RESPONSE.redirect(
          '%s?portal_status_message=' \
          'Nothing to do, already migrated.' % \
          self.absolute_url())
1435
      return
1436

1437 1438 1439
    # note that the site itself is not migrated (ERP5Site is not a portal type)
    # only the tools and top level modules are.
    # Normally, PersistentMigrationMixin should take care of the rest.
1440 1441
    id_list = self.objectIds()

1442
    # make sure that Types Tool is migrated last
1443 1444 1445 1446 1447 1448
    id_list.remove('portal_types')
    id_list.append('portal_types')
    for id in id_list:
      method = getattr(self[id], '_migrateToPortalTypeClass', None)
      if method is None:
        continue
1449
      method()
1450

1451 1452 1453 1454 1455 1456
    if REQUEST is not None:
      return REQUEST.RESPONSE.redirect(
        '%s?portal_status_message=' \
        'Successfully migrated tools and types to portal type classes.' % \
        self.absolute_url())

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1457 1458
Globals.InitializeClass(ERP5Site)

1459 1460 1461 1462 1463 1464 1465
def getBootstrapDirectory():
  """
    Return the name of the bootstrap directory
  """
  product_path = package_home(globals())
  return os.path.join(product_path, 'bootstrap')

1466 1467 1468 1469 1470 1471 1472 1473
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
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566

# 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 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
1567 1568
class ERP5Generator(PortalGenerator):

1569
  klass = ERP5Site
1570

1571 1572 1573
  def create(self,
             parent,
             id,
1574
             create_userfolder,
1575
             erp5_catalog_storage,
1576
             erp5_sql_connection_type,
1577
             erp5_sql_connection_string,
1578
             erp5_sql_deferred_connection_type,
1579 1580
             cmf_activity_sql_connection_type,
             cmf_activity_sql_connection_string,
1581
             create_activities=True,
1582 1583
             reindex=1,
             **kw):
1584 1585
    id = str(id)
    portal = self.klass(id=id)
1586 1587
    # Make sure reindex will not be called until business templates
    # will be installed
1588
    setattr(portal, 'isIndexable', ConstantGetter('isIndexable', value=False))
1589 1590 1591 1592 1593 1594 1595

    # This is only used to refine log level.
    # Has no functional use, and should never have any:
    # if you use it for something else than a logging-oriented hint,
    # trolls *will* chase you and haunt you in your dreams
    portal._v_bootstrapping = True

1596 1597 1598
    parent._setObject(id, portal)
    # Return the fully wrapped object.
    p = parent.this()._getOb(id)
1599 1600

    erp5_sql_deferred_connection_string = erp5_sql_connection_string
1601 1602
    p._setProperty('erp5_catalog_storage',
                   erp5_catalog_storage, 'string')
1603
    p._setProperty('erp5_sql_connection_type',
1604
                   erp5_sql_connection_type, 'string')
1605
    p._setProperty('erp5_sql_connection_string',
1606
                   erp5_sql_connection_string, 'string')
1607
    p._setProperty('erp5_sql_deferred_connection_type',
1608
                   erp5_sql_deferred_connection_type, 'string')
1609
    p._setProperty('erp5_sql_deferred_connection_string',
1610
                   erp5_sql_deferred_connection_string, 'string')
1611
    p._setProperty('cmf_activity_sql_connection_type',
1612
                   cmf_activity_sql_connection_type, 'string')
1613
    p._setProperty('cmf_activity_sql_connection_string',
1614
                   cmf_activity_sql_connection_string, 'string')
1615
    p._setProperty('management_page_charset', 'UTF-8', 'string')
1616 1617
    self.setup(p, create_userfolder, create_activities=create_activities,
        reindex=reindex, **kw)
1618 1619 1620

    p._v_bootstrapping = False

1621 1622
    return p

1623
  def setupLastTools(self, p, create_activities=True, **kw):
1624
    """
1625 1626 1627
    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
1628 1629
    """
    # Add Activity Tool
1630
    if create_activities and not p.hasObject('portal_activities'):
1631
      addERP5Tool(p, 'portal_activities', 'Activity Tool')
1632
      # Initialize Activities
1633
      p.portal_activities.manageClearActivities(keep=0)
1634

1635 1636
    # Add several other tools, only at the end in order
    # to make sure that they will be reindexed
1637 1638 1639 1640
    addERP5Tool(p, 'portal_rules', 'Rule Tool')
    addERP5Tool(p, 'portal_simulation', 'Simulation Tool')
    addERP5Tool(p, 'portal_deliveries', 'Delivery Tool')
    addERP5Tool(p, 'portal_orders', 'Order Tool')
1641 1642


1643 1644
  def setupTemplateTool(self, p, **kw):
    """
1645
    Setup the Template Tool. Security must be set strictly.
1646
    """
1647
    addERP5Tool(p, 'portal_templates', 'Template Tool')
1648 1649 1650 1651 1652 1653 1654
    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):
    """
1655
    Set up initial tools.
1656 1657 1658 1659
    """
    if not 'portal_actions' in p.objectIds():
      PortalGenerator.setupTools(self, p)

1660
    # It is better to remove portal_catalog
1661
    # which is ZCatalog as soon as possible,
1662
    # because the API is not the completely same as ERP5Catalog,
1663
    # and ZCatalog is useless for ERP5 after all.
1664
    update = kw.get('update', 0)
1665 1666 1667 1668 1669
    try:
      if p.portal_catalog.meta_type != 'ZSQLCatalog' and not update:
        p._delObject('portal_catalog')
    except AttributeError:
      pass
1670 1671 1672

    # Add CMF Report Tool
    if not p.hasObject('portal_report'):
1673 1674 1675 1676 1677
      try:
        addTool = p.manage_addProduct['CMFReportTool'].manage_addTool
        addTool('CMF Report Tool', None)
      except AttributeError:
        pass
1678 1679

    # Add ERP5 Tools
1680 1681
    addERP5Tool(p, 'portal_categories', 'Category Tool')
    addERP5Tool(p, 'portal_ids', 'Id Tool')
1682 1683
    if not p.hasObject('portal_templates'):
      self.setupTemplateTool(p)
1684 1685 1686 1687 1688 1689
    addERP5Tool(p, 'portal_trash', 'Trash Tool')
    addERP5Tool(p, 'portal_alarms', 'Alarm Tool')
    addERP5Tool(p, 'portal_domains', 'Domain Tool')
    addERP5Tool(p, 'portal_tests', 'Test Tool')
    addERP5Tool(p, 'portal_password', 'Password Tool')
    addERP5Tool(p, 'portal_acknowledgements', 'Acknowledgement Tool')
Aurel's avatar
Aurel committed
1690

1691
    # Add ERP5Type Tool
1692 1693
    addERP5Tool(p, 'portal_caches', 'Cache Tool')
    addERP5Tool(p, 'portal_memcached', 'Memcached Tool')
1694

1695
    try:
1696
      addERP5Tool(p, 'portal_subversion', 'Subversion Tool')
1697 1698
    except AttributeError:
      pass
1699

1700
    # Add ERP5Type Tools
1701 1702 1703 1704
    if allowClassTool():
      addERP5Tool(p, 'portal_classes', 'Class Tool')
    else:
      addERP5Tool(p, 'portal_classes', 'Dummy Class Tool')
1705 1706 1707 1708 1709

    # 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
1710

1711 1712 1713
    # Add Default SQL connection
    if p.erp5_sql_connection_type == 'Z MySQL Database Connection':
      if not p.hasObject('erp5_sql_connection'):
1714 1715
        addSQLConnection = p.manage_addProduct['ZMySQLDA'].\
                                     manage_addZMySQLConnection
1716 1717
        addSQLConnection('erp5_sql_connection',
                         'ERP5 SQL Server Connection',
1718
                         p.erp5_sql_connection_string)
1719 1720
    elif p.erp5_sql_connection_type == 'Z Gadfly':
      pass
1721 1722

    # Add Deferred SQL Connections
1723 1724
    if p.erp5_sql_deferred_connection_type == \
        'Z MySQL Deferred Database Connection':
1725
      if not p.hasObject('erp5_sql_deferred_connection'):
1726 1727
        addSQLConnection = p.manage_addProduct['ZMySQLDDA'].\
            manage_addZMySQLDeferredConnection
1728 1729
        addSQLConnection('erp5_sql_deferred_connection',
                         'ERP5 SQL Server Deferred Connection',
1730
                         p.erp5_sql_deferred_connection_string)
1731 1732 1733 1734
    elif p.erp5_sql_deferred_connection_type == 'Z Gadfly':
      pass

    # Add Activity SQL Connections
1735 1736
    if p.cmf_activity_sql_connection_type == 'Z MySQL Database Connection':
      if not p.hasObject('cmf_activity_sql_connection'):
1737 1738
        addSQLConnection = p.manage_addProduct['ZMySQLDA'].\
                                     manage_addZMySQLConnection
1739 1740
        addSQLConnection('cmf_activity_sql_connection',
                         'CMF Activity SQL Server Connection',
1741
                         p.cmf_activity_sql_connection_string)
1742 1743 1744 1745 1746
      # 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
1747
      # minus prepended to the connection string.
1748 1749 1750 1751 1752
      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
1753
                         '-%s' % p.cmf_activity_sql_connection_string)
1754 1755
    elif p.cmf_activity_sql_connection_type == 'Z Gadfly':
      pass
1756

1757
    # Add ERP5Form Tools
1758 1759
    addERP5Tool(p, 'portal_selections', 'Selection Tool')
    addERP5Tool(p, 'portal_preferences', 'Preference Tool')
1760

1761 1762
    try:
      # Add ERP5SyncML Tools
1763
      addERP5Tool(p, 'portal_synchronizations', 'Synchronization Tool')
1764 1765
    except AttributeError:
      pass
1766 1767 1768 1769 1770

    # Add Message Catalog
    if not 'Localizer' in p.objectIds():
      addLocalizer = p.manage_addProduct['Localizer'].manage_addLocalizer
      addLocalizer('', ('en',))
1771
    localizer = p.Localizer
1772 1773
    addMessageCatalog = localizer.manage_addProduct['Localizer']\
                                      .manage_addMessageCatalog
1774 1775 1776
    if 'erp5_ui' not in localizer.objectIds():
      if 'default' in localizer.objectIds():
        localizer.manage_delObjects('default')
1777 1778 1779
      addMessageCatalog('default', 'ERP5 Localized Messages', ('en',))
      addMessageCatalog('erp5_ui', 'ERP5 Localized Interface', ('en',))
      addMessageCatalog('erp5_content', 'ERP5 Localized Content', ('en',))
1780

1781 1782 1783
    # Add an error_log
    if 'error_log' not in p.objectIds():
      manage_addErrorLog(p)
1784 1785 1786 1787
      p.error_log.setProperties(keep_entries=20,
                                copy_to_zlog=True,
                                ignored_exceptions=('NotFound', 'Redirect'))

1788 1789 1790

    # Remove unused default actions
    def removeActionsFromTool(tool, remove_list):
1791 1792 1793 1794 1795 1796 1797
      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:
1798 1799
        # 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
1800
        # start loading ZCML. 
1801
        pass
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
      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',))
1815 1816
    # properties tool
    removeActionsFromTool(p.portal_properties, ('configPortal',))
1817 1818 1819 1820
    # remove unused action providers
    for i in ('portal_registration', 'portal_discussion', 'portal_syndication'):
      p.portal_actions.deleteActionProvider(i)

1821 1822
  def setupMembersFolder(self, p):
    """
1823
    ERP5 is not a CMS
1824 1825 1826
    """
    pass

1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840
  # 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
1841 1842
      def generateKey(package, subdir):
        return _generateKey(package.__name__, subdir)
1843
    except ImportError:
1844 1845 1846
      # Means we're still on CMF 1.x, were they generate the DirectoryView
      # key using minimalpath
      # ( see Products.CMFCore.DirectoryView.addDirectoryViews() )
1847
      from Products.CMFCore.DirectoryView import minimalpath
1848
      def generateKey(package, subdir):
1849 1850 1851 1852
        package_path = os.path.dirname(package.__file__)
        return minimalpath(os.path.join(package_path, subdir))
    import Products.CMFDefault

1853
    ps = p.portal_skins
1854 1855
    # get the layer directories actually present
    for cmfdefault_skin_layer in self.CMFDEFAULT_FOLDER_LIST:
1856 1857
      reg_key = generateKey(Products.CMFDefault,
                            'skins/' + cmfdefault_skin_layer)
1858 1859
      createDirectoryView(ps, reg_key)

1860 1861 1862
  def setupDefaultSkins(self, p):
    from Products.CMFCore.DirectoryView import addDirectoryViews
    from Products.CMFActivity import cmfactivity_globals
1863
    ps = p.portal_skins
1864
    self.addCMFDefaultDirectoryViews(p)
1865 1866 1867
    addDirectoryViews(ps, 'skins', cmfactivity_globals)
    ps.manage_addProduct['OFSP'].manage_addFolder(id='external_method')
    ps.manage_addProduct['OFSP'].manage_addFolder(id='custom')
1868
    # Set the 'custom' layer a high priority, so it remains the first
1869 1870 1871 1872 1873
    #   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'
1874
                       ] + self.CMFDEFAULT_FOLDER_LIST
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
    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
                       )
1888 1889 1890 1891
    p.setupCurrentSkin()

  def setupWorkflow(self, p):
    """
1892
    Set up workflows for business templates
1893
    """
1894
    tool = p.portal_workflow
1895
    for wf_id in ('business_template_building_workflow',
1896
                  'business_template_installation_workflow'):
1897 1898
      if wf_id in tool.objectIds():
        tool.manage_delObjects([wf_id])
1899
    bootstrap_dir = getBootstrapDirectory()
1900 1901 1902
    business_template_building_workflow = os.path.join(
                                 bootstrap_dir,
                                 'business_template_building_workflow.xml')
1903
    tool._importObjectFromFile(business_template_building_workflow)
1904 1905 1906
    business_template_installation_workflow = os.path.join(
                                 bootstrap_dir,
                                 'business_template_installation_workflow.xml')
1907 1908
    tool._importObjectFromFile(business_template_installation_workflow)
    tool.setChainForPortalTypes( ( 'Business Template', ),
1909 1910
                                 ( 'business_template_building_workflow',
                                   'business_template_installation_workflow' ) )
1911 1912 1913

  def setupIndex(self, p, **kw):
    # Make sure all tools and folders have been indexed
1914
    if not kw.get('reindex', 1):
1915
      return
1916
    # When no SQL connection was define on the site,
1917 1918
    # we don't want to make it crash
    if p.erp5_sql_connection_type is not None:
1919
      setattr(p, 'isIndexable', ConstantGetter('isIndexable', value=True))
1920 1921
      # Clear portal ids sql table, like this we do not take
      # ids for a previously created web site
Sebastien Robin's avatar
Sebastien Robin committed
1922
      p.portal_ids.clearGenerator(all=True)
1923
      # Then clear the catalog and reindex it
1924
      p.portal_catalog.manage_catalogClear()
1925
      # Calling ERP5Site_reindexAll is useless.
1926

1927 1928 1929
  def setupUserFolder(self, p):
      # Use Pluggable Auth Service instead of the standard acl_users.
      p.manage_addProduct['PluggableAuthService'].addPluggableAuthService()
1930
      pas_dispatcher = p.acl_users.manage_addProduct['PluggableAuthService']
1931
      # Add legacy ZODB support
1932 1933 1934
      pas_dispatcher.addZODBUserManager('zodb_users')
      pas_dispatcher.addZODBGroupManager('zodb_groups')
      pas_dispatcher.addZODBRoleManager('zodb_roles')
1935 1936 1937 1938
      # Add CMF Portal Roles
      p.acl_users.zodb_roles.addRole('Member')
      p.acl_users.zodb_roles.addRole('Reviewer')
      # Register ZODB Interface
1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949
      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'))
1950
      # Add ERP5UserManager
1951 1952 1953 1954 1955
      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')
1956
      # Register ERP5UserManager Interface
1957 1958 1959
      p.acl_users.erp5_users.manage_activateInterfaces(
                                        ('IAuthenticationPlugin',
                                        'IUserEnumerationPlugin',))
1960 1961
      p.acl_users.erp5_groups.manage_activateInterfaces(('IGroupsPlugin',))
      p.acl_users.erp5_roles.manage_activateInterfaces(('IRolesPlugin',))
1962 1963
      p.acl_users.erp5_user_factory.manage_activateInterfaces(
                                        ('IUserFactoryPlugin',))
1964 1965 1966 1967 1968 1969 1970 1971

  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'),
1972
      'Change local roles'           : ('Manager', ),
1973 1974 1975 1976 1977 1978
      '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'),
1979
      'List undoable changes'        : ('Manager', ),
1980 1981 1982 1983 1984
      'Manage properties'            : ('Manager', 'Owner'),
      'Modify portal content'        : ('Manager', 'Owner'),
      'Reply to item'                : ('Manager', 'Member'),
      'Review portal content'        : ('Manager', 'Reviewer'),
      'Search ZCatalog'              : ('Manager', 'Member'),
1985
      'Set own password'             : ('Manager', ),
1986
      'Set own properties'           : ('Manager', 'Member'),
1987
      'Use mailhost services'        : ('Manager', 'Member'),
1988
      'Undo changes'                 : ('Manager', 'Owner'),
1989
      'View'                         : ('Manager', 'Member',
1990
                                        'Owner', 'Anonymous'),
1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001
      '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)

2002 2003 2004
    if getattr(p, 'setDefaultSorting', None) is not None:
      p.setDefaultSorting('id', 0)

2005 2006 2007 2008 2009
    self.setupTools(p, **kw)

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

Jérome Perrin's avatar
Jérome Perrin committed
2010 2011
    if create_userfolder and not p.hasObject('acl_users'):
      self.setupUserFolder(p)
2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029

    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)

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

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

2030 2031 2032
    # Make sure the cache is initialized
    p.portal_caches.updateCache()

2033 2034
    self.setupLastTools(p, **kw)

2035 2036 2037 2038 2039
    # 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)

2040
  def setupERP5Core(self,p,**kw):
2041
    """
2042
    Install the core part of ERP5
2043
    """
2044
    template_tool = p.portal_templates
2045
    if template_tool.getInstalledBusinessTemplate('erp5_core') is None:
2046 2047
      for bt in ('erp5_property_sheets', 'erp5_core', p.erp5_catalog_storage,
                 'erp5_xhtml_style'):
2048 2049
        if not bt:
          continue
2050 2051 2052
        url = getBootstrapBusinessTemplateUrl(bt)
        bt = template_tool.download(url)
        bt.install(**kw)