PreferenceTool.py 11.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
##############################################################################
#
# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
#                    Jerome Perrin <jerome@nexedi.com>
#
# 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
#
# 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.
#
##############################################################################

29
from AccessControl import ClassSecurityInfo, getSecurityManager
30
from MethodObject import Method
31
from Globals import InitializeClass, DTMLFile
32
from zLOG import LOG, PROBLEM
33 34 35

from Products.CMFCore.utils import getToolByName
from Products.ERP5Type.Tool.BaseTool import BaseTool
36
from Products.ERP5Type import Permissions, PropertySheet
37 38
from Products.ERP5Type.Cache import CachingMethod
from Products.ERP5Type.Utils import convertToUpperCase
39
from Products.ERP5Type.Accessor.TypeDefinition import list_types
40
from Products.ERP5Form import _dtmldir
41
from Products.ERP5Form.Document.Preference import Priority
42

43
_marker = []
44

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
def updatePreferenceClassPropertySheetList():
  # The Preference class should be imported from the common location
  # in ERP5Type since it could be overloaded in another product
  from Products.ERP5Type.Document.Preference import Preference
  # 'Static' property sheets defined on the class
  class_property_sheet_list = Preference.property_sheets
  # Time to lookup for preferences defined on other modules
  property_sheets = list(class_property_sheet_list)
  for id in dir(PropertySheet):
    if id.endswith('Preference'):
      ps = getattr(PropertySheet, id)
      if ps not in property_sheets:
        property_sheets.append(ps)
  class_property_sheet_list = tuple(property_sheets)
  Preference.property_sheets = class_property_sheet_list

61

62
def createPreferenceToolAccessorList(portal) :
63 64 65 66 67 68 69
  """
    Initialize all Preference methods on the preference tool.
    This method must be called on startup.

    This tool is capable of updating the list of Preference
    property sheets by looking at all registered property sheets
    and considering those which name ends with 'Preference'
70 71
  """
  attr_list = []
72 73
  typestool = getToolByName(portal, 'portal_types')
  pref_portal_type = typestool.getTypeInfo('Preference')
74 75 76

  # 'Dynamic' property sheets added through ZMI
  zmi_property_sheet_list = []
77
  if pref_portal_type is None:
78
    LOG('ERP5Form.PreferenceTool', PROBLEM,
79
           'Preference type information is not installed.')
80 81 82 83 84 85 86 87
  else:
    for property_sheet in pref_portal_type.property_sheet_list :
      try:
        zmi_property_sheet_list.append(
                    getattr(__import__(property_sheet), property_sheet))
      except ImportError, e :
        LOG('ERP5Form.PreferenceTool', PROBLEM,
             'unable to import Property Sheet %s' % property_sheet, e)
88

89
  # 'Static' property sheets defined on the class
90 91 92
  # The Preference class should be imported from the common location
  # in ERP5Type since it could be overloaded in another product
  from Products.ERP5Type.Document.Preference import Preference
93
  class_property_sheet_list = Preference.property_sheets
94
  # We can now merge
95 96
  for property_sheet in ( tuple(zmi_property_sheet_list) +
                                class_property_sheet_list ) :
97
    # then generate common method names
98 99 100 101 102 103 104 105 106 107 108
    for prop in property_sheet._properties :
      if not prop.get('preference', 0) :
        # only properties marked as preference are used
        continue
      attribute = prop['id']
      attr_list = [ 'get%s' % convertToUpperCase(attribute)]
      if prop['type'] in list_types :
        attr_list +=  ['get%sList' % convertToUpperCase(attribute), ]
      for attribute_name in attr_list:
        method = PreferenceMethod(attribute_name)
        setattr(PreferenceTool, attribute_name, method)
109 110 111 112


class func_code: pass

113
class PreferenceMethod(Method):
114 115 116 117 118 119 120
  """ A method object that lookup the attribute on preferences. """
  # This is required to call the method form the Web
  func_code = func_code()
  func_code.co_varnames = ('self', )
  func_code.co_argcount = 1
  func_defaults = ()

121
  def __init__(self, attribute):
122
    self._preference_name = attribute
123 124
    self._preference_cache_id = 'PreferenceTool.CachingMethod.%s' % attribute
    self._null = (None, '', (), [])
125

126
  def __call__(self, instance, *args, **kw):
127
    def _getPreference(*args, **kw):
128
      value = None
Aurel's avatar
Aurel committed
129
      for pref in instance._getSortedPreferenceList(*args, **kw):
130
        value = getattr(pref, self._preference_name, _marker)
131 132
        # XXX-JPS Why don't we use accessors here such as:
        # value = pref.getProperty(self._preference_name, _marker)
133
        if value is not _marker:
134 135
          # If callable, store the return value.
          if callable(value):
Aurel's avatar
Aurel committed
136
            value = value(*args, **kw)
137 138 139 140
          if value not in self._null:
            break
      return value
    _getPreference = CachingMethod(_getPreference,
141 142
            id='%s.%s' % (self._preference_cache_id,
                          getSecurityManager().getUser().getId()),
143
            cache_factory='erp5_ui_short')
144
    value = _getPreference(*args, **kw)
145 146 147 148
    # XXX Preference Tool has a strange assumption that, even if
    # all values are null values, one of them must be returned.
    # Therefore, return a default value, only if explicitly specified,
    # instead of returning None.
149 150 151 152 153 154 155
    default = _marker
    if 'default' in kw:
      default = kw['default']
    elif args:
      default = args[0]
    if value in self._null and default is not _marker:
      return default
156
    return value
