← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to setup/configure.py

  • Committer: dcoles
  • Date: 2008-07-03 04:38:30 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:804
Setup: To go with last revision - Now just a front end for the setup package

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup/configure.py
23
23
# Configures IVLE with machine-specific details, most notably, various paths.
24
24
# Either prompts the administrator for these details or accepts them as
25
25
# command-line args.
26
 
# Creates lib/conf/conf.py and bin/trampoline/conf.h.
 
26
# Creates lib/conf/conf.py and trampoline/conf.h.
27
27
 
28
28
import optparse
29
29
import getopt
30
30
import os
31
 
import sys
32
31
import hashlib
33
32
import uuid
34
 
 
35
 
from setup.util import query_user
 
33
from setup.setuputil import query_user
36
34
 
37
35
class ConfigOption:
38
36
    """A configuration option; one of the things written to conf.py."""
39
 
    def __init__(self, option_name, default, prompt, comment, ask=True):
 
37
    def __init__(self, option_name, default, prompt, comment):
40
38
        """Creates a configuration option.
41
39
        option_name: Name of the variable in conf.py. Also name of the
42
40
            command-line argument to setup.py conf.
45
43
            setup.py conf.
46
44
        comment: (Long) comment string stored in conf.py. Each line of this
47
45
            string should begin with a '#'.
48
 
        ask: Whether to ask the question in the default config run.
49
46
        """
50
47
        self.option_name = option_name
51
48
        self.default = default
52
49
        self.prompt = prompt
53
50
        self.comment = comment
54
 
        self.ask = ask
55
51
 
56
52
# Configuration options, defaults and descriptions
57
53
config_options = []
58
 
 
59
54
config_options.append(ConfigOption("root_dir", "/",
60
55
    """Root directory where IVLE is located (in URL space):""",
61
56
    """
62
57
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
63
58
# with this).
64
 
# eg. "/" or "/ivle".""", ask=False))
65
 
 
66
 
config_options.append(ConfigOption("prefix", "/usr/local",
67
 
    """In the local file system, the prefix to the system directory where IVLE
68
 
is installed. (This should either be /usr or /usr/local):""",
69
 
    """
70
 
# In the local file system, the prefix to the system directory where IVLE is
71
 
# installed. This should either be '/usr' or '/usr/local'.
72
 
# ('/usr/local' for the usual install, '/usr' for distribution packages)""",
73
 
    ask=False))
74
 
 
75
 
config_options.append(ConfigOption("python_site_packages_override",
76
 
    None,
77
 
    """site-packages directory in Python, where Python libraries are to be
78
 
installed. May be left as the default, in which case the value will be
79
 
computed from prefix and the current Python version:""",
80
 
    """
81
 
# 'site-packages' directory in Python, where Python libraries are to be
82
 
# installed. May be None (recommended), in which case the value will be
83
 
# computed from prefix and the current Python version.""", ask=False))
84
 
 
85
 
config_options.append(ConfigOption("data_path",
86
 
    "/var/lib/ivle",
87
 
    "In the local file system, where user-modifiable data files should be "
88
 
    "located:",
89
 
    """
90
 
# In the local file system, where user-modifiable data files should be
91
 
# located.""", ask=False))
92
 
 
93
 
config_options.append(ConfigOption("log_path",
94
 
    "/var/log/ivle",
95
 
    """Directory where IVLE log files are stored (on the local
96
 
file system). Note - this must be writable by the user the IVLE server 
97
 
process runs as (usually www-data):""",
98
 
    """
99
 
# In the local file system, where IVLE error logs should be located.""",
100
 
    ask=False))
101
 
 
 
59
# eg. "/" or "/ivle"."""))
 
60
config_options.append(ConfigOption("ivle_install_dir", "/opt/ivle",
 
61
    'Root directory where IVLE will be installed (on the local file '
 
62
    'system):',
 
63
    """
 
64
# In the local file system, where IVLE is actually installed.
 
65
# This directory should contain the "www" and "bin" directories."""))
 
66
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
 
67
    """Location of Directories
 
68
=======================
 
69
Root directory where the jails (containing user files) are stored
 
70
(on the local file system):""",
 
71
    """
 
72
# In the local file system, where are the student/user file spaces located.
 
73
# The user jails are expected to be located immediately in subdirectories of
 
74
# this location."""))
 
