← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: mattgiuca
  • Date: 2008-01-25 06:20:32 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:313
test/test_framework: Updated examples, a bit of better descriptions, sample
    partial solutions, etc.

Added all sample subject material.
This has been copied from test/test_framework and modified slightly.
There is now a subject "sample" with 2 worksheets. The 1st worksheet has 3
exercises. These work in IVLE by default.

setup.py: Added code to install subjects into the designated directory. This
means that installing IVLE will result in the sample subjects being
immediately available.

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup.py
31
31
# cutting a distribution, and the listfile it generates should be included in
32
32
# the distribution, avoiding the administrator having to run it.
33
33
 
34
 
# setup.py config [args]
 
34
# setup.py conf [args]
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 lib/conf/conf.py and trampoline/conf.h.
 
38
# Creates www/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(), 'lib'))
 
73
sys.path.append(os.path.join(os.getcwd(), 'www'))
74
74
import conf
75
75
import common.makeuser
76
76
 
77
 
# Determine which Python version (2.4 or 2.5, for example) we are running,
78
 
# and use that as the filename to the Python directory.
79
 
# Just get the first 3 characters of sys.version.
80
 
PYTHON_VERSION = sys.version[0:3]
81
 
 
82
77
# Operating system files to copy over into the jail.
83
78
# These will be copied from the given place on the OS file system into the
84
79
# same place within the jail.
99
94
    '/bin/ls',
100
95
    '/bin/echo',
101
96
    # Needed by python
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',
 
97
    '/usr/bin/python2.5',
142
98
    # Needed by matplotlib
143
99
    '/usr/lib/i686/cmov/libssl.so.0.9.8',
144
100
    '/usr/lib/i686/cmov/libcrypto.so.0.9.8',
162
118
]
163
119
# Symlinks to make within the jail. Src mapped to dst.
164
120
JAIL_LINKS = {
165
 
    'python%s' % PYTHON_VERSION: 'jail/usr/bin/python',
 
121
    'python2.5': 'jail/usr/bin/python',
166
122
}
167
123
# Trees to copy. Src mapped to dst (these will be passed to action_copytree).
168
124
JAIL_COPYTREES = {
169
 
    '/usr/lib/python%s' % PYTHON_VERSION:
170
 
        'jail/usr/lib/python%s' % PYTHON_VERSION,
 
125
    '/usr/lib/python2.5': 'jail/usr/lib/python2.5',
171
126
    '/usr/share/matplotlib': 'jail/usr/share/matplotlib',
172
127
    '/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
173
128
}
174
129
 
175
 
class ConfigOption:
176
 
    """A configuration option; one of the things written to conf.py."""
177
 
    def __init__(self, option_name, default, prompt, comment):
178
 
        """Creates a configuration option.
179
 
        option_name: Name of the variable in conf.py. Also name of the
180
 
            command-line argument to setup.py conf.
181
 
        default: Default value for this variable.
182
 
        prompt: (Short) string presented during the interactive prompt in
183
 
            setup.py conf.
184
 
        comment: (Long) comment string stored in conf.py. Each line of this
185
 
            string should begin with a '#'.
186
 
        """
187
 
        self.option_name = option_name
188
 
        self.default = default
189
 
        self.prompt = prompt
190
 
        self.comment = comment
191
 
 
192
 
# Configuration options, defaults and descriptions
193
 
config_options = []
194
 
config_options.append(ConfigOption("root_dir", "/",
195
 
    """Root directory where IVLE is located (in URL space):""",
196
 
    """
197
 
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
198
 
# with this).
199
 
# eg. "/" or "/ivle"."""))
200
 
config_options.append(ConfigOption("ivle_install_dir", "/opt/ivle",
201
 
    'Root directory where IVLE will be installed (on the local file '
202
 
    'system):',
203
 
    """
204
 
# In the local file system, where IVLE is actually installed.
205
 
# This directory should contain the "www" and "bin" directories."""))
206
 
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
207
 
    """Root directory where the jails (containing user files) are stored
208
 
(on the local file system):""",
209
 
    """
210
 
# In the local file system, where are the student/user file spaces located.
211
 
# The user jails are expected to be located immediately in subdirectories of
212
 
# this location."""))
213
 
