X-Git-Url: https://git.stderr.nl/gitweb?p=matthijs%2Fprojects%2Fbackupninja.git;a=blobdiff_plain;f=src%2Flib%2Fbackupninja%2Fhandlers%2F__init__.py;h=72b30179a3a0017f9bfe3447b60d9e5d5365922a;hp=fb57bf43f01622000622a0c21f71056919bf9c70;hb=74f27713c34ce30c7eef87891f095a0d4bf15f50;hpb=00be52d4097dd5b4d35d50b102bfab824680c188

diff --git a/src/lib/backupninja/handlers/__init__.py b/src/lib/backupninja/handlers/__init__.py
index fb57bf4..72b3017 100644
--- a/src/lib/backupninja/handlers/__init__.py
+++ b/src/lib/backupninja/handlers/__init__.py
@@ -17,18 +17,31 @@
 #    with this program; if not, write to the Free Software Foundation, Inc.,
 #    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
-""" Handler superclass with common functionality """
+""" Action superclass with common functionality """
 
 import sys
 import logging as log
 
-class Handler(object):
-    def __init__(self, conf):
-        self.conf = conf
+from backupninja import config
+
+class Action(object):
+    """
+    Subclasses of Action represent handlers for various action types.
+    This class is called Action instead of Handler, since even though the
+    classes could be referred to as handlers, the instances of this
+    class are really actions (i.e., it represents a specific action,
+    which is a combination of a action type and a specific action
+    configuration).
+    """
+    def __init__(self):
+        # Subclasses should overwrite this with their default config
+        # See backupninja.config.load_config for the structure of this
+        # value.
+        self.default_config = {}
 
     def run(self, **kwargs):
         """
-        Run this handler for a single target. Override this method
+        Run this action for a single target. Override this method
         in a subclass
         """
         pass
@@ -40,12 +53,21 @@ class Handler(object):
         """
         pass
 
-def create_handler(ty, conf):
+    def load_config(self, filename):
+        """
+        Load the configuration for this action from the given filename.
+        """
+        self.conf = config.load_config(filename, self.default_config)
+
+        
+
+def create_action(ty):
     """
-    Create a new (subclass of) Handler object for an action with the
-    given type. conf is the configuration to pass to the handler.
+    Create a new (subclass of) Action object for an action with the
+    given type.
 
-    If the handler cannot be loaded, an exception is thrown.
+    If the handler class for this type cannot be loaded, an exception is
+    thrown.
     """
     modname = 'backupninja.handlers.%s' % ty
     # Load the handler if it is not loaded yet
@@ -62,18 +84,18 @@ def create_handler(ty, conf):
     module = sys.modules[modname]
 
     # Check that the module has a "handler" top level function, which
-    # should create a new Handler object.
+    # should create a new Action object.
     if not hasattr(module, 'handler'):
         raise ImportError('%s is not valid: it '
                           'does not have a "handler" top level function.' 
                           % (module.__file__))
 
-    # Call the "handler" function to create the actual handler
-    handler = module.handler(conf)
+    # Call the "handler" function to create the actual action
+    action = module.handler()
    
-    # Check if the handler returned is really a subclass of Handler
-    if not isinstance(handler, Handler):
+    # Check if the handler returned is really a subclass of Action
+    if not isinstance(action, Action):
         raise TypeError('%s is not valid, %s.handler did not return a '
                         'subclass of backupninja.handlers.Handler.'
                         % (module.__file__, modname))
-    return handler
+    return action