3 # Copyright (C) 2014 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/>.
21 from ipsilon.util.page import Page
22 from ipsilon.util.page import admin_protect
23 from ipsilon.util.plugin import PluginObject
26 class AdminPage(Page):
28 def __init__(self, *args, **kwargs):
29 super(AdminPage, self).__init__(*args, **kwargs)
30 self.default_headers.update({
31 'Cache-Control': 'no-cache, must-revalidate',
33 'Expires': 'Thu, 01 Dec 1994 16:00:00 GMT',
35 self.auth_protect = True
38 class AdminPluginConfig(AdminPage):
40 def __init__(self, po, site, parent):
41 super(AdminPluginConfig, self).__init__(site, form=True)
43 self.title = '%s plugin' % po.name
44 self.url = '%s/%s' % (parent.url, po.name)
45 self.facility = parent.facility
47 self.back = parent.url
50 options = po.get_config_desc()
54 self.options_order = []
55 if hasattr(po, 'conf_opt_order'):
56 self.options_order = po.conf_opt_order
58 # append any undefined options
60 for k in options.keys():
61 if k not in self.options_order:
66 self.options_order.append(k)
69 def GET(self, *args, **kwargs):
70 return self._template('admin/plugin_config.html', title=self.title,
71 name='admin_%s_%s_form' % (self.facility,
73 menu=self.menu, action=self.url, back=self.back,
74 options_order=self.options_order,
78 def POST(self, *args, **kwargs):
80 message = "Nothing was modified."
85 options = self._po.get_config_desc()
89 for key, value in kwargs.iteritems():
91 if value != self._po.get_config_value(key):
92 cherrypy.log.error("Storing [%s]: %s = %s" %
93 (self._po.name, key, value))
94 new_values[key] = value
96 if len(new_values) != 0:
97 # First we try to save in the database
99 self._po.save_plugin_config(self.facility, new_values)
100 message = "New configuration saved."
101 message_type = "success"
102 except Exception: # pylint: disable=broad-except
103 message = "Failed to save data!"
104 message_type = "error"
106 # And only if it succeeds we change the live object
107 self._po.refresh_plugin_config(self.facility)
109 return self._template('admin/plugin_config.html', title=self.title,
111 message_type=message_type,
112 name='admin_%s_%s_form' % (self.facility,
114 menu=self.menu, action=self.url,
118 class AdminPluginsOrder(AdminPage):
120 def __init__(self, site, parent, facility):
121 super(AdminPluginsOrder, self).__init__(site, form=True)
123 self.facility = facility
124 self.url = '%s/order' % parent.url
128 def GET(self, *args, **kwargs):
129 return self.parent.root_with_msg()
132 def POST(self, *args, **kwargs):
133 message = "Nothing was modified."
134 message_type = "info"
135 by_name = {p.name: p for p in self._site[self.facility]['enabled']}
137 if 'order' in kwargs:
138 order = kwargs['order'].split(',')
145 if val not in by_name:
146 error = "Invalid plugin name: %s" % val
147 raise ValueError(error)
148 new_names.append(val)
149 new_plugins.append(by_name[val])
150 if len(new_names) < len(by_name):
152 if val not in new_names:
153 new_names.append(val)
154 new_plugins.append(by_name[val])
156 self.parent.save_enabled_plugins(new_names)
157 self.parent.reorder_plugins(new_names)
159 # When all is saved update also live config. The
160 # live config is a list of the actual plugin
162 self._site[self.facility]['enabled'] = new_plugins
164 message = "New configuration saved."
165 message_type = "success"
167 except ValueError, e:
169 message_type = "error"
171 except Exception, e: # pylint: disable=broad-except
172 message = "Failed to save data!"
173 message_type = "error"
175 return self.parent.root_with_msg(message=message,
176 message_type=message_type)
179 class AdminPlugins(AdminPage):
180 def __init__(self, name, site, parent, facility, ordered=True):
181 super(AdminPlugins, self).__init__(site)
182 self._master = parent
184 self.title = '%s plugins' % name
185 self.url = '%s/%s' % (parent.url, name)
186 self.facility = facility
187 self.template = 'admin/plugins.html'
189 parent.add_subtree(name, self)
191 for plugin in self._site[facility]['available']:
192 cherrypy.log.error('Admin info plugin: %s' % plugin)
193 obj = self._site[facility]['available'][plugin]
194 page = AdminPluginConfig(obj, self._site, self)
195 if hasattr(obj, 'admin'):
196 obj.admin.mount(page)
197 self.add_subtree(plugin, page)
200 self.order = AdminPluginsOrder(self._site, self, facility)
202 def save_enabled_plugins(self, names):
206 globalconf['order'] = ','.join(names)
207 po.set_config(globalconf)
208 po.save_plugin_config(self.facility)
210 def reorder_plugins(self, names):
213 def root_with_msg(self, message=None, message_type=None):
214 plugins = self._site[self.facility]
216 for p in plugins['enabled']:
217 enabled.append(p.name)
218 targs = {'title': self.title,
219 'menu': self._master.menu,
221 'message_type': message_type,
222 'available': plugins['available'],
226 targs['order_name'] = '%s_order_form' % self.name
227 targs['order_action'] = self.order.url
229 # pylint: disable=star-args
230 return self._template(self.template, **targs)
232 def root(self, *args, **kwargs):
233 return self.root_with_msg()
236 def enable(self, plugin):
238 plugins = self._site[self.facility]
239 if plugin not in plugins['available']:
240 msg = "Unknown plugin %s" % plugin
241 return self.root_with_msg(msg, "error")
242 obj = plugins['available'][plugin]
243 if obj not in plugins['enabled']:
244 obj.enable(self._site)
246 enabled = list(x.name for x in plugins['enabled'])
247 self.save_enabled_plugins(enabled)
248 msg = "Plugin %s enabled" % obj.name
249 return self.root_with_msg(msg, "success")
250 enable.public_function = True
253 def disable(self, plugin):
255 plugins = self._site[self.facility]
256 if plugin not in plugins['available']:
257 msg = "Unknown plugin %s" % plugin
258 return self.root_with_msg(msg, "error")
259 obj = plugins['available'][plugin]
260 if obj in plugins['enabled']:
261 obj.disable(self._site)
263 enabled = list(x.name for x in plugins['enabled'])
264 self.save_enabled_plugins(enabled)
265 msg = "Plugin %s disabled" % obj.name
266 return self.root_with_msg(msg, "success")
267 disable.public_function = True
270 class Admin(AdminPage):
272 def __init__(self, site, mount):
273 super(Admin, self).__init__(site)
274 self.url = '%s/%s' % (self.basepath, mount)
277 def root(self, *args, **kwargs):
278 return self._template('admin/index.html',
279 title='Configuration',
282 def add_subtree(self, name, page):
283 self.__dict__[name] = page
284 self.menu.append(page)
286 def del_subtree(self, name):
287 self.menu.remove(self.__dict__[name])
288 del self.__dict__[name]