3 # Copyright (C) 2013 Simo Sorce <simo@redhat.com>
5 # see file 'COPYING' for use and warranty information
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
24 from ipsilon.util.data import Store
27 class Plugins(object):
30 self._providers_tree = None
32 def _load_class(self, tree, class_type, file_name):
33 cherrypy.log.error('Check module %s for class %s' % (file_name,
35 name, ext = os.path.splitext(os.path.split(file_name)[-1])
37 if ext.lower() == '.py':
38 mod = imp.load_source(name, file_name)
39 #elif ext.lower() == '.pyc':
40 # mod = imp.load_compiled(name, file_name)
43 except Exception, e: # pylint: disable=broad-except
44 cherrypy.log.error('Failed to load "%s" module: [%s]' % (name, e))
47 if hasattr(mod, class_type):
48 instance = getattr(mod, class_type)()
49 public_name = getattr(instance, 'name', name)
50 tree[public_name] = instance
51 cherrypy.log.error('Added module %s as %s' % (name, public_name))
53 def _load_classes(self, tree, path, class_type):
56 files = os.listdir(path)
57 except Exception, e: # pylint: disable=broad-except
58 cherrypy.log.error('No modules in %s: [%s]' % (path, e))
62 filename = os.path.join(path, name)
63 self._load_class(tree, class_type, filename)
65 def get_plugins(self, path, class_type):
67 self._load_classes(plugins, path, class_type)
71 class PluginLoader(object):
73 def __init__(self, baseobj, facility, plugin_type):
74 (whitelist, config) = Store().get_plugins_config(facility)
75 if cherrypy.config.get('debug', False):
76 cherrypy.log('[%s] %s: %s' % (facility, whitelist, config))
83 (pathname, dummy) = os.path.split(inspect.getfile(baseobj))
86 'available': p.get_plugins(pathname, plugin_type),
87 'whitelist': whitelist,
91 def get_plugin_data(self):
95 class PluginInstaller(object):
96 def __init__(self, baseobj):
97 (pathname, dummy) = os.path.split(inspect.getfile(baseobj))
98 self._pathname = pathname
100 def get_plugins(self):
102 return p.get_plugins(self._pathname, 'Installer')
105 class PluginObject(object):
113 def get_config_desc(self):
114 """ The configuration description is a dictionary that provides
115 A description of the supported configuration options, as well
116 as the default configuration option values.
117 The key is the option name, the value is an array of 3 elements:
124 def set_config(self, config):
125 self._config = config
127 def get_config_value(self, name):
130 value = self._config.get(name, None)
133 opt = self._options.get(name, None)
137 if cherrypy.config.get('debug', False):
138 cherrypy.log('[%s] %s: %s' % (self.name, name, value))
142 def set_config_value(self, option, value):
144 self._config = dict()
145 self._config[option] = value
147 def get_plugin_config(self, facility):
148 return self._data.get_plugin_config(facility, self.name)
150 def save_plugin_config(self, facility):
151 self._data.save_plugin_config(facility, self.name, self._config)
153 def get_data(self, idval=None, name=None, value=None):
154 return self._data.get_data(self.name, idval=idval, name=name,
157 def save_data(self, data):
158 self._data.save_data(self.name, data)
160 def new_datum(self, datum):
161 self._data.new_datum(self.name, datum)
163 def wipe_config_values(self, facility):
164 self._data.wipe_plugin_config(facility, self.name)
167 self._data.wipe_data(self.name)