PreferenceTool.py 8.94 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, INFO, PROBLEM
33 34 35 36 37 38

from Products.CMFCore.utils import getToolByName
from Products.ERP5Type.Tool.BaseTool import BaseTool
from Products.ERP5Type import Permissions
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.Document.Preference import Preference
41
from Products.ERP5Form import _dtmldir
42
from Products.ERP5Form.Document.Preference import Priority
43

44 45 46 47 48 49 50 51

class func_code: pass

def createPreferenceMethods(portal) :
  """Initialize all Preference methods on the preference tool.
  This method must be called on startup.
  """
  attr_list = []
52 53 54 55 56
  typestool = getToolByName(portal, 'portal_types')
  pref_portal_type = typestool.getTypeInfo('Preference')
  if pref_portal_type is None:
    LOG('createPreferenceMethods', PROBLEM,
           'Preference type information is not installed.')
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
  # 'Dynamic' property sheets added through ZMI
  zmi_property_sheet_list = []
  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('createPreferenceMethods', PROBLEM,
           'unable to import Property Sheet %s' % property_sheet, e)
  # 'Static' property sheets defined on the class
  class_property_sheet_list = Preference.property_sheets
  for property_sheet in ( tuple(zmi_property_sheet_list) +
                                class_property_sheet_list ) :
    # then generate common method names 
    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)

class PreferenceMethod(Method) :
  """ 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 = ()

  def __init__(self, attribute) :
    self._preference_name = attribute

  def __call__(self, instance, *args, **kw) :
95
    # FIXME: Preference method doesn't support default parameter
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
    def _getPreference(user_name="") :
      found = 0
      MARKER = []
      for pref in instance._getSortedPreferenceList() :
        attr = getattr(pref, self._preference_name, MARKER)
        if attr is not MARKER :
          found = 1
          # test the attr is set
          if callable(attr) :
            value = attr()
          else :
            value = attr
          if value not in (None, '', (), []) :
            return value
      if found :
        return value
    _getPreference = CachingMethod( _getPreference,
            id='PreferenceTool.CachingMethod.%s' % self._preference_name)
    user_name = getSecurityManager().getUser().getId()
    return _getPreference(user_name=user_name)
    
117
class PreferenceTool(BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
118 119 120 121 122 123
  """
    PreferenceTool manages User Preferences / User profiles.

    TODO:
      - make the preference tool an action provider (templates)
  """
124 125 126
  id            = 'portal_preferences'
  meta_type     = 'ERP5 Preference Tool'
  portal_type   = 'Preference Tool'
Jérome Perrin's avatar
Jérome Perrin committed
127
  title         = 'Preferences'
128 129 130 131 132 133
  allowed_types = ( 'ERP5 Preference',)
  security      = ClassSecurityInfo()

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

135 136 137 138 139 140 141 142
  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'])
    BaseTool.inheritedAttribute('manage_afterAdd')(self, item, container)
143

144
  security.declareProtected(Permissions.View, "getPreference")
145
  def getPreference(self, pref_name, default=None) :
146
    """ get the preference on the most appopriate Preference object. """
147 148
    return getattr(self, 'get%s' %
        convertToUpperCase(pref_name))(default=default)
149

150 151 152 153
  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})
154 155 156

  security.declarePrivate('_getSortedPreferenceList')
  def _getSortedPreferenceList(self) :
157
    """ return the most appropriate preferences objects,
158 159
        sorted so that the first in the list should be applied first
    """
160
    prefs = []
161 162 163
    # XXX will also cause problems with Manager (too long)
    # XXX For manager, create a manager specific preference
    #                  or better solution
164 165
    user = getToolByName(self, 'portal_membership').getAuthenticatedMember()
    user_is_manager = 'Manager' in user.getRolesInContext(self)
166
    for pref in self.searchFolder(portal_type='Preference') :
167
      pref = pref.getObject()
168 169
      if pref is not None and pref.getProperty('preference_state',
                                               'broken') == 'enabled' :
170 171 172 173 174 175 176
        # 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)
177 178
    prefs.sort(lambda b, a: cmp(a.getPriority(), b.getPriority()))
    return prefs
179
    
180 181 182 183
  security.declareProtected(Permissions.View, 'getActivePreference')
  def getActivePreference(self) :
    """ returns the current preference for the user. 
       Note that this preference may be read only. """
184
    enabled_prefs = self._getSortedPreferenceList()
185 186 187
    if len(enabled_prefs) > 0 :
      return enabled_prefs[0]

188
  security.declareProtected(Permissions.View, 'getDocumentTemplateList')
189
  def getDocumentTemplateList(self, folder=None) :
190
    """ returns all document templates that are in acceptable Preferences
191 192
        based on different criteria such as folder, portal_type, etc.
    """
193
    # We must set the user_id as a parameter to make sure each
Jérome Perrin's avatar
Jérome Perrin committed
194
    # user can get a different cache
195 196 197
    def _getDocumentTemplateList(user_id,portal_type=None):
      acceptable_templates = []
      for pref in self._getSortedPreferenceList() :
Jérome Perrin's avatar
Jérome Perrin committed
198
        for doc in pref.contentValues() :
199 200 201 202 203 204 205 206 207 208 209 210
          if doc.getPortalType() == portal_type:
            acceptable_templates.append(doc.getRelativeUrl())
      return acceptable_templates
    _getDocumentTemplateList = CachingMethod(_getDocumentTemplateList,
                          'portal_preferences.getDocumentTemplateList',
                          cache_duration=3000)

    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
211
      for template_url in _getDocumentTemplateList(user_id, portal_type=portal_type):
212 213
        template_list.append(self.restrictedTraverse(template_url))
    return template_list
214 215 216

InitializeClass(PreferenceTool)