← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: drtomc
  • Date: 2008-03-04 01:17:10 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:636
remakeuser: use the database, not the password file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup.py
35
35
# Configures IVLE with machine-specific details, most notably, various paths.
36
36
# Either prompts the administrator for these details or accepts them as
37
37
# command-line args.
38
 
# Creates www/conf/conf.py and trampoline/conf.h.
 
38
# Creates lib/conf/conf.py and trampoline/conf.h.
39
39
 
40
40
# setup.py build
41
41
# Compiles all files and sets up a jail template in the source directory.
70
70
 
71
71
# Import modules from the website is tricky since they're in the www
72
72
# directory.
73
 
sys.path.append(os.path.join(os.getcwd(), 'www'))
 
73
sys.path.append(os.path.join(os.getcwd(), 'lib'))
74
74
import conf
75
75
import common.makeuser
76
76
 
100
100
    '/bin/echo',
101
101
    # Needed by python
102
102
    '/usr/bin/python%s' % PYTHON_VERSION,
 
103
    # Needed by fileservice
 
104
    '/lib/libcom_err.so.2',
 
105
    '/lib/libcrypt.so.1',
 
106
    '/lib/libkeyutils.so.1',
 
107
    '/lib/libresolv.so.2',
 
108
    '/lib/librt.so.1',
 
109
    '/lib/libuuid.so.1',
 
110
    '/usr/lib/libapr-1.so.0',
 
111
    '/usr/lib/libaprutil-1.so.0',
 
112
    '/usr/lib/libdb-4.4.so',
 
113
    '/usr/lib/libexpat.so.1',
 
114
    '/usr/lib/libgcrypt.so.11',
 
115
    '/usr/lib/libgnutls.so.13',
 
116
    '/usr/lib/libgpg-error.so.0',
 
117
    '/usr/lib/libgssapi_krb5.so.2',
 
118
    '/usr/lib/libk5crypto.so.3',
 
119
    '/usr/lib/libkrb5.so.3',
 
120
    '/usr/lib/libkrb5support.so.0',
 
121
    '/usr/lib/liblber.so.2',
 
122
    '/usr/lib/libldap_r.so.2',
 
123
    '/usr/lib/libneon.so.26',
 
124
    '/usr/lib/libpq.so.5',
 
125
    '/usr/lib/libsasl2.so.2',
 
126
    '/usr/lib/libsqlite3.so.0',
 
127
    '/usr/lib/libsvn_client-1.so.1',
 
128
    '/usr/lib/libsvn_delta-1.so.1',
 
129
    '/usr/lib/libsvn_diff-1.so.1',
 
130
    '/usr/lib/libsvn_fs-1.so.1',
 
131
    '/usr/lib/libsvn_fs_base-1.so.1',
 
132
    '/usr/lib/libsvn_fs_fs-1.so.1',
 
133
    '/usr/lib/libsvn_ra-1.so.1',
 
134
    '/usr/lib/libsvn_ra_dav-1.so.1',
 
135
    '/usr/lib/libsvn_ra_local-1.so.1',
 
136
    '/usr/lib/libsvn_ra_svn-1.so.1',
 
137
    '/usr/lib/libsvn_repos-1.so.1',
 
138
    '/usr/lib/libsvn_subr-1.so.1',
 
139
    '/usr/lib/libsvn_wc-1.so.1',
 
140
    '/usr/lib/libtasn1.so.3',
 
141
    '/usr/lib/libxml2.so.2',
103
142
    # Needed by matplotlib
104
143
    '/usr/lib/i686/cmov/libssl.so.0.9.8',
105
144
    '/usr/lib/i686/cmov/libcrypto.so.0.9.8',
120
159
    '/usr/lib/libXdmcp.so.6',
121
160
    '/lib/libgcc_s.so.1',
122
161
    '/etc/matplotlibrc',
 
162
    # Needed for resolv
 
163
    '/lib/libnss_dns.so.2',
 
164
    #'/lib/libnss_mdns4.so',
 
165
    '/etc/hosts',
 
166
    '/etc/resolv.conf',
 
167
    #'/etc/hosts.conf',
 
168
    #'/etc/hostname',
 
169
    '/etc/nsswitch.conf',
 
170
    '/lib/libnss_files.so.2',
123
171
]
124
172
# Symlinks to make within the jail. Src mapped to dst.
125
173
JAIL_LINKS = {
133
181
    '/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
134
182
}
135
183
 
 
184
class ConfigOption:
 
