← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/configure.py

  • Committer: chadnickbok
  • Date: 2009-02-03 03:53:54 UTC
  • Revision ID: svn-v4:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1193
Fixed a few small issues with the way the Worksheet menus were
being displayed.

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 trampoline/conf.h.
 
26
# Creates lib/conf/conf.py and bin/trampoline/conf.h.
27
27
 
28
28
import optparse
29
29
import getopt
31
31
import sys
32
32
import hashlib
33
33
import uuid
34
 
from setup.setuputil import query_user
 
34
 
 
35
from setup.util import query_user
35
36
 
36
37
class ConfigOption:
37
38
    """A configuration option; one of the things written to conf.py."""
38
 
    def __init__(self, option_name, default, prompt, comment):
 
39
    def __init__(self, option_name, default, prompt, comment, ask=True):
39
40
        """Creates a configuration option.
40
41
        option_name: Name of the variable in conf.py. Also name of the
41
42
            command-line argument to setup.py conf.
44
45
            setup.py conf.
45
46
        comment: (Long) comment string stored in conf.py. Each line of this
46
47
            string should begin with a '#'.
 
48
        ask: Whether to ask the question in the default config run.
47
49
        """
48
50
        self.option_name = option_name
49
51
        self.default = default
50
52
        self.prompt = prompt
51
53
        self.comment = comment
 
54
        self.ask = ask
52
55
 
53
56
# Configuration options, defaults and descriptions
54
57
config_options = []
 
58
 
55
59
config_options.append(ConfigOption("root_dir", "/",
56
60
    """Root directory where IVLE is located (in URL space):""",
57
61
    """
58
62
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
59
63
# with this).
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 '
63
 
    'system):',
64
 
    """
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):""",
72
 
    """
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.""",
80
 
    """
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):""",
87
 
    """
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
91
 
# modifications."""))
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):""",
96
 
    """
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
104
 
system):""",
105
 
    """
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
111
 
    file system):""",
112
 
    """
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
117
 
    file system):""",
118
 
    """
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."""))
 
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
 
122
102
config_options.append(ConfigOption("public_host", "public.localhost",
123
103
    """Hostname which will cause the server to go into "public mode",
124
104
providing login-free access to student's published work:""",
129
109
# Public mode does not use cookies, and serves only public content.
130
110
# Private mode (normal mode) requires login, and only serves files relevant to
131
111
# the logged-in user."""))
 
112
 
132
113
config_options.append(ConfigOption("allowed_uids", "33",
133
114
    """UID of the web server process which will run IVLE.
134
115
Only this user may execute the trampoline. May specify multiple users as
138
119
# The User-ID of the web server process which will run IVLE, and any other
139
120
# users who are allowed to run the trampoline. This is stores as a string of
140
121
# comma-separated integers, simply because it is not used within Python, only
141
 
# used by the setup program to write to conf.h (see setup.py config)."""))
 
122
# used by the setup program to write to conf.h (see setup.py config).""",
 
123
    ask=False))
 
124
 
142
125
config_options.append(ConfigOption("db_host", "localhost",
143
126
    """PostgreSQL Database config
144
127
==========================
146
129
    """
147
130
### PostgreSQL Database config ###
148
131
# Database server hostname"""))
 
132
 
149
133
config_options.append(ConfigOption("db_port", "5432",
150
134
    """Port of the DB server:""",
151
135
    """
152
136
# Database server port"""))
 
137
 
153
138
config_options.append(ConfigOption("db_dbname", "ivle",
154
139
    """Database name:""",
155
140
    """
156
141
# Database name"""))
 
142
 
157
143
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
158
144
    """Forum Database name:""",
159
145
    """
160
146
# Forum Database name"""))
 
147
 
161
148
config_options.append(ConfigOption("db_user", "postgres",
162
149
    """Username for DB server login:""",
163
150
    """
164
151
# Database username"""))
 
152
 
165
153
config_options.append(ConfigOption("db_password", "",
166
154
    """Password for DB server login:
167
 
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
 
155
    (Caution: This password is stored in plaintext in ivle/conf/conf.py)""",
168
156
    """
169
157
# Database password"""))
170
 
