← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/configure.py

ivle.webapp.base.views#XHTMLView: Set the content type to text/html.
ivle.webapp.browser#BrowserView: Don't set the content type.
ivle.webapp.groups#GroupsView: Clean up, and don't set the content type. 

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
 
122
93
config_options.append(ConfigOption("log_path",
123
 
    "/home/informatics/logs/",
 
94
    "/var/log/ivle",
124
95
    """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).:""",
 
96
file system). Note - this must be writable by the user the IVLE server 
 
97
process runs as (usually www-data):""",
127
98
    """
128
 
# In the local file system, where is the Terms of Service document located."""))
 
99
# In the local file system, where IVLE error logs should be located.""",
 
100
    ask=False))
 
101
 
129
102
config_options.append(ConfigOption("public_host", "public.localhost",
130
103
    """Hostname which will cause the server to go into "public mode",
131
104
providing login-free access to student's published work:""",
136
109
# Public mode does not use cookies, and serves only public content.
137
110
# Private mode (normal mode) requires login, and only serves files relevant to
138
111
# the logged-in user."""))
 
112
 
139
113
config_options.append(ConfigOption("allowed_uids", "33",
140
114
    """UID of the web server process which will run IVLE.
141
115
Only this user may execute the trampoline. May specify multiple users as
145
119
# The User-ID of the web server process which will run IVLE, and any other
146
120
# users who are allowed to run the trampoline. This is stores as a string of
147
121
# 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)."""))
 
122
# used by the setup program to write to conf.h (see setup.py config).""",
 
123
    ask=False))
 
124
 
149
125
config_options.append(ConfigOption("db_host", "localhost",
150
126
    """PostgreSQL Database config
151
127
==========================
153
129
    """
154
130
### PostgreSQL Database config ###
155
131
# Database server hostname"""))
 
132
 
156
133
config_options.append(ConfigOption("db_port", "5432",
157
134
    """Port of the DB server:""",
158
135
    """
159
136
# Database server port"""))
 
137
 
160
138
config_options.append(ConfigOption("db_dbname", "ivle",
161
139
    """Database name:""",
162
140
    """
163
141
# Database name"""))
 
142
 
164
143
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
165
144
    """Forum Database name:""",
166
145
    """
167
146
# Forum Database name"""))
 
147
 
168
148
config_options.append(ConfigOption("db_user", "postgres",
169
149
    """Username for DB server login:""",
170
150
    """
171
151
# Database username"""))
 
152
 
172
153
config_options.append(ConfigOption("db_password", "",
173
154
    """Password for DB server login:
174
 
    (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)""",
175
156
    """
176
157
# Database password"""))
177
 
config_options.append(ConfigOption("auth_modules", "ldap_auth",
 
158
 
 
159
config_options.append(ConfigOption("auth_modules", "",
178
160
    """Authentication config
179
161
=====================
180
 
Comma-separated list of authentication modules. Only "ldap" is available
181
 
by default.""",
 
162
Comma-separated list of authentication modules.""",
182
163
    """
183
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.
184
168
# These refer to importable Python modules in the www/auth directory.
185
 
# Modules "ldap" and "guest" are available in the source tree, but
 
169
# Modules "ldap_auth" and "guest" are available in the source tree, but
186
170
# other modules may be plugged in to auth against organisation-specific
187
 
# auth backends."""))
 
171
# auth backends.""", ask=False))
 
172
 
188
173
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
189
174
    """(LDAP options are only relevant if "ldap" is included in the list of
190
175
auth modules).
191
176
URL for LDAP authentication server:""",
192
177
    """
193
 
# URL for LDAP authentication server"""))
 
178
# URL for LDAP authentication server""", ask=False))
 
179
 
194
180
config_options.append(ConfigOption("ldap_format_string",
195
181
    "uid=%s,ou=users,o=example",
196
182
    """Format string for LDAP auth request:
197
183
    (Must contain a single "%s" for the user's login name)""",
198
184
    """
199
185
# Format string for LDAP auth request
200
 
# (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
 
201
188
config_options.append(ConfigOption("subject_pulldown_modules", "",
202
189
    """Comma-separated list of subject pulldown modules.
203
190
Add proprietary modules to automatically enrol students in subjects.""",
206
193
# These refer to importable Python modules in the lib/pulldown_subj directory.
207
194
# Only "dummy_subj" is available in the source tree (an example), but
208
195
# other modules may be plugged in to pulldown against organisation-specific
209
 
# pulldown backends."""))
 
196
# pulldown backends.""", ask=False))
 
197
 
210
198
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
211
199
    """Subversion config
212
200
=================
213
201
The base url for accessing subversion repositories:""",
214
202
    """
215
203
# 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:""",
219
 
    """
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:""",
224
 
    """
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:""",
229
 
    """
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:""",
235
 
    """
236
 
# The location of the password file used to authenticate local users
237
 
# of the subversion repository."""))
 
