← Back to branch summary

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

« back to all changes in this revision

Viewing changes to bin/ivle-config

Move the plugin loading/indexing logic into ivle.config.Config.
Also eliminate plugins_HACK, looking in a configuration file instead.

req.config is now set to a Config instance, and things that need to look
at plugins ask it.

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/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",
 
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):""",
 
101
    """
 
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",
 
106
    """Hostname which will cause the server to go into "public mode",
 
107
providing login-free access to student's published work:""",
 
108
    """
 
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."""))
 
115
 
 
116
config_options.append(ConfigOption("database/host", "localhost",
 
117
    """PostgreSQL Database config
 
118
==========================
 
119
Hostname of the DB server:""",
 
120
    """
 
121
# Database server hostname"""))
 
122
 
 
123
config_options.append(ConfigOption("database/port", "5432",
 
124
    """Port of the DB server:""",
 
125
    """
 
126
# Database server port"""))
 
127
 
 
128
config_options.append(ConfigOption("database/name", "ivle",
 
129
    """Database name:""",
 
130
    """
 
131
# Database name"""))
 
132
 
 
133
config_options.append(ConfigOption("database/username", "postgres",
 
134
    """Username for DB server login:""",
 
135
    """
 
136
# Database username"""))
 
137
 
 
138
config_options.append(ConfigOption("database/password", "",
 
139
    """Password for DB server login:
 
140
    (Caution: This password is stored in plaintext!)""",
 
141
    """
 
142
# Database password"""))
 
143
 
 
144
config_options.append(ConfigOption("auth/modules", "",
 
145
    """Authentication config
 
146
=====================
 
147
Comma-separated list of authentication modules.""",
 
148
    """
 
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.
 
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))
 
157
 
 
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
 
160
auth modules).
 
161
URL for LDAP authentication server:""",
 
162
    """
 
163
# URL for LDAP authentication server""", ask=False))
 
164
 
 
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)""",
 
169
    """
 
170
# Format string for LDAP auth request
 
171
# (Must contain a single "%s" for the user's login name)""", ask=False))
 
172
 
 
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.""",
 
176
    """
 
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))
 
182
 
 
183
config_options.append(ConfigOption("urls/svn_addr", "http://svn.localhost/",
 
184
    """Subversion config
 
185
=================
 
186
The base url for accessing subversion repositories:""",
 
187
    """
 
188
# The base url for accessing subversion repositories."""))
 
189
 
 
190
config_options.append(ConfigOption("usrmgt/host", "localhost",
 
191
    """User Management Server config
 
192
============================
 
193
The hostname where the usrmgt-server runs:""",
 
194
    """
 
195
# The hostname where the usrmgt-server runs."""))
 
196
 
 
197
config_options.append(ConfigOption("usrmgt/port", "2178",
 
198
    """The port where the usrmgt-server runs:""",
 
199
    """
 
200
# The port where the usrmgt-server runs.""", ask=False))
 
