36
from setup.util import query_user
40
# This dict maps legacy config option names to new config option paths
41
# ('section/option_name')
42
# NOTE: This is copied from ivle/conf/conf.py (because neither of these files
43
# can see each other).
45
'root_dir': 'urls/root',
46
'prefix': 'paths/prefix',
47
'data_path': 'paths/data',
48
'log_path': 'paths/logs',
49
'python_site_packages_override': 'paths/site_packages',
50
'public_host': 'urls/public_host',
51
'allowed_uids': 'os/allowed_uids',
52
'db_host': 'database/host',
53
'db_port': 'database/port',
54
'db_dbname': 'database/name',
55
'db_forumdbname': 'plugins/forum/dbname',
56
'db_user': 'database/username',
57
'db_password': 'database/password',
58
'auth_modules': 'auth/modules',
59
'ldap_url': 'auth/ldap_url',
60
'ldap_format_string': 'auth/ldap_format_string',
61
'subject_pulldown_modules': 'auth/subject_pulldown_modules',
62
'svn_addr': 'urls/svn_addr',
63
'usrmgt_host': 'usrmgt/host',
64
'usrmgt_port': 'usrmgt/port',
65
'usrmgt_magic': 'usrmgt/magic',
66
'forum_secret': 'plugins/forum/secret',
34
from setup.setuputil import query_user
69
36
class ConfigOption:
70
37
"""A configuration option; one of the things written to conf.py."""
71
def __init__(self, option_name, default, prompt, comment, ask=True):
38
def __init__(self, option_name, default, prompt, comment):
72
39
"""Creates a configuration option.
73
40
option_name: Name of the variable in conf.py. Also name of the
74
41
command-line argument to setup.py conf.
78
45
comment: (Long) comment string stored in conf.py. Each line of this
79
46
string should begin with a '#'.
80
ask: Whether to ask the question in the default config run.
82
48
self.option_name = option_name
83
49
self.default = default
84
50
self.prompt = prompt
85
51
self.comment = comment
88
53
# Configuration options, defaults and descriptions
89
54
config_options = []
91
55
config_options.append(ConfigOption("root_dir", "/",
92
56
"""Root directory where IVLE is located (in URL space):""",
94
58
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
96
# eg. "/" or "/ivle".""", ask=False))
98
config_options.append(ConfigOption("prefix", "/usr/local",
99
"""In the local file system, the prefix to the system directory where IVLE
100
is installed. (This should either be /usr or /usr/local):""",
102
# In the local file system, the prefix to the system directory where IVLE is
103
# installed. This should either be '/usr' or '/usr/local'.
104
# ('/usr/local' for the usual install, '/usr' for distribution packages)""",
107
config_options.append(ConfigOption("python_site_packages_override",
109
"""site-packages directory in Python, where Python libraries are to be
110
installed. May be left as the default, in which case the value will be
111
computed from prefix and the current Python version:""",
113
# 'site-packages' directory in Python, where Python libraries are to be
114
# installed. May be None (recommended), in which case the value will be
115
# computed from prefix and the current Python version.""", ask=False))
117
config_options.append(ConfigOption("data_path",
119
"In the local file system, where user-modifiable data files should be "
122
# In the local file system, where user-modifiable data files should be
123
# located.""", ask=False))
125
config_options.append(ConfigOption("log_path",
127
"""Directory where IVLE log files are stored (on the local
128
file system). Note - this must be writable by the user the IVLE server
129
process runs as (usually www-data):""",
131
# In the local file system, where IVLE error logs should be located.""",
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."""))
134
122
config_options.append(ConfigOption("public_host", "public.localhost",
135
123
"""Hostname which will cause the server to go into "public mode",
136
124
providing login-free access to student's published work:""",
151
138
# The User-ID of the web server process which will run IVLE, and any other
152
139
# users who are allowed to run the trampoline. This is stores as a string of
153
140
# comma-separated integers, simply because it is not used within Python, only
154
# used by the setup program to write to conf.h (see setup.py config).""",
141
# used by the setup program to write to conf.h (see setup.py config)."""))
157
142
config_options.append(ConfigOption("db_host", "localhost",
158
143
"""PostgreSQL Database config
159
144
==========================
160
145
Hostname of the DB server:""",
147
### PostgreSQL Database config ###
162
148
# Database server hostname"""))
164
149
config_options.append(ConfigOption("db_port", "5432",
165
150
"""Port of the DB server:""",
167
152
# Database server port"""))
169
153
config_options.append(ConfigOption("db_dbname", "ivle",
170
154
"""Database name:""",
172
156
# Database name"""))
174
157
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
175
158
"""Forum Database name:""",
177
160
# Forum Database name"""))
179
161
config_options.append(ConfigOption("db_user", "postgres",
180
162
"""Username for DB server login:""",
182
164
# Database username"""))
184
165
config_options.append(ConfigOption("db_password", "",
185
166
"""Password for DB server login:
186
(Caution: This password is stored in plaintext in ivle/conf/conf.py)""",
167
(Caution: This password is stored in plaintext in lib/conf/conf.py)""",
188
169
# Database password"""))
190
config_options.append(ConfigOption("auth_modules", "",
170
config_options.append(ConfigOption("auth_modules", "ldap_auth",
191
171
"""Authentication config
192
172
=====================
193
Comma-separated list of authentication modules.""",
173
Comma-separated list of authentication modules. Only "ldap" is available
195
176
# Comma-separated list of authentication modules.
196
# Note that auth is always enabled against the local database, and NO OTHER
197
# auth is enabled by default. This section is for specifying additional auth
199
177
# These refer to importable Python modules in the www/auth directory.
200
# Modules "ldap_auth" and "guest" are available in the source tree, but
178
# Modules "ldap" and "guest" are available in the source tree, but
201
179
# other modules may be plugged in to auth against organisation-specific
202
# auth backends.""", ask=False))
180
# auth backends."""))
204
181
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
205
182
"""(LDAP options are only relevant if "ldap" is included in the list of
207
184
URL for LDAP authentication server:""",
209
# URL for LDAP authentication server""", ask=False))
186
# URL for LDAP authentication server"""))
211
187
config_options.append(ConfigOption("ldap_format_string",
212
188
"uid=%s,ou=users,o=example",
213
189
"""Format string for LDAP auth request:
214
190
(Must contain a single "%s" for the user's login name)""",
216
192
# Format string for LDAP auth request
217
# (Must contain a single "%s" for the user's login name)""", ask=False))
193
# (Must contain a single "%s" for the user's login name)"""))
219
194
config_options.append(ConfigOption("subject_pulldown_modules", "",
220
195
"""Comma-separated list of subject pulldown modules.
221
196
Add proprietary modules to automatically enrol students in subjects.""",
224
199
# These refer to importable Python modules in the lib/pulldown_subj directory.
225
200
# Only "dummy_subj" is available in the source tree (an example), but
226
201
# other modules may be plugged in to pulldown against organisation-specific
227
# pulldown backends.""", ask=False))
202
# pulldown backends."""))
229
203
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
230
204
"""Subversion config
231
205
=================
232
206
The base url for accessing subversion repositories:""",
234
208
# The base url for accessing subversion repositories."""))
209
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
210
"""The location of the subversion configuration file used by apache
211
to host the user repositories:""",
213
# The location of the subversion configuration file used by
214
# apache to host the user repositories."""))
215
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
216
"""The root directory for the subversion repositories:""",
218
# The root directory for the subversion repositories."""))
219
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
220
"""The location of the password file used to authenticate users
221
of the subversion repository from the ivle server:""",
223
# The location of the password file used to authenticate users
224
# of the subversion repository from the ivle server."""))
225
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
226
"""The location of the password file used to authenticate local users
227
of the subversion repository:""",
229
# The location of the password file used to authenticate local users
230
# of the subversion repository."""))
236
231
config_options.append(ConfigOption("usrmgt_host", "localhost",
237
232
"""User Management Server config
238
233
============================
239
234
The hostname where the usrmgt-server runs:""",
241
236
# The hostname where the usrmgt-server runs."""))
243
237
config_options.append(ConfigOption("usrmgt_port", "2178",
244
238
"""The port where the usrmgt-server runs:""",
246
# The port where the usrmgt-server runs.""", ask=False))
248
config_options.append(ConfigOption("usrmgt_magic", None,
240
# The port where the usrmgt-server runs."""))
241
config_options.append(ConfigOption("usrmgt_magic", "",
249
242
"""The password for the usrmgt-server:""",
251
# The password for the usrmgt-server.""", ask=False))
244
# The password for the usrmgt-server."""))
253
246
def configure(args):
247
usage = """usage: %prog build [options]
249
Compiles all files and sets up a jail template in the source directory.
250
-O is recommended to cause compilation to be optimised.
252
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
253
Creates jail with system and student packages installed from MIRROR.
254
Copies console/ to a location within the jail.
255
Copies OS programs and files to corresponding locations within the jail
256
(eg. python and Python libs, ld.so, etc).
257
Generates .pyc or .pyo files for all the IVLE .py files."""
260
parser = optparse.OptionParser(usage)
261
(options, args) = parser.parse_args(args)
254
263
# Call the real function
255
return __configure(args)
257
266
def __configure(args):
258
267
global db_port, usrmgt_port
346
358
"Must be an integer between 0 and 65535." % repr(usrmgt_port))
349
# By default we generate the magic randomly.
350
if globals()['usrmgt_magic'] is None:
351
globals()['usrmgt_magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
353
361
# Generate the forum secret
354
362
forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
356
# Write ./etc/ivle.conf
358
conf = configobj.ConfigObj()
359
conf.filename = conffile
361
conf.initial_comment = ["# IVLE Configuration File"]
363
# Add the forum secret to the config file (regenerated each config)
364
config_options.append(ConfigOption('forum_secret', None, '', ''))
365
globals()['forum_secret'] = forum_secret
367
for legacyopt in config_options:
368
newopt_path = CONFIG_OPTIONS[legacyopt.option_name].split('/')
369
# Iterate over each segment of the path, and find the section in conf
370
# file to insert the value into (use all but the last path segment)
372
for seg in newopt_path[:-1]:
373
# Create the section if it isn't there
374
if seg not in conf_section:
375
conf_section[seg] = {}
376
conf_section = conf_section[seg]
377
# The final path segment names the key to insert into
378
keyname = newopt_path[-1]
379
value = globals()[legacyopt.option_name]
380
if value is not None:
381
conf_section[keyname] = value
382
conf_section.comments[keyname] = legacyopt.comment.split('\n')
386
print "Successfully wrote %s" % conffile
388
# Write bin/trampoline/conf.h
390
conf = open(conf_hfile, "w")
392
# XXX Compute jail_base, jail_src_base and jail_system. These will
393
# ALSO be done by the boilerplate code, but we need them here in order
394
# to write to the C file.
395
jail_base = os.path.join(data_path, 'jailmounts')
396
jail_src_base = os.path.join(data_path, 'jails')
397
jail_system = os.path.join(jail_src_base, '__base__')
399
conf.write("""/* IVLE Configuration File
364
# Write lib/conf/conf.py
367
conf = open(conffile, "w")
369
conf.write("""# IVLE Configuration File
371
# Miscellaneous application settings
374
for opt in config_options:
375
conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
376
repr(globals()[opt.option_name])))
378
# Add the forum secret to the config file (regenerated each config)
379
conf.write('forum_secret = "%s"\n' % (forum_secret))
382
except IOError, (errno, strerror):
383
print "IO error(%s): %s" % (errno, strerror)
386
print "Successfully wrote lib/conf/conf.py"
388
# Write conf/jailconf.py
391
conf = open(jailconffile, "w")
393
# In the "in-jail" version of conf, we don't need MOST of the details
394
# (it would be a security risk to have them here).
395
# So we just write root_dir, and jail_base is "/".
396
# (jail_base being "/" means "jail-relative" paths are relative to "/"
397
# when inside the jail.)
398
conf.write("""# IVLE Configuration File
400
# Miscellaneous application settings
401
# (User jail version)
404
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
406
# eg. "/" or "/ivle".
409
# In the local file system, where are the student/user file spaces located.
410
# The user jails are expected to be located immediately in subdirectories of
414
# The hostname for serving publicly accessible pages
416
""" % (repr(root_dir),repr(public_host)))
419
except IOError, (errno, strerror):
420
print "IO error(%s): %s" % (errno, strerror)
423
print "Successfully wrote lib/conf/jailconf.py"
425
# Write trampoline/conf.h
428
conf = open(conf_hfile, "w")
430
conf.write("""/* IVLE Configuration File
401
432
* Administrator settings required by trampoline.
402
433
* Note: trampoline will have to be rebuilt in order for changes to this file
458
493
$forum_secret = '""" + forum_secret +"""';
463
print "Successfully wrote %s" % phpBBconffile
497
except IOError, (errno, strerror):
498
print "IO error(%s): %s" % (errno, strerror)
501
print "Successfully wrote www/php/phpBB3/config.php"
503
# Write lib/conf/usrmgt-server.init
506
conf = open(usrmgtserver_initdfile, "w")
508
conf.write( '''#! /bin/sh
510
# Works for Ubuntu. Check before using on other distributions
513
# Provides: usrmgt-server
514
# Required-Start: $syslog $networking $urandom
515
# Required-Stop: $syslog
516
# Default-Start: 2 3 4 5
518
# Short-Description: IVLE user management server
519
# Description: Daemon connecting to the IVLE user management database.
522
PATH=/sbin:/bin:/usr/sbin:/usr/bin
523
DESC="IVLE user management server"
525
DAEMON=/opt/ivle/scripts/$NAME
526
DAEMON_ARGS="''' + str(usrmgt_port) + ''' ''' + usrmgt_magic + '''"
527
PIDFILE=/var/run/$NAME.pid
528
SCRIPTNAME=/etc/init.d/usrmgt-server
530
# Exit if the daemon does not exist
531
test -f $DAEMON || exit 0
533
# Load the VERBOSE setting and other rcS variables
534
[ -f /etc/default/rcS ] && . /etc/default/rcS
536
# Define LSB log_* functions.
537
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
538
. /lib/lsb/init-functions
541
# Function that starts the daemon/service
546
# 0 if daemon has been started
547
# 1 if daemon was already running
548
# 2 if daemon could not be started
549
start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
551
start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
554
# Add code here, if necessary, that waits for the process to be ready
555
# to handle requests from services started subsequently which depend
556
# on this one. As a last resort, sleep for some time.
560
# Function that stops the daemon/service
565
# 0 if daemon has been stopped
566
# 1 if daemon was already stopped
567
# 2 if daemon could not be stopped
568
# other if a failure occurred
569
start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
571
[ "$RETVAL" = 2 ] && return 2
572
# Wait for children to finish too if this is a daemon that forks
573
# and if the daemon is only ever run from this initscript.
574
# If the above conditions are not satisfied then add some other code
575
# that waits for the process to drop all resources that could be
576
# needed by services started subsequently. A last resort is to
577
# sleep for some time.
578
start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
579
[ "$?" = 2 ] && return 2
580
# Many daemons don't delete their pidfiles when they exit.
586
# Function that sends a SIGHUP to the daemon/service
590
# If the daemon can reload its configuration without
591
# restarting (for example, when it is sent a SIGHUP),
592
# then implement that here.
594
start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
600
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
603
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
604
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
608
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
611
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
612
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
615
#reload|force-reload)
617
# If do_reload() is not implemented then leave this commented out
618
# and leave 'force-reload' as an alias for 'restart'.
620
#log_daemon_msg "Reloading $DESC" "$NAME"
624
restart|force-reload)
626
# If the "reload" option is implemented then remove the
627
# 'force-reload' alias
629
log_daemon_msg "Restarting $DESC" "$NAME"
636
1) log_end_msg 1 ;; # Old process is still running
637
*) log_end_msg 1 ;; # Failed to start
647
#echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
648
echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
657
except IOError, (errno, strerror):
658
print "IO error(%s): %s" % (errno, strerror)
661
# fix permissions as the file contains the database password
663
os.chmod('doc/setup/usrmgt-server.init', 0600)
664
except OSError, (errno, strerror):
665
print "WARNING: Couldn't chmod doc/setup/usrmgt-server.init:"
666
print "OS error(%s): %s" % (errno, strerror)
668
print "Successfully wrote lib/conf/usrmgt-server.init"
466
671
print "You may modify the configuration at any time by editing"
469
675
print phpBBconffile
676
print usrmgtserver_initdfile
added
removed
setup/configure.py
