main: Add action loading and running infrastructure.
[matthijs/projects/backupninja.git] / src / lib / backupninja / action.py
1 # -*- mode: python; sh-basic-offset: 4; indent-tabs-mode: nil; -*-
2 # vim: set filetype=python sw=4 sts=4 expandtab autoindent:
3 #
4 #    Backupninja python reimplementation, based on original backupninja program
5 #    by riseup.net.
6 #    Copyright (C) 2010  Matthijs Kooijman <matthijs@stdin.nl>
7 #
8 #    This program is free software; you can redistribute it and/or modify
9 #    it under the terms of the GNU General Public License as published by
10 #    the Free Software Foundation; either version 2 of the License, or
11 #    (at your option) any later version.
12 #
13 #    This program is distributed in the hope that it will be useful,
14 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
15 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 #    GNU General Public License for more details.
17 #
18 #    You should have received a copy of the GNU General Public License along
19 #    with this program; if not, write to the Free Software Foundation, Inc.,
20 #    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21
22 """ Running backup actions """
23
24 from backupninja import config
25 from backupninja import handlers
26
27 def run_all_actions(opts, global_config):
28     """
29     Run all defined actions.
30
31     opts are the parsed commandline options, global_config is the parsed
32     global configuration.
33     """
34     actions = config.list_actions(opts)
35
36     for action in actions:
37         run_action(action, opts, global_config)
38
39 def run_action(action, opts, global_config):
40     """
41     Run a single action. opts are the parsed commandline options,
42     global_config is the parsed global configuration.
43     """
44     # Split the action filename
45     parts = action.split('.', 2)
46     if (len(parts) < 2):
47         log.error('Invalid action filename: "%s". Should be in the form name.type, where type is a valid handler.')
48         return
49     (action_name, action_ty) = parts
50
51     # Get the config for this action
52     action_config = config.get_action_config(opts, action)
53     # Create a handler for this action
54     handler = handlers.create_handler(action_ty, action_config)
55
56     if handler:
57         # Run the handler
58         handler.run()
59         handler.finish()
60     # Silently skip invalid handlers, create_handler will have
61     # logged an error