← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/configure.py

setup.configure: Removed "###" major heading comment generated into ivle.conf
    (no longer needed due to actual headings).

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup/configure.py
1
1
# IVLE - Informatics Virtual Learning Environment
2
 
# Copyright (C) 2007-2008 The University of Melbourne
 
2
# Copyright (C) 2007-2009 The University of Melbourne
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
19
19
# Author: Matt Giuca, Refactored by David Coles
20
20
# Date:   03/07/2008
21
21
 
22
 
# setup/config.py
23
 
# Configures IVLE with machine-specific details, most notably, various paths.
24
 
# Either prompts the administrator for these details or accepts them as
25
 
# command-line args.
26
 
# Creates lib/conf/conf.py and trampoline/conf.h.
 
22
'''Configures IVLE with machine-specific details, most notably, various paths.
 
23
Either prompts the administrator for these details or accepts them as
 
24
command-line args.
 
25
 
 
26
Creates ivle/conf/conf.py and bin/trampoline/trampoline/conf.h.
 
27
'''
27
28
 
28
29
import optparse
29
30
import getopt
31
32
import sys
32
33
import hashlib
33
34
import uuid
34
 
from setup.setuputil import query_user
 
35
 
 
36
from setup.util import query_user
 
37
 
 
38
import configobj
 
39
 
 
40
# This dict maps legacy config option names to new config option paths
 
41
# ('section/option_name')
 
42
# NOTE: This is copied from ivle/conf/conf.py (because neither of these files
 
43
# can see each other).
 
44
CONFIG_OPTIONS = {
 
45
    'root_dir': 'urls/root',
 
46
    'prefix': 'paths/prefix',
 
47
    'data_path': 'paths/data',
 
48
    'log_path': 'paths/logs',
 
49
    'python_site_packages_override': 'paths/site_packages',
 
50
    'public_host': 'urls/public_host',
 
51
    'allowed_uids': 'os/allowed_uids',
 
52
    'db_host': 'database/host',
 
53
    'db_port': 'database/port',
 
54
    'db_dbname': 'database/name',
 
55
    'db_forumdbname': 'plugins/forum/dbname',
 
56
    'db_user': 'database/username',
 
57
    'db_password': 'database/password',
 
58
    'auth_modules': 'auth/modules',
 
59
    'ldap_url': 'auth/ldap_url',
 
60
    'ldap_format_string': 'auth/ldap_format_string',
 
61
    'subject_pulldown_modules': 'auth/subject_pulldown_modules',
 
62
    'svn_addr': 'urls/svn_addr',
 
63
    'usrmgt_host': 'usrmgt/host',
 
64
    'usrmgt_port': 'usrmgt/port',
 
65
    'usrmgt_magic': 'usrmgt/magic',
 
66
    'forum_secret': 'plugins/forum/secret',
 
67
}
35
68
 
36
69
class ConfigOption:
37
70
    """A configuration option; one of the things written to conf.py."""
38
 
    def __init__(self, option_name, default, prompt, comment):
 
71
    def __init__(self, option_name, default, prompt, comment, ask=True):
39
72
        """Creates a configuration option.
40
73
        option_name: Name of the variable in conf.py. Also name of the
41
74
            command-line argument to setup.py conf.
44
77
            setup.py conf.
45
78
        comment: (Long) comment string stored in conf.py. Each line of this
46
79
            string should begin with a '#'.
 
80
        ask: Whether to ask the question in the default config run.
47
81
        """
48
82
        self.option_name = option_name
49
83
        self.default = default
50
84
        self.prompt = prompt
51
85
        self.comment = comment
 
86
        self.ask = ask
52
87
 
53
88
# Configuration options, defaults and descriptions
54
89
config_options = []
 
90
 
55
91
config_options.append(ConfigOption("root_dir", "/",
56
92
    """Root directory where IVLE is located (in URL space):""",
57
93
    """
58
94
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
59
95
# with this).
60
 
# eg. "/" or "/ivle"."""))
61
 