185
    """A configuration option; one of the things written to conf.py."""
 
186
    def __init__(self, option_name, default, prompt, comment):
 
187
        """Creates a configuration option.
 
188
        option_name: Name of the variable in conf.py. Also name of the
 
189
            command-line argument to setup.py conf.
 
190
        default: Default value for this variable.
 
191
        prompt: (Short) string presented during the interactive prompt in
 
192
            setup.py conf.
 
193
        comment: (Long) comment string stored in conf.py. Each line of this
 
194
            string should begin with a '#'.
 
195
        """
 
196
        self.option_name = option_name
 
197
        self.default = default
 
198
        self.prompt = prompt
 
199
        self.comment = comment
 
200
 
 
201
# Configuration options, defaults and descriptions
 
202
config_options = []
 
203
config_options.append(ConfigOption("root_dir", "/",
 
204
    """Root directory where IVLE is located (in URL space):""",
 
205
    """
 
206
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
 
207
# with this).
 
208
# eg. "/" or "/ivle"."""))
 
209
config_options.append(ConfigOption("ivle_install_dir", "/opt/ivle",
 
210
    'Root directory where IVLE will be installed (on the local file '
 
211
    'system):',
 
212
    """
 
213
# In the local file system, where IVLE is actually installed.
 
214
# This directory should contain the "www" and "bin" directories."""))
 
215
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
 
216
    """Location of Directories
 
217
=======================
 
218
Root directory where the jails (containing user files) are stored
 
219
(on the local file system):""",
 
220
    """
 
221
# In the local file system, where are the student/user file spaces located.
 
222
# The user jails are expected to be located immediately in subdirectories of
 
223
# this location."""))
 
224
config_options.append(ConfigOption("subjects_base",
 
225
    "/home/informatics/subjects",
 
226
    """Root directory where the subject directories (containing worksheets
 
227
and other per-subject files) are stored (on the local file system):""",
 
228
    """
 
229
# In the local file system, where are the per-subject file spaces located.
 
230
# The individual subject directories are expected to be located immediately
 
231
# in subdirectories of this location."""))
 
232
config_options.append(ConfigOption("exercises_base",
 
233
    "/home/informatics/exercises",
 
234
    """Root directory where the exercise directories (containing
 
235
subject-independent exercise sheets) are stored (on the local file
 
236
system):""",
 
237
    """
 
238
# In the local file system, where are the subject-independent exercise sheet
 
239
# file spaces located."""))
 
240
config_options.append(ConfigOption("public_host", "public.localhost",
 
241
    """Hostname which will cause the server to go into "public mode",
 
242
providing login-free access to student's published work:""",
 
243
    """
 
244
# The server goes into "public mode" if the browser sends a request with this
 
245
# host. This is for security reasons - we only serve public student files on a
 
246
# separate domain to the main IVLE site.
 
247
# Public mode does not use cookies, and serves only public content.
 
248
# Private mode (normal mode) requires login, and only serves files relevant to
 
249
# the logged-in user."""))
 
250
config_options.append(ConfigOption("allowed_uids", "33",
 
251
    """UID of the web server process which will run IVLE.
 
252
Only this user may execute the trampoline. May specify multiple users as
 
253
a comma-separated list.
 
254
    (eg. "1002,78")""",
 
255
    """
 
256
# The User-ID of the web server process which will run IVLE, and any other
 
257
# users who are allowed to run the trampoline. This is stores as a string of
 
258
# comma-separated integers, simply because it is not used within Python, only
 
259
# used by the setup program to write to conf.h (see setup.py config)."""))
 
260
config_options.append(ConfigOption("db_host", "localhost",
 
261
    """PostgreSQL Database config
 
262
==========================
 
263
Hostname of the DB server:""",
 
264
    """
 
265
### PostgreSQL Database config ###
 
266
# Database server hostname"""))
 
267
config_options.append(ConfigOption("db_port", "5432",
 
268
    """Port of the DB server:""",
 
269
    """
 
270
# Database server port"""))
 
271
config_options.append(ConfigOption("db_dbname", "ivle",
 
272
    """Database name:""",
 
273
    """
 
274
# Database name"""))
 
275
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
 
276
    """Forum Database name:""",
 
277
    """
 
278
# Forum Database name"""))
 
279
config_options.append(ConfigOption("db_user", "postgres",
 
280
    """Username for DB server login:""",
 
281
    """
 
282
# Database username"""))
 
