← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/conf/conf.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/conf/conf.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
Temporary emulation layer for the old-style conf.py configuration file.
 
22
Loads the IVLE config file and provides all of the legacy config variables.
 
23
 
 
24
May raise a RuntimeError on import if it cannot find the config file.
 
25
"""
 
26
 
 
27
import os
 
28
import sys
 
29
 
 
30
import configobj
 
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
    'python_site_packages_override': 'paths/site_packages',
 
47
    'public_host': 'urls/public_host',
 
48
    'db_host': 'database/host',
 
49
    'db_port': 'database/port',
 
50
    'db_dbname': 'database/name',
 
51
    'db_user': 'database/username',
 
52
    'db_password': 'database/password',
 
53
    'auth_modules': 'auth/modules',
 
54
    'ldap_url': 'auth/ldap_url',
 
55
    'ldap_format_string': 'auth/ldap_format_string',
 
56
    'subject_pulldown_modules': 'auth/subject_pulldown_modules',
 
57
    'svn_addr': 'urls/svn_addr',
 
58
    'usrmgt_host': 'usrmgt/host',
 
59
    'usrmgt_port': 'usrmgt/port',
 
60
    'usrmgt_magic': 'usrmgt/magic',
 
61
    'forum_secret': 'plugins/forum/secret',
 
62
}
 
63
 
 
64
for legacyopt, newopt_path in CONFIG_OPTIONS.iteritems():
 
65
    # Iterate over each segment of the path, and find the value in conf file
 
66
    try:
 
67
        value = conf
 
68
        for seg in newopt_path.split('/'):
 
69
            value = value[seg]
 
70
        globals()[legacyopt] = value
 
71
    except KeyError:
 
72
        globals()[legacyopt] = None
 
73
 
 
74
# XXX Munge some nice shiny new-style values into horrible old-style values
 
75
# IRONY: These have just been split from commas. We need to re-join it so that
 
76
# pulldown_subj and auth_modules can re-split them.
 
77
subject_pulldown_modules = ','.join(subject_pulldown_modules)
 
78
auth_modules = ','.join(auth_modules)
 
79
 
 
80
# Additional auto-generated config options
 
81
 
 
82
# Path where architecture-dependent data (including non-user-executable
 
83
# binaries) is installed.
 
84
lib_path = os.path.join(prefix, 'lib/ivle')
 
85
 
 
86
# Path where arch-independent data is installed.
 
87
share_path = os.path.join(prefix, 'share/ivle')
 
88
 
 
89
# Path where user-executable binaries are installed.
 
90
bin_path = os.path.join(prefix, 'bin')
 
91
 
 
92
# 'site-packages' directory in Python, where Python libraries are to be
 
93
# installed.
 
94
if python_site_packages_override is None:
 
95
    PYTHON_VERSION = sys.version[0:3]   # eg. "2.5"
 
96
    python_site_packages = os.path.join(prefix,
 
97
                               'lib/python%s/site-packages' % PYTHON_VERSION)
 
98
else:
 
99
    python_site_packages = python_site_packages_override
 
100
 
 
101
# In the local file system, where the student/user jails will be mounted.
 
102
# Only a single copy of the jail's system components will be stored here -
 
103
# all user jails will be virtually mounted here.
 
104
jail_base = os.path.join(data_path, 'jailmounts')
 
105
 
 
106
# In the local file system, where are the student/user file spaces located.
 
107
# The user jails are expected to be located immediately in subdirectories of
 
108
# this location. Note that no complete jails reside here - only user
 
109
# modifications.
 
110
jail_src_base = os.path.join(data_path, 'jails')
 
111
 
 
112
# In the local file system, where the template system jail will be stored.
 
113
jail_system = os.path.join(jail_src_base, '__base__')
 
114
 
 
115
# In the local file system, where the template system jail will be stored.
 
116
jail_system_build = os.path.join(jail_src_base, '__base_build__')
 
117
 
 
118
# In the local file system, where the subject content files are located.
 
119
# (The 'subjects' and 'exercises' directories).
 
120
content_path = os.path.join(data_path, 'content')
 
121
 
 
122
# In the local file system, where are the per-subject file spaces located.
 
123
# The individual subject directories are expected to be located immediately
 
124
# in subdirectories of this location.
 
125
subjects_base = os.path.join(content_path, 'subjects')
 
126
 
 
127
# In the local file system, where are the subject-independent exercise sheet
 
128
# file spaces located.
 
129
exercises_base = os.path.join(content_path, 'exercises')
 
130
 
 
131
# In the local file system, where the system notices are stored (such as terms
 
132
# of service and MOTD).
 
133
notices_path = os.path.join(data_path, 'notices')
 
134
 
 
135
# In the local file system, where is the Terms of Service document located.
 
136
tos_path = os.path.join(notices_path, 'tos.html')
 
137
 
 
138
# In the local file system, where is the Message of the Day document
 
139
# located. This is an HTML file (just the body fragment), which will
 
140
# be displayed on the login page. It is optional.
 
141
motd_path = os.path.join(notices_path, 'motd.html')
 
142
 
 
143
# The location of all the subversion config and repositories.
 
144
svn_path = os.path.join(data_path, 'svn')
 
145
 
 
146
# The location of the subversion configuration file used by
 
147
# apache to host the user repositories.
 
148
svn_conf = os.path.join(svn_path, 'svn.conf')
 
149
 
 
150
# The location of the subversion configuration file used by
 
151
# apache to host the user repositories.
 
152
svn_group_conf = os.path.join(svn_path, 'svn-group.conf')
 
153
 
 
154
# The root directory for the subversion repositories.
 
155
svn_repo_path = os.path.join(svn_path, 'repositories')
 
156
 
 
157
# The location of the password file used to authenticate users
 
158
# of the subversion repository from the ivle server.
 
159
svn_auth_ivle = os.path.join(svn_path, 'ivle.auth')