← Back to branch summary

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

« back to all changes in this revision

Viewing changes to bin/ivle-config

  • Committer: Matt Giuca
  • Date: 2010-07-20 09:42:45 UTC
  • Revision ID: matt.giuca@gmail.com-20100720094245-0poipwrxm9tde8et
TextView: Removed constructor (it just called its superclass ctor).

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