283
config_options.append(ConfigOption("db_password", "",
 
284
    """Password for DB server login:
 
285
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
 
286
    """
 
287
# Database password"""))
 
288
config_options.append(ConfigOption("auth_modules", "ldap_auth",
 
289
    """Authentication config
 
290
=====================
 
291
Comma-separated list of authentication modules. Only "ldap" is available
 
292
by default.""",
 
293
    """
 
294
# Comma-separated list of authentication modules.
 
295
# These refer to importable Python modules in the www/auth directory.
 
296
# Modules "ldap" and "guest" are available in the source tree, but
 
297
# other modules may be plugged in to auth against organisation-specific
 
298
# auth backends."""))
 
299
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
 
300
    """(LDAP options are only relevant if "ldap" is included in the list of
 
301
auth modules).
 
302
URL for LDAP authentication server:""",
 
303
    """
 
304
# URL for LDAP authentication server"""))
 
305
config_options.append(ConfigOption("ldap_format_string",
 
306
    "uid=%s,ou=users,o=example",
 
307
    """Format string for LDAP auth request:
 
308
    (Must contain a single "%s" for the user's login name)""",
 
309
    """
 
310
# Format string for LDAP auth request
 
311
# (Must contain a single "%s" for the user's login name)"""))
 
312
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
 
313
    """Subversion config
 
314
=================
 
315
The base url for accessing subversion repositories:""",
 
316
    """
 
317
# The base url for accessing subversion repositories."""))
 
318
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
 
319
    """The location of the subversion configuration file used by apache
 
320
to host the user repositories:""",
 
321
    """
 
322
# The location of the subversion configuration file used by
 
323
# apache to host the user repositories."""))
 
324
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
 
325
    """The root directory for the subversion repositories:""",
 
326
    """
 
327
# The root directory for the subversion repositories."""))
 
328
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
 
329
    """The location of the password file used to authenticate users
 
330
of the subversion repository from the ivle server:""",
 
331
    """
 
332
# The location of the password file used to authenticate users
 
333
# of the subversion repository from the ivle server."""))
 
334
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
 
335
    """The location of the password file used to authenticate local users
 
336
of the subversion repository:""",
 
337
    """
 
338
# The location of the password file used to authenticate local users
 
339
# of the subversion repository."""))
 
340
config_options.append(ConfigOption("usrmgt_host", "localhost",
 
341
    """User Management Server config
 
342
============================
 
343
The hostname where the usrmgt-server runs:""",
 
344
    """
 
345
# The hostname where the usrmgt-server runs."""))
 
346
config_options.append(ConfigOption("usrmgt_port", "2178",
 
347
    """The port where the usrmgt-server runs:""",
 
348
    """
 
349
# The port where the usrmgt-server runs."""))
 
350
config_options.append(ConfigOption("usrmgt_magic", "",
 
351
    """The password for the usrmgt-server:""",
 
352
    """
 
353
# The password for the usrmgt-server."""))
 
354
 
136
355
# Try importing existing conf, but if we can't just set up defaults
137
356
# The reason for this is that these settings are used by other phases
138
357
# of setup besides conf, so we need to know them.
139
358
# Also this allows you to hit Return to accept the existing value.
140
359
try:
141
 
    confmodule = __import__("www/conf/conf")
142
 
    try:
143
 
        root_dir = confmodule.root_dir
144
 
    except:
145
 
        root_dir = "/ivle"
146
 
    try:
147
 
        ivle_install_dir = confmodule.ivle_install_dir
148
 
    except:
149
 
        ivle_install_dir = "/opt/ivle"
150
 
    try:
151
 
        public_host = confmodule.public_host
152
 
    except:
153
 
        public_host = "public.localhost"
154
 
    try:
155
 
        jail_base = confmodule.jail_base
156
 
    except:
157
 
        jail_base = "/home/informatics/jails"
158
 
    try:
159
 
        subjects_base = confmodule.subjects_base
160
 
    except:
161
 
        subjects_base = "/home/informatics/subjects"
 
360
    confmodule = __import__("lib/conf/conf")
 
361
    for opt in config_options:
 
362
        try:
 
363
            globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
 
364
        except:
 
365
            globals()[opt.option_name] = opt.default
162
366
except ImportError:
163
367
    # Just set reasonable defaults
164
 
    root_dir = "/ivle"
165
 
    ivle_install_dir = "/opt/ivle"
166
 
    public_host = "public.localhost"
