1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Module: setup/config
19
# Author: Matt Giuca, Refactored by David Coles
22
'''Configures IVLE with machine-specific details, most notably, various paths.
23
Either prompts the administrator for these details or accepts them as
26
Creates ivle/conf/conf.py and bin/trampoline/trampoline/conf.h.
36
from setup.util import query_user
40
# This dict maps legacy config option names to new config option paths
41
# ('section/option_name')
42
# NOTE: This is copied from ivle/conf/conf.py (because neither of these files
43
# can see each other).
45
'root_dir': 'urls/root',
46
'prefix': 'paths/prefix',
47
'data_path': 'paths/data',
48
'log_path': 'paths/logs',
49
'python_site_packages_override': 'paths/site_packages',
50
'public_host': 'urls/public_host',
51
'allowed_uids': 'os/allowed_uids',
52
'db_host': 'database/host',
53
'db_port': 'database/port',
54
'db_dbname': 'database/name',
55
'db_forumdbname': 'plugins/forum/dbname',
56
'db_user': 'database/username',
57
'db_password': 'database/password',
58
'auth_modules': 'auth/modules',
59
'ldap_url': 'auth/ldap_url',
60
'ldap_format_string': 'auth/ldap_format_string',
61
'subject_pulldown_modules': 'auth/subject_pulldown_modules',
62
'svn_addr': 'urls/svn_addr',
63
'usrmgt_host': 'usrmgt/host',
64
'usrmgt_port': 'usrmgt/port',
65
'usrmgt_magic': 'usrmgt/magic',
66
'forum_secret': 'plugins/forum/secret',
70
"""A configuration option; one of the things written to conf.py."""
71
def __init__(self, option_name, default, prompt, comment, ask=True):
72
"""Creates a configuration option.
73
option_name: Name of the variable in conf.py. Also name of the
74
command-line argument to setup.py conf.
75
default: Default value for this variable.
76
prompt: (Short) string presented during the interactive prompt in
78
comment: (Long) comment string stored in conf.py. Each line of this
79
string should begin with a '#'.
80
ask: Whether to ask the question in the default config run.
82
self.option_name = option_name
83
self.default = default
85
self.comment = comment
88
# Configuration options, defaults and descriptions
91
config_options.append(ConfigOption("root_dir", "/",
92
"""Root directory where IVLE is located (in URL space):""",
94
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
96
# eg. "/" or "/ivle".""", ask=False))
98
config_options.append(ConfigOption("prefix", "/usr/local",
99
"""In the local file system, the prefix to the system directory where IVLE
100
is installed. (This should either be /usr or /usr/local):""",
102
# In the local file system, the prefix to the system directory where IVLE is
103
# installed. This should either be '/usr' or '/usr/local'.
104
# ('/usr/local' for the usual install, '/usr' for distribution packages)""",
107
config_options.append(ConfigOption("python_site_packages_override",
109
"""site-packages directory in Python, where Python libraries are to be
110
installed. May be left as the default, in which case the value will be
111
computed from prefix and the current Python version:""",
113
# 'site-packages' directory in Python, where Python libraries are to be
114
# installed. May be None (recommended), in which case the value will be
115
# computed from prefix and the current Python version.""", ask=False))
117
config_options.append(ConfigOption("data_path",
119
"In the local file system, where user-modifiable data files should be "
122
# In the local file system, where user-modifiable data files should be
123
# located.""", ask=False))
125
config_options.append(ConfigOption("log_path",
127
"""Directory where IVLE log files are stored (on the local
128
file system). Note - this must be writable by the user the IVLE server
129
process runs as (usually www-data):""",
131
# In the local file system, where IVLE error logs should be located.""",
134
config_options.append(ConfigOption("public_host", "public.localhost",
135
"""Hostname which will cause the server to go into "public mode",
136
providing login-free access to student's published work:""",
138
# The server goes into "public mode" if the browser sends a request with this
139
# host. This is for security reasons - we only serve public student files on a
140
# separate domain to the main IVLE site.
141
# Public mode does not use cookies, and serves only public content.
142
# Private mode (normal mode) requires login, and only serves files relevant to
143
# the logged-in user."""))
145
config_options.append(ConfigOption("allowed_uids", "33",
146
"""UID of the web server process which will run IVLE.
147
Only this user may execute the trampoline. May specify multiple users as
148
a comma-separated list.
151
# The User-ID of the web server process which will run IVLE, and any other
152
# users who are allowed to run the trampoline. This is stores as a string of
153
# comma-separated integers, simply because it is not used within Python, only
154
# used by the setup program to write to conf.h (see setup.py config).""",
157
config_options.append(ConfigOption("db_host", "localhost",
158
"""PostgreSQL Database config
159
==========================
160
Hostname of the DB server:""",
162
### PostgreSQL Database config ###
163
# Database server hostname"""))
165
config_options.append(ConfigOption("db_port", "5432",
166
"""Port of the DB server:""",
168
# Database server port"""))
170
config_options.append(ConfigOption("db_dbname", "ivle",
171
"""Database name:""",
175
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
176
"""Forum Database name:""",
178
# Forum Database name"""))
180
config_options.append(ConfigOption("db_user", "postgres",
181
"""Username for DB server login:""",
183
# Database username"""))
185
config_options.append(ConfigOption("db_password", "",
186
"""Password for DB server login:
187
(Caution: This password is stored in plaintext in ivle/conf/conf.py)""",
189
# Database password"""))
191
config_options.append(ConfigOption("auth_modules", "",
192
"""Authentication config
193
=====================
194
Comma-separated list of authentication modules.""",
196
# Comma-separated list of authentication modules.
197
# Note that auth is always enabled against the local database, and NO OTHER
198
# auth is enabled by default. This section is for specifying additional auth
200
# These refer to importable Python modules in the www/auth directory.
201
# Modules "ldap_auth" and "guest" are available in the source tree, but
202
# other modules may be plugged in to auth against organisation-specific
203
# auth backends.""", ask=False))
205
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
206
"""(LDAP options are only relevant if "ldap" is included in the list of
208
URL for LDAP authentication server:""",
210
# URL for LDAP authentication server""", ask=False))
212
config_options.append(ConfigOption("ldap_format_string",
213
"uid=%s,ou=users,o=example",
214
"""Format string for LDAP auth request:
215
(Must contain a single "%s" for the user's login name)""",
217
# Format string for LDAP auth request
218
# (Must contain a single "%s" for the user's login name)""", ask=False))
220
config_options.append(ConfigOption("subject_pulldown_modules", "",
221
"""Comma-separated list of subject pulldown modules.
222
Add proprietary modules to automatically enrol students in subjects.""",
224
# Comma-separated list of subject pulldown modules.
225
# These refer to importable Python modules in the lib/pulldown_subj directory.
226
# Only "dummy_subj" is available in the source tree (an example), but
227
# other modules may be plugged in to pulldown against organisation-specific
228
# pulldown backends.""", ask=False))
230
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
233
The base url for accessing subversion repositories:""",
235
# The base url for accessing subversion repositories."""))
237
config_options.append(ConfigOption("usrmgt_host", "localhost",
238
"""User Management Server config
239
============================
240
The hostname where the usrmgt-server runs:""",
242
# The hostname where the usrmgt-server runs."""))
244
config_options.append(ConfigOption("usrmgt_port", "2178",
245
"""The port where the usrmgt-server runs:""",
247
# The port where the usrmgt-server runs.""", ask=False))
249
config_options.append(ConfigOption("usrmgt_magic", None,
250
"""The password for the usrmgt-server:""",
252
# The password for the usrmgt-server.""", ask=False))
255
# Call the real function
256
return __configure(args)
258
def __configure(args):
259
global db_port, usrmgt_port
261
# Try importing existing conf, but if we can't just set up defaults
262
# The reason for this is that these settings are used by other phases
263
# of setup besides conf, so we need to know them.
264
# Also this allows you to hit Return to accept the existing value.
266
confmodule = __import__("ivle/conf/conf")
267
for opt in config_options:
269
globals()[opt.option_name] = \
270
confmodule.__dict__[opt.option_name]
272
globals()[opt.option_name] = opt.default
274
# Just set reasonable defaults
275
for opt in config_options:
276
globals()[opt.option_name] = opt.default
278
# Set up some variables
281
# the files that will be created/overwritten
282
conffile = os.path.join(cwd, "etc/ivle.conf")
283
conf_hfile = os.path.join(cwd, "bin/trampoline/conf.h")
284
phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
286
# Get command-line arguments to avoid asking questions.
289
for opt in config_options:
290
optnames.append(opt.option_name + "=")
291
(opts, args) = getopt.gnu_getopt(args, "", optnames)
294
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
298
# Interactive mode. Prompt the user for all the values.
300
print """This tool will create the following files:
304
prompting you for details about your configuration. The file will be
305
overwritten if it already exists. It will *not* install or deploy IVLE.
307
Please hit Ctrl+C now if you do not wish to do this.
308
""" % (conffile, conf_hfile, phpBBconffile)
310
# Get information from the administrator
311
# If EOF is encountered at any time during the questioning, just exit
314
for opt in config_options:
316
globals()[opt.option_name] = \
317
query_user(globals()[opt.option_name], opt.prompt)
320
# Non-interactive mode. Parse the options.
321
for opt in config_options:
322
if '--' + opt.option_name in opts:
323
globals()[opt.option_name] = opts['--' + opt.option_name]
325
# Error handling on input values
327
allowed_uids_list = map(int, allowed_uids.split(','))
329
print >>sys.stderr, (
330
"Invalid UID list (%s).\n"
331
"Must be a comma-separated list of integers." % allowed_uids)
334
db_port = int(db_port)
335
if db_port < 0 or db_port >= 65536: raise ValueError()
337
print >>sys.stderr, (
338
"Invalid DB port (%s).\n"
339
"Must be an integer between 0 and 65535." % repr(db_port))
342
usrmgt_port = int(usrmgt_port)
343
if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
345
print >>sys.stderr, (
346
"Invalid user management port (%s).\n"
347
"Must be an integer between 0 and 65535." % repr(usrmgt_port))
350
# By default we generate the magic randomly.
351
if globals()['usrmgt_magic'] is None:
352
globals()['usrmgt_magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
354
# Generate the forum secret
355
forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
357
# Write ./etc/ivle.conf
359
conf = configobj.ConfigObj()
360
conf.filename = conffile
362
conf.initial_comment = ["# IVLE Configuration File"]
364
# Add the forum secret to the config file (regenerated each config)
365
config_options.append(ConfigOption('forum_secret', None, '', ''))
366
globals()['forum_secret'] = forum_secret
368
for legacyopt in config_options:
369
newopt_path = CONFIG_OPTIONS[legacyopt.option_name].split('/')
370
# Iterate over each segment of the path, and find the section in conf
371
# file to insert the value into (use all but the last path segment)
373
for seg in newopt_path[:-1]:
374
# Create the section if it isn't there
375
if seg not in conf_section:
376
conf_section[seg] = {}
377
conf_section = conf_section[seg]
378
# The final path segment names the key to insert into
379
keyname = newopt_path[-1]
380
value = globals()[legacyopt.option_name]
381
if value is not None:
382
conf_section[keyname] = value
383
conf_section.comments[keyname] = legacyopt.comment.split('\n')
387
print "Successfully wrote %s" % conffile
389
# Write bin/trampoline/conf.h
391
conf = open(conf_hfile, "w")
393
# XXX Compute jail_base, jail_src_base and jail_system. These will
394
# ALSO be done by the boilerplate code, but we need them here in order
395
# to write to the C file.
396
jail_base = os.path.join(data_path, 'jailmounts')
397
jail_src_base = os.path.join(data_path, 'jails')
398
jail_system = os.path.join(jail_src_base, '__base__')
400
conf.write("""/* IVLE Configuration File
402
* Administrator settings required by trampoline.
403
* Note: trampoline will have to be rebuilt in order for changes to this file
407
#define IVLE_AUFS_JAILS
409
/* In the local file system, where are the jails located.
410
* The trampoline does not allow the creation of a jail anywhere besides
411
* jail_base or a subdirectory of jail_base.
413
static const char* jail_base = "%s";
414
static const char* jail_src_base = "%s";
415
static const char* jail_system = "%s";
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).
421
static const int allowed_uids[] = { %s };
422
""" % (repr(jail_base)[1:-1], repr(jail_src_base)[1:-1],
423
repr(jail_system)[1:-1], repr(allowed_uids_list)[1:-1]))
424
# Note: The above uses PYTHON reprs, not C reprs
425
# However they should be the same with the exception of the outer
426
# characters, which are stripped off and replaced
430
print "Successfully wrote %s" % conf_hfile
432
# Write www/php/phpBB3/config.php
434
conf = open(phpBBconffile, "w")
437
if db_host == 'localhost':
438
forumdb_host = '127.0.0.1'
440
forumdb_host = db_host
443
// phpBB 3.0.x auto-generated configuration file
444
// Do not change anything in this file!
446
$dbhost = '""" + forumdb_host + """';
447
$dbport = '""" + str(db_port) + """';
448
$dbname = '""" + db_forumdbname + """';
449
$dbuser = '""" + db_user + """';
450
$dbpasswd = '""" + db_password + """';
452
$table_prefix = 'phpbb_';
454
$load_extensions = '';
455
@define('PHPBB_INSTALLED', true);
456
// @define('DEBUG', true);
457
//@define('DEBUG_EXTRA', true);
459
$forum_secret = '""" + forum_secret +"""';
464
print "Successfully wrote %s" % phpBBconffile
467
print "You may modify the configuration at any time by editing"
added
removed
setup/configure.py
