WebSection.py 13.6 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3 4
# Copyright (c) 2002-2008 Nexedi SA and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
13 14 15 16 17 18 19 20 21 22 23 24 25 26
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
27 28 29 30
##############################################################################

from AccessControl import ClassSecurityInfo
from Products.CMFCore.utils import getToolByName
31
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Cache
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32
from Products.ERP5.Document.Domain import Domain
33
from Products.ERP5.Document.Document import PermanentURLMixIn
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34 35
from Acquisition import ImplicitAcquisitionWrapper, aq_base, aq_inner
from Products.ERP5Type.Base import TempBase
36
from Products.ERP5Type.UnrestrictedMethod import unrestricted_apply
37
from AccessControl import Unauthorized
38
from zLOG import LOG, WARNING
39
import sys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40

41
from Products.ERP5Type.Cache import getReadOnlyTransactionCache
42

43 44
# Global keys used for URL generation
WEBSECTION_KEY = 'web_section_value'
45
MARKER = []
46

47
class WebSection(Domain, PermanentURLMixIn):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
48 49
    """
      A Web Section is a Domain with an extended API intended to
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
      support the creation of Web front ends to
      server ERP5 contents through a pretty and configurable
      user interface.

      WebSection uses the following scripts for customisation:

      - WebSection_getBreadcrumbItemList

      - WebSection_getDocumentValueList

      - WebSection_getPermanentURL

      - WebSection_getDocumentValue

      - WebSection_getDefaultDocumentValue

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
66
      - WebSection_getWebSectionValue
67 68 69 70 71 72 73 74 75
      - WebSection_getWebSiteValue

      It defines the following REQUEST global variables:

      - current_web_section

      - current_web_document

      - is_web_section_default_document
Jean-Paul Smets's avatar
Jean-Paul Smets committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
    """
    # CMF Type Definition
    meta_type = 'ERP5 Web Section'
    portal_type = 'Web Section'
    isPortalContent = 1
    isRADContent = 1

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

    # Default Properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
92
                      , PropertySheet.WebSection
Jean-Paul Smets's avatar
Jean-Paul Smets committed
93
                      , PropertySheet.SortIndex
94
                      , PropertySheet.Predicate
Jean-Paul Smets's avatar
Jean-Paul Smets committed
95 96
                      )

97
    web_section_key = WEBSECTION_KEY
Jean-Paul Smets's avatar
Jean-Paul Smets committed
98

99 100
    security.declareProtected(Permissions.View, '__bobo_traverse__')
    def __bobo_traverse__(self, request, name):
101
      """
102 103
        If no subobject is found through Folder API
        then try to lookup the object by invoking getDocumentValue
104 105
      """
      # Register current web site physical path for later URL generation
106
      if request.get(self.web_section_key, MARKER) is MARKER:
107
        request[self.web_section_key] = self.getPhysicalPath()
108 109 110 111
        # Normalize web parameter in the request
        # Fix common user mistake and transform '1' string to boolean
        for web_param in ['ignore_layout', 'editable_mode']:
          if hasattr(request, web_param):
112 113 114 115
            param = getattr(request, web_param, None)
            if isinstance(param, (list, tuple)):
              param = param[0]
            if param in ('1', 1, True):
116 117 118
              request.set(web_param, True)
            else:
              request.set(web_param, False)
119

120
      return PermanentURLMixIn.__bobo_traverse__(self, request, name)
121

122
    security.declareProtected(Permissions.AccessContentsInformation, 'getLayoutProperty')
123
    def getLayoutProperty(self, key, default=None):
124
      """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
125 126
        A simple method to get a property of the current by
        acquiring it from the current section or its parents.
127 128 129
      """
      section = aq_inner(self)
      while section.getPortalType() in ('Web Section', 'Web Site'):
130
        result = section.getProperty(key, MARKER)
131
        if result not in (MARKER, None):