167
 
    jail_base = "/home/informatics/jails"
168
 
    subjects_base = "/home/informatics/subjects"
169
 
# Always defaults
170
 
allowed_uids = "0"
 
368
    for opt in config_options:
 
369
        globals()[opt.option_name] = opt.default
171
370
 
172
371
# Try importing install_list, but don't fail if we can't, because listmake can
173
372
# function without it.
182
381
# as necessary, and include it in the distribution.
183
382
listmake_mimetypes = ['text/x-python', 'text/html',
184
383
    'application/x-javascript', 'application/javascript',
185
 
    'text/css', 'image/png', 'application/xml']
 
384
    'text/css', 'image/png', 'image/gif', 'application/xml']
186
385
 
187
386
# Main function skeleton from Guido van Rossum
188
387
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
273
472
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
274
473
directory, and run build/install one time.
275
474
 
276
 
Creates www/conf/conf.py and trampoline/conf.h.
 
475
Creates lib/conf/conf.py and trampoline/conf.h.
277
476
 
278
 
Args are:
279
 
    --root_dir
280
 
    --ivle_install_dir
281
 
    --public_host
282
 
    --jail_base
283
 
    --subjects_base
284
 
    --allowed_uids
285
 
As explained in the interactive prompt or conf.py.
 
477
Args are:"""
 
478
        for opt in config_options:
 
479
            print "    --" + opt.option_name
 
480
        print """As explained in the interactive prompt or conf.py.
286
481
"""
287
482
    elif operation == 'build':
288
483
        print """python -O setup.py build [--dry|-n]
310
505
Copy subjects/ to subjects directory (unless --nosubjects specified).
311
506
 
312
507
--nojail        Do not copy the jail.
313
 
--nosubjects    Do not copy the subjects.
 
508
--nosubjects    Do not copy the subjects and exercises directories.
314
509
--dry | -n  Print out the actions but don't do anything."""
315
510
    elif operation == 'updatejails':
316
511
        print """sudo python setup.py updatejails [--dry|-n]
327
522
def listmake(args):
328
523
    # We build two separate lists, by walking www and console
329
524
    list_www = build_list_py_files('www')
330
 
    list_console = build_list_py_files('console')
 
525
    list_lib = build_list_py_files('lib')
331
526
    list_subjects = build_list_py_files('subjects', no_top_level=True)
 
527
    list_exercises = build_list_py_files('exercises', no_top_level=True)
 
528
    list_scripts = [
 
529
        "scripts/python-console",
 
530
        "scripts/fileservice",
 
531
        "scripts/usrmgt-server",
 
532
        "scripts/diffservice",
 
533
    ]
332
534
    # Make sure that the files generated by conf are in the list
333
535
    # (since listmake is typically run before conf)
334
 
    if "www/conf/conf.py" not in list_www:
335
 
        list_www.append("www/conf/conf.py")
336
 
    # Make sure that console/python-console is in the list
337
 
    if "console/python-console" not in list_console:
338
 
        list_console.append("console/python-console")
 
536
    if "lib/conf/conf.py" not in list_lib:
 
537
        list_lib.append("lib/conf/conf.py")
339
538
    # Write these out to a file
340
539
    cwd = os.getcwd()
341
540
    # the files that will be created/overwritten
355
554
list_www = """)
356
555
        writelist_pretty(file, list_www)
357
556
        file.write("""
358
 
# List of all installable files in console directory.
359
 
list_console = """)
360
 
        writelist_pretty(file, list_console)
 
557
# List of all installable files in lib directory.
 
558
list_lib = """)
 
559
        writelist_pretty(file, list_lib)
 
560
        file.write("""
 
561
# List of all installable files in scripts directory.
 
562
list_scripts = """)
 
563
        writelist_pretty(file, list_scripts)
361
564
        file.write("""
362
565
# List of all installable files in subjects directory.
363
566
# This is to install sample subjects and material.
364
567
list_subjects = """)
365
568
        writelist_pretty(file, list_subjects)
 
569
        file.write("""
 
570
# List of all installable files in exercises directory.
 
571
# This is to install sample exercise material.
 
