← Back to branch summary

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

« back to all changes in this revision

Viewing changes to bin/ivle-config

ivle-buildjail now only copies the system's IVLE files if jail/devmode
is True. It defaults to False.

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