X-Git-Url: http://git.cascardo.info/?p=cascardo%2Fipsilon.git;a=blobdiff_plain;f=ipsilon%2Fadmin%2Fcommon.py;h=2b833144658329900ac41f99b4d6429d2c45e66e;hp=18b71ab5f85ae799c5aad61350e0d284e6ad22f5;hb=dc9f4a30a47cdce1e0070c18398351ea6c307305;hpb=dbcead832f700ad63dc382648f0e3b1b84cd4d23 diff --git a/ipsilon/admin/common.py b/ipsilon/admin/common.py index 18b71ab..2b83314 100755 --- a/ipsilon/admin/common.py +++ b/ipsilon/admin/common.py @@ -18,94 +18,295 @@ # along with this program. If not, see . import cherrypy -from ipsilon.util.data import Store from ipsilon.util.page import Page from ipsilon.util.page import admin_protect +from ipsilon.util import config as pconfig -class AdminPluginPage(Page): +ADMIN_STATUS_OK = "success" +ADMIN_STATUS_ERROR = "danger" +ADMIN_STATUS_WARN = "warning" - def __init__(self, obj, site, parent): - super(AdminPluginPage, self).__init__(site) - self._obj = obj - self.title = '%s plugin' % obj.name - self.url = '%s/%s' % (parent.url, obj.name) + +class AdminError(Exception): + def __init__(self, message): + super(AdminError, self).__init__(message) + self.message = message + + def __str__(self): + return str(self.message) + + +class AdminPage(Page): + + def __init__(self, *args, **kwargs): + super(AdminPage, self).__init__(*args, **kwargs) + self.default_headers.update({ + 'Cache-Control': 'no-cache, must-revalidate', + 'Pragma': 'no-cache', + 'Expires': 'Thu, 01 Dec 1994 16:00:00 GMT', + }) + self.auth_protect = True + + +class AdminPluginConfig(AdminPage): + + def __init__(self, po, site, parent): + super(AdminPluginConfig, self).__init__(site, form=True) + self._po = po + self.title = '%s plugin' % po.name + self.url = '%s/%s' % (parent.url, po.name) self.facility = parent.facility self.menu = [parent] + self.back = parent.url - # Get the defaults - self.plugin_config = obj.get_config_desc() - if not self.plugin_config: - self.plugin_config = [] - - # Now overlay the actual config - for option in self.plugin_config: - self.plugin_config[option][2] = obj.get_config_value(option) + def root_with_msg(self, message=None, message_type=None): + return self._template('admin/plugin_config.html', title=self.title, + menu=self.menu, action=self.url, back=self.back, + message=message, message_type=message_type, + name='admin_%s_%s_form' % (self.facility, + self._po.name), + config=self._po.get_config_obj()) @admin_protect def GET(self, *args, **kwargs): - return self._template('admin/plugin_config.html', title=self.title, - name='admin_%s_%s_form' % (self.facility, - self._obj.name), - menu=self.menu, action=self.url, - options=self.plugin_config) + return self.root_with_msg() @admin_protect def POST(self, *args, **kwargs): + if self._po.is_readonly: + return self.root_with_msg( + message="Configuration is marked Read-Only", + message_type=ADMIN_STATUS_WARN) + message = "Nothing was modified." message_type = "info" - new_values = dict() + new_db_values = dict() + + conf = self._po.get_config_obj() - for key, value in kwargs.iteritems(): - if key in self.plugin_config: - if value != self.plugin_config[key][2]: - cherrypy.log.error("Storing [%s]: %s = %s" % - (self._obj.name, key, value)) - new_values[key] = value + for name, option in conf.iteritems(): + if name in kwargs: + value = kwargs[name] + if isinstance(option, pconfig.List): + value = [x.strip() for x in value.split('\n')] + elif isinstance(option, pconfig.Condition): + value = True + else: + if isinstance(option, pconfig.Condition): + value = False + elif isinstance(option, pconfig.Choice): + value = list() + for a in option.get_allowed(): + aname = '%s_%s' % (name, a) + if aname in kwargs: + value.append(a) + else: + continue - if len(new_values) != 0: + if value != option.get_value(): + cherrypy.log.error("Storing [%s]: %s = %s" % + (self._po.name, name, value)) + option.set_value(value) + new_db_values[name] = option.export_value() + + if len(new_db_values) != 0: # First we try to save in the database try: - store = Store() - store.save_plugin_config(self.facility, - self._obj.name, new_values) + self._po.save_plugin_config(new_db_values) message = "New configuration saved." - message_type = "success" + message_type = ADMIN_STATUS_OK except Exception: # pylint: disable=broad-except message = "Failed to save data!" - message_type = "error" + message_type = ADMIN_STATUS_ERROR - # And only if it succeeds we change the live object - for name, value in new_values.items(): - self._obj.set_config_value(name, value) - self.plugin_config[name][2] = value + # Then refresh the actual objects + self._po.refresh_plugin_config() - return self._template('admin/plugin_config.html', title=self.title, - message=message, - message_type=message_type, - name='admin_%s_%s_form' % (self.facility, - self._obj.name), - menu=self.menu, action=self.url, - options=self.plugin_config) + return self.root_with_msg(message=message, + message_type=message_type) + + +class AdminPluginsOrder(AdminPage): + + def __init__(self, site, parent, facility): + super(AdminPluginsOrder, self).__init__(site, form=True) + self.parent = parent + self.facility = facility + self.url = '%s/order' % parent.url + self.menu = [parent] + + @admin_protect + def GET(self, *args, **kwargs): + return self.parent.root_with_msg() + + @admin_protect + def POST(self, *args, **kwargs): + + if self._site[self.facility].is_readonly: + return self.parent.root_with_msg( + message="Configuration is marked Read-Only", + message_type=ADMIN_STATUS_WARN) + + message = "Nothing was modified." + message_type = "info" + changed = None + cur_enabled = self._site[self.facility].enabled + + if 'order' in kwargs: + order = kwargs['order'].split(',') + if len(order) != 0: + new_order = [] + try: + for v in order: + val = v.strip() + if val not in cur_enabled: + error = "Invalid plugin name: %s" % val + raise ValueError(error) + new_order.append(val) + if len(new_order) < len(cur_enabled): + for val in cur_enabled: + if val not in new_order: + new_order.append(val) + + self.parent.save_enabled_plugins(new_order) + + # When all is saved update also live config. The + # live config is the ordered list of plugin names. + self._site[self.facility].refresh_enabled() + + message = "New configuration saved." + message_type = ADMIN_STATUS_OK + + changed = dict() + self.debug('%s -> %s' % (cur_enabled, new_order)) + for i in range(0, len(cur_enabled)): + if cur_enabled[i] != new_order[i]: + changed[cur_enabled[i]] = 'reordered' + + except ValueError, e: + message = str(e) + message_type = ADMIN_STATUS_ERROR + + except Exception, e: # pylint: disable=broad-except + message = "Failed to save data!" + message_type = ADMIN_STATUS_ERROR + + return self.parent.root_with_msg(message=message, + message_type=message_type, + changed=changed) + + +class AdminPlugins(AdminPage): + def __init__(self, name, site, parent, facility, ordered=True): + super(AdminPlugins, self).__init__(site) + self._master = parent + self.name = name + self.title = '%s plugins' % name + self.url = '%s/%s' % (parent.url, name) + self.facility = facility + self.template = 'admin/plugins.html' + self.order = None + parent.add_subtree(name, self) + + for plugin in self._site[facility].available: + cherrypy.log.error('Admin info plugin: %s' % plugin) + obj = self._site[facility].available[plugin] + page = AdminPluginConfig(obj, self._site, self) + if hasattr(obj, 'admin'): + obj.admin.mount(page) + self.add_subtree(plugin, page) + + if ordered: + self.order = AdminPluginsOrder(self._site, self, facility) + + def save_enabled_plugins(self, names): + self._site[self.facility].save_enabled(names) + + def root_with_msg(self, message=None, message_type=None, changed=None): + plugins = self._site[self.facility] + + if changed is None: + changed = dict() + + targs = {'title': self.title, + 'menu': self._master.menu, + 'message': message, + 'message_type': message_type, + 'available': plugins.available, + 'enabled': plugins.enabled, + 'changed': changed, + 'baseurl': self.url, + 'newurl': self.url} + if self.order: + targs['order_name'] = '%s_order_form' % self.name + targs['order_action'] = self.order.url + + # pylint: disable=star-args + return self._template(self.template, **targs) def root(self, *args, **kwargs): - cherrypy.log.error("method: %s" % cherrypy.request.method) - op = getattr(self, cherrypy.request.method, self.GET) - if callable(op): - return op(*args, **kwargs) + return self.root_with_msg() + + def _get_plugin_obj(self, plugin): + plugins = self._site[self.facility] + if plugins.is_readonly: + msg = "Configuration is marked Read-Only" + raise AdminError(msg) + if plugin not in plugins.available: + msg = "Unknown plugin %s" % plugin + raise AdminError(msg) + obj = plugins.available[plugin] + if obj.is_readonly: + msg = "Plugin Configuration is marked Read-Only" + raise AdminError(msg) + return obj + + @admin_protect + def enable(self, plugin): + msg = None + try: + obj = self._get_plugin_obj(plugin) + except AdminError, e: + return self.root_with_msg(str(e), ADMIN_STATUS_WARN) + if not obj.is_enabled: + obj.enable() + obj.save_enabled_state() + msg = "Plugin %s enabled" % obj.name + return self.root_with_msg(msg, ADMIN_STATUS_OK, + changed={obj.name: 'enabled'}) + enable.public_function = True + + @admin_protect + def disable(self, plugin): + msg = None + try: + obj = self._get_plugin_obj(plugin) + except AdminError, e: + return self.root_with_msg(str(e), ADMIN_STATUS_WARN) + if obj.is_enabled: + obj.disable() + obj.save_enabled_state() + msg = "Plugin %s disabled" % obj.name + return self.root_with_msg(msg, ADMIN_STATUS_OK, + changed={obj.name: 'disabled'}) + disable.public_function = True -class Admin(Page): +class Admin(AdminPage): def __init__(self, site, mount): super(Admin, self).__init__(site) + self.title = 'Home' + self.mount = mount self.url = '%s/%s' % (self.basepath, mount) - self.menu = [] + self.menu = [self] def root(self, *args, **kwargs): return self._template('admin/index.html', title='Configuration', + baseurl=self.url, menu=self.menu) def add_subtree(self, name, page): @@ -115,3 +316,20 @@ class Admin(Page): def del_subtree(self, name): self.menu.remove(self.__dict__[name]) del self.__dict__[name] + + def get_menu_urls(self): + urls = dict() + for item in self.menu: + name = getattr(item, 'name', None) + if name: + urls['%s_url' % name] = cherrypy.url('/%s/%s' % (self.mount, + name)) + return urls + + @admin_protect + def scheme(self): + cherrypy.response.headers.update({'Content-Type': 'image/svg+xml'}) + urls = self.get_menu_urls() + # pylint: disable=star-args + return self._template('admin/ipsilon-scheme.svg', **urls) + scheme.public_function = True