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

1092.1.11 by Matt Giuca
Replaced Python config files (conf.py) with new config files system, using
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
1092.1.14 by Matt Giuca
Added module ivle.config, which takes care of some work interfacing with
32
import ivle.config
1092.1.11 by Matt Giuca
Replaced Python config files (conf.py) with new config files system, using
33
1092.1.12 by Matt Giuca
Changed new-style config file to a hierarchical one with nice shiny new names.
34
try:
1092.1.14 by Matt Giuca
Added module ivle.config, which takes care of some work interfacing with
35
    conf = ivle.config.Config()
36
except ivle.config.ConfigError, e:
1092.1.12 by Matt Giuca
Changed new-style config file to a hierarchical one with nice shiny new names.
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
    'allowed_uids': 'os/allowed_uids',
49
    'db_host': 'database/host',
50
    'db_port': 'database/port',
51
    'db_dbname': 'database/name',
52
    'db_forumdbname': 'plugins/forum/dbname',
53
    'db_user': 'database/username',
54
    'db_password': 'database/password',
55
    'auth_modules': 'auth/modules',
56
    'ldap_url': 'auth/ldap_url',
57
    'ldap_format_string': 'auth/ldap_format_string',
58
    'subject_pulldown_modules': 'auth/subject_pulldown_modules',
59
    'svn_addr': 'urls/svn_addr',
60
    'usrmgt_host': 'usrmgt/host',
61
    'usrmgt_port': 'usrmgt/port',
62
    'usrmgt_magic': 'usrmgt/magic',
63
    'forum_secret': 'plugins/forum/secret',
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)
1092.1.19 by William Grant
Fix a bug in the ivle.conf emulation layer, where allowed_uids was a list
81
allowed_uids = ','.join([str(uid) for uid in allowed_uids])
1092.1.11 by Matt Giuca
Replaced Python config files (conf.py) with new config files system, using
82
83
# Additional auto-generated config options
84
85
# Path where architecture-dependent data (including non-user-executable
86
# binaries) is installed.
87
lib_path = os.path.join(prefix, 'lib/ivle')
88
89
# Path where arch-independent data is installed.
90
share_path = os.path.join(prefix, 'share/ivle')
91
92
# Path where user-executable binaries are installed.
93
bin_path = os.path.join(prefix, 'bin')
94
95
# 'site-packages' directory in Python, where Python libraries are to be
96
# installed.
1092.1.12 by Matt Giuca
Changed new-style config file to a hierarchical one with nice shiny new names.
97
if python_site_packages_override is None:
98
    PYTHON_VERSION = sys.version[0:3]   # eg. "2.5"
99
    python_site_packages = os.path.join(prefix,
100
                               'lib/python%s/site-packages' % PYTHON_VERSION)
101
else:
102
    python_site_packages = python_site_packages_override
1092.1.11 by Matt Giuca
Replaced Python config files (conf.py) with new config files system, using
103
104
# In the local file system, where the student/user jails will be mounted.
105
# Only a single copy of the jail's system components will be stored here -
106
# all user jails will be virtually mounted here.
107
jail_base = os.path.join(data_path, 'jailmounts')
108
109
# In the local file system, where are the student/user file spaces located.
110
# The user jails are expected to be located immediately in subdirectories of
111
# this location. Note that no complete jails reside here - only user
112
# modifications.
113
jail_src_base = os.path.join(data_path, 'jails')
114
115
# In the local file system, where the template system jail will be stored.
116
jail_system = os.path.join(jail_src_base, '__base__')
117
118
# In the local file system, where the template system jail will be stored.
119
jail_system_build = os.path.join(jail_src_base, '__base_build__')
120
121
# In the local file system, where the subject content files are located.
122
# (The 'subjects' and 'exercises' directories).
123
content_path = os.path.join(data_path, 'content')
124
125
# In the local file system, where are the per-subject file spaces located.
126
# The individual subject directories are expected to be located immediately
127
# in subdirectories of this location.
128
subjects_base = os.path.join(content_path, 'subjects')
129
130
# In the local file system, where are the subject-independent exercise sheet
131
# file spaces located.
132
exercises_base = os.path.join(content_path, 'exercises')
133
134
# In the local file system, where the system notices are stored (such as terms
135
# of service and MOTD).
136
notices_path = os.path.join(data_path, 'notices')
137
138
# In the local file system, where is the Terms of Service document located.
139
tos_path = os.path.join(notices_path, 'tos.html')
140
141
# In the local file system, where is the Message of the Day document
142
# located. This is an HTML file (just the body fragment), which will
143
# be displayed on the login page. It is optional.
144
motd_path = os.path.join(notices_path, 'motd.html')
145
146
# The location of all the subversion config and repositories.
147
svn_path = os.path.join(data_path, 'svn')
148
149
# The location of the subversion configuration file used by
150
# apache to host the user repositories.
151
svn_conf = os.path.join(svn_path, 'svn.conf')
152
153
# The location of the subversion configuration file used by
154
# apache to host the user repositories.
155
svn_group_conf = os.path.join(svn_path, 'svn-group.conf')
156
157
# The root directory for the subversion repositories.
158
svn_repo_path = os.path.join(svn_path, 'repositories')
159
160
# The location of the password file used to authenticate users
161
# of the subversion repository from the ivle server.
162
svn_auth_ivle = os.path.join(svn_path, 'ivle.auth')