← Back to branch summary

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

« back to all changes in this revision

Viewing changes to bin/ivle-config

Remove phpBB3 configuration from ivle-config.

Now the only forum-related thing in the main IVLE configuration is the forum
secret. That also now persists across configurations, rather than being
clobbered.

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 hashlib
 
33
import uuid
 
34
 
 
35
import ivle.config
 
36
 
 
37
import configobj
 
38
 
 
39
class ConfigOption:
 
40
    """A configuration option; one of the things written to conf.py."""
 
41
    def __init__(self, option_name, default, prompt, comment, ask=True):
 
42
        """Creates a configuration option.
 
43
        option_name: Name of the variable in conf.py. Also name of the
 
44
            command-line argument to setup.py conf.
 
45
        default: Default value for this variable.
 
46
        prompt: (Short) string presented during the interactive prompt in
 
47
            setup.py conf.
 
48
        comment: (Long) comment string stored in conf.py. Each line of this
 
49
            string should begin with a '#'.
 
50
        ask: Whether to ask the question in the default config run.
 
51
        """
 
52
        self.option_name = option_name
 
53
        self.default = default
 
54
        self.prompt = prompt
 
55
        self.comment = comment
 
56
        self.ask = ask
 
57
 
 
58
# Configuration options, defaults and descriptions
 
59
config_options = []
 
60
 
 
61
config_options.append(ConfigOption("urls/root", "/",
 
62
    """Root directory where IVLE is located (in URL space):""",
 
63
    """
 
64
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
 
65
# with this).
 
66
# eg. "/" or "/ivle".""", ask=False))
 
67
 
 
68
config_options.append(ConfigOption("paths/prefix", "/usr/local",
 
69
    """In the local file system, the prefix to the system directory where IVLE
 
70
is installed. (This should either be /usr or /usr/local):""",
 
71
    """
 
72
# In the local file system, the prefix to the system directory where IVLE is
 
73
# installed. This should either be '/usr' or '/usr/local'.
 
74
# ('/usr/local' for the usual install, '/usr' for distribution packages)""",
 
75
    ask=False))
 
76
 
 
77
config_options.append(ConfigOption("paths/site_packages",
 
78
    None,
 
79
    """site-packages directory in Python, where Python libraries are to be
 
80
installed. May be left as the default, in which case the value will be
 
81
computed from prefix and the current Python version:""",
 
82
    """
 
83
# 'site-packages' directory in Python, where Python libraries are to be
 
84
# installed. May be omitted (recommended), in which case the value will be
 
85
# computed from prefix and the current Python version.""", ask=False))
 
86
 
 
87
config_options.append(ConfigOption("paths/data",
 
88
    "/var/lib/ivle",
 
89
    "In the local file system, where user-modifiable data files should be "
 
90
    "located:",
 
91
    """
 
92
# In the local file system, where user-modifiable data files should be
 
93
# located.""", ask=False))
 
94
 
 
95
config_options.append(ConfigOption("paths/logs",
 
96
    "/var/log/ivle",
 
97
    """Directory where IVLE log files are stored (on the local
 
98
file system). Note - this must be writable by the user the IVLE server 
 
99
process runs as (usually www-data):""",
 
100
    """
 
101
# In the local file system, where IVLE error logs should be located.""",
 
102
    ask=False))
 
103
 
 
104
config_options.append(ConfigOption("urls/public_host", "public.localhost",
 
105
    """Hostname which will cause the server to go into "public mode",
 
106
providing login-free access to student's published work:""",
 
107
    """
 
108
# The server goes into "public mode" if the browser sends a request with this
 
109
# host. This is for security reasons - we only serve public student files on a
 
110
# separate domain to the main IVLE site.
 
111
# Public mode does not use cookies, and serves only public content.
 
112
# Private mode (normal mode) requires login, and only serves files relevant to
 
113
# the logged-in user."""))
 
114
 
 
115
config_options.append(ConfigOption("database/host", "localhost",
 
116
    """PostgreSQL Database config
 
117
==========================
 
118
Hostname of the DB server:""",
 
119
    """
 
120
# Database server hostname"""))
 
121
 
 
122
config_options.append(ConfigOption("database/port", "5432",
 
123
    """Port of the DB server:""",
 
124
    """
 
125
# Database server port"""))
 
126
 
 
127
config_options.append(ConfigOption("database/name", "ivle",
 
128
    """Database name:""",
 
129
    """
 
130
# Database name"""))
 
131
 
 
132
config_options.append(ConfigOption("database/username", "postgres",
 
133
    """Username for DB server login:""",
 
134
    """
 
135
# Database username"""))
 
