Skip to content

erp5
erp5
Commit 4558c766 authored by Jérome Perrin's avatar Jérome Perrin
3 Browse files
Options

Fix preferences cache 

* Fix the problem that preference cache was not reset when `setPreferredSomething` was called, only when `edit(preferred_something=)`
* Implement something more advanced than just `portal_cache.clearCache()` so that when a user change their preference, only preference of this user are affected.
* Increase default cache duration, now that we invalidate caches properly.

/reviewed-on nexedi/erp5!983
parents 0bfc33fd b55661f3
Pipeline #6887 failed with stage
    in 0 seconds
    Hide whitespace changes
    Inline Side-by-side
    Showing with 423 additions and 101 deletions
    bt5/erp5_upgrader/TestTemplateItem/portal_components/test.erp5.testUpgrader.py
    View file @ 4558c766
    ...@@ -232,8 +232,8 @@ class TestUpgrader(ERP5TypeTestCase): ...@@ -232,8 +232,8 @@ class TestUpgrader(ERP5TypeTestCase):
    alarm = getattr(self.portal.portal_alarms, 'upgrader_check_post_upgrade') alarm = getattr(self.portal.portal_alarms, 'upgrader_check_post_upgrade')
    active_process = alarm.getLastActiveProcess() active_process = alarm.getLastActiveProcess()
    detail_list = active_process.getResultList()[0].detail detail_list = active_process.getResultList()[0].detail
    message = 'Preference - Expected: edit_workflow, preference_workflow <> Found: (Default)' message = 'Preference - Expected: edit_workflow, preference_interaction_workflow, preference_workflow <> Found: (Default)'
    self.assertTrue(message in detail_list, detail_list) self.assertIn(message, detail_list)
    self.assertTrue(detail_list.count(message), 1) self.assertTrue(detail_list.count(message), 1)
    def stepSetConstraintInPersonModulePortalType(self, sequence=None): def stepSetConstraintInPersonModulePortalType(self, sequence=None):
    ......
    product/ERP5/bootstrap/erp5_core/PortalTypeWorkflowChainTemplateItem/workflow_chain_type.xml
    View file @ 4558c766
    ...@@ -133,7 +133,7 @@ ...@@ -133,7 +133,7 @@
    </chain> </chain>
    <chain> <chain>
    <type>Preference</type> <type>Preference</type>
    <workflow>edit_workflow, preference_workflow</workflow> <workflow>edit_workflow, preference_interaction_workflow, preference_workflow</workflow>
    </chain> </chain>
    <chain> <chain>
    <type>Property Existence Constraint</type> <type>Property Existence Constraint</type>
    ...@@ -169,7 +169,7 @@ ...@@ -169,7 +169,7 @@
    </chain> </chain>
    <chain> <chain>
    <type>System Preference</type> <type>System Preference</type>
    <workflow>edit_workflow, preference_workflow</workflow> <workflow>edit_workflow, preference_interaction_workflow, preference_workflow</workflow>
    </chain> </chain>
    <chain> <chain>
    <type>TALES Constraint</type> <type>TALES Constraint</type>
    ......
    product/ERP5/bootstrap/erp5_core/SkinTemplateItem/portal_skins/erp5_core/Base_makeTemplateFromDocument.py
    View file @ 4558c766
    ...@@ -30,7 +30,7 @@ paste_info, = preference.manage_pasteObjects(cb_copy_data=cp, is_indexable=False ...@@ -30,7 +30,7 @@ paste_info, = preference.manage_pasteObjects(cb_copy_data=cp, is_indexable=False
    template = getattr(preference, paste_info['new_id']) template = getattr(preference, paste_info['new_id'])
    template.makeTemplate() template.makeTemplate()
    context.portal_caches.clearCacheFactory('erp5_ui_short') portal.portal_preferences.clearCache(preference)
    kw['keep_items'] = dict(portal_status_message=message) kw['keep_items'] = dict(portal_status_message=message)
    return context.Base_redirect(form_id, return context.Base_redirect(form_id,
    ......
    product/ERP5/bootstrap/erp5_core/WorkflowTemplateItem/portal_workflow/preference_interaction_workflow.xml 0 → 100644
    View file @ 4558c766
    <?xml version="1.0"?>
    <ZopeData>
    <record id="1" aka="AAAAAAAAAAE=">
    <pickle>
    <global name="InteractionWorkflowDefinition" module="Products.ERP5.InteractionWorkflow"/>
    </pickle>
    <pickle>
    <dictionary>
    <item>
    <key> <string>_objects</string> </key>
    <value>
    <tuple/>
    </value>
    </item>
    <item>
    <key> <string>groups</string> </key>
    <value>
    <tuple/>
    </value>
    </item>
    <item>
    <key> <string>id</string> </key>
    <value> <string>preference_interaction_workflow</string> </value>
    </item>
    </dictionary>
    </pickle>
    </record>
    </ZopeData>
    product/ERP5/bootstrap/erp5_core/WorkflowTemplateItem/portal_workflow/preference_interaction_workflow/interactions.xml 0 → 100644
    View file @ 4558c766
    <?xml version="1.0"?>
    <ZopeData>
    <record id="1" aka="AAAAAAAAAAE=">
    <pickle>
    <global name="Interaction" module="Products.ERP5.Interaction"/>
    </pickle>
    <pickle>
    <dictionary>
    <item>
    <key> <string>_mapping</string> </key>
    <value>
    <dictionary/>
    </value>
    </item>
    <item>
    <key> <string>_objects</string> </key>
    <value>
    <tuple/>
    </value>
    </item>
    <item>
    <key> <string>id</string> </key>
    <value> <string>interactions</string> </value>
    </item>
    </dictionary>
    </pickle>
    </record>
    </ZopeData>
    product/ERP5/bootstrap/erp5_core/WorkflowTemplateItem/portal_workflow/preference_interaction_workflow/interactions/edit.xml 0 → 100644
    View file @ 4558c766
    <?xml version="1.0"?>
    <ZopeData>
    <record id="1" aka="AAAAAAAAAAE=">
    <pickle>
    <global name="InteractionDefinition" module="Products.ERP5.Interaction"/>
    </pickle>
    <pickle>
    <dictionary>
    <item>
    <key> <string>actbox_category</string> </key>
    <value> <string>workflow</string> </value>
    </item>
    <item>
    <key> <string>actbox_name</string> </key>
    <value> <string></string> </value>
    </item>
    <item>
    <key> <string>actbox_url</string> </key>
    <value> <string></string> </value>
    </item>
    <item>
    <key> <string>activate_script_name</string> </key>
    <value>
    <tuple/>
    </value>
    </item>
    <item>
    <key> <string>after_script_name</string> </key>
    <value>
    <list>
    <string>ERP5Site_clearPreferrenceCache</string>
    </list>
    </value>
    </item>
    <item>
    <key> <string>before_commit_script_name</string> </key>
    <value>
    <tuple/>
    </value>
    </item>
    <item>
    <key> <string>description</string> </key>
    <value> <string></string> </value>
    </item>
    <item>
    <key> <string>guard</string> </key>
    <value>
    <none/>
    </value>
    </item>
    <item>
    <key> <string>id</string> </key>
    <value> <string>edit</string> </value>
    </item>
    <item>
    <key> <string>method_id</string> </key>
    <value>
    <list>
    <string>_set.*</string>
    <string>manage_beforeDelete</string>
    <string>enable</string>
    <string>disable</string>
    </list>
    </value>
    </item>
    <item>
    <key> <string>once_per_transaction</string> </key>
    <value> <int>0</int> </value>
    </item>
    <item>
    <key> <string>portal_type_filter</string> </key>
    <value>
    <none/>
    </value>
    </item>
    <item>
    <key> <string>portal_type_group_filter</string> </key>
    <value>
    <none/>
    </value>
    </item>
    <item>
    <key> <string>script_name</string> </key>
    <value>
    <tuple/>
    </value>
    </item>
    <item>
    <key> <string>temporary_document_disallowed</string> </key>
    <value> <int>0</int> </value>
    </item>
    <item>
    <key> <string>title</string> </key>
    <value> <string></string> </value>
    </item>
    <item>
    <key> <string>trigger_type</string> </key>
    <value> <int>2</int> </value>
    </item>
    </dictionary>
    </pickle>
    </record>
    </ZopeData>
    product/ERP5/bootstrap/erp5_core/WorkflowTemplateItem/portal_workflow/preference_interaction_workflow/scripts.xml 0 → 100644
    View file @ 4558c766
    <?xml version="1.0"?>
    <ZopeData>
    <record id="1" aka="AAAAAAAAAAE=">
    <pickle>
    <global name="Scripts" module="Products.DCWorkflow.Scripts"/>
    </pickle>
    <pickle>
    <dictionary>
    <item>
    <key> <string>_mapping</string> </key>
    <value>
    <dictionary/>
    </value>
    </item>
    <item>
    <key> <string>_objects</string> </key>
    <value>
    <tuple/>
    </value>
    </item>
    <item>
    <key> <string>id</string> </key>
    <value> <string>scripts</string> </value>
    </item>
    </dictionary>
    </pickle>
    </record>
    </ZopeData>
    product/ERP5/bootstrap/erp5_core/WorkflowTemplateItem/portal_workflow/preference_interaction_workflow/scripts/ERP5Site_clearPreferrenceCache.py 0 → 100644
    View file @ 4558c766
    portal = sci['object'].getPortalObject()
    portal.portal_preferences.clearCache(sci['object'])
    • Roque @rporchetto ·
      Developer

      I'm getting an AttributeError: clearCache in this line on 2 instances I updated. I checked carefully to have the instances and bts properly updated to discard a problem on my side.

      I get the error when changing or editing a preference, so it blocks these instances to set the VCS properties.

      Before I start to investigate in detail, I want to check if may be this is a known issue or I'm missing something to get this working.

      cc @jerome

    • Jérome Perrin @jerome ·
      Owner

      Please make sure that you have updated the products and restarted zopes before updating business templates. This clearCache method is defined here

    • Roque @rporchetto ·
      Developer

      True, I was missing to restart the zopes. It works fine. Thank you !

    Please register or sign in to reply
    product/ERP5/bootstrap/erp5_core/WorkflowTemplateItem/portal_workflow/preference_interaction_workflow/scripts/ERP5Site_clearPreferrenceCache.xml 0 → 100644
    View file @ 4558c766
    <?xml version="1.0"?>
    <ZopeData>
    <record id="1" aka="AAAAAAAAAAE=">
    <pickle>
    <global name="PythonScript" module="Products.PythonScripts.PythonScript"/>
    </pickle>
    <pickle>
    <dictionary>
    <item>
    <key> <string>Script_magic</string> </key>
    <value> <int>3</int> </value>
    </item>
    <item>
    <key> <string>_bind_names</string> </key>
    <value>
    <object>
    <klass>
    <global name="NameAssignments" module="Shared.DC.Scripts.Bindings"/>
    </klass>
    <tuple/>
    <state>
    <dictionary>
    <item>
    <key> <string>_asgns</string> </key>
    <value>
    <dictionary>
    <item>
    <key> <string>name_container</string> </key>
    <value> <string>container</string> </value>
    </item>
    <item>
    <key> <string>name_context</string> </key>
    <value> <string>context</string> </value>
    </item>
    <item>
    <key> <string>name_m_self</string> </key>
    <value> <string>script</string> </value>
    </item>
    <item>
    <key> <string>name_subpath</string> </key>
    <value> <string>traverse_subpath</string> </value>
    </item>
    </dictionary>
    </value>
    </item>
    </dictionary>
    </state>
    </object>
    </value>
    </item>
    <item>
    <key> <string>_params</string> </key>
    <value> <string>sci</string> </value>
    </item>
    <item>
    <key> <string>_proxy_roles</string> </key>
    <value>
    <tuple>
    <string>Manager</string>
    </tuple>
    </value>
    </item>
    <item>
    <key> <string>id</string> </key>
    <value> <string>ERP5Site_clearPreferrenceCache</string> </value>
    </item>
    </dictionary>
    </pickle>
    </record>
    </ZopeData>
    product/ERP5/bootstrap/erp5_core/WorkflowTemplateItem/portal_workflow/preference_interaction_workflow/variables.xml 0 → 100644
    View file @ 4558c766
    <?xml version="1.0"?>
    <ZopeData>
    <record id="1" aka="AAAAAAAAAAE=">
    <pickle>
    <global name="Variables" module="Products.DCWorkflow.Variables"/>
    </pickle>
    <pickle>
    <dictionary>
    <item>
    <key> <string>_mapping</string> </key>
    <value>
    <dictionary/>
    </value>
    </item>
    <item>
    <key> <string>id</string> </key>
    <value> <string>variables</string> </value>
    </item>
    </dictionary>
    </pickle>
    </record>
    </ZopeData>
    product/ERP5/bootstrap/erp5_core/WorkflowTemplateItem/portal_workflow/preference_interaction_workflow/worklists.xml 0 → 100644
    View file @ 4558c766
    <?xml version="1.0"?>
    <ZopeData>
    <record id="1" aka="AAAAAAAAAAE=">
    <pickle>
    <global name="Worklists" module="Products.DCWorkflow.Worklists"/>
    </pickle>
    <pickle>
    <dictionary>
    <item>
    <key> <string>_mapping</string> </key>
    <value>
    <dictionary/>
    </value>
    </item>
    <item>
    <key> <string>id</string> </key>
    <value> <string>worklists</string> </value>
    </item>
    </dictionary>
    </pickle>
    </record>
    </ZopeData>
    product/ERP5/bootstrap/erp5_core/bt/template_portal_type_workflow_chain_list
    View file @ 4558c766
    ...@@ -45,6 +45,7 @@ Module Component | dynamic_class_generation_interaction_workflow ...@@ -45,6 +45,7 @@ Module Component | dynamic_class_generation_interaction_workflow
    Module Component | edit_workflow Module Component | edit_workflow
    Predicate | edit_workflow Predicate | edit_workflow
    Preference | edit_workflow Preference | edit_workflow
    Preference | preference_interaction_workflow
    Preference | preference_workflow Preference | preference_workflow
    Property Existence Constraint | dynamic_class_generation_interaction_workflow Property Existence Constraint | dynamic_class_generation_interaction_workflow
    Property Sheet Tool | dynamic_class_generation_interaction_workflow Property Sheet Tool | dynamic_class_generation_interaction_workflow
    ...@@ -55,6 +56,7 @@ SQL Method | edit_workflow ...@@ -55,6 +56,7 @@ SQL Method | edit_workflow
    Standard Property | dynamic_class_generation_interaction_workflow Standard Property | dynamic_class_generation_interaction_workflow
    String Attribute Match Constraint | dynamic_class_generation_interaction_workflow String Attribute Match Constraint | dynamic_class_generation_interaction_workflow
    System Preference | edit_workflow System Preference | edit_workflow
    System Preference | preference_interaction_workflow
    System Preference | preference_workflow System Preference | preference_workflow
    TALES Constraint | dynamic_class_generation_interaction_workflow TALES Constraint | dynamic_class_generation_interaction_workflow
    Test Component | component_validation_workflow Test Component | component_validation_workflow
    ......
    product/ERP5/bootstrap/erp5_core/bt/template_workflow_id_list
    View file @ 4558c766
    ...@@ -6,6 +6,7 @@ distributed_ram_cache_interaction_workflow ...@@ -6,6 +6,7 @@ distributed_ram_cache_interaction_workflow
    dynamic_class_generation_interaction_workflow dynamic_class_generation_interaction_workflow
    edit_workflow edit_workflow
    memcached_plugin_interaction_workflow memcached_plugin_interaction_workflow
    preference_interaction_workflow
    preference_workflow preference_workflow
    pricing_interaction_workflow pricing_interaction_workflow
    rule_validation_workflow rule_validation_workflow
    ......
    product/ERP5/tests/testAuthenticationPolicy.py
    View file @ 4558c766
    ...@@ -100,8 +100,7 @@ class TestAuthenticationPolicy(ERP5TypeTestCase): ...@@ -100,8 +100,7 @@ class TestAuthenticationPolicy(ERP5TypeTestCase):
    def _clearCache(self): def _clearCache(self):
    self.portal.portal_caches.clearCache( self.portal.portal_caches.clearCache(
    cache_factory_list=('erp5_ui_short', # for preference cache cache_factory_list=('erp5_content_short', # for authentication cache
    'erp5_content_short', # for authentication cache
    )) ))
    def _getPasswordEventList(self, login): def _getPasswordEventList(self, login):
    ......
    product/ERP5/tests/testERP5Coordinate.py
    View file @ 4558c766
    ...@@ -49,6 +49,13 @@ class TestERP5Coordinate(ERP5TypeTestCase): ...@@ -49,6 +49,13 @@ class TestERP5Coordinate(ERP5TypeTestCase):
    'erp5_full_text_mroonga_catalog', 'erp5_full_text_mroonga_catalog',
    'erp5_base',) 'erp5_base',)
    def afterSetUp(self):
    ERP5TypeTestCase.afterSetUp(self)
    self.default_site_preference = self.portal.portal_preferences.default_site_preference
    if self.default_site_preference.getPreferenceState() != 'global':
    self.default_site_preference.enable()
    self.tic()
    def beforeTearDown(self): def beforeTearDown(self):
    self.abort() self.abort()
    for module in ( self.portal.person_module, for module in ( self.portal.person_module,
    ...@@ -109,20 +116,20 @@ class TestERP5Coordinate(ERP5TypeTestCase): ...@@ -109,20 +116,20 @@ class TestERP5Coordinate(ERP5TypeTestCase):
    def test_TelephonePreference(self): def test_TelephonePreference(self):
    pers = self.getPersonModule().newContent(portal_type='Person') pers = self.getPersonModule().newContent(portal_type='Person')
    tel = pers.newContent(portal_type='Telephone') tel = pers.newContent(portal_type='Telephone')
    pref = self.portal.portal_preferences.default_site_preference self.default_site_preference.setPreferredTelephoneDefaultCountryNumber('33')
    pref.setPreferredTelephoneDefaultCountryNumber('33') self.default_site_preference.setPreferredTelephoneDefaultAreaNumber('2')
    pref.setPreferredTelephoneDefaultAreaNumber('2') self.tic()
    pref.enable()
    tel.fromText(coordinate_text='11111111') tel.fromText(coordinate_text='11111111')
    self.assertEqual('+33(0)2-11111111',tel.asText()) self.assertEqual('+33(0)2-11111111',tel.asText())
    def test_TelephoneCountryAndAreaCodeRemains(self): def test_TelephoneCountryAndAreaCodeRemains(self):
    pers = self.getPersonModule().newContent(portal_type='Person') pers = self.getPersonModule().newContent(portal_type='Person')
    tel = pers.newContent(portal_type='Telephone') tel = pers.newContent(portal_type='Telephone')
    pref = self.portal.portal_preferences.default_site_preference self.default_site_preference.setPreferredTelephoneDefaultCountryNumber('')
    pref.setPreferredTelephoneDefaultCountryNumber('') self.default_site_preference.setPreferredTelephoneDefaultAreaNumber('')
    pref.setPreferredTelephoneDefaultAreaNumber('') self.tic()
    pref.enable()
    tel.fromText(coordinate_text='+11 1 11111111') tel.fromText(coordinate_text='+11 1 11111111')
    tel.fromText(coordinate_text='+22333445555') tel.fromText(coordinate_text='+22333445555')
    self.assertEqual('+(0)-22333445555',tel.asText()) self.assertEqual('+(0)-22333445555',tel.asText())
    ...@@ -312,10 +319,9 @@ class TestERP5Coordinate(ERP5TypeTestCase): ...@@ -312,10 +319,9 @@ class TestERP5Coordinate(ERP5TypeTestCase):
    def test_TelephoneWhenTheDefaultCountryAndAreaPreferenceIsBlank(self): def test_TelephoneWhenTheDefaultCountryAndAreaPreferenceIsBlank(self):
    pers = self.getPersonModule().newContent(portal_type='Person') pers = self.getPersonModule().newContent(portal_type='Person')
    tel = pers.newContent(portal_type='Telephone') tel = pers.newContent(portal_type='Telephone')
    pref = self.portal.portal_preferences.default_site_preference self.default_site_preference.setPreferredTelephoneDefaultCountryNumber('')
    pref.setPreferredTelephoneDefaultCountryNumber('') self.default_site_preference.setPreferredTelephoneDefaultAreaNumber('')
    pref.setPreferredTelephoneDefaultAreaNumber('') self.tic()
    pref.enable()
    tel.fromText(coordinate_text='12345678') tel.fromText(coordinate_text='12345678')
    self.assertEqual('+(0)-12345678',tel.asText()) self.assertEqual('+(0)-12345678',tel.asText())
    ......
    product/ERP5/tests/testEditorField.py
    View file @ 4558c766
    ...@@ -99,11 +99,10 @@ class TestEditorField(ERP5TypeTestCase, ZopeTestCase.Functional): ...@@ -99,11 +99,10 @@ class TestEditorField(ERP5TypeTestCase, ZopeTestCase.Functional):
    is using appropriate editor (editor) as defined is using appropriate editor (editor) as defined
    in preferences in preferences
    """ """
    self.getDefaultSitePreference().setPreferredTextEditor(preferred_editor) site_preference = self.getDefaultSitePreference()
    if self.getDefaultSitePreference().getPreferenceState() == 'global': site_preference.setPreferredTextEditor(preferred_editor)
    self.getDefaultSitePreference()._clearCache() if site_preference.getPreferenceState() != 'global':
    else: site_preference.enable()
    self.getDefaultSitePreference().enable()
    # commit transaction, are preferences are in transaction cache # commit transaction, are preferences are in transaction cache
    self.commit() self.commit()
    ......
    product/ERP5Form/Document/Preference.py
    View file @ 4558c766
    ...@@ -66,32 +66,3 @@ class Preference( Folder ): ...@@ -66,32 +66,3 @@ class Preference( Folder ):
    security = ClassSecurityInfo() security = ClassSecurityInfo()
    security.declareObjectProtected(Permissions.AccessContentsInformation) security.declareObjectProtected(Permissions.AccessContentsInformation)
    def _clearCache(self):
    """Clear caches used by methods of this preference
    # TODO: clear different caches according to the preference priority
    # TODO: (XXX) currently, if one use enables / disables a cache, caches
    for all other users are reset. This is not good for a system
    in which users do a lot of preference validation. A better solution
    is needed for this. But it is not easy because the concept of
    "per user cache" has been proven to be ambiguous or useless.
    In theory, a solution could consist in using more keys to
    select caches or to delete "manually" certain cache keys.
    """
    portal_caches = getToolByName(self.getPortalObject(), 'portal_caches')
    portal_caches.clearCache(cache_factory_list=('erp5_ui_short',))
    def _edit(self, **kw):
    """edit and clear all caches"""
    self._clearCache()
    Folder._edit(self, **kw)
    security.declareProtected(Permissions.ModifyPortalContent, 'enable')
    def enable(self, **kw):
    """Workflow method"""
    self._clearCache()
    security.declareProtected(Permissions.ModifyPortalContent, 'disable')
    def disable(self, **kw):
    """Workflow method"""
    self._clearCache()
    product/ERP5Form/PreferenceTool.py
    View file @ 4558c766
    ...@@ -41,6 +41,7 @@ from Products.ERP5Type.Cache import CachingMethod ...@@ -41,6 +41,7 @@ from Products.ERP5Type.Cache import CachingMethod
    from Products.ERP5Type.Utils import convertToUpperCase from Products.ERP5Type.Utils import convertToUpperCase
    from Products.ERP5Type.TransactionalVariable import getTransactionalVariable from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
    from Products.ERP5Form import _dtmldir from Products.ERP5Form import _dtmldir
    from BTrees.OIBTree import OIBTree
    _marker = object() _marker = object()
    ...@@ -83,10 +84,11 @@ class PreferenceMethod(Method): ...@@ -83,10 +84,11 @@ class PreferenceMethod(Method):
    return default return default
    _getPreference = CachingMethod(_getPreference, _getPreference = CachingMethod(_getPreference,
    id='%s.%s' % (self._preference_cache_id, id='%s.%s' % (self._preference_cache_id,
    getSecurityManager().getUser().getId()), instance.getPortalObject().portal_preferences._getCacheId()),
    cache_factory='erp5_ui_short') cache_factory='erp5_ui_long')
    return _getPreference(default, *args, **kw) return _getPreference(default, *args, **kw)
    class PreferenceTool(BaseTool): class PreferenceTool(BaseTool):
    """ """
    PreferenceTool manages User Preferences / User profiles. PreferenceTool manages User Preferences / User profiles.
    ...@@ -199,6 +201,35 @@ class PreferenceTool(BaseTool): ...@@ -199,6 +201,35 @@ class PreferenceTool(BaseTool):
    Note that this preference may be read only. """ Note that this preference may be read only. """
    return self._getActivePreferenceByPortalType('Preference') return self._getActivePreferenceByPortalType('Preference')
    security.declareProtected(Permissions.View, 'clearCache')
    def clearCache(self, preference):
    """ clear cache when a preference is modified.
    This is called by an interaction workflow on preferences.
    """
    self._getCacheId() # initialize _preference_cache if needed.
    if preference.getPriority() == Priority.USER:
    user_id = getSecurityManager().getUser().getId()
    self._preference_cache[user_id] = \
    self._preference_cache.get(user_id, 0) + 1
    self._preference_cache[None] = self._preference_cache.get(None, 0) + 1
    def _getCacheId(self):
    """Return a cache id for preferences.
    We use:
    - user_id: because preferences are always different by user
    - self._preference_cache[user_id] which is increased everytime a user
    preference is modified
    - self._preference_cache[None] which is increased everytime a global
    preference is modified
    """
    user_id = getSecurityManager().getUser().getId()
    try:
    self._preference_cache
    except AttributeError:
    self._preference_cache = OIBTree()
    return self._preference_cache.get(None), self._preference_cache.get(user_id), user_id
    security.declareProtected(Permissions.View, 'getActiveUserPreference') security.declareProtected(Permissions.View, 'getActiveUserPreference')
    def getActiveUserPreference(self) : def getActiveUserPreference(self) :
    """ returns the current user preference for the user. """ returns the current user preference for the user.
    ...@@ -244,9 +275,10 @@ class PreferenceTool(BaseTool): ...@@ -244,9 +275,10 @@ class PreferenceTool(BaseTool):
    for doc in pref.contentValues(portal_type=portal_type) : for doc in pref.contentValues(portal_type=portal_type) :
    acceptable_template_list.append(doc.getRelativeUrl()) acceptable_template_list.append(doc.getRelativeUrl())
    return acceptable_template_list return acceptable_template_list
    _getDocumentTemplateList = CachingMethod(_getDocumentTemplateList, _getDocumentTemplateList = CachingMethod(
    'portal_preferences.getDocumentTemplateList', _getDocumentTemplateList,
    cache_factory='erp5_ui_short') 'portal_preferences.getDocumentTemplateList.{}'.format(self._getCacheId()),
    cache_factory='erp5_ui_long')
    allowed_content_types = map(lambda pti: pti.id, allowed_content_types = map(lambda pti: pti.id,
    folder.allowedContentTypes()) folder.allowedContentTypes())
    ...@@ -297,24 +329,12 @@ class PreferenceTool(BaseTool): ...@@ -297,24 +329,12 @@ class PreferenceTool(BaseTool):
    This method exists here due to bootstrap issues. This method exists here due to bootstrap issues.
    It should work even if erp5_authentication_policy bt5 is not installed. It should work even if erp5_authentication_policy bt5 is not installed.
    """ """
    # XXX: define an interface # isPreferredAuthenticationPolicyEnabled exisss if property sheets from
    def _isAuthenticationPolicyEnabled(): # erp5_authentication_policy are installed.
    portal_preferences = self.getPortalObject().portal_preferences method = getattr(self, 'isPreferredAuthenticationPolicyEnabled', None)
    method_id = 'isPreferredAuthenticationPolicyEnabled' if method is not None and method():
    method = getattr(self, method_id, None) return True
    if method is not None and method(): # if it does not exist, for sure authentication policy is not enabled.
    return True return False
    return False
    tv = getTransactionalVariable()
    tv_key = 'PreferenceTool._isAuthenticationPolicyEnabled.%s' % getSecurityManager().getUser().getId()
    if tv.get(tv_key, None) is None:
    _isAuthenticationPolicyEnabled = CachingMethod(_isAuthenticationPolicyEnabled,
    id='PortalPreferences_isAuthenticationPolicyEnabled',
    cache_factory='erp5_content_short')
    tv[tv_key] = _isAuthenticationPolicyEnabled()
    return tv[tv_key]
    InitializeClass(PreferenceTool) InitializeClass(PreferenceTool)
    product/ERP5Form/tests/testPreferences.py
    View file @ 4558c766
    ...@@ -29,7 +29,7 @@ ...@@ -29,7 +29,7 @@
    ############################################################################## ##############################################################################
    import unittest import unittest
    from unittest import expectedFailure import mock
    from AccessControl.SecurityManagement import noSecurityManager from AccessControl.SecurityManagement import noSecurityManager
    from AccessControl.SecurityManagement import getSecurityManager from AccessControl.SecurityManagement import getSecurityManager
    ...@@ -217,6 +217,12 @@ class TestPreferences(PropertySheetTestCase): ...@@ -217,6 +217,12 @@ class TestPreferences(PropertySheetTestCase):
    self.assertEqual(list(pref_tool.getPreference( self.assertEqual(list(pref_tool.getPreference(
    'preferred_accounting_transaction_simulation_state_list')), 'preferred_accounting_transaction_simulation_state_list')),
    list(person1.getPreferredAccountingTransactionSimulationStateList())) list(person1.getPreferredAccountingTransactionSimulationStateList()))
    # edits can also be made with setters
    person1.setPreferredAccountingTransactionSimulationStateList(['planned'])
    self.assertEqual(list(pref_tool.getPreference(
    'preferred_accounting_transaction_simulation_state_list')),
    list(person1.getPreferredAccountingTransactionSimulationStateList()))
    # disable person -> group is selected # disable person -> group is selected
    self.getWorkflowTool().doActionFor(person1, self.getWorkflowTool().doActionFor(person1,
    'disable_action', wf_id='preference_workflow') 'disable_action', wf_id='preference_workflow')
    ...@@ -526,6 +532,8 @@ class TestPreferences(PropertySheetTestCase): ...@@ -526,6 +532,8 @@ class TestPreferences(PropertySheetTestCase):
    # But they can see others # But they can see others
    system_pref.view() system_pref.view()
    # check accessors works # check accessors works
    self.assertEqual(['http://127.0.0.1'],
    preference_tool.getPreferredDocumentConversionServerUrlList())
    system_pref.setPreferredDocumentConversionServerUrlList(['http://1.2.3.4']) system_pref.setPreferredDocumentConversionServerUrlList(['http://1.2.3.4'])
    self.tic() self.tic()
    self.assertEqual(['http://1.2.3.4'], self.assertEqual(['http://1.2.3.4'],
    ...@@ -679,7 +687,6 @@ class TestPreferences(PropertySheetTestCase): ...@@ -679,7 +687,6 @@ class TestPreferences(PropertySheetTestCase):
    self.assertEqual(system_preference_string, self.assertEqual(system_preference_string,
    portal_preferences.getDummystring()) portal_preferences.getDummystring())
    @expectedFailure
    def test_system_preference_value_prefererred_clear_cache_disabled(self): def test_system_preference_value_prefererred_clear_cache_disabled(self):
    default_preference_string = 'Default Name' default_preference_string = 'Default Name'
    normal_preference_string = 'Normal Preference' normal_preference_string = 'Normal Preference'
    ...@@ -687,36 +694,50 @@ class TestPreferences(PropertySheetTestCase): ...@@ -687,36 +694,50 @@ class TestPreferences(PropertySheetTestCase):
    self._addProperty('Preference', self._addProperty('Preference',
    'test_system_preference_value_prefererred_clear_cache_disabled Preference', 'test_system_preference_value_prefererred_clear_cache_disabled Preference',
    portal_type='Standard Property', portal_type='Standard Property',
    property_id='dummystring', property_id='dummystring_cache_disabled',
    property_default='python: "%s"' % default_preference_string, property_default='python: "%s"' % default_preference_string,
    preference=True, preference=True,
    elementary_type='string') elementary_type='string')
    portal_preferences = self.portal.portal_preferences portal_preferences = self.portal.portal_preferences
    self.assertEqual(default_preference_string, self.assertEqual(
    portal_preferences.getDummystring()) default_preference_string,
    portal_preferences.getDummystringCacheDisabled())
    preference = portal_preferences.newContent(portal_type='Preference', preference = portal_preferences.newContent(
    dummystring=normal_preference_string, portal_type='Preference',
    priority=Priority.SITE) dummystring_cache_disabled=normal_preference_string,
    priority=Priority.SITE)
    preference.enable() preference.enable()
    self.tic() self.tic()
    self.assertEqual(normal_preference_string, self.assertEqual(
    portal_preferences.getDummystring()) normal_preference_string,
    portal_preferences.getDummystringCacheDisabled())
    # simulate situation when _clearCache does nothing, for example in case # simulate situation when _clearCache does nothing, for example in case
    # if memcached or any other non-deleteable cache is used # if memcached or any other non-deleteable cache is used
    from Products.ERP5Form.Document.Preference import Preference with mock.patch.object(
    Preference._clearCache = lambda *args,**kwargs: None self.portal.portal_caches.__class__,
    system_preference = portal_preferences.newContent(portal_type='System Preference', 'clearAllCache') as clearAllCache,\
    dummystring=system_preference_string) mock.patch.object(
    system_preference.enable() self.portal.portal_caches.__class__,
    self.tic() 'clearCacheFactory') as clearCacheFactory:
    self.assertEqual(system_preference_string, system_preference = portal_preferences.newContent(
    portal_preferences.getDummystring()) portal_type='System Preference',
    dummystring_cache_disabled=system_preference_string)
    def test_suite(): system_preference.enable()
    suite = unittest.TestSuite() self.tic()
    suite.addTest(unittest.makeSuite(TestPreferences))
    return suite self.assertEqual(
    system_preference_string,
    portal_preferences.getDummystringCacheDisabled())
    system_preference.setDummystringCacheDisabled("changed")
    self.tic()
    self.assertEqual(
    "changed",
    portal_preferences.getDummystringCacheDisabled())
    clearAllCache.assert_not_called()
    clearCacheFactory.assert_not_called()
    Markdown is supported
    0% or
    You are about to add 0 people to the discussion. Proceed with caution.
    Finish editing this message first!
    Please register or to comment
    GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7