PreferenceTool.py 11.2 KB
Newer Older
1
# -*- coding: utf-8 -*-
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 29
##############################################################################
#
# 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.
#
##############################################################################

30 31 32
from AccessControl import ClassSecurityInfo
from AccessControl.SecurityManagement import getSecurityManager,\
                          setSecurityManager, newSecurityManager
33
from MethodObject import Method
34
from Products.ERP5Type.Globals import InitializeClass, DTMLFile
35
from zLOG import LOG, PROBLEM
36 37 38

from Products.CMFCore.utils import getToolByName
from Products.ERP5Type.Tool.BaseTool import BaseTool
39
from Products.ERP5Type import Permissions
40 41
from Products.ERP5Type.Cache import CachingMethod
from Products.ERP5Type.Utils import convertToUpperCase
42
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
43 44
from Products.ERP5Form import _dtmldir

45
_marker = object()
46

47 48 49 50 51 52
class Priority:
  """ names for priorities """
  SITE  = 1
  GROUP = 2
  USER  = 3

53 54
class func_code: pass

55
class PreferenceMethod(Method):
56 57 58 59 60 61 62
  """ 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 = ()

63
  def __init__(self, attribute, default):
64
    self.__name__ = self._preference_getter = attribute
65
    self._preference_default = default
66
    self._preference_cache_id = 'PreferenceTool.CachingMethod.%s' % attribute
67

68
  def __call__(self, instance, default=_marker, *args, **kw):
69
    def _getPreference(*args, **kw):
70 71 72 73 74
      # XXX: sql_catalog_id is passed when calling getPreferredArchive
      # This is inconsistent with regular accessor API, and indicates that
      # there is a design problem in current archive API.
      sql_catalog_id = kw.pop('sql_catalog_id', None)
      for pref in instance._getSortedPreferenceList(sql_catalog_id=sql_catalog_id):
75 76 77 78 79 80 81
        value = getattr(pref, self._preference_getter)(_marker, *args, **kw)
        # XXX Due to UI limitation, null value is treated as if the property
        #     was not defined. The drawback is that it is not possible for a
        #     user to mask a non-null global value with a null value.
        if value not in (_marker, None, '', (), []):
          return value
      return _marker
82
    _getPreference = CachingMethod(_getPreference,
83 84
            id='%s.%s' % (self._preference_cache_id,
                          getSecurityManager().getUser().getId()),
85
            cache_factory='erp5_ui_short')
86
    value = _getPreference(*args, **kw)
87 88 89 90 91
    if value is not _marker:
      return value
    elif default is _marker:
      return self._preference_default
    return default
Aurel's avatar
Aurel committed
92

93
class PreferenceTool(BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
94 95 96 97 98 99
  """
    PreferenceTool manages User Preferences / User profiles.

    TODO:
      - make the preference tool an action provider (templates)
  """
100 101 102
  id            = 'portal_preferences'
  meta_type     = 'ERP5 Preference Tool'
  portal_type   = 'Preference Tool'
Jérome Perrin's avatar
Jérome Perrin committed
103
  title         = 'Preferences'
104 105 106
  allowed_types = ( 'ERP5 Preference',)
  security      = ClassSecurityInfo()

107 108
  aq_preference_generated = False

109 110 111
  security.declareProtected(
       Permissions.ManagePortal, 'manage_overview' )
  manage_overview = DTMLFile( 'explainPreferenceTool', _dtmldir )
112

113 114 115 116 117
  security.declarePrivate('manage_afterAdd')
  def manage_afterAdd(self, item, container) :
    """ init the permissions right after creation """
    item.manage_permission(Permissions.AddPortalContent,
          ['Member', 'Author', 'Manager'])
118 119
    item.manage_permission(Permissions.AddPortalFolders,
          ['Member', 'Author', 'Manager'])
120 121
    item.manage_permission(Permissions.View,
          ['Member', 'Auditor', 'Manager'])
122 123 124 125
    item.manage_permission(Permissions.CopyOrMove,
          ['Member', 'Auditor', 'Manager'])
    item.manage_permission(Permissions.ManageProperties,
          ['Manager'], acquire=0)
Aurel's avatar
Aurel committed
126 127
    item.manage_permission(Permissions.SetOwnPassword,
          ['Member', 'Author', 'Manager'])
128
    BaseTool.inheritedAttribute('manage_afterAdd')(self, item, container)
129

130
  security.declarePublic('getPreference')
131
  def getPreference(self, pref_name, default=_marker) :
132
    """ get the preference on the most appopriate Preference object. """
133
    method = getattr(self, 'get%s' % convertToUpperCase(pref_name), None)
134
    if method is not None:
135
      return method(default)
136
    return default
137

138 139 140 141
  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})
142

143
  def _getSortedPreferenceList(self, sql_catalog_id=None):
144
    """ return the most appropriate preferences objects,