572
list_exercises = """)
 
573
        writelist_pretty(file, list_exercises)
366
574
 
367
575
        file.close()
368
576
    except IOError, (errno, strerror):
408
616
        file.write(']\n')
409
617
 
410
618
def conf(args):
411
 
    global root_dir, ivle_install_dir, jail_base, subjects_base
412
 
    global public_host, allowed_uids
 
619
    global db_port, usrmgt_port
413
620
    # Set up some variables
414
621
 
415
622
    cwd = os.getcwd()
416
623
    # the files that will be created/overwritten
417
 
    conffile = os.path.join(cwd, "www/conf/conf.py")
 
624
    conffile = os.path.join(cwd, "lib/conf/conf.py")
 
625
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
418
626
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
 
627
    phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
419
628
 
420
629
    # Get command-line arguments to avoid asking questions.
421
630
 
422
 
    (opts, args) = getopt.gnu_getopt(args, "", ['root_dir=',
423
 
                    'ivle_install_dir=', 'jail_base=', 'allowed_uids='])
 
631
    optnames = []
 
632
    for opt in config_options:
 
633
        optnames.append(opt.option_name + "=")
 
634
    (opts, args) = getopt.gnu_getopt(args, "", optnames)
424
635
 
425
636
    if args != []:
426
637
        print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
432
643
        print """This tool will create the following files:
433
644
    %s
434
645
    %s
 
646
    %s
435
647
prompting you for details about your configuration. The file will be
436
648
overwritten if it already exists. It will *not* install or deploy IVLE.
437
649
 
438
650
Please hit Ctrl+C now if you do not wish to do this.
439
 
""" % (conffile, conf_hfile)
 
651
""" % (conffile, jailconffile, conf_hfile)
440
652
 
441
653
        # Get information from the administrator
442
654
        # If EOF is encountered at any time during the questioning, just exit
443
655
        # silently
444
656
 
445
 
        root_dir = query_user(root_dir,
446
 
        """Root directory where IVLE is located (in URL space):""")
447
 
        ivle_install_dir = query_user(ivle_install_dir,
448
 
        'Root directory where IVLE will be installed (on the local file '
449
 
        'system):')
450
 
        jail_base = query_user(jail_base,
451
 
        """Root directory where the jails (containing user files) are stored
452
 
(on the local file system):""")
453
 
        subjects_base = query_user(subjects_base,
454
 
        """Root directory where the subject directories (containing worksheets
455
 
and other per-subject files) are stored (on the local file system):""")
456
 
        public_host = query_user(public_host,
457
 
        """Hostname which will cause the server to go into "public mode",
458
 
providing login-free access to student's published work:""")
459
 
        allowed_uids = query_user(allowed_uids,
460
 
        """UID of the web server process which will run IVLE.
461
 
Only this user may execute the trampoline. May specify multiple users as
462
 
a comma-separated list.
463
 
    (eg. "1002,78")""")
464
 
 
 
657
        for opt in config_options:
 
658
            globals()[opt.option_name] = \
 
659
                query_user(globals()[opt.option_name], opt.prompt)
465
660
    else:
466
661
        opts = dict(opts)
467
662
        # Non-interactive mode. Parse the options.
468
 
        if '--root_dir' in opts:
469
 
            root_dir = opts['--root_dir']
470
 
        if '--ivle_install_dir' in opts:
471
 
            ivle_install_dir = opts['--ivle_install_dir']
472
 
        if '--jail_base' in opts:
473
 
            jail_base = opts['--jail_base']
474
 
        if '--subjects_base' in opts:
475
 
            jail_base = opts['--subjects_base']
476
 
        if '--public_host' in opts:
477
 
            public_host = opts['--public_host']
478
 
        if '--allowed_uids' in opts:
479
 
            allowed_uids = opts['--allowed_uids']
 
663
        for opt in config_options:
 
664
            if '--' + opt.option_name in opts:
 
665
                globals()[opt.option_name] = opts['--' + opt.option_name]
480
666
 
481
667
    # Error handling on input values
482
668
    try:
483
 
        allowed_uids = map(int, allowed_uids.split(','))
 
669
        allowed_uids_list = map(int, allowed_uids.split(','))
484
670
    except ValueError:
485
671
        print >>sys.stderr, (
486
672
        "Invalid UID list (%s).\n"
487
673
        "Must be a comma-separated list of integers." % allowed_uids)
488
674
        return 1
 
675
    try:
 
676
        db_port = int(db_port)
 
677
        if db_port < 0 or db_port >= 65536: raise ValueError()
 
678
    except ValueError:
 
679
        print >>sys.stderr, (
 
680
        "Invalid DB port (%s).\n"
 
681
        "Must be an integer between 0 and 65535." % repr(db_port))
 