132 133
          return result
        section = section.aq_parent
134
      return default
135

136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
    security.declareProtected(Permissions.AccessContentsInformation, 'getWebSectionValue')
    def getWebSectionValue(self):
      """
        Returns the current web section (ie. self) though containment acquisition.

        To understand the misteries of acquisition and how the rule
        containment vs. acquisition works, please look at
        XXXX (Zope web site)
      """
      return self

    # Default view display
    security.declareProtected(Permissions.View, '__call__')
    def __call__(self):
      """
        If a Web Section has a default document, we render
        the default document instead of rendering the Web Section
        itself.

        The implementation is based on the presence of specific
        variables in the REQUEST (besides editable_mode and
        ignore_layout).

        current_web_section -- defines the Web Section which is
        used to display the current document.

        current_web_document -- defines the Document (ex. Web Page)
        which is being displayed within current_web_section.

        is_web_section_default_document -- a boolean which is
        set each time we display a default document as a section.

        We use REQUEST parameters so that they are reset for every
        Web transaction and can be accessed from widgets. 
      """
171 172 173
      # Register current web site physical path for later URL generation
      if self.REQUEST.get(self.web_section_key, MARKER) is MARKER:
        self.REQUEST[self.web_section_key] = self.getPhysicalPath()
174 175
      self.REQUEST.set('current_web_section', self)
      if not self.REQUEST.get('editable_mode') and not self.REQUEST.get('ignore_layout'):
176
        document = None
177 178 179 180 181 182 183 184 185
        if self.isDefaultPageDisplayed():
          # The following could be moved to a typed based method for more flexibility
          document = self.getDefaultDocumentValue()
          if document is None:
            # no document found for current user, still such document may exists
            # in some cases user (like Anonymous) can not view document according to portal catalog
            # but we may ask him to login if such a document exists
            isAuthorizationForced = getattr(self, 'isAuthorizationForced', None)
            if isAuthorizationForced is not None and isAuthorizationForced():
186
              if unrestricted_apply(self.getDefaultDocumentValue) is not None:
187 188
                # force user to login as specified in Web Section
                raise Unauthorized
189 190 191
          if document is not None and document.getReference() is not None:
            # we use web_site_module/site_id/section_id/page_reference
            # as the url of the default document.
192
            self.REQUEST.set('current_web_document', document)
193
            self.REQUEST.set('is_web_section_default_document', 1)
194
            document = aq_base(document.asContext(
195
                id=document.getReference(),
196 197
                original_container=document.getParentValue(),
                original_id=document.getId(),
198
                original_path=document.getPath(),
199 200 201 202 203 204 205 206 207
                editable_absolute_url=document.absolute_url())).__of__(self)
        # Try to use a custom renderer if any
        custom_render_method_id = self.getCustomRenderMethodId()
        if custom_render_method_id is not None:
          if document is None:
            document = self
          return getattr(document, custom_render_method_id)()
        elif document is not None:
          return document()
208 209 210 211 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
      return Domain.__call__(self)

    # Layout Selection API
    security.declareProtected(Permissions.AccessContentsInformation, 'getApplicableLayout')
    def getApplicableLayout(self):
      """
        The applicable layout on a section is the container layout.
      """
      return self.getContainerLayout()

    # WebSection API
    security.declareProtected(Permissions.View, 'getDefaultDocumentValue')
    def getDefaultDocumentValue(self):
      """
        Return the default document of the current
        section.

        This method must be implemented through a
        portal type dependent script:
          WebSection_getDefaultDocumentValue
      """
      cache = getReadOnlyTransactionCache(self)
      if cache is not None:
        key = ('getDefaultDocumentValue', self)
        try:
          return cache[key]
        except KeyError:
          pass

      result = self._getTypeBasedMethod('getDefaultDocumentValue',
                     fallback_script_id='WebSection_getDefaultDocumentValue')()

      if cache is not None:
        cache[key] = result

