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/data",
80
"In the local file system, where user-modifiable data files should be "
83
# In the local file system, where user-modifiable data files should be
84
# located.""", ask=False))
86
config_options.append(ConfigOption("paths/logs",
88
"""Directory where IVLE log files are stored (on the local
89
file system). Note - this must be writable by the user the IVLE server
90
process runs as (usually www-data):""",
92
# In the local file system, where IVLE error logs should be located.""",
95
config_options.append(ConfigOption("urls/public_host",
96
"public.ivle.localhost",
97
"""Hostname which will cause the server to go into "public mode",
98
providing login-free access to student's published work:""",
100
# The server goes into "public mode" if the browser sends a request with this
101
# host. This is for security reasons - we only serve public student files on a
102
# separate domain to the main IVLE site.
103
# Public mode does not use cookies, and serves only public content.
104
# Private mode (normal mode) requires login, and only serves files relevant to
105
# the logged-in user."""))
107
config_options.append(ConfigOption("media/version", None,
108
"""Version of IVLE media resources (must change on each upgrade):""",
110
# Version string for IVLE media resource URLs. When set, they are aggressively
111
# cached by the browser, so it must be either left unset or changed each time
112
# a media file is changed.""", ask=False))
114
config_options.append(ConfigOption("database/host", "localhost",
115
"""PostgreSQL Database config
116
==========================
117
Hostname of the DB server:""",
119
# Database server hostname"""))
121
config_options.append(ConfigOption("database/port", "5432",
122
"""Port of the DB server:""",
124
# Database server port"""))
126
config_options.append(ConfigOption("database/name", "ivle",
127
"""Database name:""",
131
config_options.append(ConfigOption("database/username", "postgres",
132
"""Username for DB server login:""",
134
# Database username"""))
136
config_options.append(ConfigOption("database/password", "",
137
"""Password for DB server login:
138
(Caution: This password is stored in plaintext!)""",
140
# Database password"""))
142
config_options.append(ConfigOption("auth/modules", "",
143
"""Authentication config
144
=====================
145
Comma-separated list of authentication modules.""",
147
# Comma-separated list of authentication modules.
148
# Note that auth is always enabled against the local database, and NO OTHER
149
# auth is enabled by default. This section is for specifying additional auth
151
# These refer to importable Python modules in the www/auth directory.
152
# Modules "ldap_auth" and "guest" are available in the source tree, but
153
# other modules may be plugged in to auth against organisation-specific
154
# auth backends.""", ask=False))
156
config_options.append(ConfigOption("auth/ldap_url", "ldaps://www.example.com",
157
"""(LDAP options are only relevant if "ldap" is included in the list of
159
URL for LDAP authentication server:""",
161
# URL for LDAP authentication server""", ask=False))
163
config_options.append(ConfigOption("auth/ldap_format_string",
164
"uid=%s,ou=users,o=example",
165
"""Format string for LDAP auth request:
166
(Must contain a single "%s" for the user's login name)""",
168
# Format string for LDAP auth request
169
# (Must contain a single "%s" for the user's login name)""", ask=False))
171
config_options.append(ConfigOption("auth/subject_pulldown_modules", "",
172
"""Comma-separated list of subject pulldown modules.
173
Add proprietary modules to automatically enrol students in subjects.""",
175
# Comma-separated list of subject pulldown modules.
176
# These refer to importable Python modules in the lib/pulldown_subj directory.
177
# Only "dummy_subj" is available in the source tree (an example), but
178
# other modules may be plugged in to pulldown against organisation-specific
179
# pulldown backends.""", ask=False))
181
config_options.append(ConfigOption("urls/svn_addr",
182
"http://svn.ivle.localhost/",
185
The base url for accessing subversion repositories:""",
187
# The base url for accessing subversion repositories."""))
189
config_options.append(ConfigOption("usrmgt/host", "localhost",
190
"""User Management Server config
191
============================
192
The hostname where the usrmgt-server runs:""",
194
# The hostname where the usrmgt-server runs."""))
196
config_options.append(ConfigOption("usrmgt/port", "2178",
197
"""The port where the usrmgt-server runs:""",
199
# The port where the usrmgt-server runs.""", ask=False))
201
config_options.append(ConfigOption("usrmgt/magic", None,
202
"""The password for the usrmgt-server:""",
204
# The password for the usrmgt-server.""", ask=False))
206
def query_user(default, prompt):
207
"""Prompts the user for a string, which is read from a line of stdin.
208
Exits silently if EOF is encountered. Returns the string, with spaces
209
removed from the beginning and end.
211
Returns default if a 0-length line (after spaces removed) was read.
214
# A default of None means the value will be computed specially, so we
215
# can't really tell you what it is
216
defaultstr = "computed"
217
elif isinstance(default, basestring):
218
defaultstr = '"%s"' % default
220
defaultstr = repr(default)
221
sys.stdout.write('%s\n (default: %s)\n>' % (prompt, defaultstr))
223
val = sys.stdin.readline()
224
except KeyboardInterrupt:
226
sys.stdout.write("\n")
228
sys.stdout.write("\n")
230
if val == '': sys.exit(1)
231
# If empty line, return default
233
if val == '': return default
237
# Try importing existing conf, but if we can't just set up defaults
238
# The reason for this is that these settings are used by other phases
239
# of setup besides conf, so we need to know them.
240
# Also this allows you to hit Return to accept the existing value.
242
conf = ivle.config.Config()
243
except ivle.config.ConfigError:
244
# Couldn't find a config file anywhere.
245
# Create a new blank config object (not yet bound to a file)
246
# All lookups (below) will fail, so it will be initialised with all
247
# the default values.
248
conf = ivle.config.Config(blank=True)
250
# Check that all the options are present, and if not, load the default
251
for opt in config_options:
253
conf.get_by_path(opt.option_name)
255
# If the default is None, omit it
256
# Else ConfigObj will write the string 'None' to the conf file
257
if opt.default is not None:
258
conf.set_by_path(opt.option_name, opt.default)
260
# Store comments in the conf object
261
for opt in config_options:
262
# Omitted if the key doesn't exist
263
conf.set_by_path(opt.option_name, comment=opt.comment)
265
# Set up some variables
268
# the files that will be created/overwritten
270
confdir = os.environ['IVLECONF']
272
confdir = '/etc/ivle'
274
conffile = os.path.join(confdir, 'ivle.conf')
275
plugindefaultfile = os.path.join(confdir, 'plugins.d/000default.conf')
277
# Get command-line arguments to avoid asking questions.
280
for opt in config_options:
281
optnames.append(opt.option_name + "=")
282
(opts, args) = getopt.gnu_getopt(args, "", optnames)
285
print >>sys.stderr, "Invalid arguments:", ' '.join(args)
289
# Interactive mode. Prompt the user for all the values.
291
print """This tool will create %s, prompting you for details about
292
your configuration. The file will be updated with modified options if it already
293
exists. If it does not already exist, it will be created with sane defaults and
294
restrictive permissions.
296
%s will also be overwritten with the default list of plugins.
298
Please hit Ctrl+C now if you do not wish to do this.
299
""" % (conffile, plugindefaultfile)
301
# Get information from the administrator
302
# If EOF is encountered at any time during the questioning, just exit
305
for opt in config_options:
307
conf.set_by_path(opt.option_name,
308
query_user(conf.get_by_path(opt.option_name), opt.prompt))
311
# Non-interactive mode. Parse the options.
312
for opt in config_options:
313
if '--' + opt.option_name in opts:
314
conf.set_by_path(opt.option_name,
315
opts['--' + opt.option_name])
317
# Error handling on input values
319
conf['database']['port'] = int(conf['database']['port'])
320
if (conf['database']['port'] < 0
321
or conf['database']['port'] >= 65536):
324
if conf['database']['port'] == '' or conf['database']['port'] is None:
327
print >>sys.stderr, (
328
"Invalid DB port (%s).\n"
329
"Must be an integer between 0 and 65535." %
330
repr(conf['database']['port']))
333
conf['usrmgt']['port'] = int(conf['usrmgt']['port'])
334
if (conf['usrmgt']['port'] < 0 or conf['usrmgt']['port'] >= 65536):
337
print >>sys.stderr, (
338
"Invalid user management port (%s).\n"
339
"Must be an integer between 0 and 65535." %
340
repr(conf['usrmgt']['port']))
343
# By default we generate the magic randomly.
345
conf['usrmgt']['magic'] # Throw away; just check for KeyError
347
conf['usrmgt']['magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
349
clobber_permissions = not os.path.exists(conffile)
351
# Write ./etc/ivle.conf (even if we loaded from a different filename)
352
conf.filename = conffile
353
conf.initial_comment = ["# IVLE Configuration File"]
356
# We need to restrict permissions on a new file, as it contains
357
# a nice database password.
358
if clobber_permissions:
359
os.chown(conffile, 33, 33) # chown to www-data
360
os.chmod(conffile, stat.S_IRUSR | stat.S_IWUSR) # No g/o perms!
362
print "Successfully wrote %s" % conffile
364
plugindefault = open(plugindefaultfile, 'w')
365
plugindefault.write("""# IVLE default plugin configuration file
366
[ivle.webapp.core#Plugin]
367
[ivle.webapp.admin.user#Plugin]
368
[ivle.webapp.tutorial#Plugin]
369
[ivle.webapp.admin.subject#Plugin]
370
[ivle.webapp.filesystem.browser#Plugin]
371
[ivle.webapp.filesystem.diff#Plugin]
372
[ivle.webapp.filesystem.svnlog#Plugin]
373
[ivle.webapp.filesystem.serve#Plugin]
374
[ivle.webapp.groups#Plugin]
375
[ivle.webapp.console#Plugin]
376
[ivle.webapp.security#Plugin]
377
[ivle.webapp.media#Plugin]
378
[ivle.webapp.help#Plugin]
379
[ivle.webapp.tos#Plugin]
380
[ivle.webapp.userservice#Plugin]
381
[ivle.webapp.fileservice#Plugin]
382
[ivle.webapp.submit#Plugin]
384
plugindefault.close()
385
print "Successfully wrote %s" % plugindefaultfile
388
print "You may modify the configuration at any time by editing " + conffile
396
# Print the opening spiel including the GPL notice
398
print """IVLE - Informatics Virtual Learning Environment Setup
399
Copyright (C) 2007-2009 The University of Melbourne
400
IVLE comes with ABSOLUTELY NO WARRANTY.
401
This is free software, and you are welcome to redistribute it
402
under certain conditions. See LICENSE.txt for details.
407
return configure(argv[1:])
409
if __name__ == "__main__":
added
removed
bin/ivle-config