682
        return 1
 
683
    try:
 
684
        usrmgt_port = int(usrmgt_port)
 
685
        if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
 
686
    except ValueError:
 
687
        print >>sys.stderr, (
 
688
        "Invalid user management port (%s).\n"
 
689
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
 
690
        return 1
489
691
 
490
 
    # Write www/conf/conf.py
 
692
    # Write lib/conf/conf.py
491
693
 
492
694
    try:
493
695
        conf = open(conffile, "w")
496
698
# conf.py
497
699
# Miscellaneous application settings
498
700
 
 
701
""")
 
702
        for opt in config_options:
 
703
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
 
704
                repr(globals()[opt.option_name])))
 
705
 
 
706
        conf.close()
 
707
    except IOError, (errno, strerror):
 
708
        print "IO error(%s): %s" % (errno, strerror)
 
709
        sys.exit(1)
 
710
 
 
711
    print "Successfully wrote lib/conf/conf.py"
 
712
 
 
713
    # Write conf/jailconf.py
 
714
 
 
715
    try:
 
716
        conf = open(jailconffile, "w")
 
717
 
 
718
        # In the "in-jail" version of conf, we don't need MOST of the details
 
719
        # (it would be a security risk to have them here).
 
720
        # So we just write root_dir, and jail_base is "/".
 
721
        # (jail_base being "/" means "jail-relative" paths are relative to "/"
 
722
        # when inside the jail.)
 
723
        conf.write("""# IVLE Configuration File
 
724
# conf.py
 
725
# Miscellaneous application settings
 
726
# (User jail version)
 
727
 
499
728
 
500
729
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
501
730
# with this).
502
731
# eg. "/" or "/ivle".
503
 
root_dir = "%s"
504
 
 
505
 
# In the local file system, where IVLE is actually installed.
506
 
# This directory should contain the "www" and "bin" directories.
507
 
ivle_install_dir = "%s"
508
 
 
509
 
# The server goes into "public mode" if the browser sends a request with this
510
 
# host. This is for security reasons - we only serve public student files on a
511
 
# separate domain to the main IVLE site.
512
 
# Public mode does not use cookies, and serves only public content.
513
 
# Private mode (normal mode) requires login, and only serves files relevant to
514
 
# the logged-in user.
515
 
public_host = "%s"
 
732
root_dir = %s
516
733
 
517
734
# In the local file system, where are the student/user file spaces located.
518
735
# The user jails are expected to be located immediately in subdirectories of
519
736
# this location.
520
 
jail_base = "%s"
 
737
jail_base = '/'
521
738
 
522
 
# In the local file system, where are the per-subject file spaces located.
523
 
# The individual subject directories are expected to be located immediately
524
 
# in subdirectories of this location.
525
 
subjects_base = "%s"
526
 
""" % (root_dir, ivle_install_dir, public_host, jail_base, subjects_base))
 
739
# The hostname for serving publicly accessible pages
 
740
public_host = %s
 
741
""" % (repr(root_dir),repr(public_host)))
527
742
 
528
743
        conf.close()
529
744
    except IOError, (errno, strerror):
530
745
        print "IO error(%s): %s" % (errno, strerror)
531
746
        sys.exit(1)
532
747
 
533
 
    print "Successfully wrote www/conf/conf.py"
 
748
    print "Successfully wrote lib/conf/jailconf.py"
534
749
 
535
750
    # Write trampoline/conf.h
536
751
 
555
770
 * (Note that root is an implicit member of this list).
556
771
 */
557
772
static const int allowed_uids[] = { %s };
558
 
""" % (jail_base, repr(allowed_uids)[1:-1]))
 
773
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
 
774
    # Note: The above uses PYTHON reprs, not C reprs
 
775
    # However they should be the same with the exception of the outer
 
776
    # characters, which are stripped off and replaced
559
777
 
560
778
        conf.close()
561
779
    except IOError, (errno, strerror):
564
782
 
565
783
    print "Successfully wrote trampoline/conf.h"
566
784
 
 
785
    # Write www/php/phpBB3/config.php
 
786
 
 
787
    try:
 
788
        conf = open(phpBBconffile, "w")
 
789
        
 
790
        # php-pg work around
 
791
        if db_host == 'localhost':
 
792
            forumdb_host = '127.0.0.1'
 
793
        else:
 
794
            forumdb_host = db_host
 
795
 
 
796
        conf.write( """<?php
 
