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

Timestamp:

06/18/08 22:45:22 (6 months ago)

Author:

vardo

Message:

Added new 'init' method to Plugin class that plugins can implement to make actions that need to be done only once - when plugin is added (not activated) to Gajim. In this method plugins should declare handlers for GUI extension points. This was created so that init method doesn't have to be reimplemented in specific way (create config, load config) - it is all done by init in Plugin class. If init is reimplemented, it must call Plugin init (eg. using super() ) to plugin work properly.

Example plug-ins were modified to use init() instead of init().

Added new category in configuration - 'plugins'. It only holds one option for each plugin - 'active', which determines whether plugin should be activated on startup.

Now, Gajim remembers which plugins are active on exit, and activates them on next startup.

Files:

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

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

@@ -20 +20 @@
 
 :author: Mateusz Biliński <mateusz@bilinski.it>
-:since: 05/30/2008
+:since: 30th May 2008
 :copyright: Copyright (2008) Mateusz Biliński <mateusz@bilinski.it>
 :license: GPL
@@ -95 +95 @@
 
                 for path in gajim.PLUGINS_DIRS:
-                        self._add_plugins(PluginManager.scan_dir_for_plugins(path))
+                        self.add_plugins(PluginManager.scan_dir_for_plugins(path))
 
                 log.debug('plugins: %s'%(self.plugins))
 
-                self.activate_all_plugins()
+                self._activate_all_plugins_from_global_config()
 
                 log.debug('active: %s'%(self.active_plugins))
 
-                
-        @log_calls('PluginManager')
-        def _add_plugin(self, plugin_class):
+        @log_calls('PluginManager')
+        def _plugin_has_entry_in_global_config(self, plugin):
+                if gajim.config.get_per('plugins', plugin.short_name) is None:
+                        return False
+                else:
+                        return True
+        
+        @log_calls('PluginManager')
+        def _create_plugin_entry_in_global_config(self, plugin):
+                gajim.config.add_per('plugins', plugin.short_name)
+                
+        @log_calls('PluginManager')
+        def add_plugin(self, plugin_class):
                 '''
                 :todo: what about adding plug-ins that are already added? Module reload
                 and adding class from reloaded module or ignoring adding plug-in?
                 '''
-                plugin_class._active = False
-                plugin_class._instance = None
-                self.plugins.append(plugin_class)
-        
-        @log_calls('PluginManager')
-        def _add_plugins(self, plugin_classes):
+                plugin = plugin_class()
+                if not self._plugin_has_entry_in_global_config(plugin):
+                        self._create_plugin_entry_in_global_config(plugin)
+                        
+                self.plugins.append(plugin)
+                plugin.active = False
+        
+        @log_calls('PluginManager')
+        def add_plugins(self, plugin_classes):
                 for plugin_class in plugin_classes:
-                        self._add_plugin(plugin_class)
+                        self.add_plugin(plugin_class)
                 
         @log_calls('PluginManager')
@@ -157 +170 @@
 
         @log_calls('PluginManager')
-        def activate_plugin(self, plugin_class):
+        def activate_plugin(self, plugin):
                 '''
                 :param plugin: plugin to be activated
                 :type plugin: class object of `GajimPlugin` subclass
-                '''
-                
-                plugin_object = plugin_class()
-
-                success = True
-
-                self._add_gui_extension_points_handlers_from_plugin(plugin_object)
-                self._handle_all_gui_extension_points_with_plugin(plugin_object)
-
-                if success:
-                        self.active_plugins.append(plugin_object)
-                        plugin_object.activate()
-                        plugin_class._instance = plugin_object
-                        plugin_class._active = True
+                
+                :todo: success checks should be implemented using exceptions. Such
+                        control should also be implemented in deactivation.
+                '''
+                success = False
+                if not plugin.active:
+        
+                        self._add_gui_extension_points_handlers_from_plugin(plugin)
+                        self._handle_all_gui_extension_points_with_plugin(plugin)
+                        
+                        success = True
+                        
+                        if success:
+                                self.active_plugins.append(plugin)
+                                plugin.activate()
+                                self._set_plugin_active_in_global_config(plugin)
+                                plugin.active = True
 
                 return success
         
-        def deactivate_plugin(self, plugin_object):
+        def deactivate_plugin(self, plugin):
                 # 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():
+                                plugin.gui_extension_points.iteritems():
                         if gui_extpoint_name in self.gui_extension_points:
                                 for gui_extension_point_args in self.gui_extension_points[gui_extpoint_name]:
@@ -191 +207 @@
                 # handlers list
                 for gui_extpoint_name, gui_extpoint_handlers in \
-                                plugin_object.gui_extension_points.iteritems():
+                                plugin.gui_extension_points.iteritems():
                         self.gui_extension_points_handlers[gui_extpoint_name].remove(gui_extpoint_handlers)
                         
                 # removing plug-in from active plug-ins list
-                plugin_object.deactivate()
-                self.active_plugins.remove(plugin_object)
-                plugin_object.__class__._active = False
-                plugin_object.__class__._instance = None
-                del plugin_object
-                
-        def deactivate_all_plugins(self):
+                plugin.deactivate()
+                self.active_plugins.remove(plugin)
+                self._set_plugin_active_in_global_config(plugin, False)
+                plugin.active = False
+                
+        def _deactivate_all_plugins(self):
                 for plugin_object in self.active_plugins:
                         self.deactivate_plugin(plugin_object)
         
         @log_calls('PluginManager')
-        def _add_gui_extension_points_handlers_from_plugin(self, plugin_object):
+        def _add_gui_extension_points_handlers_from_plugin(self, plugin):
                 for gui_extpoint_name, gui_extpoint_handlers in \
-                                plugin_object.gui_extension_points.iteritems():
+                                plugin.gui_extension_points.iteritems():
                         self.gui_extension_points_handlers.setdefault(gui_extpoint_name, []).append(
                                         gui_extpoint_handlers)
         
         @log_calls('PluginManager')
-        def _handle_all_gui_extension_points_with_plugin(self, plugin_object):
+        def _handle_all_gui_extension_points_with_plugin(self, plugin):
                 for gui_extpoint_name, gui_extpoint_handlers in \
-                                plugin_object.gui_extension_points.iteritems():
+                                plugin.gui_extension_points.iteritems():
                         if gui_extpoint_name in self.gui_extension_points:
                                 for gui_extension_point_args in self.gui_extension_points[gui_extpoint_name]:
@@ -221 +236 @@
 
         @log_calls('PluginManager')
-        def activate_all_plugins(self):
+        def _activate_all_plugins(self):
                 '''
                 Activates all plugins in `plugins`.
@@ -227 +242 @@
                 Activated plugins are appended to `active_plugins` list.
                 '''
-                self.active_plugins = []
+                #self.active_plugins = []
                 for plugin in self.plugins:
                         self.activate_plugin(plugin)
+                        
+        def _activate_all_plugins_from_global_config(self):
+                for plugin in self.plugins:
+                        if self._plugin_is_active_in_global_config(plugin):
+                                self.activate_plugin(plugin)
+                
+        def _plugin_is_active_in_global_config(self, plugin):
+                return gajim.config.get_per('plugins', plugin.short_name, 'active')
+        
+        def _set_plugin_active_in_global_config(self, plugin, active=True):
+                gajim.config.set_per('plugins', plugin.short_name, 'active', active)
 
         @staticmethod