← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/configure.py

  • Committer: me at id
  • Date: 2009-01-15 03:02:36 UTC
  • mto: This revision was merged to the branch mainline in revision 1090.
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:branches%2Fstorm:1150
ivle.makeuser.make_jail: Just take an ivle.database.User, rather than some
    attributes.

services/usrmgt-server: Give make_jail a User.

bin/ivle-remakeuser: Rewrite to use ivle.database.User.

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup/configure.py
1
 
#!/usr/bin/python
2
1
# IVLE - Informatics Virtual Learning Environment
3
 
# Copyright (C) 2007-2009 The University of Melbourne
 
2
# Copyright (C) 2007-2008 The University of Melbourne
4
3
#
5
4
# This program is free software; you can redistribute it and/or modify
6
5
# it under the terms of the GNU General Public License as published by
16
15
# along with this program; if not, write to the Free Software
17
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
17
 
 
18
# Module: setup/config
19
19
# Author: Matt Giuca, Refactored by David Coles
20
 
 
21
 
'''Configures IVLE with machine-specific details, most notably, various paths.
22
 
Either prompts the administrator for these details or accepts them as
23
 
command-line args.
24
 
 
25
 
Creates etc/ivle.conf
26
 
'''
 
20
# Date:   03/07/2008
 
21
 
 
22
# setup/config.py
 
23
# Configures IVLE with machine-specific details, most notably, various paths.
 
24
# Either prompts the administrator for these details or accepts them as
 
25
# command-line args.
 
26
# Creates lib/conf/conf.py and bin/trampoline/conf.h.
27
27
 
28
28
import optparse
29
29
import getopt
30
30
import os
31
31
import sys
32
 
import stat
33
32
import hashlib
34
33
import uuid
35
34
 
36
 
import ivle.config
37
 
 
38
 
import configobj
 
35
from setup.util import query_user
39
36
 
40
37
class ConfigOption:
41
38
    """A configuration option; one of the things written to conf.py."""
59
56
# Configuration options, defaults and descriptions
60
57
config_options = []
61
58
 
62
 
