← 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-04-17 07:24:01 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:736
Added new script "marks.py" which computes the marks for all students and outputs it as a CSV file.
This borrows a lot of code from tutorial/__init__.py which should be factored out.

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 conf [args]
 
34
# setup.py config [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 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.
67
67
import mimetypes
68
68
import compileall
69
69
import getopt
 
70
import hashlib
 
71
import uuid
 
72
 
 
73
# Import modules from the website is tricky since they're in the www
 
74
# directory.
 
75
sys.path.append(os.path.join(os.getcwd(), 'lib'))
 
76
import conf
 
77
import common.makeuser
 
78
 
 
79
# Determine which Python version (2.4 or 2.5, for example) we are running,
 
80
# and use that as the filename to the Python directory.
 
81
# Just get the first 3 characters of sys.version.
 
82
PYTHON_VERSION = sys.version[0:3]
 
83
 
 
84
# Operating system files to copy over into the jail.
 
85
# These will be copied from the given place on the OS file system into the
 
86
# same place within the jail.
 
87
JAIL_FILES = [
 
88
    '/lib/ld-linux.so.2',
 
89
    '/lib/tls/i686/cmov/libc.so.6',
 
90
    '/lib/tls/i686/cmov/libdl.so.2',
 
91
    '/lib/tls/i686/cmov/libm.so.6',
 
92
    '/lib/tls/i686/cmov/libpthread.so.0',
 
93
    '/lib/tls/i686/cmov/libutil.so.1',
 
94
    '/etc/ld.so.conf',
 
95
    '/etc/ld.so.cache',
 
96
    # These 2 files do not exist in Ubuntu
 
97
    #'/etc/ld.so.preload',
 
98
    #'/etc/ld.so.nohwcap',
 
99
    # UNIX commands
 
100
    '/usr/bin/strace',
 
101
    '/bin/ls',
 
102
    '/bin/echo',
 
103
    # Needed by python
 
104
    '/usr/bin/python%s' % PYTHON_VERSION,
 
105
    # Needed by fileservice
 
106
    '/lib/libcom_err.so.2',
 
107
    '/lib/libcrypt.so.1',
 
108
    '/lib/libkeyutils.so.1',
 
109
    '/lib/libresolv.so.2',
 
110
    '/lib/librt.so.1',
 
111
    '/lib/libuuid.so.1',
 
112
    '/usr/lib/libapr-1.so.0',
 
113
    '/usr/lib/libaprutil-1.so.0',
 
114
    '/usr/lib/libdb-4.4.so',
 
115
    '/usr/lib/libexpat.so.1',
 
116
    '/usr/lib/libgcrypt.so.11',
 
117
    '/usr/lib/libgnutls.so.13',
 
118
    '/usr/lib/libgpg-error.so.0',
 
119
    '/usr/lib/libgssapi_krb5.so.2',
 
120
    '/usr/lib/libk5crypto.so.3',
 
121
    '/usr/lib/libkrb5.so.3',
 
122
    '/usr/lib/libkrb5support.so.0',
 
123
    '/usr/lib/liblber.so.2',
 
124
    '/usr/lib/libldap_r.so.2',
 
125
    '/usr/lib/libneon.so.26',
 
126
    '/usr/lib/libpq.so.5',
 
127
    '/usr/lib/libsasl2.so.2',
 
128
    '/usr/lib/libsqlite3.so.0',
 
129
    '/usr/lib/libsvn_client-1.so.1',
 
130
    '/usr/lib/libsvn_delta-1.so.1',
 
131
    '/usr/lib/libsvn_diff-1.so.1',
 
132
    '/usr/lib/libsvn_fs-1.so.1',
 
133
    '/usr/lib/libsvn_fs_base-1.so.1',
 
134
    '/usr/lib/libsvn_fs_fs-1.so.1',
 
135
    '/usr/lib/libsvn_ra-1.so.1',
 
136
    '/usr/lib/libsvn_ra_dav-1.so.1',
 
137
    '/usr/lib/libsvn_ra_local-1.so.1',
 
138
    '/usr/lib/libsvn_ra_svn-1.so.1',
 
139
    '/usr/lib/libsvn_repos-1.so.1',
 
140
    '/usr/lib/libsvn_subr-1.so.1',
 
141
    '/usr/lib/libsvn_wc-1.so.1',
 
142
    '/usr/lib/libtasn1.so.3',
 
143
    '/usr/lib/libxml2.so.2',
 
144
    # Needed by matplotlib
 
145
    '/usr/lib/i686/cmov/libssl.so.0.9.8',
 
146
    '/usr/lib/i686/cmov/libcrypto.so.0.9.8',
 
147
    '/lib/tls/i686/cmov/libnsl.so.1',
 
148
    '/usr/lib/libz.so.1',
 
149
    '/usr/lib/atlas/liblapack.so.3',
 
150
    '/usr/lib/atlas/libblas.so.3',
 
151
    '/usr/lib/libg2c.so.0',
 
152
    '/usr/lib/libstdc++.so.6',
 
153
    '/usr/lib/libfreetype.so.6',
 
154
    '/usr/lib/libpng12.so.0',
 
155
    '/usr/lib/libBLT.2.4.so.8.4',
 
156
    '/usr/lib/libtk8.4.so.0',
 
157
    '/usr/lib/libtcl8.4.so.0',
 
158
    '/usr/lib/tcl8.4/init.tcl',
 
159
    '/usr/lib/libX11.so.6',
 
160
    '/usr/lib/libXau.so.6',
 
161
    '/usr/lib/libXdmcp.so.6',
 
162
    '/lib/libgcc_s.so.1',
 
163
    '/etc/matplotlibrc',
 
164
    # Needed for resolv
 
165
    '/lib/libnss_dns.so.2',
 
166
    '/lib/libnss_mdns4_minimal.so.2',
 
167
    '/etc/hosts',
 
168
    '/etc/resolv.conf',
 
169
    #'/etc/hosts.conf',
 
170
    #'/etc/hostname',
 
171
    '/etc/nsswitch.conf',
 
172
    '/lib/libnss_files.so.2',
 
173
]
 
174
# Symlinks to make within the jail. Src mapped to dst.
 
175
JAIL_LINKS = {
 
176
    'python%s' % PYTHON_VERSION: 'jail/usr/bin/python',
 
177
}
 
178
# Trees to copy. Src mapped to dst (these will be passed to action_copytree).
 
179
JAIL_COPYTREES = {
 
180
    '/usr/lib/python%s' % PYTHON_VERSION:
 
181
        'jail/usr/lib/python%s' % PYTHON_VERSION,
 
182
    '/usr/share/matplotlib': 'jail/usr/share/matplotlib',
 
183
    '/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
 
184
    '/usr/share/nltk': 'jail/usr/share/nltk',
 
185
}
 
