Refactor plugin configuration

[cascardo/ipsilon.git] / ipsilon / info / common.py

diff --git a/ipsilon/info/common.py b/ipsilon/info/common.py
index 6dbaf93..586b9e5 100755 (executable)
--- a/ipsilon/info/common.py
+++ b/ipsilon/info/common.py
@@ -5,53 +5,128 @@
 # See the file named COPYING for the project license
 
 from ipsilon.util.log import Log
-from ipsilon.util.plugin import PluginLoader, PluginObject
-from ipsilon.util.plugin import PluginInstaller
+from ipsilon.util.plugin import PluginInstaller, PluginLoader
+from ipsilon.util.plugin import PluginObject, PluginConfig
 
 
-class InfoProviderBase(PluginObject):
+class InfoProviderBase(PluginConfig, PluginObject):
 
     def __init__(self):
-        super(InfoProviderBase, self).__init__()
+        PluginConfig.__init__(self)
+        PluginObject.__init__(self)
+        self._site = None
+        self.is_enabled = False
 
     def get_user_attrs(self, user):
         raise NotImplementedError
 
+    def enable(self, site):
+        if self.is_enabled:
+            return
+
+        if not self._site:
+            self._site = site
+        plugins = self._site[FACILITY]
+
+        # configure self
+        if self.name in plugins['config']:
+            self.import_config(plugins['config'][self.name])
+
+        plugins['enabled'].append(self)
+        self.is_enabled = True
+        self.debug('Info plugin enabled: %s' % self.name)
+
+    def disable(self, site):
+        if not self.is_enabled:
+            return
+
+        plugins = self._site[FACILITY]
+        plugins['enabled'].remove(self)
+        self.is_enabled = False
+        self.debug('Info plugin disabled: %s' % self.name)
+
+
+class InfoMapping(Log):
+
+    def __init__(self):
+        self.standard_attributes = {
+            'fullname': 'Full Name',
+            'nickname': 'Nickname',
+            'surname': 'Last Name',
+            'firstname': 'First Name',
+            'title': 'Title',
+            'dob': 'Date of Birth',
+            'email': 'E-mail Address',
+            'gender': 'Gender',
+            'postcode': 'Postal Code',
+            'street': 'Street Address',
+            'state': 'State or Province',
+            'country': 'Country',
+            'phone': 'Telephone Number',
+            'language': 'Language',
+            'timezone': 'Time Zone',
+        }
+        self.mapping = dict()
+
+    def set_mapping(self, attrs_map):
+        self.mapping = attrs_map
+
+    def display_name(self, name):
+        if name in self.standard_attributes:
+            return self.standard_attributes[name]
+        return name
+
+    def map_attrs(self, attrs):
+        s = dict()
+        e = dict()
+        for a in attrs:
+            if a in self.mapping:
+                s[self.mapping[a]] = attrs[a]
+            else:
+                e[a] = attrs[a]
+
+        return s, e
+
 
 FACILITY = 'info_config'
 
 
 class Info(Log):
 
-    def __init__(self, *args, **kwargs):
-        self.providers = []
+    def __init__(self, site):
+        self._site = site
 
         loader = PluginLoader(Info, FACILITY, 'InfoProvider')
-        plugins = loader.get_plugin_data()
+        self._site[FACILITY] = loader.get_plugin_data()
+        plugins = self._site[FACILITY]
 
         available = plugins['available'].keys()
         self.debug('Available info providers: %s' % str(available))
 
+        plugins['root'] = self
         for item in plugins['whitelist']:
             self.debug('Login plugin in whitelist: %s' % item)
             if item not in plugins['available']:
                 self.debug('Info Plugin %s not found' % item)
                 continue
-            self.providers.append((item, plugins['available'][item]))
-            self.debug('Added Info plugin: %s' % item)
-
-    def get_user_attrs(self, user, provider=None):
-        if provider:
-            for p in self.providers:
-                if p[0] == provider:
-                    return p[1].get_user_attrs(user)
-        else:
-            for p in self.providers:
-                ret = p[1].get_user_attrs(user)
-                if ret:
-                    return ret
-
-        return None
+            plugins['available'][item].enable(self._site)
+
+    def get_user_attrs(self, user, requested=None):
+        plugins = self._site[FACILITY]['available']
+        result = dict()
+
+        for _, p in plugins.items():
+            if requested is None:
+                if not p.is_enabled:
+                    continue
+            else:
+                if requested != p.name:
+                    continue
+            result = p.get_user_attrs(user)
+            if result:
+                break
+
+        return result
 
 
 class InfoProviderInstaller(object):