75
config_options.append(ConfigOption("subjects_base",
 
76
    "/home/informatics/subjects",
 
77
    """Root directory where the subject directories (containing worksheets
 
78
and other per-subject files) are stored (on the local file system):""",
 
79
    """
 
80
# In the local file system, where are the per-subject file spaces located.
 
81
# The individual subject directories are expected to be located immediately
 
82
# in subdirectories of this location."""))
 
83
config_options.append(ConfigOption("exercises_base",
 
84
    "/home/informatics/exercises",
 
85
    """Root directory where the exercise directories (containing
 
86
subject-independent exercise sheets) are stored (on the local file
 
87
system):""",
 
88
    """
 
89
# In the local file system, where are the subject-independent exercise sheet
 
90
# file spaces located."""))
 
91
config_options.append(ConfigOption("tos_path",
 
92
    "/home/informatics/tos.html",
 
93
    """Location where the Terms of Service document is stored (on the local
 
94
    file system):""",
 
95
    """
 
96
# In the local file system, where is the Terms of Service document located."""))
 
97
config_options.append(ConfigOption("motd_path",
 
98
    "/home/informatics/motd.html",
 
99
    """Location where the Message of the Day document is stored (on the local
 
100
    file system):""",
 
101
    """
 
102
# In the local file system, where is the Message of the Day document
 
103
# located. This is an HTML file (just the body fragment), which will
 
104
# be displayed on the login page. It is optional."""))
102
105
config_options.append(ConfigOption("public_host", "public.localhost",
103
106
    """Hostname which will cause the server to go into "public mode",
104
107
providing login-free access to student's published work:""",
109
112
# Public mode does not use cookies, and serves only public content.
110
113
# Private mode (normal mode) requires login, and only serves files relevant to
111
114
# the logged-in user."""))
112
 
 
113
115
config_options.append(ConfigOption("allowed_uids", "33",
114
116
    """UID of the web server process which will run IVLE.
115
117
Only this user may execute the trampoline. May specify multiple users as
119
121
# The User-ID of the web server process which will run IVLE, and any other
120
122
# users who are allowed to run the trampoline. This is stores as a string of
121
123
# 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).""",
123
 
    ask=False))
124
 
 
 
124
# used by the setup program to write to conf.h (see setup.py config)."""))
125
125
config_options.append(ConfigOption("db_host", "localhost",
126
126
    """PostgreSQL Database config
127
127
==========================
129
129
    """
130
130
### PostgreSQL Database config ###
131
131
# Database server hostname"""))
132
 
 
133
132
config_options.append(ConfigOption("db_port", "5432",
134
133
    """Port of the DB server:""",
135
134
    """
136
135
# Database server port"""))
137
 
 
138
136
config_options.append(ConfigOption("db_dbname", "ivle",
139
137
    """Database name:""",
140
138
    """
141
139
# Database name"""))
142
 
 
143
140
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
144
141
    """Forum Database name:""",
145
142
    """
146
143
# Forum Database name"""))
147
 
 
148
144
config_options.append(ConfigOption("db_user", "postgres",
149
145
    """Username for DB server login:""",
150
146
    """
151
147
# Database username"""))
152
 
 
153
148
config_options.append(ConfigOption("db_password", "",
154
149
    """Password for DB server login:
155
 
    (Caution: This password is stored in plaintext in ivle/conf/conf.py)""",
 
150
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
156
151
    """
157
152
# Database password"""))
158
 
 
159
 
config_options.append(ConfigOption("auth_modules", "",
 
153
config_options.append(ConfigOption("auth_modules", "ldap_auth",
160
154
    """Authentication config
161
155
=====================
162
 
Comma-separated list of authentication modules.""",
 
156
Comma-separated list of authentication modules. Only "ldap" is available
 
157
by default.""",
163
158
    """
164
159
# Comma-separated list of authentication modules.
165
 
# Note that auth is always enabled against the local database, and NO OTHER
166
 
# auth is enabled by default. This section is for specifying additional auth
167
 
# modules.
168
160
# These refer to importable Python modules in the www/auth directory.
169
 
# Modules "ldap_auth" and "guest" are available in the source tree, but
 
161
# Modules "ldap" and "guest" are available in the source tree, but
170
162
# other modules may be plugged in to auth against organisation-specific
171
 
# auth backends.""", ask=False))
172
 
 
 
163
# auth backends."""))
173
164
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
174
165
    """(LDAP options are only relevant if "ldap" is included in the list of
175
166
auth modules).
176
167
URL for LDAP authentication server:""",
177
168
    """
178
 
# URL for LDAP authentication server""", ask=False))
179
 
 
 
169
# URL for LDAP authentication server"""))
180
170
config_options.append(ConfigOption("ldap_format_string",
181
171
    "uid=%s,ou=users,o=example",
182
172
    """Format string for LDAP auth request:
183
173
    (Must contain a single "%s" for the user's login name)""",
184
174
    """
185
175
# Format string for LDAP auth request
186
 
# (Must contain a single "%s" for the user's login name)""", ask=False))
187
 
 
188
 
config_options.append(ConfigOption("subject_pulldown_modules", "",
189
 
    """Comma-separated list of subject pulldown modules.
190
 
Add proprietary modules to automatically enrol students in subjects.""",
191
 
    """
192
 
# Comma-separated list of subject pulldown modules.
193
 
# These refer to importable Python modules in the lib/pulldown_subj directory.
194
 
# Only "dummy_subj" is available in the source tree (an example), but
195
 
# other modules may be plugged in to pulldown against organisation-specific
196
 
# pulldown backends.""", ask=False))
197
 
 
 
176
# (Must contain a single "%s" for the user's login name)"""))
198
177
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
199
178
    """Subversion config
200
179
=================
201
180
The base url for accessing subversion repositories:""",
202
181
    """
203
182
# The base url for accessing subversion repositories."""))
204
 
 
 
183
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
 
184
    """The location of the subversion configuration file used by apache
 
185
to host the user repositories:""",
 
186
    """
 
187
# The location of the subversion configuration file used by
 
188
# apache to host the user repositories."""))
 
