src/lib/backupninja/handlers/__init__.py

   1 #
   2 #    Backupninja python reimplementation, based on original backupninja program
   3 #    by riseup.net.
   4 #    Copyright (C) 2010  Matthijs Kooijman <matthijs@stdin.nl>
   5 #
   6 #    This program is free software; you can redistribute it and/or modify
   7 #    it under the terms of the GNU General Public License as published by
   8 #    the Free Software Foundation; either version 2 of the License, or
   9 #    (at your option) any later version.
  10 #
  11 #    This program is distributed in the hope that it will be useful,
  12 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 #    GNU General Public License for more details.
  15 #
  16 #    You should have received a copy of the GNU General Public License along
  17 #    with this program; if not, write to the Free Software Foundation, Inc.,
  18 #    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 """ Action superclass with common functionality """
  21
  22 import sys, ConfigParser
  23 import logging as log
  24
  25 from backupninja import config
  26
  27 class Action(object):
  28     """
  29     Subclasses of Action represent handlers for various action types.
  30     This class is called Action instead of Handler, since even though the
  31     classes could be referred to as handlers, the instances of this
  32     class are really actions (i.e., it represents a specific action,
  33     which is a combination of a action type and a specific action
  34     configuration).
  35     """
  36     def __init__(self):
  37         # Subclasses should overwrite this with their default config
  38         # See backupninja.config.load_config for the structure of this
  39         # value.
  40         self.default_config = {}
  41         # Assume we'll run succesfully. If anything fails in the
  42         # meanwhile, set this to True.
  43         self.failed = False
  44
  45     def run(self, **kwargs):
  46         """
  47         Run this action for a single target. Override this method
  48         in a subclass
  49         """
  50         pass
  51
  52     def finish(self, **kwargs):
  53         """
  54         Called when all targets have been processed. Can be overridden
  55         in a subclass.
  56         """
  57         pass
  58
  59     def load_config(self, filename):
  60         """
  61         Load the configuration for this action from the given filename.
  62         """
  63         self.conf = config.load_config(filename, self.default_config)
  64
  65     def get_config_optional(self, section, option):
  66         """
  67         Returns the value of the given option. If the option was not set
  68         (and no default was set in self.default_config), return None.
  69
  70         This is a convenience wrapper for ConfigParser.get(), since that
  71         throws an exception on unset options.
  72         """
  73         try:
  74             return self.conf.get(section, option)
  75         except ConfigParser.NoOptionError:
  76             return None
  77
  78     def get_config_mandatory(self, section, option):
  79         """
  80         Returns the value of the given option. If the option was not set
  81         (and no default was set in self.default_config), raises a
  82         backupninja.config.ConfigError.
  83
  84         This is a convenience wrapper for ConfigParser.get(), since that
  85         has a very generic exception message on unknown options.
  86         """
  87         try:
  88             return self.conf.get(section, option)
  89         except ConfigParser.NoOptionError:
  90             raise config.ConfigError("Option '%s' in section '%s' is mandatory, please configure it" % (option, section))
  91
  92 def create_action(ty):
  93     """
  94     Create a new (subclass of) Action object for an action with the
  95     given type.
  96
  97     If the handler class for this type cannot be loaded, an exception is
  98     thrown.
  99     """
 100     modname = 'backupninja.handlers.%s' % ty
 101     # Load the handler if it is not loaded yet
 102     if not modname in sys.modules:
 103         log.debug('Loading handler for type "%s"', ty)
 104         try:
 105             __import__(modname, globals(), locals(), [])
 106         except ImportError, e:
 107             # Add some extra info, since the default exception does not
 108             # show the full module name.
 109             raise ImportError('Cannot load module %s: %s' % (modname, e))
 110         log.debug('Loaded handler for type "%s" from "%s"', ty, sys.modules[modname].__file__)
 111     # Get the module from the module table
 112     module = sys.modules[modname]
 113
 114     # Check that the module has a "handler" top level function, which
 115     # should create a new Action object.
 116     if not hasattr(module, 'handler'):
 117         raise ImportError('%s is not valid: it '
 118                           'does not have a "handler" top level function.'
 119                           % (module.__file__))
 120
 121     # Call the "handler" function to create the actual action
 122     action = module.handler()
 123
 124     # Check if the handler returned is really a subclass of Action
 125     if not isinstance(action, Action):
 126         raise TypeError('%s is not valid, %s.handler did not return a '
 127                         'subclass of backupninja.handlers.Handler.'
 128                         % (module.__file__, modname))
 129     return action