ERP5Site.py 54.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 ZPublisher import BeforeTraverse
Jean-Paul Smets's avatar
Jean-Paul Smets committed
22 23 24 25
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
26
from Products.ERP5Type.Core.Folder import FolderMixIn
Jean-Paul Smets's avatar
Jean-Paul Smets committed
27
from Acquisition import aq_base, aq_parent, aq_inner, aq_acquire
28
from Products.ERP5Type import allowClassTool
29
from Products.ERP5Type.Cache import CachingMethod
30 31
from Products.ERP5Type.ERP5Type import ERP5TypeInformation
from Products.ERP5.Document.BusinessTemplate import BusinessTemplate
32

33
import ERP5Defaults
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34

35
from zLOG import LOG, INFO
Sebastien Robin's avatar
Sebastien Robin committed
36
from string import join
37
import os, traceback
38 39
MARKER = []

40

Jean-Paul Smets's avatar
Jean-Paul Smets committed
41
# Site Creation DTML
42 43 44 45 46 47 48 49 50
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)

51
manage_addERP5SiteForm.__name__ = 'addERP5Site'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
52 53

# ERP5Site Constructor
54 55 56
def manage_addERP5Site(self,
                       id,
                       title='ERP5',
57 58 59 60 61 62
                       description='',
                       create_userfolder=1,
                       create_activities=1,
                       email_from_address='postmaster@localhost',
                       email_from_name='Portal Administrator',
                       validate_email=0,
63
                       erp5_catalog_storage='',
64 65 66 67 68 69 70 71 72 73 74 75 76 77
                       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.
  '''
78
  gen = ERP5Generator()
79
  id = str(id).strip()
80 81
  p = gen.create(self,
                 id,
82
                 create_userfolder,
83
                 erp5_catalog_storage,
84 85 86 87 88 89 90 91 92
                 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)
93 94
  gen.setupDefaultProperties(p,
                             title,
95
                             description,
96
                             email_from_address,
97 98
                             email_from_name,
                             validate_email)
99
  if RESPONSE is not None:
100 101
    RESPONSE.redirect(p.absolute_url())

102 103 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()
  #import pdb; pdb.set_trace()
  for item in os.listdir(bootstrap_dir):
    #LOG('getCatalogStorageList', 0, item)
    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
  constructors = (manage_addERP5SiteForm, manage_addERP5Site, )
186 187 188
  uid = 0
  last_id = 0
  icon = 'portal.gif'
189
  isIndexable = 1 # Default value, prevents error during upgrade
190 191

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

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

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

212 213 214 215 216 217 218
  security.declareProtected(Permissions.ManagePortal, 'enableRefererCheck')
  def enableRefererCheck(self):
    """Enable a ReferCheckerBeforeTraverseHook to check users have valid
    HTTP_REFERER
    """
    BeforeTraverse.registerBeforeTraverse(self,
                                        ReferCheckerBeforeTraverseHook(),
219 220 221
                                        ReferCheckerBeforeTraverseHook.handle,
                             # we want to be registered _after_ CookieCrumbler
                                        100)
222

223 224 225 226
  def _disableRefererCheck(self):
    """Disable the HTTP_REFERER check."""
    BeforeTraverse.unregisterBeforeTraverse(self,
                                        ReferCheckerBeforeTraverseHook.handle)
227

228
  def hasObject(self, id):
229
    """
230
    Check if the portal has an id.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
231
    """
232
    return id in self.objectIds()
233

234
  security.declareProtected(Permissions.AccessContentsInformation,
235
                            'getPortalObject')
236 237
  def getPortalObject(self):
    return self
Jean-Paul Smets's avatar
Jean-Paul Smets committed
238

239
  security.declareProtected(Permissions.AccessContentsInformation,
240
                            'getTitle')
241 242 243 244 245
  def getTitle(self):
    """
      Return the title.
    """
    return self.title
246

247 248 249 250 251 252
  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
253

254 255 256
      WARNING : must be updates for circular references issues
    """
    return getattr(self, 'uid', 0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
257

258
  security.declareProtected(Permissions.AccessContentsInformation,
259
                            'getParentUid')
260 261 262 263 264
  def getParentUid(self):
    """
      A portal has no parent
    """
    return self.getUid()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
265

266 267 268 269
  # 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
270

271 272 273 274
  # 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
275

276 277
  security.declareProtected(Permissions.AccessContentsInformation, 'getUrl')
  def getUrl(self, REQUEST=None):
278 279 280 281
    """
      Returns the absolute path of an object
    """
    return join(self.getPhysicalPath(),'/')
Sebastien Robin's avatar
Sebastien Robin committed
282

283 284 285 286 287
  # Old name - for compatibility
  security.declareProtected(Permissions.AccessContentsInformation, 'getPath')
  getPath = getUrl

  security.declareProtected(Permissions.AccessContentsInformation, 'searchFolder')
288 289 290 291 292 293 294 295
  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
    kw2 = {}
296 297 298
    # Remove useless matter before calling the
    # catalog. In particular, consider empty
    # strings as None values
299
    for cname in kw.keys():
300
      if kw[cname] not in ('', None):
301
        kw2[cname] = kw[cname]
302 303
    # The method to call to search the folder
    # content has to be called z_search_folder
304 305 306 307 308 309 310 311 312 313 314 315
    method = self.portal_catalog.searchResults
    return method(**kw2)

  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
    kw2 = {}
316 317 318
    # Remove useless matter before calling the
    # catalog. In particular, consider empty
    # strings as None values
319
    for cname in kw.keys():
320
      if kw[cname] not in ('', None):
321
        kw2[cname] = kw[cname]
322 323
    # The method to call to search the folder
    # content has to be called z_search_folder
324 325 326 327 328 329 330 331 332 333
    method = self.portal_catalog.countResults
    return method(**kw2)

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

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

336
    This should absolutely be rewritten by using clean
337
    concepts to separate worklists XXX
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
    """
    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,
360 361 362
                             email_from_address, email_from_name,
                             validate_email
                             ):
363
    CMFSite.setupDefaultProperties(self, p, title, description,
364 365
                           email_from_address, email_from_name,
                           validate_email)
366

367 368 369
  # 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
370
  # to customize the settings for each portal site.
371 372
  def _getPortalConfiguration(self, id):
    """
373
    Get a portal-specific configuration.
374

375 376
    Current implementation is using properties in a portal object.
    If not found, try to get a default value for backward compatibility.
377

378 379
    This implementation can be improved by gathering information
    from appropriate places, such as portal_types, portal_categories
380
    and portal_workflow.
381 382 383
    """
    if self.hasProperty(id):
      return self.getProperty(id)
384

385 386
    # Fall back to the default.
    return getattr(ERP5Defaults, id, None)
387

388
  def _getPortalGroupedTypeList(self, group):
389
    """
390
    Return a list of portal types classified to a specific group.
391 392 393 394 395 396 397 398
    """
    def getTypeList(group):
      type_list = []
      for pt in self.portal_types.objectValues():
        if group in getattr(pt, 'group_list', ()):
          type_list.append(pt.getId())
      return tuple(type_list)

399
    getTypeList = CachingMethod(getTypeList,
400
                                id=('_getPortalGroupedTypeList', group),
401
                                cache_duration=3600)
402 403 404
    return getTypeList(group)

  def _getPortalGroupedCategoryList(self, group):
405
    """
406
    Return a list of base categories classified to a specific group.
407 408 409 410 411 412 413 414
    """
    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)

415 416
    getCategoryList = CachingMethod(
                            getCategoryList,
417
                            id=('_getPortalGroupedCategoryList', group),
418
                            cache_duration=3600)
419 420 421
    return getCategoryList(group)

  def _getPortalGroupedStateList(self, group):
422
    """
423
    Return a list of workflow states classified to a specific group.
424 425 426 427 428 429 430 431 432 433
    """
    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())

434
    getStateList = CachingMethod(getStateList,
435
                                 id=('_getPortalGroupedStateList', group),
436
                                 cache_duration=3600)
437 438
    return getStateList(group)

439 440
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDefaultSectionCategory')
441 442
  def getPortalDefaultSectionCategory(self):
    """
443
    Return a default section category. This method is deprecated.
444 445 446 447
    """
    LOG('ERP5Site', 0, 'getPortalDefaultSectionCategory is deprecated;'+
        ' use portal_preferences.getPreferredSectionCategory instead.')
    section_category = self.portal_preferences.getPreferredSectionCategory()
448

449 450 451 452
    # XXX This is only for backward-compatibility.
    if not section_category:
      section_category = self._getPortalConfiguration(
                                'portal_default_section_category')
453

454
    return section_category
455

456 457 458 459 460 461
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalResourceTypeList')
  def getPortalResourceTypeList(self):
    """
      Return resource types.
    """
462 463 464
    return self._getPortalGroupedTypeList('resource') or \
           self._getPortalConfiguration('portal_resource_type_list')

465 466 467 468 469 470 471
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSubVariationTypeList')
  def getPortalSubVariationTypeList(self):
    """
      Return resource types.
    """
    return self._getPortalGroupedTypeList('sub_variation')
472

473 474 475 476 477 478 479
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSubVariationBaseCategoryList')
  def getPortalSubVariationBaseCategoryList(self):
    """
      Return variation base categories.
    """
    return self._getPortalGroupedCategoryList('sub_variation')
480

481 482 483 484 485 486
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalVariationTypeList')
  def getPortalVariationTypeList(self):
    """
      Return variation types.
    """
487 488 489
    return self._getPortalGroupedTypeList('variation') or \
           self._getPortalConfiguration('portal_variation_type_list')

490 491 492 493 494 495
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalNodeTypeList')
  def getPortalNodeTypeList(self):
    """
      Return node types.
    """
496 497 498
    return self._getPortalGroupedTypeList('node') or \
           self._getPortalConfiguration('portal_node_type_list')

499 500 501 502 503 504
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPaymentNodeTypeList')
  def getPortalPaymentNodeTypeList(self):
    """
      Return payment node types.
    """
505 506 507
    return self._getPortalGroupedTypeList('payment_node') or \
           self._getPortalConfiguration('portal_payment_node_type_list')

508 509 510 511 512 513
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInvoiceTypeList')
  def getPortalInvoiceTypeList(self):
    """
      Return invoice types.
    """
514 515 516
    return self._getPortalGroupedTypeList('invoice') or \
           self._getPortalConfiguration('portal_invoice_type_list')

517 518 519 520 521 522
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOrderTypeList')
  def getPortalOrderTypeList(self):
    """
      Return order types.
    """
523 524 525
    return self._getPortalGroupedTypeList('order') or \
           self._getPortalConfiguration('portal_order_type_list')

526 527 528 529 530 531
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDeliveryTypeList')
  def getPortalDeliveryTypeList(self):
    """
      Return delivery types.
    """
532 533 534
    return self._getPortalGroupedTypeList('delivery') or \
           self._getPortalConfiguration('portal_delivery_type_list')

535 536 537 538 539 540
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTransformationTypeList')
  def getPortalTransformationTypeList(self):
    """
      Return transformation types.
    """
541 542 543
    return self._getPortalGroupedTypeList('transformation') or \
           self._getPortalConfiguration('portal_transformation_type_list')

544 545 546 547 548 549
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalVariationBaseCategoryList')
  def getPortalVariationBaseCategoryList(self):
    """
      Return variation base categories.
    """
550 551 552
    return self._getPortalGroupedCategoryList('variation') or \
           self._getPortalConfiguration('portal_variation_base_category_list')

553 554 555 556 557 558
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOptionBaseCategoryList')
  def getPortalOptionBaseCategoryList(self):
    """
      Return option base categories.
    """
559 560 561
    return self._getPortalGroupedCategoryList('option') or \
           self._getPortalConfiguration('portal_option_base_category_list')

562 563 564 565 566 567
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalInvoiceMovementTypeList')
  def getPortalInvoiceMovementTypeList(self):
    """
      Return invoice movement types.
    """
568 569 570
    return self._getPortalGroupedTypeList('invoice_movement') or \
           self._getPortalConfiguration('portal_invoice_movement_type_list')

571 572 573 574 575 576
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalOrderMovementTypeList')
  def getPortalOrderMovementTypeList(self):
    """
      Return order movement types.
    """
577 578 579
    return self._getPortalGroupedTypeList('order_movement') or \
           self._getPortalConfiguration('portal_order_movement_type_list')

580 581 582 583 584 585
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDeliveryMovementTypeList')
  def getPortalDeliveryMovementTypeList(self):
    """
      Return delivery movement types.
    """
586 587 588
    return self._getPortalGroupedTypeList('delivery_movement') or \
           self._getPortalConfiguration('portal_delivery_movement_type_list')

589
  security.declareProtected(Permissions.AccessContentsInformation,
590
                            'getPortalSupplyTypeList')
591 592 593 594
  def getPortalSupplyTypeList(self):
    """
      Return supply types.
    """
595 596 597
    return self._getPortalGroupedTypeList('supply') or \
           self._getPortalConfiguration('portal_supply_type_list')

598
  security.declareProtected(Permissions.AccessContentsInformation,
599 600 601 602 603
                              'getPortalDocumentTypeList')
  def getPortalDocumentTypeList(self):
    """
      Return document types.
    """
604
    return self._getPortalGroupedTypeList('document')
605 606 607 608 609 610 611 612 613

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

614
  security.declareProtected(Permissions.AccessContentsInformation,
615
                            'getPortalSupplyPathTypeList')
616 617 618 619
  def getPortalSupplyPathTypeList(self):
    """
      Return supply movement types.
    """
620 621 622
    return self._getPortalGroupedTypeList('supply_path') or \
           self._getPortalConfiguration('portal_supply_path_type_list')

623 624 625 626 627 628 629
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAcquisitionMovementTypeList')
  def getPortalAcquisitionMovementTypeList(self):
    """
      Return acquisition movement types.
    """
    return tuple(list(self.getPortalOrderMovementTypeList()) +
630 631 632
                 list(self.getPortalDeliveryMovementTypeList()) +
                 list(self.getPortalInvoiceMovementTypeList()))

633 634 635 636 637 638 639
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalMovementTypeList')
  def getPortalMovementTypeList(self):
    """
      Return movement types.
    """
    return tuple(list(self.getPortalOrderMovementTypeList()) +
640 641
                 list(self.getPortalDeliveryMovementTypeList()) +
                 list(self.getPortalInvoiceMovementTypeList()) +
642
                 ['Simulation Movement'])
643

644 645 646 647 648 649
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalSimulatedMovementTypeList')
  def getPortalSimulatedMovementTypeList(self):
    """
      Return simulated movement types.
    """
650
    return tuple([x for x in self.getPortalMovementTypeList() \
651
                  if x not in self.getPortalContainerTypeList()])
652

653 654 655 656 657 658
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalContainerTypeList')
  def getPortalContainerTypeList(self):
    """
      Return container types.
    """
659 660 661
    return self._getPortalGroupedTypeList('container') or \
           self._getPortalConfiguration('portal_container_type_list')

662 663 664 665 666 667
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalContainerLineTypeList')
  def getPortalContainerLineTypeList(self):
    """
      Return container line types.
    """
668 669 670
    return self._getPortalGroupedTypeList('container_line') or \
           self._getPortalConfiguration('portal_container_line_type_list')

671 672 673 674 675 676
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalItemTypeList')
  def getPortalItemTypeList(self):
    """
      Return item types.
    """
677 678 679
    return self._getPortalGroupedTypeList('item') or \
           self._getPortalConfiguration('portal_item_type_list')

680 681 682 683 684 685
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDiscountTypeList')
  def getPortalDiscountTypeList(self):
    """
      Return discount types.
    """
686 687 688
    return self._getPortalGroupedTypeList('discount') or \
           self._getPortalConfiguration('portal_discount_type_list')

689 690 691 692 693 694
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalAlarmTypeList')
  def getPortalAlarmTypeList(self):
    """
      Return alarm types.
    """
695 696 697
    return self._getPortalGroupedTypeList('alarm') or \
           self._getPortalConfiguration('portal_alarm_type_list')

698 699 700 701 702 703
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPaymentConditionTypeList')
  def getPortalPaymentConditionTypeList(self):
    """
      Return payment condition types.
    """
704 705 706
    return self._getPortalGroupedTypeList('payment_condition') or \
           self._getPortalConfiguration('portal_payment_condition_type_list')

707 708 709 710 711 712
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalBalanceTransactionLineTypeList')
  def getPortalBalanceTransactionLineTypeList(self):
    """
      Return balance transaction line types.
    """
713
    return self._getPortalGroupedTypeList('balance_transaction_line') or \
714 715
           self._getPortalConfiguration(
                  'portal_balance_transaction_line_type_list')
716

717 718 719 720 721 722
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalCurrentInventoryStateList')
  def getPortalCurrentInventoryStateList(self):
    """
      Return current inventory states.
    """
723 724 725
    return self._getPortalGroupedStateList('current_inventory') or \
           self._getPortalConfiguration('portal_current_inventory_state_list')

726 727 728 729 730 731
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDraftOrderStateList')
  def getPortalDraftOrderStateList(self):
    """
      Return draft order states.
    """
732 733 734
    return self._getPortalGroupedStateList('draft_order') or \
           self._getPortalConfiguration('portal_draft_order_state_list')

735 736 737 738 739 740
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalPlannedOrderStateList')
  def getPortalPlannedOrderStateList(self):
    """
      Return planned order states.
    """
741 742 743
    return self._getPortalGroupedStateList('planned_order') or \
           self._getPortalConfiguration('portal_planned_order_state_list')

744 745 746 747 748 749
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalReservedInventoryStateList')
  def getPortalReservedInventoryStateList(self):
    """
      Return reserved inventory states.
    """
750
    return self._getPortalGroupedStateList('reserved_inventory') or \
751
        self._getPortalConfiguration('portal_reserved_inventory_state_list')
752

753 754 755 756 757 758
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalFutureInventoryStateList')
  def getPortalFutureInventoryStateList(self):
    """
      Return future inventory states.
    """
759 760 761
    return self._getPortalGroupedStateList('future_inventory') or \
           self._getPortalConfiguration('portal_future_inventory_state_list')

762
  security.declareProtected(Permissions.AccessContentsInformation,
763
                          'getPortalUpdatableAmortisationTransactionStateList')
764 765
  def getPortalUpdatableAmortisationTransactionStateList(self):
    """
766
      Return states when Amortisation Transaction can be updated
767
      by amortisation_transaction_builder.
768
    """
769 770
    return self._getPortalConfiguration(
        'portal_updatable_amortisation_transaction_state_list')
771

772 773 774 775 776 777
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalColumnBaseCategoryList')
  def getPortalColumnBaseCategoryList(self):
    """
      Return column base categories.
    """
778 779 780
    return self._getPortalGroupedCategoryList('column') or \
           self._getPortalConfiguration('portal_column_base_category_list')

781 782 783 784 785 786
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalLineBaseCategoryList')
  def getPortalLineBaseCategoryList(self):
    """
      Return line base categories.
    """
787 788 789
    return self._getPortalGroupedCategoryList('line') or \
           self._getPortalConfiguration('portal_line_base_category_list')

790 791 792 793 794 795
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTabBaseCategoryList')
  def getPortalTabBaseCategoryList(self):
    """
      Return tab base categories.
    """
796 797 798
    return self._getPortalGroupedCategoryList('tab') or \
           self._getPortalConfiguration('portal_tab_base_category_list')

799 800 801 802
  def getPortalDefaultGapRoot(self):
    """
      Return the Accounting Plan to use by default (return the root node)
    """
803
    LOG('ERP5Site', 0,
804 805 806
        'getPortalDefaultGapRoot is deprecated; ' \
        'use portal_preferences.getPreferredAccountingTransactionGap instead.')

807 808
    return self.portal_preferences.getPreferredAccountingTransactionGap() or \
           self._getPortalConfiguration('portal_default_gap_root')
809

810 811 812 813
  def getPortalAccountingMovementTypeList(self) :
    """
      Return accounting movement type list.
    """
814
    return self._getPortalGroupedTypeList('accounting_movement') or \
815
        self._getPortalConfiguration('portal_accounting_movement_type_list')
816

817 818 819 820
  def getPortalAccountingTransactionTypeList(self) :
    """
      Return accounting transaction movement type list.
    """
821
    return self._getPortalGroupedTypeList('accounting_transaction') or \
822
      self._getPortalConfiguration('portal_accounting_transaction_type_list')
823

824 825 826 827
  def getPortalAssignmentBaseCategoryList(self):
    """
      Return List of category values to generate security groups.
    """
828
    return self._getPortalGroupedCategoryList('assignment') or \
829
        self._getPortalConfiguration('portal_assignment_base_category_list')
830

831 832
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalTicketTypeList')
833 834 835 836 837
  def getPortalTicketTypeList(self):
    """
    Return ticket types.
    """
    return self._getPortalGroupedTypeList('ticket')
838

839 840
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalEventTypeList')
841 842 843 844 845
  def getPortalEventTypeList(self):
    """
    Return event types.
    """
    return self._getPortalGroupedTypeList('event')
846

847 848 849 850 851 852 853 854
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalDivergenceTesterTypeList')
  def getPortalDivergenceTesterTypeList(self):
    """
    Return divergence tester types.
    """
    return self._getPortalGroupedTypeList('divergence_tester')

855 856 857 858 859 860 861 862
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getPortalCalendarPeriodTypeList')
  def getPortalCalendarPeriodTypeList(self):
    """
    Return calendar period types.
    """
    return self._getPortalGroupedTypeList('calendar_period')

863 864
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDefaultModuleId')
865 866 867 868 869
  def getDefaultModuleId(self, portal_type, default=MARKER):
    """
      Return default module id where a object with portal_type can
      be created.
    """
870
    # first try to find by naming convention
871 872
    module_name = portal_type.lower().replace(' ','_')
    portal_object = self
873 874 875 876 877 878
    if hasattr(portal_object, module_name):
      return module_name
    module_name += '_module'
    if hasattr(portal_object, module_name):
      return module_name
    # then look for module where the type is allowed
879
    module_name=None
880 881
    modlist=[m for m in self.objectIds() if m.endswith('module')]
    for mod in modlist:
882 883
      module=self.restrictedTraverse(mod,None)
      if module is None: # we can't access this one
884 885 886 887
        continue
      if portal_type in self.portal_types[module.getPortalType()].allowed_content_types:
       module_name=mod 
       break
888
    if module_name is not None:
889 890 891 892 893 894 895 896
      return module_name
    if default is not MARKER:
      return default
    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
897 898
    return module_name

899 900
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDefaultModule')
901 902 903 904 905
  def getDefaultModule(self, portal_type):
    """
      Return default module where a object with portal_type can be created
    """
    return getattr(self, self.getDefaultModuleId(portal_type), None)
906

907 908 909 910 911 912 913 914 915
  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'
916 917 918 919
    self.portal_types.constructContent(type_name=portal_type,
                                       container=self,
                                       id=id,
                                       ) # **kw) removed due to CMF bug
920
    new_instance = self[id]
921 922 923 924
    if kw is not None:
      new_instance._edit(force_update=1, **kw)
    if immediate_reindex:
      new_instance.immediateReindexObject()
925 926
    return new_instance

927
  def log(self,description,content=''):
928
    """
929
    Put a log message
930
    """
931 932 933 934 935 936 937 938 939
    if content=='': # allow for content only while keeping interface
        description,content=content,description
    st=traceback.extract_stack()
    head=[]
    for frame in st[-2:-6:-1]: # assume no deep nesting in Script (Python)
        if frame[0]=='Script (Python)': # does anybody log from ZPT or dtml?
            head.append('%s, %d' % (frame[2],frame[1]))
    head=' -> '.join(head)
    description='%s: %s' % (head,description)
940 941
    LOG(description, 0, content)

942

Jean-Paul Smets's avatar
Jean-Paul Smets committed
943 944
Globals.InitializeClass(ERP5Site)

945 946 947 948 949 950 951
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
952 953
class ERP5Generator(PortalGenerator):

954
  klass = ERP5Site
955

956
  def getBootstrapDirectory(self):
957
    return getBootstrapDirectory()
958

959 960 961
  def create(self,
             parent,
             id,
962
             create_userfolder,
963
             erp5_catalog_storage,
964
             erp5_sql_connection_type,
965 966 967 968 969 970 971 972
             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):
973 974
    id = str(id)
    portal = self.klass(id=id)
975 976
    # Make sure reindex will not be called until business templates
    # will be installed
977
    setattr(portal, 'isIndexable', 0)
978 979 980
    parent._setObject(id, portal)
    # Return the fully wrapped object.
    p = parent.this()._getOb(id)
981 982
    p._setProperty('erp5_catalog_storage',
                   erp5_catalog_storage, 'string')
983
    p._setProperty('erp5_sql_connection_type',
984
                   erp5_sql_connection_type, 'string')
985
    p._setProperty('erp5_sql_connection_string',
986
                   erp5_sql_connection_string, 'string')
987
    p._setProperty('erp5_sql_deferred_connection_type',
988
                   erp5_sql_deferred_connection_type, 'string')
989
    p._setProperty('erp5_sql_deferred_connection_string',
990
                   erp5_sql_deferred_connection_string, 'string')
991
    p._setProperty('cmf_activity_sql_connection_type',
992
                   cmf_activity_sql_connection_type, 'string')
993
    p._setProperty('cmf_activity_sql_connection_string',
994 995
                   cmf_activity_sql_connection_string, 'string')
    # XXX hardcoded charset
996
    p._setProperty('management_page_charset', 'UTF-8', 'string')
997 998
    self.setup(p, create_userfolder, create_activities=create_activities,
        reindex=reindex, **kw)
999 1000 1001 1002
    return p

  def setupLastTools(self, p, **kw):
    """
1003 1004 1005
    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
1006 1007
    """
    # Add Activity Tool
1008
    if kw.has_key('create_activities') and int(kw['create_activities'])==1:
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
      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)
1020

1021 1022
  def setupTemplateTool(self, p, **kw):
    """
1023
    Setup the Template Tool. Security must be set strictly.
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
    """
    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):
    """
1034
    Set up initial tools.
1035 1036 1037 1038
    """
    if not 'portal_actions' in p.objectIds():
      PortalGenerator.setupTools(self, p)

1039
    # It is better to remove portal_catalog
1040
    # which is ZCatalog as soon as possible,
1041
    # because the API is not the completely same as ERP5Catalog,
1042
    # and ZCatalog is useless for ERP5 after all.
1043 1044
    update = kw.get('update', 0)
    portal_catalog = getToolByName(p, 'portal_catalog', None)
1045 1046 1047
    if portal_catalog is not None and \
       portal_catalog.meta_type != 'ZSQLCatalog' and \
       not update:
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
      p._delObject('portal_catalog')

    # Add CMF Report Tool
    if not p.hasObject('portal_report'):
      addTool = p.manage_addProduct['CMFReportTool'].manage_addTool
      addTool('CMF Report Tool', None)

    # 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)
1077 1078
    if not p.hasObject('portal_tests'):
      addTool('ERP5 Test Tool', None)
1079 1080 1081
    
    # Add ERP5Type Tool
    addTool = p.manage_addProduct['ERP5Type'].manage_addTool
1082 1083
    if not p.hasObject('portal_caches'):
      addTool('ERP5 Cache Tool', None)
1084 1085
    if not p.hasObject('portal_memcached'):
      addTool('ERP5 Memcached Tool', None)
1086

1087 1088 1089 1090 1091 1092
    try:
      addTool = p.manage_addProduct['ERP5Subversion'].manage_addTool
      if not p.hasObject('portal_subversion'):
        addTool('ERP5 Subversion Tool', None)
    except AttributeError:
      pass
1093

1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
    # 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)
    # Add Default SQL connection
    if p.erp5_sql_connection_type == 'Z MySQL Database Connection':
      if not p.hasObject('erp5_sql_connection'):
1109 1110
        addSQLConnection = p.manage_addProduct['ZMySQLDA'].\
                                     manage_addZMySQLConnection
1111 1112
        addSQLConnection('erp5_sql_connection',
                         'ERP5 SQL Server Connection',
1113
                         p.erp5_sql_connection_string)
1114 1115
    elif p.erp5_sql_connection_type == 'Z Gadfly':
      pass
1116 1117

    # Add Deferred SQL Connections
1118 1119
    if p.erp5_sql_deferred_connection_type == \
        'Z MySQL Deferred Database Connection':
1120
      if not p.hasObject('erp5_sql_deferred_connection'):
1121 1122
        addSQLConnection = p.manage_addProduct['ZMySQLDDA'].\
            manage_addZMySQLDeferredConnection
1123 1124
        addSQLConnection('erp5_sql_deferred_connection',
                         'ERP5 SQL Server Deferred Connection',
1125
                         p.erp5_sql_deferred_connection_string)
1126 1127 1128 1129
    elif p.erp5_sql_deferred_connection_type == 'Z Gadfly':
      pass

    # Add Activity SQL Connections
1130 1131
    if p.cmf_activity_sql_connection_type == 'Z MySQL Database Connection':
      if not p.hasObject('cmf_activity_sql_connection'):
1132 1133
        addSQLConnection = p.manage_addProduct['ZMySQLDA'].\
                                     manage_addZMySQLConnection
1134 1135
        addSQLConnection('cmf_activity_sql_connection',
                         'CMF Activity SQL Server Connection',
1136
                         p.cmf_activity_sql_connection_string)
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
      # 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
      # minux prepended to the conneciton string.
      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
1148
                         '-%s' % p.cmf_activity_sql_connection_string)
1149 1150
    elif p.cmf_activity_sql_connection_type == 'Z Gadfly':
      pass
1151

1152 1153 1154 1155 1156 1157 1158
    # 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)

1159 1160 1161 1162 1163 1164 1165
    try:
      # Add ERP5SyncML Tools
      addTool = p.manage_addProduct['ERP5SyncML'].manage_addTool
      if not p.hasObject('portal_synchronizations'):
        addTool('ERP5 Synchronizations', None)
    except AttributeError:
      pass
1166 1167 1168 1169 1170 1171

    # Add Message Catalog
    if not 'Localizer' in p.objectIds():
      addLocalizer = p.manage_addProduct['Localizer'].manage_addLocalizer
      addLocalizer('', ('en',))
    localizer = getToolByName(p, 'Localizer')
1172 1173
    addMessageCatalog = localizer.manage_addProduct['Localizer']\
                                      .manage_addMessageCatalog
1174 1175 1176
    if 'erp5_ui' not in localizer.objectIds():
      if 'default' in localizer.objectIds():
        localizer.manage_delObjects('default')
1177 1178 1179
      addMessageCatalog('default', 'ERP5 Localized Messages', ('en',))
      addMessageCatalog('erp5_ui', 'ERP5 Localized Interface', ('en',))
      addMessageCatalog('erp5_content', 'ERP5 Localized Content', ('en',))
1180 1181 1182 1183


  def setupMembersFolder(self, p):
    """
1184
    ERP5 is not a CMS
1185 1186 1187 1188 1189
    """
    pass

  def setupDefaultSkins(self, p):
    from Products.CMFCore.DirectoryView import addDirectoryViews
1190
    from Products.CMFDefault  import cmfdefault_globals
1191
    from Products.CMFActivity import cmfactivity_globals
Jérome Perrin's avatar
Jérome Perrin committed
1192 1193 1194 1195 1196
    try:
      from Products.FCKeditor   import fckeditor_globals
      have_fckeditor = 1
    except:
      have_fckeditor = 0
1197 1198 1199
    ps = getToolByName(p, 'portal_skins')
    addDirectoryViews(ps, 'skins', cmfdefault_globals)
    addDirectoryViews(ps, 'skins', cmfactivity_globals)
Jérome Perrin's avatar
Jérome Perrin committed
1200 1201
    if have_fckeditor:
      addDirectoryViews(ps, 'skins', fckeditor_globals)
1202 1203
    ps.manage_addProduct['OFSP'].manage_addFolder(id='external_method')
    ps.manage_addProduct['OFSP'].manage_addFolder(id='custom')
1204
    # Set the 'custom' layer a high priority, so it remains the first
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
    #   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
1218 1219
    if have_fckeditor:
      skin_folder_list.insert(1, 'fckeditor')
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
    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
                       )
1233 1234 1235 1236
    p.setupCurrentSkin()

  def setupWorkflow(self, p):
    """
1237
    Set up workflows for business templates
1238 1239 1240
    """
    tool = getToolByName(p, 'portal_workflow', None)
    if tool is None:
Jérome Perrin's avatar
Jérome Perrin committed
1241
      return
1242
    for wf_id in ('business_template_building_workflow',
1243
                  'business_template_installation_workflow'):
1244 1245 1246
      if wf_id in tool.objectIds():
        tool.manage_delObjects([wf_id])
    bootstrap_dir = self.getBootstrapDirectory()
1247 1248 1249
    business_template_building_workflow = os.path.join(
                                 bootstrap_dir,
                                 'business_template_building_workflow.xml')
1250
    tool._importObjectFromFile(business_template_building_workflow)
1251 1252 1253
    business_template_installation_workflow = os.path.join(
                                 bootstrap_dir,
                                 'business_template_installation_workflow.xml')
1254 1255
    tool._importObjectFromFile(business_template_installation_workflow)
    tool.setChainForPortalTypes( ( 'Business Template', ),
1256 1257
                                 ( 'business_template_building_workflow',
                                   'business_template_installation_workflow' ) )
1258 1259 1260

  def setupIndex(self, p, **kw):
    # Make sure all tools and folders have been indexed
1261
    if not kw.get('reindex', 1):
1262 1263 1264 1265
      return
    skins_tool = getToolByName(p, 'portal_skins', None)
    if skins_tool is None:
      return
1266
    # When no SQL connection was define on the site,
1267 1268 1269 1270 1271 1272
    # 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
      portal_catalog.manage_catalogClear()
      skins_tool["erp5_core"].ERP5Site_reindexAll()
1273

1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
  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()
1289
      pas_dispatcher = p.acl_users.manage_addProduct['PluggableAuthService']
1290
      # Add legacy ZODB support
1291 1292 1293
      pas_dispatcher.addZODBUserManager('zodb_users')
      pas_dispatcher.addZODBGroupManager('zodb_groups')
      pas_dispatcher.addZODBRoleManager('zodb_roles')
1294
      # Add CMF Portal Roles
1295
      #XXX Maybe it will be no longer required once PAS is the standard
1296 1297 1298
      p.acl_users.zodb_roles.addRole('Member')
      p.acl_users.zodb_roles.addRole('Reviewer')
      # Register ZODB Interface
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
      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'))
1310
      # Add ERP5UserManager
1311 1312 1313 1314 1315
      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')
1316
      # Register ERP5UserManager Interface
1317 1318 1319
      p.acl_users.erp5_users.manage_activateInterfaces(
                                        ('IAuthenticationPlugin',
                                        'IUserEnumerationPlugin',))
1320 1321
      p.acl_users.erp5_groups.manage_activateInterfaces(('IGroupsPlugin',))
      p.acl_users.erp5_roles.manage_activateInterfaces(('IRolesPlugin',))
1322 1323
      p.acl_users.erp5_user_factory.manage_activateInterfaces(
                                        ('IUserFactoryPlugin',))
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
    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'),
1338
      'Change local roles'           : ('Manager', ),
1339 1340 1341 1342 1343 1344
      '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'),
1345
      'List undoable changes'        : ('Manager', ),
1346 1347 1348 1349 1350
      'Manage properties'            : ('Manager', 'Owner'),
      'Modify portal content'        : ('Manager', 'Owner'),
      'Reply to item'                : ('Manager', 'Member'),
      'Review portal content'        : ('Manager', 'Reviewer'),
      'Search ZCatalog'              : ('Manager', 'Member'),
1351
      'Set own password'             : ('Manager', ),
1352 1353
      'Set own properties'           : ('Manager', 'Member'),
      'Undo changes'                 : ('Manager', 'Owner'),
1354
      'View'                         : ('Manager', 'Member',
1355
                                        'Owner', 'Anonymous'),
1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
      '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)

1367 1368 1369
    if getattr(p, 'setDefaultSorting', None) is not None:
      p.setDefaultSorting('id', 0)

1370 1371 1372 1373 1374
    self.setupTools(p, **kw)

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

Jérome Perrin's avatar
Jérome Perrin committed
1375 1376
    if create_userfolder and not p.hasObject('acl_users'):
      self.setupUserFolder(p)
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403

    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)

1404 1405 1406
    # Make sure the cache is initialized
    p.portal_caches.updateCache()

1407 1408
    self.setupLastTools(p, **kw)

1409 1410 1411 1412 1413 1414 1415
    # 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):
    """
1416
    Install the portal_type of Business Template
1417 1418 1419 1420 1421 1422 1423 1424 1425
    """
    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)

1426
  def setupERP5Core(self,p,**kw):
1427
    """
1428
    Install the core part of ERP5
1429 1430 1431 1432 1433 1434
    """
    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()
1435 1436 1437 1438 1439
      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:
1440 1441 1442 1443 1444 1445 1446
        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)