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

« back to all changes in this revision

Viewing changes to bin/ivle-config

MergeĀ fromĀ trunk.

Show diffs side-by-side

added added

removed removed

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