← Back to branch summary

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

« back to all changes in this revision

Viewing changes to bin/ivle-config

  • Committer: William Grant
  • Date: 2010-02-23 08:48:09 UTC
  • mfrom: (1673 trunk)
  • mto: This revision was merged to the branch mainline in revision 1674.
  • Revision ID: grantw@unimelb.edu.au-20100223084809-du6dvsxrjhw15ytr
Merge trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bin/ivle-config
 
1
#!/usr/bin/python
 
2
# IVLE - Informatics Virtual Learning Environment
 
3
# Copyright (C) 2007-2009 The University of Melbourne
 
4
#
 
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.
 
9
#
 
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.
 
14
#
 
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
 
18
 
 
19
# Author: Matt Giuca, Refactored by David Coles
 
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
 
 
28
import optparse
 
29
import getopt
 
30
import os
 
31
import sys
 
32
import stat
 
33
import hashlib
 
34
import uuid
 
35
 
 
36
import ivle.config
 
37
 
 
38
import configobj
 
39
 
 
40
class ConfigOption:
 
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
 
48
            setup.py conf.
 
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.
 
52
        """
 
53
        self.option_name = option_name
 
54
        self.default = default
 
55
        self.prompt = prompt
 
56
        self.comment = comment
 
57
        self.ask = ask
 
58
 
 
59
# Configuration options, defaults and descriptions
 
60
config_options = []
 
61
 
 
62
config_options.append(ConfigOption("urls/root", "/",
 
63
    """Root directory where IVLE is located (in URL space):""",
 
64
    """
 
65
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
 
66
# with this).
 
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/data",
 
79
    "/var/lib/ivle",
 
80
    "In the local file system, where user-modifiable data files should be "
 
81
    "located:",
 
82
    """
 
83
# In the local file system, where user-modifiable data files should be
 
84
# located.""", ask=False))
 
85
 
 
86
config_options.append(ConfigOption("paths/logs",
 
87
    "/var/log/ivle",
 
88
    """Directory where IVLE log files are stored (on the local
 
89
file system). Note - this must be writable by the user the IVLE server 
 
90
process runs as (usually www-data):""",
 
91
    """
 
92
# In the local file system, where IVLE error logs should be located.""",
 
93
    ask=False))
 
94
 
 
95
config_options.append(ConfigOption("urls/public_host",
 
96
    "public.ivle.localhost",
 
97
    """Hostname which will cause the server to go into "public mode",
 
98
providing login-free access to student's published work:""",
 
99
    """
 
100
# The server goes into "public mode" if the browser sends a request with this
 
101
# host. This is for security reasons - we only serve public student files on a
 
102
# separate domain to the main IVLE site.
 
103
# Public mode does not use cookies, and serves only public content.
 
104
# Private mode (normal mode) requires login, and only serves files relevant to
 
105
# the logged-in user."""))
 
106
 
 
107
config_options.append(ConfigOption("media/version", None,
 
108
    """Version of IVLE media resources (must change on each upgrade):""",
 
109
    """
 
110
# Version string for IVLE media resource URLs. When set, they are aggressively
 
111
# cached by the browser, so it must be either left unset or changed each time
 
112
# a media file is changed.""", ask=False))
 
113
 
 
114
config_options.append(ConfigOption("database/host", "localhost",
 
115
    """PostgreSQL Database config
 
116
==========================
 
117
Hostname of the DB server:""",
 
118
    """
 
119
# Database server hostname"""))
 
120
 
 
121
config_options.append(ConfigOption("database/port", "5432",
 
122
    """Port of the DB server:""",
 
123
    """
 
124
# Database server port"""))
 
125
 
 
126
config_options.append(ConfigOption("database/name", "ivle",
 
127
    """Database name:""",
 
128
    """
 
129
# Database name"""))
 
130
 
 
131
config_options.append(ConfigOption("database/username", "postgres",
 
132
    """Username for DB server login:""",
 
133
    """
 
134
# Database username"""))
 
135
 
 
136
config_options.append(ConfigOption("database/password", "",
 
137
    """Password for DB server login:
 
138
    (Caution: This password is stored in plaintext!)""",
 
139
    """
 
140
# Database password"""))
 
