Changeset 9737

Timestamp:

06/02/08 01:33:51 (3 months ago)

Author:

vardo

Message:

Initial commit related to plug-in system:
- basic PluginManager? class that loads plugins from *.py files

in given directories

- Singleton metaclass was created to use with PluginManager?;

notice: init of class is called only once (not like in code

that is included in Python Cookbook)

- variable to keep paths of plugin directories has been created

(common.gajim.PLUGINS_DIRS); also added initilization of these
paths to common.ConfigPaths?

- added global variable with PluginManager? object:

common.gajim.plugin_manager

- created customized logger for plugin system ('gajim.plugin_system')
- created function decorator plugins.helpers.log_calls which logs

each call of function/method; it also logs when function is left

- base class Plugin for plug-in implementation added; not much

here - only empty class attributes: name, short_name, authors,

version, description

- based on Plugin class, first plugin was created named

LengthNotifierPlugin?; it is used to notify users when they
exceed given length of message during writing it (text entry
field highlights)

- first GUI extension points works when ChatControl? object

is created (it is used in mentioned plugin)

- added 'epydoc.conf' file customized a little bit (file

is also in trunk now)

- fixed indentation in common.sleepy module (also in trunk

now)

Location:

branches/plugin-system

Files:

• epydoc.conf (added)
• plugins (added)
• plugins/length_notifier.py (added)
• src/chat_control.py (modified) (1 diff)
• src/common/configpaths.py (modified) (1 diff)
• src/common/gajim.py (modified) (2 diffs)
• src/common/sleepy.py (modified) (1 diff)
• src/gajim.py (modified) (1 diff)
• src/plugins (added)
• src/plugins/helpers.py (added)
• src/plugins/__init__.py (added)
• src/plugins/pluginmanager.py (added)
• src/plugins/plugin.py (added)
• test (added)
• test/test_pluginmanager.py (added)

branches/plugin-system/src/chat_control.py

@@ -1140 +1140 @@
                 # restore previous conversation
                 self.restore_conversation()
+                
+                gajim.plugin_manager.gui_extension_point('chat_control', self)
 
         def on_avatar_eventbox_enter_notify_event(self, widget, event):

branches/plugin-system/src/common/configpaths.py

@@ -93 +93 @@
                 self.add('HOME', fse(os.path.expanduser('~')))
                 self.add('TMP', fse(tempfile.gettempdir()))
+                
+                # dirs for plugins
+                self.add('PLUGINS_BASE', os.path.join(u'..', windowsify(u'plugins')))
+                self.add_from_root('PLUGINS_USER', u'plugins')
 
                 try:

branches/plugin-system/src/common/gajim.py

@@ -62 +62 @@
 verbose = False
 ipython_window = None
+plugin_manager = None
 
 h = logging.StreamHandler()
@@ -86 +87 @@
 DATA_DIR = gajimpaths['DATA']
 HOME_DIR = gajimpaths['HOME']
+PLUGINS_DIRS = [gajimpaths['PLUGINS_BASE'],
+                                gajimpaths['PLUGINS_USER']]
 
 try:

branches/plugin-system/src/common/sleepy.py

@@ -36 +36 @@
 SUPPORTED = True
 try:
-                if os.name == 'nt':
-                        import ctypes
+        if os.name == 'nt':
+                import ctypes
 
-                        GetTickCount = ctypes.windll.kernel32.GetTickCount
-                        GetLastInputInfo = ctypes.windll.user32.GetLastInputInfo
+                GetTickCount = ctypes.windll.kernel32.GetTickCount
+                GetLastInputInfo = ctypes.windll.user32.GetLastInputInfo
 
-                        class LASTINPUTINFO(ctypes.Structure):
-                                _fields_ = [('cbSize', ctypes.c_uint), ('dwTime', ctypes.c_uint)]
+                class LASTINPUTINFO(ctypes.Structure):
+                        _fields_ = [('cbSize', ctypes.c_uint), ('dwTime', ctypes.c_uint)]
 
-                        lastInputInfo = LASTINPUTINFO()
-                        lastInputInfo.cbSize = ctypes.sizeof(lastInputInfo)
+                lastInputInfo = LASTINPUTINFO()
+                lastInputInfo.cbSize = ctypes.sizeof(lastInputInfo)
 
-                elif sys.platform == 'darwin':
-                        import osx.idle as idle
-                else: # unix
-                        import idle
+        elif sys.platform == 'darwin':
+                import osx.idle as idle
+        else: # unix
+                import idle
 except:
         gajim.log.debug('Unable to load idle module')

branches/plugin-system/src/gajim.py

@@ -3462 +3462 @@
                 gobject.timeout_add_seconds(gajim.config.get(
                         'check_idle_every_foo_seconds'), self.read_sleepy)
+                
+                # Creating plugin manager
+                import plugins
+                gajim.plugin_manager = plugins.PluginManager()
 
 if __name__ == '__main__':