23
23
# This is a command-line application, for use by the administrator.
24
# Prompts the administrator to enter machine-specific details and builds the
26
# (This file is not included with the distribution precisely because it
27
# contains machine-specific settings).
24
# This program configures, builds and installs IVLE in three separate steps.
25
# It is called with at least one argument, which specifies which operation to
28
# setup.py listmake (for developer use only)
29
# Recurses through the source tree and builds a list of all files which should
30
# be copied upon installation. This should be run by the developer before
31
# cutting a distribution, and the listfile it generates should be included in
32
# the distribution, avoiding the administrator having to run it.
34
# setup.py config [args]
35
# Configures IVLE with machine-specific details, most notably, various paths.
36
# Either prompts the administrator for these details or accepts them as
38
# Creates lib/conf/conf.py and trampoline/conf.h.
41
# Compiles all files and sets up a jail template in the source directory.
43
# Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
45
# Creates standard subdirs inside the jail, eg bin, opt, home, tmp.
46
# Copies console/ to a location within the jail.
47
# Copies OS programs and files to corresponding locations within the jail
48
# (eg. python and Python libs, ld.so, etc).
49
# Generates .pyc files for all the IVLE .py files.
51
# setup.py install [--nojail] [--dry|n]
53
# Create target install directory ($target).
55
# Copy trampoline/trampoline to $target/bin.
56
# chown and chmod the installed trampoline.
57
# Copy www/ to $target.
58
# Copy jail/ to jails template directory (unless --nojail specified).
32
def query_user(prompt):
33
"""Prompts the user for a string, which is read from a line of stdin.
34
Exits silently if EOF is encountered. Returns the string, with spaces
35
removed from the beginning and end.
37
sys.stdout.write(prompt)
38
sys.stdout.write("\n>")
40
val = sys.stdin.readline()
41
except KeyboardInterrupt:
43
sys.stdout.write("\n")
45
sys.stdout.write("\n")
46
if val == '': sys.exit(1)
51
# Set up some variables
54
# conffile is the file that will be created/overwritten
55
conffile = os.path.join(cwd, "www/conf/conf.py")
57
# Fixed config options that we don't ask the admin
61
# Print the opening spiel including the GPL notice
63
print """IVLE - Informatics Virtual Learning Environment Setup
71
# Import modules from the website is tricky since they're in the www
73
sys.path.append(os.path.join(os.getcwd(), 'lib'))
75
import common.makeuser
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]
82
# Operating system files to copy over into the jail.
83
# These will be copied from the given place on the OS file system into the
84
# same place within the jail.
87
'/lib/tls/i686/cmov/libc.so.6',
88
'/lib/tls/i686/cmov/libdl.so.2',
89
'/lib/tls/i686/cmov/libm.so.6',
90
'/lib/tls/i686/cmov/libpthread.so.0',
91
'/lib/tls/i686/cmov/libutil.so.1',
94
# These 2 files do not exist in Ubuntu
95
#'/etc/ld.so.preload',
96
#'/etc/ld.so.nohwcap',
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',
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',
142
# Needed by matplotlib
143
'/usr/lib/i686/cmov/libssl.so.0.9.8',
144
'/usr/lib/i686/cmov/libcrypto.so.0.9.8',
145
'/lib/tls/i686/cmov/libnsl.so.1',
146
'/usr/lib/libz.so.1',
147
'/usr/lib/atlas/liblapack.so.3',
148
'/usr/lib/atlas/libblas.so.3',
149
'/usr/lib/libg2c.so.0',
150
'/usr/lib/libstdc++.so.6',
151
'/usr/lib/libfreetype.so.6',
152
'/usr/lib/libpng12.so.0',
153
'/usr/lib/libBLT.2.4.so.8.4',
154
'/usr/lib/libtk8.4.so.0',
155
'/usr/lib/libtcl8.4.so.0',
156
'/usr/lib/tcl8.4/init.tcl',
157
'/usr/lib/libX11.so.6',
158
'/usr/lib/libXau.so.6',
159
'/usr/lib/libXdmcp.so.6',
160
'/lib/libgcc_s.so.1',
163
# Symlinks to make within the jail. Src mapped to dst.
165
'python%s' % PYTHON_VERSION: 'jail/usr/bin/python',
167
# Trees to copy. Src mapped to dst (these will be passed to action_copytree).
169
'/usr/lib/python%s' % PYTHON_VERSION:
170
'jail/usr/lib/python%s' % PYTHON_VERSION,
171
'/usr/share/matplotlib': 'jail/usr/share/matplotlib',
172
'/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
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
184
comment: (Long) comment string stored in conf.py. Each line of this
185
string should begin with a '#'.
187
self.option_name = option_name
188
self.default = default
190
self.comment = comment
192
# Configuration options, defaults and descriptions
194
config_options.append(ConfigOption("root_dir", "/ivle",
195
"""Root directory where IVLE is located (in URL space):""",
197
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
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 '
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):""",
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):""",
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
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:""",
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.
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:""",
254
### PostgreSQL Database config ###
255
# Database server hostname"""))
256
config_options.append(ConfigOption("db_port", "5432",
257
"""Port of the DB server:""",
259
# Database server port"""))
260
config_options.append(ConfigOption("db_dbname", "ivle",
261
"""Database name:""",
264
config_options.append(ConfigOption("db_user", "postgres",
265
"""Username for DB server login:""",
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)""",
272
# Database password"""))
274
# Try importing existing conf, but if we can't just set up defaults
275
# The reason for this is that these settings are used by other phases
276
# of setup besides conf, so we need to know them.
277
# Also this allows you to hit Return to accept the existing value.
279
confmodule = __import__("lib/conf/conf")
280
for opt in config_options:
282
globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
284
globals()[opt.option_name] = opt.default
286
# Just set reasonable defaults
287
for opt in config_options:
288
globals()[opt.option_name] = opt.default
290
# Try importing install_list, but don't fail if we can't, because listmake can
291
# function without it.
297
# Mime types which will automatically be placed in the list by listmake.
298
# Note that listmake is not intended to be run by the final user (the system
299
# administrator who installs this), so the developers can customize the list
300
# as necessary, and include it in the distribution.
301
listmake_mimetypes = ['text/x-python', 'text/html',
302
'application/x-javascript', 'application/javascript',
303
'text/css', 'image/png', 'application/xml']
305
# Main function skeleton from Guido van Rossum
306
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
312
# Print the opening spiel including the GPL notice
314
print """IVLE - Informatics Virtual Learning Environment Setup
64
315
Copyright (C) 2007-2008 The University of Melbourne
65
316
IVLE comes with ABSOLUTELY NO WARRANTY.
66
317
This is free software, and you are welcome to redistribute it
67
318
under certain conditions. See LICENSE.txt for details.
71
This tool will create the file """ + conffile + """,
323
# First argument is the name of the setup operation
327
# Print usage message and exit
331
# Disallow run as root unless installing
332
if (operation != 'install' and operation != 'updatejails'
333
and os.geteuid() == 0):
334
print >>sys.stderr, "I do not want to run this stage as root."
335
print >>sys.stderr, "Please run as a normal user."
337
# Call the requested operation's function
343
'listmake' : listmake,
345
'updatejails' : updatejails,
348
print >>sys.stderr, (
349
"""Invalid operation '%s'. Try python setup.py help."""
352
return oper_func(argv[2:])
354
# Operation functions
358
print """Usage: python setup.py operation [args]
359
Operation (and args) can be:
361
listmake (developer use only)
364
install [--nojail] [--nosubjects] [-n|--dry]
368
print """Usage: python setup.py help [operation]"""
373
if operation == 'help':
374
print """python setup.py help [operation]
375
Prints the usage message or detailed help on an operation, then exits."""
376
elif operation == 'listmake':
377
print """python setup.py listmake
378
(For developer use only)
379
Recurses through the source tree and builds a list of all files which should
380
be copied upon installation. This should be run by the developer before
381
cutting a distribution, and the listfile it generates should be included in
382
the distribution, avoiding the administrator having to run it."""
383
elif operation == 'config':
384
print """python setup.py config [args]
385
Configures IVLE with machine-specific details, most notably, various paths.
386
Either prompts the administrator for these details or accepts them as
387
command-line args. Will be interactive only if there are no arguments given.
388
Takes defaults from existing conf file if it exists.
390
To run IVLE out of the source directory (allowing development without having
391
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
392
directory, and run build/install one time.
394
Creates lib/conf/conf.py and trampoline/conf.h.
397
for opt in config_options:
398
print " --" + opt.option_name
399
print """As explained in the interactive prompt or conf.py.
401
elif operation == 'build':
402
print """python -O setup.py build [--dry|-n]
403
Compiles all files and sets up a jail template in the source directory.
404
-O is recommended to cause compilation to be optimised.
406
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
408
Creates standard subdirs inside the jail, eg bin, opt, home, tmp.
409
Copies console/ to a location within the jail.
410
Copies OS programs and files to corresponding locations within the jail
411
(eg. python and Python libs, ld.so, etc).
412
Generates .pyc or .pyo files for all the IVLE .py files.
414
--dry | -n Print out the actions but don't do anything."""
415
elif operation == 'install':
416
print """sudo python setup.py install [--nojail] [--nosubjects][--dry|-n]
418
Create target install directory ($target).
420
Copy trampoline/trampoline to $target/bin.
421
chown and chmod the installed trampoline.
422
Copy www/ to $target.
423
Copy jail/ to jails template directory (unless --nojail specified).
424
Copy subjects/ to subjects directory (unless --nosubjects specified).
426
--nojail Do not copy the jail.
427
--nosubjects Do not copy the subjects and problems directories.
428
--dry | -n Print out the actions but don't do anything."""
429
elif operation == 'updatejails':
430
print """sudo python setup.py updatejails [--dry|-n]
432
Copy jail/ to each subdirectory in jails directory.
434
--dry | -n Print out the actions but don't do anything."""
436
print >>sys.stderr, (
437
"""Invalid operation '%s'. Try python setup.py help."""
442
# We build two separate lists, by walking www and console
443
list_www = build_list_py_files('www')
444
list_lib = build_list_py_files('lib')
445
list_scripts = build_list_py_files('scripts')
446
list_subjects = build_list_py_files('subjects', no_top_level=True)
447
list_problems = build_list_py_files('problems', no_top_level=True)
448
# Make sure that the files generated by conf are in the list
449
# (since listmake is typically run before conf)
450
if "lib/conf/conf.py" not in list_lib:
451
list_lib.append("lib/conf/conf.py")
452
# Make sure that console/python-console is in the list
453
if "scripts/python-console" not in list_scripts:
454
list_scripts.append("scripts/python-console")
455
if "scripts/fileservice" not in list_scripts:
456
list_scripts.append("scripts/fileservice")
457
# Write these out to a file
459
# the files that will be created/overwritten
460
listfile = os.path.join(cwd, "install_list.py")
463
file = open(listfile, "w")
465
file.write("""# IVLE Configuration File
467
# Provides lists of all files to be installed by `setup.py install' from
468
# certain directories.
469
# Note that any files with the given filename plus 'c' or 'o' (that is,
470
# compiled .pyc or .pyo files) will be copied as well.
472
# List of all installable files in www directory.
474
writelist_pretty(file, list_www)
476
# List of all installable files in lib directory.
478
writelist_pretty(file, list_lib)
480
# List of all installable files in scripts directory.
482
writelist_pretty(file, list_scripts)
484
# List of all installable files in subjects directory.
485
# This is to install sample subjects and material.
487
writelist_pretty(file, list_subjects)
489
# List of all installable files in problems directory.
490
# This is to install sample exercise material.
492
writelist_pretty(file, list_problems)
495
except IOError, (errno, strerror):
496
print "IO error(%s): %s" % (errno, strerror)
499
print "Successfully wrote install_list.py"
502
print ("You may modify the set of installable files before cutting the "
509
def build_list_py_files(dir, no_top_level=False):
510
"""Builds a list of all py files found in a directory and its
511
subdirectories. Returns this as a list of strings.
512
no_top_level=True means the file paths will not include the top-level
516
for (dirpath, dirnames, filenames) in os.walk(dir):
517
# Exclude directories beginning with a '.' (such as '.svn')
518
filter_mutate(lambda x: x[0] != '.', dirnames)
519
# All *.py files are added to the list
520
pylist += [os.path.join(dirpath, item) for item in filenames
521
if mimetypes.guess_type(item)[0] in listmake_mimetypes]
523
for i in range(0, len(pylist)):
524
_, pylist[i] = pylist[i].split(os.sep, 1)
527
def writelist_pretty(file, list):
528
"""Writes a list one element per line, to a file."""
534
file.write(' %s,\n' % repr(elem))
539
# Set up some variables
542
# the files that will be created/overwritten
543
conffile = os.path.join(cwd, "lib/conf/conf.py")
544
jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
545
conf_hfile = os.path.join(cwd, "trampoline/conf.h")
547
# Get command-line arguments to avoid asking questions.
550
for opt in config_options:
551
optnames.append(opt.option_name + "=")
552
(opts, args) = getopt.gnu_getopt(args, "", optnames)
555
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
559
# Interactive mode. Prompt the user for all the values.
561
print """This tool will create the following files:
72
565
prompting you for details about your configuration. The file will be
73
566
overwritten if it already exists. It will *not* install or deploy IVLE.
75
568
Please hit Ctrl+C now if you do not wish to do this.
78
# Get information from the administrator
79
# If EOF is encountered at any time during the questioning, just exit silently
81
root_dir = query_user("""Root directory where IVLE is located (in URL space):
82
(eg. "/" or "/ivle")""")
83
student_dir = query_user(
84
"""Root directory where user files are stored (on the local file system):
85
(eg. "/home/informatics/jails")""")
90
conf = open(conffile, "w")
92
conf.write("""# IVLE Configuration File
94
# Miscellaneous application settings
569
""" % (conffile, jailconffile, conf_hfile)
571
# Get information from the administrator
572
# If EOF is encountered at any time during the questioning, just exit
575
for opt in config_options:
576
globals()[opt.option_name] = \
577
query_user(globals()[opt.option_name], opt.prompt)
580
# Non-interactive mode. Parse the options.
581
for opt in config_options:
582
if '--' + opt.option_name in opts:
583
globals()[opt.option_name] = opts['--' + opt.option_name]
585
# Error handling on input values
587
allowed_uids_list = map(int, allowed_uids.split(','))
589
print >>sys.stderr, (
590
"Invalid UID list (%s).\n"
591
"Must be a comma-separated list of integers." % allowed_uids)
594
db_port = int(db_port)
595
if db_port < 0 or db_port >= 65536: raise ValueError()
597
print >>sys.stderr, (
598
"Invalid DB port (%s).\n"
599
"Must be an integer between 0 and 65535." % repr(db_port))
602
# Write lib/conf/conf.py
605
conf = open(conffile, "w")
607
conf.write("""# IVLE Configuration File
609
# Miscellaneous application settings
612
for opt in config_options:
613
conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
614
repr(globals()[opt.option_name])))
617
except IOError, (errno, strerror):
618
print "IO error(%s): %s" % (errno, strerror)
621
print "Successfully wrote lib/conf/conf.py"
623
# Write conf/jailconf.py
626
conf = open(jailconffile, "w")
628
# In the "in-jail" version of conf, we don't need MOST of the details
629
# (it would be a security risk to have them here).
630
# So we just write root_dir, and jail_base is "/".
631
# (jail_base being "/" means "jail-relative" paths are relative to "/"
632
# when inside the jail.)
633
conf.write("""# IVLE Configuration File
635
# Miscellaneous application settings
636
# (User jail version)
97
639
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
99
641
# eg. "/" or "/ivle".
100
root_dir = """ + '"' + root_dir + '"' + """
102
644
# In the local file system, where are the student/user file spaces located.
103
645
# The user jails are expected to be located immediately in subdirectories of
105
student_dir = """ + '"' + student_dir + '"' + """
107
# Which application to load by default (if the user navigates to the top level
108
# of the site). This is the app's URL name.
109
# Note that if this app requires authentication, the user will first be
110
# presented with the login screen.
111
default_app = """ + '"' + default_app + '"' + """
648
""" % repr(root_dir))
651
except IOError, (errno, strerror):
652
print "IO error(%s): %s" % (errno, strerror)
655
print "Successfully wrote lib/conf/jailconf.py"
657
# Write trampoline/conf.h
660
conf = open(conf_hfile, "w")
662
conf.write("""/* IVLE Configuration File
664
* Administrator settings required by trampoline.
665
* Note: trampoline will have to be rebuilt in order for changes to this file
669
/* In the local file system, where are the jails located.
670
* The trampoline does not allow the creation of a jail anywhere besides
671
* jail_base or a subdirectory of jail_base.
673
static const char* jail_base = "%s";
675
/* Which user IDs are allowed to run the trampoline.
676
* This list should be limited to the web server user.
677
* (Note that root is an implicit member of this list).
679
static const int allowed_uids[] = { %s };
680
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
681
# Note: The above uses PYTHON reprs, not C reprs
682
# However they should be the same with the exception of the outer
683
# characters, which are stripped off and replaced
686
except IOError, (errno, strerror):
687
print "IO error(%s): %s" % (errno, strerror)
690
print "Successfully wrote trampoline/conf.h"
693
print "You may modify the configuration at any time by editing"
701
# Get "dry" variable from command line
702
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
704
dry = '-n' in opts or '--dry' in opts
707
print "Dry run (no actions will be executed\n"
709
# Compile the trampoline
711
os.chdir('trampoline')
712
action_runprog('make', [], dry)
715
# Create the jail and its subdirectories
716
# Note: Other subdirs will be made by copying files
717
action_mkdir('jail', dry)
718
action_mkdir('jail/home', dry)
719
action_mkdir('jail/tmp', dry)
721
# Copy all console and operating system files into the jail
722
action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
723
copy_os_files_jail(dry)
724
# Chmod the python console
725
action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
726
action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
115
except IOError, (errno, strerror):
116
print "IO error(%s): %s" % (errno, strerror)
119
print "Successfully wrote conf.py"
121
print "You may modify the configuration at any time by editing"
728
# Also copy the IVLE lib directory into the jail
729
# This is necessary for running certain scripts
730
action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
731
# IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
732
# which could compromise security if left in the jail (such as the DB
734
# The "safe" version is in jailconf.py. Delete conf.py and replace it with
736
# NOTE: The first thing action_rename does is call action_remove.
737
action_copyfile('jail/opt/ivle/lib/conf/jailconf.py',
738
'jail/opt/ivle/lib/conf/conf.py', dry)
740
# Compile .py files into .pyc or .pyo files
741
compileall.compile_dir('www', quiet=True)
742
compileall.compile_dir('lib', quiet=True)
743
compileall.compile_dir('scripts', quiet=True)
744
compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
746
# Set up ivle.pth inside the jail
747
# Need to set /opt/ivle/lib to be on the import path
749
"jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
750
f = open(ivle_pth, 'w')
751
f.write('/opt/ivle/lib\n')
756
def copy_os_files_jail(dry):
757
"""Copies necessary Operating System files from their usual locations
758
into the jail/ directory of the cwd."""
759
# Currently source paths are configured for Ubuntu.
760
for filename in JAIL_FILES:
761
copy_file_to_jail(filename, dry)
762
for src, dst in JAIL_LINKS.items():
763
action_symlink(src, dst, dry)
764
for src, dst in JAIL_COPYTREES.items():
765
action_copytree(src, dst, dry)
767
def copy_file_to_jail(src, dry):
768
"""Copies a single file from an absolute location into the same location
769
within the jail. src must begin with a '/'. The jail will be located
770
in a 'jail' subdirectory of the current path."""
771
action_copyfile(src, 'jail' + src, dry)
774
# Get "dry" and "nojail" variables from command line
775
(opts, args) = getopt.gnu_getopt(args, "n",
776
['dry', 'nojail', 'nosubjects'])
778
dry = '-n' in opts or '--dry' in opts
779
nojail = '--nojail' in opts
780
nosubjects = '--nosubjects' in opts
783
print "Dry run (no actions will be executed\n"
785
if not dry and os.geteuid() != 0:
786
print >>sys.stderr, "Must be root to run install"
787
print >>sys.stderr, "(I need to chown some files)."
790
# Create the target (install) directory
791
action_mkdir(ivle_install_dir, dry)
793
# Create bin and copy the compiled files there
794
action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
795
tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
796
action_copyfile('trampoline/trampoline', tramppath, dry)
797
# chown trampoline to root and set setuid bit
798
action_chown_setuid(tramppath, dry)
800
# Copy the www and lib directories using the list
801
action_copylist(install_list.list_www, ivle_install_dir, dry)
802
action_copylist(install_list.list_lib, ivle_install_dir, dry)
805
# Copy the local jail directory built by the build action
806
# to the jails template directory (it will be used as a template
807
# for all the students' jails).
808
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
810
# Copy the subjects and problems directories across
811
action_copylist(install_list.list_subjects, subjects_base, dry,
813
action_copylist(install_list.list_problems, problems_base, dry,
816
# Append IVLE path to ivle.pth in python site packages
817
# (Unless it's already there)
818
ivle_pth = os.path.join(sys.prefix,
819
"lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
820
ivle_www = os.path.join(ivle_install_dir, "www")
821
ivle_lib = os.path.join(ivle_install_dir, "lib")
822
write_ivle_pth = True
823
write_ivle_lib_pth = True
825
file = open(ivle_pth, 'r')
827
if line.strip() == ivle_www:
828
write_ivle_pth = False
829
elif line.strip() == ivle_lib:
830
write_ivle_lib_pth = False
832
except (IOError, OSError):
835
action_append(ivle_pth, ivle_www)
836
if write_ivle_lib_pth:
837
action_append(ivle_pth, ivle_lib)
841
def updatejails(args):
842
# Get "dry" variable from command line
843
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
845
dry = '-n' in opts or '--dry' in opts
848
print "Dry run (no actions will be executed\n"
850
if not dry and os.geteuid() != 0:
851
print >>sys.stderr, "Must be root to run install"
852
print >>sys.stderr, "(I need to chown some files)."
855
# Update the template jail directory in case it hasn't been installed
857
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
859
# Re-link all the files in all students jails.
860
for dir in os.listdir(jail_base):
861
if dir == 'template': continue
862
# First back up the student's home directory
863
temp_home = os.tmpnam()
864
action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
865
# Delete the student's jail and relink the jail files
866
action_linktree(os.path.join(jail_base, 'template'),
867
os.path.join(jail_base, dir), dry)
868
# Restore the student's home directory
869
action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
870
# Set up the user's home directory just in case they don't have a
871
# directory for this yet
872
action_mkdir(os.path.join(jail_base, dir, 'home', dir), dry)
876
# The actions call Python os functions but print actions and handle dryness.
877
# May still throw os exceptions if errors occur.
880
"""Represents an error when running a program (nonzero return)."""
881
def __init__(self, prog, retcode):
883
self.retcode = retcode
885
return str(self.prog) + " returned " + repr(self.retcode)
887
def action_runprog(prog, args, dry):
888
"""Runs a unix program. Searches in $PATH. Synchronous (waits for the
889
program to return). Runs in the current environment. First prints the
890
action as a "bash" line.
892
Throws a RunError with a retcode of the return value of the program,
893
if the program did not return 0.
895
prog: String. Name of the program. (No path required, if in $PATH).
896
args: [String]. Arguments to the program.
897
dry: Bool. If True, prints but does not execute.
899
print prog, string.join(args, ' ')
901
ret = os.spawnvp(os.P_WAIT, prog, args)
903
raise RunError(prog, ret)
905
def action_remove(path, dry):
906
"""Calls rmtree, deleting the target file if it exists."""
910
shutil.rmtree(path, True)
911
except OSError, (err, msg):
912
if err != errno.EEXIST:
914
# Otherwise, didn't exist, so we don't care
916
def action_rename(src, dst, dry):
917
"""Calls rename. Deletes the target if it already exists."""
918
action_remove(dst, dry)
919
print "mv ", src, dst
923
except OSError, (err, msg):
924
if err != errno.EEXIST:
927
def action_mkdir(path, dry):
928
"""Calls mkdir. Silently ignored if the directory already exists.
929
Creates all parent directories as necessary."""
930
print "mkdir -p", path
934
except OSError, (err, msg):
935
if err != errno.EEXIST:
938
def action_copytree(src, dst, dry):
939
"""Copies an entire directory tree. Symlinks are seen as normal files and
940
copies of the entire file (not the link) are made. Creates all parent
941
directories as necessary.
943
See shutil.copytree."""
944
action_remove(dst, dry)
945
print "cp -r", src, dst
947
shutil.copytree(src, dst, True)
949
def action_linktree(src, dst, dry):
950
"""Hard-links an entire directory tree. Same as copytree but the created
951
files are hard-links not actual copies. Removes the existing destination.
953
action_remove(dst, dry)
954
print "<cp with hardlinks> -r", src, dst
956
common.makeuser.linktree(src, dst)
958
def action_copylist(srclist, dst, dry, srcdir="."):
959
"""Copies all files in a list to a new location. The files in the list
960
are read relative to the current directory, and their destinations are the
961
same paths relative to dst. Creates all parent directories as necessary.
962
srcdir is "." by default, can be overridden.
964
for srcfile in srclist:
965
dstfile = os.path.join(dst, srcfile)
966
srcfile = os.path.join(srcdir, srcfile)
967
dstdir = os.path.split(dstfile)[0]
968
if not os.path.isdir(dstdir):
969
action_mkdir(dstdir, dry)
970
print "cp -f", srcfile, dstfile
973
shutil.copyfile(srcfile, dstfile)
974
shutil.copymode(srcfile, dstfile)
978
def action_copyfile(src, dst, dry):
979
"""Copies one file to a new location. Creates all parent directories
981
Warn if file not found.
983
dstdir = os.path.split(dst)[0]
984
if not os.path.isdir(dstdir):
985
action_mkdir(dstdir, dry)
986
print "cp -f", src, dst
989
shutil.copyfile(src, dst)
990
shutil.copymode(src, dst)
991
except (shutil.Error, IOError), e:
992
print "Warning: " + str(e)
994
def action_symlink(src, dst, dry):
995
"""Creates a symlink in a given location. Creates all parent directories
998
dstdir = os.path.split(dst)[0]
999
if not os.path.isdir(dstdir):
1000
action_mkdir(dstdir, dry)
1001
# Delete existing file
1002
if os.path.exists(dst):
1004
print "ln -fs", src, dst
1006
os.symlink(src, dst)
1008
def action_append(ivle_pth, ivle_www):
1009
file = open(ivle_pth, 'a+')
1010
file.write(ivle_www + '\n')
1013
def action_chown_setuid(file, dry):
1014
"""Chowns a file to root, and sets the setuid bit on the file.
1015
Calling this function requires the euid to be root.
1016
The actual mode of path is set to: rws--s--s
1018
print "chown root:root", file
1020
os.chown(file, 0, 0)
1021
print "chmod a+xs", file
1022
print "chmod u+rw", file
1024
os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
1025
| stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
1027
def action_chmod_x(file, dry):
1028
"""Chmod 755 a file (sets permissions to rwxr-xr-x)."""
1029
print "chmod 755", file
1031
os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1032
| stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
1034
def query_user(default, prompt):
1035
"""Prompts the user for a string, which is read from a line of stdin.
1036
Exits silently if EOF is encountered. Returns the string, with spaces
1037
removed from the beginning and end.
1039
Returns default if a 0-length line (after spaces removed) was read.
1041
sys.stdout.write('%s\n (default: "%s")\n>' % (prompt, default))
1043
val = sys.stdin.readline()
1044
except KeyboardInterrupt:
1046
sys.stdout.write("\n")
1048
sys.stdout.write("\n")
1050
if val == '': sys.exit(1)
1051
# If empty line, return default
1053
if val == '': return default
1056
def filter_mutate(function, list):
1057
"""Like built-in filter, but mutates the given list instead of returning a
1058
new one. Returns None."""
1061
# Delete elements which do not match
1062
if not function(list[i]):
1066
if __name__ == "__main__":
added
removed
setup.py