243 244 245
      if result is not None:
        result = result.__of__(self)

246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
      return result

    security.declareProtected(Permissions.View, 'getDocumentValueList')
    def getDocumentValueList(self, **kw):
      """
        Return the list of documents which belong to the
        current section. The API is designed to
        support additional parameters so that it is possible
        to group documents by reference, version, language, etc.
        or to implement filtering of documents.

        This method must be implemented through a
        portal type dependent script:
          WebSection_getDocumentValueList
      """
      cache = getReadOnlyTransactionCache(self)
      if cache is not None:
        key = ('getDocumentValueList', self) + tuple(kw.items())
        try:
          return cache[key]
        except KeyError:
          pass

      result = self._getTypeBasedMethod('getDocumentValueList',
                     fallback_script_id='WebSection_getDocumentValueList')(**kw)

      if cache is not None:
        cache[key] = result

275
      if result is not None and not kw.get('src__', 0):
276 277
        result = [doc.__of__(self) for doc in result]

278 279 280 281 282 283 284 285 286 287 288 289 290 291
      return result

    security.declareProtected(Permissions.View, 'getPermanentURL')
    def getPermanentURL(self, document):
      """
        Return a permanent URL of document in the context
        of the current section.

        This method must be implemented through a
        portal type dependent script:
          WebSection_getPermanentURL
      """
      cache = getReadOnlyTransactionCache(self)
      if cache is not None:
292
        key = ('getPermanentURL', self, document.getPath())
293 294 295 296 297 298 299 300 301 302 303 304 305 306
        try:
          return cache[key]
        except KeyError:
          pass

      result = self._getTypeBasedMethod('getPermanentURL',
                     fallback_script_id='WebSection_getPermanentURL')(document)

      if cache is not None:
        cache[key] = result

      return result

    security.declareProtected(Permissions.View, 'getBreadcrumbItemList')
307
    def getBreadcrumbItemList(self, document=None):
308 309 310 311 312 313 314 315
      """
        Return a section dependent breadcrumb in the form
        of a list of (title, document) tuples.

        This method must be implemented through a
        portal type dependent script:
          WebSection_getBreadcrumbItemList
      """
316 317
      if document is None:
        document = self
318 319
      cache = getReadOnlyTransactionCache(self)
      if cache is not None:
320
        key = ('getBreadcrumbItemList', self, document.getPath())
321 322 323 324 325 326 327 328 329 330 331 332
        try:
          return cache[key]
        except KeyError:
          pass

      result = self._getTypeBasedMethod('getBreadcrumbItemList',
                     fallback_script_id='WebSection_getBreadcrumbItemList')(document)

      if cache is not None:
        cache[key] = result

      return result
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377

    security.declareProtected(Permissions.View, 'getSiteMapTree')
    def getSiteMapTree(self, **kw):
      """
        Return a site map tree section dependent breadcrumb in the
        form of a list of dicts whose structure is provided as a tree
        so that it is easy to implement recursive call with TAL/METAL:

        [
          {
            'url'      : '/erp5/web_site_module/site/section',
            'level'    : 1,
            'translated_title' : 'Section Title',
            'subsection' : [
              {
                'url'      : '/erp5/web_site_module/site/section/reference',
                'level'    : 2,
                'translated_title' : 'Sub Section Title',
                'subsection' : None,
              },
              ...
            ],
          }
          ...
        ]

        This method must be implemented through a
        portal type dependent script:
          WebSection_getSiteMapTree
      """
      cache = getReadOnlyTransactionCache(self)
      if cache is not None:
        key = ('getSiteMapTree', self) + tuple(kw.items())
        try:
          return cache[key]
        except KeyError:
          pass

      result = self._getTypeBasedMethod('getSiteMapTree',
                     fallback_script_id='WebSection_getSiteMapTree')(**kw)

      if cache is not None:
        cache[key] = result

      return result