Refactor plugin initialization and enablement
[cascardo/ipsilon.git] / ipsilon / admin / common.py
index b9dfbf4..9c82142 100755 (executable)
@@ -20,7 +20,7 @@
 import cherrypy
 from ipsilon.util.page import Page
 from ipsilon.util.page import admin_protect
-from ipsilon.util.plugin import PluginObject
+from ipsilon.util import config as pconfig
 
 
 class AdminPage(Page):
@@ -46,33 +46,13 @@ class AdminPluginConfig(AdminPage):
         self.menu = [parent]
         self.back = parent.url
 
-        # Get the defaults
-        options = po.get_config_desc()
-        if options is None:
-            options = dict()
-
-        self.options_order = []
-        if hasattr(po, 'conf_opt_order'):
-            self.options_order = po.conf_opt_order
-
-        # append any undefined options
-        add = []
-        for k in options.keys():
-            if k not in self.options_order:
-                add.append(k)
-        if len(add):
-            add.sort()
-            for k in add:
-                self.options_order.append(k)
-
     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),
-                              options_order=self.options_order,
-                              plugin=self._po)
+                              config=self._po.get_config_obj())
 
     @admin_protect
     def GET(self, *args, **kwargs):
@@ -83,32 +63,47 @@ class AdminPluginConfig(AdminPage):
 
         message = "Nothing was modified."
         message_type = "info"
-        new_values = dict()
-
-        # Get the defaults
-        options = self._po.get_config_desc()
-        if options is None:
-            options = dict()
-
-        for key, value in kwargs.iteritems():
-            if key in options:
-                if value != self._po.get_config_value(key):
-                    cherrypy.log.error("Storing [%s]: %s = %s" %
-                                       (self._po.name, key, value))
-                    new_values[key] = value
-
-        if len(new_values) != 0:
+        new_db_values = dict()
+
+        conf = self._po.get_config_obj()
+
+        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 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:
-                self._po.save_plugin_config(self.facility, new_values)
+                self._po.save_plugin_config(new_db_values)
                 message = "New configuration saved."
                 message_type = "success"
             except Exception:  # pylint: disable=broad-except
                 message = "Failed to save data!"
                 message_type = "error"
 
-            # And only if it succeeds we change the live object
-            self._po.refresh_plugin_config(self.facility)
+            # Then refresh the actual objects
+            self._po.refresh_plugin_config()
 
         return self.root_with_msg(message=message,
                                   message_type=message_type)
@@ -127,45 +122,40 @@ class AdminPluginsOrder(AdminPage):
     def GET(self, *args, **kwargs):
         return self.parent.root_with_msg()
 
-    def _get_enabled_by_name(self):
-        by_name = dict()
-        for p in self._site[self.facility]['available'].values():
+    def _get_enabled_list(self):
+        cur = list()
+        for p in self._site[self.facility].available.values():
             if p.is_enabled:
-                by_name[p.name] = p
-        return by_name
+                cur.append(p.name)
+        return cur
 
     @admin_protect
     def POST(self, *args, **kwargs):
         message = "Nothing was modified."
         message_type = "info"
-        by_name = self._get_enabled_by_name()
+        cur_enabled = self._get_enabled_list()
 
         if 'order' in kwargs:
             order = kwargs['order'].split(',')
             if len(order) != 0:
-                new_names = []
-                new_plugins = []
+                new_order = []
                 try:
                     for v in order:
                         val = v.strip()
-                        if val not in by_name:
+                        if val not in cur_enabled:
                             error = "Invalid plugin name: %s" % val
                             raise ValueError(error)
-                        new_names.append(val)
-                        new_plugins.append(by_name[val])
-                    if len(new_names) < len(by_name):
-                        for val in by_name:
-                            if val not in new_names:
-                                new_names.append(val)
-                                new_plugins.append(by_name[val])
+                        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_names)
-                    self.parent.reorder_plugins(new_names)
+                    self.parent.save_enabled_plugins(new_order)
 
                     # When all is saved update also live config. The