config_options.append(ConfigOption("subjects_base",
214
 
    "/home/informatics/subjects",
215
 
    """Root directory where the subject directories (containing worksheets
216
 
and other per-subject files) are stored (on the local file system):""",
217
 
    """
218
 
# In the local file system, where are the per-subject file spaces located.
219
 
# The individual subject directories are expected to be located immediately
220
 
# in subdirectories of this location."""))
221
 
config_options.append(ConfigOption("problems_base",
222
 
    "/home/informatics/problems",
223
 
    """Root directory where the problem directories (containing
224
 
subject-independent problem sheets) are stored (on the local file
225
 
system):""",
226
 
    """
227
 
# In the local file system, where are the subject-independent problem sheet
228
 
# file spaces located."""))
229
 
config_options.append(ConfigOption("public_host", "public.localhost",
230
 
    """Hostname which will cause the server to go into "public mode",
231
 
providing login-free access to student's published work:""",
232
 
    """
233
 
# The server goes into "public mode" if the browser sends a request with this
234
 
# host. This is for security reasons - we only serve public student files on a
235
 
# separate domain to the main IVLE site.
236
 
# Public mode does not use cookies, and serves only public content.
237
 
# Private mode (normal mode) requires login, and only serves files relevant to
238
 
# the logged-in user."""))
239
 
config_options.append(ConfigOption("allowed_uids", "33",
240
 
    """UID of the web server process which will run IVLE.
241
 
Only this user may execute the trampoline. May specify multiple users as
242
 
a comma-separated list.
243
 
    (eg. "1002,78")""",
244
 
    """
245
 
# The User-ID of the web server process which will run IVLE, and any other
246
 
# users who are allowed to run the trampoline. This is stores as a string of
247
 
# comma-separated integers, simply because it is not used within Python, only
248
 
# used by the setup program to write to conf.h (see setup.py config)."""))
249
 
config_options.append(ConfigOption("db_host", "localhost",
250
 
    """PostgreSQL Database config
251
 
==========================
252
 
Hostname of the DB server:""",
253
 
    """
254
 
### PostgreSQL Database config ###
255
 
# Database server hostname"""))
256
 
config_options.append(ConfigOption("db_port", "5432",
257
 
    """Port of the DB server:""",
258
 
    """
259
 
# Database server port"""))
260
 
config_options.append(ConfigOption("db_dbname", "ivle",
261
 
    """Database name:""",
262
 
    """
263
 
# Database name"""))
264
 
config_options.append(ConfigOption("db_user", "postgres",
265
 
    """Username for DB server login:""",
266
 
    """
267
 
# Database username"""))
268
 
config_options.append(ConfigOption("db_password", "",
269
 
    """Password for DB server login:
270
 
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
271
 
    """
272
 
# Database password"""))
273
 
 
274
 
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
275
 
    """URL for LDAP authentication server:""",
276
 
    """
277
 
# URL for LDAP authentication server"""))
278
 
config_options.append(ConfigOption("ldap_format_string",
279
 
    "uid=%s,ou=users,o=example",
280
 
    """Format string for LDAP auth request:
281
 
    (Must contain a single "%s" for the user's login name)""",
282
 
    """
283
 
# Format string for LDAP auth request
284
 
# (Must contain a single "%s" for the user's login name)"""))
285
 
 
286
 
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
287
 
    """The location of the subversion configuration file used by apache
288
 
to host the user repositories:""",
289
 
    """
290
 
# The location of the subversion configuration file used by
291
 
# apache to host the user repositories."""))
292
 
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
293
 
    """The root directory for the subversion repositories:""",