config_options.append(ConfigOption("ivle_install_dir", "/opt/ivle",
62
 
    'Root directory where IVLE will be installed (on the local file '
63
 
    'system):',
64
 
    """
65
 
# In the local file system, where IVLE is actually installed.
66
 
# This directory should contain the "www" and "bin" directories."""))
67
 
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
68
 
    """Location of jail mountpoints
69
 
============================
70
 
Root directory where the user jails will be mounted, and the non-user
71
 
components of the jails will be stored (on the local file system):""",
72
 
    """
73
 
# In the local file system, where the student/user jails will be mounted.
74
 
# Only a single copy of the jail's system components will be stored here -
75
 
# all user jails will be virtually mounted here."""))
76
 
config_options.append(ConfigOption("jail_system", "/home/informatics/jails/__base__",
77
 
    """Location of system jail components
78
 
==================================
79
 
Directory where the template system jail will be stored.""",
80
 
    """
81
 
# In the local file system, where the template system jail will be stored."""))
82
 
config_options.append(ConfigOption("jail_src_base", "/home/informatics/jailssrc",
83
 
    """Location of user jail components
84
 
================================
85
 
Root directory where the user components of the jails will be stored (on the
86
 
local file system):""",
87
 
    """
88
 
# In the local file system, where are the student/user file spaces located.
89
 
# The user jails are expected to be located immediately in subdirectories of
90
 
# this location. Note that no complete jails reside here - only user
91
 
# modifications."""))
92
 
config_options.append(ConfigOption("subjects_base",
93
 
    "/home/informatics/subjects",
94
 
    """Root directory where the subject directories (containing worksheets
95
 
and other per-subject files) are stored (on the local file system):""",
96
 
    """
97
 
# In the local file system, where are the per-subject file spaces located.
98
 
# The individual subject directories are expected to be located immediately
99
 
# in subdirectories of this location."""))
100
 
config_options.append(ConfigOption("exercises_base",
101
 
    "/home/informatics/exercises",
102
 
    """Root directory where the exercise directories (containing
103
 
subject-independent exercise sheets) are stored (on the local file
104
 
system):""",
105
 
    """
106
 
# In the local file system, where are the subject-independent exercise sheet
107
 
# file spaces located."""))
108
 
config_options.append(ConfigOption("tos_path",
109
 
    "/home/informatics/tos.html",
110
 
    """Location where the Terms of Service document is stored (on the local
111
 
    file system):""",
112
 
    """
113
 
# In the local file system, where is the Terms of Service document located."""))
114
 
config_options.append(ConfigOption("motd_path",
115
 
    "/home/informatics/motd.html",
116
 
    """Location where the Message of the Day document is stored (on the local
117
 
    file system):""",
118
 
    """
119
 
# In the local file system, where is the Message of the Day document
120
 
# located. This is an HTML file (just the body fragment), which will
121
 
# be displayed on the login page. It is optional."""))
 
96
# eg. "/" or "/ivle".""", ask=False))
 
97
 
 
98
config_options.append(ConfigOption("prefix", "/usr/local",
 
99
    """In the local file system, the prefix to the system directory where IVLE
 
100
is installed. (This should either be /usr or /usr/local):""",
 
101
    """
 
102
# In the local file system, the prefix to the system directory where IVLE is
 
103
# installed. This should either be '/usr' or '/usr/local'.
 
104
# ('/usr/local' for the usual install, '/usr' for distribution packages)""",
 
105
    ask=False))
 
106
 
 
107
config_options.append(ConfigOption("python_site_packages_override",
 
108
    None,
 
109
    """site-packages directory in Python, where Python libraries are to be
 
110
installed. May be left as the default, in which case the value will be
 
111
computed from prefix and the current Python version:""",
 
112
    """
 
113
# 'site-packages' directory in Python, where Python libraries are to be
 
114
# installed. May be None (recommended), in which case the value will be
 
115
# computed from prefix and the current Python version.""", ask=False))
 
