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
'/lib/libnss_dns.so.2',
164
#'/lib/libnss_mdns4.so',
169
'/etc/nsswitch.conf',
170
'/lib/libnss_files.so.2',
172
# Symlinks to make within the jail. Src mapped to dst.
174
'python%s' % PYTHON_VERSION: 'jail/usr/bin/python',
176
# Trees to copy. Src mapped to dst (these will be passed to action_copytree).
178
'/usr/lib/python%s' % PYTHON_VERSION:
179
'jail/usr/lib/python%s' % PYTHON_VERSION,
180
'/usr/share/matplotlib': 'jail/usr/share/matplotlib',
181
'/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
185
"""A configuration option; one of the things written to conf.py."""
186
def __init__(self, option_name, default, prompt, comment):
187
"""Creates a configuration option.
188
option_name: Name of the variable in conf.py. Also name of the
189
command-line argument to setup.py conf.
190
default: Default value for this variable.
191
prompt: (Short) string presented during the interactive prompt in
193
comment: (Long) comment string stored in conf.py. Each line of this
194
string should begin with a '#'.
196
self.option_name = option_name
197
self.default = default
199
self.comment = comment
201
# Configuration options, defaults and descriptions
203
config_options.append(ConfigOption("root_dir", "/",
204
"""Root directory where IVLE is located (in URL space):""",
206
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
208
# eg. "/" or "/ivle"."""))
209
config_options.append(ConfigOption("ivle_install_dir", "/opt/ivle",
210
'Root directory where IVLE will be installed (on the local file '
213
# In the local file system, where IVLE is actually installed.
214
# This directory should contain the "www" and "bin" directories."""))
215
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
216
"""Location of Directories
217
=======================
218
Root directory where the jails (containing user files) are stored
219
(on the local file system):""",
221
# In the local file system, where are the student/user file spaces located.
222
# The user jails are expected to be located immediately in subdirectories of
223
# this location."""))
224
config_options.append(ConfigOption("subjects_base",
225
"/home/informatics/subjects",
226
"""Root directory where the subject directories (containing worksheets
227
and other per-subject files) are stored (on the local file system):""",
229
# In the local file system, where are the per-subject file spaces located.
230
# The individual subject directories are expected to be located immediately
231
# in subdirectories of this location."""))
232
config_options.append(ConfigOption("exercises_base",
233
"/home/informatics/exercises",
234
"""Root directory where the exercise directories (containing
235
subject-independent exercise sheets) are stored (on the local file
238
# In the local file system, where are the subject-independent exercise sheet
239
# file spaces located."""))
240
config_options.append(ConfigOption("public_host", "public.localhost",
241
"""Hostname which will cause the server to go into "public mode",
242
providing login-free access to student's published work:""",
244
# The server goes into "public mode" if the browser sends a request with this
245
# host. This is for security reasons - we only serve public student files on a
246
# separate domain to the main IVLE site.
247
# Public mode does not use cookies, and serves only public content.
248
# Private mode (normal mode) requires login, and only serves files relevant to
249
# the logged-in user."""))
250
config_options.append(ConfigOption("allowed_uids", "33",
251
"""UID of the web server process which will run IVLE.
252
Only this user may execute the trampoline. May specify multiple users as
253
a comma-separated list.
256
# The User-ID of the web server process which will run IVLE, and any other
257
# users who are allowed to run the trampoline. This is stores as a string of
258
# comma-separated integers, simply because it is not used within Python, only
259
# used by the setup program to write to conf.h (see setup.py config)."""))
260
config_options.append(ConfigOption("db_host", "localhost",
261
"""PostgreSQL Database config
262
==========================
263
Hostname of the DB server:""",
265
### PostgreSQL Database config ###
266
# Database server hostname"""))
267
config_options.append(ConfigOption("db_port", "5432",
268
"""Port of the DB server:""",
270
# Database server port"""))
271
config_options.append(ConfigOption("db_dbname", "ivle",
272
"""Database name:""",
275
config_options.append(ConfigOption("db_user", "postgres",
276
"""Username for DB server login:""",
278
# Database username"""))
279
config_options.append(ConfigOption("db_password", "",
280
"""Password for DB server login:
281
(Caution: This password is stored in plaintext in lib/conf/conf.py)""",
283
# Database password"""))
284
config_options.append(ConfigOption("auth_modules", "ldap_auth",
285
"""Authentication config
286
=====================
287
Comma-separated list of authentication modules. Only "ldap" is available
290
# Comma-separated list of authentication modules.
291
# These refer to importable Python modules in the www/auth directory.
292
# Modules "ldap" and "guest" are available in the source tree, but
293
# other modules may be plugged in to auth against organisation-specific
294
# auth backends."""))
295
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
296
"""(LDAP options are only relevant if "ldap" is included in the list of
298
URL for LDAP authentication server:""",
300
# URL for LDAP authentication server"""))
301
config_options.append(ConfigOption("ldap_format_string",
302
"uid=%s,ou=users,o=example",
303
"""Format string for LDAP auth request:
304
(Must contain a single "%s" for the user's login name)""",
306
# Format string for LDAP auth request
307
# (Must contain a single "%s" for the user's login name)"""))
308
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
311
The base url for accessing subversion repositories:""",
313
# The base url for accessing subversion repositories."""))
314
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
315
"""The location of the subversion configuration file used by apache
316
to host the user repositories:""",
318
# The location of the subversion configuration file used by
319
# apache to host the user repositories."""))
320
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
321
"""The root directory for the subversion repositories:""",
323
# The root directory for the subversion repositories."""))
324
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
325
"""The location of the password file used to authenticate users
326
of the subversion repository from the ivle server:""",
328
# The location of the password file used to authenticate users
329
# of the subversion repository from the ivle server."""))
330
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
331
"""The location of the password file used to authenticate local users
332
of the subversion repository:""",
334
# The location of the password file used to authenticate local users
335
# of the subversion repository."""))
336
config_options.append(ConfigOption("usrmgt_host", "localhost",
337
"""User Management Server config
338
============================
339
The hostname where the usrmgt-server runs:""",
341
# The hostname where the usrmgt-server runs."""))
342
config_options.append(ConfigOption("usrmgt_port", "2178",
343
"""The port where the usrmgt-server runs:""",
345
# The port where the usrmgt-server runs."""))
346
config_options.append(ConfigOption("usrmgt_magic", "",
347
"""The password for the usrmgt-server:""",
349
# The password for the usrmgt-server."""))
351
# Try importing existing conf, but if we can't just set up defaults
352
# The reason for this is that these settings are used by other phases
353
# of setup besides conf, so we need to know them.
354
# Also this allows you to hit Return to accept the existing value.
356
confmodule = __import__("lib/conf/conf")
357
for opt in config_options:
359
globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
361
globals()[opt.option_name] = opt.default
363
# Just set reasonable defaults
364
for opt in config_options:
365
globals()[opt.option_name] = opt.default
367
# Try importing install_list, but don't fail if we can't, because listmake can
368
# function without it.
374
# Mime types which will automatically be placed in the list by listmake.
375
# Note that listmake is not intended to be run by the final user (the system
376
# administrator who installs this), so the developers can customize the list
377
# as necessary, and include it in the distribution.
378
listmake_mimetypes = ['text/x-python', 'text/html',
379
'application/x-javascript', 'application/javascript',
380
'text/css', 'image/png', 'application/xml']
382
# Main function skeleton from Guido van Rossum
383
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
385
33
def main(argv=None):
408
# Disallow run as root unless installing
409
if (operation != 'install' and operation != 'updatejails'
410
and os.geteuid() == 0):
411
print >>sys.stderr, "I do not want to run this stage as root."
412
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):
414
74
# Call the requested operation's function
420
'listmake' : listmake,
422
'updatejails' : updatejails,
78
'build' : setup.build.build,
79
'install' : setup.install.install,
425
82
print >>sys.stderr, (
426
83
"""Invalid operation '%s'. Try python setup.py help."""
429
return oper_func(argv[2:])
431
# Operation functions
435
print """Usage: python setup.py operation [args]
436
Operation (and args) can be:
438
listmake (developer use only)
441
install [--nojail] [--nosubjects] [-n|--dry]
445
print """Usage: python setup.py help [operation]"""
450
if operation == 'help':
451
print """python setup.py help [operation]
452
Prints the usage message or detailed help on an operation, then exits."""
453
elif operation == 'listmake':
454
print """python setup.py listmake
455
(For developer use only)
456
Recurses through the source tree and builds a list of all files which should
457
be copied upon installation. This should be run by the developer before
458
cutting a distribution, and the listfile it generates should be included in
459
the distribution, avoiding the administrator having to run it."""
460
elif operation == 'config':
461
print """python setup.py config [args]
462
Configures IVLE with machine-specific details, most notably, various paths.
463
Either prompts the administrator for these details or accepts them as
464
command-line args. Will be interactive only if there are no arguments given.
465
Takes defaults from existing conf file if it exists.
467
To run IVLE out of the source directory (allowing development without having
468
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
469
directory, and run build/install one time.
471
Creates lib/conf/conf.py and trampoline/conf.h.
474
for opt in config_options:
475
print " --" + opt.option_name
476
print """As explained in the interactive prompt or conf.py.
478
elif operation == 'build':
479
print """python -O setup.py build [--dry|-n]
480
Compiles all files and sets up a jail template in the source directory.
481
-O is recommended to cause compilation to be optimised.
483
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
485
Creates standard subdirs inside the jail, eg bin, opt, home, tmp.
486
Copies console/ to a location within the jail.
487
Copies OS programs and files to corresponding locations within the jail
488
(eg. python and Python libs, ld.so, etc).
489
Generates .pyc or .pyo files for all the IVLE .py files.
491
--dry | -n Print out the actions but don't do anything."""
492
elif operation == 'install':
493
print """sudo python setup.py install [--nojail] [--nosubjects][--dry|-n]
495
Create target install directory ($target).
497
Copy trampoline/trampoline to $target/bin.
498
chown and chmod the installed trampoline.
499
Copy www/ to $target.
500
Copy jail/ to jails template directory (unless --nojail specified).
501
Copy subjects/ to subjects directory (unless --nosubjects specified).
503
--nojail Do not copy the jail.
504
--nosubjects Do not copy the subjects and exercises directories.
505
--dry | -n Print out the actions but don't do anything."""
506
elif operation == 'updatejails':
507
print """sudo python setup.py updatejails [--dry|-n]
509
Copy jail/ to each subdirectory in jails directory.
511
--dry | -n Print out the actions but don't do anything."""
513
print >>sys.stderr, (
514
"""Invalid operation '%s'. Try python setup.py help."""
519
# We build two separate lists, by walking www and console
520
list_www = build_list_py_files('www')
521
list_lib = build_list_py_files('lib')
522
list_subjects = build_list_py_files('subjects', no_top_level=True)
523
list_exercises = build_list_py_files('exercises', no_top_level=True)
525
"scripts/python-console",
526
"scripts/fileservice",
527
"scripts/usrmgt-server",
529
# Make sure that the files generated by conf are in the list
530
# (since listmake is typically run before conf)
531
if "lib/conf/conf.py" not in list_lib:
532
list_lib.append("lib/conf/conf.py")
533
# Write these out to a file
535
# the files that will be created/overwritten
536
listfile = os.path.join(cwd, "install_list.py")
539
file = open(listfile, "w")
541
file.write("""# IVLE Configuration File
543
# Provides lists of all files to be installed by `setup.py install' from
544
# certain directories.
545
# Note that any files with the given filename plus 'c' or 'o' (that is,
546
# compiled .pyc or .pyo files) will be copied as well.
548
# List of all installable files in www directory.
550
writelist_pretty(file, list_www)
552
# List of all installable files in lib directory.
554
writelist_pretty(file, list_lib)
556
# List of all installable files in scripts directory.
558
writelist_pretty(file, list_scripts)
560
# List of all installable files in subjects directory.
561
# This is to install sample subjects and material.
563
writelist_pretty(file, list_subjects)
565
# List of all installable files in exercises directory.
566
# This is to install sample exercise material.
567
list_exercises = """)
568
writelist_pretty(file, list_exercises)
571
except IOError, (errno, strerror):
572
print "IO error(%s): %s" % (errno, strerror)
575
print "Successfully wrote install_list.py"
578
print ("You may modify the set of installable files before cutting the "
585
def build_list_py_files(dir, no_top_level=False):
586
"""Builds a list of all py files found in a directory and its
587
subdirectories. Returns this as a list of strings.
588
no_top_level=True means the file paths will not include the top-level
592
for (dirpath, dirnames, filenames) in os.walk(dir):
593
# Exclude directories beginning with a '.' (such as '.svn')
594
filter_mutate(lambda x: x[0] != '.', dirnames)
595
# All *.py files are added to the list
596
pylist += [os.path.join(dirpath, item) for item in filenames
597
if mimetypes.guess_type(item)[0] in listmake_mimetypes]
599
for i in range(0, len(pylist)):
600
_, pylist[i] = pylist[i].split(os.sep, 1)
603
def writelist_pretty(file, list):
604
"""Writes a list one element per line, to a file."""
610
file.write(' %s,\n' % repr(elem))
614
global db_port, usrmgt_port
615
# Set up some variables
618
# the files that will be created/overwritten
619
conffile = os.path.join(cwd, "lib/conf/conf.py")
620
jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
621
conf_hfile = os.path.join(cwd, "trampoline/conf.h")
623
# Get command-line arguments to avoid asking questions.
626
for opt in config_options:
627
optnames.append(opt.option_name + "=")
628
(opts, args) = getopt.gnu_getopt(args, "", optnames)
631
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
635
# Interactive mode. Prompt the user for all the values.
637
print """This tool will create the following files:
641
prompting you for details about your configuration. The file will be
642
overwritten if it already exists. It will *not* install or deploy IVLE.
644
Please hit Ctrl+C now if you do not wish to do this.
645
""" % (conffile, jailconffile, conf_hfile)
647
# Get information from the administrator
648
# If EOF is encountered at any time during the questioning, just exit
651
for opt in config_options:
652
globals()[opt.option_name] = \
653
query_user(globals()[opt.option_name], opt.prompt)
656
# Non-interactive mode. Parse the options.
657
for opt in config_options:
658
if '--' + opt.option_name in opts:
659
globals()[opt.option_name] = opts['--' + opt.option_name]
661
# Error handling on input values
663
allowed_uids_list = map(int, allowed_uids.split(','))
665
print >>sys.stderr, (
666
"Invalid UID list (%s).\n"
667
"Must be a comma-separated list of integers." % allowed_uids)
670
db_port = int(db_port)
671
if db_port < 0 or db_port >= 65536: raise ValueError()
673
print >>sys.stderr, (
674
"Invalid DB port (%s).\n"
675
"Must be an integer between 0 and 65535." % repr(db_port))
678
usrmgt_port = int(usrmgt_port)
679
if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
681
print >>sys.stderr, (
682
"Invalid user management port (%s).\n"
683
"Must be an integer between 0 and 65535." % repr(usrmgt_port))
686
# Write lib/conf/conf.py
689
conf = open(conffile, "w")
691
conf.write("""# IVLE Configuration File
693
# Miscellaneous application settings
696
for opt in config_options:
697
conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
698
repr(globals()[opt.option_name])))
701
except IOError, (errno, strerror):
702
print "IO error(%s): %s" % (errno, strerror)
705
print "Successfully wrote lib/conf/conf.py"
707
# Write conf/jailconf.py
710
conf = open(jailconffile, "w")
712
# In the "in-jail" version of conf, we don't need MOST of the details
713
# (it would be a security risk to have them here).
714
# So we just write root_dir, and jail_base is "/".
715
# (jail_base being "/" means "jail-relative" paths are relative to "/"
716
# when inside the jail.)
717
conf.write("""# IVLE Configuration File
719
# Miscellaneous application settings
720
# (User jail version)
723
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
725
# eg. "/" or "/ivle".
728
# In the local file system, where are the student/user file spaces located.
729
# The user jails are expected to be located immediately in subdirectories of
733
# The hostname for serving publicly accessible pages
735
""" % (repr(root_dir),repr(public_host)))
738
except IOError, (errno, strerror):
739
print "IO error(%s): %s" % (errno, strerror)
742
print "Successfully wrote lib/conf/jailconf.py"
744
# Write trampoline/conf.h
747
conf = open(conf_hfile, "w")
749
conf.write("""/* IVLE Configuration File
751
* Administrator settings required by trampoline.
752
* Note: trampoline will have to be rebuilt in order for changes to this file
756
/* In the local file system, where are the jails located.
757
* The trampoline does not allow the creation of a jail anywhere besides
758
* jail_base or a subdirectory of jail_base.
760
static const char* jail_base = "%s";
762
/* Which user IDs are allowed to run the trampoline.
763
* This list should be limited to the web server user.
764
* (Note that root is an implicit member of this list).
766
static const int allowed_uids[] = { %s };
767
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
768
# Note: The above uses PYTHON reprs, not C reprs
769
# However they should be the same with the exception of the outer
770
# characters, which are stripped off and replaced
773
except IOError, (errno, strerror):
774
print "IO error(%s): %s" % (errno, strerror)
777
print "Successfully wrote trampoline/conf.h"
780
print "You may modify the configuration at any time by editing"
788
# Get "dry" variable from command line
789
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
791
dry = '-n' in opts or '--dry' in opts
794
print "Dry run (no actions will be executed\n"
796
# Compile the trampoline
798
os.chdir('trampoline')
799
action_runprog('make', [], dry)
802
# Create the jail and its subdirectories
803
# Note: Other subdirs will be made by copying files
804
action_mkdir('jail', dry)
805
action_mkdir('jail/home', dry)
806
action_mkdir('jail/tmp', dry)
808
# Chmod the tmp directory to world writable
809
action_chmod_w('jail/tmp', dry)
811
# Copy all console and operating system files into the jail
812
action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
813
copy_os_files_jail(dry)
814
# Chmod the python console
815
action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
816
action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
818
# Also copy the IVLE lib directory into the jail
819
# This is necessary for running certain scripts
820
action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
821
# IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
822
# which could compromise security if left in the jail (such as the DB
824
# The "safe" version is in jailconf.py. Delete conf.py and replace it with
826
action_copyfile('lib/conf/jailconf.py',
827
'jail/opt/ivle/lib/conf/conf.py', dry)
829
# Compile .py files into .pyc or .pyo files
830
compileall.compile_dir('www', quiet=True)
831
compileall.compile_dir('lib', quiet=True)
832
compileall.compile_dir('scripts', quiet=True)
833
compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
835
# Set up ivle.pth inside the jail
836
# Need to set /opt/ivle/lib to be on the import path
838
"jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
839
f = open(ivle_pth, 'w')
840
f.write('/opt/ivle/lib\n')
845
def copy_os_files_jail(dry):
846
"""Copies necessary Operating System files from their usual locations
847
into the jail/ directory of the cwd."""
848
# Currently source paths are configured for Ubuntu.
849
for filename in JAIL_FILES:
850
copy_file_to_jail(filename, dry)
851
for src, dst in JAIL_LINKS.items():
852
action_symlink(src, dst, dry)
853
for src, dst in JAIL_COPYTREES.items():
854
action_copytree(src, dst, dry)
856
def copy_file_to_jail(src, dry):
857
"""Copies a single file from an absolute location into the same location
858
within the jail. src must begin with a '/'. The jail will be located
859
in a 'jail' subdirectory of the current path."""
860
action_copyfile(src, 'jail' + src, dry)
863
# Get "dry" and "nojail" variables from command line
864
(opts, args) = getopt.gnu_getopt(args, "n",
865
['dry', 'nojail', 'nosubjects'])
867
dry = '-n' in opts or '--dry' in opts
868
nojail = '--nojail' in opts
869
nosubjects = '--nosubjects' in opts
872
print "Dry run (no actions will be executed\n"
874
if not dry and os.geteuid() != 0:
875
print >>sys.stderr, "Must be root to run install"
876
print >>sys.stderr, "(I need to chown some files)."
879
# Create the target (install) directory
880
action_mkdir(ivle_install_dir, dry)
882
# Create bin and copy the compiled files there
883
action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
884
tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
885
action_copyfile('trampoline/trampoline', tramppath, dry)
886
# chown trampoline to root and set setuid bit
887
action_chown_setuid(tramppath, dry)
889
# Create a scripts directory to put the usrmgt-server in.
890
action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
891
usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
892
action_copyfile('scripts/usrmgt-server', usrmgtpath, dry)
893
action_chmod_x(usrmgtpath, dry)
895
# Copy the www and lib directories using the list
896
action_copylist(install_list.list_www, ivle_install_dir, dry)
897
action_copylist(install_list.list_lib, ivle_install_dir, dry)
899
# Copy the php directory
900
action_copytree('www/php/phpBB3',os.path.join(ivle_install_dir,'www/php/phpBB3'),
904
# Copy the local jail directory built by the build action
905
# to the jails template directory (it will be used as a template
906
# for all the students' jails).
907
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
909
# Copy the subjects and exercises directories across
910
action_copylist(install_list.list_subjects, subjects_base, dry,
912
action_copylist(install_list.list_exercises, exercises_base, dry,
913
srcdir="./exercises")
915
# Append IVLE path to ivle.pth in python site packages
916
# (Unless it's already there)
917
ivle_pth = os.path.join(sys.prefix,
918
"lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
919
ivle_www = os.path.join(ivle_install_dir, "www")
920
ivle_lib = os.path.join(ivle_install_dir, "lib")
921
write_ivle_pth = True
922
write_ivle_lib_pth = True
924
file = open(ivle_pth, 'r')
926
if line.strip() == ivle_www:
927
write_ivle_pth = False
928
elif line.strip() == ivle_lib:
929
write_ivle_lib_pth = False
931
except (IOError, OSError):
934
action_append(ivle_pth, ivle_www)
935
if write_ivle_lib_pth:
936
action_append(ivle_pth, ivle_lib)
940
def updatejails(args):
941
# Get "dry" variable from command line
942
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
944
dry = '-n' in opts or '--dry' in opts
947
print "Dry run (no actions will be executed\n"
949
if not dry and os.geteuid() != 0:
950
print >>sys.stderr, "Must be root to run install"
951
print >>sys.stderr, "(I need to chown some files)."
954
# Update the template jail directory in case it hasn't been installed
956
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
958
# Re-link all the files in all students jails.
959
for dir in os.listdir(jail_base):
960
if dir == 'template': continue
961
# First back up the student's home directory
962
temp_home = os.tmpnam()
963
action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
964
# Delete the student's jail and relink the jail files
965
action_linktree(os.path.join(jail_base, 'template'),
966
os.path.join(jail_base, dir), dry)
967
# Restore the student's home directory
968
action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
969
# Set up the user's home directory just in case they don't have a
970
# directory for this yet
971
action_mkdir(os.path.join(jail_base, dir, 'home', dir), dry)
975
# The actions call Python os functions but print actions and handle dryness.
976
# May still throw os exceptions if errors occur.
979
"""Represents an error when running a program (nonzero return)."""
980
def __init__(self, prog, retcode):
982
self.retcode = retcode
984
return str(self.prog) + " returned " + repr(self.retcode)
986
def action_runprog(prog, args, dry):
987
"""Runs a unix program. Searches in $PATH. Synchronous (waits for the
988
program to return). Runs in the current environment. First prints the
989
action as a "bash" line.
991
Throws a RunError with a retcode of the return value of the program,
992
if the program did not return 0.
994
prog: String. Name of the program. (No path required, if in $PATH).
995
args: [String]. Arguments to the program.
996
dry: Bool. If True, prints but does not execute.
998
print prog, string.join(args, ' ')
1000
ret = os.spawnvp(os.P_WAIT, prog, args)
1002
raise RunError(prog, ret)
1004
def action_remove(path, dry):
1005
"""Calls rmtree, deleting the target file if it exists."""
1009
shutil.rmtree(path, True)
1010
except OSError, (err, msg):
1011
if err != errno.EEXIST:
1013
# Otherwise, didn't exist, so we don't care
1015
def action_rename(src, dst, dry):
1016
"""Calls rename. Deletes the target if it already exists."""
1017
action_remove(dst, dry)
1018
print "mv ", src, dst
1022
except OSError, (err, msg):
1023
if err != errno.EEXIST:
1026
def action_mkdir(path, dry):
1027
"""Calls mkdir. Silently ignored if the directory already exists.
1028
Creates all parent directories as necessary."""
1029
print "mkdir -p", path
1033
except OSError, (err, msg):
1034
if err != errno.EEXIST:
1037
def action_copytree(src, dst, dry):
1038
"""Copies an entire directory tree. Symlinks are seen as normal files and
1039
copies of the entire file (not the link) are made. Creates all parent
1040
directories as necessary.
1042
See shutil.copytree."""
1043
# Allow copying over itself
1044
if (os.path.normpath(os.path.join(os.getcwd(),src)) ==
1045
os.path.normpath(os.path.join(os.getcwd(),dst))):
1047
action_remove(dst, dry)
1048
print "cp -r", src, dst
1050
shutil.copytree(src, dst, True)
1052
def action_linktree(src, dst, dry):
1053
"""Hard-links an entire directory tree. Same as copytree but the created
1054
files are hard-links not actual copies. Removes the existing destination.
1056
action_remove(dst, dry)
1057
print "<cp with hardlinks> -r", src, dst
1059
common.makeuser.linktree(src, dst)
1061
def action_copylist(srclist, dst, dry, srcdir="."):
1062
"""Copies all files in a list to a new location. The files in the list
1063
are read relative to the current directory, and their destinations are the
1064
same paths relative to dst. Creates all parent directories as necessary.
1065
srcdir is "." by default, can be overridden.
1067
for srcfile in srclist:
1068
dstfile = os.path.join(dst, srcfile)
1069
srcfile = os.path.join(srcdir, srcfile)
1070
dstdir = os.path.split(dstfile)[0]
1071
if not os.path.isdir(dstdir):
1072
action_mkdir(dstdir, dry)
1073
print "cp -f", srcfile, dstfile
1076
shutil.copyfile(srcfile, dstfile)
1077
shutil.copymode(srcfile, dstfile)
1078
except shutil.Error:
1081
def action_copyfile(src, dst, dry):
1082
"""Copies one file to a new location. Creates all parent directories
1084
Warn if file not found.
1086
dstdir = os.path.split(dst)[0]
1087
if not os.path.isdir(dstdir):
1088
action_mkdir(dstdir, dry)
1089
print "cp -f", src, dst
1092
shutil.copyfile(src, dst)
1093
shutil.copymode(src, dst)
1094
except (shutil.Error, IOError), e:
1095
print "Warning: " + str(e)
1097
def action_symlink(src, dst, dry):
1098
"""Creates a symlink in a given location. Creates all parent directories
1101
dstdir = os.path.split(dst)[0]
1102
if not os.path.isdir(dstdir):
1103
action_mkdir(dstdir, dry)
1104
# Delete existing file
1105
if os.path.exists(dst):
1107
print "ln -fs", src, dst
1109
os.symlink(src, dst)
1111
def action_append(ivle_pth, ivle_www):
1112
file = open(ivle_pth, 'a+')
1113
file.write(ivle_www + '\n')
1116
def action_chown_setuid(file, dry):
1117
"""Chowns a file to root, and sets the setuid bit on the file.
1118
Calling this function requires the euid to be root.
1119
The actual mode of path is set to: rws--s--s
1121
print "chown root:root", file
1123
os.chown(file, 0, 0)
1124
print "chmod a+xs", file
1125
print "chmod u+rw", file
1127
os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
1128
| stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
1130
def action_chmod_x(file, dry):
1131
"""Chmod 755 a file (sets permissions to rwxr-xr-x)."""
1132
print "chmod 755", file
1134
os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1135
| stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
1138
def action_chmod_w(file, dry):
1139
"""Chmod 777 a file (sets permissions to rwxrwxrwx)."""
1140
print "chmod 777", file
1142
os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1143
| stat.S_IXGRP | stat.S_IWGRP | stat.S_IRGRP | stat.S_IXOTH
1144
| stat.S_IWOTH | stat.S_IROTH)
1146
def query_user(default, prompt):
1147
"""Prompts the user for a string, which is read from a line of stdin.
1148
Exits silently if EOF is encountered. Returns the string, with spaces
1149
removed from the beginning and end.
1151
Returns default if a 0-length line (after spaces removed) was read.
1153
sys.stdout.write('%s\n (default: "%s")\n>' % (prompt, default))
1155
val = sys.stdin.readline()
1156
except KeyboardInterrupt:
1158
sys.stdout.write("\n")
1160
sys.stdout.write("\n")
1162
if val == '': sys.exit(1)
1163
# If empty line, return default
1165
if val == '': return default
1168
def filter_mutate(function, list):
1169
"""Like built-in filter, but mutates the given list instead of returning a
1170
new one. Returns None."""
1173
# Delete elements which do not match
1174
if not function(list[i]):
1178
88
if __name__ == "__main__":
added
removed
setup.py
