23
23
# This is a command-line application, for use by the administrator.
24
# This program configures, builds and installs IVLE in three separate steps.
24
# This program is a frontend for the modules in the setup packages that
25
# build and install IVLE in separate steps.
25
26
# 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).
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", "/",
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"""))
273
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
274
"""The location of the subversion configuration file used by apache
275
to host the user repositories:""",
277
# The location of the subversion configuration file used by
278
# apache to host the user repositories."""))
279
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
280
"""The root directory for the subversion repositories:""",
282
# The root directory for the subversion repositories."""))
283
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
284
"""The location of the password file used to authenticate users
285
of the subversion repository from the ivle server:""",
287
# The location of the password file used to authenticate users
288
# of the subversion repository from the ivle server."""))
289
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
290
"""The location of the password file used to authenticate local users
291
of the subversion repository:""",
293
# The location of the password file used to authenticate local users
294
# of the subversion repository."""))
295
config_options.append(ConfigOption("usrmgt_host", "localhost",
296
"""The hostname where the usrmgt-server runs:""",
298
# The hostname where the usrmgt-server runs."""))
299
config_options.append(ConfigOption("usrmgt_port", "2178",
300
"""The port where the usrmgt-server runs:""",
302
# The port where the usrmgt-server runs."""))
303
config_options.append(ConfigOption("usrmgt_magic", "",
304
"""The password for the usrmgt-server:""",
306
# The password for the usrmgt-server."""))
308
# Try importing existing conf, but if we can't just set up defaults
309
# The reason for this is that these settings are used by other phases
310
# of setup besides conf, so we need to know them.
311
# Also this allows you to hit Return to accept the existing value.
313
confmodule = __import__("lib/conf/conf")
314
for opt in config_options:
316
globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
318
globals()[opt.option_name] = opt.default
320
# Just set reasonable defaults
321
for opt in config_options:
322
globals()[opt.option_name] = opt.default
324
# Try importing install_list, but don't fail if we can't, because listmake can
325
# function without it.
331
# Mime types which will automatically be placed in the list by listmake.
332
# Note that listmake is not intended to be run by the final user (the system
333
# administrator who installs this), so the developers can customize the list
334
# as necessary, and include it in the distribution.
335
listmake_mimetypes = ['text/x-python', 'text/html',
336
'application/x-javascript', 'application/javascript',
337
'text/css', 'image/png', 'application/xml']
339
# Main function skeleton from Guido van Rossum
340
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
342
33
def main(argv=None):
365
# Disallow run as root unless installing
366
if (operation != 'install' and operation != 'updatejails'
367
and os.geteuid() == 0):
368
print >>sys.stderr, "I do not want to run this stage as root."
369
print >>sys.stderr, "Please run as a normal user."
56
oper_func = call_operator(operation)
57
return oper_func(argv[2:])
61
print """Usage: python setup.py operation [options]
67
For help and options for a specific operation use 'help [operation]'."""
70
oper_func = call_operator(operator)
71
oper_func(['operator','--help'])
73
def call_operator(operation):
371
74
# Call the requested operation's function
377
'listmake' : listmake,
379
'updatejails' : updatejails,
78
'build' : setup.build.build,
79
'install' : setup.install.install,
382
82
print >>sys.stderr, (
383
83
"""Invalid operation '%s'. Try python setup.py help."""
386
return oper_func(argv[2:])
388
# Operation functions
392
print """Usage: python setup.py operation [args]
393
Operation (and args) can be:
395
listmake (developer use only)
398
install [--nojail] [--nosubjects] [-n|--dry]
402
print """Usage: python setup.py help [operation]"""
407
if operation == 'help':
408
print """python setup.py help [operation]
409
Prints the usage message or detailed help on an operation, then exits."""
410
elif operation == 'listmake':
411
print """python setup.py listmake
412
(For developer use only)
413
Recurses through the source tree and builds a list of all files which should
414
be copied upon installation. This should be run by the developer before
415
cutting a distribution, and the listfile it generates should be included in
416
the distribution, avoiding the administrator having to run it."""
417
elif operation == 'config':
418
print """python setup.py config [args]
419
Configures IVLE with machine-specific details, most notably, various paths.
420
Either prompts the administrator for these details or accepts them as
421
command-line args. Will be interactive only if there are no arguments given.
422
Takes defaults from existing conf file if it exists.
424
To run IVLE out of the source directory (allowing development without having
425
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
426
directory, and run build/install one time.
428
Creates lib/conf/conf.py and trampoline/conf.h.
431
for opt in config_options:
432
print " --" + opt.option_name
433
print """As explained in the interactive prompt or conf.py.
435
elif operation == 'build':
436
print """python -O setup.py build [--dry|-n]
437
Compiles all files and sets up a jail template in the source directory.
438
-O is recommended to cause compilation to be optimised.
440
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
442
Creates standard subdirs inside the jail, eg bin, opt, home, tmp.
443
Copies console/ to a location within the jail.
444
Copies OS programs and files to corresponding locations within the jail
445
(eg. python and Python libs, ld.so, etc).
446
Generates .pyc or .pyo files for all the IVLE .py files.
448
--dry | -n Print out the actions but don't do anything."""
449
elif operation == 'install':
450
print """sudo python setup.py install [--nojail] [--nosubjects][--dry|-n]
452
Create target install directory ($target).
454
Copy trampoline/trampoline to $target/bin.
455
chown and chmod the installed trampoline.
456
Copy www/ to $target.
457
Copy jail/ to jails template directory (unless --nojail specified).
458
Copy subjects/ to subjects directory (unless --nosubjects specified).
460
--nojail Do not copy the jail.
461
--nosubjects Do not copy the subjects and problems directories.
462
--dry | -n Print out the actions but don't do anything."""
463
elif operation == 'updatejails':
464
print """sudo python setup.py updatejails [--dry|-n]
466
Copy jail/ to each subdirectory in jails directory.
468
--dry | -n Print out the actions but don't do anything."""
470
print >>sys.stderr, (
471
"""Invalid operation '%s'. Try python setup.py help."""
476
# We build two separate lists, by walking www and console
477
list_www = build_list_py_files('www')
478
list_lib = build_list_py_files('lib')
479
list_subjects = build_list_py_files('subjects', no_top_level=True)
480
list_problems = build_list_py_files('problems', no_top_level=True)
482
"scripts/python-console",
483
"scripts/fileservice",
484
"scripts/usrmgt-server",
486
# Make sure that the files generated by conf are in the list
487
# (since listmake is typically run before conf)
488
if "lib/conf/conf.py" not in list_lib:
489
list_lib.append("lib/conf/conf.py")
490
# Write these out to a file
492
# the files that will be created/overwritten
493
listfile = os.path.join(cwd, "install_list.py")
496
file = open(listfile, "w")
498
file.write("""# IVLE Configuration File
500
# Provides lists of all files to be installed by `setup.py install' from
501
# certain directories.
502
# Note that any files with the given filename plus 'c' or 'o' (that is,
503
# compiled .pyc or .pyo files) will be copied as well.
505
# List of all installable files in www directory.
507
writelist_pretty(file, list_www)
509
# List of all installable files in lib directory.
511
writelist_pretty(file, list_lib)
513
# List of all installable files in scripts directory.
515
writelist_pretty(file, list_scripts)
517
# List of all installable files in subjects directory.
518
# This is to install sample subjects and material.
520
writelist_pretty(file, list_subjects)
522
# List of all installable files in problems directory.
523
# This is to install sample exercise material.
525
writelist_pretty(file, list_problems)
528
except IOError, (errno, strerror):
529
print "IO error(%s): %s" % (errno, strerror)
532
print "Successfully wrote install_list.py"
535
print ("You may modify the set of installable files before cutting the "
542
def build_list_py_files(dir, no_top_level=False):
543
"""Builds a list of all py files found in a directory and its
544
subdirectories. Returns this as a list of strings.
545
no_top_level=True means the file paths will not include the top-level
549
for (dirpath, dirnames, filenames) in os.walk(dir):
550
# Exclude directories beginning with a '.' (such as '.svn')
551
filter_mutate(lambda x: x[0] != '.', dirnames)
552
# All *.py files are added to the list
553
pylist += [os.path.join(dirpath, item) for item in filenames
554
if mimetypes.guess_type(item)[0] in listmake_mimetypes]
556
for i in range(0, len(pylist)):
557
_, pylist[i] = pylist[i].split(os.sep, 1)
560
def writelist_pretty(file, list):
561
"""Writes a list one element per line, to a file."""
567
file.write(' %s,\n' % repr(elem))
571
global db_port, usrmgt_port
572
# Set up some variables
575
# the files that will be created/overwritten
576
conffile = os.path.join(cwd, "lib/conf/conf.py")
577
jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
578
conf_hfile = os.path.join(cwd, "trampoline/conf.h")
580
# Get command-line arguments to avoid asking questions.
583
for opt in config_options:
584
optnames.append(opt.option_name + "=")
585
(opts, args) = getopt.gnu_getopt(args, "", optnames)
588
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
592
# Interactive mode. Prompt the user for all the values.
594
print """This tool will create the following files:
598
prompting you for details about your configuration. The file will be
599
overwritten if it already exists. It will *not* install or deploy IVLE.
601
Please hit Ctrl+C now if you do not wish to do this.
602
""" % (conffile, jailconffile, conf_hfile)
604
# Get information from the administrator
605
# If EOF is encountered at any time during the questioning, just exit
608
for opt in config_options:
609
globals()[opt.option_name] = \
610
query_user(globals()[opt.option_name], opt.prompt)
613
# Non-interactive mode. Parse the options.
614
for opt in config_options:
615
if '--' + opt.option_name in opts:
616
globals()[opt.option_name] = opts['--' + opt.option_name]
618
# Error handling on input values
620
allowed_uids_list = map(int, allowed_uids.split(','))
622
print >>sys.stderr, (
623
"Invalid UID list (%s).\n"
624
"Must be a comma-separated list of integers." % allowed_uids)
627
db_port = int(db_port)
628
if db_port < 0 or db_port >= 65536: raise ValueError()
630
print >>sys.stderr, (
631
"Invalid DB port (%s).\n"
632
"Must be an integer between 0 and 65535." % repr(db_port))
635
usrmgt_port = int(usrmgt_port)
636
if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
638
print >>sys.stderr, (
639
"Invalid user management port (%s).\n"
640
"Must be an integer between 0 and 65535." % repr(usrmgt_port))
643
# Write lib/conf/conf.py
646
conf = open(conffile, "w")
648
conf.write("""# IVLE Configuration File
650
# Miscellaneous application settings
653
for opt in config_options:
654
conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
655
repr(globals()[opt.option_name])))
658
except IOError, (errno, strerror):
659
print "IO error(%s): %s" % (errno, strerror)
662
print "Successfully wrote lib/conf/conf.py"
664
# Write conf/jailconf.py
667
conf = open(jailconffile, "w")
669
# In the "in-jail" version of conf, we don't need MOST of the details
670
# (it would be a security risk to have them here).
671
# So we just write root_dir, and jail_base is "/".
672
# (jail_base being "/" means "jail-relative" paths are relative to "/"
673
# when inside the jail.)
674
conf.write("""# IVLE Configuration File
676
# Miscellaneous application settings
677
# (User jail version)
680
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
682
# eg. "/" or "/ivle".
685
# In the local file system, where are the student/user file spaces located.
686
# The user jails are expected to be located immediately in subdirectories of
690
# The hostname for serving publicly accessible pages
692
""" % (repr(root_dir),repr(public_host)))
695
except IOError, (errno, strerror):
696
print "IO error(%s): %s" % (errno, strerror)
699
print "Successfully wrote lib/conf/jailconf.py"
701
# Write trampoline/conf.h
704
conf = open(conf_hfile, "w")
706
conf.write("""/* IVLE Configuration File
708
* Administrator settings required by trampoline.
709
* Note: trampoline will have to be rebuilt in order for changes to this file
713
/* In the local file system, where are the jails located.
714
* The trampoline does not allow the creation of a jail anywhere besides
715
* jail_base or a subdirectory of jail_base.
717
static const char* jail_base = "%s";
719
/* Which user IDs are allowed to run the trampoline.
720
* This list should be limited to the web server user.
721
* (Note that root is an implicit member of this list).
723
static const int allowed_uids[] = { %s };
724
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
725
# Note: The above uses PYTHON reprs, not C reprs
726
# However they should be the same with the exception of the outer
727
# characters, which are stripped off and replaced
730
except IOError, (errno, strerror):
731
print "IO error(%s): %s" % (errno, strerror)
734
print "Successfully wrote trampoline/conf.h"
737
print "You may modify the configuration at any time by editing"
745
# Get "dry" variable from command line
746
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
748
dry = '-n' in opts or '--dry' in opts
751
print "Dry run (no actions will be executed\n"
753
# Compile the trampoline
755
os.chdir('trampoline')
756
action_runprog('make', [], dry)
759
# Create the jail and its subdirectories
760
# Note: Other subdirs will be made by copying files
761
action_mkdir('jail', dry)
762
action_mkdir('jail/home', dry)
763
action_mkdir('jail/tmp', dry)
765
# Copy all console and operating system files into the jail
766
action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
767
copy_os_files_jail(dry)
768
# Chmod the python console
769
action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
770
action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
772
# Also copy the IVLE lib directory into the jail
773
# This is necessary for running certain scripts
774
action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
775
# IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
776
# which could compromise security if left in the jail (such as the DB
778
# The "safe" version is in jailconf.py. Delete conf.py and replace it with
780
action_copyfile('lib/conf/jailconf.py',
781
'jail/opt/ivle/lib/conf/conf.py', dry)
783
# Compile .py files into .pyc or .pyo files
784
compileall.compile_dir('www', quiet=True)
785
compileall.compile_dir('lib', quiet=True)
786
compileall.compile_dir('scripts', quiet=True)
787
compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
789
# Set up ivle.pth inside the jail
790
# Need to set /opt/ivle/lib to be on the import path
792
"jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
793
f = open(ivle_pth, 'w')
794
f.write('/opt/ivle/lib\n')
799
def copy_os_files_jail(dry):
800
"""Copies necessary Operating System files from their usual locations
801
into the jail/ directory of the cwd."""
802
# Currently source paths are configured for Ubuntu.
803
for filename in JAIL_FILES:
804
copy_file_to_jail(filename, dry)
805
for src, dst in JAIL_LINKS.items():
806
action_symlink(src, dst, dry)
807
for src, dst in JAIL_COPYTREES.items():
808
action_copytree(src, dst, dry)
810
def copy_file_to_jail(src, dry):
811
"""Copies a single file from an absolute location into the same location
812
within the jail. src must begin with a '/'. The jail will be located
813
in a 'jail' subdirectory of the current path."""
814
action_copyfile(src, 'jail' + src, dry)
817
# Get "dry" and "nojail" variables from command line
818
(opts, args) = getopt.gnu_getopt(args, "n",
819
['dry', 'nojail', 'nosubjects'])
821
dry = '-n' in opts or '--dry' in opts
822
nojail = '--nojail' in opts
823
nosubjects = '--nosubjects' in opts
826
print "Dry run (no actions will be executed\n"
828
if not dry and os.geteuid() != 0:
829
print >>sys.stderr, "Must be root to run install"
830
print >>sys.stderr, "(I need to chown some files)."
833
# Create the target (install) directory
834
action_mkdir(ivle_install_dir, dry)
836
# Create bin and copy the compiled files there
837
action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
838
tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
839
action_copyfile('trampoline/trampoline', tramppath, dry)
840
# chown trampoline to root and set setuid bit
841
action_chown_setuid(tramppath, dry)
843
# Copy the www and lib directories using the list
844
action_copylist(install_list.list_www, ivle_install_dir, dry)
845
action_copylist(install_list.list_lib, ivle_install_dir, dry)
848
# Copy the local jail directory built by the build action
849
# to the jails template directory (it will be used as a template
850
# for all the students' jails).
851
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
853
# Copy the subjects and problems directories across
854
action_copylist(install_list.list_subjects, subjects_base, dry,
856
action_copylist(install_list.list_problems, problems_base, dry,
859
# Append IVLE path to ivle.pth in python site packages
860
# (Unless it's already there)
861
ivle_pth = os.path.join(sys.prefix,
862
"lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
863
ivle_www = os.path.join(ivle_install_dir, "www")
864
ivle_lib = os.path.join(ivle_install_dir, "lib")
865
write_ivle_pth = True
866
write_ivle_lib_pth = True
868
file = open(ivle_pth, 'r')
870
if line.strip() == ivle_www:
871
write_ivle_pth = False
872
elif line.strip() == ivle_lib:
873
write_ivle_lib_pth = False
875
except (IOError, OSError):
878
action_append(ivle_pth, ivle_www)
879
if write_ivle_lib_pth:
880
action_append(ivle_pth, ivle_lib)
884
def updatejails(args):
885
# Get "dry" variable from command line
886
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
888
dry = '-n' in opts or '--dry' in opts
891
print "Dry run (no actions will be executed\n"
893
if not dry and os.geteuid() != 0:
894
print >>sys.stderr, "Must be root to run install"
895
print >>sys.stderr, "(I need to chown some files)."
898
# Update the template jail directory in case it hasn't been installed
900
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
902
# Re-link all the files in all students jails.
903
for dir in os.listdir(jail_base):
904
if dir == 'template': continue
905
# First back up the student's home directory
906
temp_home = os.tmpnam()
907
action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
908
# Delete the student's jail and relink the jail files
909
action_linktree(os.path.join(jail_base, 'template'),
910
os.path.join(jail_base, dir), dry)
911
# Restore the student's home directory
912
action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
913
# Set up the user's home directory just in case they don't have a
914
# directory for this yet
915
action_mkdir(os.path.join(jail_base, dir, 'home', dir), dry)
919
# The actions call Python os functions but print actions and handle dryness.
920
# May still throw os exceptions if errors occur.
923
"""Represents an error when running a program (nonzero return)."""
924
def __init__(self, prog, retcode):
926
self.retcode = retcode
928
return str(self.prog) + " returned " + repr(self.retcode)
930
def action_runprog(prog, args, dry):
931
"""Runs a unix program. Searches in $PATH. Synchronous (waits for the
932
program to return). Runs in the current environment. First prints the
933
action as a "bash" line.
935
Throws a RunError with a retcode of the return value of the program,
936
if the program did not return 0.
938
prog: String. Name of the program. (No path required, if in $PATH).
939
args: [String]. Arguments to the program.
940
dry: Bool. If True, prints but does not execute.
942
print prog, string.join(args, ' ')
944
ret = os.spawnvp(os.P_WAIT, prog, args)
946
raise RunError(prog, ret)
948
def action_remove(path, dry):
949
"""Calls rmtree, deleting the target file if it exists."""
953
shutil.rmtree(path, True)
954
except OSError, (err, msg):
955
if err != errno.EEXIST:
957
# Otherwise, didn't exist, so we don't care
959
def action_rename(src, dst, dry):
960
"""Calls rename. Deletes the target if it already exists."""
961
action_remove(dst, dry)
962
print "mv ", src, dst
966
except OSError, (err, msg):
967
if err != errno.EEXIST:
970
def action_mkdir(path, dry):
971
"""Calls mkdir. Silently ignored if the directory already exists.
972
Creates all parent directories as necessary."""
973
print "mkdir -p", path
977
except OSError, (err, msg):
978
if err != errno.EEXIST:
981
def action_copytree(src, dst, dry):
982
"""Copies an entire directory tree. Symlinks are seen as normal files and
983
copies of the entire file (not the link) are made. Creates all parent
984
directories as necessary.
986
See shutil.copytree."""
987
action_remove(dst, dry)
988
print "cp -r", src, dst
990
shutil.copytree(src, dst, True)
992
def action_linktree(src, dst, dry):
993
"""Hard-links an entire directory tree. Same as copytree but the created
994
files are hard-links not actual copies. Removes the existing destination.
996
action_remove(dst, dry)
997
print "<cp with hardlinks> -r", src, dst
999
common.makeuser.linktree(src, dst)
1001
def action_copylist(srclist, dst, dry, srcdir="."):
1002
"""Copies all files in a list to a new location. The files in the list
1003
are read relative to the current directory, and their destinations are the
1004
same paths relative to dst. Creates all parent directories as necessary.
1005
srcdir is "." by default, can be overridden.
1007
for srcfile in srclist:
1008
dstfile = os.path.join(dst, srcfile)
1009
srcfile = os.path.join(srcdir, srcfile)
1010
dstdir = os.path.split(dstfile)[0]
1011
if not os.path.isdir(dstdir):
1012
action_mkdir(dstdir, dry)
1013
print "cp -f", srcfile, dstfile
1016
shutil.copyfile(srcfile, dstfile)
1017
shutil.copymode(srcfile, dstfile)
1018
except shutil.Error:
1021
def action_copyfile(src, dst, dry):
1022
"""Copies one file to a new location. Creates all parent directories
1024
Warn if file not found.
1026
dstdir = os.path.split(dst)[0]
1027
if not os.path.isdir(dstdir):
1028
action_mkdir(dstdir, dry)
1029
print "cp -f", src, dst
1032
shutil.copyfile(src, dst)
1033
shutil.copymode(src, dst)
1034
except (shutil.Error, IOError), e:
1035
print "Warning: " + str(e)
1037
def action_symlink(src, dst, dry):
1038
"""Creates a symlink in a given location. Creates all parent directories
1041
dstdir = os.path.split(dst)[0]
1042
if not os.path.isdir(dstdir):
1043
action_mkdir(dstdir, dry)
1044
# Delete existing file
1045
if os.path.exists(dst):
1047
print "ln -fs", src, dst
1049
os.symlink(src, dst)
1051
def action_append(ivle_pth, ivle_www):
1052
file = open(ivle_pth, 'a+')
1053
file.write(ivle_www + '\n')
1056
def action_chown_setuid(file, dry):
1057
"""Chowns a file to root, and sets the setuid bit on the file.
1058
Calling this function requires the euid to be root.
1059
The actual mode of path is set to: rws--s--s
1061
print "chown root:root", file
1063
os.chown(file, 0, 0)
1064
print "chmod a+xs", file
1065
print "chmod u+rw", file
1067
os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
1068
| stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
1070
def action_chmod_x(file, dry):
1071
"""Chmod 755 a file (sets permissions to rwxr-xr-x)."""
1072
print "chmod 755", file
1074
os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1075
| stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
1077
def query_user(default, prompt):
1078
"""Prompts the user for a string, which is read from a line of stdin.
1079
Exits silently if EOF is encountered. Returns the string, with spaces
1080
removed from the beginning and end.
1082
Returns default if a 0-length line (after spaces removed) was read.
1084
sys.stdout.write('%s\n (default: "%s")\n>' % (prompt, default))
1086
val = sys.stdin.readline()
1087
except KeyboardInterrupt:
1089
sys.stdout.write("\n")
1091
sys.stdout.write("\n")
1093
if val == '': sys.exit(1)
1094
# If empty line, return default
1096
if val == '': return default
1099
def filter_mutate(function, list):
1100
"""Like built-in filter, but mutates the given list instead of returning a
1101
new one. Returns None."""
1104
# Delete elements which do not match
1105
if not function(list[i]):
1109
88
if __name__ == "__main__":
added
removed
setup.py
