Changeset 9754 for branches/plugin-system/src/plugins/pluginmanager.py

Timestamp:

06/03/08 15:40:27 (6 months ago)

Author:

vardo

Message:

Added plug-in deactivation mechanism, which allows plug-ins to clean up after themselves (eg. disconnecting handlers made in GUI); GUI extension points handlers are removed from list.

Updated Length Notifier plug-in so that it can be properly deactivated.

Files:

• branches/plugin-system/src/plugins/pluginmanager.py (modified) (7 diffs)

branches/plugin-system/src/plugins/pluginmanager.py

@@ -50 +50 @@
         :todo: implement mechanism to dynamically load plugins where GUI extension
                    points have been already called (i.e. when plugin is activated
-                   after GUI object creation)
+                   after GUI object creation). [DONE?]
         :todo: implement mechanism to dynamically deactive plugins (call plugin's
-                   deactivation handler)
+                   deactivation handler) [DONE?]
+        :todo: when plug-in is deactivated all GUI extension points are removed
+                   from `PluginManager.gui_extension_points_handlers`. But when
+                   object that invoked GUI extension point is abandoned by Gajim, eg.
+                   closed ChatControl object, the reference to called GUI extension
+                   points is still in `PluginManager.gui_extension_points`. These
+                   should be removed, so that object can be destroyed by Python.
+                   Possible solution: add call to clean up method in classes
+                   'destructors' (classes that register GUI extension points)
         '''
         
         __metaclass__ = Singleton
 
-        @log_calls('PluginManager')
+        #@log_calls('PluginManager')
         def __init__(self):
                 self.plugins = []
@@ -69 +77 @@
                 self.active_plugins = []
                 '''
-                Objectsof active plugins.
+                Instance objects of active plugins.
                 
                 These are object instances of classes held `plugins`, but only those
@@ -91 +99 @@
                 log.debug('plugins: %s'%(self.plugins))
 
-                #self._activate_all_plugins()
+                self.activate_all_plugins()
 
                 log.debug('active: %s'%(self.active_plugins))
@@ -134 +142 @@
 
         @log_calls('PluginManager')
-        def _activate_plugin(self, plugin):
+        def activate_plugin(self, plugin):
                 '''
                 :param plugin: plugin to be activated
@@ -151 +159 @@
 
                 return success
+        
+        def deactivate_plugin(self, plugin_object):
+                # detaching plug-in from handler GUI extension points (calling
+                # cleaning up method that must be provided by plug-in developer
+                # for each handled GUI extension point)
+                for gui_extpoint_name, gui_extpoint_handlers in \
+                                plugin_object.gui_extension_points.iteritems():
+                        for gui_extension_point_args in self.gui_extension_points[gui_extpoint_name]:
+                                gui_extpoint_handlers[1](*gui_extension_point_args)
+                                
+                # remove GUI extension points handlers (provided by plug-in) from
+                # handlers list
+                for gui_extpoint_name, gui_extpoint_handlers in \
+                                plugin_object.gui_extension_points.iteritems():
+                        self.gui_extension_points_handlers[gui_extpoint_name].remove(gui_extpoint_handlers)
+                        
+                # removing plug-in from active plug-ins list
+                self.active_plugins.remove(plugin_object)
+                
+        def deactivate_all_plugins(self):
+                for plugin_object in self.active_plugins:
+                        self.deactivate_plugin(plugin_object)
         
         @log_calls('PluginManager')
@@ -168 +198 @@
 
         @log_calls('PluginManager')
-        def _activate_all_plugins(self):
+        def activate_all_plugins(self):
                 '''
                 Activates all plugins in `plugins`.
@@ -176 +206 @@
                 self.active_plugins = []
                 for plugin in self.plugins:
-                        self._activate_plugin(plugin)
+                        self.activate_plugin(plugin)
 
         @staticmethod