116
 
 
117
config_options.append(ConfigOption("data_path",
 
118
    "/var/lib/ivle",
 
119
    "In the local file system, where user-modifiable data files should be "
 
120
    "located:",
 
121
    """
 
122
# In the local file system, where user-modifiable data files should be
 
123
# located.""", ask=False))
 
124
 
 
125
config_options.append(ConfigOption("log_path",
 
126
    "/var/log/ivle",
 
127
    """Directory where IVLE log files are stored (on the local
 
128
file system). Note - this must be writable by the user the IVLE server 
 
129
process runs as (usually www-data):""",
 
130
    """
 
131
# In the local file system, where IVLE error logs should be located.""",
 
132
    ask=False))
 
133
 
122
134
config_options.append(ConfigOption("public_host", "public.localhost",
123
135
    """Hostname which will cause the server to go into "public mode",
124
136
providing login-free access to student's published work:""",
129
141
# Public mode does not use cookies, and serves only public content.
130
142
# Private mode (normal mode) requires login, and only serves files relevant to
131
143
# the logged-in user."""))
 
144
 
132
145
config_options.append(ConfigOption("allowed_uids", "33",
133
146
    """UID of the web server process which will run IVLE.
134
147
Only this user may execute the trampoline. May specify multiple users as
138
151
# The User-ID of the web server process which will run IVLE, and any other
139
152
# users who are allowed to run the trampoline. This is stores as a string of
140
153
# comma-separated integers, simply because it is not used within Python, only
141
 
# used by the setup program to write to conf.h (see setup.py config)."""))
 
154
# used by the setup program to write to conf.h (see setup.py config).""",
 
155
    ask=False))
 
156
 
142
157
config_options.append(ConfigOption("db_host", "localhost",
143
158
    """PostgreSQL Database config
144
159
==========================
145
160
Hostname of the DB server:""",
146
161
    """
147
 
### PostgreSQL Database config ###
148
162
# Database server hostname"""))
 
163
 
149
164
config_options.append(ConfigOption("db_port", "5432",
150
165
    """Port of the DB server:""",
151
166
    """
152
167
# Database server port"""))
 
168
 
153
169
config_options.append(ConfigOption("db_dbname", "ivle",
154
170
    """Database name:""",
155
171
    """
156
172
# Database name"""))
 
173
 
157
174
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
158
175
    """Forum Database name:""",
159
176
    """
160
177
# Forum Database name"""))
 
178
 
161
179
config_options.append(ConfigOption("db_user", "postgres",
162
180
    """Username for DB server login:""",
163
181
    """
164
182
# Database username"""))
 
183
 
165
184
config_options.append(ConfigOption("db_password", "",
166
185
    """Password for DB server login:
167
 
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
 
186
    (Caution: This password is stored in plaintext in ivle/conf/conf.py)""",
168
187
    """
169
188
# Database password"""))
170
 