797
// phpBB 3.0.x auto-generated configuration file
 
798
// Do not change anything in this file!
 
799
$dbms = 'postgres';
 
800
$dbhost = '""" + forumdb_host + """';
 
801
$dbport = '""" + str(db_port) + """';
 
802
$dbname = '""" + db_forumdbname + """';
 
803
$dbuser = '""" + db_user + """';
 
804
$dbpasswd = '""" + db_password + """';
 
805
 
 
806
$table_prefix = 'phpbb_';
 
807
$acm_type = 'file';
 
808
$load_extensions = '';
 
809
@define('PHPBB_INSTALLED', true);
 
810
// @define('DEBUG', true);
 
811
//@define('DEBUG_EXTRA', true);
 
812
?>"""   )
 
813
    
 
814
        conf.close()
 
815
    except IOError, (errno, strerror):
 
816
        print "IO error(%s): %s" % (errno, strerror)
 
817
        sys.exit(1)
 
818
 
 
819
    print "Successfully wrote www/php/phpBB3/config.php"
 
820
 
567
821
    print
568
822
    print "You may modify the configuration at any time by editing"
569
823
    print conffile
 
824
    print jailconffile
570
825
    print conf_hfile
 
826
    print phpBBconffile
571
827
    print
572
828
    return 0
573
829
 
592
848
    action_mkdir('jail/home', dry)
593
849
    action_mkdir('jail/tmp', dry)
594
850
 
 
851
    # Chmod the tmp directory to world writable
 
852
    action_chmod_w('jail/tmp', dry)
 
853
 
595
854
    # Copy all console and operating system files into the jail
596
 
    action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
 
855
    action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
597
856
    copy_os_files_jail(dry)
598
857
    # Chmod the python console
599
 
    action_chmod_x('jail/opt/ivle/console/python-console', dry)
 
858
    action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
 
859
    action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
600
860
    
 
861
    # Also copy the IVLE lib directory into the jail
 
862
    # This is necessary for running certain scripts
 
863
    action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
 
864
    # IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
 
865
    # which could compromise security if left in the jail (such as the DB
 
866
    # password).
 
867
    # The "safe" version is in jailconf.py. Delete conf.py and replace it with
 
868
    # jailconf.py.
 
869
    action_copyfile('lib/conf/jailconf.py',
 
870
        'jail/opt/ivle/lib/conf/conf.py', dry)
601
871
 
602
872
    # Compile .py files into .pyc or .pyo files
603
873
    compileall.compile_dir('www', quiet=True)
604
 
    compileall.compile_dir('console', quiet=True)
 
874
    compileall.compile_dir('lib', quiet=True)
 
875
    compileall.compile_dir('scripts', quiet=True)
 
876
    compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
 
877
 
 
878
    # Set up ivle.pth inside the jail
 
879
    # Need to set /opt/ivle/lib to be on the import path
 
880
    ivle_pth = \
 
881
        "jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
 
882
    f = open(ivle_pth, 'w')
 
883
    f.write('/opt/ivle/lib\n')
 
884
    f.close()
605
885
 
606
886
    return 0
607
887
 
649
929
    # chown trampoline to root and set setuid bit
650
930
    action_chown_setuid(tramppath, dry)
651
931
 
652
 
    # Copy the www directory using the list
 
932
    # Create a scripts directory to put the usrmgt-server in.
 
933
    action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
 
934
    usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
 
935
    action_copyfile('scripts/usrmgt-server', usrmgtpath, dry)
 
936
    action_chmod_x(usrmgtpath, dry)
 
937
 
 
938
    # Copy the www and lib directories using the list
653
939
    action_copylist(install_list.list_www, ivle_install_dir, dry)
 
940
    action_copylist(install_list.list_lib, ivle_install_dir, dry)
 
941
    
 
942
    # Copy the php directory
 
943
    action_copytree('www/php/phpBB3',os.path.join(ivle_install_dir,'www/php/phpBB3'), 
 
944
    dry)
654
945
 
655
946
    if not nojail:
656
947
        # Copy the local jail directory built by the build action
658
949
        # for all the students' jails).
659
950
        action_copytree('jail', os.path.join(jail_base, 'template'), dry)
660
951
    if not nosubjects:
661
 
        # Copy the subjects directory across
 
952
        # Copy the subjects and exercises directories across
662
953
        action_copylist(install_list.list_subjects, subjects_base, dry,
663
954
            srcdir="./subjects")
 
955
        action_copylist(install_list.list_exercises, exercises_base, dry,
 
956
            srcdir="./exercises")
664
957
 
665
958
    # Append IVLE path to ivle.pth in python site packages
666
959
    # (Unless it's already there)
667
960
    ivle_pth = os.path.join(sys.prefix,
668
961
        "lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
669
962
    ivle_www = os.path.join(ivle_install_dir, "www")
 
963
    ivle_lib = os.path.join(ivle_install_dir, "lib")
670
964
    write_ivle_pth = True
 
965
    write_ivle_lib_pth = True
671
966
    try:
672
967
        file = open(ivle_pth, 'r')
673
968
        for line in file:
674
969
            if line.strip() == ivle_www:
675
970
                write_ivle_pth = False
676
 
                break
 
971
            elif line.strip() == ivle_lib:
 
972
                write_ivle_lib_pth = False
 
973
        file.close()
677
974
    except (IOError, OSError):
678
975
        pass
679
976
    if write_ivle_pth:
680
977
        action_append(ivle_pth, ivle_www)
 
978
    if write_ivle_lib_pth:
 
979
        action_append(ivle_pth, ivle_lib)
681
980
 
682
981
    return 0
683
982
 
745
1044
    if ret != 0:
746
1045
        raise RunError(prog, ret)
747
1046
 
 
1047
def action_remove(path, dry):
 
1048
    """Calls rmtree, deleting the target file if it exists."""
 
1049
    try:
 
1050
        print "rm -r", path
 
1051
        if not dry:
 
1052
            shutil.rmtree(path, True)
 
1053
    except OSError, (err, msg):
 
1054
        if err != errno.EEXIST:
 
1055
            raise
 
1056
        # Otherwise, didn't exist, so we don't care
 
1057
 
748
1058
def action_rename(src, dst, dry):
749
1059
    """Calls rename. Deletes the target if it already exists."""
750
 
    if os.access(dst, os.F_OK):
751
 
        print "rm -r", dst
752
 
        if not dry:
753
 
            shutil.rmtree(dst, True)
 
1060
    action_remove(dst, dry)
754
1061
    print "mv ", src, dst
755
1062
    if dry: return
756
1063
    try:
776
1083
    directories as necessary.
777
1084
 
778
1085
    See shutil.copytree."""