294
 
    """
295
 
# The root directory for the subversion repositories."""))
296
 
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
297
 
    """The location of the password file used to authenticate users
298
 
of the subversion repository from the ivle server:""",
299
 
    """
300
 
# The location of the password file used to authenticate users
301
 
# of the subversion repository from the ivle server."""))
302
 
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
303
 
    """The location of the password file used to authenticate local users
304
 
of the subversion repository:""",
305
 
    """
306
 
# The location of the password file used to authenticate local users
307
 
# of the subversion repository."""))
308
 
config_options.append(ConfigOption("usrmgt_host", "localhost",
309
 
    """The hostname where the usrmgt-server runs:""",
310
 
    """
311
 
# The hostname where the usrmgt-server runs."""))
312
 
config_options.append(ConfigOption("usrmgt_port", "2178",
313
 
    """The port where the usrmgt-server runs:""",
314
 
    """
315
 
# The port where the usrmgt-server runs."""))
316
 
config_options.append(ConfigOption("usrmgt_magic", "",
317
 
    """The password for the usrmgt-server:""",
318
 
    """
319
 
# The password for the usrmgt-server."""))
320
 
 
321
130
# Try importing existing conf, but if we can't just set up defaults
322
131
# The reason for this is that these settings are used by other phases
323
132
# of setup besides conf, so we need to know them.
324
133
# Also this allows you to hit Return to accept the existing value.
325
134
try:
326
 
    confmodule = __import__("lib/conf/conf")
327
 
    for opt in config_options:
328
 
        try:
329
 
            globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
330
 
        except:
331
 
            globals()[opt.option_name] = opt.default
 
135
    confmodule = __import__("www/conf/conf")
 
136
    try:
 
137
        root_dir = confmodule.root_dir
 
138
    except:
 
139
        root_dir = "/ivle"
 
140
    try:
 
141
        ivle_install_dir = confmodule.ivle_install_dir
 
142
    except:
 
143
        ivle_install_dir = "/opt/ivle"
 
144
    try:
 
145
        public_host = confmodule.public_host
 
146
    except:
 
147
        public_host = "public.localhost"
 
148
    try:
 
149
        jail_base = confmodule.jail_base
 
150
    except:
 
151
        jail_base = "/home/informatics/jails"
 
152
    try:
 
153
        subjects_base = confmodule.subjects_base
 
154
    except:
 
155
        subjects_base = "/home/informatics/subjects"
332
156
except ImportError:
333
157
    # Just set reasonable defaults
334
 
    for opt in config_options:
335
 
        globals()[opt.option_name] = opt.default
 
158
    root_dir = "/ivle"
 
159
    ivle_install_dir = "/opt/ivle"
 
160
    public_host = "public.localhost"
 
161
    jail_base = "/home/informatics/jails"
 
162
    subjects_base = "/home/informatics/subjects"
 
163
# Always defaults
 
164
allowed_uids = "0"
336
165
 
337
166
# Try importing install_list, but don't fail if we can't, because listmake can
338
167
# function without it.
385
214
    try:
386
215
        oper_func = {
387
216
            'help' : help,
388
 
            'config' : conf,
 
217
            'conf' : conf,
389
218
            'build' : build,
390
219
            'listmake' : listmake,
391
220
            'install' : install,
406
235
Operation (and args) can be:
407
236
    help [operation]
408
237
    listmake (developer use only)
409
 
    config [args]
 
238
    conf [args]
410
239
    build
411
240
    install [--nojail] [--nosubjects] [-n|--dry]
412
241
"""
427
256
be copied upon installation. This should be run by the developer before
428
257
cutting a distribution, and the listfile it generates should be included in
429
258
the distribution, avoiding the administrator having to run it."""
430
 
    elif operation == 'config':
431
 
        print """python setup.py config [args]
 
259
    elif operation == 'conf':
 
260
        print """python setup.py conf [args]
432
261
Configures IVLE with machine-specific details, most notably, various paths.
433
262
Either prompts the administrator for these details or accepts them as
434
263
command-line args. Will be interactive only if there are no arguments given.
438
267
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
439
268
directory, and run build/install one time.
440
269
 
441
 
Creates lib/conf/conf.py and trampoline/conf.h.
 
270
Creates www/conf/conf.py and trampoline/conf.h.
442
271
 
443
 
Args are:"""
444
 
        for opt in config_options:
445
 
            print "    --" + opt.option_name
446
 
        print """As explained in the interactive prompt or conf.py.
 
272
Args are:
 
273
    --root_dir
 
274
    --ivle_install_dir
 
275
    --public_host
 
276
    --jail_base
 
277
    --subjects_base
 
278
    --allowed_uids
 
279
As explained in the interactive prompt or conf.py.
447
280
"""
448
281
    elif operation == 'build':
449
282
        print """python -O setup.py build [--dry|-n]
471
304
Copy subjects/ to subjects directory (unless --nosubjects specified).
472
305
 
473
306
--nojail        Do not copy the jail.
474
 
--nosubjects    Do not copy the subjects and problems directories.
 
307
--nosubjects    Do not copy the subjects.
475
308
--dry | -n  Print out the actions but don't do anything."""
476
309
    elif operation == 'updatejails':
477
310
        print """sudo python setup.py updatejails [--dry|-n]
488
321
def listmake(args):
489
322
    # We build two separate lists, by walking www and console
490
323
    list_www = build_list_py_files('www')
491
 
    list_lib = build_list_py_files('lib')
 
324
    list_console = build_list_py_files('console')
492
325
    list_subjects = build_list_py_files('subjects', no_top_level=True)
493
 
    list_problems = build_list_py_files('problems', no_top_level=True)
494
 
    list_scripts = [
495
 
        "scripts/python-console",
496
 
        "scripts/fileservice",
497
 
        "scripts/usrmgt-server",
498
 
    ]
499
326
    # Make sure that the files generated by conf are in the list
500
327
    # (since listmake is typically run before conf)
501
 
    if "lib/conf/conf.py" not in list_lib:
502
 
        list_lib.append("lib/conf/conf.py")
 
328
    if "www/conf/conf.py" not in list_www:
 
329
        list_www.append("www/conf/conf.py")
 
330
    # Make sure that console/python-console is in the list
 
331
    if "console/python-console" not in list_console:
 
332
        list_console.append("console/python-console")
503
333
    # Write these out to a file
504
334
    cwd = os.getcwd()
505
335
    # the files that will be created/overwritten
519
349
list_www = """)
520
350
        writelist_pretty(file, list_www)
521
351
        file.write("""
522
 
# List of all installable files in lib directory.
523
 
list_lib = """)
524
 
        writelist_pretty(file, list_lib)
525
 
        file.write("""
526
 
# List of all installable files in scripts directory.
527
 
list_scripts = """)
528
 
        writelist_pretty(file, list_scripts)
 
352
# List of all installable files in console directory.
 
353
list_console = """)
 
354
        writelist_pretty(file, list_console)
529
355
        file.write("""
530
356
# List of all installable files in subjects directory.
531
357
# This is to install sample subjects and material.
532
358
list_subjects = """)
533
359
        writelist_pretty(file, list_subjects)
534
 
        file.write("""
535
 
# List of all installable files in problems directory.
536
 
# This is to install sample exercise material.
537
 
