2
# IVLE - Informatics Virtual Learning Environment
3
# Copyright (C) 2007-2009 The University of Melbourne
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19
# Author: Matt Giuca, Refactored by David Coles
21
'''Configures IVLE with machine-specific details, most notably, various paths.
22
Either prompts the administrator for these details or accepts them as
41
"""A configuration option; one of the things written to conf.py."""
42
def __init__(self, option_name, default, prompt, comment, ask=True):
43
"""Creates a configuration option.
44
option_name: Name of the variable in conf.py. Also name of the
45
command-line argument to setup.py conf.
46
default: Default value for this variable.
47
prompt: (Short) string presented during the interactive prompt in
49
comment: (Long) comment string stored in conf.py. Each line of this
50
string should begin with a '#'.
51
ask: Whether to ask the question in the default config run.
53
self.option_name = option_name
54
self.default = default
56
self.comment = comment
59
# Configuration options, defaults and descriptions
62
config_options.append(ConfigOption("urls/root", "/",
63
"""Root directory where IVLE is located (in URL space):""",
65
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
67
# eg. "/" or "/ivle".""", ask=False))
69
config_options.append(ConfigOption("paths/prefix", "/usr/local",
70
"""In the local file system, the prefix to the system directory where IVLE
71
is installed. (This should either be /usr or /usr/local):""",
73
# In the local file system, the prefix to the system directory where IVLE is
74
# installed. This should either be '/usr' or '/usr/local'.
75
# ('/usr/local' for the usual install, '/usr' for distribution packages)""",
78
config_options.append(ConfigOption("paths/site_packages",
80
"""site-packages directory in Python, where Python libraries are to be
81
installed. May be left as the default, in which case the value will be
82
computed from prefix and the current Python version:""",
84
# 'site-packages' directory in Python, where Python libraries are to be
85
# installed. May be omitted (recommended), in which case the value will be
86
# computed from prefix and the current Python version.""", ask=False))
88
config_options.append(ConfigOption("paths/data",
90
"In the local file system, where user-modifiable data files should be "
93
# In the local file system, where user-modifiable data files should be
94
# located.""", ask=False))
96
config_options.append(ConfigOption("paths/logs",
98
"""Directory where IVLE log files are stored (on the local
99
file system). Note - this must be writable by the user the IVLE server
100
process runs as (usually www-data):""",
102
# In the local file system, where IVLE error logs should be located.""",
105
config_options.append(ConfigOption("urls/public_host", "public.localhost",
106
"""Hostname which will cause the server to go into "public mode",
107
providing login-free access to student's published work:""",
109
# The server goes into "public mode" if the browser sends a request with this
110
# host. This is for security reasons - we only serve public student files on a
111
# separate domain to the main IVLE site.
112
# Public mode does not use cookies, and serves only public content.
113
# Private mode (normal mode) requires login, and only serves files relevant to
114
# the logged-in user."""))
116
config_options.append(ConfigOption("media/version", None,
117
"""Version of IVLE media resources (must change on each upgrade):""",
119
# Version string for IVLE media resource URLs. When set, they are aggressively
120
# cached by the browser, so it must be either left unset or changed each time
121
# a media file is changed.""", ask=False))
123
config_options.append(ConfigOption("database/host", "localhost",
124
"""PostgreSQL Database config
125
==========================
126
Hostname of the DB server:""",
128
# Database server hostname"""))
130
config_options.append(ConfigOption("database/port", "5432",
131
"""Port of the DB server:""",
133
# Database server port"""))
135
config_options.append(ConfigOption("database/name", "ivle",
136
"""Database name:""",
140
config_options.append(ConfigOption("database/username", "postgres",
141
"""Username for DB server login:""",
143
# Database username"""))
145
config_options.append(ConfigOption("database/password", "",
146
"""Password for DB server login:
147
(Caution: This password is stored in plaintext!)""",
149
# Database password"""))
151
config_options.append(ConfigOption("auth/modules", "",
152
"""Authentication config
153
=====================
154
Comma-separated list of authentication modules.""",
156
# Comma-separated list of authentication modules.
157
# Note that auth is always enabled against the local database, and NO OTHER
158
# auth is enabled by default. This section is for specifying additional auth
160
# These refer to importable Python modules in the www/auth directory.
161
# Modules "ldap_auth" and "guest" are available in the source tree, but
162
# other modules may be plugged in to auth against organisation-specific
163
# auth backends.""", ask=False))
165
config_options.append(ConfigOption("auth/ldap_url", "ldaps://www.example.com",
166
"""(LDAP options are only relevant if "ldap" is included in the list of
168
URL for LDAP authentication server:""",
170
# URL for LDAP authentication server""", ask=False))
172
config_options.append(ConfigOption("auth/ldap_format_string",
173
"uid=%s,ou=users,o=example",
174
"""Format string for LDAP auth request:
175
(Must contain a single "%s" for the user's login name)""",
177
# Format string for LDAP auth request
178
# (Must contain a single "%s" for the user's login name)""", ask=False))
180
config_options.append(ConfigOption("auth/subject_pulldown_modules", "",
181
"""Comma-separated list of subject pulldown modules.
182
Add proprietary modules to automatically enrol students in subjects.""",
184
# Comma-separated list of subject pulldown modules.
185
# These refer to importable Python modules in the lib/pulldown_subj directory.
186
# Only "dummy_subj" is available in the source tree (an example), but
187
# other modules may be plugged in to pulldown against organisation-specific
188
# pulldown backends.""", ask=False))
190
config_options.append(ConfigOption("urls/svn_addr", "http://svn.localhost/",
193
The base url for accessing subversion repositories:""",
195
# The base url for accessing subversion repositories."""))
197
config_options.append(ConfigOption("usrmgt/host", "localhost",
198
"""User Management Server config
199
============================
200
The hostname where the usrmgt-server runs:""",
202
# The hostname where the usrmgt-server runs."""))
204
config_options.append(ConfigOption("usrmgt/port", "2178",
205
"""The port where the usrmgt-server runs:""",
207
# The port where the usrmgt-server runs.""", ask=False))
209
config_options.append(ConfigOption("usrmgt/magic", None,
210
"""The password for the usrmgt-server:""",
212
# The password for the usrmgt-server.""", ask=False))
214
def query_user(default, prompt):
215
"""Prompts the user for a string, which is read from a line of stdin.
216
Exits silently if EOF is encountered. Returns the string, with spaces
217
removed from the beginning and end.
219
Returns default if a 0-length line (after spaces removed) was read.
222
# A default of None means the value will be computed specially, so we
223
# can't really tell you what it is
224
defaultstr = "computed"
225
elif isinstance(default, basestring):
226
defaultstr = '"%s"' % default
228
defaultstr = repr(default)
229
sys.stdout.write('%s\n (default: %s)\n>' % (prompt, defaultstr))
231
val = sys.stdin.readline()
232
except KeyboardInterrupt:
234
sys.stdout.write("\n")
236
sys.stdout.write("\n")
238
if val == '': sys.exit(1)
239
# If empty line, return default
241
if val == '': return default
245
# Try importing existing conf, but if we can't just set up defaults
246
# The reason for this is that these settings are used by other phases
247
# of setup besides conf, so we need to know them.
248
# Also this allows you to hit Return to accept the existing value.
250
conf = ivle.config.Config()
251
except ivle.config.ConfigError:
252
# Couldn't find a config file anywhere.
253
# Create a new blank config object (not yet bound to a file)
254
# All lookups (below) will fail, so it will be initialised with all
255
# the default values.
256
conf = ivle.config.Config(blank=True)
258
# Check that all the options are present, and if not, load the default
259
for opt in config_options:
261
conf.get_by_path(opt.option_name)
263
# If the default is None, omit it
264
# Else ConfigObj will write the string 'None' to the conf file
265
if opt.default is not None:
266
conf.set_by_path(opt.option_name, opt.default)
268
# Store comments in the conf object
269
for opt in config_options:
270
# Omitted if the key doesn't exist
271
conf.set_by_path(opt.option_name, comment=opt.comment)
273
# Set up some variables
276
# the files that will be created/overwritten
278
confdir = os.environ['IVLECONF']
280
confdir = '/etc/ivle'
282
conffile = os.path.join(confdir, 'ivle.conf')
283
plugindefaultfile = os.path.join(confdir, 'plugins.d/000default.conf')
285
# Get command-line arguments to avoid asking questions.
288
for opt in config_options:
289
optnames.append(opt.option_name + "=")
290
(opts, args) = getopt.gnu_getopt(args, "", optnames)
293
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
297
# Interactive mode. Prompt the user for all the values.
299
print """This tool will create %s, prompting you for details about
300
your configuration. The file will be updated with modified options if it already
301
exists. If it does not already exist, it will be created with sane defaults and
302
restrictive permissions.
304
%s will also be overwritten with the default list of plugins.
306
Please hit Ctrl+C now if you do not wish to do this.
307
""" % (conffile, plugindefaultfile)
309
# Get information from the administrator
310
# If EOF is encountered at any time during the questioning, just exit
313
for opt in config_options:
315
conf.set_by_path(opt.option_name,
316
query_user(conf.get_by_path(opt.option_name), opt.prompt))
319
# Non-interactive mode. Parse the options.
320
for opt in config_options:
321
if '--' + opt.option_name in opts:
322
conf.set_by_path(opt.option_name,
323
opts['--' + opt.option_name])
325
# Error handling on input values
327
conf['database']['port'] = int(conf['database']['port'])
328
if (conf['database']['port'] < 0
329
or conf['database']['port'] >= 65536):
332
if conf['database']['port'] == '' or conf['database']['port'] is None:
335
print >>sys.stderr, (
336
"Invalid DB port (%s).\n"
337
"Must be an integer between 0 and 65535." %
338
repr(conf['database']['port']))
341
conf['usrmgt']['port'] = int(conf['usrmgt']['port'])
342
if (conf['usrmgt']['port'] < 0 or conf['usrmgt']['port'] >= 65536):
345
print >>sys.stderr, (
346
"Invalid user management port (%s).\n"
347
"Must be an integer between 0 and 65535." %
348
repr(conf['usrmgt']['port']))
351
# By default we generate the magic randomly.
353
conf['usrmgt']['magic'] # Throw away; just check for KeyError
355
conf['usrmgt']['magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
357
clobber_permissions = not os.path.exists(conffile)
359
# Write ./etc/ivle.conf (even if we loaded from a different filename)
360
conf.filename = conffile
361
conf.initial_comment = ["# IVLE Configuration File"]
364
# We need to restrict permissions on a new file, as it contains
365
# a nice database password.
366
if clobber_permissions:
367
os.chown(conffile, 33, 33) # chown to www-data
368
os.chmod(conffile, stat.S_IRUSR | stat.S_IWUSR) # No g/o perms!
370
print "Successfully wrote %s" % conffile
372
plugindefault = open(plugindefaultfile, 'w')
373
plugindefault.write("""# IVLE default plugin configuration file
374
[ivle.webapp.core#Plugin]
375
[ivle.webapp.admin.user#Plugin]
376
[ivle.webapp.tutorial#Plugin]
377
[ivle.webapp.admin.subject#Plugin]
378
[ivle.webapp.filesystem.browser#Plugin]
379
[ivle.webapp.filesystem.diff#Plugin]
380
[ivle.webapp.filesystem.svnlog#Plugin]
381
[ivle.webapp.filesystem.serve#Plugin]
382
[ivle.webapp.groups#Plugin]
383
[ivle.webapp.console#Plugin]
384
[ivle.webapp.security#Plugin]
385
[ivle.webapp.media#Plugin]
386
[ivle.webapp.help#Plugin]
387
[ivle.webapp.tos#Plugin]
388
[ivle.webapp.userservice#Plugin]
389
[ivle.webapp.fileservice#Plugin]
390
[ivle.webapp.submit#Plugin]
392
plugindefault.close()
393
print "Successfully wrote %s" % plugindefaultfile
396
print "You may modify the configuration at any time by editing " + conffile
404
# Print the opening spiel including the GPL notice
406
print """IVLE - Informatics Virtual Learning Environment Setup
407
Copyright (C) 2007-2009 The University of Melbourne
408
IVLE comes with ABSOLUTELY NO WARRANTY.
409
This is free software, and you are welcome to redistribute it
410
under certain conditions. See LICENSE.txt for details.
415
return configure(argv[1:])
417
if __name__ == "__main__":
added
removed
bin/ivle-config
