← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/configure.py

  • Committer: wagrant
  • Date: 2008-07-14 04:39:11 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:862
browser: Refactor the client-side actions1 processing! Kill off 100 lines
         of a 150 line block by creating a function to enable or disable
         an arbitrary option.

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