201
 
 
202
config_options.append(ConfigOption("usrmgt/magic", None,
 
203
    """The password for the usrmgt-server:""",
 
204
    """
 
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
 
236
 
 
237
def configure(args):
 
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.
 
242
    try:
 
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)
 
265
 
 
266
    # Set up some variables
 
267
    cwd = os.getcwd()
 
268
 
 
269
    # the files that will be created/overwritten
 
270
    try:
 
271
        confdir = os.environ['IVLECONF']
 
272
    except KeyError:
 
273
        confdir = '/etc/ivle'
 
274
 
 
275
    conffile = os.path.join(confdir, 'ivle.conf')
 
276
 
 
277
    # Get command-line arguments to avoid asking questions.
 
278
 
 
279
    optnames = []
 
280
    for opt in config_options:
 
281
        optnames.append(opt.option_name + "=")
 
282
    (opts, args) = getopt.gnu_getopt(args, "", optnames)
 
283
 
 
284
    if args != []:
 
285
        print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
 
286
        return 2
 
287
 
 
288
    if opts == []:
 
289
        # Interactive mode. Prompt the user for all the values.
 
290
 
 
291
        print """This tool will create %s, prompting you for details about
 
292
your configuration. The file will be updated with modified options if it already
 
293
exists. If it does not already exist, it will be created with sane defaults and
 
294
restrictive permissions.
 
295
 
 
296
Please hit Ctrl+C now if you do not wish to do this.
 
297
""" % conffile
 
298
 
 
299
        # Get information from the administrator
 
300
        # If EOF is encountered at any time during the questioning, just exit
 
301
        # silently
 
302
 
 
303
        for opt in config_options:
 
304
            if opt.ask:
 
305
                conf.set_by_path(opt.option_name,
 
306
                    query_user(conf.get_by_path(opt.option_name), opt.prompt))
 
307
    else:
 
308
        opts = dict(opts)
 
309
        # Non-interactive mode. Parse the options.
 
310
        for opt in config_options:
 
311
            if '--' + opt.option_name in opts:
 
312
                conf.set_by_path(opt.option_name,
 
313
                                 opts['--' + opt.option_name])
 
314
 
 
315
    # Error handling on input values
 
316
    try:
 
317
        conf['database']['port'] = int(conf['database']['port'])
 
318
        if (conf['database']['port'] < 0
 
319
            or conf['database']['port'] >= 65536):
 
320
            raise ValueError()
 
321
    except ValueError:
 
322
        print >>sys.stderr, (
 
323
        "Invalid DB port (%s).\n"
 
324
        "Must be an integer between 0 and 65535." %
 
325
            repr(conf['database']['port']))
 
326
        return 1
 
327
    try:
 
328
        conf['usrmgt']['port'] = int(conf['usrmgt']['port'])
 
329
        if (conf['usrmgt']['port'] < 0 or conf['usrmgt']['port'] >= 65536):
 
330
            raise ValueError()
 
331
    except ValueError:
 
332
        print >>sys.stderr, (
 
333
        "Invalid user management port (%s).\n"
 
334
        "Must be an integer between 0 and 65535." %
 
335
            repr(conf['usrmgt']['port']))
 
336
        return 1
 
337
 
 
338
    # By default we generate the magic randomly.
 
339
    try:
 
340
        conf['usrmgt']['magic']     # Throw away; just check for KeyError
 
341
    except KeyError:
 
342
        conf['usrmgt']['magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
343
 
 
344
    clobber_permissions = not os.path.exists(conffile)
 
345
 
 
346
    # Write ./etc/ivle.conf (even if we loaded from a different filename)
 
347
    conf.filename = conffile
 
348
    conf.initial_comment = ["# IVLE Configuration File"]
 
349
 
 
350
    try:
 
351
        conf['plugins']['forum']['secret']
 
352
    except KeyError:
 
353
        # Generate the forum secret.
 
354
        forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
355
        conf['plugins']['forum']['secret'] = forum_secret
 
356
 
 
357
    conf.write()
 
358
 
 
359
    # We need to restrict permissions on a new file, as it contains
 
360
    # a nice database password.
 
361
    if clobber_permissions:
 
362
        os.chown(conffile, 33, 33) # chown to www-data
 
363
        os.chmod(conffile, stat.S_IRUSR | stat.S_IWUSR) # No g/o perms!
 
364
 
 
365
    print "Successfully wrote %s" % conffile
 
366
    print
 
367
    print "You may modify the configuration at any time by editing " + conffile
 
368
    
 
369
    return 0
 
370
 
 
371
def main(argv=None):
 
372
    if argv is None:
 
373
        argv = sys.argv
 
374
 
 
375
    # Print the opening spiel including the GPL notice
 
376
 
 
377
    print """IVLE - Informatics Virtual Learning Environment Setup
 
378
Copyright (C) 2007-2009 The University of Melbourne
 
379
IVLE comes with ABSOLUTELY NO WARRANTY.
 
380
This is free software, and you are welcome to redistribute it
 
381
under certain conditions. See LICENSE.txt for details.
 
382
 
 
383
IVLE Configuration
 
384
"""
 
385
 
 
386
    return configure(argv[1:])
 
387
 
 
388
if __name__ == "__main__":
 
389
    sys.exit(main())