136
 
 
137
config_options.append(ConfigOption("database/password", "",
 
138
    """Password for DB server login:
 
139
    (Caution: This password is stored in plaintext in ivle/conf/conf.py)""",
 
140
    """
 
141
# Database password"""))
 
142
 
 
143
config_options.append(ConfigOption("auth/modules", "",
 
144
    """Authentication config
 
145
=====================
 
146
Comma-separated list of authentication modules.""",
 
147
    """
 
148
# Comma-separated list of authentication modules.
 
149
# Note that auth is always enabled against the local database, and NO OTHER
 
150
# auth is enabled by default. This section is for specifying additional auth
 
151
# modules.
 
152
# These refer to importable Python modules in the www/auth directory.
 
153
# Modules "ldap_auth" and "guest" are available in the source tree, but
 
154
# other modules may be plugged in to auth against organisation-specific
 
155
# auth backends.""", ask=False))
 
156
 
 
157
config_options.append(ConfigOption("auth/ldap_url", "ldaps://www.example.com",
 
158
    """(LDAP options are only relevant if "ldap" is included in the list of
 
159
auth modules).
 
160
URL for LDAP authentication server:""",
 
161
    """
 
162
# URL for LDAP authentication server""", ask=False))
 
163
 
 
164
config_options.append(ConfigOption("auth/ldap_format_string",
 
165
    "uid=%s,ou=users,o=example",
 
166
    """Format string for LDAP auth request:
 
167
    (Must contain a single "%s" for the user's login name)""",
 
168
    """
 
169
# Format string for LDAP auth request
 
170
# (Must contain a single "%s" for the user's login name)""", ask=False))
 
171
 
 
172
config_options.append(ConfigOption("auth/subject_pulldown_modules", "",
 
173
    """Comma-separated list of subject pulldown modules.
 
174
Add proprietary modules to automatically enrol students in subjects.""",
 
175
    """
 
176
# Comma-separated list of subject pulldown modules.
 
177
# These refer to importable Python modules in the lib/pulldown_subj directory.
 
178
# Only "dummy_subj" is available in the source tree (an example), but
 
179
# other modules may be plugged in to pulldown against organisation-specific
 
180
# pulldown backends.""", ask=False))
 