141
 
 
142
config_options.append(ConfigOption("auth/modules", "",
 
143
    """Authentication config
 
144
=====================
 
145
Comma-separated list of authentication modules.""",
 
146
    """
 
147
# Comma-separated list of authentication modules.
 
148
# Note that auth is always enabled against the local database, and NO OTHER
 
149
# auth is enabled by default. This section is for specifying additional auth
 
150
# modules.
 
151
# These refer to importable Python modules in the www/auth directory.
 
152
# Modules "ldap_auth" and "guest" are available in the source tree, but
 
153
# other modules may be plugged in to auth against organisation-specific
 
154
# auth backends.""", ask=False))
 
155
 
 
156
config_options.append(ConfigOption("auth/ldap_url", "ldaps://www.example.com",
 
157
    """(LDAP options are only relevant if "ldap" is included in the list of
 
158
auth modules).
 
159
URL for LDAP authentication server:""",
 
160
    """
 
161
# URL for LDAP authentication server""", ask=False))
 
162
 
 
163
config_options.append(ConfigOption("auth/ldap_format_string",
 
164
    "uid=%s,ou=users,o=example",
 
165
    """Format string for LDAP auth request:
 
166
    (Must contain a single "%s" for the user's login name)""",
 
167
    """
 
168
# Format string for LDAP auth request
 
169
# (Must contain a single "%s" for the user's login name)""", ask=False))
 
170
 
 
171
config_options.append(ConfigOption("auth/subject_pulldown_modules", "",
 
172
    """Comma-separated list of subject pulldown modules.
 
173
Add proprietary modules to automatically enrol students in subjects.""",
 
174
    """
 
175
# Comma-separated list of subject pulldown modules.
 
176
# These refer to importable Python modules in the lib/pulldown_subj directory.
 
177
# Only "dummy_subj" is available in the source tree (an example), but
 
178
# other modules may be plugged in to pulldown against organisation-specific
 
179
# pulldown backends.""", ask=False))
 
180
 
 
181
config_options.append(ConfigOption("urls/svn_addr",
 
182
    "http://svn.ivle.localhost/",
 
183
    """Subversion config
 
184
=================
 
185
The base url for accessing subversion repositories:""",
 
186
    """
 
187
# The base url for accessing subversion repositories."""))
 
188
 
 
189
config_options.append(ConfigOption("usrmgt/host", "localhost",
 
190
    """User Management Server config
 
191
============================
 
192
The hostname where the usrmgt-server runs:""",
 
193
    """
 
194
# The hostname where the usrmgt-server runs."""))
 
195
 
 
196
config_options.append(ConfigOption("usrmgt/port", "2178",
 
197
    """The port where the usrmgt-server runs:""",
 
198
    """
 
199
# The port where the usrmgt-server runs.""", ask=False))
 
200
 
 
201
config_options.append(ConfigOption("usrmgt/magic", None,
 
202
    """The password for the usrmgt-server:""",
 
203
    """
 
204
# The password for the usrmgt-server.""", ask=False))
 
205
 
 
206
config_options.append(ConfigOption("jail/suite", "hardy",
 
207
    """The distribution release to use to build the jail:""",
 
208
    """
 
209
# The distribution release to use to build the jail.""", ask=True))
 
210
 
 
211
config_options.append(ConfigOption("jail/mirror", "archive.ubuntu.com",
 
212
    """The archive mirror to use to build the jail:""",
 
213
    """
 
214
# The archive mirror to use to build the jail.""", ask=True))
 
215
 
 
216
config_options.append(ConfigOption("jail/devmode", False,
 
217
    """Whether jail development mode be activated:""",
 
218
    """
 
219
# Should jail development mode be activated?""", ask=False))
 
220
 
 
221
# The password for the usrmgt-server.""", ask=False))
 
222
def query_user(default, prompt):
 
223
    """Prompts the user for a string, which is read from a line of stdin.
 
224
    Exits silently if EOF is encountered. Returns the string, with spaces
 
225
    removed from the beginning and end.
 
226
 
 
227
    Returns default if a 0-length line (after spaces removed) was read.
 
228
    """
 
229
    if default is None:
 
230
        # A default of None means the value will be computed specially, so we
 
231
        # can't really tell you what it is
 
232
        defaultstr = "computed"
 