189
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
 
190
    """The root directory for the subversion repositories:""",
 
191
    """
 
192
# The root directory for the subversion repositories."""))
 
193
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
 
194
    """The location of the password file used to authenticate users
 
195
of the subversion repository from the ivle server:""",
 
196
    """
 
197
# The location of the password file used to authenticate users
 
198
# of the subversion repository from the ivle server."""))
 
199
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
 
200
    """The location of the password file used to authenticate local users
 
201
of the subversion repository:""",
 
202
    """
 
203
# The location of the password file used to authenticate local users
 
204
# of the subversion repository."""))
205
205
config_options.append(ConfigOption("usrmgt_host", "localhost",
206
206
    """User Management Server config
207
207
============================
208
208
The hostname where the usrmgt-server runs:""",
209
209
    """
210
210
# The hostname where the usrmgt-server runs."""))
211
 
 
212
211
config_options.append(ConfigOption("usrmgt_port", "2178",
213
212
    """The port where the usrmgt-server runs:""",
214
213
    """
215
 
# The port where the usrmgt-server runs.""", ask=False))
216
 
 
217
 
config_options.append(ConfigOption("usrmgt_magic", None,
 
214
# The port where the usrmgt-server runs."""))
 
215
config_options.append(ConfigOption("usrmgt_magic", "",
218
216
    """The password for the usrmgt-server:""",
219
217
    """
220
 
# The password for the usrmgt-server.""", ask=False))
 
218
# The password for the usrmgt-server."""))
221
219
 
222
220
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."""
 
221
    usage = """usage: %prog build [options]
 
222
(requires root)
 
223
Compiles all files and sets up a jail template in the source directory.
 
224
-O is recommended to cause compilation to be optimised.
 
225
Details:
 
226
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
 
227
Creates jail with system and student packages installed from MIRROR.
 
228
Copies console/ to a location within the jail.
 
229
Copies OS programs and files to corresponding locations within the jail
 
230
  (eg. python and Python libs, ld.so, etc).
 
231
Generates .pyc or .pyo files for all the IVLE .py files."""
226
232
 
227
233
    # Parse arguments
228
234
    parser = optparse.OptionParser(usage)
229
235
    (options, args) = parser.parse_args(args)
230
236
 
231
237
    # Call the real function
232
 
    return __configure(args)
 
238
    __configure(args)
233
239
 
234
240
def __configure(args):
235
241
    global db_port, usrmgt_port
239
245
    # of setup besides conf, so we need to know them.
240
246
    # Also this allows you to hit Return to accept the existing value.
241
247
    try:
242
 
        confmodule = __import__("ivle/conf/conf")
 
248
        confmodule = __import__("lib/conf/conf")
243
249
        for opt in config_options:
244
250
            try:
245
251
                globals()[opt.option_name] = \
255
261
    cwd = os.getcwd()
256
262
 
257
263
    # 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")
 
264
    conffile = os.path.join(cwd, "lib/conf/conf.py")
 
265
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
 
266
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
261
267
    phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
 
268
    usrmgtserver_initdfile = os.path.join(cwd, "doc/setup/usrmgt-server.init")
262
269
 
263
270
    # Get command-line arguments to avoid asking questions.
264
271
 
279
286
    %s
280
287
    %s
281
288
    %s
 
289
    %s
282
290
prompting you for details about your configuration. The file will be
283
291
overwritten if it already exists. It will *not* install or deploy IVLE.
284
292
 
285
293
Please hit Ctrl+C now if you do not wish to do this.
286
 
""" % (conffile, jailconffile, conf_hfile, phpBBconffile)
 
294
""" % (conffile, jailconffile, conf_hfile, phpBBconffile, usrmgtserver_initdfile)
287
295
 
288
296
        # Get information from the administrator
289
297
        # If EOF is encountered at any time during the questioning, just exit
290
298
        # silently
291
299
 
292
300
        for opt in config_options:
293
 
            if opt.ask:
294
 
                globals()[opt.option_name] = \
295
 
                    query_user(globals()[opt.option_name], opt.prompt)
 
301
            globals()[opt.option_name] = \
 
302
                query_user(globals()[opt.option_name], opt.prompt)
296
303
    else:
297
304
        opts = dict(opts)
298
305
        # Non-interactive mode. Parse the options.
325
332
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
326
333
        return 1
327
334
 
328
 
    # By default we generate the magic randomly.
329
 
    if globals()['usrmgt_magic'] is None:
330
 
        globals()['usrmgt_magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
331
 
 
332
335
    # Generate the forum secret
333
336
    forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
334
337
 
341
344
# conf.py
342
345
# Miscellaneous application settings
343
346
 
344
 
import os
345
 
import sys
346
347
""")
347
348
        for opt in config_options:
348
 
            conf.write('%s\n%s = %r\n' % (opt.comment, opt.option_name,
349
 
                globals()[opt.option_name]))
350
 
 
351
 
            # Add the forum secret to the config file (regenerated each config)
352
 
        conf.write('forum_secret = "%s"\n\n' % (forum_secret))
353
 
 
354
 
        write_conf_file_boilerplate(conf)
 
349
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
 
350
                repr(globals()[opt.option_name])))
 