181
 
 
182
config_options.append(ConfigOption("urls/svn_addr", "http://svn.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
def query_user(default, prompt):
 
207
    """Prompts the user for a string, which is read from a line of stdin.
 
208
    Exits silently if EOF is encountered. Returns the string, with spaces
 
209
    removed from the beginning and end.
 
210
 
 
211
    Returns default if a 0-length line (after spaces removed) was read.
 
212
    """
 
213
    if default is None:
 
214
        # A default of None means the value will be computed specially, so we
 
215
        # can't really tell you what it is
 
216
        defaultstr = "computed"
 
217
    elif isinstance(default, basestring):
 
218
        defaultstr = '"%s"' % default
 
219
    else:
 
220
        defaultstr = repr(default)
 
221
    sys.stdout.write('%s\n    (default: %s)\n>' % (prompt, defaultstr))
 
222
    try:
 
223
        val = sys.stdin.readline()
 
224
    except KeyboardInterrupt:
 
225
        # Ctrl+C
 
226
        sys.stdout.write("\n")
 
227
        sys.exit(1)
 
228
    sys.stdout.write("\n")
 
229
    # If EOF, exit
 
230
    if val == '': sys.exit(1)
 
231
    # If empty line, return default
 
232
    val = val.strip()
 
233
    if val == '': return default
 
234
    return val
 
235
 
 
236
def configure(args):
 
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.
 
241
    try:
 
242
        conf = ivle.config.Config()
 
243
    except ivle.config.ConfigError:
 
244
        # Couldn't find a config file anywhere.
 
245
        # Create a new blank config object (not yet bound to a file)
 
246
        # All lookups (below) will fail, so it will be initialised with all
 
247
        # the default values.
 
248
        conf = ivle.config.Config(blank=True)
 
249
 
 
250
    # Check that all the options are present, and if not, load the default
 
251
    for opt in config_options:
 
252
        try:
 
253
            conf.get_by_path(opt.option_name)
 
254
        except KeyError:
 
255
            # If the default is None, omit it
 
256
            # Else ConfigObj will write the string 'None' to the conf file
 
257
            if opt.default is not None:
 
258
                conf.set_by_path(opt.option_name, opt.default)
 
259
 
 
260
    # Store comments in the conf object
 
261
    for opt in config_options:
 
262
        # Omitted if the key doesn't exist
 
263
        conf.set_by_path(opt.option_name, comment=opt.comment)
 
264
 
 
265
    # Set up some variables
 
266
    cwd = os.getcwd()
 
267
 
 
268
    # the files that will be created/overwritten
 
269
    conffile = os.path.join(cwd, "etc/ivle.conf")
 
270
 
 
271
    # Get command-line arguments to avoid asking questions.
 
272
 
 
273
    optnames = []
 
274
    for opt in config_options:
 
275
        optnames.append(opt.option_name + "=")
 
276
    (opts, args) = getopt.gnu_getopt(args, "", optnames)
 
277
 
 
278
    if args != []:
 
279
        print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
 
280
        return 2
 
281
 
 
282
    if opts == []:
 
283
        # Interactive mode. Prompt the user for all the values.
 
284
 
 
285
        print """This tool will create %s, prompting you for details about
 
286
your configuration. The file will be overwritten if it already exists.
 
287
 
 
288
Please hit Ctrl+C now if you do not wish to do this.
 
289
""" % conffile
 
290
 
 
291
        # Get information from the administrator
 
292
        # If EOF is encountered at any time during the questioning, just exit
 
293
        # silently
 
294
 
 
295
        for opt in config_options:
 
296
            if opt.ask:
 
297
                conf.set_by_path(opt.option_name,
 
298
                    query_user(conf.get_by_path(opt.option_name), opt.prompt))
 
299
    else:
 
300
        opts = dict(opts)
 
301
        # Non-interactive mode. Parse the options.
 
302
        for opt in config_options:
 
303
            if '--' + opt.option_name in opts:
 
304
                conf.set_by_path(opt.option_name,
 
305
                                 opts['--' + opt.option_name])
 
306
 
 
307
    # Error handling on input values
 
308
    try:
 
309
        conf['database']['port'] = int(conf['database']['port'])
 
310
        if (conf['database']['port'] < 0
 
311
            or conf['database']['port'] >= 65536):
 
312
            raise ValueError()
 
313
    except ValueError:
 
314
        print >>sys.stderr, (
 
315
        "Invalid DB port (%s).\n"
 
316
        "Must be an integer between 0 and 65535." %
 
317
            repr(conf['database']['port']))
 
318
        return 1
 
319
    try:
 
320
        conf['usrmgt']['port'] = int(conf['usrmgt']['port'])
 
321
        if (conf['usrmgt']['port'] < 0 or conf['usrmgt']['port'] >= 65536):
 
322
            raise ValueError()
 
323
    except ValueError:
 
324
        print >>sys.stderr, (
 
325
        "Invalid user management port (%s).\n"
 
326
        "Must be an integer between 0 and 65535." %
 
327
            repr(conf['usrmgt']['port']))
 
328
        return 1
 
329
 
 
330
    # By default we generate the magic randomly.
 
331
    try:
 
332
        conf['usrmgt']['magic']     # Throw away; just check for KeyError
 
333
    except KeyError:
 
334
        conf['usrmgt']['magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
335
 
 
336
 
 
337
    # Write ./etc/ivle.conf (even if we loaded from a different filename)
 
338
    conf.filename = conffile
 
339
 
 
340
    conf.initial_comment = ["# IVLE Configuration File"]
 
341
 
 
342
    try:
 
343
        conf['plugins']['forum']['secret']
 
344
    except KeyError:
 
345
        # Generate the forum secret.
 
346
        forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
347
        conf['plugins']['forum']['secret'] = forum_secret
 
348
 
 
349
    conf.write()
 
350
 
 
351
    print "Successfully wrote %s" % conffile
 
352
    print
 
353
    print "You may modify the configuration at any time by editing " + conffile
 
354
    
 
355
    return 0
 
356
 
 
357
def main(argv=None):
 
358
    if argv is None:
 
359
        argv = sys.argv
 
360
 
 
361
    # Print the opening spiel including the GPL notice
 
362
 
 
363
    print """IVLE - Informatics Virtual Learning Environment Setup
 
364
Copyright (C) 2007-2009 The University of Melbourne
 
365
IVLE comes with ABSOLUTELY NO WARRANTY.
 
366
This is free software, and you are welcome to redistribute it
 
367
under certain conditions. See LICENSE.txt for details.
 
368
 
 
369
IVLE Configuration
 
370
"""
 
371
 
 
372
    return configure(argv[1:])
 
373
 
 
374
if __name__ == "__main__":
 
375
    sys.exit(main())