145 146
        sorted so that the first in the list should be applied first
    """
147
    tv = getTransactionalVariable()
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
    security_manager = getSecurityManager()
    user = security_manager.getUser()
    acl_users = self.getPortalObject().acl_users
    try:
      # reset a security manager without any proxy role or unrestricted method,
      # wich affects the catalog search that we do to find applicable
      # preferences.
      actual_user = acl_users.getUser(str(user))
      if actual_user is not None:
        newSecurityManager(self.REQUEST, actual_user.__of__(acl_users))
      tv_key = 'PreferenceTool._getSortedPreferenceList/%s/%s' % (user,
                                                                  sql_catalog_id)
      if tv.get(tv_key, None) is None:
        prefs = []
        # XXX will also cause problems with Manager (too long)
        # XXX For manager, create a manager specific preference
        #                  or better solution
        user_is_manager = 'Manager' in user.getRolesInContext(self)
        for pref in self.searchFolder(portal_type='Preference', sql_catalog_id=sql_catalog_id):
          pref = pref.getObject()
          if pref is not None and pref.getProperty('preference_state',
                                    'broken') in ('enabled', 'global'):
            # XXX quick workaround so that manager only see user preference
            # they actually own.
            if user_is_manager and pref.getPriority() == Priority.USER :
              if pref.getOwnerTuple()[1] == user.getId():
                prefs.append(pref)
            else :
176
              prefs.append(pref)
177 178 179 180 181 182 183 184 185 186
        prefs.sort(key=lambda x: x.getPriority(), reverse=True)
        # add system preferences before user preferences
        sys_prefs = [x.getObject() for x in self.searchFolder(portal_type='System Preference', sql_catalog_id=sql_catalog_id) \
                     if x.getObject().getProperty('preference_state', 'broken') in ('enabled', 'global')]
        sys_prefs.sort(key=lambda x: x.getPriority(), reverse=True)
        preference_list = sys_prefs + prefs
        tv[tv_key] = preference_list
      return tv[tv_key]
    finally:
      setSecurityManager(security_manager)
Aurel's avatar
Aurel committed
187

188 189 190 191 192 193 194 195 196 197
  def _getActivePreferenceByPortalType(self, portal_type):
    enabled_prefs = self._getSortedPreferenceList()
    if len(enabled_prefs) > 0 :
      try:
        return [x for x in enabled_prefs
            if x.getPortalType() == portal_type][0]
      except IndexError:
        pass
    return None

198 199
  security.declareProtected(Permissions.View, 'getActivePreference')
  def getActivePreference(self) :
Aurel's avatar
Aurel committed
200
    """ returns the current preference for the user.
201
       Note that this preference may be read only. """
202 203 204 205 206 207 208
    return self._getActivePreferenceByPortalType('Preference')

  security.declareProtected(Permissions.View, 'getActiveSystemPreference')
  def getActiveSystemPreference(self) :
    """ returns the current system preference for the user.
       Note that this preference may be read only. """
    return self._getActivePreferenceByPortalType('System Preference')
209

210
  security.declareProtected(Permissions.View, 'getDocumentTemplateList')
211
  def getDocumentTemplateList(self, folder=None) :
212
    """ returns all document templates that are in acceptable Preferences
213 214
        based on different criteria such as folder, portal_type, etc.
    """
215 216
    if folder is None:
      # as the preference tool is also a Folder, this method is called by
Aurel's avatar
Aurel committed
217
      # page templates to get the list of document templates for self.
218 219
      folder = self

220
    # We must set the user_id as a parameter to make sure each
Jérome Perrin's avatar
Jérome Perrin committed
221
    # user can get a different cache
Jean-Paul Smets's avatar
Jean-Paul Smets committed
222
    def _getDocumentTemplateList(user_id, portal_type=None):
223 224
      acceptable_templates = []
      for pref in self._getSortedPreferenceList() :
Jérome Perrin's avatar
Jérome Perrin committed
225
        for doc in pref.contentValues() :
226 227 228 229 230
          if doc.getPortalType() == portal_type:
            acceptable_templates.append(doc.getRelativeUrl())
      return acceptable_templates
    _getDocumentTemplateList = CachingMethod(_getDocumentTemplateList,
                          'portal_preferences.getDocumentTemplateList',
Aurel's avatar
Aurel committed
231
                                             cache_factory='erp5_ui_medium')
232 233 234 235 236 237

    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
238
      for template_url in _getDocumentTemplateList(user_id, portal_type=portal_type):
239 240 241
        template = self.restrictedTraverse(template_url, None)
        if template is not None:
          template_list.append(template)
242
    return template_list
243

244 245
  security.declareProtected(Permissions.ManagePortal,
                            'createPreferenceForUser')
246 247 248
  def createPreferenceForUser(self, username, enable=True):
    """Creates a preference for a given user, and optionnally enable the
    preference.
249 250 251 252 253 254
    """
    security_manager = getSecurityManager()
    try:
      user_folder = self.getPortalObject().acl_users
      user = user_folder.getUserById(username)
      if user is None:
255
        raise ValueError("User %r not found" % (username, ))
256
      newSecurityManager(None, user.__of__(user_folder))
257 258 259 260
      preference = self.newContent(portal_type='Preference')
      if enable:
        preference.enable()
      return preference
261 262 263
    finally:
      setSecurityManager(security_manager)

264 265
InitializeClass(PreferenceTool)