186
 
 
187
class ConfigOption:
 
188
    """A configuration option; one of the things written to conf.py."""
 
189
    def __init__(self, option_name, default, prompt, comment):
 
190
        """Creates a configuration option.
 
191
        option_name: Name of the variable in conf.py. Also name of the
 
192
            command-line argument to setup.py conf.
 
193
        default: Default value for this variable.
 
194
        prompt: (Short) string presented during the interactive prompt in
 
195
            setup.py conf.
 
196
        comment: (Long) comment string stored in conf.py. Each line of this
 
197
            string should begin with a '#'.
 
198
        """
 
199
        self.option_name = option_name
 
200
        self.default = default
 
201
        self.prompt = prompt
 
202
        self.comment = comment
 
203
 
 
204
# Configuration options, defaults and descriptions
 
205
config_options = []
 
206
config_options.append(ConfigOption("root_dir", "/",
 
207
    """Root directory where IVLE is located (in URL space):""",
 
208
    """
 
209
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
 
210
# with this).
 
211
# eg. "/" or "/ivle"."""))
 
212
config_options.append(ConfigOption("ivle_install_dir", "/opt/ivle",
 
213
    'Root directory where IVLE will be installed (on the local file '
 
214
    'system):',
 
215
    """
 
216
# In the local file system, where IVLE is actually installed.
 
217
# This directory should contain the "www" and "bin" directories."""))
 
218
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
 
219
    """Location of Directories
 
220
=======================
 
221
Root directory where the jails (containing user files) are stored
 
222
(on the local file system):""",
 
223
    """
 
224
# In the local file system, where are the student/user file spaces located.
 
225
# The user jails are expected to be located immediately in subdirectories of
 
226
# this location."""))
 
227
config_options.append(ConfigOption("subjects_base",
 
228
    "/home/informatics/subjects",
 
229
    """Root directory where the subject directories (containing worksheets
 
230
and other per-subject files) are stored (on the local file system):""",
 
231
    """
 
232
# In the local file system, where are the per-subject file spaces located.
 
233
# The individual subject directories are expected to be located immediately
 
234
# in subdirectories of this location."""))
 
235
config_options.append(ConfigOption("exercises_base",
 
236
    "/home/informatics/exercises",
 
237
    """Root directory where the exercise directories (containing
 
238
subject-independent exercise sheets) are stored (on the local file
 
239
system):""",
 
240
    """
 
241
# In the local file system, where are the subject-independent exercise sheet
 
242
# file spaces located."""))
 
243
config_options.append(ConfigOption("tos_path",
 
244
    "/home/informatics/tos.html",
 
245
    """Location where the Terms of Service document is stored (on the local
 
246
    file system):""",
 
247
    """
 
248
# In the local file system, where is the Terms of Service document located."""))
 
249
config_options.append(ConfigOption("motd_path",
 
250
    "/home/informatics/motd.html",
 
251
    """Location where the Message of the Day document is stored (on the local
 
252
    file system):""",
 
253
    """
 
254
# In the local file system, where is the Message of the Day document
 
255
# located. This is an HTML file (just the body fragment), which will
 
256
# be displayed on the login page. It is optional."""))
 
257
config_options.append(ConfigOption("public_host", "public.localhost",
 
258
    """Hostname which will cause the server to go into "public mode",
 
259
providing login-free access to student's published work:""",
 
260
    """
 
261
# The server goes into "public mode" if the browser sends a request with this
 
262
# host. This is for security reasons - we only serve public student files on a
 
263
# separate domain to the main IVLE site.
 
264
# Public mode does not use cookies, and serves only public content.
 
265
# Private mode (normal mode) requires login, and only serves files relevant to
 
266
# the logged-in user."""))
 
267
config_options.append(ConfigOption("allowed_uids", "33",
 
268
    """UID of the web server process which will run IVLE.
 
269
Only this user may execute the trampoline. May specify multiple users as
 
270
a comma-separated list.
 
271
    (eg. "1002,78")""",
 
272
    """
 
273
# The User-ID of the web server process which will run IVLE, and any other
 
274
# users who are allowed to run the trampoline. This is stores as a string of
 
275
# comma-separated integers, simply because it is not used within Python, only
 
276
# used by the setup program to write to conf.h (see setup.py config)."""))
 
277
config_options.append(ConfigOption("db_host", "localhost",
 
278
    """PostgreSQL Database config
 
279
==========================
 
280
Hostname of the DB server:""",
 
281
    """
 
282
### PostgreSQL Database config ###
 
283
# Database server hostname"""))
 
284
config_options.append(ConfigOption("db_port", "5432",
 
285
    """Port of the DB server:""",
 
286
    """
 
287
# Database server port"""))
 
288
config_options.append(ConfigOption("db_dbname", "ivle",
 
289
    """Database name:""",
 
290
    """
 
291
# Database name"""))
 
292
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
 
293
    """Forum Database name:""",
 
294
    """
 
295
# Forum Database name"""))
 
296
config_options.append(ConfigOption("db_user", "postgres",
 
297
    """Username for DB server login:""",
 
298
    """
 
299
# Database username"""))
 
300
config_options.append(ConfigOption("db_password", "",
 
301
    """Password for DB server login:
 
302
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
 
303
    """
 
304
# Database password"""))
 
305
config_options.append(ConfigOption("auth_modules", "ldap_auth",
 
306
    """Authentication config
 
307
=====================
 
308
Comma-separated list of authentication modules. Only "ldap" is available
 
309
by default.""",
 
310
    """
 
311
# Comma-separated list of authentication modules.
 
312
# These refer to importable Python modules in the www/auth directory.
 
313
# Modules "ldap" and "guest" are available in the source tree, but
 
314
# other modules may be plugged in to auth against organisation-specific
 
315
# auth backends."""))
 
316
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
 
317
    """(LDAP options are only relevant if "ldap" is included in the list of
 
318
auth modules).
 
319
URL for LDAP authentication server:""",
 
320
    """
 
321
# URL for LDAP authentication server"""))
 
322
config_options.append(ConfigOption("ldap_format_string",
 
323
    "uid=%s,ou=users,o=example",
 
324
    """Format string for LDAP auth request:
 
325
    (Must contain a single "%s" for the user's login name)""",
 
326
    """
 
327
# Format string for LDAP auth request
 
328
# (Must contain a single "%s" for the user's login name)"""))
 
329
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
 
330
    """Subversion config
 
331
=================
 
332
The base url for accessing subversion repositories:""",
 
333
    """
 
334
# The base url for accessing subversion repositories."""))
 
335
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
 
336
    """The location of the subversion configuration file used by apache
 
337
to host the user repositories:""",
 
