← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/config/__init__.py

Move the plugin loading/indexing logic into ivle.config.Config.
Also eliminate plugins_HACK, looking in a configuration file instead.

req.config is now set to a Config instance, and things that need to look
at plugins ask it.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/config/__init__.py
22
22
"""
23
23
 
24
24
import os
 
25
import glob
 
26
import inspect
25
27
 
26
28
from configobj import ConfigObj
27
29
from validate import Validator
34
36
    """
35
37
    pass
36
38
 
37
 
def search_conffile():
 
39
def search_confdir():
38
40
    """
39
41
    Search for the config file, and return it as a filename.
40
42
    1. Environment var IVLECONF (path to directory)
42
44
    Raises a ConfigError on error.
43
45
    """
44
46
    if 'IVLECONF' in os.environ:
45
 
        fname = os.path.join(os.environ['IVLECONF'], 'ivle.conf')
 
47
        fname = os.path.join(os.environ['IVLECONF'])
46
48
        if os.path.exists(fname):
47
49
            return fname
48
 
    if os.path.exists('/etc/ivle/ivle.conf'):
49
 
        return '/etc/ivle/ivle.conf'
50
 
    raise ConfigError("Could not find IVLE config file")
 
50
    if os.path.exists('/etc/ivle'):
 
51
        return '/etc/ivle'
 
52
    raise ConfigError("Could not find IVLE config directory")
 
53
 
 
54
def get_plugin(pluginstr):
 
55
    plugin_path, classname = pluginstr.split('#')
 
56
    # Load the plugin module from somewhere in the Python path
 
57
    # (Note that plugin_path is a fully-qualified Python module name).
 
58
    return (plugin_path,
 
59
            getattr(__import__(plugin_path, fromlist=[classname]), classname))
51
60
 
52
61
_NO_VALUE = []
53
62
class Config(ConfigObj):
58
67
    Automatically validates the file against the spec (found in
59
68
    ./ivle-spec.conf relative to this module).
60
69
    """
61
 
    def __init__(self, blank=False, *args, **kwargs):
 
70
    def __init__(self, blank=False, plugins=True, *args, **kwargs):
62
71
        """Initialises a new Config object. Searches for the config file,
63
72
        loads it, and validates it.
64
73
        @param blank: If blank=True, will create a blank config instead, and
65
74
        not search for the config file.
 
75
        @param plugins: If True, will find and index plugins.
66
76
        @raise ConfigError: If the config file cannot be found.
67
77
        """
68
78
        specfile = os.path.join(os.path.dirname(__file__), 'ivle-spec.conf')
69
79
        if blank:
70
80
            super(Config, self).__init__(configspec=specfile, *args, **kwargs)
71
81
        else:
72
 
            conffile = search_conffile()
 
82
            confdir = search_confdir()
 
83
            conffile = os.path.join(confdir, 'ivle.conf')
73
84
            super(Config, self).__init__(infile=conffile, configspec=specfile,
74
85
                                         *args, **kwargs)
75
86
            # XXX This doesn't raise errors if it doesn't validate
76
87
            self.validate(Validator())
77
88
 
 
89
            if not plugins:
 
90
                return
 
91
            self.plugins = {}
 
92
            self.plugin_configs = {}
 
93
            # Go through the plugin config files, looking for plugins.
 
94
            for pconfn in glob.glob(os.path.join(confdir, 'plugins.d/*.conf')):
 
95
                pconf = ConfigObj(pconfn)
 
96
                for plugin_section in pconf:
 
97
                    # We have a plugin path. Resolve it into a class...
 
98
                    plugin_path, plugin = get_plugin(plugin_section)
 
99
                    self.plugins[plugin_path] = plugin
 
100
                    # ... and add it to the registry.
 
101
                    self.plugin_configs[plugin] = pconf[plugin_section]
 
102
 
 
103
            # Create a registry mapping plugin classes to paths.
 
104
            self.reverse_plugins = dict([(v, k) for (k, v) in
 
105
                                         self.plugins.items()])
 
106
 
 
107
            # Create an index of plugins by base class.
 
108
            self.plugin_index = {}
 
109
            for plugin in self.plugins.values():
 
110
                # Getmro returns a tuple of all the super-classes of the plugin
 
111
                for base in inspect.getmro(plugin):
 
112
                    if base not in self.plugin_index:
 
113
                        self.plugin_index[base] = []
 
114
                    self.plugin_index[base].append(plugin)
 
115
 
78
116
    def set_by_path(self, path, value=_NO_VALUE, comment=None):
79
117
        """Writes a value to an option, given a '/'-separated path.
80
118
        @param path: '/'-separated path to configuration option.