← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/conf/conf.py

Replaced Python config files (conf.py) with new config files system, using
    configobj (INI-file style config files).

setup.py config now produces ./etc/ivle.conf, a new-style config file.
ivle/conf/conf.py is now part of the IVLE source code. It reads the new config
file and provides the same legacy interface, so all of IVLE still functions,
including setup.py config.

Added /etc to the source tree (config files will be stored here).
Added configobj as a dependency in doc/setup/install_proc.txt.

setup.py install copies ./etc/ivle.conf into /etc/ivle/ivle.conf.

Removed boilerplate code generation from setup/configure.py (that code is now
part of ivle/conf/conf.py which is now in the source tree).

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/conf/conf.py
29
29
 
30
30
import configobj
31
31
 
32
 
import ivle.config
33
 
 
34
 
try:
35
 
    conf = ivle.config.Config(plugins=False)
36
 
except ivle.config.ConfigError, e:
37
 
    raise ImportError(str(e))
38
 
 
39
 
# This dict maps legacy config option names to new config option paths
40
 
# ('section/option_name')
41
 
CONFIG_OPTIONS = {
42
 
    'root_dir': 'urls/root',
43
 
    'prefix': 'paths/prefix',
44
 
    'data_path': 'paths/data',
45
 
    'log_path': 'paths/logs',
46
 
    'public_host': 'urls/public_host',
47
 
    'db_host': 'database/host',
48
 
    'db_port': 'database/port',
49
 
    'db_dbname': 'database/name',
50
 
    'db_user': 'database/username',
51
 
    'db_password': 'database/password',
52
 
    'auth_modules': 'auth/modules',
53
 
    'ldap_url': 'auth/ldap_url',
54
 
    'ldap_format_string': 'auth/ldap_format_string',
55
 
    'subject_pulldown_modules': 'auth/subject_pulldown_modules',
56
 
    'svn_addr': 'urls/svn_addr',
57
 
    'usrmgt_host': 'usrmgt/host',
58
 
    'usrmgt_port': 'usrmgt/port',
59
 
    'usrmgt_magic': 'usrmgt/magic',
60
 
 
61
 
    # These two are only relevant inside the jail.
62
 
    'login': 'user_info/login',
63
 
    'svn_pass': 'user_info/svn_pass',
64
 
}
65
 
 
66
 
for legacyopt, newopt_path in CONFIG_OPTIONS.iteritems():
67
 
    # Iterate over each segment of the path, and find the value in conf file
68
 
    try:
69
 
        value = conf
70
 
        for seg in newopt_path.split('/'):
71
 
            value = value[seg]
72
 
        globals()[legacyopt] = value
73
 
    except KeyError:
74
 
        globals()[legacyopt] = None
75
 
 
76
 
# XXX Munge some nice shiny new-style values into horrible old-style values
77
 
# IRONY: These have just been split from commas. We need to re-join it so that
78
 
# pulldown_subj and auth_modules can re-split them.
79
 
subject_pulldown_modules = ','.join(subject_pulldown_modules)
80
 
auth_modules = ','.join(auth_modules)
 
32
def search_conffile():
 
33
    """
 
34
    Search for the config file, and return it as a filename.
 
35
    1. Environment var IVLECONF (full filename).
 
36
    2. ./etc/ivle.conf
 
37
    3. /etc/ivle/ivle.conf
 
38
    """
 
39
    if 'IVLECONF' in os.environ:
 
40
        fname = os.environ['IVLECONF']
 
41
        if os.path.exists(fname):
 
42
            return fname
 
43
    if os.path.exists('./etc/ivle.conf'):
 
44
        return './etc/ivle.conf'
 
45
    if os.path.exists('/etc/ivle/ivle.conf'):
 
46
        return '/etc/ivle/ivle.conf'
 
47
    raise RuntimeError("Could not find IVLE config file")
 
48
 
 
49
conffile = search_conffile()
 
50
conf = configobj.ConfigObj(conffile)
 
51
 
 
52
CONFIG_OPTIONS = ('root_dir', 'prefix', 'data_path', 'log_path',
 
53
    'public_host', 'allowed_uids', 'db_host', 'db_port', 'db_dbname',
 
54
    'db_forumdbname', 'db_user', 'db_password', 'auth_modules', 'ldap_url',
 
55
    'ldap_format_string', 'subject_pulldown_modules', 'svn_addr',
 
56
    'usrmgt_host', 'usrmgt_port', 'usrmgt_magic', 'forum_secret'
 
57
    )
 
58
 
 
59
for opt in CONFIG_OPTIONS:
 
60
    globals()[opt] = conf[opt]
 
61
 
 
62
# XXX Convert db_port and usrmgt_port to int.
 
63
# Because.
 
64
db_port = int(db_port)
 
65
usrmgt_port = int(usrmgt_port)
81
66
 
82
67
# Additional auto-generated config options
83
68
 
91
76
# Path where user-executable binaries are installed.
92
77
bin_path = os.path.join(prefix, 'bin')
93
78
 
 
79
# 'site-packages' directory in Python, where Python libraries are to be
 
80
# installed.
 
81
PYTHON_VERSION = sys.version[0:3]   # eg. "2.5"
 
82
python_site_packages = os.path.join(prefix,
 
83
                           'lib/python%s/site-packages' % PYTHON_VERSION)
 
84
 
94
85
# In the local file system, where the student/user jails will be mounted.
95
86
# Only a single copy of the jail's system components will be stored here -
96
87
# all user jails will be virtually mounted here.
97
 
# XXX: Some jail code calls ivle.studpath.url_to_{local,jailpaths}, both
98
 
#      of which use jail_base. Note that they don't use the bits of the
99
 
#      return value that depend on jail_base, so it can be any string inside
100
 
#      the jail. The value computed here may be meaningless inside the jail,
101
 
#      but that's OK for now.
102
88
jail_base = os.path.join(data_path, 'jailmounts')
103
89
 
104
90
# In the local file system, where are the student/user file spaces located.
117
103
# (The 'subjects' and 'exercises' directories).
118
104
content_path = os.path.join(data_path, 'content')
119
105
 
 
106
# In the local file system, where are the per-subject file spaces located.
 
107
# The individual subject directories are expected to be located immediately
 
108
# in subdirectories of this location.
 
109
subjects_base = os.path.join(content_path, 'subjects')
 
110
 
 
111
# In the local file system, where are the subject-independent exercise sheet
 
112
# file spaces located.
 
113
exercises_base = os.path.join(content_path, 'exercises')
 
114
 
120
115
# In the local file system, where the system notices are stored (such as terms
121
116
# of service and MOTD).
122
117
notices_path = os.path.join(data_path, 'notices')