summaryrefslogtreecommitdiffstats
path: root/ipsilon/info/common.py
blob: c4be8fe8b3e012b23d1afe3474caa060ec4c3db5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
#!/usr/bin/python
#
# Copyright (C) 2014 Ipsilon Project Contributors
#
# 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


class InfoProviderBase(PluginObject, Log):

    def __init__(self):
        super(InfoProviderBase, self).__init__()
        self.enabled = False

    def get_user_attrs(self, user):
        raise NotImplementedError

    @property
    def is_enabled(self):
        return self.enabled

    def enable(self, site):
        self.enabled = True

        plugins = site[FACILITY]
        if self in plugins['enabled']:
            return

        # configure self
        if self.name in plugins['config']:
            self.set_config(plugins['config'][self.name])

        plugins['enabled'].append(self)
        self.debug('Info plugin enabled: %s' % self.name)

    def disable(self, site):
        self.enabled = False

        plugins = site[FACILITY]
        if self not in plugins['enabled']:
            return

        plugins['enabled'].remove(self)
        self.debug('Info plugin disabled: %s' % self.name)


FACILITY = 'info_config'


class Info(Log):

    def __init__(self, site):
        self._site = site

        loader = PluginLoader(Info, FACILITY, 'InfoProvider')
        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
            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):

    def __init__(self):
        self.facility = FACILITY
        self.ptype = 'info'
        self.name = None

    def install_args(self, group):
        raise NotImplementedError

    def configure(self, opts):
        raise NotImplementedError


class InfoProviderInstall(object):

    def __init__(self):
        pi = PluginInstaller(InfoProviderInstall)
        self.plugins = pi.get_plugins()