Changeset f9798f in indico

Timestamp:

04/27/12 15:39:28 (13 months ago)

Author:

Jose Benito <jose.benito.gonzalez@…>

Branches:

master, hello-world-walkthrough, ipv6, v0.98-series, v0.98.2, v0.98.3, v0.99, 051b2622c51afb171a1dedb46a0df4fbb0cbd02e, d9941f8582b36b24821a11ea5ba16fda6a457fb1

Children:

c06c72

Parents:

d71fd2

git-author:

Matthew Pugh <matthew.alexander.pugh@…> (04/27/12 14:48:06)

git-committer:

Jose Benito <jose.benito.gonzalez@…> (04/27/12 15:39:28)

Message:

[FIX] Disable Stats when plugin disabled.

• Stats Register is now aware if any or no plugins are active.
• Only contributes to SideMenu? when active implementations.
• No code injection on disactive plugins.

Location:

indico/ext/statistics

Files:

• chrome.py (modified) (3 diffs)
• register.py (modified) (4 diffs)

indico/ext/statistics/chrome.py

@@ -46 +46 @@
     def fillManagementSideMenu(cls, obj, params={}):
         if obj._conf.canModify(obj._rh._aw):
-            params['Statistics'] = wcomponents.SideMenuItem(_('Statistics'),
-                UHConfModifStatistics.getURL(obj._conf))
+
+            if StatisticsRegister().hasActivePlugins():
+                params['Statistics'] = wcomponents.SideMenuItem(_('Statistics'),
+                    UHConfModifStatistics.getURL(obj._conf))
 
 
@@ -60 +62 @@
         """
         stats = PluginsHolder().getPluginType('statistics')
-
-        if not stats.isActive():
+        register = StatisticsRegister()
+
+        if not stats.isActive() or not register.hasActivePlugins():
             return False
 
-        register = StatisticsRegister()
         key = 'extraFooterContent'
         extension = {}
@@ -174 +176 @@
         self._conf = self._rh._conf
         self._register = StatisticsRegister()
-        self._plugins = self._register.getAllPlugins()
+        self._plugins = self._register.getAllPlugins(activeOnly=True)
         self._templateClass = templateClass
         self._extraJS = []

indico/ext/statistics/register.py

@@ -63 +63 @@
         self._buildRegister()
 
-    def getAllPlugins(self, instantiate=True):
+
+    def hasActivePlugins(self):
+        """
+        Returns True only if any implementations are active in the PluginsHolder
+        """
+
+        activePlugins = list(p for p in self.getAllPlugins(True) if p.isActive())
+
+        # The resultant activePlugins is only True if there are any plugins.
+        return bool(activePlugins)
+
+    def getAllPlugins(self, instantiate=True, activeOnly=False):
         """
         Returns a list of all plugin class registered, if instantiate is
-        True, instates all objects before appending to the list.
+        True, instates all objects before appending to the list. By default
+        this method only returns active implementations, however all implementations
+        may be returned by setting activeOnly to True.
         """
         result = []
@@ -72 +85 @@
         if instantiate:
             for plugin in self._getRegister().values():
+
+                if activeOnly and not plugin().isActive():
+                    continue
+
                 result.append(plugin())
         else:
-            result = self._getRegister().values()
+            if activeOnly:
+                result = list(p for p in self._getRegister().values() if p().isActive())
+            else:
+                result = self._getRegister().values()
 
         return result
@@ -84 +104 @@
         return self._getRegister().keys()
 
-    def getAllPluginJSHooks(self, extra=None):
+    def getAllPluginJSHooks(self, extra=None, includeInactive=False):
         """
         Returns a list of JSHook objects which contain the parameters
@@ -94 +114 @@
 
         for plugin in self.getAllPlugins(True):
+
+            if not includeInactive and not plugin.isActive():
+                continue
 
             if extra is not None: