1 # Copyright (C) 2014 Simo Sorce <simo@redhat.com>
3 # see file 'COPYING' for use and warranty information
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19 from ipsilon.util.page import Page
20 from ipsilon.util.page import admin_protect
21 from ipsilon.util import config as pconfig
24 ADMIN_STATUS_OK = "success"
25 ADMIN_STATUS_ERROR = "danger"
26 ADMIN_STATUS_WARN = "warning"
29 class AdminError(Exception):
30 def __init__(self, message):
31 super(AdminError, self).__init__(message)
32 self.message = message
35 return str(self.message)
38 class AdminPage(Page):
40 def __init__(self, *args, **kwargs):
41 super(AdminPage, self).__init__(*args, **kwargs)
42 self.auth_protect = True
45 class AdminPluginConfig(AdminPage):
47 def __init__(self, po, site, parent):
48 super(AdminPluginConfig, self).__init__(site, form=True)
50 self.title = '%s plugin' % po.name
51 self.url = '%s/%s' % (parent.url, po.name)
52 self.facility = parent.facility
54 self.back = parent.url
56 def root_with_msg(self, message=None, message_type=None):
57 return self._template('admin/plugin_config.html', title=self.title,
58 menu=self.menu, action=self.url, back=self.back,
59 message=message, message_type=message_type,
60 name='admin_%s_%s_form' % (self.facility,
62 config=self._po.get_config_obj())
64 def get_complex_list_value(self, name, old_value, **kwargs):
67 for key, val in kwargs.iteritems():
68 if not key.startswith(name):
71 if len(n) == 0 or n[0] != ' ':
74 index, field = n[1:].split('-')
78 delete.append(int(index))
80 change[int(index)] = val
82 if len(delete) == 0 and len(change) == 0:
87 # remove unwanted changes
92 # perform requested changes
93 for index, val in change.iteritems():
94 val_list = val.split('/')
97 stripped.append(v.strip())
98 if len(stripped) == 1:
99 stripped = stripped[0]
100 if len(value) <= index:
101 value.extend([None]*(index + 1 - len(value)))
102 value[index] = stripped
104 if len(value[index]) == 0:
107 # the previous loop may add 'None' entries
108 # if any still exists mark them to be deleted
109 for i in xrange(0, len(value)):
113 # remove duplicates and set in reverse order
114 delete = list(set(delete))
115 delete.sort(reverse=True)
125 def get_mapping_list_value(self, name, old_value, **kwargs):
128 for key, val in kwargs.iteritems():
129 if not key.startswith(name):
132 if len(n) == 0 or n[0] != ' ':
135 index, field = n[1:].split('-')
138 if field == 'delete':
139 delete.append(int(index))
144 change[i][field] = val
146 if len(delete) == 0 and len(change) == 0:
151 # remove unwanted changes
156 # perform requested changes
157 for index, fields in change.iteritems():
158 for k in 'from', 'to':
161 val_list = val.split('/')
164 stripped.append(v.strip())
165 if len(stripped) == 1:
166 stripped = stripped[0]
167 if len(value) <= index:
168 value.extend([None]*(index + 1 - len(value)))
169 if value[index] is None:
170 value[index] = [None, None]
175 value[index][i] = stripped
177 # eliminate incomplete/incorrect entries
178 if value[index] is not None:
179 if ((len(value[index]) != 2 or
180 value[index][0] is None or
181 len(value[index][0]) == 0 or
182 value[index][1] is None or
183 len(value[index][1]) == 0)):
186 # the previous loop may add 'None' entries
187 # if any still exists mark them to be deleted
188 for i in xrange(0, len(value)):
192 # remove duplicates and set in reverse order
193 delete = list(set(delete))
194 delete.sort(reverse=True)
205 def GET(self, *args, **kwargs):
206 return self.root_with_msg()
209 def POST(self, *args, **kwargs):
211 if self._po.is_readonly:
212 return self.root_with_msg(
213 message="Configuration is marked Read-Only",
214 message_type=ADMIN_STATUS_WARN)
216 message = "Nothing was modified."
217 message_type = "info"
218 new_db_values = dict()
220 conf = self._po.get_config_obj()
222 for name, option in conf.iteritems():
225 if isinstance(option, pconfig.List):
226 value = [x.strip() for x in value.split('\n')]
227 elif isinstance(option, pconfig.Condition):
230 if isinstance(option, pconfig.Condition):
232 elif isinstance(option, pconfig.Choice):
234 for a in option.get_allowed():
235 aname = '%s_%s' % (name, a)
238 elif type(option) is pconfig.ComplexList:
239 value = self.get_complex_list_value(name,
244 elif type(option) is pconfig.MappingList:
245 value = self.get_mapping_list_value(name,
253 if value != option.get_value():
254 cherrypy.log.error("Storing [%s]: %s = %s" %
255 (self._po.name, name, value))
256 option.set_value(value)
257 new_db_values[name] = option.export_value()
259 if len(new_db_values) != 0:
260 # First we try to save in the database
262 self._po.save_plugin_config(new_db_values)
263 message = "New configuration saved."
264 message_type = ADMIN_STATUS_OK
265 except Exception: # pylint: disable=broad-except
266 message = "Failed to save data!"
267 message_type = ADMIN_STATUS_ERROR
269 # Then refresh the actual objects
270 self._po.refresh_plugin_config()
272 return self.root_with_msg(message=message,
273 message_type=message_type)
276 class AdminPluginsOrder(AdminPage):
278 def __init__(self, site, parent, facility):
279 super(AdminPluginsOrder, self).__init__(site, form=True)
281 self.facility = facility
282 self.url = '%s/order' % parent.url
286 def GET(self, *args, **kwargs):
287 return self.parent.root_with_msg()
290 def POST(self, *args, **kwargs):
292 if self._site[self.facility].is_readonly:
293 return self.parent.root_with_msg(
294 message="Configuration is marked Read-Only",
295 message_type=ADMIN_STATUS_WARN)
297 message = "Nothing was modified."
298 message_type = "info"
300 cur_enabled = self._site[self.facility].enabled
302 if 'order' in kwargs:
303 order = kwargs['order'].split(',')
309 if val not in cur_enabled:
310 error = "Invalid plugin name: %s" % val
311 raise ValueError(error)
312 new_order.append(val)
313 if len(new_order) < len(cur_enabled):
314 for val in cur_enabled:
315 if val not in new_order:
316 new_order.append(val)
318 self.parent.save_enabled_plugins(new_order)
320 # When all is saved update also live config. The
321 # live config is the ordered list of plugin names.
322 self._site[self.facility].refresh_enabled()
324 message = "New configuration saved."
325 message_type = ADMIN_STATUS_OK
328 self.debug('%s -> %s' % (cur_enabled, new_order))
329 for i in range(0, len(cur_enabled)):
330 if cur_enabled[i] != new_order[i]:
331 changed[cur_enabled[i]] = 'reordered'
333 except ValueError, e:
335 message_type = ADMIN_STATUS_ERROR
337 except Exception, e: # pylint: disable=broad-except
338 message = "Failed to save data!"
339 message_type = ADMIN_STATUS_ERROR
341 return self.parent.root_with_msg(message=message,
342 message_type=message_type,
346 class AdminPlugins(AdminPage):
347 def __init__(self, name, site, parent, facility, ordered=True):
348 super(AdminPlugins, self).__init__(site)
349 self._master = parent
351 self.title = '%s plugins' % name
352 self.url = '%s/%s' % (parent.url, name)
353 self.facility = facility
354 self.template = 'admin/plugins.html'
356 parent.add_subtree(name, self)
358 for plugin in self._site[facility].available:
359 cherrypy.log.error('Admin info plugin: %s' % plugin)
360 obj = self._site[facility].available[plugin]
361 page = AdminPluginConfig(obj, self._site, self)
362 if hasattr(obj, 'admin'):
363 obj.admin.mount(page)
364 self.add_subtree(plugin, page)
367 self.order = AdminPluginsOrder(self._site, self, facility)
369 def save_enabled_plugins(self, names):
370 self._site[self.facility].save_enabled(names)
372 def root_with_msg(self, message=None, message_type=None, changed=None):
373 plugins = self._site[self.facility]
378 targs = {'title': self.title,
379 'menu': self._master.menu,
381 'message_type': message_type,
382 'available': plugins.available,
383 'enabled': plugins.enabled,
388 targs['order_name'] = '%s_order_form' % self.name
389 targs['order_action'] = self.order.url
391 # pylint: disable=star-args
392 return self._template(self.template, **targs)
394 def root(self, *args, **kwargs):
395 return self.root_with_msg()
397 def _get_plugin_obj(self, plugin):
398 plugins = self._site[self.facility]
399 if plugins.is_readonly:
400 msg = "Configuration is marked Read-Only"
401 raise AdminError(msg)
402 if plugin not in plugins.available:
403 msg = "Unknown plugin %s" % plugin
404 raise AdminError(msg)
405 obj = plugins.available[plugin]
407 msg = "Plugin Configuration is marked Read-Only"
408 raise AdminError(msg)
412 def enable(self, plugin):
415 obj = self._get_plugin_obj(plugin)
416 except AdminError, e:
417 return self.root_with_msg(str(e), ADMIN_STATUS_WARN)
418 if not obj.is_enabled:
420 obj.save_enabled_state()
421 msg = "Plugin %s enabled" % obj.name
422 return self.root_with_msg(msg, ADMIN_STATUS_OK,
423 changed={obj.name: 'enabled'})
424 enable.public_function = True
427 def disable(self, plugin):
430 obj = self._get_plugin_obj(plugin)
431 except AdminError, e:
432 return self.root_with_msg(str(e), ADMIN_STATUS_WARN)
435 obj.save_enabled_state()
436 msg = "Plugin %s disabled" % obj.name
437 return self.root_with_msg(msg, ADMIN_STATUS_OK,
438 changed={obj.name: 'disabled'})
439 disable.public_function = True
442 class Admin(AdminPage):
444 def __init__(self, site, mount):
445 super(Admin, self).__init__(site)
448 self.url = '%s/%s' % (self.basepath, mount)
451 def root(self, *args, **kwargs):
452 return self._template('admin/index.html',
453 title='Configuration',
457 def add_subtree(self, name, page):
458 self.__dict__[name] = page
459 self.menu.append(page)
461 def del_subtree(self, name):
462 self.menu.remove(self.__dict__[name])
463 del self.__dict__[name]
465 def get_menu_urls(self):
467 for item in self.menu:
468 name = getattr(item, 'name', None)
470 urls['%s_url' % name] = cherrypy.url('/%s/%s' % (self.mount,
476 cherrypy.response.headers.update({'Content-Type': 'image/svg+xml'})
477 urls = self.get_menu_urls()
478 # pylint: disable=star-args
479 return str(self._template('admin/ipsilon-scheme.svg', **urls))
480 scheme.public_function = True