list_problems = """)
538
 
        writelist_pretty(file, list_problems)
539
360
 
540
361
        file.close()
541
362
    except IOError, (errno, strerror):
581
402
        file.write(']\n')
582
403
 
583
404
def conf(args):
584
 
    global db_port, usrmgt_port
 
405
    global root_dir, ivle_install_dir, jail_base, subjects_base
 
406
    global public_host, allowed_uids
585
407
    # Set up some variables
586
408
 
587
409
    cwd = os.getcwd()
588
410
    # the files that will be created/overwritten
589
 
    conffile = os.path.join(cwd, "lib/conf/conf.py")
590
 
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
 
411
    conffile = os.path.join(cwd, "www/conf/conf.py")
591
412
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
592
413
 
593
414
    # Get command-line arguments to avoid asking questions.
594
415
 
595
 
    optnames = []
596
 
    for opt in config_options:
597
 
        optnames.append(opt.option_name + "=")
598
 
    (opts, args) = getopt.gnu_getopt(args, "", optnames)
 
416
    (opts, args) = getopt.gnu_getopt(args, "", ['root_dir=',
 
417
                    'ivle_install_dir=', 'jail_base=', 'allowed_uids='])
599
418
 
600
419
    if args != []:
601
420
        print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
607
426
        print """This tool will create the following files:
608
427
    %s
609
428
    %s
610
 
    %s
611
429
prompting you for details about your configuration. The file will be
612
430
overwritten if it already exists. It will *not* install or deploy IVLE.
613
431
 
614
432
Please hit Ctrl+C now if you do not wish to do this.
615
 
""" % (conffile, jailconffile, conf_hfile)
 
433
""" % (conffile, conf_hfile)
616
434
 
617
435
        # Get information from the administrator
618
436
        # If EOF is encountered at any time during the questioning, just exit
619
437
        # silently
620
438
 
621
 
        for opt in config_options:
622
 
            globals()[opt.option_name] = \
623
 
                query_user(globals()[opt.option_name], opt.prompt)
 
439
        root_dir = query_user(root_dir,
 
440
        """Root directory where IVLE is located (in URL space):""")
 
441
        ivle_install_dir = query_user(ivle_install_dir,
 
442
        'Root directory where IVLE will be installed (on the local file '
 
443
        'system):')
 
444
        jail_base = query_user(jail_base,
 
445
        """Root directory where the jails (containing user files) are stored
 
446
(on the local file system):""")
 
447
        subjects_base = query_user(subjects_base,
 
448
        """Root directory where the subject directories (containing worksheets
 
449
and other per-subject files) are stored (on the local file system):""")
 
450
        public_host = query_user(public_host,
 
451
        """Hostname which will cause the server to go into "public mode",
 
452
providing login-free access to student's published work:""")
 
453
        allowed_uids = query_user(allowed_uids,
 
454
        """UID of the web server process which will run IVLE.
 
455
Only this user may execute the trampoline. May specify multiple users as
 
456
a comma-separated list.
 
457
    (eg. "1002,78")""")
 
458
 
624
459
    else:
625
460
        opts = dict(opts)
626
461
        # Non-interactive mode. Parse the options.
627
 
        for opt in config_options:
628
 
            if '--' + opt.option_name in opts:
629
 
                globals()[opt.option_name] = opts['--' + opt.option_name]
 
462
        if '--root_dir' in opts:
 
463
            root_dir = opts['--root_dir']
 
464
        if '--ivle_install_dir' in opts:
 
465
            ivle_install_dir = opts['--ivle_install_dir']
 
466
        if '--jail_base' in opts:
 
467
            jail_base = opts['--jail_base']
 
468
        if '--subjects_base' in opts:
 
469
            jail_base = opts['--subjects_base']
 
470
        if '--public_host' in opts:
 
471
            public_host = opts['--public_host']
 
472
        if '--allowed_uids' in opts:
 
473
            allowed_uids = opts['--allowed_uids']
630
474
 
631
475
    # Error handling on input values
632
476
    try:
633
 
        allowed_uids_list = map(int, allowed_uids.split(','))
 
477
        allowed_uids = map(int, allowed_uids.split(','))
634
478
    except ValueError:
635
479
        print >>sys.stderr, (
636
480
        "Invalid UID list (%s).\n"
637
481
        "Must be a comma-separated list of integers." % allowed_uids)
638
482
        return 1
639
 
    try:
640
 
        db_port = int(db_port)
641
 
        if db_port < 0 or db_port >= 65536: raise ValueError()
642
 
    except ValueError:
643
 
        print >>sys.stderr, (
644
 
        "Invalid DB port (%s).\n"
645
 
        "Must be an integer between 0 and 65535." % repr(db_port))
646
 
        return 1
647
 
    try:
648
 
        usrmgt_port = int(usrmgt_port)
649
 
        if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
650
 
    except ValueError:
651
 
        print >>sys.stderr, (
652
 
        "Invalid user management port (%s).\n"
653
 
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
654
 
        return 1
655
483
 
656
 
    # Write lib/conf/conf.py
 
484
    # Write www/conf/conf.py
657
485
 
658
486
    try:
659
487
        conf = open(conffile, "w")
662
490
# conf.py
663
491
# Miscellaneous application settings
664
492
 
665
 
""")
666
 
        for opt in config_options:
667
 
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
668
 
                repr(globals()[opt.option_name])))
669
 
 
670
 
        conf.close()
671
 
    except IOError, (errno, strerror):
672
 
        print "IO error(%s): %s" % (errno, strerror)
673
 
        sys.exit(1)
674
 
 
675
 
    print "Successfully wrote lib/conf/conf.py"
676
 
 
677
 
    # Write conf/jailconf.py
678
 
 
679
 
    try:
680
 
        conf = open(jailconffile, "w")
681
 
 
682
 
        # In the "in-jail" version of conf, we don't need MOST of the details
683
 
        # (it would be a security risk to have them here).
684
 
        # So we just write root_dir, and jail_base is "/".
685
 
        # (jail_base being "/" means "jail-relative" paths are relative to "/"
686
 
        # when inside the jail.)
687
 
        conf.write("""# IVLE Configuration File
688
 
# conf.py
689
 
# Miscellaneous application settings
690
 
# (User jail version)
691
 
 
692
493
 
693
494
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
694
495
# with this).
695
496
# eg. "/" or "/ivle".
696
 
root_dir = %s
 
497
root_dir = "%s"
 
498
 
 
499
# In the local file system, where IVLE is actually installed.
 
500
# This directory should contain the "www" and "bin" directories.
 
501
ivle_install_dir = "%s"
 
502
 
 
503
# The server goes into "public mode" if the browser sends a request with this
 
504
# host. This is for security reasons - we only serve public student files on a
 
505
# separate domain to the main IVLE site.
 
506
# Public mode does not use cookies, and serves only public content.
 
507
# Private mode (normal mode) requires login, and only serves files relevant to
 
508
# the logged-in user.
 
509
public_host = "%s"
697
510
 
698
511
# In the local file system, where are the student/user file spaces located.
699
512
# The user jails are expected to be located immediately in subdirectories of
700
513
# this location.
701
 
jail_base = '/'
 
514
jail_base = "%s"
702
515
 
703
 
# The hostname for serving publicly accessible pages
704
 
public_host = %s
705
 
""" % (repr(root_dir),repr(public_host)))
 
516
# In the local file system, where are the per-subject file spaces located.
 
517
# The individual subject directories are expected to be located immediately
 
518
# in subdirectories of this location.
 
519
subjects_base = "%s"
 
520
""" % (root_dir, ivle_install_dir, public_host, jail_base, subjects_base))
706
521
 
707
522
        conf.close()
708
523
    except IOError, (errno, strerror):
709
524
        print "IO error(%s): %s" % (errno, strerror)
710
525
        sys.exit(1)
711
526
 
712
 
    print "Successfully wrote lib/conf/jailconf.py"
 
527
    print "Successfully wrote www/conf/conf.py"
713
528
 
714
529
    # Write trampoline/conf.h
715
530
 
734
549
 * (Note that root is an implicit member of this list).
735
550
 */
736
551
static const int allowed_uids[] = { %s };
737
 
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
738
 
    # Note: The above uses PYTHON reprs, not C reprs
739
 
    # However they should be the same with the exception of the outer
740
 
    # characters, which are stripped off and replaced
 