233
    elif isinstance(default, basestring):
 
234
        defaultstr = '"%s"' % default
 
235
    else:
 
236
        defaultstr = repr(default)
 
237
    sys.stdout.write('%s\n    (default: %s)\n>' % (prompt, defaultstr))
 
238
    try:
 
239
        val = sys.stdin.readline()
 
240
    except KeyboardInterrupt:
 
241
        # Ctrl+C
 
242
        sys.stdout.write("\n")
 
243
        sys.exit(1)
 
244
    sys.stdout.write("\n")
 
245
    # If EOF, exit
 
246
    if val == '': sys.exit(1)
 
247
    # If empty line, return default
 
248
    val = val.strip()
 
249
    if val == '': return default
 
250
    return val
 
251
 
 
252
def configure(args):
 
253
    # Try importing existing conf, but if we can't just set up defaults
 
254
    # The reason for this is that these settings are used by other phases
 
255
    # of setup besides conf, so we need to know them.
 
256
    # Also this allows you to hit Return to accept the existing value.
 
257
    try:
 
258
        conf = ivle.config.Config()
 
259
    except ivle.config.ConfigError:
 
260
        # Couldn't find a config file anywhere.
 
261
        # Create a new blank config object (not yet bound to a file)
 
262
        # All lookups (below) will fail, so it will be initialised with all
 
263
        # the default values.
 
264
        conf = ivle.config.Config(blank=True)
 
265
 
 
266
    # Check that all the options are present, and if not, load the default
 
267
    for opt in config_options:
 
268
        try:
 
269
            conf.get_by_path(opt.option_name)
 
270
        except KeyError:
 
271
            # If the default is None, omit it
 
272
            # Else ConfigObj will write the string 'None' to the conf file
 
273
            if opt.default is not None:
 
274
                conf.set_by_path(opt.option_name, opt.default)
 
275
 
 
276
    # Store comments in the conf object
 
277
    for opt in config_options:
 
278
        # Omitted if the key doesn't exist
 
279
        conf.set_by_path(opt.option_name, comment=opt.comment)
 
280
 
 
281
    # Set up some variables
 
282
    cwd = os.getcwd()
 
283
 
 
284
    # the files that will be created/overwritten
 
285
    try:
 
286
        confdir = os.environ['IVLECONF']
 
287
    except KeyError:
 
288
        confdir = '/etc/ivle'
 
289
 
 
290
    conffile = os.path.join(confdir, 'ivle.conf')
 
291
    plugindefaultfile = os.path.join(confdir, 'plugins.d/000default.conf')
 
292
 
 
293
    # Get command-line arguments to avoid asking questions.
 
294
 
 
295
    optnames = []
 
296
    for opt in config_options:
 
297
        optnames.append(opt.option_name + "=")
 
298
    (opts, args) = getopt.gnu_getopt(args, "", optnames)
 
299
 
 
300
    if args != []:
 
301
        print >>sys.stderr, "Invalid arguments:", ' '.join(args)
 
302
        return 2
 
303
 
 
304
    if opts == []:
 
305
        # Interactive mode. Prompt the user for all the values.
 
306
 
 
307
        print """This tool will create %s, prompting you for details about
 
308
your configuration. The file will be updated with modified options if it already
 
309
exists. If it does not already exist, it will be created with sane defaults and
 
310
restrictive permissions.
 
311
 
 
312
%s will also be overwritten with the default list of plugins.
 
313
 
 
314
Please hit Ctrl+C now if you do not wish to do this.
 
315
""" % (conffile, plugindefaultfile)
 
316
 
 
317
        # Get information from the administrator
 
318
        # If EOF is encountered at any time during the questioning, just exit
 
319
        # silently
 
320
 
 
321
        for opt in config_options:
 
322
            if opt.ask:
 
323
                conf.set_by_path(opt.option_name,
 
324
                    query_user(conf.get_by_path(opt.option_name), opt.prompt))
 
325
    else:
 
326
        opts = dict(opts)
 
327
        # Non-interactive mode. Parse the options.
 
328
        for opt in config_options:
 
329
            if '--' + opt.option_name in opts:
 
330
                conf.set_by_path(opt.option_name,
 
331
                                 opts['--' + opt.option_name])
 
332
 
 
333
    # Error handling on input values
 
