ERP5Site.py 64.3 KB
Newer Older
1
##############################################################################
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3 4 5 6 7 8 9 10 11 12
#
# 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
#
##############################################################################
13 14
"""
  Portal class
Jean-Paul Smets's avatar
Jean-Paul Smets committed
15 16 17
"""

import Globals
18
import AccessControl
Jean-Paul Smets's avatar
Jean-Paul Smets committed
19
from Globals import package_home
20

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

38
from zLOG import LOG, INFO
Sebastien Robin's avatar
Sebastien Robin committed
39
from string import join
40
import os, traceback
41
import warnings
42 43
MARKER = []

44

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

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

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

152 153 154 155 156 157 158
    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
159

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

179
class ERP5Site(FolderMixIn, CMFSite):
180
  """
181 182
  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.
183
  """
184
  meta_type = 'ERP5 Site'
185
  portal_type = 'ERP5 Site'
186
  constructors = (('addERP5Site', manage_addERP5SiteForm), manage_addERP5Site, )
187 188 189
  uid = 0
  last_id = 0
  icon = 'portal.gif'
190
  isIndexable = 1 # Default value, prevents error during upgrade
191 192

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

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

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

213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
  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)

248 249 250 251 252 253 254
  def _getAcquireLocalRoles(self):
    """
      Prevent local roles from being acquired outside of Portal object.
      See ERP5Security/__init__.py:mergedLocalRoles .
    """
    return False

255 256 257 258 259 260 261
  security.declareProtected(Permissions.ManagePortal, 'enableRefererCheck')
  def enableRefererCheck(self):
    """Enable a ReferCheckerBeforeTraverseHook to check users have valid
    HTTP_REFERER
    """
    BeforeTraverse.registerBeforeTraverse(self,
                                        ReferCheckerBeforeTraverseHook(),
262 263 264
                                        ReferCheckerBeforeTraverseHook.handle,
                             # we want to be registered _after_ CookieCrumbler
                                        100)
265

266 267 268 269
  def _disableRefererCheck(self):
    """Disable the HTTP_REFERER check."""
    BeforeTraverse.unregisterBeforeTraverse(self,
                                        ReferCheckerBeforeTraverseHook.handle)
270

271
  def hasObject(self, id):
272
    """
273
    Check if the portal has an id.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
274
    """
275
    return id in self.objectIds()
276

277
  security.declareProtected(Permissions.AccessContentsInformation,
278
                            'getPortalObject')
279 280
  def getPortalObject(self):
    return self
Jean-Paul Smets's avatar
Jean-Paul Smets committed
281

282 283 284 285 286
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalType')
  def getPortalType(self):
    return self.portal_type

287
  security.declareProtected(Permissions.AccessContentsInformation,
288
                            'getTitle')
289 290 291 292 293
  def getTitle(self):
    """
      Return the title.
    """
    return self.title
294

295 296 297 298 299 300
  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
301

302 303 304
      WARNING : must be updates for circular references issues
    """
    return getattr(self, 'uid', 0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
305

306
  security.declareProtected(Permissions.AccessContentsInformation,
307
                            'getParentUid')
308 309 310 311 312
  def getParentUid(self):
    """
      A portal has no parent
    """
    return self.getUid()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
313

314 315 316 317
  # 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
318

319 320 321 322
  # 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
323

324 325
  security.declareProtected(Permissions.AccessContentsInformation, 'getUrl')
  def getUrl(self, REQUEST=None):
326 327 328 329
    """
      Returns the absolute path of an object
    """
    return join(self.getPhysicalPath(),'/')
Sebastien Robin's avatar
Sebastien Robin committed
330

331 332 333 334 335
  # Old name - for compatibility
  security.declareProtected(Permissions.AccessContentsInformation, 'getPath')
  getPath = getUrl

  security.declareProtected(Permissions.AccessContentsInformation, 'searchFolder')
336 337 338 339 340 341 342
  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
343
    return self.portal_catalog.searchResults(**kw)
344 345 346 347 348 349 350 351 352

  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
353
    return self.portal_catalog.countResults(**kw)
354 355 356 357 358 359 360 361

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

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

364
    This should absolutely be rewritten by using clean
365
    concepts to separate worklists XXX
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
    """
    sorted_workflow_actions = {}
    sorted_global_actions = []
    other_global_actions = []
    for action in action_list:
      action['disabled'] = 0
      if action.has_key('workflow_title'):
        if not sorted_workflow_actions.has_key(action['workflow_title']):
          sorted_workflow_actions[action['workflow_title']] = []
        sorted_workflow_actions[action['workflow_title']].append(action)
      else:
        other_global_actions.append(action)
    workflow_title_list = sorted_workflow_actions.keys()
    workflow_title_list.sort()
    for key in workflow_title_list:
      sorted_global_actions.append({'title': key, 'disabled': 1})
      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,
388 389 390
                             email_from_address, email_from_name,
                             validate_email
                             ):
391
    CMFSite.setupDefaultProperties(self, p, title, description,
392 393
                           email_from_address, email_from_name,
                           validate_email)
394

395 396 397
  # 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
398
  # to customize the settings for each portal site.
399 400
  def _getPortalConfiguration(self, id):
    """
401
    Get a portal-specific configuration.
402

403 404
    Current implementation is using properties in a portal object.
    If not found, try to get a default value for backward compatibility.
405

406 407
    This implementation can be improved by gathering information
    from appropriate places, such as portal_types, portal_categories
408
    and portal_workflow.
409 410 411
    """
    if self.hasProperty(id):
      return self.getProperty(id)
412