config_options.append(ConfigOption("auth_modules", "ldap_auth",
 
189
 
 
190
config_options.append(ConfigOption("auth_modules", "",
171
191
    """Authentication config
172
192
=====================
173
 
Comma-separated list of authentication modules. Only "ldap" is available
174
 
by default.""",
 
193
Comma-separated list of authentication modules.""",
175
194
    """
176
195
# Comma-separated list of authentication modules.
 
196
# Note that auth is always enabled against the local database, and NO OTHER
 
197
# auth is enabled by default. This section is for specifying additional auth
 
198
# modules.
177
199
# These refer to importable Python modules in the www/auth directory.
178
 
# Modules "ldap" and "guest" are available in the source tree, but
 
200
# Modules "ldap_auth" and "guest" are available in the source tree, but
179
201
# other modules may be plugged in to auth against organisation-specific
180
 
# auth backends."""))
 
202
# auth backends.""", ask=False))
 
203
 
181
204
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
182
205
    """(LDAP options are only relevant if "ldap" is included in the list of
183
206
auth modules).
184
207
URL for LDAP authentication server:""",
185
208
    """
186
 
# URL for LDAP authentication server"""))
 
209
# URL for LDAP authentication server""", ask=False))
 
210
 
187
211
config_options.append(ConfigOption("ldap_format_string",
188
212
    "uid=%s,ou=users,o=example",
189
213
    """Format string for LDAP auth request:
190
214
    (Must contain a single "%s" for the user's login name)""",
191
215
    """
192
216
# Format string for LDAP auth request
193
 
# (Must contain a single "%s" for the user's login name)"""))
 
217
# (Must contain a single "%s" for the user's login name)""", ask=False))
 
218
 
194
219
config_options.append(ConfigOption("subject_pulldown_modules", "",
195
220
    """Comma-separated list of subject pulldown modules.
196
221
Add proprietary modules to automatically enrol students in subjects.""",
199
224
# These refer to importable Python modules in the lib/pulldown_subj directory.
200
225
# Only "dummy_subj" is available in the source tree (an example), but
201
226
# other modules may be plugged in to pulldown against organisation-specific
202
 
# pulldown backends."""))
 
227
# pulldown backends.""", ask=False))
 
228
 
203
229
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
204
230
    """Subversion config
205
231
=================
206
232
The base url for accessing subversion repositories:""",
207
233
    """
208
234
# The base url for accessing subversion repositories."""))
209
 
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
210
 
    """The location of the subversion configuration file used by apache
211
 
to host the user repositories:""",
212
 
    """
213
 
# The location of the subversion configuration file used by
214
 
# apache to host the user repositories."""))
215
 
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
216
 
    """The root directory for the subversion repositories:""",
217
 
    """
218
 
# The root directory for the subversion repositories."""))
219
 
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
220
 
    """The location of the password file used to authenticate users
221
 
of the subversion repository from the ivle server:""",
222
 
    """
223
 
# The location of the password file used to authenticate users
224
 
# of the subversion repository from the ivle server."""))
225
 
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
226
 
    """The location of the password file used to authenticate local users
227
 
of the subversion repository:""",
228
 
    """
229
 
# The location of the password file used to authenticate local users
230
 
# of the subversion repository."""))
 
235
 
231
236
config_options.append(ConfigOption("usrmgt_host", "localhost",
232
237
    """User Management Server config
233
238
============================
234
239
The hostname where the usrmgt-server runs:""",
235
240
    """
236
241
# The hostname where the usrmgt-server runs."""))
 
242
 
237
243
config_options.append(ConfigOption("usrmgt_port", "2178",
238
244
    """The port where the usrmgt-server runs:""",
239
245
    """
240
 
# The port where the usrmgt-server runs."""))
241
 
