Generalize the upgrade framework

Move upgrade code to the most common class: LanguageManager

Author: J. David Ibanez

LanguageManager.py

@@ -160,12 +160,22 @@ def get_selected_language(self, **kw):
 
     def filtered_manage_options(self, REQUEST=None):
         options = Tabs.filtered_manage_options(self, REQUEST=REQUEST)
+
+        # Insert the upgrade form if needed
+        if self._needs_upgrade():
+            options.insert(0,
+                {'action': 'manage_upgradeForm',
+                 'label': u'Upgrade',
+                 'help': ('Localizer', 'LM_upgrade.stx')})
+
+        # Translate the labels
         r = []
         for option in options:
             option = option.copy()
             option['label'] = _(option['label'])
             r.append(option)
 
+        # Ok
         return r
 
 
@@ -212,4 +222,31 @@ def manage_changeDefaultLang(self, language, REQUEST=None, RESPONSE=None):
     manage_page_header = LocalDTMLFile('ui/manage_page_header', globals())
 
 
+    ########################################################################
+    # Upgrade
+    def _needs_upgrade(self):
+        return False
+
+
+    def _upgrade(self):
+        pass
+
+
+    security.declarePublic('need_upgrade')
+    def need_upgrade(self):
+        """ """
+        return self._needs_upgrade()
+
+
+    security.declareProtected(
+        'Manage Access Rules', 'manage_upgradeForm', 'manage_upgrade')
+    manage_upgradeForm = LocalDTMLFile('ui/LM_upgrade', globals())
+    def manage_upgrade(self, REQUEST, RESPONSE):
+        """ """
+        self._upgrade()
+        RESPONSE.redirect('manage_main')
+
+
+
+
 InitializeClass(LanguageManager)

LocalPropertyManager.py

@@ -26,7 +26,6 @@
 from LanguageManager import LanguageManager
 from LocalAttributes import LocalAttribute, LocalAttributesBase
 from LocalFiles import LocalDTMLFile
-from utils import needs_upgrade
 
 
 # FIXME
@@ -63,10 +62,6 @@ def getLocalPropertyManager(self):
         return self
 
     manage_options = (
-        {'action': 'manage_upgradeForm',
-         'filter': needs_upgrade,
-         'label': u'Upgrade',
-         'help': ('Localizer', 'LPM_upgrade.stx')},
         {'action': 'manage_localPropertiesForm',
          'label': u'Local properties',
          'help': ('Localizer', 'LPM_properties.stx')},
@@ -279,15 +274,11 @@ def get_default_language(self):
 
 
     # Upgrading..
-    security.declarePublic('need_upgrade')
-    def need_upgrade(self):
-        """ """
+    def _needs_upgrade(self):
         return hasattr(self.aq_base, 'original_language')
 
 
-    manage_upgradeForm = LocalDTMLFile('ui/LPM_upgrade', globals())
-    def manage_upgrade(self, REQUEST=None, RESPONSE=None):
-        """ """
+    def _upgrade(self):
         # In version 0.7 the language management logic moved to the
         # mixin class LanguageManager, as a consequence the attribute
         # "original_language" changes its name to "_default_language".
@@ -307,9 +298,6 @@ def manage_upgrade(self, REQUEST=None, RESPONSE=None):
 ##                    self._local_properties[k][i] = (j, time())
 ##        self._p_changed = 1
 
-        if REQUEST is not None:
-            return self.manage_main(self, REQUEST)
-
 
     # Define <id>_<lang> attributes, useful for example to catalog
     def __getattr__(self, name):

Localizer.py

@@ -31,7 +31,7 @@
 # Import Localizer modules
 from LocalFiles import LocalDTMLFile
 from MessageCatalog import MessageCatalog
-from utils import lang_negotiator, needs_upgrade
+from utils import lang_negotiator
 from LanguageManager import LanguageManager
 
 
@@ -65,12 +65,8 @@ class Localizer(LanguageManager, Folder):
 
     security = ClassSecurityInfo()
 
-    manage_options = (
-        {'action': 'manage_upgradeForm',
-         'filter': needs_upgrade,
-         'label': u'Upgrade',
-         'help': ('Localizer', 'Localizer_upgrade.stx')},
-        Folder.manage_options[0]) \
+    manage_options = \
+        (Folder.manage_options[0],) \
         + LanguageManager.manage_options \
         + Folder.manage_options[1:]
 
@@ -82,6 +78,10 @@ def __init__(self, title, languages):
         self._default_language = languages[0]
 
 
+    #######################################################################
+    # API / Private
+    #######################################################################
+
     # Hook/unhook the traversal machinery
     # Support for copy, cut and paste operations
     def manage_beforeDelete(self, item, container):
@@ -101,6 +101,20 @@ def _getCopy(self, container):
         return Localizer.inheritedAttribute('_getCopy')(self, container)
 
 
+    def _needs_upgrade(self):
+        return not self.hooked()
+
+
+    def _upgrade(self):
+        # Upgrade to 0.9
+        if not self.hooked():
+            self.manage_hook(1)
+
+
+    #######################################################################
+    # API / Public
+    #######################################################################
+
     # Get some data
     security.declarePublic('get_supported_languages')
     def get_supported_languages(self):
@@ -233,23 +247,4 @@ def changeLanguage(self, lang, goto=None, expires=None):
         response.redirect(goto)
 
 
-    # Upgrading..
-    security.declarePublic('need_upgrade')
-    def need_upgrade(self):
-        """ """
-        return not self.hooked()
-
-
-    security.declareProtected('Manage Access Rules',
-                              'manage_upgradeForm', 'manage_upgrade')
-    manage_upgradeForm = LocalDTMLFile('ui/Localizer_upgrade', globals())
-    def manage_upgrade(self, REQUEST, RESPONSE):
-        """ """
-        # Upgrade to 0.9
-        if not self.hooked():
-            self.manage_hook(1)
-
-        RESPONSE.redirect('manage_main')
-
-
 InitializeClass(Localizer)

help/LM_upgrade.stx

@@ -0,0 +1,12 @@
+Localizer - Upgrade LocalPropertyManager
+
+  Description
+
+    This view allows to upgrade an object when a new version of its class
+    has been installed that requires changes to the object.
+
+    This feature is specific to the Localizer product.
+
+  Controls
+
+    Upgrade -- Upgrades the object.

help/LPM_upgrade.stx

@@ -5,7 +5,7 @@
 <dtml-if need_upgrade>
   <p class="form-help">
     <dtml-gettext>
-      This <tt>Localizer</tt> object needs to be upgraded.
+      This object must be upgraded.
     </dtml-gettext>
   </p>
 
@@ -18,7 +18,7 @@
 <dtml-else>
   <p class="form-help">
     <dtml-gettext>
-      This <tt>Localizer</tt> object doesn't need to be upgraded.
+      This object is up-to-date.
     </dtml-gettext>
   </p>
 </dtml-if>

help/Localizer_upgrade.stx

@@ -57,13 +57,6 @@ def lang_negotiator(available_languages):
 init_language_selector(lang_negotiator)
 
 
-###########################################################################
-# Upgrade
-###########################################################################
-def needs_upgrade(obj):
-    return obj.need_upgrade()
-
-
 ###########################################################################
 # Provide an API to access translations stored as MO files in the 'locale'
 # directory.