351
 
 
352
        # Add the forum secret to the config file (regenerated each config)
 
353
        conf.write('forum_secret = "%s"\n' % (forum_secret))
355
354
 
356
355
        conf.close()
357
356
    except IOError, (errno, strerror):
358
357
        print "IO error(%s): %s" % (errno, strerror)
359
358
        sys.exit(1)
360
359
 
361
 
    print "Successfully wrote %s" % conffile
 
360
    print "Successfully wrote lib/conf/conf.py"
362
361
 
363
362
    # Write conf/jailconf.py
364
363
 
388
387
 
389
388
# The hostname for serving publicly accessible pages
390
389
public_host = %s
391
 
 
392
 
# The URL under which the Subversion repositories are located.
393
 
svn_addr = %s
394
 
""" % (repr(root_dir),repr(public_host),repr(svn_addr)))
 
390
""" % (repr(root_dir),repr(public_host)))
395
391
 
396
392
        conf.close()
397
393
    except IOError, (errno, strerror):
398
394
        print "IO error(%s): %s" % (errno, strerror)
399
395
        sys.exit(1)
400
396
 
401
 
    print "Successfully wrote %s" % jailconffile
 
397
    print "Successfully wrote lib/conf/jailconf.py"
402
398
 
403
 
    # Write bin/trampoline/conf.h
 
399
    # Write trampoline/conf.h
404
400
 
405
401
    try:
406
402
        conf = open(conf_hfile, "w")