413 414
    # Fall back to the default.
    return getattr(ERP5Defaults, id, None)
415

416
  def _getPortalGroupedTypeList(self, group):
417
    """
418
    Return a list of portal types classified to a specific group.
419 420
    The result is sorted by language (using the user language
    as default)
421 422 423 424 425 426
    """
    def getTypeList(group):
      type_list = []
      for pt in self.portal_types.objectValues():
        if group in getattr(pt, 'group_list', ()):
          type_list.append(pt.getId())
427 428 429 430 431 432

      def sortByTranslation(a, b):
        return cmp(localizer_tool.translate('ui', a),
                   localizer_tool.translate('ui', b))

      type_list.sort(sortByTranslation)
433 434
      return tuple(type_list)

435 436 437 438
    localizer_tool = getToolByName(self, 'Localizer')
    language = localizer_tool.get_selected_language()
    # language should be cached in Transaction Cache if performance issue

439
    getTypeList = CachingMethod(getTypeList,
440
                                id=(('_getPortalGroupedTypeList', language), group),
Aurel's avatar
Aurel committed
441
                                cache_factory='erp5_content_medium')
442 443 444

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

  def _getPortalGroupedCategoryList(self, group):
447
    """
448
    Return a list of base categories classified to a specific group.
449 450 451 452 453 454 455 456
    """
    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)

457 458
    getCategoryList = CachingMethod(
                            getCategoryList,
459
                            id=('_getPortalGroupedCategoryList', group),
Aurel's avatar
Aurel committed
460
                            cache_factory='erp5_content_medium')
461 462 463
    return getCategoryList(group)

  def _getPortalGroupedStateList(self, group):
464
    """
465
    Return a list of workflow states classified to a specific group.
466 467 468 469 470 471 472 473 474 475
    """
    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())

476
    getStateList = CachingMethod(getStateList,
477
                                 id=('_getPortalGroupedStateList', group),
Aurel's avatar
Aurel committed
478
                                 cache_factory='erp5_content_medium')
479 480
    return getStateList(group)

481 482
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDefaultSectionCategory')
483 484
  def getPortalDefaultSectionCategory(self):
    """
485
    Return a default section category. This method is deprecated.
486 487 488 489
    """
    LOG('ERP5Site', 0, 'getPortalDefaultSectionCategory is deprecated;'+
        ' use portal_preferences.getPreferredSectionCategory instead.')
    section_category = self.portal_preferences.getPreferredSectionCategory()
490

491 492 493 494
    # XXX This is only for backward-compatibility.
    if not section_category:
      section_category = self._getPortalConfiguration(
                                'portal_default_section_category')
495

496
    return section_category
497

498 499 500 501 502 503
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalResourceTypeList')
  def getPortalResourceTypeList(self):
    """
      Return resource types.
    """
504 505 506
    return self._getPortalGroupedTypeList('resource') or \
           self._getPortalConfiguration('portal_resource_type_list')

507 508 509 510 511 512 513
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSubVariationTypeList')
  def getPortalSubVariationTypeList(self):
    """
      Return resource types.
    """
    return self._getPortalGroupedTypeList('sub_variation')
514

515 516 517 518 519 520 521
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSubVariationBaseCategoryList')
  def getPortalSubVariationBaseCategoryList(self):
    """
      Return variation base categories.
    """
    return self._getPortalGroupedCategoryList('sub_variation')
522

523 524 525 526 527 528
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalVariationTypeList')
  def getPortalVariationTypeList(self):
    """
      Return variation types.
    """
529 530 531
    return self._getPortalGroupedTypeList('variation') or \
           self._getPortalConfiguration('portal_variation_type_list')

532 533 534 535 536 537
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalNodeTypeList')
  def getPortalNodeTypeList(self):
    """
      Return node types.
    """
538 539 540
    return self._getPortalGroupedTypeList('node') or \
           self._getPortalConfiguration('portal_node_type_list')

541 542 543 544 545 546
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPaymentNodeTypeList')
  def getPortalPaymentNodeTypeList(self):
    """
      Return payment node types.
    """
547 548 549
    return self._getPortalGroupedTypeList('payment_node') or \
           self._getPortalConfiguration('portal_payment_node_type_list')

550 551 552 553 554 555
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInvoiceTypeList')
  def getPortalInvoiceTypeList(self):
    """
      Return invoice types.
    """
556 557 558
    return self._getPortalGroupedTypeList('invoice') or \
           self._getPortalConfiguration('portal_invoice_type_list')

559 560 561 562 563 564
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOrderTypeList')
  def getPortalOrderTypeList(self):
    """
      Return order types.
    """
565 566 567
    return self._getPortalGroupedTypeList('order') or \
           self._getPortalConfiguration('portal_order_type_list')

568 569 570 571 572 573
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDeliveryTypeList')
  def getPortalDeliveryTypeList(self):
    """
      Return delivery types.
    """
574 575 576
    return self._getPortalGroupedTypeList('delivery') or \
           self._getPortalConfiguration('portal_delivery_type_list')

577 578 579 580 581 582
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTransformationTypeList')
  def getPortalTransformationTypeList(self):
    """
      Return transformation types.
    """
583 584 585
    return self._getPortalGroupedTypeList('transformation') or \
           self._getPortalConfiguration('portal_transformation_type_list')

586 587 588 589 590 591
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalVariationBaseCategoryList')
  def getPortalVariationBaseCategoryList(self):
    """
      Return variation base categories.
    """
592 593 594
    return self._getPortalGroupedCategoryList('variation') or \
           self._getPortalConfiguration('portal_variation_base_category_list')