config_options.append(ConfigOption("urls/root", "/",
 
59
config_options.append(ConfigOption("root_dir", "/",
63
60
    """Root directory where IVLE is located (in URL space):""",
64
61
    """
65
62
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
66
63
# with this).
67
64
# eg. "/" or "/ivle".""", ask=False))
68
65
 
69
 
config_options.append(ConfigOption("paths/prefix", "/usr/local",
 
66
config_options.append(ConfigOption("prefix", "/usr/local",
70
67
    """In the local file system, the prefix to the system directory where IVLE
71
68
is installed. (This should either be /usr or /usr/local):""",
72
69
    """
75
72
# ('/usr/local' for the usual install, '/usr' for distribution packages)""",
76
73
    ask=False))
77
74
 
78
 
config_options.append(ConfigOption("paths/data",
 
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",
79
86
    "/var/lib/ivle",
80
87
    "In the local file system, where user-modifiable data files should be "
81
88
    "located:",
83
90
# In the local file system, where user-modifiable data files should be
84
91
# located.""", ask=False))
85
92
 
86
 
config_options.append(ConfigOption("paths/logs",
 
93
config_options.append(ConfigOption("log_path",
87
94
    "/var/log/ivle",
88
95
    """Directory where IVLE log files are stored (on the local
89
96
file system). Note - this must be writable by the user the IVLE server 
92
99
# In the local file system, where IVLE error logs should be located.""",
93
100
    ask=False))
94
101
 
95
 
config_options.append(ConfigOption("urls/public_host", "public.localhost",
 
102
config_options.append(ConfigOption("public_host", "public.localhost",
96
103
    """Hostname which will cause the server to go into "public mode",
97
104
providing login-free access to student's published work:""",
98
105
    """
103
110
# Private mode (normal mode) requires login, and only serves files relevant to
104
111
# the logged-in user."""))
105
112
 
106
 
config_options.append(ConfigOption("media/version", None,
107
 
    """Version of IVLE media resources (must change on each upgrade):""",
 
113
config_options.append(ConfigOption("allowed_uids", "33",
 
114
    """UID of the web server process which will run IVLE.
 
115
Only this user may execute the trampoline. May specify multiple users as
 
116
a comma-separated list.
 
117
    (eg. "1002,78")""",
108
118
    """
109
 
# Version string for IVLE media resource URLs. When set, they are aggressively
110
 
# cached by the browser, so it must be either left unset or changed each time
111
 
# a media file is changed.""", ask=False))
 
119
# The User-ID of the web server process which will run IVLE, and any other
 
120
# users who are allowed to run the trampoline. This is stores as a string of
 
121
# 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))
112
124
 
113
 
config_options.append(ConfigOption("database/host", "localhost",
 
125
config_options.append(ConfigOption("db_host", "localhost",
114
126
    """PostgreSQL Database config
115
127
==========================
116
128
Hostname of the DB server:""",
117
129
    """
 
130
### PostgreSQL Database config ###
118
131
# Database server hostname"""))
119
132
 
120
 
config_options.append(ConfigOption("database/port", "5432",
 
133
config_options.append(ConfigOption("db_port", "5432",
121
134
    """Port of the DB server:""",
122
135
    """
123
136
# Database server port"""))
124
137
 
125
 
config_options.append(ConfigOption("database/name", "ivle",
 
138
config_options.append(ConfigOption("db_dbname", "ivle",
126
139
    """Database name:""",
127
140
    """
128
141
# Database name"""))
129
142
 
130
 
config_options.append(ConfigOption("database/username", "postgres",
 
143
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
 
144
    """Forum Database name:""",
 
145
    """
 
146
# Forum Database name"""))
 
147
 
 
148
config_options.append(ConfigOption("db_user", "postgres",
131
149
    """Username for DB server login:""",
132
150
    """
133
151
# Database username"""))
134
152
 
135
 
config_options.append(ConfigOption("database/password", "",
 
153
config_options.append(ConfigOption("db_password", "",
136
154
    """Password for DB server login:
137
 
    (Caution: This password is stored in plaintext!)""",
 
155
    (Caution: This password is stored in plaintext in ivle/conf/conf.py)""",
138
156
    """
139
157
# Database password"""))
140
158
 
141
 
config_options.append(ConfigOption("auth/modules", "",
 
159
config_options.append(ConfigOption("auth_modules", "",
142
160
    """Authentication config
143
161
=====================
144
162
Comma-separated list of authentication modules.""",
152
170
# other modules may be plugged in to auth against organisation-specific
153
171
# auth backends.""", ask=False))
154
172
 
155
 
config_options.append(ConfigOption("auth/ldap_url", "ldaps://www.example.com",
 
173
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
156
174
    """(LDAP options are only relevant if "ldap" is included in the list of
157
175
auth modules).
158
176
URL for LDAP authentication server:""",
159
177
    """
160
178
# URL for LDAP authentication server""", ask=False))
161
179
 
162
 
config_options.append(ConfigOption("auth/ldap_format_string",
 
180
config_options.append(ConfigOption("ldap_format_string",
163
181
    "uid=%s,ou=users,o=example",
164
182
    """Format string for LDAP auth request:
165
183
    (Must contain a single "%s" for the user's login name)""",
167
185
# Format string for LDAP auth request
168
186
# (Must contain a single "%s" for the user's login name)""", ask=False))
169
187
 
170
 
config_options.append(ConfigOption("auth/subject_pulldown_modules", "",
 
188
config_options.append(ConfigOption("subject_pulldown_modules", "",
171
189
    """Comma-separated list of subject pulldown modules.
172
190
Add proprietary modules to automatically enrol students in subjects.""",
173
191
    """
177
195
# other modules may be plugged in to pulldown against organisation-specific
178
196
# pulldown backends.""", ask=False))
179
197
 
180
 
config_options.append(ConfigOption("urls/svn_addr", "http://svn.localhost/",
 
198
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
181
199
    """Subversion config
182
200
=================
183
201
The base url for accessing subversion repositories:""",
184
202
    """
185
203
# The base url for accessing subversion repositories."""))
186
204
 
187
 
config_options.append(ConfigOption("usrmgt/host", "localhost",
 
205
config_options.append(ConfigOption("usrmgt_host", "localhost",
188
206
    """User Management Server config
189
207
============================
190
208
The hostname where the usrmgt-server runs:""",
191
209
    """
192
210
# The hostname where the usrmgt-server runs."""))
193
211
 
194
 
config_options.append(ConfigOption("usrmgt/port", "2178",
 
212
config_options.append(ConfigOption("usrmgt_port", "2178",
195
213
    """The port where the usrmgt-server runs:""",
196
214
    """
197
215
# The port where the usrmgt-server runs.""", ask=False))
198
216
 
199
 
config_options.append(ConfigOption("usrmgt/magic", None,
 
217
config_options.append(ConfigOption("usrmgt_magic", None,
200
218
    """The password for the usrmgt-server:""",
201
219
    """
202
220
# The password for the usrmgt-server.""", ask=False))
203
221
 
204
 
def query_user(default, prompt):
205
 
    """Prompts the user for a string, which is read from a line of stdin.
206
 
    Exits silently if EOF is encountered. Returns the string, with spaces
207
 
    removed from the beginning and end.
208
 
 
209
 
    Returns default if a 0-length line (after spaces removed) was read.
210
 
    """
211
 
    if default is None:
212
 
        # A default of None means the value will be computed specially, so we
213
 
        # can't really tell you what it is
214
 
        defaultstr = "computed"
215
 
    elif isinstance(default, basestring):
216
 
        defaultstr = '"%s"' % default
217
 
    else:
218
 
        defaultstr = repr(default)
219
 
    sys.stdout.write('%s\n    (default: %s)\n>' % (prompt, defaultstr))
220
 
    try:
221
 
        val = sys.stdin.readline()
222
 
    except KeyboardInterrupt:
223
 
        # Ctrl+C
224
 
        sys.stdout.write("\n")
225
 
        sys.exit(1)
226
 
    sys.stdout.write("\n")
227
 
    # If EOF, exit
228
 
    if val == '': sys.exit(1)
229
 
    # If empty line, return default
230
 
    val = val.strip()
231
 
    if val == '': return default
232
 
    return val
233
 
 
234
222
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."""
 
226
 
 
227
    # Parse arguments
 
228
    parser = optparse.OptionParser(usage)
 
229
    (options, args) = parser.parse_args(args)
 
230
 
 
231
    # Call the real function
 
232
    return __configure(args)
 
233
 
 
234
def __configure(args):
 
235
    global db_port, usrmgt_port
 
236
 
235
237
    # Try importing existing conf, but if we can't just set up defaults
236
238
    # The reason for this is that these settings are used by other phases
237
239
    # of setup besides conf, so we need to know them.
238
240
    # Also this allows you to hit Return to accept the existing value.
239
241
    try:
240
 
        conf = ivle.config.Config()
241
 
    except ivle.config.ConfigError:
242
 
        # Couldn't find a config file anywhere.
243
 
        # Create a new blank config object (not yet bound to a file)
244
 
        # All lookups (below) will fail, so it will be initialised with all
245
 
        # the default values.
246
 
        conf = ivle.config.Config(blank=True)
247
 
 
248
 
    # Check that all the options are present, and if not, load the default
249
 
    for opt in config_options:
250
 
        try:
251
 
            conf.get_by_path(opt.option_name)
252
 
        except KeyError:
253
 
            # If the default is None, omit it
254
 
            # Else ConfigObj will write the string 'None' to the conf file
255
 
            if opt.default is not None:
256
 
                conf.set_by_path(opt.option_name, opt.default)
257
 
 
258
 
    # Store comments in the conf object
259
 
    for opt in config_options:
260
 
        # Omitted if the key doesn't exist
261
 
        conf.set_by_path(opt.option_name, comment=opt.comment)
 
242
        confmodule = __import__("ivle/conf/conf")
 
243
        for opt in config_options:
 
244
            try:
 
245
                globals()[opt.option_name] = \
 
246
                confmodule.__dict__[opt.option_name]
 
247
            except:
 
248
                globals()[opt.option_name] = opt.default
 
249
    except ImportError:
 
250
        # Just set reasonable defaults
 
251
        for opt in config_options:
 
252
            globals()[opt.option_name] = opt.default
262
253
 
263
254
    # Set up some variables
264
255
    cwd = os.getcwd()
265
256
 
266
257
    # the files that will be created/overwritten
267
 
    try:
268
 
        confdir = os.environ['IVLECONF']
269
 
    except KeyError:
270
 
        confdir = '/etc/ivle'
271
 
 
272
 
    conffile = os.path.join(confdir, 'ivle.conf')
273
 
    plugindefaultfile = os.path.join(confdir, 'plugins.d/000default.conf')
 
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")
 
261
    phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
274
262
 
275
263
    # Get command-line arguments to avoid asking questions.
276
264
 
286
274
    if opts == []:
287
275
        # Interactive mode. Prompt the user for all the values.
288
276
 
289
 
        print """This tool will create %s, prompting you for details about
290
 
your configuration. The file will be updated with modified options if it already
291
 
exists. If it does not already exist, it will be created with sane defaults and
292
 
restrictive permissions.
293
 
 
294
 
%s will also be overwritten with the default list of plugins.
 
277
        print """This tool will create the following files:
 
278
    %s
 
279
    %s
 
280
    %s
 
281
    %s
 
282
prompting you for details about your configuration. The file will be
 
283
overwritten if it already exists. It will *not* install or deploy IVLE.
295
284
 
296
285
Please hit Ctrl+C now if you do not wish to do this.
297
 
""" % (conffile, plugindefaultfile)
 
286
""" % (conffile, jailconffile, conf_hfile, phpBBconffile)
298
287
 
299
288
        # Get information from the administrator
300
289
        # If EOF is encountered at any time during the questioning, just exit
302
291
 
303
292
        for opt in config_options:
304
293
            if opt.ask:
305
 
                conf.set_by_path(opt.option_name,
306
 
                    query_user(conf.get_by_path(opt.option_name), opt.prompt))
 
294
                globals()[opt.option_name] = \
 
295
                    query_user(globals()[opt.option_name], opt.prompt)
307
296
    else:
308
297
        opts = dict(opts)
309
298
        # Non-interactive mode. Parse the options.
310
299
        for opt in config_options:
311
300
            if '--' + opt.option_name in opts:
312
 
                conf.set_by_path(opt.option_name,
313
 
                                 opts['--' + opt.option_name])
 
301
                globals()[opt.option_name] = opts['--' + opt.option_name]
314
302
 
315
303
    # Error handling on input values
316
304
    try:
317
 
        conf['database']['port'] = int(conf['database']['port'])
318
 
        if (conf['database']['port'] < 0
319
 
            or conf['database']['port'] >= 65536):
320
 
            raise ValueError()
321
 
    except ValueError:
322
 
        if conf['database']['port'] == '' or conf['database']['port'] is None:
323
 
            pass
324
 
        else:
325
 
            print >>sys.stderr, (
326
 
            "Invalid DB port (%s).\n"
327
 
            "Must be an integer between 0 and 65535." %
328
 
                repr(conf['database']['port']))
329
 
            return 1
330
 
    try:
331
 
        conf['usrmgt']['port'] = int(conf['usrmgt']['port'])
332
 
        if (conf['usrmgt']['port'] < 0 or conf['usrmgt']['port'] >= 65536):
333
 
            raise ValueError()
 
305
        allowed_uids_list = map(int, allowed_uids.split(','))
 
306
    except ValueError:
 
307
        print >>sys.stderr, (
 
308
        "Invalid UID list (%s).\n"
 
309
        "Must be a comma-separated list of integers." % allowed_uids)
 
310
        return 1
 
311
    try:
 
312
        db_port = int(db_port)
 
313
        if db_port < 0 or db_port >= 65536: raise ValueError()
 
314
    except ValueError:
 
315
        print >>sys.stderr, (
 
316
        "Invalid DB port (%s).\n"
 
317
        "Must be an integer between 0 and 65535." % repr(db_port))
 
318
        return 1
 
319
    try:
 
320
        usrmgt_port = int(usrmgt_port)
 
321
        if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
334
322
    except ValueError:
335
323
        print >>sys.stderr, (
336
324
        "Invalid user management port (%s).\n"
337
 
        "Must be an integer between 0 and 65535." %
338
 
            repr(conf['usrmgt']['port']))
 
325
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
339
326
        return 1
340
327
 
341
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
    # Generate the forum secret
 
333
    forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
334
 
 
335
    # Write lib/conf/conf.py
 
336
 
342
337
    try:
343
 
        conf['usrmgt']['magic']     # Throw away; just check for KeyError
344
 
    except KeyError:
345
 
        conf['usrmgt']['magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
346
 
 
347
 
    clobber_permissions = not os.path.exists(conffile)
348
 
 
349
 
    # Write ./etc/ivle.conf (even if we loaded from a different filename)
350
 
    conf.filename = conffile
351
 
    conf.initial_comment = ["# IVLE Configuration File"]
352
 
    conf.write()
353
 
 
354
 
    # We need to restrict permissions on a new file, as it contains
355
 
    # a nice database password.
356
 
    if clobber_permissions:
357
 
        os.chown(conffile, 33, 33) # chown to www-data
358
 
        os.chmod(conffile, stat.S_IRUSR | stat.S_IWUSR) # No g/o perms!
 
338
        conf = open(conffile, "w")
 
339
 
 
340
        conf.write("""# IVLE Configuration File
 
341
# conf.py
 
342
# Miscellaneous application settings
 
343
 
 
344
import os
 
345
import sys
 
346
""")
 
347
        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)
 
355
 
 
356
        conf.close()
 
357
    except IOError, (errno, strerror):
 
358
        print "IO error(%s): %s" % (errno, strerror)
 
359
        sys.exit(1)
359
360
 
360
361
    print "Successfully wrote %s" % conffile
361
362
 
362
 
    plugindefault = open(plugindefaultfile, 'w')
363
 
    plugindefault.write("""# IVLE default plugin configuration file
364
 
[ivle.webapp.core#Plugin]
365
 
[ivle.webapp.admin.user#Plugin]
366
 
[ivle.webapp.tutorial#Plugin]
367
 
[ivle.webapp.admin.subject#Plugin]
368
 
[ivle.webapp.filesystem.browser#Plugin]
369
 
[ivle.webapp.filesystem.diff#Plugin]
370
 
[ivle.webapp.filesystem.svnlog#Plugin]
371
 
[ivle.webapp.filesystem.serve#Plugin]
372
 
[ivle.webapp.groups#Plugin]
373
 
[ivle.webapp.console#Plugin]
374
 
[ivle.webapp.security#Plugin]
375
 
[ivle.webapp.media#Plugin]
376
 
[ivle.webapp.help#Plugin]
377
 
[ivle.webapp.tos#Plugin]
378
 
[ivle.webapp.userservice#Plugin]
379
 
[ivle.webapp.fileservice#Plugin]
380
 
[ivle.webapp.submit#Plugin]
381
 
""")
382
 
    plugindefault.close()
383
 
    print "Successfully wrote %s" % plugindefaultfile
384
 
 
385
 
    print
386
 
    print "You may modify the configuration at any time by editing " + conffile
 
363
    # Write conf/jailconf.py
 
364
 
 
365
    try:
 
366
        conf = open(jailconffile, "w")
 
367
 
 
368
        # In the "in-jail" version of conf, we don't need MOST of the details
 
369
        # (it would be a security risk to have them here).
 
370
        # So we just write root_dir, and jail_base is "/".
 
371
        # (jail_base being "/" means "jail-relative" paths are relative to "/"
 
372
        # when inside the jail.)
 
373
        conf.write("""# IVLE Configuration File
 
374
# conf.py
 
375
# Miscellaneous application settings
 
376
# (User jail version)
 
377
 
 
378
 
 
379
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
 
380
# with this).
 
381
# eg. "/" or "/ivle".
 
382
root_dir = %s
 
383
 
 
384
# In the local file system, where are the student/user file spaces located.
 
385
# The user jails are expected to be located immediately in subdirectories of
 
386
# this location.
 
387
jail_base = '/'
 
388
 
 
389
# The hostname for serving publicly accessible pages
 
390
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)))
 
395
 
 
396
        conf.close()
 
397
    except IOError, (errno, strerror):
 
398
        print "IO error(%s): %s" % (errno, strerror)
 
399
        sys.exit(1)
 
400
 
 
401
    print "Successfully wrote %s" % jailconffile
 
402
 
 
403
    # Write bin/trampoline/conf.h
 
404
 
 
405
    try:
 
406
        conf = open(conf_hfile, "w")
 
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
 
 
415
        conf.write("""/* IVLE Configuration File
 
416
 * conf.h
 
417
 * Administrator settings required by trampoline.
 
418
 * Note: trampoline will have to be rebuilt in order for changes to this file
 
419
 * to take effect.
 
420
 */
 
421
 
 
422
#define IVLE_AUFS_JAILS
 
423
 
 
424
/* In the local file system, where are the jails located.
 
425
 * The trampoline does not allow the creation of a jail anywhere besides
 
426
 * jail_base or a subdirectory of jail_base.
 
427
 */
 
428
static const char* jail_base = "%s";
 
429
static const char* jail_src_base = "%s";
 
430
static const char* jail_system = "%s";
 
431
 
 
432
/* Which user IDs are allowed to run the trampoline.
 
433
 * This list should be limited to the web server user.
 
434
 * (Note that root is an implicit member of this list).
 
435
 */
 
436
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]))
 
439
    # Note: The above uses PYTHON reprs, not C reprs
 
440
    # However they should be the same with the exception of the outer
 
441
    # characters, which are stripped off and replaced
 
442
 
 
443
        conf.close()
 
444
    except IOError, (errno, strerror):
 
445
        print "IO error(%s): %s" % (errno, strerror)
 
446
        sys.exit(1)
 
447
 
 
448
    print "Successfully wrote %s" % conf_hfile
 
449
 
 
450
    # Write www/php/phpBB3/config.php
 
451
 
 
452
    try:
 
453
        conf = open(phpBBconffile, "w")
 
454
        
 
455
        # php-pg work around
 
456
        if db_host == 'localhost':
 
457
            forumdb_host = '127.0.0.1'
 
458
        else:
 
459
            forumdb_host = db_host
 
460
 
 
461
        conf.write( """<?php
 
462
// phpBB 3.0.x auto-generated configuration file
 
463
// Do not change anything in this file!
 
464
$dbms = 'postgres';
 
465
$dbhost = '""" + forumdb_host + """';
 
466
$dbport = '""" + str(db_port) + """';
 
467
$dbname = '""" + db_forumdbname + """';
 
468
$dbuser = '""" + db_user + """';
 
469
$dbpasswd = '""" + db_password + """';
 
470
 
 
471
$table_prefix = 'phpbb_';
 
472
$acm_type = 'file';
 
473
$load_extensions = '';
 
474
@define('PHPBB_INSTALLED', true);
 
475
// @define('DEBUG', true);
 
476
//@define('DEBUG_EXTRA', true);
 
477
 
 
478
$forum_secret = '""" + forum_secret +"""';
 
479
?>"""   )
 
480
    
 
481
        conf.close()
 
482
    except IOError, (errno, strerror):
 
483
        print "IO error(%s): %s" % (errno, strerror)
 
484
        sys.exit(1)
 
485
 
 
486
    print "Successfully wrote %s" % phpBBconffile
 
487
 
 
488
    print
 
489
    print "You may modify the configuration at any time by editing"
 
490
    print conffile
 
491
    print jailconffile
 
492
    print conf_hfile
 
493
    print phpBBconffile
 
494
    print
387
495
    
388
496
    return 0
389
497
 
390
 
def main(argv=None):
391
 
    if argv is None:
392
 
        argv = sys.argv
393
 
 
394
 
    # Print the opening spiel including the GPL notice
395
 
 
396
 
    print """IVLE - Informatics Virtual Learning Environment Setup
397
 
Copyright (C) 2007-2009 The University of Melbourne
398
 
IVLE comes with ABSOLUTELY NO WARRANTY.
399
 
This is free software, and you are welcome to redistribute it
400
 
under certain conditions. See LICENSE.txt for details.
401
 
 
402
 
IVLE Configuration
403
 
"""
404
 
 
405
 
    return configure(argv[1:])
406
 
 
407
 
if __name__ == "__main__":
408
 
    sys.exit(main())
 
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
""")