1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2008 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
23
# Configures IVLE with machine-specific details, most notably, various paths.
24
# Either prompts the administrator for these details or accepts them as
26
# Creates lib/conf/conf.py and bin/trampoline/conf.h.
35
from setup.util import query_user
38
"""A configuration option; one of the things written to conf.py."""
39
def __init__(self, option_name, default, prompt, comment, ask=True):
40
"""Creates a configuration option.
41
option_name: Name of the variable in conf.py. Also name of the
42
command-line argument to setup.py conf.
43
default: Default value for this variable.
44
prompt: (Short) string presented during the interactive prompt in
46
comment: (Long) comment string stored in conf.py. Each line of this
47
string should begin with a '#'.
48
ask: Whether to ask the question in the default config run.
50
self.option_name = option_name
51
self.default = default
53
self.comment = comment
56
# Configuration options, defaults and descriptions
59
config_options.append(ConfigOption("root_dir", "/",
60
"""Root directory where IVLE is located (in URL space):""",
62
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
64
# eg. "/" or "/ivle".""", ask=False))
66
config_options.append(ConfigOption("prefix", "/usr/local",
67
"""In the local file system, the prefix to the system directory where IVLE
68
is installed. (This should either be /usr or /usr/local):""",
70
# In the local file system, the prefix to the system directory where IVLE is
71
# installed. This should either be '/usr' or '/usr/local'.
72
# ('/usr/local' for the usual install, '/usr' for distribution packages)""",
75
config_options.append(ConfigOption("python_site_packages_override",
77
"""site-packages directory in Python, where Python libraries are to be
78
installed. May be left as the default, in which case the value will be
79
computed from prefix and the current Python version:""",
81
# 'site-packages' directory in Python, where Python libraries are to be
82
# installed. May be None (recommended), in which case the value will be
83
# computed from prefix and the current Python version.""", ask=False))
85
config_options.append(ConfigOption("data_path",
87
"In the local file system, where user-modifiable data files should be "
90
# In the local file system, where user-modifiable data files should be
91
# located.""", ask=False))
93
config_options.append(ConfigOption("log_path",
95
"""Directory where IVLE log files are stored (on the local
96
file system). Note - this must be writable by the user the IVLE server
97
process runs as (usually www-data):""",
99
# In the local file system, where IVLE error logs should be located.""",
102
config_options.append(ConfigOption("public_host", "public.localhost",
103
"""Hostname which will cause the server to go into "public mode",
104
providing login-free access to student's published work:""",
106
# The server goes into "public mode" if the browser sends a request with this
107
# host. This is for security reasons - we only serve public student files on a
108
# separate domain to the main IVLE site.
109
# Public mode does not use cookies, and serves only public content.
110
# Private mode (normal mode) requires login, and only serves files relevant to
111
# the logged-in user."""))
113
config_options.append(ConfigOption("allowed_uids", "33",
114
"""UID of the web server process which will run IVLE.
115
Only this user may execute the trampoline. May specify multiple users as
116
a comma-separated list.
119
# The User-ID of the web server process which will run IVLE, and any other
120
# users who are allowed to run the trampoline. This is stores as a string of
121
# comma-separated integers, simply because it is not used within Python, only
122
# used by the setup program to write to conf.h (see setup.py config).""",
125
config_options.append(ConfigOption("db_host", "localhost",
126
"""PostgreSQL Database config
127
==========================
128
Hostname of the DB server:""",
130
### PostgreSQL Database config ###
131
# Database server hostname"""))
133
config_options.append(ConfigOption("db_port", "5432",
134
"""Port of the DB server:""",
136
# Database server port"""))
138
config_options.append(ConfigOption("db_dbname", "ivle",
139
"""Database name:""",
143
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
144
"""Forum Database name:""",
146
# Forum Database name"""))
148
config_options.append(ConfigOption("db_user", "postgres",
149
"""Username for DB server login:""",
151
# Database username"""))
153
config_options.append(ConfigOption("db_password", "",
154
"""Password for DB server login:
155
(Caution: This password is stored in plaintext in ivle/conf/conf.py)""",
157
# Database password"""))
159
config_options.append(ConfigOption("auth_modules", "",
160
"""Authentication config
161
=====================
162
Comma-separated list of authentication modules.""",
164
# Comma-separated list of authentication modules.
165
# Note that auth is always enabled against the local database, and NO OTHER
166
# auth is enabled by default. This section is for specifying additional auth
168
# These refer to importable Python modules in the www/auth directory.
169
# Modules "ldap_auth" and "guest" are available in the source tree, but
170
# other modules may be plugged in to auth against organisation-specific
171
# auth backends.""", ask=False))
173
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
174
"""(LDAP options are only relevant if "ldap" is included in the list of
176
URL for LDAP authentication server:""",
178
# URL for LDAP authentication server""", ask=False))
180
config_options.append(ConfigOption("ldap_format_string",
181
"uid=%s,ou=users,o=example",
182
"""Format string for LDAP auth request:
183
(Must contain a single "%s" for the user's login name)""",
185
# Format string for LDAP auth request
186
# (Must contain a single "%s" for the user's login name)""", ask=False))
188
config_options.append(ConfigOption("subject_pulldown_modules", "",
189
"""Comma-separated list of subject pulldown modules.
190
Add proprietary modules to automatically enrol students in subjects.""",
192
# Comma-separated list of subject pulldown modules.
193
# These refer to importable Python modules in the lib/pulldown_subj directory.
194
# Only "dummy_subj" is available in the source tree (an example), but
195
# other modules may be plugged in to pulldown against organisation-specific
196
# pulldown backends.""", ask=False))
198
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
201
The base url for accessing subversion repositories:""",
203
# The base url for accessing subversion repositories."""))
205
config_options.append(ConfigOption("usrmgt_host", "localhost",
206
"""User Management Server config
207
============================
208
The hostname where the usrmgt-server runs:""",
210
# The hostname where the usrmgt-server runs."""))
212
config_options.append(ConfigOption("usrmgt_port", "2178",
213
"""The port where the usrmgt-server runs:""",
215
# The port where the usrmgt-server runs.""", ask=False))
217
config_options.append(ConfigOption("usrmgt_magic", None,
218
"""The password for the usrmgt-server:""",
220
# The password for the usrmgt-server.""", ask=False))
223
usage = """usage: %prog config [options]
224
Creates lib/conf/conf.py (and a few other config files).
225
Interactively asks questions to set this up."""
228
parser = optparse.OptionParser(usage)
229
(options, args) = parser.parse_args(args)
231
# Call the real function
232
return __configure(args)
234
def __configure(args):
235
global db_port, usrmgt_port
237
# Try importing existing conf, but if we can't just set up defaults
238
# The reason for this is that these settings are used by other phases
239
# of setup besides conf, so we need to know them.
240
# Also this allows you to hit Return to accept the existing value.
242
confmodule = __import__("ivle/conf/conf")
243
for opt in config_options:
245
globals()[opt.option_name] = \
246
confmodule.__dict__[opt.option_name]
248
globals()[opt.option_name] = opt.default
250
# Just set reasonable defaults
251
for opt in config_options:
252
globals()[opt.option_name] = opt.default
254
# Set up some variables
257
# the files that will be created/overwritten
258
conffile = os.path.join(cwd, "ivle/conf/conf.py")
259
jailconffile = os.path.join(cwd, "ivle/conf/jailconf.py")
260
conf_hfile = os.path.join(cwd, "bin/trampoline/conf.h")
261
phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
263
# Get command-line arguments to avoid asking questions.
266
for opt in config_options:
267
optnames.append(opt.option_name + "=")
268
(opts, args) = getopt.gnu_getopt(args, "", optnames)
271
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
275
# Interactive mode. Prompt the user for all the values.
277
print """This tool will create the following files:
282
prompting you for details about your configuration. The file will be
283
overwritten if it already exists. It will *not* install or deploy IVLE.
285
Please hit Ctrl+C now if you do not wish to do this.
286
""" % (conffile, jailconffile, conf_hfile, phpBBconffile)
288
# Get information from the administrator
289
# If EOF is encountered at any time during the questioning, just exit
292
for opt in config_options:
294
globals()[opt.option_name] = \
295
query_user(globals()[opt.option_name], opt.prompt)
298
# Non-interactive mode. Parse the options.
299
for opt in config_options:
300
if '--' + opt.option_name in opts:
301
globals()[opt.option_name] = opts['--' + opt.option_name]
303
# Error handling on input values
305
allowed_uids_list = map(int, allowed_uids.split(','))
307
print >>sys.stderr, (
308
"Invalid UID list (%s).\n"
309
"Must be a comma-separated list of integers." % allowed_uids)
312
db_port = int(db_port)
313
if db_port < 0 or db_port >= 65536: raise ValueError()
315
print >>sys.stderr, (
316
"Invalid DB port (%s).\n"
317
"Must be an integer between 0 and 65535." % repr(db_port))
320
usrmgt_port = int(usrmgt_port)
321
if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
323
print >>sys.stderr, (
324
"Invalid user management port (%s).\n"
325
"Must be an integer between 0 and 65535." % repr(usrmgt_port))
328
# By default we generate the magic randomly.
329
if globals()['usrmgt_magic'] is None:
330
globals()['usrmgt_magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
332
# Generate the forum secret
333
forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
335
# Write lib/conf/conf.py
338
conf = open(conffile, "w")
340
conf.write("""# IVLE Configuration File
342
# Miscellaneous application settings
347
for opt in config_options:
348
conf.write('%s\n%s = %r\n' % (opt.comment, opt.option_name,
349
globals()[opt.option_name]))
351
# Add the forum secret to the config file (regenerated each config)
352
conf.write('forum_secret = "%s"\n\n' % (forum_secret))
354
write_conf_file_boilerplate(conf)
357
except IOError, (errno, strerror):
358
print "IO error(%s): %s" % (errno, strerror)
361
print "Successfully wrote %s" % conffile
363
# Write conf/jailconf.py
366
conf = open(jailconffile, "w")
368
# In the "in-jail" version of conf, we don't need MOST of the details
369
# (it would be a security risk to have them here).
370
# So we just write root_dir, and jail_base is "/".
371
# (jail_base being "/" means "jail-relative" paths are relative to "/"
372
# when inside the jail.)
373
conf.write("""# IVLE Configuration File
375
# Miscellaneous application settings
376
# (User jail version)
379
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
381
# eg. "/" or "/ivle".
384
# In the local file system, where are the student/user file spaces located.
385
# The user jails are expected to be located immediately in subdirectories of
389
# The hostname for serving publicly accessible pages
392
# The URL under which the Subversion repositories are located.
394
""" % (repr(root_dir),repr(public_host),repr(svn_addr)))
397
except IOError, (errno, strerror):
398
print "IO error(%s): %s" % (errno, strerror)
401
print "Successfully wrote %s" % jailconffile
403
# Write bin/trampoline/conf.h
406
conf = open(conf_hfile, "w")
408
# XXX Compute jail_base, jail_src_base and jail_system. These will
409
# ALSO be done by the boilerplate code, but we need them here in order
410
# to write to the C file.
411
jail_base = os.path.join(data_path, 'jailmounts')
412
jail_src_base = os.path.join(data_path, 'jails')
413
jail_system = os.path.join(jail_src_base, '__base__')
415
conf.write("""/* IVLE Configuration File
417
* Administrator settings required by trampoline.
418
* Note: trampoline will have to be rebuilt in order for changes to this file
422
#define IVLE_AUFS_JAILS
424
/* In the local file system, where are the jails located.
425
* The trampoline does not allow the creation of a jail anywhere besides
426
* jail_base or a subdirectory of jail_base.
428
static const char* jail_base = "%s";
429
static const char* jail_src_base = "%s";
430
static const char* jail_system = "%s";
432
/* Which user IDs are allowed to run the trampoline.
433
* This list should be limited to the web server user.
434
* (Note that root is an implicit member of this list).
436
static const int allowed_uids[] = { %s };
437
""" % (repr(jail_base)[1:-1], repr(jail_src_base)[1:-1],
438
repr(jail_system)[1:-1], repr(allowed_uids_list)[1:-1]))
439
# Note: The above uses PYTHON reprs, not C reprs
440
# However they should be the same with the exception of the outer
441
# characters, which are stripped off and replaced
444
except IOError, (errno, strerror):
445
print "IO error(%s): %s" % (errno, strerror)
448
print "Successfully wrote %s" % conf_hfile
450
# Write www/php/phpBB3/config.php
453
conf = open(phpBBconffile, "w")
456
if db_host == 'localhost':
457
forumdb_host = '127.0.0.1'
459
forumdb_host = db_host
462
// phpBB 3.0.x auto-generated configuration file
463
// Do not change anything in this file!
465
$dbhost = '""" + forumdb_host + """';
466
$dbport = '""" + str(db_port) + """';
467
$dbname = '""" + db_forumdbname + """';
468
$dbuser = '""" + db_user + """';
469
$dbpasswd = '""" + db_password + """';
471
$table_prefix = 'phpbb_';
473
$load_extensions = '';
474
@define('PHPBB_INSTALLED', true);
475
// @define('DEBUG', true);
476
//@define('DEBUG_EXTRA', true);
478
$forum_secret = '""" + forum_secret +"""';
482
except IOError, (errno, strerror):
483
print "IO error(%s): %s" % (errno, strerror)
486
print "Successfully wrote %s" % phpBBconffile
489
print "You may modify the configuration at any time by editing"
498
def write_conf_file_boilerplate(conf_file):
500
### Below is boilerplate code, appended by ./setup.py config ###
502
# Path where architecture-dependent data (including non-user-executable
503
# binaries) is installed.
504
lib_path = os.path.join(prefix, 'lib/ivle')
506
# Path where arch-independent data is installed.
507
share_path = os.path.join(prefix, 'share/ivle')
509
# Path where user-executable binaries are installed.
510
bin_path = os.path.join(prefix, 'bin')
512
# 'site-packages' directory in Python, where Python libraries are to be
514
if python_site_packages_override is None:
515
PYTHON_VERSION = sys.version[0:3] # eg. "2.5"
516
python_site_packages = os.path.join(prefix,
517
'lib/python%s/site-packages' % PYTHON_VERSION)
519
python_site_packages = python_site_packages_override
521
# In the local file system, where the student/user jails will be mounted.
522
# Only a single copy of the jail's system components will be stored here -
523
# all user jails will be virtually mounted here.
524
jail_base = os.path.join(data_path, 'jailmounts')
526
# In the local file system, where are the student/user file spaces located.
527
# The user jails are expected to be located immediately in subdirectories of
528
# this location. Note that no complete jails reside here - only user
530
jail_src_base = os.path.join(data_path, 'jails')
532
# In the local file system, where the template system jail will be stored.
533
jail_system = os.path.join(jail_src_base, '__base__')
535
# In the local file system, where the subject content files are located.
536
# (The 'subjects' and 'exercises' directories).
537
content_path = os.path.join(data_path, 'content')
539
# In the local file system, where are the per-subject file spaces located.
540
# The individual subject directories are expected to be located immediately
541
# in subdirectories of this location.
542
subjects_base = os.path.join(content_path, 'subjects')
544
# In the local file system, where are the subject-independent exercise sheet
545
# file spaces located.
546
exercises_base = os.path.join(content_path, 'exercises')
548
# In the local file system, where the system notices are stored (such as terms
549
# of service and MOTD).
550
notices_path = os.path.join(data_path, 'notices')
552
# In the local file system, where is the Terms of Service document located.
553
tos_path = os.path.join(notices_path, 'tos.html')
555
# In the local file system, where is the Message of the Day document
556
# located. This is an HTML file (just the body fragment), which will
557
# be displayed on the login page. It is optional.
558
motd_path = os.path.join(notices_path, 'motd.html')
560
# The location of all the subversion config and repositories.
561
svn_path = os.path.join(data_path, 'svn')
563
# The location of the subversion configuration file used by
564
# apache to host the user repositories.
565
svn_conf = os.path.join(svn_path, 'svn.conf')
567
# The location of the subversion configuration file used by
568
# apache to host the user repositories.
569
svn_group_conf = os.path.join(svn_path, 'svn-group.conf')
571
# The root directory for the subversion repositories.
572
svn_repo_path = os.path.join(svn_path, 'repositories')
574
# The location of the password file used to authenticate users
575
# of the subversion repository from the ivle server.
576
svn_auth_ivle = os.path.join(svn_path, 'ivle.auth')
added
removed
setup/configure.py
