← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/config/__init__.py

Add an ivle-createdatadirs script, to create the hierarchy under /var/lib/ivle.

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
 
 
26
from configobj import ConfigObj
 
27
from validate import Validator
 
28
 
 
29
__all__ = ["ConfigError", "Config"]
 
30
 
 
31
class ConfigError(Exception):
 
32
    """
 
33
    An error reading or writing the configuration file.
 
34
    """
 
35
    pass
 
36
 
 
37
def search_conffile():
 
38
    """
 
39
    Search for the config file, and return it as a filename.
 
40
    1. Environment var IVLECONF (path to directory)
 
41
    2. /etc/ivle/ivle.conf
 
42
    Raises a ConfigError on error.
 
43
    """
 
44
    if 'IVLECONF' in os.environ:
 
45
        fname = os.path.join(os.environ['IVLECONF'], 'ivle.conf')
 
46
        if os.path.exists(fname):
 
47
            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")
 
51
 
 
52
_NO_VALUE = []
 
53
class Config(ConfigObj):
 
54
    """
 
55
    The configuration object. Can be instantiated with no arguments (will
 
56
    implicitly find the ivle.conf file and load it).
 
57
 
 
58
    Automatically validates the file against the spec (found in
 
59
    ./ivle-spec.conf relative to this module).
 
60
    """
 
61
    def __init__(self, blank=False, *args, **kwargs):
 
62
        """Initialises a new Config object. Searches for the config file,
 
63
        loads it, and validates it.
 
64
        @param blank: If blank=True, will create a blank config instead, and
 
65
        not search for the config file.
 
66
        @raise ConfigError: If the config file cannot be found.
 
67
        """
 
68
        specfile = os.path.join(os.path.dirname(__file__), 'ivle-spec.conf')
 
69
        if blank:
 
70
            super(Config, self).__init__(configspec=specfile, *args, **kwargs)
 
71
        else:
 
72
            conffile = search_conffile()
 
73
            super(Config, self).__init__(infile=conffile, configspec=specfile,
 
74
                                         *args, **kwargs)
 
75
            # XXX This doesn't raise errors if it doesn't validate
 
76
            self.validate(Validator())
 
77
 
 
78
    def set_by_path(self, path, value=_NO_VALUE, comment=None):
 
79
        """Writes a value to an option, given a '/'-separated path.
 
80
        @param path: '/'-separated path to configuration option.
 
81
        @param value: Optional - value to write to the option.
 
82
        @param comment: Optional - comment string (lines separated by '\n's).
 
83
        Note: If only a comment is being inserted, and the value does not
 
84
        exist, fails silently.
 
85
        """
 
86
        path = path.split('/')
 
87
        # Iterate over each segment of the path, and find the section in conf
 
88
        # file to insert the value into (use all but the last path segment)
 
89
        conf_section = self
 
90
        for seg in path[:-1]:
 
91
            # Create the section if it isn't there
 
92
            if seg not in conf_section:
 
93
                conf_section[seg] = {}
 
94
            conf_section = conf_section[seg]
 
95
        # The final path segment names the key to insert into
 
96
        keyname = path[-1]
 
97
        if value is not _NO_VALUE:
 
98
            conf_section[keyname] = value
 
99
        if comment is not None:
 
100
            try:
 
101
                conf_section[keyname]
 
102
            except KeyError:
 
103
                pass        # Fail silently
 
104
            else:
 
105
                conf_section.comments[keyname] = comment.split('\n')
 
106
 
 
107
    def get_by_path(self, path):
 
108
        """Gets an option's value, given a '/'-separated path.
 
109
        @param path: '/'-separated path to configuration option.
 
110
        @raise KeyError: if no config option is at that path.
 
111
        """
 
112
        # Iterate over each segment of the path, and find the value in conf file
 
113
        value = self
 
114
        for seg in path.split('/'):
 
115
            value = value[seg]      # May raise KeyError
 
116
        return value