595 596 597 598 599 600
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOptionBaseCategoryList')
  def getPortalOptionBaseCategoryList(self):
    """
      Return option base categories.
    """
601 602 603
    return self._getPortalGroupedCategoryList('option') or \
           self._getPortalConfiguration('portal_option_base_category_list')

604 605 606 607 608 609
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInvoiceMovementTypeList')
  def getPortalInvoiceMovementTypeList(self):
    """
      Return invoice movement types.
    """
610 611 612
    return self._getPortalGroupedTypeList('invoice_movement') or \
           self._getPortalConfiguration('portal_invoice_movement_type_list')

613 614 615 616 617 618 619 620 621 622
  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')


623 624 625 626 627 628
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOrderMovementTypeList')
  def getPortalOrderMovementTypeList(self):
    """
      Return order movement types.
    """
629 630 631
    return self._getPortalGroupedTypeList('order_movement') or \
           self._getPortalConfiguration('portal_order_movement_type_list')

632 633 634 635 636 637
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDeliveryMovementTypeList')
  def getPortalDeliveryMovementTypeList(self):
    """
      Return delivery movement types.
    """
638 639 640
    return self._getPortalGroupedTypeList('delivery_movement') or \
           self._getPortalConfiguration('portal_delivery_movement_type_list')

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

650 651 652 653 654 655 656 657
  security.declareProtected(Permissions.AccessContentsInformation,
                              'getPortalRuleTypeList')
  def getPortalRuleTypeList(self):
    """
      Return rule types.
    """
    return self._getPortalGroupedTypeList('rule')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
658 659 660 661
  security.declareProtected(Permissions.AccessContentsInformation,
                              'getPortalProjectTypeList')
  def getPortalProjectTypeList(self):
    """
662
      Return project types.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
663 664 665
    """
    return self._getPortalGroupedTypeList('project')

666
  security.declareProtected(Permissions.AccessContentsInformation,
667 668 669 670 671
                              'getPortalDocumentTypeList')
  def getPortalDocumentTypeList(self):
    """
      Return document types.
    """
672
    return self._getPortalGroupedTypeList('document')
673 674 675 676 677 678 679 680 681

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

682 683 684 685
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalFileDocumentTypeList')
  def getPortalFileDocumentTypeList(self):
    """
686
      Return file document types.
687 688 689 690 691 692 693
    """
    return self._getPortalGroupedTypeList('file_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalRecentDocumentTypeList')
  def getPortalRecentDocumentTypeList(self):
    """
694
      Return recent document types.
695 696 697 698 699 700 701
    """
    return self._getPortalGroupedTypeList('recent_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTemplateDocumentTypeList')
  def getPortalTemplateDocumentTypeList(self):
    """
702
      Return template document types.
703 704 705 706 707 708 709
    """
    return self._getPortalGroupedTypeList('template_document')

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMyDocumentTypeList')
  def getPortalMyDocumentTypeList(self):
    """
710
      Return my document types.
711 712 713
    """
    return self._getPortalGroupedTypeList('my_document')

714 715 716 717
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalCrawlerIndexTypeList')
  def getPortalCrawlerIndexTypeList(self):
    """
718
      Return crawler index types.
719 720 721
    """
    return self._getPortalGroupedTypeList('crawler_index')

722 723 724 725 726 727 728 729
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBudgetVariationTypeList')
  def getPortalBudgetVariationTypeList(self):
    """
      Return budget variation types.
    """
    return self._getPortalGroupedTypeList('budget_variation')

730
  security.declareProtected(Permissions.AccessContentsInformation,
731
                            'getPortalSupplyPathTypeList')
732 733
  def getPortalSupplyPathTypeList(self):
    """
734
      Return supply path types.
735
    """
736 737 738
    return self._getPortalGroupedTypeList('supply_path') or \
           self._getPortalConfiguration('portal_supply_path_type_list')

739 740 741 742 743 744 745
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAcquisitionMovementTypeList')
  def getPortalAcquisitionMovementTypeList(self):
    """
      Return acquisition movement types.
    """
    return tuple(list(self.getPortalOrderMovementTypeList()) +
746
                 list(self.getPortalDeliveryMovementTypeList()) +
747
                 list(self.getPortalTaxMovementTypeList()) +
748 749
                 list(self.getPortalInvoiceMovementTypeList()))

750 751 752 753 754 755 756
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMovementTypeList')
  def getPortalMovementTypeList(self):
    """
      Return movement types.
    """
    return tuple(list(self.getPortalOrderMovementTypeList()) +
757 758
                 list(self.getPortalDeliveryMovementTypeList()) +
                 list(self.getPortalInvoiceMovementTypeList()) +
759
                 list(self.getPortalTaxMovementTypeList()) +
760
                 ['Simulation Movement'])
761

762 763 764 765 766 767
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSimulatedMovementTypeList')
  def getPortalSimulatedMovementTypeList(self):
    """
      Return simulated movement types.
    """
768
    return tuple([x for x in self.getPortalMovementTypeList() \
769
                  if x not in self.getPortalContainerTypeList()])
770

771 772 773 774 775 776
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalContainerTypeList')
  def getPortalContainerTypeList(self):
    """
      Return container types.
    """
777 778 779
    return self._getPortalGroupedTypeList('container') or \
           self._getPortalConfiguration('portal_container_type_list')

780 781 782 783 784 785
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalContainerLineTypeList')
  def getPortalContainerLineTypeList(self):
    """
      Return container line types.
    """
786 787 788
    return self._getPortalGroupedTypeList('container_line') or \
           self._getPortalConfiguration('portal_container_line_type_list')