407
403
 
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__')
414
 
 
415
404
        conf.write("""/* IVLE Configuration File
416
405
 * conf.h
417
406
 * Administrator settings required by trampoline.
419
408
 * to take effect.
420
409
 */
421
410
 
422
 
#define IVLE_AUFS_JAILS
423
 
 
424
411
/* In the local file system, where are the jails located.
425
412
 * The trampoline does not allow the creation of a jail anywhere besides
426
413
 * jail_base or a subdirectory of jail_base.
427
414
 */
428
415
static const char* jail_base = "%s";
429
 
static const char* jail_src_base = "%s";
430
 
static const char* jail_system = "%s";
431
416
 
432
417
/* Which user IDs are allowed to run the trampoline.
433
418
 * This list should be limited to the web server user.
434
419
 * (Note that root is an implicit member of this list).
435
420
 */
436
421
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]))
 
422
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
439
423
    # Note: The above uses PYTHON reprs, not C reprs
440
424
    # However they should be the same with the exception of the outer
441
425
    # characters, which are stripped off and replaced
445
429
        print "IO error(%s): %s" % (errno, strerror)
446
430
        sys.exit(1)
447
431
 
448
 
    print "Successfully wrote %s" % conf_hfile
 
432
    print "Successfully wrote trampoline/conf.h"
449
433
 
450
434
    # Write www/php/phpBB3/config.php
451
435
 
483
467
        print "IO error(%s): %s" % (errno, strerror)
484
468
        sys.exit(1)
485
469
 
486
 
    print "Successfully wrote %s" % phpBBconffile
 
470
    print "Successfully wrote www/php/phpBB3/config.php"
 
471
 
 
472
    # Write lib/conf/usrmgt-server.init
 
473
 
 
474
    try:
 
475
        conf = open(usrmgtserver_initdfile, "w")
 
476
 
 
477
        conf.write( '''#! /bin/sh
 
478
 
 
479
# Works for Ubuntu. Check before using on other distributions
 
480
 
 
481
### BEGIN INIT INFO
 
482
# Provides:          usrmgt-server
 
483
# Required-Start:    $syslog $networking $urandom
 
484
# Required-Stop:     $syslog
 
485
# Default-Start:     2 3 4 5
 
486
# Default-Stop:      1
 
487
# Short-Description: IVLE user management server
 
488
# Description:       Daemon connecting to the IVLE user management database.
 
489
### END INIT INFO
 
490
 
 
491
PATH=/sbin:/bin:/usr/sbin:/usr/bin
 
492
DESC="IVLE user management server"
 
493
NAME=usrmgt-server
 
494
DAEMON=/opt/ivle/scripts/$NAME
 
495
DAEMON_ARGS="''' + str(usrmgt_port) + ''' ''' + usrmgt_magic + '''"
 
496
PIDFILE=/var/run/$NAME.pid
 
497
SCRIPTNAME=/etc/init.d/usrmgt-server
 
498
 
 
499
# Exit if the daemon does not exist 
 
500
test -f $DAEMON || exit 0
 
501
 
 
502
# Load the VERBOSE setting and other rcS variables
 
503
[ -f /etc/default/rcS ] && . /etc/default/rcS
 
504
 
 
505
# Define LSB log_* functions.
 
506
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
 
507
. /lib/lsb/init-functions
 
508
 
 
509
#
 
510
# Function that starts the daemon/service
 
511
#
 
512
do_start()
 
513
{
 
514
        # Return
 
515
        #   0 if daemon has been started
 
516
        #   1 if daemon was already running
 
517
        #   2 if daemon could not be started
 
518
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
 
519
                || return 1
 
520
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
 
521
                $DAEMON_ARGS \
 
522
                || return 2
 
523
        # Add code here, if necessary, that waits for the process to be ready
 
524
        # to handle requests from services started subsequently which depend
 
525
        # on this one.  As a last resort, sleep for some time.
 
526
}
 
527
 
 
528
#
 
529
# Function that stops the daemon/service
 
530
#
 
531
do_stop()
 
532
{
 
533
        # Return
 
534
        #   0 if daemon has been stopped
 
535
        #   1 if daemon was already stopped
 
536
        #   2 if daemon could not be stopped
 
537
        #   other if a failure occurred
 
538
        start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
 
539
        RETVAL="$?"
 
540
        [ "$RETVAL" = 2 ] && return 2
 
541
        # Wait for children to finish too if this is a daemon that forks
 
542
        # and if the daemon is only ever run from this initscript.
 
543
        # If the above conditions are not satisfied then add some other code
 
544
        # that waits for the process to drop all resources that could be
 
545
        # needed by services started subsequently.  A last resort is to
 
546
        # sleep for some time.
 
547
        start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
 
548
        [ "$?" = 2 ] && return 2
 
549
        # Many daemons don't delete their pidfiles when they exit.
 
550
        rm -f $PIDFILE
 
551
        return "$RETVAL"
 
552
}
 
553
 
 
554
#
 
555
# Function that sends a SIGHUP to the daemon/service
 
556
#
 
557
do_reload() {
 
558
        #
 
559
        # If the daemon can reload its configuration without
 
560
        # restarting (for example, when it is sent a SIGHUP),
 
561
        # then implement that here.
 
562
        #
 
563
        start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
 
564
        return 0
 
565
}
 
566
 
 
567
case "$1" in
 
568
  start)
 
569
    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
 
570
        do_start
 
571
        case "$?" in
 
572
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
 
573
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
 
574
        esac
 
575
        ;;
 
576
  stop)
 
577
        [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
 
578
        do_stop
 
579
        case "$?" in
 
580
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
 
581
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
 
582
        esac
 
583
        ;;
 
584
  #reload|force-reload)
 
585
        #
 
586
        # If do_reload() is not implemented then leave this commented out
 
587
        # and leave 'force-reload' as an alias for 'restart'.
 
588
        #
 
589
        #log_daemon_msg "Reloading $DESC" "$NAME"
 
590
        #do_reload
 
591
        #log_end_msg $?
 
592
        #;;
 
593
  restart|force-reload)
 
594
        #
 
595
        # If the "reload" option is implemented then remove the
 
596
        # 'force-reload' alias
 
597
        #
 
598
        log_daemon_msg "Restarting $DESC" "$NAME"
 
599
        do_stop
 
600
        case "$?" in
 
601
          0|1)
 
602
                do_start
 
603
                case "$?" in
 
604
                        0) log_end_msg 0 ;;
 
605
                        1) log_end_msg 1 ;; # Old process is still running
 
606
                        *) log_end_msg 1 ;; # Failed to start
 
607
                esac
 
608
                ;;
 
609
          *)
 
610
                # Failed to stop
 
611
                log_end_msg 1
 
612
                ;;
 
613
        esac
 
614
        ;;
 
615
  *)
 
616
        #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
 
617
        echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
 
618
        exit 3
 
619
        ;;
 
620
esac
 
621
 
 
622
:
 
623
''')
 
624
        
 
625
        conf.close()
 
626
    except IOError, (errno, strerror):
 
627
        print "IO error(%s): %s" % (errno, strerror)
 
628
        sys.exit(1)
 
629
 
 
630
    # fix permissions as the file contains the database password
 
631
    try:
 
632
        os.chmod('doc/setup/usrmgt-server.init', 0600)
 
633
    except OSError, (errno, strerror):
 
634
        print "WARNING: Couldn't chmod doc/setup/usrmgt-server.init:"
 
635
        print "OS error(%s): %s" % (errno, strerror)
 
636
 
 
637
    print "Successfully wrote lib/conf/usrmgt-server.init"
487
638
 
488
639
    print
489
640
    print "You may modify the configuration at any time by editing"
491
642
    print jailconffile
492
643
    print conf_hfile
493
644
    print phpBBconffile
 
645
    print usrmgtserver_initdfile
494
646
    print
495
647
    
496
648
    return 0
497
 
 
498
 
def write_conf_file_boilerplate(conf_file):
499
 
    conf_file.write("""\
500
 
### Below is boilerplate code, appended by ./setup.py config ###
501
 
 
502
 
# Path where architecture-dependent data (including non-user-executable
503
 
# binaries) is installed.
504
 
lib_path = os.path.join(prefix, 'lib/ivle')
505
 
 
506
 
# Path where arch-independent data is installed.
507
 
share_path = os.path.join(prefix, 'share/ivle')
508
 
 
509
 
# Path where user-executable binaries are installed.
510
 
bin_path = os.path.join(prefix, 'bin')
511
 
 
512
 
# 'site-packages' directory in Python, where Python libraries are to be
513
 
# installed.
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)
518
 
else:
519
 
    python_site_packages = python_site_packages_override
520
 
 
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')
525
 
 
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
529
 
# modifications.
530
 
jail_src_base = os.path.join(data_path, 'jails')
531
 
 
532
 
# In the local file system, where the template system jail will be stored.
533
 
jail_system = os.path.join(jail_src_base, '__base__')
534
 
 
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')
538
 
 
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')
543
 
 
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')
547
 
 
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')
551
 
 
552
 
# In the local file system, where is the Terms of Service document located.
553
 
tos_path = os.path.join(notices_path, 'tos.html')
554
 
 
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')
559
 
 
560
 
# The location of all the subversion config and repositories.
561
 
svn_path = os.path.join(data_path, 'svn')
562
 
 
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')
566
 
 
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')
570
 
 
571
 
# The root directory for the subversion repositories.
572
 
svn_repo_path = os.path.join(svn_path, 'repositories')
573
 
 
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')
577
 
""")