← Back to branch summary

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

« back to all changes in this revision

Viewing changes to bin/ivle-config

ivle.chat now opens /dev/null as std{in,out,err} when daemonising.

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