23
23
# This is a command-line application, for use by the administrator.
24
# This program is a frontend for the modules in the setup packages that
25
# build and install IVLE in separate steps.
24
# This program configures, builds and installs IVLE in three separate steps.
26
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).
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
"""Location of Directories
208
=======================
209
Root directory where the jails (containing user files) are stored
210
(on the local file system):""",
212
# In the local file system, where are the student/user file spaces located.
213
# The user jails are expected to be located immediately in subdirectories of
214
# this location."""))
215
config_options.append(ConfigOption("subjects_base",
216
"/home/informatics/subjects",
217
"""Root directory where the subject directories (containing worksheets
218
and other per-subject files) are stored (on the local file system):""",
220
# In the local file system, where are the per-subject file spaces located.
221
# The individual subject directories are expected to be located immediately
222
# in subdirectories of this location."""))
223
config_options.append(ConfigOption("exercises_base",
224
"/home/informatics/exercises",
225
"""Root directory where the exercise directories (containing
226
subject-independent exercise sheets) are stored (on the local file
229
# In the local file system, where are the subject-independent exercise sheet
230
# file spaces located."""))
231
config_options.append(ConfigOption("public_host", "public.localhost",
232
"""Hostname which will cause the server to go into "public mode",
233
providing login-free access to student's published work:""",
235
# The server goes into "public mode" if the browser sends a request with this
236
# host. This is for security reasons - we only serve public student files on a
237
# separate domain to the main IVLE site.
238
# Public mode does not use cookies, and serves only public content.
239
# Private mode (normal mode) requires login, and only serves files relevant to
240
# the logged-in user."""))
241
config_options.append(ConfigOption("allowed_uids", "33",
242
"""UID of the web server process which will run IVLE.
243
Only this user may execute the trampoline. May specify multiple users as
244
a comma-separated list.
247
# The User-ID of the web server process which will run IVLE, and any other
248
# users who are allowed to run the trampoline. This is stores as a string of
249
# comma-separated integers, simply because it is not used within Python, only
250
# used by the setup program to write to conf.h (see setup.py config)."""))
251
config_options.append(ConfigOption("db_host", "localhost",
252
"""PostgreSQL Database config
253
==========================
254
Hostname of the DB server:""",
256
### PostgreSQL Database config ###
257
# Database server hostname"""))
258
config_options.append(ConfigOption("db_port", "5432",
259
"""Port of the DB server:""",
261
# Database server port"""))
262
config_options.append(ConfigOption("db_dbname", "ivle",
263
"""Database name:""",
266
config_options.append(ConfigOption("db_user", "postgres",
267
"""Username for DB server login:""",
269
# Database username"""))
270
config_options.append(ConfigOption("db_password", "",
271
"""Password for DB server login:
272
(Caution: This password is stored in plaintext in lib/conf/conf.py)""",
274
# Database password"""))
275
config_options.append(ConfigOption("auth_modules", "ldap_auth",
276
"""Authentication config
277
=====================
278
Comma-separated list of authentication modules. Only "ldap" is available
281
# Comma-separated list of authentication modules.
282
# These refer to importable Python modules in the www/auth directory.
283
# Modules "ldap" and "guest" are available in the source tree, but
284
# other modules may be plugged in to auth against organisation-specific
285
# auth backends."""))
286
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
287
"""(LDAP options are only relevant if "ldap" is included in the list of
289
URL for LDAP authentication server:""",
291
# URL for LDAP authentication server"""))
292
config_options.append(ConfigOption("ldap_format_string",
293
"uid=%s,ou=users,o=example",
294
"""Format string for LDAP auth request:
295
(Must contain a single "%s" for the user's login name)""",
297
# Format string for LDAP auth request
298
# (Must contain a single "%s" for the user's login name)"""))
299
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
302
The base url for accessing subversion repositories:""",
304
# The base url for accessing subversion repositories."""))
305
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
306
"""The location of the subversion configuration file used by apache
307
to host the user repositories:""",
309
# The location of the subversion configuration file used by
310
# apache to host the user repositories."""))
311
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
312
"""The root directory for the subversion repositories:""",
314
# The root directory for the subversion repositories."""))
315
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
316
"""The location of the password file used to authenticate users
317
of the subversion repository from the ivle server:""",
319
# The location of the password file used to authenticate users
320
# of the subversion repository from the ivle server."""))
321
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
322
"""The location of the password file used to authenticate local users
323
of the subversion repository:""",
325
# The location of the password file used to authenticate local users
326
# of the subversion repository."""))
327
config_options.append(ConfigOption("usrmgt_host", "localhost",
328
"""User Management Server config
329
============================
330
The hostname where the usrmgt-server runs:""",
332
# The hostname where the usrmgt-server runs."""))
333
config_options.append(ConfigOption("usrmgt_port", "2178",
334
"""The port where the usrmgt-server runs:""",
336
# The port where the usrmgt-server runs."""))
337
config_options.append(ConfigOption("usrmgt_magic", "",
338
"""The password for the usrmgt-server:""",
340
# The password for the usrmgt-server."""))
342
# Try importing existing conf, but if we can't just set up defaults
343
# The reason for this is that these settings are used by other phases
344
# of setup besides conf, so we need to know them.
345
# Also this allows you to hit Return to accept the existing value.
347
confmodule = __import__("lib/conf/conf")
348
for opt in config_options:
350
globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
352
globals()[opt.option_name] = opt.default
354
# Just set reasonable defaults
355
for opt in config_options:
356
globals()[opt.option_name] = opt.default
358
# Try importing install_list, but don't fail if we can't, because listmake can
359
# function without it.
365
# Mime types which will automatically be placed in the list by listmake.
366
# Note that listmake is not intended to be run by the final user (the system
367
# administrator who installs this), so the developers can customize the list
368
# as necessary, and include it in the distribution.
369
listmake_mimetypes = ['text/x-python', 'text/html',
370
'application/x-javascript', 'application/javascript',
371
'text/css', 'image/png', 'application/xml']
373
# Main function skeleton from Guido van Rossum
374
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
33
376
def main(argv=None):
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):
399
# Disallow run as root unless installing
400
if (operation != 'install' and operation != 'updatejails'
401
and os.geteuid() == 0):
402
print >>sys.stderr, "I do not want to run this stage as root."
403
print >>sys.stderr, "Please run as a normal user."
74
405
# Call the requested operation's function
78
'build' : setup.build.build,
79
'install' : setup.install.install,
411
'listmake' : listmake,
413
'updatejails' : updatejails,
82
416
print >>sys.stderr, (
83
417
"""Invalid operation '%s'. Try python setup.py help."""
420
return oper_func(argv[2:])
422
# Operation functions
426
print """Usage: python setup.py operation [args]
427
Operation (and args) can be:
429
listmake (developer use only)
432
install [--nojail] [--nosubjects] [-n|--dry]
436
print """Usage: python setup.py help [operation]"""
441
if operation == 'help':
442
print """python setup.py help [operation]
443
Prints the usage message or detailed help on an operation, then exits."""
444
elif operation == 'listmake':
445
print """python setup.py listmake
446
(For developer use only)
447
Recurses through the source tree and builds a list of all files which should
448
be copied upon installation. This should be run by the developer before
449
cutting a distribution, and the listfile it generates should be included in
450
the distribution, avoiding the administrator having to run it."""
451
elif operation == 'config':
452
print """python setup.py config [args]
453
Configures IVLE with machine-specific details, most notably, various paths.
454
Either prompts the administrator for these details or accepts them as
455
command-line args. Will be interactive only if there are no arguments given.
456
Takes defaults from existing conf file if it exists.
458
To run IVLE out of the source directory (allowing development without having
459
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
460
directory, and run build/install one time.
462
Creates lib/conf/conf.py and trampoline/conf.h.
465
for opt in config_options:
466
print " --" + opt.option_name
467
print """As explained in the interactive prompt or conf.py.
469
elif operation == 'build':
470
print """python -O setup.py build [--dry|-n]
471
Compiles all files and sets up a jail template in the source directory.
472
-O is recommended to cause compilation to be optimised.
474
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
476
Creates standard subdirs inside the jail, eg bin, opt, home, tmp.
477
Copies console/ to a location within the jail.
478
Copies OS programs and files to corresponding locations within the jail
479
(eg. python and Python libs, ld.so, etc).
480
Generates .pyc or .pyo files for all the IVLE .py files.
482
--dry | -n Print out the actions but don't do anything."""
483
elif operation == 'install':
484
print """sudo python setup.py install [--nojail] [--nosubjects][--dry|-n]
486
Create target install directory ($target).
488
Copy trampoline/trampoline to $target/bin.
489
chown and chmod the installed trampoline.
490
Copy www/ to $target.
491
Copy jail/ to jails template directory (unless --nojail specified).
492
Copy subjects/ to subjects directory (unless --nosubjects specified).
494
--nojail Do not copy the jail.
495
--nosubjects Do not copy the subjects and exercises directories.
496
--dry | -n Print out the actions but don't do anything."""
497
elif operation == 'updatejails':
498
print """sudo python setup.py updatejails [--dry|-n]
500
Copy jail/ to each subdirectory in jails directory.
502
--dry | -n Print out the actions but don't do anything."""
504
print >>sys.stderr, (
505
"""Invalid operation '%s'. Try python setup.py help."""
510
# We build two separate lists, by walking www and console
511
list_www = build_list_py_files('www')
512
list_lib = build_list_py_files('lib')
513
list_subjects = build_list_py_files('subjects', no_top_level=True)
514
list_exercises = build_list_py_files('exercises', no_top_level=True)
516
"scripts/python-console",
517
"scripts/fileservice",
518
"scripts/usrmgt-server",
520
# Make sure that the files generated by conf are in the list
521
# (since listmake is typically run before conf)
522
if "lib/conf/conf.py" not in list_lib:
523
list_lib.append("lib/conf/conf.py")
524
# Write these out to a file
526
# the files that will be created/overwritten
527
listfile = os.path.join(cwd, "install_list.py")
530
file = open(listfile, "w")
532
file.write("""# IVLE Configuration File
534
# Provides lists of all files to be installed by `setup.py install' from
535
# certain directories.
536
# Note that any files with the given filename plus 'c' or 'o' (that is,
537
# compiled .pyc or .pyo files) will be copied as well.
539
# List of all installable files in www directory.
541
writelist_pretty(file, list_www)
543
# List of all installable files in lib directory.
545
writelist_pretty(file, list_lib)
547
# List of all installable files in scripts directory.
549
writelist_pretty(file, list_scripts)
551
# List of all installable files in subjects directory.
552
# This is to install sample subjects and material.
554
writelist_pretty(file, list_subjects)
556
# List of all installable files in exercises directory.
557
# This is to install sample exercise material.
558
list_exercises = """)
559
writelist_pretty(file, list_exercises)
562
except IOError, (errno, strerror):
563
print "IO error(%s): %s" % (errno, strerror)
566
print "Successfully wrote install_list.py"
569
print ("You may modify the set of installable files before cutting the "
576
def build_list_py_files(dir, no_top_level=False):
577
"""Builds a list of all py files found in a directory and its
578
subdirectories. Returns this as a list of strings.
579
no_top_level=True means the file paths will not include the top-level
583
for (dirpath, dirnames, filenames) in os.walk(dir):
584
# Exclude directories beginning with a '.' (such as '.svn')
585
filter_mutate(lambda x: x[0] != '.', dirnames)
586
# All *.py files are added to the list
587
pylist += [os.path.join(dirpath, item) for item in filenames
588
if mimetypes.guess_type(item)[0] in listmake_mimetypes]
590
for i in range(0, len(pylist)):
591
_, pylist[i] = pylist[i].split(os.sep, 1)
594
def writelist_pretty(file, list):
595
"""Writes a list one element per line, to a file."""
601
file.write(' %s,\n' % repr(elem))
605
global db_port, usrmgt_port
606
# Set up some variables
609
# the files that will be created/overwritten
610
conffile = os.path.join(cwd, "lib/conf/conf.py")
611
jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
612
conf_hfile = os.path.join(cwd, "trampoline/conf.h")
614
# Get command-line arguments to avoid asking questions.
617
for opt in config_options:
618
optnames.append(opt.option_name + "=")
619
(opts, args) = getopt.gnu_getopt(args, "", optnames)
622
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
626
# Interactive mode. Prompt the user for all the values.
628
print """This tool will create the following files:
632
prompting you for details about your configuration. The file will be
633
overwritten if it already exists. It will *not* install or deploy IVLE.
635
Please hit Ctrl+C now if you do not wish to do this.
636
""" % (conffile, jailconffile, conf_hfile)
638
# Get information from the administrator
639
# If EOF is encountered at any time during the questioning, just exit
642
for opt in config_options:
643
globals()[opt.option_name] = \
644
query_user(globals()[opt.option_name], opt.prompt)
647
# Non-interactive mode. Parse the options.
648
for opt in config_options:
649
if '--' + opt.option_name in opts:
650
globals()[opt.option_name] = opts['--' + opt.option_name]
652
# Error handling on input values
654
allowed_uids_list = map(int, allowed_uids.split(','))
656
print >>sys.stderr, (
657
"Invalid UID list (%s).\n"
658
"Must be a comma-separated list of integers." % allowed_uids)
661
db_port = int(db_port)
662
if db_port < 0 or db_port >= 65536: raise ValueError()
664
print >>sys.stderr, (
665
"Invalid DB port (%s).\n"
666
"Must be an integer between 0 and 65535." % repr(db_port))
669
usrmgt_port = int(usrmgt_port)
670
if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
672
print >>sys.stderr, (
673
"Invalid user management port (%s).\n"
674
"Must be an integer between 0 and 65535." % repr(usrmgt_port))
677
# Write lib/conf/conf.py
680
conf = open(conffile, "w")
682
conf.write("""# IVLE Configuration File
684
# Miscellaneous application settings
687
for opt in config_options:
688
conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
689
repr(globals()[opt.option_name])))
692
except IOError, (errno, strerror):
693
print "IO error(%s): %s" % (errno, strerror)
696
print "Successfully wrote lib/conf/conf.py"
698
# Write conf/jailconf.py
701
conf = open(jailconffile, "w")
703
# In the "in-jail" version of conf, we don't need MOST of the details
704
# (it would be a security risk to have them here).
705
# So we just write root_dir, and jail_base is "/".
706
# (jail_base being "/" means "jail-relative" paths are relative to "/"
707
# when inside the jail.)
708
conf.write("""# IVLE Configuration File
710
# Miscellaneous application settings
711
# (User jail version)
714
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
716
# eg. "/" or "/ivle".
719
# In the local file system, where are the student/user file spaces located.
720
# The user jails are expected to be located immediately in subdirectories of
724
# The hostname for serving publicly accessible pages
726
""" % (repr(root_dir),repr(public_host)))
729
except IOError, (errno, strerror):
730
print "IO error(%s): %s" % (errno, strerror)
733
print "Successfully wrote lib/conf/jailconf.py"
735
# Write trampoline/conf.h
738
conf = open(conf_hfile, "w")
740
conf.write("""/* IVLE Configuration File
742
* Administrator settings required by trampoline.
743
* Note: trampoline will have to be rebuilt in order for changes to this file
747
/* In the local file system, where are the jails located.
748
* The trampoline does not allow the creation of a jail anywhere besides
749
* jail_base or a subdirectory of jail_base.
751
static const char* jail_base = "%s";
753
/* Which user IDs are allowed to run the trampoline.
754
* This list should be limited to the web server user.
755
* (Note that root is an implicit member of this list).
757
static const int allowed_uids[] = { %s };
758
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
759
# Note: The above uses PYTHON reprs, not C reprs
760
# However they should be the same with the exception of the outer
761
# characters, which are stripped off and replaced
764
except IOError, (errno, strerror):
765
print "IO error(%s): %s" % (errno, strerror)
768
print "Successfully wrote trampoline/conf.h"
771
print "You may modify the configuration at any time by editing"
779
# Get "dry" variable from command line
780
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
782
dry = '-n' in opts or '--dry' in opts
785
print "Dry run (no actions will be executed\n"
787
# Compile the trampoline
789
os.chdir('trampoline')
790
action_runprog('make', [], dry)
793
# Create the jail and its subdirectories
794
# Note: Other subdirs will be made by copying files
795
action_mkdir('jail', dry)
796
action_mkdir('jail/home', dry)
797
action_mkdir('jail/tmp', dry)
799
# Copy all console and operating system files into the jail
800
action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
801
copy_os_files_jail(dry)
802
# Chmod the python console
803
action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
804
action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
806
# Also copy the IVLE lib directory into the jail
807
# This is necessary for running certain scripts
808
action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
809
# IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
810
# which could compromise security if left in the jail (such as the DB
812
# The "safe" version is in jailconf.py. Delete conf.py and replace it with
814
action_copyfile('lib/conf/jailconf.py',
815
'jail/opt/ivle/lib/conf/conf.py', dry)
817
# Compile .py files into .pyc or .pyo files
818
compileall.compile_dir('www', quiet=True)
819
compileall.compile_dir('lib', quiet=True)
820
compileall.compile_dir('scripts', quiet=True)
821
compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
823
# Set up ivle.pth inside the jail
824
# Need to set /opt/ivle/lib to be on the import path
826
"jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
827
f = open(ivle_pth, 'w')
828
f.write('/opt/ivle/lib\n')
833
def copy_os_files_jail(dry):
834
"""Copies necessary Operating System files from their usual locations
835
into the jail/ directory of the cwd."""
836
# Currently source paths are configured for Ubuntu.
837
for filename in JAIL_FILES:
838
copy_file_to_jail(filename, dry)
839
for src, dst in JAIL_LINKS.items():
840
action_symlink(src, dst, dry)
841
for src, dst in JAIL_COPYTREES.items():
842
action_copytree(src, dst, dry)
844
def copy_file_to_jail(src, dry):
845
"""Copies a single file from an absolute location into the same location
846
within the jail. src must begin with a '/'. The jail will be located
847
in a 'jail' subdirectory of the current path."""
848
action_copyfile(src, 'jail' + src, dry)
851
# Get "dry" and "nojail" variables from command line
852
(opts, args) = getopt.gnu_getopt(args, "n",
853
['dry', 'nojail', 'nosubjects'])
855
dry = '-n' in opts or '--dry' in opts
856
nojail = '--nojail' in opts
857
nosubjects = '--nosubjects' in opts
860
print "Dry run (no actions will be executed\n"
862
if not dry and os.geteuid() != 0:
863
print >>sys.stderr, "Must be root to run install"
864
print >>sys.stderr, "(I need to chown some files)."
867
# Create the target (install) directory
868
action_mkdir(ivle_install_dir, dry)
870
# Create bin and copy the compiled files there
871
action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
872
tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
873
action_copyfile('trampoline/trampoline', tramppath, dry)
874
# chown trampoline to root and set setuid bit
875
action_chown_setuid(tramppath, dry)
877
# Create a scripts directory to put the usrmgt-server in.
878
action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
879
usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
880
action_copyfile('scripts/usrmgt-server', usrmgtpath, dry)
881
action_chmod_x(usrmgtpath, dry)
883
# Copy the www and lib directories using the list
884
action_copylist(install_list.list_www, ivle_install_dir, dry)
885
action_copylist(install_list.list_lib, ivle_install_dir, dry)
887
# Copy the php directory
888
action_copytree('www/php/phpBB3',os.path.join(ivle_install_dir,'www/php/phpBB3'),
892
# Copy the local jail directory built by the build action
893
# to the jails template directory (it will be used as a template
894
# for all the students' jails).
895
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
897
# Copy the subjects and exercises directories across
898
action_copylist(install_list.list_subjects, subjects_base, dry,
900
action_copylist(install_list.list_exercises, exercises_base, dry,
901
srcdir="./exercises")
903
# Append IVLE path to ivle.pth in python site packages
904
# (Unless it's already there)
905
ivle_pth = os.path.join(sys.prefix,
906
"lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
907
ivle_www = os.path.join(ivle_install_dir, "www")
908
ivle_lib = os.path.join(ivle_install_dir, "lib")
909
write_ivle_pth = True
910
write_ivle_lib_pth = True
912
file = open(ivle_pth, 'r')
914
if line.strip() == ivle_www:
915
write_ivle_pth = False
916
elif line.strip() == ivle_lib:
917
write_ivle_lib_pth = False
919
except (IOError, OSError):
922
action_append(ivle_pth, ivle_www)
923
if write_ivle_lib_pth:
924
action_append(ivle_pth, ivle_lib)
928
def updatejails(args):
929
# Get "dry" variable from command line
930
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
932
dry = '-n' in opts or '--dry' in opts
935
print "Dry run (no actions will be executed\n"
937
if not dry and os.geteuid() != 0:
938
print >>sys.stderr, "Must be root to run install"
939
print >>sys.stderr, "(I need to chown some files)."
942
# Update the template jail directory in case it hasn't been installed
944
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
946
# Re-link all the files in all students jails.
947
for dir in os.listdir(jail_base):
948
if dir == 'template': continue
949
# First back up the student's home directory
950
temp_home = os.tmpnam()
951
action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
952
# Delete the student's jail and relink the jail files
953
action_linktree(os.path.join(jail_base, 'template'),
954
os.path.join(jail_base, dir), dry)
955
# Restore the student's home directory
956
action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
957
# Set up the user's home directory just in case they don't have a
958
# directory for this yet
959
action_mkdir(os.path.join(jail_base, dir, 'home', dir), dry)
963
# The actions call Python os functions but print actions and handle dryness.
964
# May still throw os exceptions if errors occur.
967
"""Represents an error when running a program (nonzero return)."""
968
def __init__(self, prog, retcode):
970
self.retcode = retcode
972
return str(self.prog) + " returned " + repr(self.retcode)
974
def action_runprog(prog, args, dry):
975
"""Runs a unix program. Searches in $PATH. Synchronous (waits for the
976
program to return). Runs in the current environment. First prints the
977
action as a "bash" line.
979
Throws a RunError with a retcode of the return value of the program,
980
if the program did not return 0.
982
prog: String. Name of the program. (No path required, if in $PATH).
983
args: [String]. Arguments to the program.
984
dry: Bool. If True, prints but does not execute.
986
print prog, string.join(args, ' ')
988
ret = os.spawnvp(os.P_WAIT, prog, args)
990
raise RunError(prog, ret)
992
def action_remove(path, dry):
993
"""Calls rmtree, deleting the target file if it exists."""
997
shutil.rmtree(path, True)
998
except OSError, (err, msg):
999
if err != errno.EEXIST:
1001
# Otherwise, didn't exist, so we don't care
1003
def action_rename(src, dst, dry):
1004
"""Calls rename. Deletes the target if it already exists."""
1005
action_remove(dst, dry)
1006
print "mv ", src, dst
1010
except OSError, (err, msg):
1011
if err != errno.EEXIST:
1014
def action_mkdir(path, dry):
1015
"""Calls mkdir. Silently ignored if the directory already exists.
1016
Creates all parent directories as necessary."""
1017
print "mkdir -p", path
1021
except OSError, (err, msg):
1022
if err != errno.EEXIST:
1025
def action_copytree(src, dst, dry):
1026
"""Copies an entire directory tree. Symlinks are seen as normal files and
1027
copies of the entire file (not the link) are made. Creates all parent
1028
directories as necessary.
1030
See shutil.copytree."""
1031
# Allow copying over itself
1032
if (os.path.normpath(os.path.join(os.getcwd(),src)) ==
1033
os.path.normpath(os.path.join(os.getcwd(),dst))):
1035
action_remove(dst, dry)
1036
print "cp -r", src, dst
1038
shutil.copytree(src, dst, True)
1040
def action_linktree(src, dst, dry):
1041
"""Hard-links an entire directory tree. Same as copytree but the created
1042
files are hard-links not actual copies. Removes the existing destination.
1044
action_remove(dst, dry)
1045
print "<cp with hardlinks> -r", src, dst
1047
common.makeuser.linktree(src, dst)
1049
def action_copylist(srclist, dst, dry, srcdir="."):
1050
"""Copies all files in a list to a new location. The files in the list
1051
are read relative to the current directory, and their destinations are the
1052
same paths relative to dst. Creates all parent directories as necessary.
1053
srcdir is "." by default, can be overridden.
1055
for srcfile in srclist:
1056
dstfile = os.path.join(dst, srcfile)
1057
srcfile = os.path.join(srcdir, srcfile)
1058
dstdir = os.path.split(dstfile)[0]
1059
if not os.path.isdir(dstdir):
1060
action_mkdir(dstdir, dry)
1061
print "cp -f", srcfile, dstfile
1064
shutil.copyfile(srcfile, dstfile)
1065
shutil.copymode(srcfile, dstfile)
1066
except shutil.Error:
1069
def action_copyfile(src, dst, dry):
1070
"""Copies one file to a new location. Creates all parent directories
1072
Warn if file not found.
1074
dstdir = os.path.split(dst)[0]
1075
if not os.path.isdir(dstdir):
1076
action_mkdir(dstdir, dry)
1077
print "cp -f", src, dst
1080
shutil.copyfile(src, dst)
1081
shutil.copymode(src, dst)
1082
except (shutil.Error, IOError), e:
1083
print "Warning: " + str(e)
1085
def action_symlink(src, dst, dry):
1086
"""Creates a symlink in a given location. Creates all parent directories
1089
dstdir = os.path.split(dst)[0]
1090
if not os.path.isdir(dstdir):
1091
action_mkdir(dstdir, dry)
1092
# Delete existing file
1093
if os.path.exists(dst):
1095
print "ln -fs", src, dst
1097
os.symlink(src, dst)
1099
def action_append(ivle_pth, ivle_www):
1100
file = open(ivle_pth, 'a+')
1101
file.write(ivle_www + '\n')
1104
def action_chown_setuid(file, dry):
1105
"""Chowns a file to root, and sets the setuid bit on the file.
1106
Calling this function requires the euid to be root.
1107
The actual mode of path is set to: rws--s--s
1109
print "chown root:root", file
1111
os.chown(file, 0, 0)
1112
print "chmod a+xs", file
1113
print "chmod u+rw", file
1115
os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
1116
| stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
1118
def action_chmod_x(file, dry):
1119
"""Chmod 755 a file (sets permissions to rwxr-xr-x)."""
1120
print "chmod 755", file
1122
os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1123
| stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
1125
def query_user(default, prompt):
1126
"""Prompts the user for a string, which is read from a line of stdin.
1127
Exits silently if EOF is encountered. Returns the string, with spaces
1128
removed from the beginning and end.
1130
Returns default if a 0-length line (after spaces removed) was read.
1132
sys.stdout.write('%s\n (default: "%s")\n>' % (prompt, default))
1134
val = sys.stdin.readline()
1135
except KeyboardInterrupt:
1137
sys.stdout.write("\n")
1139
sys.stdout.write("\n")
1141
if val == '': sys.exit(1)
1142
# If empty line, return default
1144
if val == '': return default
1147
def filter_mutate(function, list):
1148
"""Like built-in filter, but mutates the given list instead of returning a
1149
new one. Returns None."""
1152
# Delete elements which do not match
1153
if not function(list[i]):
88
1157
if __name__ == "__main__":
added
removed
setup.py
