2
# IVLE - Informatics Virtual Learning Environment
3
# Copyright (C) 2007-2009 The University of Melbourne
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19
# Author: Matt Giuca, Refactored by David Coles
21
'''Configures IVLE with machine-specific details, most notably, various paths.
22
Either prompts the administrator for these details or accepts them as
41
"""A configuration option; one of the things written to conf.py."""
42
def __init__(self, option_name, default, prompt, comment, ask=True):
43
"""Creates a configuration option.
44
option_name: Name of the variable in conf.py. Also name of the
45
command-line argument to setup.py conf.
46
default: Default value for this variable.
47
prompt: (Short) string presented during the interactive prompt in
49
comment: (Long) comment string stored in conf.py. Each line of this
50
string should begin with a '#'.
51
ask: Whether to ask the question in the default config run.
53
self.option_name = option_name
54
self.default = default
56
self.comment = comment
59
# Configuration options, defaults and descriptions
62
config_options.append(ConfigOption("urls/root", "/",
63
"""Root directory where IVLE is located (in URL space):""",
65
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
67
# eg. "/" or "/ivle".""", ask=False))
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):""",
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)""",
78
config_options.append(ConfigOption("paths/site_packages",
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:""",
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))
88
config_options.append(ConfigOption("paths/data",
90
"In the local file system, where user-modifiable data files should be "
93
# In the local file system, where user-modifiable data files should be
94
# located.""", ask=False))
96
config_options.append(ConfigOption("paths/logs",
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):""",
102
# In the local file system, where IVLE error logs should be located.""",
105
config_options.append(ConfigOption("urls/public_host", "public.localhost",
106
"""Hostname which will cause the server to go into "public mode",
107
providing login-free access to student's published work:""",
109
# The server goes into "public mode" if the browser sends a request with this
110
# host. This is for security reasons - we only serve public student files on a
111
# separate domain to the main IVLE site.
112
# Public mode does not use cookies, and serves only public content.
113
# Private mode (normal mode) requires login, and only serves files relevant to
114
# the logged-in user."""))
116
config_options.append(ConfigOption("database/host", "localhost",
117
"""PostgreSQL Database config
118
==========================
119
Hostname of the DB server:""",
121
# Database server hostname"""))
123
config_options.append(ConfigOption("database/port", "5432",
124
"""Port of the DB server:""",
126
# Database server port"""))
128
config_options.append(ConfigOption("database/name", "ivle",
129
"""Database name:""",
133
config_options.append(ConfigOption("database/username", "postgres",
134
"""Username for DB server login:""",
136
# Database username"""))
138
config_options.append(ConfigOption("database/password", "",
139
"""Password for DB server login:
140
(Caution: This password is stored in plaintext!)""",
142
# Database password"""))
144
config_options.append(ConfigOption("auth/modules", "",
145
"""Authentication config
146
=====================
147
Comma-separated list of authentication modules.""",
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
153
# These refer to importable Python modules in the www/auth directory.
154
# Modules "ldap_auth" and "guest" are available in the source tree, but
155
# other modules may be plugged in to auth against organisation-specific
156
# auth backends.""", ask=False))
158
config_options.append(ConfigOption("auth/ldap_url", "ldaps://www.example.com",
159
"""(LDAP options are only relevant if "ldap" is included in the list of
161
URL for LDAP authentication server:""",
163
# URL for LDAP authentication server""", ask=False))
165
config_options.append(ConfigOption("auth/ldap_format_string",
166
"uid=%s,ou=users,o=example",
167
"""Format string for LDAP auth request:
168
(Must contain a single "%s" for the user's login name)""",
170
# Format string for LDAP auth request
171
# (Must contain a single "%s" for the user's login name)""", ask=False))
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.""",
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))
183
config_options.append(ConfigOption("urls/svn_addr", "http://svn.localhost/",
186
The base url for accessing subversion repositories:""",
188
# The base url for accessing subversion repositories."""))
190
config_options.append(ConfigOption("usrmgt/host", "localhost",
191
"""User Management Server config
192
============================
193
The hostname where the usrmgt-server runs:""",
195
# The hostname where the usrmgt-server runs."""))
197
config_options.append(ConfigOption("usrmgt/port", "2178",
198
"""The port where the usrmgt-server runs:""",
200
# The port where the usrmgt-server runs.""", ask=False))
202
config_options.append(ConfigOption("usrmgt/magic", None,
203
"""The password for the usrmgt-server:""",
205
# The password for the usrmgt-server.""", ask=False))
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.
212
Returns default if a 0-length line (after spaces removed) was read.
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
221
defaultstr = repr(default)
222
sys.stdout.write('%s\n (default: %s)\n>' % (prompt, defaultstr))
224
val = sys.stdin.readline()
225
except KeyboardInterrupt:
227
sys.stdout.write("\n")
229
sys.stdout.write("\n")
231
if val == '': sys.exit(1)
232
# If empty line, return default
234
if val == '': return default
238
# Try importing existing conf, but if we can't just set up defaults
239
# The reason for this is that these settings are used by other phases
240
# of setup besides conf, so we need to know them.
241
# Also this allows you to hit Return to accept the existing value.
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)
251
# Check that all the options are present, and if not, load the default
252
for opt in config_options:
254
conf.get_by_path(opt.option_name)
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)
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)
266
# Set up some variables
269
# the files that will be created/overwritten
271
confdir = os.environ['IVLECONF']
273
confdir = '/etc/ivle'
275
conffile = os.path.join(confdir, 'ivle.conf')
276
plugindefaultfile = os.path.join(confdir, 'plugins.d/000default.conf')
278
# Get command-line arguments to avoid asking questions.
281
for opt in config_options:
282
optnames.append(opt.option_name + "=")
283
(opts, args) = getopt.gnu_getopt(args, "", optnames)
286
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
290
# Interactive mode. Prompt the user for all the values.
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.
297
%s will also be overwritten with the default list of plugins.
299
Please hit Ctrl+C now if you do not wish to do this.
300
""" % (conffile, plugindefaultfile)
302
# Get information from the administrator
303
# If EOF is encountered at any time during the questioning, just exit
306
for opt in config_options:
308
conf.set_by_path(opt.option_name,
309
query_user(conf.get_by_path(opt.option_name), opt.prompt))
312
# Non-interactive mode. Parse the options.
313
for opt in config_options:
314
if '--' + opt.option_name in opts:
315
conf.set_by_path(opt.option_name,
316
opts['--' + opt.option_name])
318
# Error handling on input values
320
conf['database']['port'] = int(conf['database']['port'])
321
if (conf['database']['port'] < 0
322
or conf['database']['port'] >= 65536):
325
if conf['database']['port'] == '' or conf['database']['port'] is None:
328
print >>sys.stderr, (
329
"Invalid DB port (%s).\n"
330
"Must be an integer between 0 and 65535." %
331
repr(conf['database']['port']))
334
conf['usrmgt']['port'] = int(conf['usrmgt']['port'])
335
if (conf['usrmgt']['port'] < 0 or conf['usrmgt']['port'] >= 65536):
338
print >>sys.stderr, (
339
"Invalid user management port (%s).\n"
340
"Must be an integer between 0 and 65535." %
341
repr(conf['usrmgt']['port']))
344
# By default we generate the magic randomly.
346
conf['usrmgt']['magic'] # Throw away; just check for KeyError
348
conf['usrmgt']['magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
350
clobber_permissions = not os.path.exists(conffile)
352
# Write ./etc/ivle.conf (even if we loaded from a different filename)
353
conf.filename = conffile
354
conf.initial_comment = ["# IVLE Configuration File"]
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!
363
print "Successfully wrote %s" % conffile
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]
384
plugindefault.close()
385
print "Successfully wrote %s" % plugindefaultfile
388
print "You may modify the configuration at any time by editing " + conffile
396
# Print the opening spiel including the GPL notice
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.
407
return configure(argv[1:])
409
if __name__ == "__main__":
added
removed
bin/ivle-config