789 790 791 792 793 794
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalItemTypeList')
  def getPortalItemTypeList(self):
    """
      Return item types.
    """
795 796 797
    return self._getPortalGroupedTypeList('item') or \
           self._getPortalConfiguration('portal_item_type_list')

798 799 800 801 802 803
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDiscountTypeList')
  def getPortalDiscountTypeList(self):
    """
      Return discount types.
    """
804 805 806
    return self._getPortalGroupedTypeList('discount') or \
           self._getPortalConfiguration('portal_discount_type_list')

807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
  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')

825 826 827 828 829 830
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAlarmTypeList')
  def getPortalAlarmTypeList(self):
    """
      Return alarm types.
    """
831 832 833
    return self._getPortalGroupedTypeList('alarm') or \
           self._getPortalConfiguration('portal_alarm_type_list')

834 835 836 837 838 839
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPaymentConditionTypeList')
  def getPortalPaymentConditionTypeList(self):
    """
      Return payment condition types.
    """
840 841 842
    return self._getPortalGroupedTypeList('payment_condition') or \
           self._getPortalConfiguration('portal_payment_condition_type_list')

843 844 845 846 847 848
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBalanceTransactionLineTypeList')
  def getPortalBalanceTransactionLineTypeList(self):
    """
      Return balance transaction line types.
    """
849
    return self._getPortalGroupedTypeList('balance_transaction_line') or \
850 851
           self._getPortalConfiguration(
                  'portal_balance_transaction_line_type_list')
852

853 854 855 856 857 858
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalCurrentInventoryStateList')
  def getPortalCurrentInventoryStateList(self):
    """
      Return current inventory states.
    """
859 860 861
    return self._getPortalGroupedStateList('current_inventory') or \
           self._getPortalConfiguration('portal_current_inventory_state_list')

862 863 864 865 866 867 868 869 870
  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')

871 872 873 874 875 876
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDraftOrderStateList')
  def getPortalDraftOrderStateList(self):
    """
      Return draft order states.
    """
877 878 879
    return self._getPortalGroupedStateList('draft_order') or \
           self._getPortalConfiguration('portal_draft_order_state_list')

880 881 882 883 884 885
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPlannedOrderStateList')
  def getPortalPlannedOrderStateList(self):
    """
      Return planned order states.
    """
886 887 888
    return self._getPortalGroupedStateList('planned_order') or \
           self._getPortalConfiguration('portal_planned_order_state_list')

889 890 891 892 893 894
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalReservedInventoryStateList')
  def getPortalReservedInventoryStateList(self):
    """
      Return reserved inventory states.
    """
895
    return self._getPortalGroupedStateList('reserved_inventory') or \
896
        self._getPortalConfiguration('portal_reserved_inventory_state_list')
897

898 899 900 901 902 903
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalFutureInventoryStateList')
  def getPortalFutureInventoryStateList(self):
    """
      Return future inventory states.
    """
904 905 906
    return self._getPortalGroupedStateList('future_inventory') or \
           self._getPortalConfiguration('portal_future_inventory_state_list')

907
  security.declareProtected(Permissions.AccessContentsInformation,
908
                          'getPortalUpdatableAmortisationTransactionStateList')
909 910
  def getPortalUpdatableAmortisationTransactionStateList(self):
    """
911
      Return states when Amortisation Transaction can be updated
912
      by amortisation_transaction_builder.
913
    """
914 915
    return self._getPortalConfiguration(
        'portal_updatable_amortisation_transaction_state_list')
916

917 918 919 920 921 922
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalColumnBaseCategoryList')
  def getPortalColumnBaseCategoryList(self):
    """
      Return column base categories.
    """
923 924 925
    return self._getPortalGroupedCategoryList('column') or \
           self._getPortalConfiguration('portal_column_base_category_list')

926 927 928 929 930 931
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalLineBaseCategoryList')
  def getPortalLineBaseCategoryList(self):
    """
      Return line base categories.
    """
932 933 934
    return self._getPortalGroupedCategoryList('line') or \
           self._getPortalConfiguration('portal_line_base_category_list')

935 936 937 938 939 940
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTabBaseCategoryList')
  def getPortalTabBaseCategoryList(self):
    """
      Return tab base categories.
    """
941 942 943
    return self._getPortalGroupedCategoryList('tab') or \
           self._getPortalConfiguration('portal_tab_base_category_list')

944 945 946 947
  def getPortalDefaultGapRoot(self):
    """
      Return the Accounting Plan to use by default (return the root node)
    """
948
    LOG('ERP5Site', 0,
949 950 951
        'getPortalDefaultGapRoot is deprecated; ' \
        'use portal_preferences.getPreferredAccountingTransactionGap instead.')

952 953
    return self.portal_preferences.getPreferredAccountingTransactionGap() or \
           self._getPortalConfiguration('portal_default_gap_root')
954

955 956 957 958
  def getPortalAccountingMovementTypeList(self) :
    """
      Return accounting movement type list.
    """
959
    return self._getPortalGroupedTypeList('accounting_movement') or \
960
        self._getPortalConfiguration('portal_accounting_movement_type_list')
961

962 963 964 965
  def getPortalAccountingTransactionTypeList(self) :
    """
      Return accounting transaction movement type list.
    """
966
    return self._getPortalGroupedTypeList('accounting_transaction') or \
967
      self._getPortalConfiguration('portal_accounting_transaction_type_list')
968

969 970 971 972
  def getPortalAssignmentBaseCategoryList(self):
    """
      Return List of category values to generate security groups.
    """
