ipsilon/admin/common.py

   1 #!/usr/bin/python
   2 #
   3 # Copyright (C) 2014  Simo Sorce <simo@redhat.com>
   4 #
   5 # see file 'COPYING' for use and warranty information
   6 #
   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.
  11 #
  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.
  16 #
  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/>.
  19
  20 import cherrypy
  21 from ipsilon.util.page import Page
  22 from ipsilon.util.page import admin_protect, auth_protect
  23
  24
  25 class AdminPage(Page):
  26
  27     def __init__(self, *args, **kwargs):
  28         super(AdminPage, self).__init__(*args, **kwargs)
  29         self.default_headers.update({
  30             'Cache-Control': 'no-cache, must-revalidate',
  31             'Pragma': 'no-cache',
  32             'Expires': 'Thu, 01 Dec 1994 16:00:00 GMT',
  33         })
  34
  35
  36 class AdminPluginPage(AdminPage):
  37
  38     def __init__(self, obj, site, parent):
  39         super(AdminPluginPage, self).__init__(site, form=True)
  40         self._obj = obj
  41         self.title = '%s plugin' % obj.name
  42         self.url = '%s/%s' % (parent.url, obj.name)
  43         self.facility = parent.facility
  44         self.menu = [parent]
  45         self.back = parent.url
  46
  47         # Get the defaults
  48         self.plugin_config = obj.get_config_desc()
  49         if not self.plugin_config:
  50             self.plugin_config = dict()
  51
  52         # Now overlay the actual config
  53         for option in self.plugin_config:
  54             self.plugin_config[option][2] = obj.get_config_value(option)
  55
  56         self.options_order = []
  57         if hasattr(obj, 'conf_opt_order'):
  58             self.options_order = obj.conf_opt_order
  59
  60         # append any undefined options
  61         add = []
  62         for k in self.plugin_config.keys():
  63             if k not in self.options_order:
  64                 add.append(k)
  65         if len(add):
  66             add.sort()
  67             for k in add:
  68                 self.options_order.append(k)
  69
  70     @admin_protect
  71     def GET(self, *args, **kwargs):
  72         return self._template('admin/plugin_config.html', title=self.title,
  73                               name='admin_%s_%s_form' % (self.facility,
  74                                                          self._obj.name),
  75                               menu=self.menu, action=self.url, back=self.back,
  76                               options_order=self.options_order,
  77                               options=self.plugin_config)
  78
  79     @admin_protect
  80     def POST(self, *args, **kwargs):
  81
  82         message = "Nothing was modified."
  83         message_type = "info"
  84         new_values = dict()
  85
  86         for key, value in kwargs.iteritems():
  87             if key in self.plugin_config:
  88                 if value != self.plugin_config[key][2]:
  89                     cherrypy.log.error("Storing [%s]: %s = %s" %
  90                                        (self._obj.name, key, value))
  91                     new_values[key] = value
  92
  93         if len(new_values) != 0:
  94             # First we try to save in the database
  95             try:
  96                 self._obj.save_plugin_config(self.facility, new_values)
  97                 message = "New configuration saved."
  98                 message_type = "success"
  99             except Exception:  # pylint: disable=broad-except
 100                 message = "Failed to save data!"
 101                 message_type = "error"
 102
 103             # And only if it succeeds we change the live object
 104             for name, value in new_values.items():
 105                 self._obj.set_config_value(name, value)
 106                 self.plugin_config[name][2] = value
 107
 108         return self._template('admin/plugin_config.html', title=self.title,
 109                               message=message,
 110                               message_type=message_type,
 111                               name='admin_%s_%s_form' % (self.facility,
 112                                                          self._obj.name),
 113                               menu=self.menu, action=self.url,
 114                               options=self.plugin_config)
 115
 116
 117 class Admin(AdminPage):
 118
 119     def __init__(self, site, mount):
 120         super(Admin, self).__init__(site)
 121         self.url = '%s/%s' % (self.basepath, mount)
 122         self.menu = []
 123
 124     @auth_protect
 125     def root(self, *args, **kwargs):
 126         return self._template('admin/index.html',
 127                               title='Configuration',
 128                               menu=self.menu)
 129
 130     def add_subtree(self, name, page):
 131         self.__dict__[name] = page
 132         self.menu.append(page)
 133
 134     def del_subtree(self, name):
 135         self.menu.remove(self.__dict__[name])
 136         del self.__dict__[name]