config_options.append(ConfigOption("usrmgt_magic", "",
 
246
# The port where the usrmgt-server runs.""", ask=False))
 
247
 
 
248
config_options.append(ConfigOption("usrmgt_magic", None,
242
249
    """The password for the usrmgt-server:""",
243
250
    """
244
 
# The password for the usrmgt-server."""))
 
251
# The password for the usrmgt-server.""", ask=False))
245
252
 
246
253
def configure(args):
247
 
    usage = """usage: %prog build [options]
248
 
(requires root)
249
 
Compiles all files and sets up a jail template in the source directory.
250
 
-O is recommended to cause compilation to be optimised.
251
 
Details:
252
 
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
253
 
Creates jail with system and student packages installed from MIRROR.
254
 
Copies console/ to a location within the jail.
255
 
Copies OS programs and files to corresponding locations within the jail
256
 
  (eg. python and Python libs, ld.so, etc).
257
 
Generates .pyc or .pyo files for all the IVLE .py files."""
258
 
 
259
 
    # Parse arguments
260
 
    parser = optparse.OptionParser(usage)
261
 
    (options, args) = parser.parse_args(args)
262
 
 
263
254
    # Call the real function
264
 
    __configure(args)
 
255
    return __configure(args)
265
256
 
266
257
def __configure(args):
267
258
    global db_port, usrmgt_port
271
262
    # of setup besides conf, so we need to know them.
272
263
    # Also this allows you to hit Return to accept the existing value.
273
264
    try:
274
 
        confmodule = __import__("lib/conf/conf")
 
265
        confmodule = __import__("ivle/conf/conf")
275
266
        for opt in config_options:
276
267
            try:
277
268
                globals()[opt.option_name] = \
287
278
    cwd = os.getcwd()
288
279
 
289
280
    # the files that will be created/overwritten
290
 
    conffile = os.path.join(cwd, "lib/conf/conf.py")
291
 
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
292
 
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
 
281
    conffile = os.path.join(cwd, "etc/ivle.conf")
 
282
    conf_hfile = os.path.join(cwd, "bin/trampoline/conf.h")
293
283
    phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
294
 
    usrmgtserver_initdfile = os.path.join(cwd, "doc/setup/usrmgt-server.init")
295
284
 
296
285
    # Get command-line arguments to avoid asking questions.
297
286
 
311
300
    %s
312
301
    %s
313
302
    %s
314
 
    %s
315
 
    %s
316
303
prompting you for details about your configuration. The file will be
317
304
overwritten if it already exists. It will *not* install or deploy IVLE.
318
305
 
319
306
Please hit Ctrl+C now if you do not wish to do this.
320
 
""" % (conffile, jailconffile, conf_hfile, phpBBconffile, usrmgtserver_initdfile)
 
307
""" % (conffile, conf_hfile, phpBBconffile)
321
308
 
322
309
        # Get information from the administrator
323
310
        # If EOF is encountered at any time during the questioning, just exit
324
311
        # silently
325
312
 
326
313
        for opt in config_options:
327
 
            globals()[opt.option_name] = \
328
 
                query_user(globals()[opt.option_name], opt.prompt)
 
314
            if opt.ask:
 
315
                globals()[opt.option_name] = \
 
316
                    query_user(globals()[opt.option_name], opt.prompt)
329
317
    else:
330
318
        opts = dict(opts)
331
319
        # Non-interactive mode. Parse the options.
358
346
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
359
347
        return 1
360
348
 
 
349
    # By default we generate the magic randomly.
 
350
    if globals()['usrmgt_magic'] is None:
 
351
        globals()['usrmgt_magic'] = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
352
 
361
353
    # Generate the forum secret
362
354
    forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
363
355
 
364
 
    # Write lib/conf/conf.py
365
 
 
366
 
    try:
367
 
        conf = open(conffile, "w")
368
 
 
369
 
        conf.write("""# IVLE Configuration File
370
 
# conf.py
371
 
# Miscellaneous application settings
372
 
 
373
 
""")
374
 
        for opt in config_options:
375
 
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
376
 
                repr(globals()[opt.option_name])))
377
 
 
378
 
        # Add the forum secret to the config file (regenerated each config)
379
 
        conf.write('forum_secret = "%s"\n' % (forum_secret))
380
 
 
381
 
        conf.close()
382
 
    except IOError, (errno, strerror):
383
 
        print "IO error(%s): %s" % (errno, strerror)
384
 
        sys.exit(1)
385
 
 
386
 
    print "Successfully wrote lib/conf/conf.py"
387
 
 
388
 
    # Write conf/jailconf.py
389
 
 
390
 
    try:
391
 
        conf = open(jailconffile, "w")
392
 
 
393
 
        # In the "in-jail" version of conf, we don't need MOST of the details
394
 
        # (it would be a security risk to have them here).
395
 
        # So we just write root_dir, and jail_base is "/".