973
    return self._getPortalGroupedCategoryList('assignment') or \
974
        self._getPortalConfiguration('portal_assignment_base_category_list')
975

976 977
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTicketTypeList')
978 979 980 981 982
  def getPortalTicketTypeList(self):
    """
    Return ticket types.
    """
    return self._getPortalGroupedTypeList('ticket')
983

984 985
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalEventTypeList')
986 987 988 989 990
  def getPortalEventTypeList(self):
    """
    Return event types.
    """
    return self._getPortalGroupedTypeList('event')
991

992 993 994 995 996 997 998 999
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDivergenceTesterTypeList')
  def getPortalDivergenceTesterTypeList(self):
    """
    Return divergence tester types.
    """
    return self._getPortalGroupedTypeList('divergence_tester')

1000 1001 1002 1003 1004 1005 1006 1007
  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
1008 1009 1010 1011 1012 1013 1014 1015
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalModuleTypeList')
  def getPortalModuleTypeList(self):
    """
    Return module types.
    """
    return self._getPortalGroupedTypeList('module')

1016 1017 1018 1019 1020 1021 1022 1023
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInventoryMovementTypeList')
  def getPortalInventoryMovementTypeList(self):
    """
    Return inventory movement types.
    """
    return self._getPortalGroupedTypeList('inventory_movement')

1024 1025 1026 1027 1028 1029 1030 1031
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMovementGroupTypeList')
  def getPortalMovementGroupTypeList(self):
    """
    Return movement group types.
    """
    return self._getPortalGroupedTypeList('movement_group')

1032 1033
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDefaultModuleId')
1034 1035
  def getDefaultModuleId(self, portal_type, default=MARKER):
    """
Romain Courteaud's avatar
Romain Courteaud committed
1036 1037
    Return default module id where a object with portal_type can
    be created.
1038 1039
    """
    portal_object = self
Romain Courteaud's avatar
Romain Courteaud committed
1040 1041 1042 1043 1044
    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
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
    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
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070

    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
1071

1072 1073
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDefaultModule')
1074
  def getDefaultModule(self, portal_type, default=MARKER):
1075 1076 1077
    """
      Return default module where a object with portal_type can be created
    """
1078 1079 1080 1081
    module_id = self.getDefaultModuleId(portal_type, default)
    if module_id:
      return getattr(self, module_id, None)
    return None
1082

1083 1084 1085 1086 1087 1088 1089 1090 1091
  security.declareProtected(Permissions.AddPortalContent, 'newContent')
  def newContent(self, id=None, portal_type=None, immediate_reindex=0, **kw):
    """
      Creates a new content
    """
    if id is None:
      raise ValueError, 'The id should not be None'
    if portal_type is None:
      raise ValueError, 'The portal_type should not be None'
1092 1093 1094 1095
    self.portal_types.constructContent(type_name=portal_type,
                                       container=self,
                                       id=id,
                                       ) # **kw) removed due to CMF bug
1096
    new_instance = self[id]
1097

1098 1099 1100 1101
    if kw is not None:
      new_instance._edit(force_update=1, **kw)
    if immediate_reindex:
      new_instance.immediateReindexObject()
1102 1103
    return new_instance

1104 1105 1106 1107 1108 1109
  security.declarePublic('getVisibleAllowedContentTypeList')
  def getVisibleAllowedContentTypeList(self):
    """Users cannot add anything in an ERP5Site using standard interface.
    """
    return ()

1110 1111 1112 1113 1114 1115
  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)
1116

1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
  security.declarePublic('setPlacelessDefaultReindexParameters')
  def setPlacelessDefaultReindexParameters(self, **kw):
    # This method sets the default keyword parameters to reindex. This is useful
    # when you need to specify special parameters implicitly (e.g. to reindexObject).
    # Those parameters will affect all reindex calls, not just ones on self.
    tv = getTransactionalVariable(self)
    key = ('default_reindex_parameter', )
    tv[key] = kw

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

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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1151 1152
Globals.InitializeClass(ERP5Site)

1153 1154 1155 1156 1157 1158 1159
def getBootstrapDirectory():
  """
    Return the name of the bootstrap directory
  """
  product_path = package_home(globals())
  return os.path.join(product_path, 'bootstrap')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1160 1161
class ERP5Generator(PortalGenerator):

1162
  klass = ERP5Site
1163

1164
  def getBootstrapDirectory(self):
1165
    return getBootstrapDirectory()
1166

1167 1168 1169
  def create(self,
             parent,
             id,
1170
             create_userfolder,
1171
             erp5_catalog_storage,
1172
             erp5_sql_connection_type,
1173 1174 1175 1176 1177 1178 1179 1180
             erp5_sql_connection_string,
             erp5_sql_deferred_connection_type,
             erp5_sql_deferred_connection_string,
             cmf_activity_sql_connection_type,
             cmf_activity_sql_connection_string,
             create_activities=1,
             reindex=1,
             **kw):
1181 1182
    id = str(id)
    portal = self.klass(id=id)
1183 1184
    # Make sure reindex will not be called until business templates
    # will be installed
1185
    setattr(portal, 'isIndexable', 0)
1186 1187 1188
    parent._setObject(id, portal)
    # Return the fully wrapped object.
    p = parent.this()._getOb(id)
1189 1190
    p._setProperty('erp5_catalog_storage',
                   erp5_catalog_storage, 'string')
1191
    p._setProperty('erp5_sql_connection_type',
1192
                   erp5_sql_connection_type, 'string')
1193
    p._setProperty('erp5_sql_connection_string',
1194
                   erp5_sql_connection_string, 'string')