Aurel's avatar
Aurel committed
157

158
class PreferenceTool(BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
159 160 161 162 163 164
  """
    PreferenceTool manages User Preferences / User profiles.

    TODO:
      - make the preference tool an action provider (templates)
  """
165 166 167
  id            = 'portal_preferences'
  meta_type     = 'ERP5 Preference Tool'
  portal_type   = 'Preference Tool'
Jérome Perrin's avatar
Jérome Perrin committed
168
  title         = 'Preferences'
169 170 171 172 173 174
  allowed_types = ( 'ERP5 Preference',)
  security      = ClassSecurityInfo()

  security.declareProtected(
       Permissions.ManagePortal, 'manage_overview' )
  manage_overview = DTMLFile( 'explainPreferenceTool', _dtmldir )
175

176 177 178 179 180 181 182
  security.declarePrivate('manage_afterAdd')
  def manage_afterAdd(self, item, container) :
    """ init the permissions right after creation """
    item.manage_permission(Permissions.AddPortalContent,
          ['Member', 'Author', 'Manager'])
    item.manage_permission(Permissions.View,
          ['Member', 'Auditor', 'Manager'])
Aurel's avatar
Aurel committed
183 184
    item.manage_permission(Permissions.SetOwnPassword,
          ['Member', 'Author', 'Manager'])
185
    BaseTool.inheritedAttribute('manage_afterAdd')(self, item, container)
186

187
  security.declarePublic('getPreference')
188
  def getPreference(self, pref_name, default=_marker) :
189
    """ get the preference on the most appopriate Preference object. """
190
    method = getattr(self, 'get%s' % convertToUpperCase(pref_name), None)
191
    if method is not None:
192 193 194 195 196
      if default is not _marker:
        kw = {'default': default}
      else:
        kw = {}
      return method(**kw)
197
    return default
198

199 200 201 202
  security.declareProtected(Permissions.ModifyPortalContent, "setPreference")
  def setPreference(self, pref_name, value) :
    """ set the preference on the active Preference object"""
    self.getActivePreference()._edit(**{pref_name:value})
203 204

  security.declarePrivate('_getSortedPreferenceList')
205
  def _getSortedPreferenceList(self, *args, **kw) :
206
    """ return the most appropriate preferences objects,
207 208
        sorted so that the first in the list should be applied first
    """
209
    prefs = []
210 211 212
    # XXX will also cause problems with Manager (too long)
    # XXX For manager, create a manager specific preference
    #                  or better solution
213 214
    user = getToolByName(self, 'portal_membership').getAuthenticatedMember()
    user_is_manager = 'Manager' in user.getRolesInContext(self)
215
    for pref in self.searchFolder(portal_type='Preference', **kw) :
216
      pref = pref.getObject()
217
      if pref is not None and pref.getProperty('preference_state',
218
                                'broken') in ('enabled', 'global'):
219 220 221 222 223 224 225
        # XXX quick workaround so that manager only see user preference
        # they actually own.
        if user_is_manager and pref.getPriority() == Priority.USER :
          if user.allowed(pref, ('Owner',)):
            prefs.append(pref)
        else :
          prefs.append(pref)
226 227
    prefs.sort(lambda b, a: cmp(a.getPriority(), b.getPriority()))
    return prefs
Aurel's avatar
Aurel committed
228

229 230
  security.declareProtected(Permissions.View, 'getActivePreference')
  def getActivePreference(self) :
Aurel's avatar
Aurel committed
231
    """ returns the current preference for the user.
232
       Note that this preference may be read only. """
233
    enabled_prefs = self._getSortedPreferenceList()
234 235 236
    if len(enabled_prefs) > 0 :
      return enabled_prefs[0]

237
  security.declareProtected(Permissions.View, 'getDocumentTemplateList')
238
  def getDocumentTemplateList(self, folder=None) :
239
    """ returns all document templates that are in acceptable Preferences
240 241
        based on different criteria such as folder, portal_type, etc.
    """
242 243
    if folder is None:
      # as the preference tool is also a Folder, this method is called by
Aurel's avatar
Aurel committed
244
      # page templates to get the list of document templates for self.
245 246
      folder = self

247
    # We must set the user_id as a parameter to make sure each
Jérome Perrin's avatar
Jérome Perrin committed
248
    # user can get a different cache
Jean-Paul Smets's avatar
Jean-Paul Smets committed
249
    def _getDocumentTemplateList(user_id, portal_type=None):
250 251
      acceptable_templates = []
      for pref in self._getSortedPreferenceList() :
Jérome Perrin's avatar
Jérome Perrin committed
252
        for doc in pref.contentValues() :
253 254 255 256 257
          if doc.getPortalType() == portal_type:
            acceptable_templates.append(doc.getRelativeUrl())
      return acceptable_templates
    _getDocumentTemplateList = CachingMethod(_getDocumentTemplateList,
                          'portal_preferences.getDocumentTemplateList',
Aurel's avatar
Aurel committed
258
                                             cache_factory='erp5_ui_medium')
259 260 261 262 263 264

    allowed_content_types = map(lambda pti: pti.id,
                                folder.allowedContentTypes())
    user_id = getToolByName(self, 'portal_membership').getAuthenticatedMember().getId()
    template_list = []
    for portal_type in allowed_content_types:
Jérome Perrin's avatar
Jérome Perrin committed
265
      for template_url in _getDocumentTemplateList(user_id, portal_type=portal_type):
266 267
        template_list.append(self.restrictedTraverse(template_url))
    return template_list
268 269 270

InitializeClass(PreferenceTool)