334
    try:
 
335
        conf['database']['port'] = int(conf['database']['port'])
 
336
        if (conf['database']['port'] < 0
 
337
            or conf['database']['port'] >= 65536):
 
338
            raise ValueError()
 
339
    except ValueError:
 
340
        if conf['database']['port'] == '' or conf['database']['port'] is None:
 
341
            pass
 
342
        else:
 
343
            print >>sys.stderr, (
 
344
            "Invalid DB port (%s).\n"
 
345
            "Must be an integer between 0 and 65535." %
 
346
                repr(conf['database']['port']))
 
347
            return 1
 
348
    try:
 
349
        conf['usrmgt']['port'] = int(conf['usrmgt']['port'])
 
350
        if (conf['usrmgt']['port'] < 0 or conf['usrmgt']['port'] >= 65536):
 
351
            raise ValueError()
 
352
    except ValueError:
 
353
        print >>sys.stderr, (
 
354
        "Invalid user management port (%s).\n"
 
355
        "Must be an integer between 0 and 65535." %
 
356
            repr(conf['usrmgt']['port']))
 
357
        return 1
 
358
 
 
359
    # By default we generate the magic randomly.
 
360
    try:
 
361
        conf['usrmgt']['magic']     # Throw away; just check for KeyError
 
362
    except KeyError:
 
363
        conf['usrmgt']['magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
364
 
 
365
    clobber_permissions = not os.path.exists(conffile)
 
366
 
 
367
    # Write ./etc/ivle.conf (even if we loaded from a different filename)
 
368
    conf.filename = conffile
 
369
    conf.initial_comment = ["# IVLE Configuration File"]
 
370
    conf.write()
 
371
 
 
372
    # We need to restrict permissions on a new file, as it contains
 
373
    # a nice database password.
 
374
    if clobber_permissions:
 
375
        os.chown(conffile, 33, 33) # chown to www-data
 
376
        os.chmod(conffile, stat.S_IRUSR | stat.S_IWUSR) # No g/o perms!
 
377
 
 
378
    print "Successfully wrote %s" % conffile
 
379
 
 
380
    plugindefault = open(plugindefaultfile, 'w')
 
381
    plugindefault.write("""# IVLE default plugin configuration file
 
382
[ivle.webapp.core#Plugin]
 
383
[ivle.webapp.admin.user#Plugin]
 
384
[ivle.webapp.tutorial#Plugin]
 
385
[ivle.webapp.admin.subject#Plugin]
 
386
[ivle.webapp.filesystem.browser#Plugin]
 
387
[ivle.webapp.filesystem.diff#Plugin]
 
388
[ivle.webapp.filesystem.svnlog#Plugin]
 
389
[ivle.webapp.filesystem.serve#Plugin]
 
390
[ivle.webapp.groups#Plugin]
 
391
[ivle.webapp.console#Plugin]
 
392
[ivle.webapp.security#Plugin]
 
393
[ivle.webapp.media#Plugin]
 
394
[ivle.webapp.help#Plugin]
 
395
[ivle.webapp.tos#Plugin]
 
396
[ivle.webapp.userservice#Plugin]
 
397
[ivle.webapp.fileservice#Plugin]
 
398
[ivle.webapp.submit#Plugin]
 
399
""")
 
400
    plugindefault.close()
 
401
    print "Successfully wrote %s" % plugindefaultfile
 
402
 
 
403
    print
 
404
    print "You may modify the configuration at any time by editing " + conffile
 
405
    
 
406
    return 0
 
407
 
 
408
def main(argv=None):
 
409
    if argv is None:
 
410
        argv = sys.argv
 
411
 
 
412
    # Print the opening spiel including the GPL notice
 
413
 
 
414
    print """IVLE - Informatics Virtual Learning Environment Setup
 
415
Copyright (C) 2007-2009 The University of Melbourne
 
416
IVLE comes with ABSOLUTELY NO WARRANTY.
 
417
This is free software, and you are welcome to redistribute it
 
418
under certain conditions. See LICENSE.txt for details.
 
419
 
 
420
IVLE Configuration
 
421
"""
 
422
 
 
423
    return configure(argv[1:])
 
424
 
 
425
if __name__ == "__main__":
 
426
    sys.exit(main())