1195
    p._setProperty('erp5_sql_deferred_connection_type',
1196
                   erp5_sql_deferred_connection_type, 'string')
1197
    p._setProperty('erp5_sql_deferred_connection_string',
1198
                   erp5_sql_deferred_connection_string, 'string')
1199
    p._setProperty('cmf_activity_sql_connection_type',
1200
                   cmf_activity_sql_connection_type, 'string')
1201
    p._setProperty('cmf_activity_sql_connection_string',
1202 1203
                   cmf_activity_sql_connection_string, 'string')
    # XXX hardcoded charset
1204
    p._setProperty('management_page_charset', 'UTF-8', 'string')
1205 1206
    self.setup(p, create_userfolder, create_activities=create_activities,
        reindex=reindex, **kw)
1207 1208 1209 1210
    return p

  def setupLastTools(self, p, **kw):
    """
1211 1212 1213
    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
1214 1215
    """
    # Add Activity Tool
1216
    if kw.has_key('create_activities') and int(kw['create_activities'])==1:
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
      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)
1228

1229 1230
  def setupTemplateTool(self, p, **kw):
    """
1231
    Setup the Template Tool. Security must be set strictly.
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
    """
    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):
    """
1242
    Set up initial tools.
1243 1244 1245 1246
    """
    if not 'portal_actions' in p.objectIds():
      PortalGenerator.setupTools(self, p)

1247
    # It is better to remove portal_catalog
1248
    # which is ZCatalog as soon as possible,
1249
    # because the API is not the completely same as ERP5Catalog,
1250
    # and ZCatalog is useless for ERP5 after all.
1251 1252
    update = kw.get('update', 0)
    portal_catalog = getToolByName(p, 'portal_catalog', None)
1253 1254 1255
    if portal_catalog is not None and \
       portal_catalog.meta_type != 'ZSQLCatalog' and \
       not update:
1256 1257 1258 1259
      p._delObject('portal_catalog')

    # Add CMF Report Tool
    if not p.hasObject('portal_report'):
1260 1261 1262 1263 1264
      try:
        addTool = p.manage_addProduct['CMFReportTool'].manage_addTool
        addTool('CMF Report Tool', None)
      except AttributeError:
        pass
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287

    # 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_rules'):
      addTool('ERP5 Rule Tool', None)
    if not p.hasObject('portal_ids'):
      addTool('ERP5 Id Tool', None)
    if not p.hasObject('portal_simulation'):
      addTool('ERP5 Simulation 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)
    if not p.hasObject('portal_deliveries'):
      addTool('ERP5 Delivery Tool', None)
    if not p.hasObject('portal_orders'):
      addTool('ERP5 Order Tool', None)
1288 1289
    if not p.hasObject('portal_tests'):
      addTool('ERP5 Test Tool', None)
1290 1291
    if not p.hasObject('portal_password'):
      addTool('ERP5 Password Tool', None)
Aurel's avatar
Aurel committed
1292

1293 1294
    # Add ERP5Type Tool
    addTool = p.manage_addProduct['ERP5Type'].manage_addTool
1295 1296
    if not p.hasObject('portal_caches'):
      addTool('ERP5 Cache Tool', None)
1297 1298
    if not p.hasObject('portal_memcached'):
      addTool('ERP5 Memcached Tool', None)
1299

1300 1301 1302 1303 1304 1305
    try:
      addTool = p.manage_addProduct['ERP5Subversion'].manage_addTool
      if not p.hasObject('portal_subversion'):
        addTool('ERP5 Subversion Tool', None)
    except AttributeError:
      pass
1306

1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
    # 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
1319

1320 1321 1322
    # Add Default SQL connection
    if p.erp5_sql_connection_type == 'Z MySQL Database Connection':
      if not p.hasObject('erp5_sql_connection'):
1323 1324
        addSQLConnection = p.manage_addProduct['ZMySQLDA'].\
                                     manage_addZMySQLConnection
1325 1326
        addSQLConnection('erp5_sql_connection',
                         'ERP5 SQL Server Connection',
1327
                         p.erp5_sql_connection_string)
1328 1329
    elif p.erp5_sql_connection_type == 'Z Gadfly':
      pass
1330 1331

    # Add Deferred SQL Connections
1332 1333
    if p.erp5_sql_deferred_connection_type == \
        'Z MySQL Deferred Database Connection':
1334
      if not p.hasObject('erp5_sql_deferred_connection'):
1335 1336
        addSQLConnection = p.manage_addProduct['ZMySQLDDA'].\
            manage_addZMySQLDeferredConnection
1337 1338
        addSQLConnection('erp5_sql_deferred_connection',
                         'ERP5 SQL Server Deferred Connection',
1339
                         p.erp5_sql_deferred_connection_string)
1340 1341 1342 1343
    elif p.erp5_sql_deferred_connection_type == 'Z Gadfly':
      pass

    # Add Activity SQL Connections
1344 1345
    if p.cmf_activity_sql_connection_type == 'Z MySQL Database Connection':
      if not p.hasObject('cmf_activity_sql_connection'):
1346 1347
        addSQLConnection = p.manage_addProduct['ZMySQLDA'].\
                                     manage_addZMySQLConnection
1348 1349
        addSQLConnection('cmf_activity_sql_connection',
                         'CMF Activity SQL Server Connection',
1350
                         p.cmf_activity_sql_connection_string)
1351 1352 1353 1354 1355
      # 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
1356
      # minus prepended to the connection string.
1357 1358 1359 1360 1361
      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
1362
                         '-%s' % p.cmf_activity_sql_connection_string)
