[tests] adapt events tests to recent changes
[leap_pycommon.git] / src / leap / common / plugins.py
1 # -*- coding: utf-8 -*-
2 # plugins.py
3 # Copyright (C) 2015 LEAP
4 #
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.
9 #
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.
14 #
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/>.
17 """
18 Twisted plugins leap utilities.
19 """
20 import os.path
21
22 from twisted.plugin import getPlugins
23
24 from leap.common.config import get_path_prefix
25
26 # A whitelist of modules from where to collect plugins dynamically.
27 # For the moment restricted to leap namespace, but the idea is that we can pass
28 # other "trusted" modules as options to the initialization of soledad.
29
30 # TODO discover all the namespace automagically
31
32 PLUGGABLE_LEAP_MODULES = ('mail', 'keymanager')
33
34 _preffix = get_path_prefix()
35 rc_file = os.path.join(_preffix, "leap", "leap.cfg")
36
37
38 def _get_extra_pluggable_modules():
39     import ConfigParser
40     config = ConfigParser.RawConfigParser()
41     config.read(rc_file)
42     try:
43         modules = eval(
44             config.get('plugins', 'extra_pluggable_modules'), {}, {})
45     except (ConfigParser.NoSectionError, ConfigParser.NoOptionError,
46             ConfigParser.MissingSectionHeaderError):
47         modules = []
48     return modules
49
50 if os.path.isfile(rc_file):
51     # TODO in the case of being called from the standalone client,
52     # we should pass the flag in some other way.
53     EXTRA_PLUGGABLE_MODULES = _get_extra_pluggable_modules()
54 else:
55     EXTRA_PLUGGABLE_MODULES = []
56
57
58 def collect_plugins(interface):
59     """
60     Traverse a whitelist of modules and collect all the plugins that implement
61     the passed interface.
62     """
63     plugins = []
64     for namespace in PLUGGABLE_LEAP_MODULES:
65         try:
66             module = __import__('leap.%s.plugins' % namespace, fromlist='.')
67             plugins = plugins + list(getPlugins(interface, module))
68         except ImportError:
69             pass
70     for namespace in EXTRA_PLUGGABLE_MODULES:
71         try:
72             module = __import__('%s.plugins' % namespace, fromlist='.')
73             plugins = plugins + list(getPlugins(interface, module))
74         except ImportError:
75             pass
76     return plugins