summaryrefslogtreecommitdiffstats
path: root/pyfirstaidkit/interpret.py
blob: 17cb99e44dfa1eadcdfafa9d288cd08caadffd4b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# First Aid Kit - diagnostic and repair tool for Linux
# Copyright (C) 2007 Martin Sivak <msivak@redhat.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

import os
import sys
from plugins import PluginSystem
from reporting import Reports, TASKER, PLUGINSYSTEM, FIRSTAIDKIT
import logging
import copy
from errors import *
from utils import FileBackupStore
from dependency import Dependencies
from configuration import Info

class Tasker:
    """The main interpret of tasks described in Config object"""

    name = "Task interpreter"

    def __init__(self, cfg, reporting = None, dependencies = None,
            backups = None, pluginsystem = None):
        self._config = cfg
        self._running = True

        if dependencies is None:
            self._provide = Dependencies()
        else:
            self._provide = dependencies

        if reporting is None:
            self._reporting = Reports()
        else:
            self._reporting = reporting

        if backups is None:
            if cfg.backup.fullpath:
                # rootpath is silly if fullpath is set by user.
                cfg.backup.rootpath = ""

            self._backups = FileBackupStore(rootpath = cfg.backup.rootpath,
                    fullpath = cfg.backup.fullpath)
            cfg.backup.fullpath = self._backups._path
        else:
            self._backups = backups

        if pluginsystem is None:
            self.pluginSystem = PluginSystem(interpret = self, reporting = self._reporting,
                    dependencies = self._provide, backups = self._backups)
        else:
            self.pluginSystem = pluginsystem

    def interrupt(self):
        self._running = False
        self._reporting.info("You sent an interrupt signal to "
                "Tasker! This is not recommended.", level = TASKER,
                origin = self, importance = logging.WARNING)

    def continuing(self):
        return self._running

    def flags(self):
        return self._provide

    def reporting(self):
        return self._reporting

    def pluginsystem(self):
        return self.pluginSystem

    def end(self):
        """Signalize end of operations to all necessary places"""
        self._reporting.end(level = FIRSTAIDKIT)

    def run(self):
        self._reporting.start(level = TASKER, origin = self)
        pluginSystem = self.pluginSystem

        # Reset the flag state
        self._provide.reset()

        # Check the root privilegies
        if os.geteuid() == 0:
            self._reporting.info("You are running the firstaidkit as root.",
                    level = TASKER, origin = self, importance = logging.WARNING)
            self._provide.provide("root")
        else:
            self._reporting.info("You are not running the firstaidkit as "
                    "root.  Some plugins may not be available.", level = TASKER,
                    origin = self, importance = logging.WARNING)
            self._provide.unprovide("root")

        #initialize the startup set of flags
        for flag in self._config.operation._list("flags"):
            self._provide.provide(flag)

        # For the auto, auto-flow, plugin, flow cases.
        if self._config.operation.mode in ("auto", "auto-flow", "plugin",
                "flow"):

            if self._config.operation.mode == "plugin":
                pluginlist = self._config.operation._list("plugin")
            else:
                pluginlist = set(pluginSystem.list())

            if self._config.operation.mode == "auto-flow":
                flows = len(pluginlist)*[self._config.operation.flow]
            elif self._config.operation.mode == "flow":
                flows = self._config.operation._list("flow")
                pluginlist = self._config.operation._list("plugin")
            else:
                flows = len(pluginlist)*[None]

            #iterate through plugins until there is no plugin left or no
            #action performed during whole iteration
            oldlist = set()
            actlist = set(zip(pluginlist, flows))

            self._running = True
            while self._running and len(actlist)>0 and oldlist!=actlist:
                oldlist = copy.copy(actlist)

                for plugin,flow in oldlist:
                    #If interruption was requested, stop
                    if not self._running:
                        break
                    
                    #If plugin does not contain the automated flow or if
                    #it ran correctly, remove it from list
                    if ((flow and
                        not flow in pluginSystem.getplugin(plugin).getFlows())
                        or (not flow and
                            not pluginSystem.getplugin(plugin).default_flow in
                            pluginSystem.getplugin(plugin).getFlows())):

                        self._reporting.info("Plugin %s does not contain "
                                "flow %s"% (plugin, flow or \
                                pluginSystem.getplugin(plugin).default_flow,), \
                                level = TASKER, origin = self)

                        actlist.remove((plugin, flow))

                    elif (pluginSystem.autorun(plugin, flow = flow,
                            dependencies = self._config.operation.dependencies
                            != "False")):
                        actlist.remove((plugin, flow))

            #some plugins may not be called because of unfavorable flags
            if self._running:
                for plugin in set(map(lambda x: x[0], actlist)):
                    self._reporting.info("Plugin %s was not called because of "
                                         "unsatisfied dependencies"% (plugin,), level = TASKER, \
                                         origin = self, importance = logging.WARNING)

        # For the flags case
        elif self._config.operation.mode == "flags":
            self._reporting.table(self._provide.known(), level = TASKER,
                    origin = self, title = "List of flags")

        # For the list case
        elif self._config.operation.mode == "list":
            #get list of plugins
            rep = []
            for k in pluginSystem.list():
                p = pluginSystem.getplugin(k)
                flowinfo = [(f, p.getFlow(f).description) for f in p.getFlows()]
                rep.append((k, p.name, p.version, p.author, p.description,
                    p.default_flow, flowinfo))
            self._reporting.table(rep, level = TASKER, origin = self,
                    title = "List of plugins")

        # For the info case
        elif self._config.operation.mode == "info":
            #get info about plugin
            try:
                p = pluginSystem.getplugin(self._config.operation.params)
            except KeyError:
                self._reporting.info(message = "No such plugin '%s'" % \
                        (self._config.operation.params,), level = TASKER, \
                        origin = self)
                return False
            flowinfo = [ (f, p.getFlow(f).description) for f in p.getFlows() ]
            rep = {"id": self._config.operation.params, "name": p.name,
                    "version": p.version, "author": p.author,
                    "description": p.description, "flow": p.default_flow,
                    "flows": flowinfo}
            self._reporting.tree(rep, level = TASKER, origin = self,
                    title = "Information about plugin %s" % \
                            (self._config.operation.params,))

        # Any other case
        else:
            self._reporting.info(message = "Incorrect task specified", \
                    level = TASKER, origin = self)
            self._reporting.stop(level = TASKER, origin = self)
            return False

        if self._config.operation.printinfo:
            Info.write()

        self._reporting.stop(level = TASKER, origin = self)
        return True