1363 1364
    elif p.cmf_activity_sql_connection_type == 'Z Gadfly':
      pass
1365

1366 1367 1368 1369 1370 1371 1372
    # 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)

1373 1374 1375 1376 1377 1378 1379
    try:
      # Add ERP5SyncML Tools
      addTool = p.manage_addProduct['ERP5SyncML'].manage_addTool
      if not p.hasObject('portal_synchronizations'):
        addTool('ERP5 Synchronizations', None)
    except AttributeError:
      pass
1380 1381 1382 1383 1384 1385

    # Add Message Catalog
    if not 'Localizer' in p.objectIds():
      addLocalizer = p.manage_addProduct['Localizer'].manage_addLocalizer
      addLocalizer('', ('en',))
    localizer = getToolByName(p, 'Localizer')
1386 1387
    addMessageCatalog = localizer.manage_addProduct['Localizer']\
                                      .manage_addMessageCatalog
1388 1389 1390
    if 'erp5_ui' not in localizer.objectIds():
      if 'default' in localizer.objectIds():
        localizer.manage_delObjects('default')
1391 1392 1393
      addMessageCatalog('default', 'ERP5 Localized Messages', ('en',))
      addMessageCatalog('erp5_ui', 'ERP5 Localized Interface', ('en',))
      addMessageCatalog('erp5_content', 'ERP5 Localized Content', ('en',))
1394

1395 1396 1397
    # Add an error_log
    if 'error_log' not in p.objectIds():
      manage_addErrorLog(p)
1398 1399 1400 1401
      p.error_log.setProperties(keep_entries=20,
                                copy_to_zlog=True,
                                ignored_exceptions=('NotFound', 'Redirect'))

1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417

    # Remove unused default actions
    def removeActionsFromTool(tool, remove_list):
      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',))
1418 1419
    # properties tool
    removeActionsFromTool(p.portal_properties, ('configPortal',))
1420 1421 1422 1423
    # remove unused action providers
    for i in ('portal_registration', 'portal_discussion', 'portal_syndication'):
      p.portal_actions.deleteActionProvider(i)

1424 1425
  def setupMembersFolder(self, p):
    """
1426
    ERP5 is not a CMS
1427 1428 1429 1430 1431
    """
    pass

  def setupDefaultSkins(self, p):
    from Products.CMFCore.DirectoryView import addDirectoryViews
1432
    from Products.CMFDefault  import cmfdefault_globals
1433
    from Products.CMFActivity import cmfactivity_globals
Jérome Perrin's avatar
Jérome Perrin committed
1434 1435 1436
    try:
      from Products.FCKeditor   import fckeditor_globals
      have_fckeditor = 1
Jérome Perrin's avatar
Jérome Perrin committed
1437
    except ImportError:
Jérome Perrin's avatar
Jérome Perrin committed
1438
      have_fckeditor = 0
1439 1440 1441
    ps = getToolByName(p, 'portal_skins')
    addDirectoryViews(ps, 'skins', cmfdefault_globals)
    addDirectoryViews(ps, 'skins', cmfactivity_globals)
Jérome Perrin's avatar
Jérome Perrin committed
1442 1443
    if have_fckeditor:
      addDirectoryViews(ps, 'skins', fckeditor_globals)
1444 1445
    ps.manage_addProduct['OFSP'].manage_addFolder(id='external_method')
    ps.manage_addProduct['OFSP'].manage_addFolder(id='custom')
1446
    # Set the 'custom' layer a high priority, so it remains the first
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459
    #   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'
                       , 'zpt_content'
                       , 'zpt_generic'
                       , 'zpt_control'
                       , 'content'
                       , 'generic'
                       , 'control'
                       , 'Images'
                       ]
Jérome Perrin's avatar
Jérome Perrin committed
1460 1461
    if have_fckeditor:
      skin_folder_list.insert(1, 'fckeditor')
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
    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
                       )
1475 1476 1477 1478
    p.setupCurrentSkin()

  def setupWorkflow(self, p):
    """
1479
    Set up workflows for business templates
1480 1481 1482
    """
    tool = getToolByName(p, 'portal_workflow', None)
    if tool is None:
Jérome Perrin's avatar
Jérome Perrin committed
1483
      return
1484
    for wf_id in ('business_template_building_workflow',
1485
                  'business_template_installation_workflow'):
1486 1487 1488
      if wf_id in tool.objectIds():
        tool.manage_delObjects([wf_id])
    bootstrap_dir = self.getBootstrapDirectory()
1489 1490 1491
    business_template_building_workflow = os.path.join(
                                 bootstrap_dir,
                                 'business_template_building_workflow.xml')
1492
    tool._importObjectFromFile(business_template_building_workflow)
1493 1494 1495
    business_template_installation_workflow = os.path.join(
                                 bootstrap_dir,
                                 'business_template_installation_workflow.xml')
1496 1497
    tool._importObjectFromFile(business_template_installation_workflow)
    tool.setChainForPortalTypes( ( 'Business Template', ),
1498 1499
                                 ( 'business_template_building_workflow',
                                   'business_template_installation_workflow' ) )
1500 1501 1502

  def setupIndex(self, p, **kw):
    # Make sure all tools and folders have been indexed
1503
    if not kw.get('reindex', 1):
1504 1505 1506 1507
      return
    skins_tool = getToolByName(p, 'portal_skins', None)
    if skins_tool is None:
      return
1508
    # When no SQL connection was define on the site,
1509 1510 1511 1512
    # we don't want to make it crash
    if p.erp5_sql_connection_type is not None:
      setattr(p, 'isIndexable', 1)
      portal_catalog = p.portal_catalog
