113
104
# Private mode (normal mode) requires login, and only serves files relevant to
114
105
# the logged-in user."""))
116
config_options.append(ConfigOption("allowed_uids", "33",
117
"""UID of the web server process which will run IVLE.
118
Only this user may execute the trampoline. May specify multiple users as
119
a comma-separated list.
107
config_options.append(ConfigOption("media/version", None,
108
"""Version of IVLE media resources (must change on each upgrade):""",
122
# The User-ID of the web server process which will run IVLE, and any other
123
# users who are allowed to run the trampoline. This is stores as a string of
124
# comma-separated integers, simply because it is not used within Python, only
125
# used by the setup program to write to conf.h (see setup.py config).""",
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))
128
config_options.append(ConfigOption("db_host", "localhost",
114
config_options.append(ConfigOption("database/host", "localhost",
129
115
"""PostgreSQL Database config
130
116
==========================
131
117
Hostname of the DB server:""",
133
### PostgreSQL Database config ###
134
119
# Database server hostname"""))
136
config_options.append(ConfigOption("db_port", "5432",
121
config_options.append(ConfigOption("database/port", "5432",
137
122
"""Port of the DB server:""",
139
124
# Database server port"""))
141
config_options.append(ConfigOption("db_dbname", "ivle",
126
config_options.append(ConfigOption("database/name", "ivle",
142
127
"""Database name:""",
144
129
# Database name"""))
146
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
147
"""Forum Database name:""",
149
# Forum Database name"""))
151
config_options.append(ConfigOption("db_user", "postgres",
131
config_options.append(ConfigOption("database/username", "postgres",
152
132
"""Username for DB server login:""",
154
134
# Database username"""))
156
config_options.append(ConfigOption("db_password", "",
136
config_options.append(ConfigOption("database/password", "",
157
137
"""Password for DB server login:
158
(Caution: This password is stored in plaintext in ivle/conf/conf.py)""",
138
(Caution: This password is stored in plaintext!)""",
160
140
# Database password"""))
162
config_options.append(ConfigOption("auth_modules", "",
142
config_options.append(ConfigOption("auth/modules", "",
163
143
"""Authentication config
164
144
=====================
165
145
Comma-separated list of authentication modules.""",
198
178
# other modules may be plugged in to pulldown against organisation-specific
199
179
# pulldown backends.""", ask=False))
201
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
181
config_options.append(ConfigOption("urls/svn_addr",
182
"http://svn.ivle.localhost/",
202
183
"""Subversion config
203
184
=================
204
185
The base url for accessing subversion repositories:""",
206
187
# The base url for accessing subversion repositories."""))
208
config_options.append(ConfigOption("usrmgt_host", "localhost",
189
config_options.append(ConfigOption("usrmgt/host", "localhost",
209
190
"""User Management Server config
210
191
============================
211
192
The hostname where the usrmgt-server runs:""",
213
194
# The hostname where the usrmgt-server runs."""))
215
config_options.append(ConfigOption("usrmgt_port", "2178",
196
config_options.append(ConfigOption("usrmgt/port", "2178",
216
197
"""The port where the usrmgt-server runs:""",
218
199
# The port where the usrmgt-server runs.""", ask=False))
220
config_options.append(ConfigOption("usrmgt_magic", None,
201
config_options.append(ConfigOption("usrmgt/magic", None,
221
202
"""The password for the usrmgt-server:""",
223
204
# The password for the usrmgt-server.""", ask=False))
206
config_options.append(ConfigOption("jail/suite", "hardy",
207
"""The distribution release to use to build the jail:""",
209
# The distribution release to use to build the jail.""", ask=True))
211
config_options.append(ConfigOption("jail/mirror", "archive.ubuntu.com",
212
"""The archive mirror to use to build the jail:""",
214
# The archive mirror to use to build the jail.""", ask=True))
216
config_options.append(ConfigOption("jail/devmode", False,
217
"""Whether jail development mode be activated:""",
219
# Should jail development mode be activated?""", ask=False))
221
# The password for the usrmgt-server.""", ask=False))
222
def query_user(default, prompt):
223
"""Prompts the user for a string, which is read from a line of stdin.
224
Exits silently if EOF is encountered. Returns the string, with spaces
225
removed from the beginning and end.
227
Returns default if a 0-length line (after spaces removed) was read.
230
# A default of None means the value will be computed specially, so we
231
# can't really tell you what it is
232
defaultstr = "computed"
233
elif isinstance(default, basestring):
234
defaultstr = '"%s"' % default
236
defaultstr = repr(default)
237
sys.stdout.write('%s\n (default: %s)\n>' % (prompt, defaultstr))
239
val = sys.stdin.readline()
240
except KeyboardInterrupt:
242
sys.stdout.write("\n")
244
sys.stdout.write("\n")
246
if val == '': sys.exit(1)
247
# If empty line, return default
249
if val == '': return default
225
252
def configure(args):
226
# Call the real function
227
return __configure(args)
229
def __configure(args):
230
global db_port, usrmgt_port
232
253
# Try importing existing conf, but if we can't just set up defaults
233
254
# The reason for this is that these settings are used by other phases
234
255
# of setup besides conf, so we need to know them.
235
256
# Also this allows you to hit Return to accept the existing value.
237
confmodule = __import__("ivle/conf/conf")
238
for opt in config_options:
240
globals()[opt.option_name] = \
241
confmodule.__dict__[opt.option_name]
243
globals()[opt.option_name] = opt.default
245
# Just set reasonable defaults
246
for opt in config_options:
247
globals()[opt.option_name] = opt.default
258
conf = ivle.config.Config()
259
except ivle.config.ConfigError:
260
# Couldn't find a config file anywhere.
261
# Create a new blank config object (not yet bound to a file)
262
# All lookups (below) will fail, so it will be initialised with all
263
# the default values.
264
conf = ivle.config.Config(blank=True)
266
# Check that all the options are present, and if not, load the default
267
for opt in config_options:
269
conf.get_by_path(opt.option_name)
271
# If the default is None, omit it
272
# Else ConfigObj will write the string 'None' to the conf file
273
if opt.default is not None:
274
conf.set_by_path(opt.option_name, opt.default)
276
# Store comments in the conf object
277
for opt in config_options:
278
# Omitted if the key doesn't exist
279
conf.set_by_path(opt.option_name, comment=opt.comment)
249
281
# Set up some variables
250
282
cwd = os.getcwd()
252
284
# the files that will be created/overwritten
253
conffile = os.path.join(cwd, "etc/ivle.conf")
254
conf_hfile = os.path.join(cwd, "bin/trampoline/conf.h")
255
phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
286
confdir = os.environ['IVLECONF']
288
confdir = '/etc/ivle'
290
conffile = os.path.join(confdir, 'ivle.conf')
291
plugindefaultfile = os.path.join(confdir, 'plugins.d/000default.conf')
257
293
# Get command-line arguments to avoid asking questions.
285
321
for opt in config_options:
287
globals()[opt.option_name] = \
288
query_user(globals()[opt.option_name], opt.prompt)
323
conf.set_by_path(opt.option_name,
324
query_user(conf.get_by_path(opt.option_name), opt.prompt))
290
326
opts = dict(opts)
291
327
# Non-interactive mode. Parse the options.
292
328
for opt in config_options:
293
329
if '--' + opt.option_name in opts:
294
globals()[opt.option_name] = opts['--' + opt.option_name]
330
conf.set_by_path(opt.option_name,
331
opts['--' + opt.option_name])
296
333
# Error handling on input values
298
allowed_uids_list = map(int, allowed_uids.split(','))
300
print >>sys.stderr, (
301
"Invalid UID list (%s).\n"
302
"Must be a comma-separated list of integers." % allowed_uids)
305
db_port = int(db_port)
306
if db_port < 0 or db_port >= 65536: raise ValueError()
308
print >>sys.stderr, (
309
"Invalid DB port (%s).\n"
310
"Must be an integer between 0 and 65535." % repr(db_port))
313
usrmgt_port = int(usrmgt_port)
314
if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
335
conf['database']['port'] = int(conf['database']['port'])
336
if (conf['database']['port'] < 0
337
or conf['database']['port'] >= 65536):
340
if conf['database']['port'] == '' or conf['database']['port'] is None:
343
print >>sys.stderr, (
344
"Invalid DB port (%s).\n"
345
"Must be an integer between 0 and 65535." %
346
repr(conf['database']['port']))
349
conf['usrmgt']['port'] = int(conf['usrmgt']['port'])
350
if (conf['usrmgt']['port'] < 0 or conf['usrmgt']['port'] >= 65536):
315
352
except ValueError:
316
353
print >>sys.stderr, (
317
354
"Invalid user management port (%s).\n"
318
"Must be an integer between 0 and 65535." % repr(usrmgt_port))
355
"Must be an integer between 0 and 65535." %
356
repr(conf['usrmgt']['port']))
321
359
# By default we generate the magic randomly.
322
if globals()['usrmgt_magic'] is None:
323
globals()['usrmgt_magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
325
# Generate the forum secret
326
forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
328
# Write ./etc/ivle.conf
330
conf = configobj.ConfigObj()
361
conf['usrmgt']['magic'] # Throw away; just check for KeyError
363
conf['usrmgt']['magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
365
clobber_permissions = not os.path.exists(conffile)
367
# Write ./etc/ivle.conf (even if we loaded from a different filename)
331
368
conf.filename = conffile
333
369
conf.initial_comment = ["# IVLE Configuration File"]
335
for opt in config_options:
336
conf[opt.option_name] = globals()[opt.option_name]
337
conf.comments[opt.option_name] = opt.comment.split('\n')
339
# Add the forum secret to the config file (regenerated each config)
340
conf['forum_secret'] = forum_secret
372
# We need to restrict permissions on a new file, as it contains
373
# a nice database password.
374
if clobber_permissions:
375
os.chown(conffile, 33, 33) # chown to www-data
376
os.chmod(conffile, stat.S_IRUSR | stat.S_IWUSR) # No g/o perms!
344
378
print "Successfully wrote %s" % conffile
346
# Write bin/trampoline/conf.h
348
conf = open(conf_hfile, "w")
350
# XXX Compute jail_base, jail_src_base and jail_system. These will
351
# ALSO be done by the boilerplate code, but we need them here in order
352
# to write to the C file.
353
jail_base = os.path.join(data_path, 'jailmounts')
354
jail_src_base = os.path.join(data_path, 'jails')
355
jail_system = os.path.join(jail_src_base, '__base__')
357
conf.write("""/* IVLE Configuration File
359
* Administrator settings required by trampoline.
360
* Note: trampoline will have to be rebuilt in order for changes to this file
364
#define IVLE_AUFS_JAILS
366
/* In the local file system, where are the jails located.
367
* The trampoline does not allow the creation of a jail anywhere besides
368
* jail_base or a subdirectory of jail_base.
370
static const char* jail_base = "%s";
371
static const char* jail_src_base = "%s";
372
static const char* jail_system = "%s";
374
/* Which user IDs are allowed to run the trampoline.
375
* This list should be limited to the web server user.
376
* (Note that root is an implicit member of this list).
378
static const int allowed_uids[] = { %s };
379
""" % (repr(jail_base)[1:-1], repr(jail_src_base)[1:-1],
380
repr(jail_system)[1:-1], repr(allowed_uids_list)[1:-1]))
381
# Note: The above uses PYTHON reprs, not C reprs
382
# However they should be the same with the exception of the outer
383
# characters, which are stripped off and replaced
387
print "Successfully wrote %s" % conf_hfile
389
# Write www/php/phpBB3/config.php
391
conf = open(phpBBconffile, "w")
394
if db_host == 'localhost':
395
forumdb_host = '127.0.0.1'
397
forumdb_host = db_host
400
// phpBB 3.0.x auto-generated configuration file
401
// Do not change anything in this file!
403
$dbhost = '""" + forumdb_host + """';
404
$dbport = '""" + str(db_port) + """';
405
$dbname = '""" + db_forumdbname + """';
406
$dbuser = '""" + db_user + """';
407
$dbpasswd = '""" + db_password + """';
409
$table_prefix = 'phpbb_';
411
$load_extensions = '';
412
@define('PHPBB_INSTALLED', true);
413
// @define('DEBUG', true);
414
//@define('DEBUG_EXTRA', true);
416
$forum_secret = '""" + forum_secret +"""';
421
print "Successfully wrote %s" % phpBBconffile
424
print "You may modify the configuration at any time by editing"
380
plugindefault = open(plugindefaultfile, 'w')
381
plugindefault.write("""# IVLE default plugin configuration file
382
[ivle.webapp.core#Plugin]
383
[ivle.webapp.admin.user#Plugin]
384
[ivle.webapp.tutorial#Plugin]
385
[ivle.webapp.admin.subject#Plugin]
386
[ivle.webapp.filesystem.browser#Plugin]
387
[ivle.webapp.filesystem.diff#Plugin]
388
[ivle.webapp.filesystem.svnlog#Plugin]
389
[ivle.webapp.filesystem.serve#Plugin]
390
[ivle.webapp.groups#Plugin]
391
[ivle.webapp.console#Plugin]
392
[ivle.webapp.security#Plugin]
393
[ivle.webapp.media#Plugin]
394
[ivle.webapp.help#Plugin]
395
[ivle.webapp.tos#Plugin]
396
[ivle.webapp.userservice#Plugin]
397
[ivle.webapp.fileservice#Plugin]
398
[ivle.webapp.submit#Plugin]
400
plugindefault.close()
401
print "Successfully wrote %s" % plugindefaultfile
404
print "You may modify the configuration at any time by editing " + conffile
412
# Print the opening spiel including the GPL notice
414
print """IVLE - Informatics Virtual Learning Environment Setup
415
Copyright (C) 2007-2009 The University of Melbourne
416
IVLE comes with ABSOLUTELY NO WARRANTY.
417
This is free software, and you are welcome to redistribute it
418
under certain conditions. See LICENSE.txt for details.
423
return configure(argv[1:])
425
if __name__ == "__main__":