← Back to branch summary

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

« back to all changes in this revision

Viewing changes to bin/ivle-config

  • Committer: David Coles
  • Date: 2009-08-06 04:04:37 UTC
  • Revision ID: coles.david@gmail.com-20090806040437-a8k5jhkkf2ixud5a
Add a rather lenient RLIMIT_NPROC that will prevent simple fork bombs (hopefully accidental...) from taking down a server.

Show diffs side-by-side

added added

removed removed

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