1513 1514 1515 1516
      # Clear portal ids sql table, like this we do not take
      # ids for a previously created web site
      portal_catalog.getSQLCatalog().z0_drop_portal_ids()
      # Then clear the catalog and reindex it
1517 1518
      portal_catalog.manage_catalogClear()
      skins_tool["erp5_core"].ERP5Site_reindexAll()
1519

1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
  def setupUserFolder(self, p):
    # We use if possible ERP5Security, then NuxUserGroups
    try:
      from Products import ERP5Security
      from Products import PluggableAuthService
    except ImportError:
      ERP5Security = None
      try:
        import Products.NuxUserGroups
        withnuxgroups = 1
      except ImportError:
        withnuxgroups = 0
    if ERP5Security is not None:
      # Use Pluggable Auth Service instead of the standard acl_users.
      p.manage_addProduct['PluggableAuthService'].addPluggableAuthService()
1535
      pas_dispatcher = p.acl_users.manage_addProduct['PluggableAuthService']
1536
      # Add legacy ZODB support
1537 1538 1539
      pas_dispatcher.addZODBUserManager('zodb_users')
      pas_dispatcher.addZODBGroupManager('zodb_groups')
      pas_dispatcher.addZODBRoleManager('zodb_roles')
1540
      # Add CMF Portal Roles
1541
      #XXX Maybe it will be no longer required once PAS is the standard
1542 1543 1544
      p.acl_users.zodb_roles.addRole('Member')
      p.acl_users.zodb_roles.addRole('Reviewer')
      # Register ZODB Interface
1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
      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'))
1556
      # Add ERP5UserManager
1557 1558 1559 1560 1561
      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')
1562
      # Register ERP5UserManager Interface
1563 1564 1565
      p.acl_users.erp5_users.manage_activateInterfaces(
                                        ('IAuthenticationPlugin',
                                        'IUserEnumerationPlugin',))
1566 1567
      p.acl_users.erp5_groups.manage_activateInterfaces(('IGroupsPlugin',))
      p.acl_users.erp5_roles.manage_activateInterfaces(('IRolesPlugin',))
1568 1569
      p.acl_users.erp5_user_factory.manage_activateInterfaces(
                                        ('IUserFactoryPlugin',))
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583
    elif withnuxgroups:
      # NuxUserGroups user folder
      p.manage_addProduct['NuxUserGroups'].addUserFolderWithGroups()
    else:
      # Standard user folder
      PortalGenerator.setupUserFolder(self, p)

  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'),
1584
      'Change local roles'           : ('Manager', ),
1585 1586 1587 1588 1589 1590
      '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'),
1591
      'List undoable changes'        : ('Manager', ),
1592 1593 1594 1595 1596
      'Manage properties'            : ('Manager', 'Owner'),
      'Modify portal content'        : ('Manager', 'Owner'),
      'Reply to item'                : ('Manager', 'Member'),
      'Review portal content'        : ('Manager', 'Reviewer'),
      'Search ZCatalog'              : ('Manager', 'Member'),
1597
      'Set own password'             : ('Manager', ),
1598
      'Set own properties'           : ('Manager', 'Member'),
1599
      'Use mailhost services'        : ('Manager', 'Member'),
1600
      'Undo changes'                 : ('Manager', 'Owner'),
1601
      'View'                         : ('Manager', 'Member',
1602
                                        'Owner', 'Anonymous'),
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
      '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)

1614 1615 1616
    if getattr(p, 'setDefaultSorting', None) is not None:
      p.setDefaultSorting('id', 0)

1617 1618 1619 1620 1621
    self.setupTools(p, **kw)

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

Jérome Perrin's avatar
Jérome Perrin committed
1622 1623
    if create_userfolder and not p.hasObject('acl_users'):
      self.setupUserFolder(p)
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649

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

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

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

    # ERP5 Design Choice is that all content should be user defined
    # Content is disseminated through business templates
    self.setupBusinessTemplate(p)

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

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

1650 1651 1652
    # Make sure the cache is initialized
    p.portal_caches.updateCache()

1653 1654
    self.setupLastTools(p, **kw)

1655 1656 1657 1658 1659 1660 1661
    # 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)

  def setupBusinessTemplate(self,p):
    """
1662
    Install the portal_type of Business Template
1663 1664 1665 1666 1667 1668 1669 1670 1671
    """
    tool = getToolByName(p, 'portal_types', None)
    if tool is None:
      return
    if 'Business Template' not in tool.objectIds():
      t = BusinessTemplate.factory_type_information
      ti = apply(ERP5TypeInformation, (), t)
      tool._setObject(t['id'], ti)

1672
  def setupERP5Core(self,p,**kw):
1673
    """
1674
    Install the core part of ERP5
1675 1676 1677 1678 1679 1680
    """
    template_tool = getToolByName(p, 'portal_templates', None)
    if template_tool is None:
      return
    if template_tool.getInstalledBusinessTemplate('erp5_core') is None:
      bootstrap_dir = self.getBootstrapDirectory()
1681 1682 1683 1684 1685
      if p.erp5_catalog_storage is not '':
        business_template_list = ('erp5_core', p.erp5_catalog_storage, 'erp5_xhtml_style')
      else:
        business_template_list = ('erp5_core', 'erp5_xhtml_style')
      for bt in business_template_list:
1686 1687 1688 1689 1690 1691 1692
        template = os.path.join(bootstrap_dir, bt)
        if not os.path.exists(template):
          template = os.path.join(bootstrap_dir, '%s.bt5' % bt)

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