552
""" % (jail_base, repr(allowed_uids)[1:-1]))
741
553
 
742
554
        conf.close()
743
555
    except IOError, (errno, strerror):
749
561
    print
750
562
    print "You may modify the configuration at any time by editing"
751
563
    print conffile
752
 
    print jailconffile
753
564
    print conf_hfile
754
565
    print
755
566
    return 0
764
575
        print "Dry run (no actions will be executed\n"
765
576
 
766
577
    # Compile the trampoline
767
 
    curdir = os.getcwd()
768
 
    os.chdir('trampoline')
769
 
    action_runprog('make', [], dry)
770
 
    os.chdir(curdir)
 
578
    action_runprog('gcc', ['-Wall', '-o', 'trampoline/trampoline',
 
579
        'trampoline/trampoline.c'], dry)
771
580
 
772
581
    # Create the jail and its subdirectories
773
582
    # Note: Other subdirs will be made by copying files
776
585
    action_mkdir('jail/tmp', dry)
777
586
 
778
587
    # Copy all console and operating system files into the jail
779
 
    action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
 
588
    action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
780
589
    copy_os_files_jail(dry)
781
590
    # Chmod the python console
782
 
    action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
783
 
    action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
 
591
    action_chmod_x('jail/opt/ivle/console/python-console', dry)
784
592
    
785
 
    # Also copy the IVLE lib directory into the jail
786
 
    # This is necessary for running certain scripts
787
 
    action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
788
 
    # IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
789
 
    # which could compromise security if left in the jail (such as the DB
790
 
    # password).
791
 
    # The "safe" version is in jailconf.py. Delete conf.py and replace it with
792
 
    # jailconf.py.
793
 
    action_copyfile('lib/conf/jailconf.py',
794
 
        'jail/opt/ivle/lib/conf/conf.py', dry)
795
593
 
796
594
    # Compile .py files into .pyc or .pyo files
797
595
    compileall.compile_dir('www', quiet=True)
798
 
    compileall.compile_dir('lib', quiet=True)
799
 
    compileall.compile_dir('scripts', quiet=True)
800
 
    compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
801
 
 
802
 
    # Set up ivle.pth inside the jail
803
 
    # Need to set /opt/ivle/lib to be on the import path
804
 
    ivle_pth = \
805
 
        "jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
806
 
    f = open(ivle_pth, 'w')
807
 
    f.write('/opt/ivle/lib\n')
808
 
    f.close()
 
596
    compileall.compile_dir('console', quiet=True)
809
597
 
810
598
    return 0
811
599
 
853
641
    # chown trampoline to root and set setuid bit
854
642
    action_chown_setuid(tramppath, dry)
855
643
 
856
 
    # Copy the www and lib directories using the list
 
644
    # Copy the www directory using the list
857
645
    action_copylist(install_list.list_www, ivle_install_dir, dry)
858
 
    action_copylist(install_list.list_lib, ivle_install_dir, dry)
859
646
 
860
647
    if not nojail:
861
648
        # Copy the local jail directory built by the build action
863
650
        # for all the students' jails).
864
651
        action_copytree('jail', os.path.join(jail_base, 'template'), dry)
865
652
    if not nosubjects:
866
 
        # Copy the subjects and problems directories across
 
653
        # Copy the subjects directory across
867
654
        action_copylist(install_list.list_subjects, subjects_base, dry,
868
655
            srcdir="./subjects")
869
 
        action_copylist(install_list.list_problems, problems_base, dry,
870
 
            srcdir="./problems")
871
656
 
872
657
    # Append IVLE path to ivle.pth in python site packages
873
658
    # (Unless it's already there)
874
659
    ivle_pth = os.path.join(sys.prefix,
875
 
        "lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
 
660
        "lib/python2.5/site-packages/ivle.pth")
876
661
    ivle_www = os.path.join(ivle_install_dir, "www")
877
 
    ivle_lib = os.path.join(ivle_install_dir, "lib")
878
662
    write_ivle_pth = True
879
 
    write_ivle_lib_pth = True
880
663
    try:
881
664
        file = open(ivle_pth, 'r')
882
665
        for line in file:
883
666
            if line.strip() == ivle_www:
884
667
                write_ivle_pth = False
885
 
            elif line.strip() == ivle_lib:
886
 
                write_ivle_lib_pth = False
887
 
        file.close()
 
668
                break
888
669
    except (IOError, OSError):
889
670
        pass
890
671
    if write_ivle_pth:
891
672
        action_append(ivle_pth, ivle_www)
892
 
    if write_ivle_lib_pth:
893
 
        action_append(ivle_pth, ivle_lib)
894
673
 
895
674
    return 0
896
675
 
958
737
    if ret != 0:
959
738
        raise RunError(prog, ret)
960
739
 
961
 
def action_remove(path, dry):
962
 
    """Calls rmtree, deleting the target file if it exists."""
963
 
    try:
964
 
        print "rm -r", path
965
 
        if not dry:
966
 
            shutil.rmtree(path, True)
967
 
    except OSError, (err, msg):
968
 
        if err != errno.EEXIST:
969
 
            raise
970
 
        # Otherwise, didn't exist, so we don't care
971
 
 
972
740
def action_rename(src, dst, dry):
973
741
    """Calls rename. Deletes the target if it already exists."""
974
 
    action_remove(dst, dry)
 
742
    if os.access(dst, os.F_OK):
 
743
        print "rm -r", dst
 
744
        if not dry:
 
745
            shutil.rmtree(dst, True)
975
746
    print "mv ", src, dst
976
747
    if dry: return
977
748
    try:
997
768
    directories as necessary.
998
769
 
999
770
    See shutil.copytree."""
