← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/config/__init__.py

  • Committer: William Grant
  • Date: 2010-02-23 08:48:09 UTC
  • mfrom: (1673 trunk)
  • mto: This revision was merged to the branch mainline in revision 1674.
  • Revision ID: grantw@unimelb.edu.au-20100223084809-du6dvsxrjhw15ytr
Merge trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/config/__init__.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2009 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Author: Matt Giuca, Will Grant
 
19
 
 
20
"""
 
21
Provides programmatic access to the IVLE configuration file.
 
22
"""
 
23
 
 
24
import os
 
25
import glob
 
26
import inspect
 
27
 
 
28
from configobj import ConfigObj
 
29
from validate import Validator
 
30
 
 
31
__all__ = ["ConfigError", "Config"]
 
32
 
 
33
class ConfigError(Exception):
 
34
    """
 
35
    An error reading or writing the configuration file.
 
36
    """
 
37
    pass
 
38
 
 
39
def search_confdir():
 
40
    """
 
41
    Search for the config file, and return the directory it is in.
 
42
    1. Environment var IVLECONF (path to directory)
 
43
    2. /etc/ivle
 
44
    Raises a ConfigError on error.
 
45
    """
 
46
    if 'IVLECONF' in os.environ:
 
47
        fname = os.path.join(os.environ['IVLECONF'])
 
48
        if os.path.exists(fname):
 
49
            return fname
 
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))
 
60
 
 
61
_NO_VALUE = []
 
62
class Config(ConfigObj):
 
63
    """
 
64
    The configuration object. Can be instantiated with no arguments (will
 
65
    implicitly find the ivle.conf file and load it).
 
66
 
 
67
    Automatically validates the file against the spec (found in
 
68
    ./ivle-spec.conf relative to this module).
 
69
    """
 
70
    def __init__(self, blank=False, plugins=True, *args, **kwargs):
 
71
        """Initialises a new Config object. Searches for the config file,
 
72
        loads it, and validates it.
 
73
        @param blank: If blank=True, will create a blank config instead, and
 
74
        not search for the config file.
 
75
        @param plugins: If True, will find and index plugins.
 
76
        @raise ConfigError: If the config file cannot be found.
 
77
        """
 
78
        specfile = os.path.join(os.path.dirname(__file__), 'ivle-spec.conf')
 
79
        if blank:
 
80
            super(Config, self).__init__(configspec=specfile, *args, **kwargs)
 
81
        else:
 
82
            confdir = search_confdir()
 
83
            conffile = os.path.join(confdir, 'ivle.conf')
 
84
            super(Config, self).__init__(infile=conffile, configspec=specfile,
 
85
                                         interpolation='template',
 
86
                                         *args, **kwargs)
 
87
            # XXX This doesn't raise errors if it doesn't validate
 
88
            self.validate(Validator())
 
89
 
 
90
            if not plugins:
 
91
                return
 
92
            self.plugins = {}
 
93
            self.plugin_configs = {}
 
94
            # Go through the plugin config files, looking for plugins.
 
95
            for pconfn in glob.glob(os.path.join(confdir, 'plugins.d/*.conf')):
 
96
                pconf = ConfigObj(pconfn)
 
97
                for plugin_section in pconf:
 
98
                    # We have a plugin path. Resolve it into a class...
 
99
                    plugin_path, plugin = get_plugin(plugin_section)
 
100
                    self.plugins[plugin_path] = plugin
 
101
                    # ... and add it to the registry.
 
102
                    self.plugin_configs[plugin] = pconf[plugin_section]
 
103
 
 
104
            # Create a registry mapping plugin classes to paths.
 
105
            self.reverse_plugins = dict([(v, k) for (k, v) in
 
106
                                         self.plugins.items()])
 
107
 
 
108
            # Create an index of plugins by base class.
 
109
            self.plugin_index = {}
 
110
            for plugin in self.plugins.values():
 
111
                # Getmro returns a tuple of all the super-classes of the plugin
 
112
                for base in inspect.getmro(plugin):
 
113
                    if base not in self.plugin_index:
 
114
                        self.plugin_index[base] = []
 
115
                    self.plugin_index[base].append(plugin)
 
116
 
 
117
    def set_by_path(self, path, value=_NO_VALUE, comment=None):
 
118
        """Writes a value to an option, given a '/'-separated path.
 
119
        @param path: '/'-separated path to configuration option.
 
120
        @param value: Optional - value to write to the option.
 
121
        @param comment: Optional - comment string (lines separated by '\n's).
 
122
        Note: If only a comment is being inserted, and the value does not
 
123
        exist, fails silently.
 
124
        """
 
125
        path = path.split('/')
 
126
        # Iterate over each segment of the path, and find the section in conf
 
127
        # file to insert the value into (use all but the last path segment)
 
128
        conf_section = self
 
129
        for seg in path[:-1]:
 
130
            # Create the section if it isn't there
 
131
            if seg not in conf_section:
 
132
                conf_section[seg] = {}
 
133
            conf_section = conf_section[seg]
 
134
        # The final path segment names the key to insert into
 
135
        keyname = path[-1]
 
136
        if value is not _NO_VALUE:
 
137
            conf_section[keyname] = value
 
138
        if comment is not None:
 
139
            try:
 
140
                conf_section[keyname]
 
141
            except KeyError:
 
142
                pass        # Fail silently
 
143
            else:
 
144
                conf_section.comments[keyname] = comment.split('\n')
 
145
 
 
146
    def get_by_path(self, path):
 
147
        """Gets an option's value, given a '/'-separated path.
 
148
        @param path: '/'-separated path to configuration option.
 
149
        @raise KeyError: if no config option is at that path.
 
150
        """
 
151
        # Iterate over each segment of the path, and find the value in conf file
 
152
        value = self
 
153
        for seg in path.split('/'):
 
154
            value = value[seg]      # May raise KeyError
 
155
        return value