← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/configure.py

  • Committer: dcoles
  • Date: 2008-07-03 04:43:49 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:805
Setup: Now you can supply a --mirror or -m option to `./setup build` to specify 
which mirror to use to build the jail from. Default is still AARNET, but at 
least is can be changed.

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