396
 
        # (jail_base being "/" means "jail-relative" paths are relative to "/"
397
 
        # when inside the jail.)
398
 
        conf.write("""# IVLE Configuration File
399
 
# conf.py
400
 
# Miscellaneous application settings
401
 
# (User jail version)
402
 
 
403
 
 
404
 
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
405
 
# with this).
406
 
# eg. "/" or "/ivle".
407
 
root_dir = %s
408
 
 
409
 
# In the local file system, where are the student/user file spaces located.
410
 
# The user jails are expected to be located immediately in subdirectories of
411
 
# this location.
412
 
jail_base = '/'
413
 
 
414
 
# The hostname for serving publicly accessible pages
415
 
public_host = %s
416
 
""" % (repr(root_dir),repr(public_host)))
417
 
 
418
 
        conf.close()
419
 
    except IOError, (errno, strerror):
420
 
        print "IO error(%s): %s" % (errno, strerror)
421
 
        sys.exit(1)
422
 
 
423
 
    print "Successfully wrote lib/conf/jailconf.py"
424
 
 
425
 
    # Write trampoline/conf.h
426
 
 
427
 
    try:
428
 
        conf = open(conf_hfile, "w")
429
 
 
430
 
        conf.write("""/* IVLE Configuration File
 
356
    # Write ./etc/ivle.conf
 
357
 
 
358
    conf = configobj.ConfigObj()
 
359
    conf.filename = conffile
 
360
 
 
361
    conf.initial_comment = ["# IVLE Configuration File"]
 
362
 
 
363
    # Add the forum secret to the config file (regenerated each config)
 
364
    config_options.append(ConfigOption('forum_secret', None, '', ''))
 
365
    globals()['forum_secret'] = forum_secret
 
366
 
 
367
    for legacyopt in config_options:
 
368
        newopt_path = CONFIG_OPTIONS[legacyopt.option_name].split('/')
 
369
        # Iterate over each segment of the path, and find the section in conf
 
370
        # file to insert the value into (use all but the last path segment)
 
371
        conf_section = conf
 
372
        for seg in newopt_path[:-1]:
 
373
            # Create the section if it isn't there
 
374
            if seg not in conf_section:
 
375
                conf_section[seg] = {}
 
376
            conf_section = conf_section[seg]
 
377
        # The final path segment names the key to insert into
 
378
        keyname = newopt_path[-1]
 
379
        value = globals()[legacyopt.option_name]
 
380
        if value is not None:
 
381
            conf_section[keyname] = value
 
382
            conf_section.comments[keyname] = legacyopt.comment.split('\n')
 
383
 
 
384
    conf.write()
 
385
 
 
386
    print "Successfully wrote %s" % conffile
 
387
 
 
388
    # Write bin/trampoline/conf.h
 
389
 
 
390
    conf = open(conf_hfile, "w")
 
391
 
 
392
    # XXX Compute jail_base, jail_src_base and jail_system. These will
 
393
    # ALSO be done by the boilerplate code, but we need them here in order
 
394
    # to write to the C file.
 
395
    jail_base = os.path.join(data_path, 'jailmounts')
 
396
    jail_src_base = os.path.join(data_path, 'jails')
 
397
    jail_system = os.path.join(jail_src_base, '__base__')
 
398
 
 
399
    conf.write("""/* IVLE Configuration File
431
400
 * conf.h
432
401
 * Administrator settings required by trampoline.
433
402
 * Note: trampoline will have to be rebuilt in order for changes to this file
455
424
    # However they should be the same with the exception of the outer
456
425
    # characters, which are stripped off and replaced
457
426
 
458
 
        conf.close()
459
 
    except IOError, (errno, strerror):
460
 
        print "IO error(%s): %s" % (errno, strerror)
461
 
        sys.exit(1)
 
427
    conf.close()
462
428
 
463
 
    print "Successfully wrote trampoline/conf.h"
 
429
    print "Successfully wrote %s" % conf_hfile
464
430
 
465
431
    # Write www/php/phpBB3/config.php
466
432
 
467
 
    try:
468
 
        conf = open(phpBBconffile, "w")
469
 
        
470
 
        # php-pg work around
471
 
        if db_host == 'localhost':
472
 
            forumdb_host = '127.0.0.1'
473
 
        else:
474
 
            forumdb_host = db_host
 
433
    conf = open(phpBBconffile, "w")
 
434
    
 
435
    # php-pg work around
 
436
    if db_host == 'localhost':
 
437
        forumdb_host = '127.0.0.1'
 
438
    else:
 
439
        forumdb_host = db_host
475
440
 
476
 
        conf.write( """<?php
 
441
    conf.write( """<?php
477
442
// phpBB 3.0.x auto-generated configuration file
478
443
// Do not change anything in this file!
479
444
$dbms = 'postgres';
493
458
$forum_secret = '""" + forum_secret +"""';
494
459
?>"""   )
495
460
    
496
 
        conf.close()
497
 
    except IOError, (errno, strerror):
498
 
        print "IO error(%s): %s" % (errno, strerror)
499
 
        sys.exit(1)
500
 
 
501
 
    print "Successfully wrote www/php/phpBB3/config.php"
502
 
 
503
 
    # Write lib/conf/usrmgt-server.init
504
 
 
505
 
    try:
506
 
        conf = open(usrmgtserver_initdfile, "w")
507
 
 
508
 
        conf.write( '''#! /bin/sh
509
 
 
510
 
# Works for Ubuntu. Check before using on other distributions
511
 
 
512
 
### BEGIN INIT INFO
513
 
# Provides:          usrmgt-server
514
 
# Required-Start:    $syslog $networking $urandom
515
 
# Required-Stop:     $syslog
516
 
# Default-Start:     2 3 4 5
517
 
# Default-Stop:      1
518
 
# Short-Description: IVLE user management server
519
 
# Description:       Daemon connecting to the IVLE user management database.
520
 
### END INIT INFO
521
 
 
522
 
PATH=/sbin:/bin:/usr/sbin:/usr/bin
523
 
DESC="IVLE user management server"
524
 
NAME=usrmgt-server
525
 
DAEMON=/opt/ivle/scripts/$NAME
526
 
DAEMON_ARGS="''' + str(usrmgt_port) + ''' ''' + usrmgt_magic + '''"
527
 
PIDFILE=/var/run/$NAME.pid
528
 
SCRIPTNAME=/etc/init.d/usrmgt-server
529
 
 
530
 
# Exit if the daemon does not exist 
531
 
test -f $DAEMON || exit 0
532
 
 
533
 
# Load the VERBOSE setting and other rcS variables
534
 
[ -f /etc/default/rcS ] && . /etc/default/rcS
535
 
 
536
 
# Define LSB log_* functions.
537
 
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
538
 
. /lib/lsb/init-functions
539
 
 
540
 
#
541
 
# Function that starts the daemon/service
542
 
#
543
 
do_start()
544
 
{
545
 
        # Return
546
 
        #   0 if daemon has been started
547
 
        #   1 if daemon was already running
548
 
        #   2 if daemon could not be started
549
 
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
550
 
                || return 1
551
 
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
552
 
                $DAEMON_ARGS \
553
 
                || return 2
554
 
        # Add code here, if necessary, that waits for the process to be ready
555
 
        # to handle requests from services started subsequently which depend
556
 
        # on this one.  As a last resort, sleep for some time.
557
 
}
558
 
 
559
 
#
560
 
# Function that stops the daemon/service
561
 
#
562
 
do_stop()
563
 
{
564
 
        # Return
565
 
        #   0 if daemon has been stopped
566
 
        #   1 if daemon was already stopped
567
 
        #   2 if daemon could not be stopped
568
 
        #   other if a failure occurred
569
 
        start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
570
 
        RETVAL="$?"
571
 
        [ "$RETVAL" = 2 ] && return 2
572
 
        # Wait for children to finish too if this is a daemon that forks
573
 
        # and if the daemon is only ever run from this initscript.
574
 
        # If the above conditions are not satisfied then add some other code
575
 
        # that waits for the process to drop all resources that could be
576
 
        # needed by services started subsequently.  A last resort is to
577
 
        # sleep for some time.
578
 
        start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
579
 
        [ "$?" = 2 ] && return 2
580
 
        # Many daemons don't delete their pidfiles when they exit.
581
 
        rm -f $PIDFILE
582
 
        return "$RETVAL"
583
 
}
584
 
 
585
 
#
586
 
# Function that sends a SIGHUP to the daemon/service
587
 
#
588
 
do_reload() {
589
 
        #
590
 
        # If the daemon can reload its configuration without
591
 
        # restarting (for example, when it is sent a SIGHUP),
592
 
        # then implement that here.
593
 
        #
594
 
        start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
595
 
        return 0
596
 
}
597
 
 
598
 
case "$1" in
599
 
  start)
600
 
    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
601
 
        do_start
602
 
        case "$?" in
603
 
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
604
 
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
605
 
        esac
606
 
        ;;
607
 
  stop)
608
 
        [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
609
 
        do_stop
610
 
        case "$?" in
611
 
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
612
 
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
613
 
        esac
614
 
        ;;
615
 
  #reload|force-reload)
616
 
        #
617
 
        # If do_reload() is not implemented then leave this commented out
618
 
        # and leave 'force-reload' as an alias for 'restart'.
619
 
        #
620
 
        #log_daemon_msg "Reloading $DESC" "$NAME"
621
 
        #do_reload
622
 
        #log_end_msg $?
623
 
        #;;
624
 
  restart|force-reload)
625
 
        #
626
 
        # If the "reload" option is implemented then remove the
627
 
        # 'force-reload' alias
628
 
        #
629
 
        log_daemon_msg "Restarting $DESC" "$NAME"
630
 
        do_stop
631
 
        case "$?" in
632
 
          0|1)
633
 
                do_start
634
 
                case "$?" in
635
 
                        0) log_end_msg 0 ;;
636
 
                        1) log_end_msg 1 ;; # Old process is still running
637
 
                        *) log_end_msg 1 ;; # Failed to start
638
 
                esac
639
 
                ;;
640
 
          *)
641
 
                # Failed to stop
642
 
                log_end_msg 1
643
 
                ;;
644
 
        esac
645
 
        ;;
646
 
  *)
647
 
        #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
648
 
        echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
649
 
        exit 3
650
 
        ;;
651
 
esac
652
 
 
653
 
:
654
 
''')
655
 
        
656
 
        conf.close()
657
 
    except IOError, (errno, strerror):
658
 
        print "IO error(%s): %s" % (errno, strerror)
659
 
        sys.exit(1)
660
 
 
661
 
    # fix permissions as the file contains the database password
662
 
    try:
663
 
        os.chmod('doc/setup/usrmgt-server.init', 0600)
664
 
    except OSError, (errno, strerror):
665
 
        print "WARNING: Couldn't chmod doc/setup/usrmgt-server.init:"
666
 
        print "OS error(%s): %s" % (errno, strerror)
667
 
 
668
 
    print "Successfully wrote lib/conf/usrmgt-server.init"
 
461
    conf.close()
 
462
 
 
463
    print "Successfully wrote %s" % phpBBconffile
669
464
 
670
465
    print
671
466
    print "You may modify the configuration at any time by editing"
672
467
    print conffile
673
 
    print jailconffile
674
468
    print conf_hfile
675
469
    print phpBBconffile
676
 
    print usrmgtserver_initdfile
677
470
    print
678
471
    
679
472
    return 0