338
    """
 
339
# The location of the subversion configuration file used by
 
340
# apache to host the user repositories."""))
 
341
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
 
342
    """The root directory for the subversion repositories:""",
 
343
    """
 
344
# The root directory for the subversion repositories."""))
 
345
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
 
346
    """The location of the password file used to authenticate users
 
347
of the subversion repository from the ivle server:""",
 
348
    """
 
349
# The location of the password file used to authenticate users
 
350
# of the subversion repository from the ivle server."""))
 
351
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
 
352
    """The location of the password file used to authenticate local users
 
353
of the subversion repository:""",
 
354
    """
 
355
# The location of the password file used to authenticate local users
 
356
# of the subversion repository."""))
 
357
config_options.append(ConfigOption("usrmgt_host", "localhost",
 
358
    """User Management Server config
 
359
============================
 
360
The hostname where the usrmgt-server runs:""",
 
361
    """
 
362
# The hostname where the usrmgt-server runs."""))
 
363
config_options.append(ConfigOption("usrmgt_port", "2178",
 
364
    """The port where the usrmgt-server runs:""",
 
365
    """
 
366
# The port where the usrmgt-server runs."""))
 
367
config_options.append(ConfigOption("usrmgt_magic", "",
 
368
    """The password for the usrmgt-server:""",
 
369
    """
 
370
# The password for the usrmgt-server."""))
70
371
 
71
372
# Try importing existing conf, but if we can't just set up defaults
72
373
# The reason for this is that these settings are used by other phases
73
374
# of setup besides conf, so we need to know them.
74
375
# Also this allows you to hit Return to accept the existing value.
75
376
try:
76
 
    confmodule = __import__("www/conf/conf")
77
 
    root_dir = confmodule.root_dir
78
 
    ivle_install_dir = confmodule.ivle_install_dir
79
 
    jail_base = confmodule.jail_base
 
377
    confmodule = __import__("lib/conf/conf")
 
378
    for opt in config_options:
 
379
        try:
 
380
            globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
 
381
        except:
 
382
            globals()[opt.option_name] = opt.default
80
383
except ImportError:
81
384
    # Just set reasonable defaults
82
 
    root_dir = "/ivle"
83
 
    ivle_install_dir = "/opt/ivle"
84
 
    jail_base = "/home/informatics/jails"
85
 
# Always defaults
86
 
allowed_uids = "0"
 
385
    for opt in config_options:
 
386
        globals()[opt.option_name] = opt.default
87
387
 
88
388
# Try importing install_list, but don't fail if we can't, because listmake can
89
389
# function without it.
98
398
# as necessary, and include it in the distribution.
99
399
listmake_mimetypes = ['text/x-python', 'text/html',
100
400
    'application/x-javascript', 'application/javascript',
101
 
    'text/css', 'image/png']
 
401
    'text/css', 'image/png', 'image/gif', 'application/xml']
102
402
 
103
403
# Main function skeleton from Guido van Rossum
104
404
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
127
427
        return 1
128
428
 
129
429
    # Disallow run as root unless installing
130
 
    if operation != 'install' and os.geteuid() == 0:
 
430
    if (operation != 'install' and operation != 'updatejails'
 
431
        and os.geteuid() == 0):
131
432
        print >>sys.stderr, "I do not want to run this stage as root."
132
433
        print >>sys.stderr, "Please run as a normal user."
133
434
        return 1
135
436
    try:
136
437
        oper_func = {
137
438
            'help' : help,
138
 
            'conf' : conf,
 
439
            'config' : conf,
139
440
            'build' : build,
140
441
            'listmake' : listmake,
141
442
            'install' : install,
 
443
            'updatejails' : updatejails,
142
444
        }[operation]
143
445
    except KeyError:
144
446
        print >>sys.stderr, (
155
457
Operation (and args) can be:
156
458
    help [operation]
157
459
    listmake (developer use only)
158
 
    conf [args]
 
460
    config [args]
159
461
    build
160
 
    install [--nojail] [-n|--dry]
 
462
    install [--nojail] [--nosubjects] [-n|--dry]
161
463
"""
162
464
        return 1
163
465
    elif len(args) != 1:
176
478
be copied upon installation. This should be run by the developer before
177
479
cutting a distribution, and the listfile it generates should be included in
178
480
the distribution, avoiding the administrator having to run it."""
179
 
    elif operation == 'conf':
180
 
        print """python setup.py conf [args]
 
481
    elif operation == 'config':
 
482
        print """python setup.py config [args]
181
483
Configures IVLE with machine-specific details, most notably, various paths.
182
484
Either prompts the administrator for these details or accepts them as
183
485
command-line args. Will be interactive only if there are no arguments given.
187
489
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
188
490
directory, and run build/install one time.
189
491
 
190
 
Creates www/conf/conf.py and trampoline/conf.h.
 
492
Creates lib/conf/conf.py and trampoline/conf.h.
191
493
 
192
 
Args are:
193
 
    --root_dir
194
 
    --ivle_install_dir
195
 
    --jail_base
196
 
    --allowed_uids
197
 
As explained in the interactive prompt or conf.py.
 
494
Args are:"""
 
495
        for opt in config_options:
 
496
            print "    --" + opt.option_name
 
497
        print """As explained in the interactive prompt or conf.py.
198
498
"""
199
499
    elif operation == 'build':
200
500
        print """python -O setup.py build [--dry|-n]
211
511
 
212
512
--dry | -n  Print out the actions but don't do anything."""
213
513
    elif operation == 'install':
214
 
        print """sudo python setup.py install [--nojail] [--dry|-n]
 
514
        print """sudo python setup.py install [--nojail] [--nosubjects][--dry|-n]
215
515
(Requires root)
216
516
Create target install directory ($target).
217
517
Create $target/bin.
219
519
chown and chmod the installed trampoline.
220
520
Copy www/ to $target.
221
521
Copy jail/ to jails template directory (unless --nojail specified).
222
 
 
223
 
--nojail    Do not copy the jail.
 
522
Copy subjects/ to subjects directory (unless --nosubjects specified).
 
523
 
 
524
--nojail        Do not copy the jail.
 
525
--nosubjects    Do not copy the subjects and exercises directories.
 
526
--dry | -n  Print out the actions but don't do anything."""
 
527
    elif operation == 'updatejails':
 
528
        print """sudo python setup.py updatejails [--dry|-n]
 
529
(Requires root)
 
530
Copy jail/ to each subdirectory in jails directory.
 
531
 
224
532
--dry | -n  Print out the actions but don't do anything."""
225
533
    else:
226
534
        print >>sys.stderr, (
231
539
def listmake(args):
232
540
    # We build two separate lists, by walking www and console
233
541
    list_www = build_list_py_files('www')
234
 
    list_console = build_list_py_files('console')
 
542
    list_lib = build_list_py_files('lib')
 
543
    list_subjects = build_list_py_files('subjects', no_top_level=True)
 
544
    list_exercises = build_list_py_files('exercises', no_top_level=True)
 
545
    list_scripts = [
 
546
        "scripts/python-console",
 
547
        "scripts/fileservice",
 
548
        "scripts/serveservice",
 
549
        "scripts/usrmgt-server",
 
550
        "scripts/diffservice",
 
551
    ]
235
552
    # Make sure that the files generated by conf are in the list
236
553
    # (since listmake is typically run before conf)
237
 
    if "www/conf/conf.py" not in list_www:
238
 
        list_www.append("www/conf/conf.py")
239
 
    # Make sure that console/python-console is in the list
240
 
    if "console/python-console" not in list_console:
241
 
        list_console.append("console/python-console")
 
554
    if "lib/conf/conf.py" not in list_lib:
 
555
        list_lib.append("lib/conf/conf.py")
242
556
    # Write these out to a file
243
557
    cwd = os.getcwd()
244
558
    # the files that will be created/overwritten
258
572
list_www = """)
259
573
        writelist_pretty(file, list_www)
260
574
        file.write("""
261
 
# List of all installable files in console directory.
262
 
list_console = """)
263
 
        writelist_pretty(file, list_console)
 
575
# List of all installable files in lib directory.
 
576
list_lib = """)
 
577
        writelist_pretty(file, list_lib)
 
578
        file.write("""
 
579
# List of all installable files in scripts directory.
 
580
list_scripts = """)
 
581
        writelist_pretty(file, list_scripts)
 
582
        file.write("""
 
583
# List of all installable files in subjects directory.
 
584
# This is to install sample subjects and material.
 
585
list_subjects = """)
 
586
        writelist_pretty(file, list_subjects)
 
587
        file.write("""
 
588
# List of all installable files in exercises directory.
 
589
# This is to install sample exercise material.
 
590
list_exercises = """)
 
591
        writelist_pretty(file, list_exercises)
264
592
 
265
593
        file.close()
266
594
    except IOError, (errno, strerror):
277
605
 
278
606
    return 0
279
607
 
280
 
def build_list_py_files(dir):
 
608
def build_list_py_files(dir, no_top_level=False):
281
609
    """Builds a list of all py files found in a directory and its
282
 
    subdirectories. Returns this as a list of strings."""
 
610
    subdirectories. Returns this as a list of strings.
 
611
    no_top_level=True means the file paths will not include the top-level
 
612
    directory.
 
613
    """
283
614
    pylist = []
284
615
    for (dirpath, dirnames, filenames) in os.walk(dir):
285
616
        # Exclude directories beginning with a '.' (such as '.svn')
287
618
        # All *.py files are added to the list
288
619
        pylist += [os.path.join(dirpath, item) for item in filenames
289
620
            if mimetypes.guess_type(item)[0] in listmake_mimetypes]
 
621
    if no_top_level:
 
622
        for i in range(0, len(pylist)):
 
623
            _, pylist[i] = pylist[i].split(os.sep, 1)
290
624
    return pylist
291
625
 
292
626
def writelist_pretty(file, list):
300
634
        file.write(']\n')
301
635
 
302
636
def conf(args):
303
 
    global root_dir, ivle_install_dir, jail_base, allowed_uids
 
637
    global db_port, usrmgt_port
304
638
    # Set up some variables
305
639
 
306
640
    cwd = os.getcwd()
307
641
    # the files that will be created/overwritten
308
 
    conffile = os.path.join(cwd, "www/conf/conf.py")
 
642
    conffile = os.path.join(cwd, "lib/conf/conf.py")
 
643
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
309
644
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
310
 
 
311
 
    # Fixed config options that we don't ask the admin
312
 
    default_app = "dummy"
 
645
    phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
 
646
    usrmgtserver_initdfile = os.path.join(cwd, "doc/setup/usrmgt-server.init")
313
647
 
314
648
    # Get command-line arguments to avoid asking questions.
315
649
 
316
 
    (opts, args) = getopt.gnu_getopt(args, "", ['root_dir=',
317
 
                    'ivle_install_dir=', 'jail_base=', 'allowed_uids='])
 
650
    optnames = []
 
651
    for opt in config_options:
 
652
        optnames.append(opt.option_name + "=")
 
653
    (opts, args) = getopt.gnu_getopt(args, "", optnames)
318
654
 
319
655
    if args != []:
320
656
        print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
326
662
        print """This tool will create the following files:
327
663
    %s
328
664
    %s
 
665
    %s
 
666
    %s
 
667
    %s
329
668
prompting you for details about your configuration. The file will be
330
669
overwritten if it already exists. It will *not* install or deploy IVLE.
331
670
 
332
671
Please hit Ctrl+C now if you do not wish to do this.
333
 
""" % (conffile, conf_hfile)
 
672
""" % (conffile, jailconffile, conf_hfile, phpBBconffile, usrmgtserver_initdfile)
334
673
 
335
674
        # Get information from the administrator
336
675
        # If EOF is encountered at any time during the questioning, just exit
337
676
        # silently
338
677
 
339
 
        root_dir = query_user(root_dir,
340
 
        """Root directory where IVLE is located (in URL space):""")
341
 
        ivle_install_dir = query_user(ivle_install_dir,
342
 
        'Root directory where IVLE will be installed (on the local file '
343
 
        'system):')
344
 
        jail_base = query_user(jail_base,
345
 
        """Root directory where the jails (containing user files) are stored
346
 
(on the local file system):""")
347
 
        allowed_uids = query_user(allowed_uids,
348
 
        """UID of the web server process which will run IVLE.
349
 
Only this user may execute the trampoline. May specify multiple users as
350
 
a comma-separated list.
351
 
    (eg. "1002,78")""")
352
 
 
 
678
        for opt in config_options:
 
679
            globals()[opt.option_name] = \
 
680
                query_user(globals()[opt.option_name], opt.prompt)
353
681
    else:
354
682
        opts = dict(opts)
355
683
        # Non-interactive mode. Parse the options.
356
 
        if '--root_dir' in opts:
357
 
            root_dir = opts['--root_dir']
358
 
        if '--ivle_install_dir' in opts:
359
 
            ivle_install_dir = opts['--ivle_install_dir']
360
 
        if '--jail_base' in opts:
361
 
            jail_base = opts['--jail_base']
362
 
        if '--allowed_uids' in opts:
363
 
            allowed_uids = opts['--allowed_uids']
 
684
        for opt in config_options:
 
685
            if '--' + opt.option_name in opts:
 
686
                globals()[opt.option_name] = opts['--' + opt.option_name]
364
687
 
365
688
    # Error handling on input values
366
689
    try:
367
 
        allowed_uids = map(int, allowed_uids.split(','))
 
690
        allowed_uids_list = map(int, allowed_uids.split(','))
368
691
    except ValueError:
369
692
        print >>sys.stderr, (
370
693
        "Invalid UID list (%s).\n"
371
694
        "Must be a comma-separated list of integers." % allowed_uids)
372
695
        return 1
373
 
 
374
 
    # Write www/conf/conf.py
 
696
    try:
 
697
        db_port = int(db_port)
 
698
        if db_port < 0 or db_port >= 65536: raise ValueError()
 
699
    except ValueError:
 
700
        print >>sys.stderr, (
 
701
        "Invalid DB port (%s).\n"
 
702
        "Must be an integer between 0 and 65535." % repr(db_port))
 
703
        return 1
 
704
    try:
 
705
        usrmgt_port = int(usrmgt_port)
 
706
        if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
 
707
    except ValueError:
 
708
        print >>sys.stderr, (
 
709
        "Invalid user management port (%s).\n"
 
710
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
 
711
        return 1
 
712
 
 
713
    # Generate the forum secret
 
714
    forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
715
 
 
716
    # Write lib/conf/conf.py
375
717
 
376
718
    try:
377
719
        conf = open(conffile, "w")
380
722
# conf.py
381
723
# Miscellaneous application settings
382
724
 
 
725
""")
 
726
        for opt in config_options:
 
727
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
 
728
                repr(globals()[opt.option_name])))
 
729
 
 
730
        # Add the forum secret to the config file (regenerated each config)
 
731
        conf.write('forum_secret = "%s"\n' % (forum_secret))
 
732
 
 
733
        conf.close()
 
734
    except IOError, (errno, strerror):
 
735
        print "IO error(%s): %s" % (errno, strerror)
 
736
        sys.exit(1)
 
737
 
 
738
    print "Successfully wrote lib/conf/conf.py"
 
739
 
 
740
    # Write conf/jailconf.py
 
741
 
 
742
    try:
 
743
        conf = open(jailconffile, "w")
 
744
 
 
745
        # In the "in-jail" version of conf, we don't need MOST of the details
 
746
        # (it would be a security risk to have them here).
 
747
        # So we just write root_dir, and jail_base is "/".
 
748
        # (jail_base being "/" means "jail-relative" paths are relative to "/"
 
749
        # when inside the jail.)
 
750
        conf.write("""# IVLE Configuration File
 
751
# conf.py
 
752
# Miscellaneous application settings
 
753
# (User jail version)
 
754
 
383
755
 
384
756
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
385
757
# with this).
386
758
# eg. "/" or "/ivle".
387
 
root_dir = "%s"
388
 
 
389
 
# In the local file system, where IVLE is actually installed.
390
 
# This directory should contain the "www" and "bin" directories.
391
 
ivle_install_dir = "%s"
 
759
root_dir = %s
392
760
 
393
761
# In the local file system, where are the student/user file spaces located.
394
762
# The user jails are expected to be located immediately in subdirectories of
395
763
# this location.
396
 
jail_base = "%s"
 
764
jail_base = '/'
397
765
 
398
 
# Which application to load by default (if the user navigates to the top level
399
 
# of the site). This is the app's URL name.
400
 
# Note that if this app requires authentication, the user will first be
401
 
# presented with the login screen.
402
 
default_app = "%s"
403
 
""" % (root_dir, ivle_install_dir, jail_base, default_app))
 
766
# The hostname for serving publicly accessible pages
 
767
public_host = %s
 
768
""" % (repr(root_dir),repr(public_host)))
404
769
 
405
770
        conf.close()
406
771
    except IOError, (errno, strerror):
407
772
        print "IO error(%s): %s" % (errno, strerror)
408
773
        sys.exit(1)
409
774
 
410
 
    print "Successfully wrote www/conf/conf.py"
 
775
    print "Successfully wrote lib/conf/jailconf.py"
411
776
 
412
777
    # Write trampoline/conf.h
413
778
 
432
797
 * (Note that root is an implicit member of this list).
433
798
 */
434
799
static const int allowed_uids[] = { %s };
435
 
""" % (jail_base, repr(allowed_uids)[1:-1]))
 
800
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
 
801
    # Note: The above uses PYTHON reprs, not C reprs
 
802
    # However they should be the same with the exception of the outer
 
803
    # characters, which are stripped off and replaced
436
804
 
437
805
        conf.close()
438
806
    except IOError, (errno, strerror):
441
809
 
442
810
    print "Successfully wrote trampoline/conf.h"
443
811
 
 
812
    # Write www/php/phpBB3/config.php
 
813
 
 
814
    try:
 
815
        conf = open(phpBBconffile, "w")
 
816
        
 
817
        # php-pg work around
 
818
        if db_host == 'localhost':
 
819
            forumdb_host = '127.0.0.1'
 
820
        else:
 
821
            forumdb_host = db_host
 
822
 
 
823
        conf.write( """<?php
 
824
// phpBB 3.0.x auto-generated configuration file
 
825
// Do not change anything in this file!
 
826
$dbms = 'postgres';
 
827
$dbhost = '""" + forumdb_host + """';
 
828
$dbport = '""" + str(db_port) + """';
 
829
$dbname = '""" + db_forumdbname + """';
 
830
$dbuser = '""" + db_user + """';
 
831
$dbpasswd = '""" + db_password + """';
 
832
 
 
833
$table_prefix = 'phpbb_';
 
834
$acm_type = 'file';
 
835
$load_extensions = '';
 
836
@define('PHPBB_INSTALLED', true);
 
837
// @define('DEBUG', true);
 
838
//@define('DEBUG_EXTRA', true);
 
839
 
 
840
$forum_secret = '""" + forum_secret +"""';
 
841
?>"""   )
 
842
    
 
843
        conf.close()
 
844
    except IOError, (errno, strerror):
 
845
        print "IO error(%s): %s" % (errno, strerror)
 
846
        sys.exit(1)
 
847
 
 
848
    print "Successfully wrote www/php/phpBB3/config.php"
 
849
 
 
850
    # Write lib/conf/usrmgt-server.init
 
851
 
 
852
    try:
 
853
        conf = open(usrmgtserver_initdfile, "w")
 
854
 
 
855
        conf.write( '''#! /bin/sh
 
856
 
 
857
# Works for Ubuntu. Check before using on other distributions
 
858
 
 
859
### BEGIN INIT INFO
 
860
# Provides:          usrmgt-server
 
861
# Required-Start:    $syslog $networking $urandom
 
862
# Required-Stop:     $syslog
 
863
# Default-Start:     2 3 4 5
 
864
# Default-Stop:      1
 
865
# Short-Description: IVLE user management server
 
866
# Description:       Daemon connecting to the IVLE user management database.
 
867
### END INIT INFO
 
868
 
 
869
PATH=/sbin:/bin:/usr/sbin:/usr/bin
 
870
DESC="IVLE user management server"
 
871
NAME=usrmgt-server
 
872
DAEMON=/opt/ivle/scripts/$NAME
 
873
DAEMON_ARGS="''' + str(usrmgt_port) + ''' ''' + usrmgt_magic + '''"
 
874
PIDFILE=/var/run/$NAME.pid
 
875
SCRIPTNAME=/etc/init.d/usrmgt-server
 
876
 
 
877
# Exit if the daemon does not exist 
 
878
test -f $DAEMON || exit 0
 
879
 
 
880
# Load the VERBOSE setting and other rcS variables
 
881
[ -f /etc/default/rcS ] && . /etc/default/rcS
 
882
 
 
883
# Define LSB log_* functions.
 
884
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
 
885
. /lib/lsb/init-functions
 
886
 
 
887
#
 
888
# Function that starts the daemon/service
 
889
#
 
890
do_start()
 
891
{
 
892
        # Return
 
893
        #   0 if daemon has been started
 
894
        #   1 if daemon was already running
 
895
        #   2 if daemon could not be started
 
896
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
 
897
                || return 1
 
898
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
 
899
                $DAEMON_ARGS \
 
900
                || return 2
 
901
        # Add code here, if necessary, that waits for the process to be ready
 
902
        # to handle requests from services started subsequently which depend
 
903
        # on this one.  As a last resort, sleep for some time.
 
904
}
 
905
 
 
906
#
 
907
# Function that stops the daemon/service
 
908
#
 
909
do_stop()
 
910
{
 
911
        # Return
 
912
        #   0 if daemon has been stopped
 
913
        #   1 if daemon was already stopped
 
914
        #   2 if daemon could not be stopped
 
915
        #   other if a failure occurred
 
916
        start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
 
917
        RETVAL="$?"
 
918
        [ "$RETVAL" = 2 ] && return 2
 
919
        # Wait for children to finish too if this is a daemon that forks
 
920
        # and if the daemon is only ever run from this initscript.
 
921
        # If the above conditions are not satisfied then add some other code
 
922
        # that waits for the process to drop all resources that could be
 
923
        # needed by services started subsequently.  A last resort is to
 
924
        # sleep for some time.
 
925
        start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
 
926
        [ "$?" = 2 ] && return 2
 
927
        # Many daemons don't delete their pidfiles when they exit.
 
928
        rm -f $PIDFILE
 
929
        return "$RETVAL"
 
930
}
 
931
 
 
932
#
 
933
# Function that sends a SIGHUP to the daemon/service
 
934
#
 
935
do_reload() {
 
936
        #
 
937
        # If the daemon can reload its configuration without
 
938
        # restarting (for example, when it is sent a SIGHUP),
 
939
        # then implement that here.
 
940
        #
 
941
        start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
 
942
        return 0
 
943
}
 
944
 
 
945
case "$1" in
 
946
  start)
 
947
    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
 
948
        do_start
 
949
        case "$?" in
 
950
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
 
951
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
 
952
        esac
 
953
        ;;
 
954
  stop)
 
955
        [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
 
956
        do_stop
 
957
        case "$?" in
 
958
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
 
959
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
 
960
        esac
 
961
        ;;
 
962
  #reload|force-reload)
 
963
        #
 
964
        # If do_reload() is not implemented then leave this commented out
 
965
        # and leave 'force-reload' as an alias for 'restart'.
 
966
        #
 
967
        #log_daemon_msg "Reloading $DESC" "$NAME"
 
968
        #do_reload
 
969
        #log_end_msg $?
 
970
        #;;
 
971
  restart|force-reload)
 
972
        #
 
973
        # If the "reload" option is implemented then remove the
 
974
        # 'force-reload' alias
 
975
        #
 
976
        log_daemon_msg "Restarting $DESC" "$NAME"
 
977
        do_stop
 
978
        case "$?" in
 
979
          0|1)
 
980
                do_start
 
981
                case "$?" in
 
982
                        0) log_end_msg 0 ;;
 
983
                        1) log_end_msg 1 ;; # Old process is still running
 
984
                        *) log_end_msg 1 ;; # Failed to start
 
985
                esac
 
986
                ;;
 
987
          *)
 
988
                # Failed to stop
 
989
                log_end_msg 1
 
990
                ;;
 
991
        esac
 
992
        ;;
 
993
  *)
 
994
        #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
 
995
        echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
 
996
        exit 3
 
997
        ;;
 
998
esac
 
999
 
 
1000
:
 
1001
''')
 
1002
        
 
1003
        conf.close()
 
1004
    except IOError, (errno, strerror):
 
1005
        print "IO error(%s): %s" % (errno, strerror)
 
1006
        sys.exit(1)
 
1007
 
 
1008
    # fix permissions as the file contains the database password
 
1009
    try:
 
1010
        os.chmod('doc/setup/usrmgt-server.init', 0600)
 
1011
    except OSError, (errno, strerror):
 
1012
        print "WARNING: Couldn't chmod doc/setup/usrmgt-server.init:"
 
1013
        print "OS error(%s): %s" % (errno, strerror)
 
1014
 
 
1015
    print "Successfully wrote lib/conf/usrmgt-server.init"
 
1016
 
444
1017
    print
445
1018
    print "You may modify the configuration at any time by editing"
446
1019
    print conffile
 
1020
    print jailconffile
447
1021
    print conf_hfile
 
1022
    print phpBBconffile
 
1023
    print usrmgtserver_initdfile
448
1024
    print
449
1025
    return 0
450
1026
 
458
1034
        print "Dry run (no actions will be executed\n"
459
1035
 
460
1036
    # Compile the trampoline
461
 
    action_runprog('gcc', ['-Wall', '-o', 'trampoline/trampoline',
462
 
        'trampoline/trampoline.c'], dry)
 
1037
    curdir = os.getcwd()
 
1038
    os.chdir('trampoline')
 
1039
    action_runprog('make', [], dry)
 
1040
    os.chdir(curdir)
463
1041
 
464
1042
    # Create the jail and its subdirectories
465
1043
    # Note: Other subdirs will be made by copying files
467
1045
    action_mkdir('jail/home', dry)
468
1046
    action_mkdir('jail/tmp', dry)
469
1047
 
 
1048
    # Chmod the tmp directory to world writable
 
1049
    action_chmod_w('jail/tmp', dry)
 
1050
 
470
1051
    # Copy all console and operating system files into the jail
471
 
    action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
 
1052
    action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
472
1053
    copy_os_files_jail(dry)
 
1054
    # Chmod the python console
 
1055
    action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
 
1056
    action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
 
1057
    action_chmod_x('jail/opt/ivle/scripts/serveservice', dry)
 
1058
    
 
1059
    # Also copy the IVLE lib directory into the jail
 
1060
    # This is necessary for running certain scripts
 
1061
    action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
 
1062
    # IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
 
1063
    # which could compromise security if left in the jail (such as the DB
 
1064
    # password).
 
1065
    # The "safe" version is in jailconf.py. Delete conf.py and replace it with
 
1066
    # jailconf.py.
 
1067
    action_copyfile('lib/conf/jailconf.py',
 
1068
        'jail/opt/ivle/lib/conf/conf.py', dry)
473
1069
 
474
1070
    # Compile .py files into .pyc or .pyo files
475
1071
    compileall.compile_dir('www', quiet=True)
476
 
    compileall.compile_dir('console', quiet=True)
 
1072
    compileall.compile_dir('lib', quiet=True)
 
1073
    compileall.compile_dir('scripts', quiet=True)
 
1074
    compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
 
1075
 
 
1076
    # Set up ivle.pth inside the jail
 
1077
    # Need to set /opt/ivle/lib to be on the import path
 
1078
    ivle_pth = \
 
1079
        "jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
 
1080
    f = open(ivle_pth, 'w')
 
1081
    f.write('/opt/ivle/lib\n')
 
1082
    f.close()
477
1083
 
478
1084
    return 0
479
1085
 
481
1087
    """Copies necessary Operating System files from their usual locations
482
1088
    into the jail/ directory of the cwd."""
483
1089
    # Currently source paths are configured for Ubuntu.
484
 
    copy_file_to_jail('/lib/ld-linux.so.2', dry)
485
 
    copy_file_to_jail('/lib/tls/i686/cmov/libc.so.6', dry)
486
 
    copy_file_to_jail('/lib/tls/i686/cmov/libdl.so.2', dry)
487
 
    copy_file_to_jail('/lib/tls/i686/cmov/libm.so.6', dry)
488
 
    copy_file_to_jail('/lib/tls/i686/cmov/libpthread.so.0', dry)
489
 
    copy_file_to_jail('/lib/tls/i686/cmov/libutil.so.1', dry)
490
 
    copy_file_to_jail('/usr/bin/python2.5', dry)
491
 
    action_symlink('python2.5', 'jail/usr/bin/python', dry)
492
 
    action_copytree('/usr/lib/python2.5', 'jail/usr/lib/python2.5', dry)
 
1090
    for filename in JAIL_FILES:
 
1091
        copy_file_to_jail(filename, dry)
 
1092
    for src, dst in JAIL_LINKS.items():
 
1093
        action_symlink(src, dst, dry)
 
1094
    for src, dst in JAIL_COPYTREES.items():
 
1095
        action_copytree(src, dst, dry)
493
1096
 
494
1097
def copy_file_to_jail(src, dry):
495
1098
    """Copies a single file from an absolute location into the same location
499
1102
 
500
1103
def install(args):
501
1104
    # Get "dry" and "nojail" variables from command line
502
 
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry', 'nojail'])
 
1105
    (opts, args) = getopt.gnu_getopt(args, "n",
 
1106
        ['dry', 'nojail', 'nosubjects'])
503
1107
    opts = dict(opts)
504
1108
    dry = '-n' in opts or '--dry' in opts
505
1109
    nojail = '--nojail' in opts
 
1110
    nosubjects = '--nosubjects' in opts
506
1111
 
507
1112
    if dry:
508
1113
        print "Dry run (no actions will be executed\n"
522
1127
    # chown trampoline to root and set setuid bit
523
1128
    action_chown_setuid(tramppath, dry)
524
1129
 
525
 
    # Copy the www directory using the list
 
1130
    # Create a scripts directory to put the usrmgt-server in.
 
1131
    action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
 
1132
    usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
 
1133
    action_copyfile('scripts/usrmgt-server', usrmgtpath, dry)
 
1134
    action_chmod_x(usrmgtpath, dry)
 
1135
 
 
1136
    # Copy the www and lib directories using the list
526
1137
    action_copylist(install_list.list_www, ivle_install_dir, dry)
 
1138
    action_copylist(install_list.list_lib, ivle_install_dir, dry)
 
1139
    
 
1140
    # Copy the php directory
 
1141
    forum_dir = "www/php/phpBB3"
 
1142
    forum_path = os.path.join(ivle_install_dir, forum_dir)
 
1143
    action_copytree(forum_dir, forum_path, dry)
 
1144
    print "chown -R www-data:www-data %s" % forum_path
 
1145
    if not dry:
 
1146
        os.system("chown -R www-data:www-data %s" % forum_path)
527
1147
 
528
1148
    if not nojail:
529
1149
        # Copy the local jail directory built by the build action
530
1150
        # to the jails template directory (it will be used as a template
531
1151
        # for all the students' jails).
532
1152
        action_copytree('jail', os.path.join(jail_base, 'template'), dry)
 
1153
    if not nosubjects:
 
1154
        # Copy the subjects and exercises directories across
 
1155
        action_copylist(install_list.list_subjects, subjects_base, dry,
 
1156
            srcdir="./subjects")
 
1157
        action_copylist(install_list.list_exercises, exercises_base, dry,
 
1158
            srcdir="./exercises")
 
1159
 
 
1160
    # Append IVLE path to ivle.pth in python site packages
 
1161
    # (Unless it's already there)
 
1162
    ivle_pth = os.path.join(sys.prefix,
 
1163
        "lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
 
1164
    ivle_www = os.path.join(ivle_install_dir, "www")
 
1165
    ivle_lib = os.path.join(ivle_install_dir, "lib")
 
1166
    write_ivle_pth = True
 
1167
    write_ivle_lib_pth = True
 
1168
    try:
 
1169
        file = open(ivle_pth, 'r')
 
1170
        for line in file:
 
1171
            if line.strip() == ivle_www:
 
1172
                write_ivle_pth = False
 
1173
            elif line.strip() == ivle_lib:
 
1174
                write_ivle_lib_pth = False
 
1175
        file.close()
 
1176
    except (IOError, OSError):
 
1177
        pass
 
1178
    if write_ivle_pth:
 
1179
        action_append(ivle_pth, ivle_www)
 
1180
    if write_ivle_lib_pth:
 
1181
        action_append(ivle_pth, ivle_lib)
 
1182
 
 
1183
    return 0
 
1184
 
 
1185
def updatejails(args):
 
1186
    # Get "dry" variable from command line
 
1187
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
 
1188
    opts = dict(opts)
 
1189
    dry = '-n' in opts or '--dry' in opts
 
1190
 
 
1191
    if dry:
 
1192
        print "Dry run (no actions will be executed\n"
 
1193
 
 
1194
    if not dry and os.geteuid() != 0:
 
1195
        print >>sys.stderr, "Must be root to run install"
 
1196
        print >>sys.stderr, "(I need to chown some files)."
 
1197
        return 1
 
1198
 
 
1199
    # Update the template jail directory in case it hasn't been installed
 
1200
    # recently.
 
1201
    action_copytree('jail', os.path.join(jail_base, 'template'), dry)
 
1202
 
 
1203
    # Re-link all the files in all students jails.
 
1204
    for dir in os.listdir(jail_base):
 
1205
        if dir == 'template': continue
 
1206
        # First back up the student's home directory
 
1207
        temp_home = os.tmpnam()
 
1208
        action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
 
1209
        # Delete the student's jail and relink the jail files
 
1210
        action_linktree(os.path.join(jail_base, 'template'),
 
1211
            os.path.join(jail_base, dir), dry)
 
1212
        # Restore the student's home directory
 
1213
        action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
 
1214
        # Set up the user's home directory just in case they don't have a
 
1215
        # directory for this yet
 
1216
        action_mkdir(os.path.join(jail_base, dir, 'home', dir), dry)
533
1217
 
534
1218
    return 0
535
1219
 
562
1246
    if ret != 0:
563
1247
        raise RunError(prog, ret)
564
1248
 
 
1249
def action_remove(path, dry):
 
1250
    """Calls rmtree, deleting the target file if it exists."""
 
1251
    try:
 
1252
        print "rm -r", path
 
1253
        if not dry:
 
1254
            shutil.rmtree(path, True)
 
1255
    except OSError, (err, msg):
 
1256
        if err != errno.EEXIST:
 
1257
            raise
 
1258
        # Otherwise, didn't exist, so we don't care
 
1259
 
 
1260
def action_rename(src, dst, dry):
 
1261
    """Calls rename. Deletes the target if it already exists."""
 
1262
    action_remove(dst, dry)
 
1263
    print "mv ", src, dst
 
1264
    if dry: return
 
1265
    try:
 
1266
        os.rename(src, dst)
 
1267
    except OSError, (err, msg):
 
1268
        if err != errno.EEXIST:
 
1269
            raise
 
1270
 
565
1271
def action_mkdir(path, dry):
566
1272
    """Calls mkdir. Silently ignored if the directory already exists.
567
1273
    Creates all parent directories as necessary."""
579
1285
    directories as necessary.
580
1286
 
581
1287
    See shutil.copytree."""
582
 
    if os.access(dst, os.F_OK):
583
 
        print "rm -r", dst
584
 
        if not dry:
585
 
            shutil.rmtree(dst, True)
 
1288
    # Allow copying over itself
 
1289
    if (os.path.normpath(os.path.join(os.getcwd(),src)) ==
 
1290
        os.path.normpath(os.path.join(os.getcwd(),dst))):
 
1291
        return
 
1292
    action_remove(dst, dry)
586
1293
    print "cp -r", src, dst
587
1294
    if dry: return
588
1295
    shutil.copytree(src, dst, True)
589
1296
 
590
 
def action_copylist(srclist, dst, dry):
 
1297
def action_linktree(src, dst, dry):
 
1298
    """Hard-links an entire directory tree. Same as copytree but the created
 
1299
    files are hard-links not actual copies. Removes the existing destination.
 
1300
    """
 
1301
    action_remove(dst, dry)
 
1302
    print "<cp with hardlinks> -r", src, dst
 
1303
    if dry: return
 
1304
    common.makeuser.linktree(src, dst)
 
1305
 
 
1306
def action_copylist(srclist, dst, dry, srcdir="."):
591
1307
    """Copies all files in a list to a new location. The files in the list
592
1308
    are read relative to the current directory, and their destinations are the
593
1309
    same paths relative to dst. Creates all parent directories as necessary.
 
1310
    srcdir is "." by default, can be overridden.
594
1311
    """
595
1312
    for srcfile in srclist:
596
1313
        dstfile = os.path.join(dst, srcfile)
 
1314
        srcfile = os.path.join(srcdir, srcfile)
597
1315
        dstdir = os.path.split(dstfile)[0]
598
1316
        if not os.path.isdir(dstdir):
599
1317
            action_mkdir(dstdir, dry)
608
1326
def action_copyfile(src, dst, dry):
609
1327
    """Copies one file to a new location. Creates all parent directories
610
1328
    as necessary.
 
1329
    Warn if file not found.
611
1330
    """
612
1331
    dstdir = os.path.split(dst)[0]
613
1332
    if not os.path.isdir(dstdir):
617
1336
        try:
618
1337
            shutil.copyfile(src, dst)
619
1338
            shutil.copymode(src, dst)
620
 
        except shutil.Error:
621
 
            pass
 
1339
        except (shutil.Error, IOError), e:
 
1340
            print "Warning: " + str(e)
622
1341
 
623
1342
def action_symlink(src, dst, dry):
624
1343
    """Creates a symlink in a given location. Creates all parent directories
634
1353
    if not dry:
635
1354
        os.symlink(src, dst)
636
1355
 
 
1356
def action_append(ivle_pth, ivle_www):
 
1357
    file = open(ivle_pth, 'a+')
 
1358
    file.write(ivle_www + '\n')
 
1359
    file.close()
 
1360
 
637
1361
def action_chown_setuid(file, dry):
638
1362
    """Chowns a file to root, and sets the setuid bit on the file.
639
1363
    Calling this function requires the euid to be root.
648
1372
        os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
649
1373
            | stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
650
1374
 
 
1375
def action_chmod_x(file, dry):
 
1376
    """Chmod 755 a file (sets permissions to rwxr-xr-x)."""
 
1377
    print "chmod 755", file
 
1378
    if not dry:
 
1379
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
 
1380
            | stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
 
1381
 
 
1382
 
 
1383
def action_chmod_w(file, dry):
 
1384
    """Chmod 777 a file (sets permissions to rwxrwxrwx)."""
 
1385
    print "chmod 777", file
 
1386
    if not dry:
 
1387
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
 
1388
            | stat.S_IXGRP | stat.S_IWGRP | stat.S_IRGRP | stat.S_IXOTH
 
1389
            | stat.S_IWOTH | stat.S_IROTH)
 
1390
 
651
1391
def query_user(default, prompt):
652
1392
    """Prompts the user for a string, which is read from a line of stdin.
653
1393
    Exits silently if EOF is encountered. Returns the string, with spaces