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):
29 def __init__(self, path=None):
31 self._path = os.getcwd()
34 self._providers_tree = None
36 def _load_class(self, tree, class_type, file_name):
37 cherrypy.log.error('Check module %s for class %s' % (file_name,
39 name, ext = os.path.splitext(os.path.split(file_name)[-1])
41 if ext.lower() == '.py':
42 mod = imp.load_source(name, file_name)
43 #elif ext.lower() == '.pyc':
44 # mod = imp.load_compiled(name, file_name)
47 except Exception, e: # pylint: disable=broad-except
48 cherrypy.log.error('Failed to load "%s" module: [%s]' % (name, e))
51 if hasattr(mod, class_type):
52 instance = getattr(mod, class_type)()
53 public_name = getattr(instance, 'name', name)
54 tree[public_name] = instance
55 cherrypy.log.error('Added module %s as %s' % (name, public_name))
57 def _load_classes(self, tree, path, class_type):
60 files = os.listdir(path)
61 except Exception, e: # pylint: disable=broad-except
62 cherrypy.log.error('No modules in %s: [%s]' % (path, e))
66 filename = os.path.join(path, name)
67 self._load_class(tree, class_type, filename)
69 def get_plugins(self, path, class_type):
71 self._load_classes(plugins, path, class_type)
75 class PluginLoader(object):
77 def __init__(self, baseobj, facility, plugin_type):
78 (whitelist, config) = Store().get_plugins_config(facility)
79 if cherrypy.config.get('debug', False):
80 cherrypy.log('[%s] %s: %s' % (facility, whitelist, config))
86 p = Plugins(path=cherrypy.config['base.dir'])
87 (pathname, dummy) = os.path.split(inspect.getfile(baseobj))
90 'available': p.get_plugins(pathname, plugin_type),
91 'whitelist': whitelist,
95 def get_plugin_data(self):
99 class PluginObject(object):
106 def get_config_desc(self):
107 """ The configuration description is a dictionary that provides
108 A description of the supported configuration options, as well
109 as the default configuration option values.
110 The key is the option name, the value is an array of 3 elements:
117 def set_config(self, config):
118 self._config = config
120 def get_config_value(self, name):
123 value = self._config.get(name, None)
126 opt = self._options.get(name, None)
130 if cherrypy.config.get('debug', False):
131 cherrypy.log('[%s] %s: %s' % (self.name, name, value))
135 def set_config_value(self, option, value):
137 self._config = dict()
138 self._config[option] = value