1000
 
    action_remove(dst, dry)
 
771
    if os.access(dst, os.F_OK):
 
772
        print "rm -r", dst
 
773
        if not dry:
 
774
            shutil.rmtree(dst, True)
1001
775
    print "cp -r", src, dst
1002
776
    if dry: return
1003
777
    shutil.copytree(src, dst, True)
1006
780
    """Hard-links an entire directory tree. Same as copytree but the created
1007
781
    files are hard-links not actual copies. Removes the existing destination.
1008
782
    """
1009
 
    action_remove(dst, dry)
 
783
    if os.access(dst, os.F_OK):
 
784
        print "rm -r", dst
 
785
        if not dry:
 
786
            shutil.rmtree(dst, True)
1010
787
    print "<cp with hardlinks> -r", src, dst
1011
788
    if dry: return
1012
789
    common.makeuser.linktree(src, dst)
1034
811
def action_copyfile(src, dst, dry):
1035
812
    """Copies one file to a new location. Creates all parent directories
1036
813
    as necessary.
1037
 
    Warn if file not found.
1038
814
    """
1039
815
    dstdir = os.path.split(dst)[0]
1040
816
    if not os.path.isdir(dstdir):
1044
820
        try:
1045
821
            shutil.copyfile(src, dst)
1046
822
            shutil.copymode(src, dst)
1047
 
        except (shutil.Error, IOError), e:
1048
 
            print "Warning: " + str(e)
 
823
        except shutil.Error:
 
824
            pass
1049
825
 
1050
826
def action_symlink(src, dst, dry):
1051
827
    """Creates a symlink in a given location. Creates all parent directories
1081
857
            | stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
1082
858
 
1083
859
def action_chmod_x(file, dry):
1084
 
    """Chmod 755 a file (sets permissions to rwxr-xr-x)."""
1085
 
    print "chmod 755", file
 
860
    """Chmod +xs a file (sets execute permission)."""
 
861
    print "chmod u+rwx", file
1086
862
    if not dry:
1087
 
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1088
 
            | stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
 
863
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR)
1089
864
 
1090
865
def query_user(default, prompt):
1091
866
    """Prompts the user for a string, which is read from a line of stdin.