config_options.append(ConfigOption("auth_modules", "ldap_auth",
 
158
 
 
159
config_options.append(ConfigOption("auth_modules", "",
171
160
    """Authentication config
172
161
=====================
173
 
Comma-separated list of authentication modules. Only "ldap" is available
174
 
by default.""",
 
162
Comma-separated list of authentication modules.""",
175
163
    """
176
164
# 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.
177
168
# These refer to importable Python modules in the www/auth directory.
178
 
# Modules "ldap" and "guest" are available in the source tree, but
 
169
# Modules "ldap_auth" and "guest" are available in the source tree, but
179
170
# other modules may be plugged in to auth against organisation-specific
180
 
# auth backends."""))
 
171
# auth backends.""", ask=False))
 
172
 
181
173
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
182
174
    """(LDAP options are only relevant if "ldap" is included in the list of
183
175
auth modules).
184
176
URL for LDAP authentication server:""",
185
177
    """
186
 
# URL for LDAP authentication server"""))
 
178
# URL for LDAP authentication server""", ask=False))
 
179
 
187
180
config_options.append(ConfigOption("ldap_format_string",
188
181
    "uid=%s,ou=users,o=example",
189
182
    """Format string for LDAP auth request:
190
183
    (Must contain a single "%s" for the user's login name)""",
191
184
    """
192
185
# Format string for LDAP auth request
193
 
# (Must contain a single "%s" for the user's login name)"""))
 
186
# (Must contain a single "%s" for the user's login name)""", ask=False))
 
187
 
194
188
config_options.append(ConfigOption("subject_pulldown_modules", "",
195
189
    """Comma-separated list of subject pulldown modules.
196
190
Add proprietary modules to automatically enrol students in subjects.""",
199
193
# These refer to importable Python modules in the lib/pulldown_subj directory.
200
194
# Only "dummy_subj" is available in the source tree (an example), but
201
195
# other modules may be plugged in to pulldown against organisation-specific
202
 
# pulldown backends."""))
 
196
# pulldown backends.""", ask=False))
 
197
 
203
198
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
204
199
    """Subversion config
205
200
=================
206
201
The base url for accessing subversion repositories:""",
207
202
    """
208
203
# 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:""",
212
 
    """
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:""",
217
 
    """
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:""",
222
 
    """
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:""",
228
 
    """
229
 
# The location of the password file used to authenticate local users
230
 
# of the subversion repository."""))
 
204
 
231
205
config_options.append(ConfigOption("usrmgt_host", "localhost",
232
206
    """User Management Server config
233
207
============================
234
208
The hostname where the usrmgt-server runs:""",
235
209
    """
236
210
# The hostname where the usrmgt-server runs."""))
 
211
 
237
212
config_options.append(ConfigOption("usrmgt_port", "2178",
238
213
    """The port where the usrmgt-server runs:""",
239
214
    """
240
 
# The port where the usrmgt-server runs."""))
241
 
config_options.append(ConfigOption("usrmgt_magic", "",
 
215
# The port where the usrmgt-server runs.""", ask=False))
 
216
 
 
217
config_options.append(ConfigOption("usrmgt_magic", None,
242
218
    """The password for the usrmgt-server:""",
243
219
    """
244
 
# The password for the usrmgt-server."""))
 
220
# The password for the usrmgt-server.""", ask=False))
245
221
 
246
222
def configure(args):
247
 
    usage = """usage: %prog build [options]
248
 
(requires root)
249
 
Compiles all files and sets up a jail template in the source directory.
250
 
-O is recommended to cause compilation to be optimised.
251
 
Details:
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."""
 
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."""
258
226
 
259
227
    # Parse arguments
260
228
    parser = optparse.OptionParser(usage)
261
229
    (options, args) = parser.parse_args(args)
262
230
 
263
231
    # Call the real function
264
 
    __configure(args)
 
232
    return __configure(args)
265
233
 
266
234
def __configure(args):
267
235
    global db_port, usrmgt_port
271
239
    # of setup besides conf, so we need to know them.
272
240
    # Also this allows you to hit Return to accept the existing value.
273
241
    try:
274
 
        confmodule = __import__("lib/conf/conf")
 
242
        confmodule = __import__("ivle/conf/conf")
275
243
        for opt in config_options:
276
244
            try:
277
245
                globals()[opt.option_name] = \
287
255
    cwd = os.getcwd()
288
256
 
289
257
    # the files that will be created/overwritten
290
 
    conffile = os.path.join(cwd, "lib/conf/conf.py")
291
 
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
292
 
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
 
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")
293
261
    phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
294
 
    usrmgtserver_initdfile = os.path.join(cwd, "doc/setup/usrmgt-server.init")
295
262
 
296
263
    # Get command-line arguments to avoid asking questions.
297
264
 
312
279
    %s
313
280
    %s
314
281
    %s
315
 
    %s
316
282
prompting you for details about your configuration. The file will be
317
283
overwritten if it already exists. It will *not* install or deploy IVLE.
318
284
 
319
285
Please hit Ctrl+C now if you do not wish to do this.
320
 
""" % (conffile, jailconffile, conf_hfile, phpBBconffile, usrmgtserver_initdfile)
 
286
""" % (conffile, jailconffile, conf_hfile, phpBBconffile)
321
287
 
322
288
        # Get information from the administrator
323
289
        # If EOF is encountered at any time during the questioning, just exit
324
290
        # silently
325
291
 
326
292
        for opt in config_options:
327
 
            globals()[opt.option_name] = \
328
 
                query_user(globals()[opt.option_name], opt.prompt)
 
293
            if opt.ask:
 
294
                globals()[opt.option_name] = \
 
295
                    query_user(globals()[opt.option_name], opt.prompt)
329
296
    else:
330
297
        opts = dict(opts)
331
298
        # Non-interactive mode. Parse the options.
358
325
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
359
326
        return 1
360
327
 
 
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
 
361
332
    # Generate the forum secret
362
333
    forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
363
334
 
370
341
# conf.py
371
342
# Miscellaneous application settings
372
343
 
 
344
import os
 
345
import sys
373
346
""")
374
347
        for opt in config_options:
375
 
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
376
 
                repr(globals()[opt.option_name])))
377
 
 
378
 
        # Add the forum secret to the config file (regenerated each config)
379
 
        conf.write('forum_secret = "%s"\n' % (forum_secret))
 
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)
380
355
 