-                    # live config is a list of the actual plugin
-                    # objects.
-                    self._site[self.facility]['enabled'] = new_plugins
+                    # live config is the ordered list of plugin names.
+                    self._site[self.facility].refresh_enabled()
 
                     message = "New configuration saved."
                     message_type = "success"
@@ -194,9 +184,9 @@ class AdminPlugins(AdminPage):
         self.order = None
         parent.add_subtree(name, self)
 
-        for plugin in self._site[facility]['available']:
+        for plugin in self._site[facility].available:
             cherrypy.log.error('Admin info plugin: %s' % plugin)
-            obj = self._site[facility]['available'][plugin]
+            obj = self._site[facility].available[plugin]
             page = AdminPluginConfig(obj, self._site, self)
             if hasattr(obj, 'admin'):
                 obj.admin.mount(page)
@@ -206,35 +196,19 @@ class AdminPlugins(AdminPage):
             self.order = AdminPluginsOrder(self._site, self, facility)
 
     def save_enabled_plugins(self, names):
-        po = PluginObject()
-        po.name = "global"
-        globalconf = dict()
-        globalconf['order'] = ','.join(names)
-        po.set_config(globalconf)
-        po.save_plugin_config(self.facility)
-
-    def reorder_plugins(self, names):
-        return
+        self._site[self.facility].save_enabled(names)
 
     def root_with_msg(self, message=None, message_type=None):
         plugins = self._site[self.facility]
-        enabled = []
-        if self.order:
-            for plugin in plugins['enabled']:
-                if plugin.is_enabled:
-                    enabled.append(plugin.name)
-        else:
-            for _, plugin in plugins['available'].iteritems():
-                if plugin.is_enabled:
-                    enabled.append(plugin.name)
 
         targs = {'title': self.title,
                  'menu': self._master.menu,
                  'message': message,
                  'message_type': message_type,
-                 'available': plugins['available'],
-                 'enabled': enabled,
-                 'baseurl': self.url}
+                 'available': plugins.available,
+                 'enabled': plugins.enabled,
+                 'baseurl': self.url,
+                 'newurl': self.url}
         if self.order:
             targs['order_name'] = '%s_order_form' % self.name
             targs['order_action'] = self.order.url
@@ -249,15 +223,13 @@ class AdminPlugins(AdminPage):
     def enable(self, plugin):
         msg = None
         plugins = self._site[self.facility]
-        if plugin not in plugins['available']:
+        if plugin not in plugins.available:
             msg = "Unknown plugin %s" % plugin
             return self.root_with_msg(msg, "error")
-        obj = plugins['available'][plugin]
+        obj = plugins.available[plugin]
         if not obj.is_enabled:
-            obj.enable(self._site)
-            if self.order:
-                enabled = list(x.name for x in plugins['enabled'])
-                self.save_enabled_plugins(enabled)
+            obj.enable()
+            obj.save_enabled_state()
             msg = "Plugin %s enabled" % obj.name
         return self.root_with_msg(msg, "success")
     enable.public_function = True
@@ -266,15 +238,13 @@ class AdminPlugins(AdminPage):
     def disable(self, plugin):
         msg = None
         plugins = self._site[self.facility]
-        if plugin not in plugins['available']:
+        if plugin not in plugins.available:
             msg = "Unknown plugin %s" % plugin
             return self.root_with_msg(msg, "error")
-        obj = plugins['available'][plugin]
+        obj = plugins.available[plugin]
         if obj.is_enabled:
-            obj.disable(self._site)
-            if self.order:
-                enabled = list(x.name for x in plugins['enabled'])
-                self.save_enabled_plugins(enabled)
+            obj.disable()
+            obj.save_enabled_state()
             msg = "Plugin %s disabled" % obj.name
         return self.root_with_msg(msg, "success")
     disable.public_function = True