204
 
238
205
config_options.append(ConfigOption("usrmgt_host", "localhost",
239
206
    """User Management Server config
240
207
============================
241
208
The hostname where the usrmgt-server runs:""",
242
209
    """
243
210
# The hostname where the usrmgt-server runs."""))
 
211
 
244
212
config_options.append(ConfigOption("usrmgt_port", "2178",
245
213
    """The port where the usrmgt-server runs:""",
246
214
    """
247
 
# The port where the usrmgt-server runs."""))
248
 
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,
249
218
    """The password for the usrmgt-server:""",
250
219
    """
251
 
# The password for the usrmgt-server."""))
 
220
# The password for the usrmgt-server.""", ask=False))
252
221
 
253
222
def configure(args):
254
 
    usage = """usage: %prog build [options]
255
 
(requires root)
256
 
Compiles all files and sets up a jail template in the source directory.
257
 
-O is recommended to cause compilation to be optimised.
258
 
Details:
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."""
 
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."""
265
226
 
266
227
    # Parse arguments
267
228
    parser = optparse.OptionParser(usage)
268
229
    (options, args) = parser.parse_args(args)
269
230
 
270
231
    # Call the real function
271
 
    __configure(args)
 
232
    return __configure(args)
272
233
 
273
234
def __configure(args):
274
235
    global db_port, usrmgt_port
278
239
    # of setup besides conf, so we need to know them.
279
240
    # Also this allows you to hit Return to accept the existing value.
280
241
    try:
281
 
        confmodule = __import__("lib/conf/conf")
 
242
        confmodule = __import__("ivle/conf/conf")
282
243
        for opt in config_options:
283
244
            try:
284
245
                globals()[opt.option_name] = \
294
255
    cwd = os.getcwd()
295
256
 
296
257
    # 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")
 
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")
300
261
    phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
301
 
    usrmgtserver_initdfile = os.path.join(cwd, "doc/setup/usrmgt-server.init")
302
262
 
303
263
    # Get command-line arguments to avoid asking questions.
304
264
 
319
279
    %s
320
280
    %s
321
281
    %s
322
 
    %s
323
282
prompting you for details about your configuration. The file will be
324
283
overwritten if it already exists. It will *not* install or deploy IVLE.
325
284
 
326
285
Please hit Ctrl+C now if you do not wish to do this.
327
 
""" % (conffile, jailconffile, conf_hfile, phpBBconffile, usrmgtserver_initdfile)
 
286
""" % (conffile, jailconffile, conf_hfile, phpBBconffile)
328
287
 
329
288
        # Get information from the administrator
330
289
        # If EOF is encountered at any time during the questioning, just exit
331
290
        # silently
332
291
 
333
292
        for opt in config_options:
334
 
            globals()[opt.option_name] = \
335
 
                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)
336
296
    else:
337
297
        opts = dict(opts)
338
298
        # Non-interactive mode. Parse the options.
365
325
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
366
326
        return 1
367
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
 
368
332
    # Generate the forum secret
369
333
    forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
370
334
 
377
341
# conf.py
378
342
# Miscellaneous application settings
379
343
 
 
344
import os
 
345
import sys
380
346
""")
381
347
        for opt in config_options:
382
 
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
383
 
                repr(globals()[opt.option_name])))
