← Back to branch summary

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

« back to all changes in this revision

Viewing changes to bin/ivle-config

  • Committer: William Grant
  • Date: 2010-07-27 12:09:13 UTC
  • mto: This revision was merged to the branch mainline in revision 1826.
  • Revision ID: grantw@unimelb.edu.au-20100727120913-v0kfnwxzbiwrjnue
(simple)json always returns a unicode when decoding, while cjson returned a str where possible. This makes cPickle unhappy, so convert back to a str.

Show diffs side-by-side

added added

removed removed

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