779
 
    if os.access(dst, os.F_OK):
780
 
        print "rm -r", dst
781
 
        if not dry:
782
 
            shutil.rmtree(dst, True)
 
1086
    # Allow copying over itself
 
1087
    if (os.path.normpath(os.path.join(os.getcwd(),src)) ==
 
1088
        os.path.normpath(os.path.join(os.getcwd(),dst))):
 
1089
        return
 
1090
    action_remove(dst, dry)
783
1091
    print "cp -r", src, dst
784
1092
    if dry: return
785
1093
    shutil.copytree(src, dst, True)
788
1096
    """Hard-links an entire directory tree. Same as copytree but the created
789
1097
    files are hard-links not actual copies. Removes the existing destination.
790
1098
    """
791
 
    if os.access(dst, os.F_OK):
792
 
        print "rm -r", dst
793
 
        if not dry:
794
 
            shutil.rmtree(dst, True)
 
1099
    action_remove(dst, dry)
795
1100
    print "<cp with hardlinks> -r", src, dst
796
1101
    if dry: return
797
1102
    common.makeuser.linktree(src, dst)
866
1171
            | stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
867
1172
 
868
1173
def action_chmod_x(file, dry):
869
 
    """Chmod +xs a file (sets execute permission)."""
870
 
    print "chmod u+rwx", file
871
 
    if not dry:
872
 
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR)
 
1174
    """Chmod 755 a file (sets permissions to rwxr-xr-x)."""
 
1175
    print "chmod 755", file
 
1176
    if not dry:
 
1177
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
 
1178
            | stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
 
1179
 
 
1180
 
 
1181
def action_chmod_w(file, dry):
 
1182
    """Chmod 777 a file (sets permissions to rwxrwxrwx)."""
 
1183
    print "chmod 777", file
 
1184
    if not dry:
 
1185
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
 
1186
            | stat.S_IXGRP | stat.S_IWGRP | stat.S_IRGRP | stat.S_IXOTH
 
1187
            | stat.S_IWOTH | stat.S_IROTH)
873
1188
 
874
1189
def query_user(default, prompt):
875
1190
    """Prompts the user for a string, which is read from a line of stdin.