core/module.py

   1 # synarere -- a highly modular and stable IRC bot.
   2 # Copyright (C) 2010 Michael Rodriguez.
   3 # Rights to this code are documented in docs/LICENSE.
   4
   5 '''Module operations.'''
   6
   7 # Import required Python function.
   8 from imp import load_source
   9
  10 # Import required core modules.
  11 import logger, var, event
  12
  13 def load(module):
  14     '''Load a module.'''
  15
  16     try:
  17         mod = load_source(module, module)
  18     except ImportError, e:
  19         logger.error('Unable to load module %s: %s' % (module, e))
  20         return
  21
  22     # Check to make sure the module has init/fini functions.
  23     if not hasattr(mod, 'module_init'):
  24         logger.error('Unable to use module %s: No entry point has been defined.' % mod.__name__)
  25         return
  26
  27     if not hasattr(mod, 'module_fini'):
  28         logger.error('Unable to use module %s: No exit point has been defined.' % mod.__name__)
  29         return
  30
  31     mod.module_init()
  32     logger.info('Module %s loaded.' % mod.__name__)
  33
  34     # Add the module to the loaded modules list.
  35     var.modules_loaded.append(mod)
  36     event.dispatch('OnModuleLoad', module)
  37
  38 def unload(module):
  39     '''Unload a module.'''
  40
  41     # Make sure it is in the modules loaded list.
  42     if module not in var.modules_loaded:
  43         logger.warning('%s is not in the loaded modules list.' % module)
  44         return
  45
  46     module.module_fini()
  47
  48     # Remove the module from the loaded modules list.
  49     var.modules_loaded.remove(module)
  50     event.dispatch('OnModuleUnload', module)
  51
  52 def load_all():
  53     '''Load all modules listed in the configuration.'''
  54
  55     for i in var.conf.get('module'):
  56         name = i.get('name')
  57
  58         if name != None:
  59            load(name)
  60
  61         event.dispatch('OnLoadAllModules', name)
  62
  63 def unload_all():
  64     '''Unload all loaded modules.'''
  65
  66     logger.info('Unloading all modules.')
  67
  68     for i in var.modules_loaded:
  69         unload(i)
  70
  71     event.dispatch('OnUnloadAllModules')