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 AdminStore
25 from ipsilon.util.log import Log
28 class Plugins(object):
31 self._providers_tree = None
33 def _load_class(self, tree, class_type, file_name):
34 cherrypy.log.error('Check module %s for class %s' % (file_name,
36 name, ext = os.path.splitext(os.path.split(file_name)[-1])
38 if ext.lower() == '.py':
39 mod = imp.load_source(name, file_name)
40 # elif ext.lower() == '.pyc':
41 # mod = imp.load_compiled(name, file_name)
44 except Exception, e: # pylint: disable=broad-except
45 cherrypy.log.error('Failed to load "%s" module: [%s]' % (name, e))
48 if hasattr(mod, class_type):
49 instance = getattr(mod, class_type)()
50 public_name = getattr(instance, 'name', name)
51 tree[public_name] = instance
52 cherrypy.log.error('Added module %s as %s' % (name, public_name))
54 def _load_classes(self, tree, path, class_type):
57 files = os.listdir(path)
58 except Exception, e: # pylint: disable=broad-except
59 cherrypy.log.error('No modules in %s: [%s]' % (path, e))
63 filename = os.path.join(path, name)
64 self._load_class(tree, class_type, filename)
66 def get_plugins(self, path, class_type):
68 self._load_classes(plugins, path, class_type)
72 class PluginLoader(object):
74 def __init__(self, baseobj, facility, plugin_type):
75 config = AdminStore().load_options(facility)
76 cherrypy.log('LOAD: %s\n' % repr(config))
78 if 'global' in config:
79 sec = config['global']
81 whitelist = sec['order'].split(',')
82 if cherrypy.config.get('debug', False):
83 cherrypy.log('[%s] %s: %s' % (facility, whitelist, config))
88 (pathname, dummy) = os.path.split(inspect.getfile(baseobj))
91 'available': p.get_plugins(pathname, plugin_type),
92 'whitelist': whitelist,
96 def get_plugin_data(self):
100 class PluginInstaller(object):
101 def __init__(self, baseobj):
102 (pathname, dummy) = os.path.split(inspect.getfile(baseobj))
103 self._pathname = pathname
105 def get_plugins(self):
107 return p.get_plugins(self._pathname, 'Installer')
110 class PluginObject(Log):
116 self._data = AdminStore()
118 def get_config_desc(self, name=None):
119 """ The configuration description is a dictionary that provides
120 A description of the supported configuration options, as well
121 as the default configuration option values.
122 The key is the option name, the value is an array of 3 elements:
130 opt = self._options.get(name, None)
135 def _value_to_list(self, name):
136 if name not in self._config:
138 value = self._config[name]
139 if type(value) is list:
141 vlist = [x.strip() for x in value.split(',')]
142 self._config[name] = vlist
144 def set_config(self, config):
145 self._config = config
146 if self._config is None:
149 for name, opt in self._options.iteritems():
151 self._value_to_list(name)
153 def get_config_value(self, name):
156 value = self._config.get(name, None)
159 opt = self._options.get(name, None)
163 if cherrypy.config.get('debug', False):
164 cherrypy.log('[%s] %s: %s' % (self.name, name, value))
168 def set_config_value(self, option, value):
170 self._config = dict()
171 self._config[option] = value
172 if self._options and option in self._options:
173 if self._options[option][1] == 'list':
174 self._value_to_list(option)
176 def get_plugin_config(self, facility):
177 return self._data.load_options(facility, self.name)
179 def refresh_plugin_config(self, facility):
180 config = self.get_plugin_config(facility)
181 self.set_config(config)
183 def save_plugin_config(self, facility, config=None):
185 config = self._config
186 config = config.copy()
188 for key, value in config.items():
189 if type(value) is list:
190 config[key] = ','.join(value)
192 self._data.save_options(facility, self.name, config)
194 def get_data(self, idval=None, name=None, value=None):
195 return self._data.get_data(self.name, idval=idval, name=name,
198 def save_data(self, data):
199 self._data.save_data(self.name, data)
201 def new_datum(self, datum):
202 self._data.new_datum(self.name, datum)
204 def del_datum(self, idval):
205 self._data.del_datum(self.name, idval)
207 def wipe_config_values(self, facility):
208 self._data.delete_options(facility, self.name, None)
211 self._data.wipe_data(self.name)