110
113
# Private mode (normal mode) requires login, and only serves files relevant to
111
114
# the logged-in user."""))
113
config_options.append(ConfigOption("allowed_uids", "33",
114
"""UID of the web server process which will run IVLE.
115
Only this user may execute the trampoline. May specify multiple users as
116
a comma-separated list.
119
# The User-ID of the web server process which will run IVLE, and any other
120
# users who are allowed to run the trampoline. This is stores as a string of
121
# comma-separated integers, simply because it is not used within Python, only
122
# used by the setup program to write to conf.h (see setup.py config).""",
125
config_options.append(ConfigOption("db_host", "localhost",
116
config_options.append(ConfigOption("database/host", "localhost",
126
117
"""PostgreSQL Database config
127
118
==========================
128
119
Hostname of the DB server:""",
130
### PostgreSQL Database config ###
131
121
# Database server hostname"""))
133
config_options.append(ConfigOption("db_port", "5432",
123
config_options.append(ConfigOption("database/port", "5432",
134
124
"""Port of the DB server:""",
136
126
# Database server port"""))
138
config_options.append(ConfigOption("db_dbname", "ivle",
128
config_options.append(ConfigOption("database/name", "ivle",
139
129
"""Database name:""",
141
131
# Database name"""))
143
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
144
"""Forum Database name:""",
146
# Forum Database name"""))
148
config_options.append(ConfigOption("db_user", "postgres",
133
config_options.append(ConfigOption("database/username", "postgres",
149
134
"""Username for DB server login:""",
151
136
# Database username"""))
153
config_options.append(ConfigOption("db_password", "",
138
config_options.append(ConfigOption("database/password", "",
154
139
"""Password for DB server login:
155
(Caution: This password is stored in plaintext in ivle/conf/conf.py)""",
140
(Caution: This password is stored in plaintext!)""",
157
142
# Database password"""))
159
config_options.append(ConfigOption("auth_modules", "",
144
config_options.append(ConfigOption("auth/modules", "",
160
145
"""Authentication config
161
146
=====================
162
147
Comma-separated list of authentication modules.""",
195
180
# other modules may be plugged in to pulldown against organisation-specific
196
181
# pulldown backends.""", ask=False))
198
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
183
config_options.append(ConfigOption("urls/svn_addr", "http://svn.localhost/",
199
184
"""Subversion config
200
185
=================
201
186
The base url for accessing subversion repositories:""",
203
188
# The base url for accessing subversion repositories."""))
205
config_options.append(ConfigOption("usrmgt_host", "localhost",
190
config_options.append(ConfigOption("usrmgt/host", "localhost",
206
191
"""User Management Server config
207
192
============================
208
193
The hostname where the usrmgt-server runs:""",
210
195
# The hostname where the usrmgt-server runs."""))
212
config_options.append(ConfigOption("usrmgt_port", "2178",
197
config_options.append(ConfigOption("usrmgt/port", "2178",
213
198
"""The port where the usrmgt-server runs:""",
215
200
# The port where the usrmgt-server runs.""", ask=False))
217
config_options.append(ConfigOption("usrmgt_magic", None,
202
config_options.append(ConfigOption("usrmgt/magic", None,
218
203
"""The password for the usrmgt-server:""",
220
205
# The password for the usrmgt-server.""", ask=False))
207
def query_user(default, prompt):
208
"""Prompts the user for a string, which is read from a line of stdin.
209
Exits silently if EOF is encountered. Returns the string, with spaces
210
removed from the beginning and end.
212
Returns default if a 0-length line (after spaces removed) was read.
215
# A default of None means the value will be computed specially, so we
216
# can't really tell you what it is
217
defaultstr = "computed"
218
elif isinstance(default, basestring):
219
defaultstr = '"%s"' % default
221
defaultstr = repr(default)
222
sys.stdout.write('%s\n (default: %s)\n>' % (prompt, defaultstr))
224
val = sys.stdin.readline()
225
except KeyboardInterrupt:
227
sys.stdout.write("\n")
229
sys.stdout.write("\n")
231
if val == '': sys.exit(1)
232
# If empty line, return default
234
if val == '': return default
222
237
def configure(args):
223
usage = """usage: %prog config [options]
224
Creates lib/conf/conf.py (and a few other config files).
225
Interactively asks questions to set this up."""
228
parser = optparse.OptionParser(usage)
229
(options, args) = parser.parse_args(args)
231
# Call the real function
232
return __configure(args)
234
def __configure(args):
235
global db_port, usrmgt_port
237
238
# Try importing existing conf, but if we can't just set up defaults
238
239
# The reason for this is that these settings are used by other phases
239
240
# of setup besides conf, so we need to know them.
240
241
# Also this allows you to hit Return to accept the existing value.
242
confmodule = __import__("ivle/conf/conf")
243
for opt in config_options:
245
globals()[opt.option_name] = \
246
confmodule.__dict__[opt.option_name]
248
globals()[opt.option_name] = opt.default
250
# Just set reasonable defaults
251
for opt in config_options:
252
globals()[opt.option_name] = opt.default
243
conf = ivle.config.Config()
244
except ivle.config.ConfigError:
245
# Couldn't find a config file anywhere.
246
# Create a new blank config object (not yet bound to a file)
247
# All lookups (below) will fail, so it will be initialised with all
248
# the default values.
249
conf = ivle.config.Config(blank=True)
251
# Check that all the options are present, and if not, load the default
252
for opt in config_options:
254
conf.get_by_path(opt.option_name)
256
# If the default is None, omit it
257
# Else ConfigObj will write the string 'None' to the conf file
258
if opt.default is not None:
259
conf.set_by_path(opt.option_name, opt.default)
261
# Store comments in the conf object
262
for opt in config_options:
263
# Omitted if the key doesn't exist
264
conf.set_by_path(opt.option_name, comment=opt.comment)
254
266
# Set up some variables
255
267
cwd = os.getcwd()
257
269
# the files that will be created/overwritten
258
conffile = os.path.join(cwd, "ivle/conf/conf.py")
259
jailconffile = os.path.join(cwd, "ivle/conf/jailconf.py")
260
conf_hfile = os.path.join(cwd, "bin/trampoline/conf.h")
261
phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
271
confdir = os.environ['IVLECONF']
273
confdir = '/etc/ivle'
275
conffile = os.path.join(confdir, 'ivle.conf')
276
plugindefaultfile = os.path.join(confdir, 'plugins.d/000default.conf')
263
278
# Get command-line arguments to avoid asking questions.
292
306
for opt in config_options:
294
globals()[opt.option_name] = \
295
query_user(globals()[opt.option_name], opt.prompt)
308
conf.set_by_path(opt.option_name,
309
query_user(conf.get_by_path(opt.option_name), opt.prompt))
297
311
opts = dict(opts)
298
312
# Non-interactive mode. Parse the options.
299
313
for opt in config_options:
300
314
if '--' + opt.option_name in opts:
301
globals()[opt.option_name] = opts['--' + opt.option_name]
315
conf.set_by_path(opt.option_name,
316
opts['--' + opt.option_name])
303
318
# Error handling on input values
305
allowed_uids_list = map(int, allowed_uids.split(','))
307
print >>sys.stderr, (
308
"Invalid UID list (%s).\n"
309
"Must be a comma-separated list of integers." % allowed_uids)
312
db_port = int(db_port)
313
if db_port < 0 or db_port >= 65536: raise ValueError()
315
print >>sys.stderr, (
316
"Invalid DB port (%s).\n"
317
"Must be an integer between 0 and 65535." % repr(db_port))
320
usrmgt_port = int(usrmgt_port)
321
if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
320
conf['database']['port'] = int(conf['database']['port'])
321
if (conf['database']['port'] < 0
322
or conf['database']['port'] >= 65536):
325
if conf['database']['port'] == '' or conf['database']['port'] is None:
328
print >>sys.stderr, (
329
"Invalid DB port (%s).\n"
330
"Must be an integer between 0 and 65535." %
331
repr(conf['database']['port']))
334
conf['usrmgt']['port'] = int(conf['usrmgt']['port'])
335
if (conf['usrmgt']['port'] < 0 or conf['usrmgt']['port'] >= 65536):
322
337
except ValueError:
323
338
print >>sys.stderr, (
324
339
"Invalid user management port (%s).\n"
325
"Must be an integer between 0 and 65535." % repr(usrmgt_port))
340
"Must be an integer between 0 and 65535." %
341
repr(conf['usrmgt']['port']))
328
344
# By default we generate the magic randomly.
329
if globals()['usrmgt_magic'] is None:
330
globals()['usrmgt_magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
332
# Generate the forum secret
333
forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
335
# Write lib/conf/conf.py
338
conf = open(conffile, "w")
340
conf.write("""# IVLE Configuration File
342
# Miscellaneous application settings
347
for opt in config_options:
348
conf.write('%s\n%s = %r\n' % (opt.comment, opt.option_name,
349
globals()[opt.option_name]))
351
# Add the forum secret to the config file (regenerated each config)
352
conf.write('forum_secret = "%s"\n\n' % (forum_secret))
354
write_conf_file_boilerplate(conf)
357
except IOError, (errno, strerror):
358
print "IO error(%s): %s" % (errno, strerror)
346
conf['usrmgt']['magic'] # Throw away; just check for KeyError
348
conf['usrmgt']['magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
350
clobber_permissions = not os.path.exists(conffile)
352
# Write ./etc/ivle.conf (even if we loaded from a different filename)
353
conf.filename = conffile
354
conf.initial_comment = ["# IVLE Configuration File"]
357
# We need to restrict permissions on a new file, as it contains
358
# a nice database password.
359
if clobber_permissions:
360
os.chown(conffile, 33, 33) # chown to www-data
361
os.chmod(conffile, stat.S_IRUSR | stat.S_IWUSR) # No g/o perms!
361
363
print "Successfully wrote %s" % conffile
363
# Write conf/jailconf.py
366
conf = open(jailconffile, "w")
368
# In the "in-jail" version of conf, we don't need MOST of the details
369
# (it would be a security risk to have them here).
370
# So we just write root_dir, and jail_base is "/".
371
# (jail_base being "/" means "jail-relative" paths are relative to "/"
372
# when inside the jail.)
373
conf.write("""# IVLE Configuration File
375
# Miscellaneous application settings
376
# (User jail version)
379
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
381
# eg. "/" or "/ivle".
384
# In the local file system, where are the student/user file spaces located.
385
# The user jails are expected to be located immediately in subdirectories of
389
# The hostname for serving publicly accessible pages
392
# The URL under which the Subversion repositories are located.
394
""" % (repr(root_dir),repr(public_host),repr(svn_addr)))
397
except IOError, (errno, strerror):
398
print "IO error(%s): %s" % (errno, strerror)
401
print "Successfully wrote %s" % jailconffile
403
# Write bin/trampoline/conf.h
406
conf = open(conf_hfile, "w")
408
# XXX Compute jail_base, jail_src_base and jail_system. These will
409
# ALSO be done by the boilerplate code, but we need them here in order
410
# to write to the C file.
411
jail_base = os.path.join(data_path, 'jailmounts')
412
jail_src_base = os.path.join(data_path, 'jails')
413
jail_system = os.path.join(jail_src_base, '__base__')
415
conf.write("""/* IVLE Configuration File
417
* Administrator settings required by trampoline.
418
* Note: trampoline will have to be rebuilt in order for changes to this file
422
#define IVLE_AUFS_JAILS
424
/* In the local file system, where are the jails located.
425
* The trampoline does not allow the creation of a jail anywhere besides
426
* jail_base or a subdirectory of jail_base.
428
static const char* jail_base = "%s";
429
static const char* jail_src_base = "%s";
430
static const char* jail_system = "%s";
432
/* Which user IDs are allowed to run the trampoline.
433
* This list should be limited to the web server user.
434
* (Note that root is an implicit member of this list).
436
static const int allowed_uids[] = { %s };
437
""" % (repr(jail_base)[1:-1], repr(jail_src_base)[1:-1],
438
repr(jail_system)[1:-1], repr(allowed_uids_list)[1:-1]))
439
# Note: The above uses PYTHON reprs, not C reprs
440
# However they should be the same with the exception of the outer
441
# characters, which are stripped off and replaced
444
except IOError, (errno, strerror):
445
print "IO error(%s): %s" % (errno, strerror)
448
print "Successfully wrote %s" % conf_hfile
450
# Write www/php/phpBB3/config.php
453
conf = open(phpBBconffile, "w")
456
if db_host == 'localhost':
457
forumdb_host = '127.0.0.1'
459
forumdb_host = db_host
462
// phpBB 3.0.x auto-generated configuration file
463
// Do not change anything in this file!
465
$dbhost = '""" + forumdb_host + """';
466
$dbport = '""" + str(db_port) + """';
467
$dbname = '""" + db_forumdbname + """';
468
$dbuser = '""" + db_user + """';
469
$dbpasswd = '""" + db_password + """';
471
$table_prefix = 'phpbb_';
473
$load_extensions = '';
474
@define('PHPBB_INSTALLED', true);
475
// @define('DEBUG', true);
476
//@define('DEBUG_EXTRA', true);
478
$forum_secret = '""" + forum_secret +"""';
482
except IOError, (errno, strerror):
483
print "IO error(%s): %s" % (errno, strerror)
486
print "Successfully wrote %s" % phpBBconffile
489
print "You may modify the configuration at any time by editing"
365
plugindefault = open(plugindefaultfile, 'w')
366
plugindefault.write("""# IVLE default plugin configuration file
367
[ivle.webapp.core#Plugin]
368
[ivle.webapp.admin.user#Plugin]
369
[ivle.webapp.tutorial#Plugin]
370
[ivle.webapp.admin.subject#Plugin]
371
[ivle.webapp.filesystem.browser#Plugin]
372
[ivle.webapp.filesystem.diff#Plugin]
373
[ivle.webapp.filesystem.svnlog#Plugin]
374
[ivle.webapp.filesystem.serve#Plugin]
375
[ivle.webapp.groups#Plugin]
376
[ivle.webapp.console#Plugin]
377
[ivle.webapp.security#Plugin]
378
[ivle.webapp.media#Plugin]
379
[ivle.webapp.help#Plugin]
380
[ivle.webapp.tos#Plugin]
381
[ivle.webapp.userservice#Plugin]
382
[ivle.webapp.fileservice#Plugin]
384
plugindefault.close()
385
print "Successfully wrote %s" % plugindefaultfile
388
print "You may modify the configuration at any time by editing " + conffile
498
def write_conf_file_boilerplate(conf_file):
500
### Below is boilerplate code, appended by ./setup.py config ###
502
# Path where architecture-dependent data (including non-user-executable
503
# binaries) is installed.
504
lib_path = os.path.join(prefix, 'lib/ivle')
506
# Path where arch-independent data is installed.
507
share_path = os.path.join(prefix, 'share/ivle')
509
# Path where user-executable binaries are installed.
510
bin_path = os.path.join(prefix, 'bin')
512
# 'site-packages' directory in Python, where Python libraries are to be
514
if python_site_packages_override is None:
515
PYTHON_VERSION = sys.version[0:3] # eg. "2.5"
516
python_site_packages = os.path.join(prefix,
517
'lib/python%s/site-packages' % PYTHON_VERSION)
519
python_site_packages = python_site_packages_override
521
# In the local file system, where the student/user jails will be mounted.
522
# Only a single copy of the jail's system components will be stored here -
523
# all user jails will be virtually mounted here.
524
jail_base = os.path.join(data_path, 'jailmounts')
526
# In the local file system, where are the student/user file spaces located.
527
# The user jails are expected to be located immediately in subdirectories of
528
# this location. Note that no complete jails reside here - only user
530
jail_src_base = os.path.join(data_path, 'jails')
532
# In the local file system, where the template system jail will be stored.
533
jail_system = os.path.join(jail_src_base, '__base__')
535
# In the local file system, where the subject content files are located.
536
# (The 'subjects' and 'exercises' directories).
537
content_path = os.path.join(data_path, 'content')
539
# In the local file system, where are the per-subject file spaces located.
540
# The individual subject directories are expected to be located immediately
541
# in subdirectories of this location.
542
subjects_base = os.path.join(content_path, 'subjects')
544
# In the local file system, where are the subject-independent exercise sheet
545
# file spaces located.
546
exercises_base = os.path.join(content_path, 'exercises')
548
# In the local file system, where the system notices are stored (such as terms
549
# of service and MOTD).
550
notices_path = os.path.join(data_path, 'notices')
552
# In the local file system, where is the Terms of Service document located.
553
tos_path = os.path.join(notices_path, 'tos.html')
555
# In the local file system, where is the Message of the Day document
556
# located. This is an HTML file (just the body fragment), which will
557
# be displayed on the login page. It is optional.
558
motd_path = os.path.join(notices_path, 'motd.html')
560
# The location of all the subversion config and repositories.
561
svn_path = os.path.join(data_path, 'svn')
563
# The location of the subversion configuration file used by
564
# apache to host the user repositories.
565
svn_conf = os.path.join(svn_path, 'svn.conf')
567
# The location of the subversion configuration file used by
568
# apache to host the user repositories.
569
svn_group_conf = os.path.join(svn_path, 'svn-group.conf')
571
# The root directory for the subversion repositories.
572
svn_repo_path = os.path.join(svn_path, 'repositories')
574
# The location of the password file used to authenticate users
575
# of the subversion repository from the ivle server.
576
svn_auth_ivle = os.path.join(svn_path, 'ivle.auth')
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