384
 
 
385
 
        # Add the forum secret to the config file (regenerated each config)
386
 
        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)
387
355
 
388
356
        conf.close()
389
357
    except IOError, (errno, strerror):
390
358
        print "IO error(%s): %s" % (errno, strerror)
391
359
        sys.exit(1)
392
360
 
393
 
    print "Successfully wrote lib/conf/conf.py"
 
361
    print "Successfully wrote %s" % conffile
394
362
 
395
363
    # Write conf/jailconf.py
396
364
 
420
388
 
421
389
# The hostname for serving publicly accessible pages
422
390
public_host = %s
423
 
""" % (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)))
424
395
 
425
396
        conf.close()
426
397
    except IOError, (errno, strerror):
427
398
        print "IO error(%s): %s" % (errno, strerror)
428
399
        sys.exit(1)
429
400
 
430
 
    print "Successfully wrote lib/conf/jailconf.py"
 
401
    print "Successfully wrote %s" % jailconffile
431
402
 
432
 
    # Write trampoline/conf.h
 
403
    # Write bin/trampoline/conf.h
433
404
 
434
405
    try:
435
406
        conf = open(conf_hfile, "w")
436
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
 
437
415
        conf.write("""/* IVLE Configuration File
438
416
 * conf.h
439
417
 * Administrator settings required by trampoline.
467
445
        print "IO error(%s): %s" % (errno, strerror)
468
446
        sys.exit(1)
469
447
 
470
 
    print "Successfully wrote trampoline/conf.h"
 
448
    print "Successfully wrote %s" % conf_hfile
471
449
 
472
450
    # Write www/php/phpBB3/config.php
473
451
 
505
483
        print "IO error(%s): %s" % (errno, strerror)
506
484
        sys.exit(1)
507
485
 
508
 
    print "Successfully wrote www/php/phpBB3/config.php"
509
 
 
510
 
    # Write lib/conf/usrmgt-server.init
511
 
 
512
 
    try:
513
 
        conf = open(usrmgtserver_initdfile, "w")
514
 
 
515
 
        conf.write( '''#! /bin/sh
516
 
 
517
 
# Works for Ubuntu. Check before using on other distributions
518
 
 
519
 
### BEGIN INIT INFO
520
 
# Provides:          usrmgt-server
521
 
# Required-Start:    $syslog $networking $urandom
522
 
# Required-Stop:     $syslog
523
 
# Default-Start:     2 3 4 5
524
 
# Default-Stop:      1
525
 
# Short-Description: IVLE user management server
526
 
# Description:       Daemon connecting to the IVLE user management database.
527
 
### END INIT INFO
528
 
 
529
 
PATH=/sbin:/bin:/usr/sbin:/usr/bin
530
 
DESC="IVLE user management server"
531
 
NAME=usrmgt-server
532
 
DAEMON=/opt/ivle/scripts/$NAME
533
 
DAEMON_ARGS="''' + str(usrmgt_port) + ''' ''' + usrmgt_magic + '''"
534
 
PIDFILE=/var/run/$NAME.pid
535
 
SCRIPTNAME=/etc/init.d/usrmgt-server
536
 
 
537
 
# Exit if the daemon does not exist 
538
 
test -f $DAEMON || exit 0
539
 
 
540
 
# Load the VERBOSE setting and other rcS variables
541
 
[ -f /etc/default/rcS ] && . /etc/default/rcS
542
 
 
543
 
# Define LSB log_* functions.
544
 
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
545
 
. /lib/lsb/init-functions
546
 
 
547
 
#
548
 
# Function that starts the daemon/service
549
 
#
550
 
do_start()
551
 
{
552
 
        # Return
553
 
        #   0 if daemon has been started
554
 
        #   1 if daemon was already running
555
 
        #   2 if daemon could not be started
556
 
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
557
 
                || return 1
558
 
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
559
 
                $DAEMON_ARGS \
560
 
                || return 2
561
 
        # Add code here, if necessary, that waits for the process to be ready
562
 
        # to handle requests from services started subsequently which depend
563
 
        # on this one.  As a last resort, sleep for some time.
564
 
}
565
 
 
566
 
#
567
 
# Function that stops the daemon/service
568
 
#
569
 
do_stop()
570
 
{
571
 
        # Return
572
 
        #   0 if daemon has been stopped
573
 
        #   1 if daemon was already stopped
574
 
        #   2 if daemon could not be stopped
575
 
        #   other if a failure occurred
576
 
        start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
577
 
        RETVAL="$?"
578
 
        [ "$RETVAL" = 2 ] && return 2
579
 
        # Wait for children to finish too if this is a daemon that forks
580
 
        # and if the daemon is only ever run from this initscript.
581
 
        # If the above conditions are not satisfied then add some other code
582
 
        # that waits for the process to drop all resources that could be
583
 
        # needed by services started subsequently.  A last resort is to
584
 
        # sleep for some time.
585
 
        start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
586
 
        [ "$?" = 2 ] && return 2
587
 
        # Many daemons don't delete their pidfiles when they exit.
588
 
        rm -f $PIDFILE
589
 
        return "$RETVAL"
590
 
}
591
 
 
592
 
#
593
 
# Function that sends a SIGHUP to the daemon/service
594
 
#
595
 
do_reload() {
596
 
        #
597
 
        # If the daemon can reload its configuration without
598
 
        # restarting (for example, when it is sent a SIGHUP),
599
 
        # then implement that here.
600
 
        #
601
 
        start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
602
 
        return 0
603
 
}
604
 
 
605
 
case "$1" in
606
 
  start)
607
 
    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
608
 
        do_start
609
 
        case "$?" in
610
 
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
611
 
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
612
 
        esac
613
 
        ;;
614
 
  stop)
615
 
        [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
616
 
        do_stop
617
 
        case "$?" in
618
 
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
619
 
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
620
 
        esac
621
 
        ;;
622
 
  #reload|force-reload)
623
 
        #
624
 
        # If do_reload() is not implemented then leave this commented out
625
 
        # and leave 'force-reload' as an alias for 'restart'.
626
 
        #
627
 
        #log_daemon_msg "Reloading $DESC" "$NAME"
628
 
        #do_reload
629
 
        #log_end_msg $?
630
 
        #;;
631
 
  restart|force-reload)
632
 
        #
633
 
        # If the "reload" option is implemented then remove the
634
 
        # 'force-reload' alias
635
 
        #
636
 
        log_daemon_msg "Restarting $DESC" "$NAME"
637
 
        do_stop
638
 
        case "$?" in
639
 
          0|1)
640
 
                do_start
641
 
                case "$?" in
642
 
                        0) log_end_msg 0 ;;
643
 
                        1) log_end_msg 1 ;; # Old process is still running
644
 
                        *) log_end_msg 1 ;; # Failed to start
645
 
                esac
646
 
                ;;
647
 
          *)
648
 
                # Failed to stop
649
 
                log_end_msg 1
650
 
                ;;
651
 
        esac
652
 
        ;;
653
 
  *)
654
 
        #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
655
 
        echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
656
 
        exit 3
657
 
        ;;
658
 
esac
659
 
 
660
 
:
661
 
''')
662
 
        
663
 
        conf.close()
664
 
    except IOError, (errno, strerror):
665
 
        print "IO error(%s): %s" % (errno, strerror)
666
 
        sys.exit(1)
667
 
 
668
 
    # fix permissions as the file contains the database password
669
 
    try:
670
 
        os.chmod('doc/setup/usrmgt-server.init', 0600)
671
 
    except OSError, (errno, strerror):
672
 
        print "WARNING: Couldn't chmod doc/setup/usrmgt-server.init:"
673
 
        print "OS error(%s): %s" % (errno, strerror)
674
 
 
675
 
    print "Successfully wrote lib/conf/usrmgt-server.init"
 
486
    print "Successfully wrote %s" % phpBBconffile
676
487
 
677
488
    print
678
489
    print "You may modify the configuration at any time by editing"
680
491
    print jailconffile
681
492
    print conf_hfile
682
493
    print phpBBconffile
683
 
    print usrmgtserver_initdfile
684
494
    print
685
495
    
686
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
""")