381
356
        conf.close()
382
357
    except IOError, (errno, strerror):
383
358
        print "IO error(%s): %s" % (errno, strerror)
384
359
        sys.exit(1)
385
360
 
386
 
    print "Successfully wrote lib/conf/conf.py"
 
361
    print "Successfully wrote %s" % conffile
387
362
 
388
363
    # Write conf/jailconf.py
389
364
 
413
388
 
414
389
# The hostname for serving publicly accessible pages
415
390
public_host = %s
416
 
""" % (repr(root_dir),repr(public_host)))
 
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)))
417
395
 
418
396
        conf.close()
419
397
    except IOError, (errno, strerror):
420
398
        print "IO error(%s): %s" % (errno, strerror)
421
399
        sys.exit(1)
422
400
 
423
 
    print "Successfully wrote lib/conf/jailconf.py"
 
401
    print "Successfully wrote %s" % jailconffile
424
402
 
425
 
    # Write trampoline/conf.h
 
403
    # Write bin/trampoline/conf.h
426
404
 
427
405
    try:
428
406
        conf = open(conf_hfile, "w")
429
407
 
 
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
 
430
415
        conf.write("""/* IVLE Configuration File
431
416
 * conf.h
432
417
 * Administrator settings required by trampoline.
460
445
        print "IO error(%s): %s" % (errno, strerror)
461
446
        sys.exit(1)
462
447
 
463
 
    print "Successfully wrote trampoline/conf.h"
 
448
    print "Successfully wrote %s" % conf_hfile
464
449
 
465
450
    # Write www/php/phpBB3/config.php
466
451
 
498
483
        print "IO error(%s): %s" % (errno, strerror)
499
484
        sys.exit(1)
500
485
 
501
 
    print "Successfully wrote www/php/phpBB3/config.php"
502
 
 
503
 
    # Write lib/conf/usrmgt-server.init
504
 
 
505
 
    try:
506
 
        conf = open(usrmgtserver_initdfile, "w")
507
 
 
508
 
        conf.write( '''#! /bin/sh
509
 
 
510
 
# Works for Ubuntu. Check before using on other distributions
511
 
 
512
 
### BEGIN INIT INFO
513
 
# Provides:          usrmgt-server
514
 
# Required-Start:    $syslog $networking $urandom
515
 
# Required-Stop:     $syslog
516
 
# Default-Start:     2 3 4 5
517
 
# Default-Stop:      1
518
 
# Short-Description: IVLE user management server
519
 
# Description:       Daemon connecting to the IVLE user management database.
520
 
### END INIT INFO
521
 
 
522
 
PATH=/sbin:/bin:/usr/sbin:/usr/bin
523
 
DESC="IVLE user management server"
524
 
NAME=usrmgt-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
529
 
 
530
 
# Exit if the daemon does not exist 
531
 
test -f $DAEMON || exit 0
532
 
 
533
 
# Load the VERBOSE setting and other rcS variables
534
 
[ -f /etc/default/rcS ] && . /etc/default/rcS
535
 
 
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
539
 
 
540
 
#
541
 
# Function that starts the daemon/service
542
 
#
543
 
do_start()
544
 
{
545
 
        # Return
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 \
550
 
                || return 1
551
 
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
552
 
                $DAEMON_ARGS \
553
 
                || return 2
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.
557
 
}
558
 
 
559
 
#
560
 
# Function that stops the daemon/service
561
 
#
562
 
do_stop()
563
 
{
564
 
        # Return
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
570
 
        RETVAL="$?"
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.
581
 
        rm -f $PIDFILE
582
 
        return "$RETVAL"
583
 
}
584
 
 
585
 
#
586
 
# Function that sends a SIGHUP to the daemon/service
587
 
#
588
 
do_reload() {
589
 
        #
590
 
        # If the daemon can reload its configuration without
591
 
        # restarting (for example, when it is sent a SIGHUP),
592
 
        # then implement that here.
593
 
        #
594
 
        start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
595
 
        return 0
596
 
}
597
 
 
598
 
case "$1" in
599
 
  start)
600
 
    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
601
 
        do_start
602
 
        case "$?" in
603
 
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
604
 
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
605
 
        esac
606
 
        ;;
607
 
  stop)
608
 
        [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
609
 
        do_stop
610
 
        case "$?" in
611
 
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
612
 
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
613
 
        esac
614
 
        ;;
615
 
  #reload|force-reload)
616
 
        #
617
 
        # If do_reload() is not implemented then leave this commented out
618
 
        # and leave 'force-reload' as an alias for 'restart'.
619
 
        #
620
 
        #log_daemon_msg "Reloading $DESC" "$NAME"
621
 
        #do_reload
622
 
        #log_end_msg $?
623
 
        #;;
624
 
  restart|force-reload)
625
 
        #
626
 
        # If the "reload" option is implemented then remove the
627
 
        # 'force-reload' alias
628
 
        #
629
 
        log_daemon_msg "Restarting $DESC" "$NAME"
630
 
        do_stop
631
 
        case "$?" in
632
 
          0|1)
633
 
                do_start
634
 
                case "$?" in
635
 
                        0) log_end_msg 0 ;;
636
 
                        1) log_end_msg 1 ;; # Old process is still running
637
 
                        *) log_end_msg 1 ;; # Failed to start
638
 
                esac
639
 
                ;;
640
 
          *)
641
 
                # Failed to stop
642
 
                log_end_msg 1
643
 
                ;;
644
 
        esac
645
 
        ;;
646
 
  *)
647
 
        #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
648
 
        echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
649
 
        exit 3
650
 
        ;;
651
 
esac
652
 
 
653
 
:
654
 
''')
655
 
        
656
 
        conf.close()
657
 
    except IOError, (errno, strerror):
658
 
        print "IO error(%s): %s" % (errno, strerror)
659
 
        sys.exit(1)
660
 
 
661
 
    # fix permissions as the file contains the database password
662
 
    try:
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)
667
 
 
668
 
    print "Successfully wrote lib/conf/usrmgt-server.init"
 
486
    print "Successfully wrote %s" % phpBBconffile
669
487
 
670
488
    print
671
489
    print "You may modify the configuration at any time by editing"
673
491
    print jailconffile
674
492
    print conf_hfile
675
493
    print phpBBconffile
676
 
    print usrmgtserver_initdfile
677
494
    print
678
495
    
679
496
    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
""")