1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2008 The University of Melbourne
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.
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.
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
18
# Module: setup/config
19
# Author: Matt Giuca, Refactored by David Coles
23
# Configures IVLE with machine-specific details, most notably, various paths.
24
# Either prompts the administrator for these details or accepts them as
26
# Creates lib/conf/conf.py and trampoline/conf.h.
34
from setup.setuputil import query_user
37
"""A configuration option; one of the things written to conf.py."""
38
def __init__(self, option_name, default, prompt, comment):
39
"""Creates a configuration option.
40
option_name: Name of the variable in conf.py. Also name of the
41
command-line argument to setup.py conf.
42
default: Default value for this variable.
43
prompt: (Short) string presented during the interactive prompt in
45
comment: (Long) comment string stored in conf.py. Each line of this
46
string should begin with a '#'.
48
self.option_name = option_name
49
self.default = default
51
self.comment = comment
53
# Configuration options, defaults and descriptions
55
config_options.append(ConfigOption("root_dir", "/",
56
"""Root directory where IVLE is located (in URL space):""",
58
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
60
# eg. "/" or "/ivle"."""))
61
config_options.append(ConfigOption("ivle_install_dir", "/opt/ivle",
62
'Root directory where IVLE will be installed (on the local file '
65
# In the local file system, where IVLE is actually installed.
66
# This directory should contain the "www" and "bin" directories."""))
67
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
68
"""Location of jail mountpoints
69
============================
70
Root directory where the user jails will be mounted, and the non-user
71
components of the jails will be stored (on the local file system):""",
73
# In the local file system, where the student/user jails will be mounted.
74
# Only a single copy of the jail's system components will be stored here -
75
# all user jails will be virtually mounted here."""))
76
config_options.append(ConfigOption("jail_system", "/home/informatics/jails/__base__",
77
"""Location of system jail components
78
==================================
79
Directory where the template system jail will be stored.""",
81
# In the local file system, where the template system jail will be stored."""))
82
config_options.append(ConfigOption("jail_src_base", "/home/informatics/jailssrc",
83
"""Location of user jail components
84
================================
85
Root directory where the user components of the jails will be stored (on the
86
local file system):""",
88
# In the local file system, where are the student/user file spaces located.
89
# The user jails are expected to be located immediately in subdirectories of
90
# this location. Note that no complete jails reside here - only user
92
config_options.append(ConfigOption("subjects_base",
93
"/home/informatics/subjects",
94
"""Root directory where the subject directories (containing worksheets
95
and other per-subject files) are stored (on the local file system):""",
97
# In the local file system, where are the per-subject file spaces located.
98
# The individual subject directories are expected to be located immediately
99
# in subdirectories of this location."""))
100
config_options.append(ConfigOption("exercises_base",
101
"/home/informatics/exercises",
102
"""Root directory where the exercise directories (containing
103
subject-independent exercise sheets) are stored (on the local file
106
# In the local file system, where are the subject-independent exercise sheet
107
# file spaces located."""))
108
config_options.append(ConfigOption("tos_path",
109
"/home/informatics/tos.html",
110
"""Location where the Terms of Service document is stored (on the local
113
# In the local file system, where is the Terms of Service document located."""))
114
config_options.append(ConfigOption("motd_path",
115
"/home/informatics/motd.html",
116
"""Location where the Message of the Day document is stored (on the local
119
# In the local file system, where is the Message of the Day document
120
# located. This is an HTML file (just the body fragment), which will
121
# be displayed on the login page. It is optional."""))
122
config_options.append(ConfigOption("log_path",
123
"/home/informatics/logs/",
124
"""Directory where IVLE log files are stored (on the local
125
file system). Note - this must be writable by the user the IVLE server
126
process runs as (usually www-data).:""",
128
# In the local file system, where is the Terms of Service document located."""))
129
config_options.append(ConfigOption("public_host", "public.localhost",
130
"""Hostname which will cause the server to go into "public mode",
131
providing login-free access to student's published work:""",
133
# The server goes into "public mode" if the browser sends a request with this
134
# host. This is for security reasons - we only serve public student files on a
135
# separate domain to the main IVLE site.
136
# Public mode does not use cookies, and serves only public content.
137
# Private mode (normal mode) requires login, and only serves files relevant to
138
# the logged-in user."""))
139
config_options.append(ConfigOption("allowed_uids", "33",
140
"""UID of the web server process which will run IVLE.
141
Only this user may execute the trampoline. May specify multiple users as
142
a comma-separated list.
145
# The User-ID of the web server process which will run IVLE, and any other
146
# users who are allowed to run the trampoline. This is stores as a string of
147
# comma-separated integers, simply because it is not used within Python, only
148
# used by the setup program to write to conf.h (see setup.py config)."""))
149
config_options.append(ConfigOption("db_host", "localhost",
150
"""PostgreSQL Database config
151
==========================
152
Hostname of the DB server:""",
154
### PostgreSQL Database config ###
155
# Database server hostname"""))
156
config_options.append(ConfigOption("db_port", "5432",
157
"""Port of the DB server:""",
159
# Database server port"""))
160
config_options.append(ConfigOption("db_dbname", "ivle",
161
"""Database name:""",
164
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
165
"""Forum Database name:""",
167
# Forum Database name"""))
168
config_options.append(ConfigOption("db_user", "postgres",
169
"""Username for DB server login:""",
171
# Database username"""))
172
config_options.append(ConfigOption("db_password", "",
173
"""Password for DB server login:
174
(Caution: This password is stored in plaintext in lib/conf/conf.py)""",
176
# Database password"""))
177
config_options.append(ConfigOption("auth_modules", "ldap_auth",
178
"""Authentication config
179
=====================
180
Comma-separated list of authentication modules. Only "ldap" is available
183
# Comma-separated list of authentication modules.
184
# These refer to importable Python modules in the www/auth directory.
185
# Modules "ldap" and "guest" are available in the source tree, but
186
# other modules may be plugged in to auth against organisation-specific
187
# auth backends."""))
188
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
189
"""(LDAP options are only relevant if "ldap" is included in the list of
191
URL for LDAP authentication server:""",
193
# URL for LDAP authentication server"""))
194
config_options.append(ConfigOption("ldap_format_string",
195
"uid=%s,ou=users,o=example",
196
"""Format string for LDAP auth request:
197
(Must contain a single "%s" for the user's login name)""",
199
# Format string for LDAP auth request
200
# (Must contain a single "%s" for the user's login name)"""))
201
config_options.append(ConfigOption("subject_pulldown_modules", "",
202
"""Comma-separated list of subject pulldown modules.
203
Add proprietary modules to automatically enrol students in subjects.""",
205
# Comma-separated list of subject pulldown modules.
206
# These refer to importable Python modules in the lib/pulldown_subj directory.
207
# Only "dummy_subj" is available in the source tree (an example), but
208
# other modules may be plugged in to pulldown against organisation-specific
209
# pulldown backends."""))
210
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
213
The base url for accessing subversion repositories:""",
215
# The base url for accessing subversion repositories."""))
216
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
217
"""The location of the subversion configuration file used by apache
218
to host the user repositories:""",
220
# The location of the subversion configuration file used by
221
# apache to host the user repositories."""))
222
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
223
"""The root directory for the subversion repositories:""",
225
# The root directory for the subversion repositories."""))
226
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
227
"""The location of the password file used to authenticate users
228
of the subversion repository from the ivle server:""",
230
# The location of the password file used to authenticate users
231
# of the subversion repository from the ivle server."""))
232
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
233
"""The location of the password file used to authenticate local users
234
of the subversion repository:""",
236
# The location of the password file used to authenticate local users
237
# of the subversion repository."""))
238
config_options.append(ConfigOption("usrmgt_host", "localhost",
239
"""User Management Server config
240
============================
241
The hostname where the usrmgt-server runs:""",
243
# The hostname where the usrmgt-server runs."""))
244
config_options.append(ConfigOption("usrmgt_port", "2178",
245
"""The port where the usrmgt-server runs:""",
247
# The port where the usrmgt-server runs."""))
248
config_options.append(ConfigOption("usrmgt_magic", "",
249
"""The password for the usrmgt-server:""",
251
# The password for the usrmgt-server."""))
254
usage = """usage: %prog build [options]
256
Compiles all files and sets up a jail template in the source directory.
257
-O is recommended to cause compilation to be optimised.
259
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
260
Creates jail with system and student packages installed from MIRROR.
261
Copies console/ to a location within the jail.
262
Copies OS programs and files to corresponding locations within the jail
263
(eg. python and Python libs, ld.so, etc).
264
Generates .pyc or .pyo files for all the IVLE .py files."""
267
parser = optparse.OptionParser(usage)
268
(options, args) = parser.parse_args(args)
270
# Call the real function
273
def __configure(args):
274
global db_port, usrmgt_port
276
# Try importing existing conf, but if we can't just set up defaults
277
# The reason for this is that these settings are used by other phases
278
# of setup besides conf, so we need to know them.
279
# Also this allows you to hit Return to accept the existing value.
281
confmodule = __import__("lib/conf/conf")
282
for opt in config_options:
284
globals()[opt.option_name] = \
285
confmodule.__dict__[opt.option_name]
287
globals()[opt.option_name] = opt.default
289
# Just set reasonable defaults
290
for opt in config_options:
291
globals()[opt.option_name] = opt.default
293
# Set up some variables
296
# the files that will be created/overwritten
297
conffile = os.path.join(cwd, "lib/conf/conf.py")
298
jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
299
conf_hfile = os.path.join(cwd, "trampoline/conf.h")
300
phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
301
usrmgtserver_initdfile = os.path.join(cwd, "doc/setup/usrmgt-server.init")
303
# Get command-line arguments to avoid asking questions.
306
for opt in config_options:
307
optnames.append(opt.option_name + "=")
308
(opts, args) = getopt.gnu_getopt(args, "", optnames)
311
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
315
# Interactive mode. Prompt the user for all the values.
317
print """This tool will create the following files:
323
prompting you for details about your configuration. The file will be
324
overwritten if it already exists. It will *not* install or deploy IVLE.
326
Please hit Ctrl+C now if you do not wish to do this.
327
""" % (conffile, jailconffile, conf_hfile, phpBBconffile, usrmgtserver_initdfile)
329
# Get information from the administrator
330
# If EOF is encountered at any time during the questioning, just exit
333
for opt in config_options:
334
globals()[opt.option_name] = \
335
query_user(globals()[opt.option_name], opt.prompt)
338
# Non-interactive mode. Parse the options.
339
for opt in config_options:
340
if '--' + opt.option_name in opts:
341
globals()[opt.option_name] = opts['--' + opt.option_name]
343
# Error handling on input values
345
allowed_uids_list = map(int, allowed_uids.split(','))
347
print >>sys.stderr, (
348
"Invalid UID list (%s).\n"
349
"Must be a comma-separated list of integers." % allowed_uids)
352
db_port = int(db_port)
353
if db_port < 0 or db_port >= 65536: raise ValueError()
355
print >>sys.stderr, (
356
"Invalid DB port (%s).\n"
357
"Must be an integer between 0 and 65535." % repr(db_port))
360
usrmgt_port = int(usrmgt_port)
361
if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
363
print >>sys.stderr, (
364
"Invalid user management port (%s).\n"
365
"Must be an integer between 0 and 65535." % repr(usrmgt_port))
368
# Generate the forum secret
369
forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
371
# Write lib/conf/conf.py
374
conf = open(conffile, "w")
376
conf.write("""# IVLE Configuration File
378
# Miscellaneous application settings
381
for opt in config_options:
382
conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
383
repr(globals()[opt.option_name])))
385
# Add the forum secret to the config file (regenerated each config)
386
conf.write('forum_secret = "%s"\n' % (forum_secret))
389
except IOError, (errno, strerror):
390
print "IO error(%s): %s" % (errno, strerror)
393
print "Successfully wrote lib/conf/conf.py"
395
# Write conf/jailconf.py
398
conf = open(jailconffile, "w")
400
# In the "in-jail" version of conf, we don't need MOST of the details
401
# (it would be a security risk to have them here).
402
# So we just write root_dir, and jail_base is "/".
403
# (jail_base being "/" means "jail-relative" paths are relative to "/"
404
# when inside the jail.)
405
conf.write("""# IVLE Configuration File
407
# Miscellaneous application settings
408
# (User jail version)
411
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
413
# eg. "/" or "/ivle".
416
# In the local file system, where are the student/user file spaces located.
417
# The user jails are expected to be located immediately in subdirectories of
421
# The hostname for serving publicly accessible pages
424
# The URL under which the Subversion repositories are located.
426
""" % (repr(root_dir),repr(public_host),repr(svn_addr)))
429
except IOError, (errno, strerror):
430
print "IO error(%s): %s" % (errno, strerror)
433
print "Successfully wrote lib/conf/jailconf.py"
435
# Write trampoline/conf.h
438
conf = open(conf_hfile, "w")
440
conf.write("""/* IVLE Configuration File
442
* Administrator settings required by trampoline.
443
* Note: trampoline will have to be rebuilt in order for changes to this file
447
#define IVLE_AUFS_JAILS
449
/* In the local file system, where are the jails located.
450
* The trampoline does not allow the creation of a jail anywhere besides
451
* jail_base or a subdirectory of jail_base.
453
static const char* jail_base = "%s";
454
static const char* jail_src_base = "%s";
455
static const char* jail_system = "%s";
457
/* Which user IDs are allowed to run the trampoline.
458
* This list should be limited to the web server user.
459
* (Note that root is an implicit member of this list).
461
static const int allowed_uids[] = { %s };
462
""" % (repr(jail_base)[1:-1], repr(jail_src_base)[1:-1],
463
repr(jail_system)[1:-1], repr(allowed_uids_list)[1:-1]))
464
# Note: The above uses PYTHON reprs, not C reprs
465
# However they should be the same with the exception of the outer
466
# characters, which are stripped off and replaced
469
except IOError, (errno, strerror):
470
print "IO error(%s): %s" % (errno, strerror)
473
print "Successfully wrote trampoline/conf.h"
475
# Write www/php/phpBB3/config.php
478
conf = open(phpBBconffile, "w")
481
if db_host == 'localhost':
482
forumdb_host = '127.0.0.1'
484
forumdb_host = db_host
487
// phpBB 3.0.x auto-generated configuration file
488
// Do not change anything in this file!
490
$dbhost = '""" + forumdb_host + """';
491
$dbport = '""" + str(db_port) + """';
492
$dbname = '""" + db_forumdbname + """';
493
$dbuser = '""" + db_user + """';
494
$dbpasswd = '""" + db_password + """';
496
$table_prefix = 'phpbb_';
498
$load_extensions = '';
499
@define('PHPBB_INSTALLED', true);
500
// @define('DEBUG', true);
501
//@define('DEBUG_EXTRA', true);
503
$forum_secret = '""" + forum_secret +"""';
507
except IOError, (errno, strerror):
508
print "IO error(%s): %s" % (errno, strerror)
511
print "Successfully wrote www/php/phpBB3/config.php"
513
# Write lib/conf/usrmgt-server.init
516
conf = open(usrmgtserver_initdfile, "w")
518
conf.write( '''#! /bin/sh
520
# Works for Ubuntu. Check before using on other distributions
523
# Provides: usrmgt-server
524
# Required-Start: $syslog $networking $urandom
525
# Required-Stop: $syslog
526
# Default-Start: 2 3 4 5
528
# Short-Description: IVLE user management server
529
# Description: Daemon connecting to the IVLE user management database.
532
PATH=/sbin:/bin:/usr/sbin:/usr/bin
533
DESC="IVLE user management server"
535
DAEMON=/opt/ivle/scripts/$NAME
536
DAEMON_ARGS="''' + str(usrmgt_port) + ''' ''' + usrmgt_magic + '''"
537
PIDFILE=/var/run/$NAME.pid
538
SCRIPTNAME=/etc/init.d/usrmgt-server
540
# Exit if the daemon does not exist
541
test -f $DAEMON || exit 0
543
# Load the VERBOSE setting and other rcS variables
544
[ -f /etc/default/rcS ] && . /etc/default/rcS
546
# Define LSB log_* functions.
547
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
548
. /lib/lsb/init-functions
551
# Function that starts the daemon/service
556
# 0 if daemon has been started
557
# 1 if daemon was already running
558
# 2 if daemon could not be started
559
start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
561
start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
564
# Add code here, if necessary, that waits for the process to be ready
565
# to handle requests from services started subsequently which depend
566
# on this one. As a last resort, sleep for some time.
570
# Function that stops the daemon/service
575
# 0 if daemon has been stopped
576
# 1 if daemon was already stopped
577
# 2 if daemon could not be stopped
578
# other if a failure occurred
579
start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
581
[ "$RETVAL" = 2 ] && return 2
582
# Wait for children to finish too if this is a daemon that forks
583
# and if the daemon is only ever run from this initscript.
584
# If the above conditions are not satisfied then add some other code
585
# that waits for the process to drop all resources that could be
586
# needed by services started subsequently. A last resort is to
587
# sleep for some time.
588
start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
589
[ "$?" = 2 ] && return 2
590
# Many daemons don't delete their pidfiles when they exit.
596
# Function that sends a SIGHUP to the daemon/service
600
# If the daemon can reload its configuration without
601
# restarting (for example, when it is sent a SIGHUP),
602
# then implement that here.
604
start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
610
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
613
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
614
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
618
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
621
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
622
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
625
#reload|force-reload)
627
# If do_reload() is not implemented then leave this commented out
628
# and leave 'force-reload' as an alias for 'restart'.
630
#log_daemon_msg "Reloading $DESC" "$NAME"
634
restart|force-reload)
636
# If the "reload" option is implemented then remove the
637
# 'force-reload' alias
639
log_daemon_msg "Restarting $DESC" "$NAME"
646
1) log_end_msg 1 ;; # Old process is still running
647
*) log_end_msg 1 ;; # Failed to start
657
#echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
658
echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
667
except IOError, (errno, strerror):
668
print "IO error(%s): %s" % (errno, strerror)
671
# fix permissions as the file contains the database password
673
os.chmod('doc/setup/usrmgt-server.init', 0600)
674
except OSError, (errno, strerror):
675
print "WARNING: Couldn't chmod doc/setup/usrmgt-server.init:"
676
print "OS error(%s): %s" % (errno, strerror)
678
print "Successfully wrote lib/conf/usrmgt-server.init"
681
print "You may modify the configuration at any time by editing"
686
print usrmgtserver_initdfile
added
removed
setup/configure.py
