WebSection_getDocumentValue.py 3.58 KB
"""
 This script is part of ERP5 Web

 ERP5 Web is a business template of ERP5 which provides a way
 to create web sites which can display selected
 ERP5 contents through multiple custom web layouts.

 The default implementation searches for
 documents which are in the user language if any
 and which reference is equal to the name parameter.

 Other implementations are possible: ex. display the last
 version in the closest language rather than
 the latest version in the user language.

 NOTE:
 - the portal parameter was introduced to
   fix acquisition issues within the _aq_dynamic
   lookup from WebSection class.
"""
from Products.ZSQLCatalog.SQLCatalog import SimpleQuery, ComplexQuery
if portal is None: portal = context.getPortalObject()
portal_catalog = portal.portal_catalog
# The list of portal types here should be large enough to include
# all portal_types defined in the various sections so that
# href tags which point to a document by reference can still work.
valid_portal_type_list = portal.getPortalDocumentTypeList()

# Find the applicable language
if language is None:
  language = portal.Localizer.get_selected_language()

validation_state = None
effective_date = None

if validation_state is None:
  validation_state = ('published', 'published_alive', 'public', 'validated')

if effective_date is None:
  if now is None:
    now = DateTime()
  effective_date = ComplexQuery(
    SimpleQuery(effective_date=None),
    SimpleQuery(effective_date=now, comparison_operator='<='),
    logical_operator='or',
  )

# Note: In sorts, NULL is considered lesser than non-NULL. So in descending
# sort, NULLs will be listed after non-NULLs, which is perfect for
# effective_date, which defines the date at which content becomes effective.
# None (NULL) effective date hence means "effective since infinite in te past".
base_sort = (('effective_date', 'descending'), )

# Search the catalog for all documents matching the reference
# this will only return documents which are accessible by the user
web_page_list = portal_catalog(reference=name,
                               effective_date=effective_date,
                               portal_type=valid_portal_type_list,
                               validation_state=validation_state,
                               language=(language, ''),
                               sort_on=(('language', 'descending'), ) + base_sort,
                               limit=1,
                               **kw)

if len(web_page_list) == 0 and language != 'en':
  # Search again with English as a fallback.
  web_page_list = portal_catalog(reference=name,
                                 effective_date=effective_date,
                                 portal_type=valid_portal_type_list,
                                 validation_state=validation_state,
                                 language='en',
                                 sort_on=base_sort,
                                 limit=1,
                                 **kw)

if len(web_page_list) == 0:
  # Search again without the language
  web_page_list = portal_catalog(reference=name,
                                 effective_date=effective_date,
                                 portal_type=valid_portal_type_list,
                                 validation_state=validation_state,
                                 sort_on=base_sort,
                                 limit=1,
                                 **kw)

if len(web_page_list) == 0:
  # Default returns None
  web_page = None
else:
  # Try to get the first page on the list
  web_page = web_page_list[0]
  web_page = web_page.getObject()

# return the web page
return web_page