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_forumdbname", "ivle_forum",
276
"""Forum Database name:""",
278
# Forum Database name"""))
279
config_options.append(ConfigOption("db_user", "postgres",
280
"""Username for DB server login:""",
282
# Database username"""))
283
config_options.append(ConfigOption("db_password", "",
284
"""Password for DB server login:
285
(Caution: This password is stored in plaintext in lib/conf/conf.py)""",
287
# Database password"""))
288
config_options.append(ConfigOption("auth_modules", "ldap_auth",
289
"""Authentication config
290
=====================
291
Comma-separated list of authentication modules. Only "ldap" is available
294
# Comma-separated list of authentication modules.
295
# These refer to importable Python modules in the www/auth directory.
296
# Modules "ldap" and "guest" are available in the source tree, but
297
# other modules may be plugged in to auth against organisation-specific
298
# auth backends."""))
299
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
300
"""(LDAP options are only relevant if "ldap" is included in the list of
302
URL for LDAP authentication server:""",
304
# URL for LDAP authentication server"""))
305
config_options.append(ConfigOption("ldap_format_string",
306
"uid=%s,ou=users,o=example",
307
"""Format string for LDAP auth request:
308
(Must contain a single "%s" for the user's login name)""",
310
# Format string for LDAP auth request
311
# (Must contain a single "%s" for the user's login name)"""))
312
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
315
The base url for accessing subversion repositories:""",
317
# The base url for accessing subversion repositories."""))
318
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
319
"""The location of the subversion configuration file used by apache
320
to host the user repositories:""",
322
# The location of the subversion configuration file used by
323
# apache to host the user repositories."""))
324
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
325
"""The root directory for the subversion repositories:""",
327
# The root directory for the subversion repositories."""))
328
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
329
"""The location of the password file used to authenticate users
330
of the subversion repository from the ivle server:""",
332
# The location of the password file used to authenticate users
333
# of the subversion repository from the ivle server."""))
334
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
335
"""The location of the password file used to authenticate local users
336
of the subversion repository:""",
338
# The location of the password file used to authenticate local users
339
# of the subversion repository."""))
340
config_options.append(ConfigOption("usrmgt_host", "localhost",
341
"""User Management Server config
342
============================
343
The hostname where the usrmgt-server runs:""",
345
# The hostname where the usrmgt-server runs."""))
346
config_options.append(ConfigOption("usrmgt_port", "2178",
347
"""The port where the usrmgt-server runs:""",
349
# The port where the usrmgt-server runs."""))
350
config_options.append(ConfigOption("usrmgt_magic", "",
351
"""The password for the usrmgt-server:""",
353
# The password for the usrmgt-server."""))
355
# Try importing existing conf, but if we can't just set up defaults
356
# The reason for this is that these settings are used by other phases
357
# of setup besides conf, so we need to know them.
358
# Also this allows you to hit Return to accept the existing value.
360
confmodule = __import__("lib/conf/conf")
361
for opt in config_options:
363
globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
365
globals()[opt.option_name] = opt.default
367
# Just set reasonable defaults
368
for opt in config_options:
369
globals()[opt.option_name] = opt.default
371
# Try importing install_list, but don't fail if we can't, because listmake can
372
# function without it.
378
# Mime types which will automatically be placed in the list by listmake.
379
# Note that listmake is not intended to be run by the final user (the system
380
# administrator who installs this), so the developers can customize the list
381
# as necessary, and include it in the distribution.
382
listmake_mimetypes = ['text/x-python', 'text/html',
383
'application/x-javascript', 'application/javascript',
384
'text/css', 'image/png', 'image/gif', 'application/xml']
386
# Main function skeleton from Guido van Rossum
387
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
389
33
def main(argv=None):
412
# Disallow run as root unless installing
413
if (operation != 'install' and operation != 'updatejails'
414
and os.geteuid() == 0):
415
print >>sys.stderr, "I do not want to run this stage as root."
416
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):
418
74
# Call the requested operation's function
424
'listmake' : listmake,
426
'updatejails' : updatejails,
78
'build' : setup.build.build,
79
'install' : setup.install.install,
429
82
print >>sys.stderr, (
430
83
"""Invalid operation '%s'. Try python setup.py help."""
433
return oper_func(argv[2:])
435
# Operation functions
439
print """Usage: python setup.py operation [args]
440
Operation (and args) can be:
442
listmake (developer use only)
445
install [--nojail] [--nosubjects] [-n|--dry]
449
print """Usage: python setup.py help [operation]"""
454
if operation == 'help':
455
print """python setup.py help [operation]
456
Prints the usage message or detailed help on an operation, then exits."""
457
elif operation == 'listmake':
458
print """python setup.py listmake
459
(For developer use only)
460
Recurses through the source tree and builds a list of all files which should
461
be copied upon installation. This should be run by the developer before
462
cutting a distribution, and the listfile it generates should be included in
463
the distribution, avoiding the administrator having to run it."""
464
elif operation == 'config':
465
print """python setup.py config [args]
466
Configures IVLE with machine-specific details, most notably, various paths.
467
Either prompts the administrator for these details or accepts them as
468
command-line args. Will be interactive only if there are no arguments given.
469
Takes defaults from existing conf file if it exists.
471
To run IVLE out of the source directory (allowing development without having
472
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
473
directory, and run build/install one time.
475
Creates lib/conf/conf.py and trampoline/conf.h.
478
for opt in config_options:
479
print " --" + opt.option_name
480
print """As explained in the interactive prompt or conf.py.
482
elif operation == 'build':
483
print """python -O setup.py build [--dry|-n]
484
Compiles all files and sets up a jail template in the source directory.
485
-O is recommended to cause compilation to be optimised.
487
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
489
Creates standard subdirs inside the jail, eg bin, opt, home, tmp.
490
Copies console/ to a location within the jail.
491
Copies OS programs and files to corresponding locations within the jail
492
(eg. python and Python libs, ld.so, etc).
493
Generates .pyc or .pyo files for all the IVLE .py files.
495
--dry | -n Print out the actions but don't do anything."""
496
elif operation == 'install':
497
print """sudo python setup.py install [--nojail] [--nosubjects][--dry|-n]
499
Create target install directory ($target).
501
Copy trampoline/trampoline to $target/bin.
502
chown and chmod the installed trampoline.
503
Copy www/ to $target.
504
Copy jail/ to jails template directory (unless --nojail specified).
505
Copy subjects/ to subjects directory (unless --nosubjects specified).
507
--nojail Do not copy the jail.
508
--nosubjects Do not copy the subjects and exercises directories.
509
--dry | -n Print out the actions but don't do anything."""
510
elif operation == 'updatejails':
511
print """sudo python setup.py updatejails [--dry|-n]
513
Copy jail/ to each subdirectory in jails directory.
515
--dry | -n Print out the actions but don't do anything."""
517
print >>sys.stderr, (
518
"""Invalid operation '%s'. Try python setup.py help."""
523
# We build two separate lists, by walking www and console
524
list_www = build_list_py_files('www')
525
list_lib = build_list_py_files('lib')
526
list_subjects = build_list_py_files('subjects', no_top_level=True)
527
list_exercises = build_list_py_files('exercises', no_top_level=True)
529
"scripts/python-console",
530
"scripts/fileservice",
531
"scripts/usrmgt-server",
532
"scripts/diffservice",
534
# Make sure that the files generated by conf are in the list
535
# (since listmake is typically run before conf)
536
if "lib/conf/conf.py" not in list_lib:
537
list_lib.append("lib/conf/conf.py")
538
# Write these out to a file
540
# the files that will be created/overwritten
541
listfile = os.path.join(cwd, "install_list.py")
544
file = open(listfile, "w")
546
file.write("""# IVLE Configuration File
548
# Provides lists of all files to be installed by `setup.py install' from
549
# certain directories.
550
# Note that any files with the given filename plus 'c' or 'o' (that is,
551
# compiled .pyc or .pyo files) will be copied as well.
553
# List of all installable files in www directory.
555
writelist_pretty(file, list_www)
557
# List of all installable files in lib directory.
559
writelist_pretty(file, list_lib)
561
# List of all installable files in scripts directory.
563
writelist_pretty(file, list_scripts)
565
# List of all installable files in subjects directory.
566
# This is to install sample subjects and material.
568
writelist_pretty(file, list_subjects)
570
# List of all installable files in exercises directory.
571
# This is to install sample exercise material.
572
list_exercises = """)
573
writelist_pretty(file, list_exercises)
576
except IOError, (errno, strerror):
577
print "IO error(%s): %s" % (errno, strerror)
580
print "Successfully wrote install_list.py"
583
print ("You may modify the set of installable files before cutting the "
590
def build_list_py_files(dir, no_top_level=False):
591
"""Builds a list of all py files found in a directory and its
592
subdirectories. Returns this as a list of strings.
593
no_top_level=True means the file paths will not include the top-level
597
for (dirpath, dirnames, filenames) in os.walk(dir):
598
# Exclude directories beginning with a '.' (such as '.svn')
599
filter_mutate(lambda x: x[0] != '.', dirnames)
600
# All *.py files are added to the list
601
pylist += [os.path.join(dirpath, item) for item in filenames
602
if mimetypes.guess_type(item)[0] in listmake_mimetypes]
604
for i in range(0, len(pylist)):
605
_, pylist[i] = pylist[i].split(os.sep, 1)
608
def writelist_pretty(file, list):
609
"""Writes a list one element per line, to a file."""
615
file.write(' %s,\n' % repr(elem))
619
global db_port, usrmgt_port
620
# Set up some variables
623
# the files that will be created/overwritten
624
conffile = os.path.join(cwd, "lib/conf/conf.py")
625
jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
626
conf_hfile = os.path.join(cwd, "trampoline/conf.h")
627
phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
629
# Get command-line arguments to avoid asking questions.
632
for opt in config_options:
633
optnames.append(opt.option_name + "=")
634
(opts, args) = getopt.gnu_getopt(args, "", optnames)
637
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
641
# Interactive mode. Prompt the user for all the values.
643
print """This tool will create the following files:
647
prompting you for details about your configuration. The file will be
648
overwritten if it already exists. It will *not* install or deploy IVLE.
650
Please hit Ctrl+C now if you do not wish to do this.
651
""" % (conffile, jailconffile, conf_hfile)
653
# Get information from the administrator
654
# If EOF is encountered at any time during the questioning, just exit
657
for opt in config_options:
658
globals()[opt.option_name] = \
659
query_user(globals()[opt.option_name], opt.prompt)
662
# Non-interactive mode. Parse the options.
663
for opt in config_options:
664
if '--' + opt.option_name in opts:
665
globals()[opt.option_name] = opts['--' + opt.option_name]
667
# Error handling on input values
669
allowed_uids_list = map(int, allowed_uids.split(','))
671
print >>sys.stderr, (
672
"Invalid UID list (%s).\n"
673
"Must be a comma-separated list of integers." % allowed_uids)
676
db_port = int(db_port)
677
if db_port < 0 or db_port >= 65536: raise ValueError()
679
print >>sys.stderr, (
680
"Invalid DB port (%s).\n"
681
"Must be an integer between 0 and 65535." % repr(db_port))
684
usrmgt_port = int(usrmgt_port)
685
if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
687
print >>sys.stderr, (
688
"Invalid user management port (%s).\n"
689
"Must be an integer between 0 and 65535." % repr(usrmgt_port))
692
# Write lib/conf/conf.py
695
conf = open(conffile, "w")
697
conf.write("""# IVLE Configuration File
699
# Miscellaneous application settings
702
for opt in config_options:
703
conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
704
repr(globals()[opt.option_name])))
707
except IOError, (errno, strerror):
708
print "IO error(%s): %s" % (errno, strerror)
711
print "Successfully wrote lib/conf/conf.py"
713
# Write conf/jailconf.py
716
conf = open(jailconffile, "w")
718
# In the "in-jail" version of conf, we don't need MOST of the details
719
# (it would be a security risk to have them here).
720
# So we just write root_dir, and jail_base is "/".
721
# (jail_base being "/" means "jail-relative" paths are relative to "/"
722
# when inside the jail.)
723
conf.write("""# IVLE Configuration File
725
# Miscellaneous application settings
726
# (User jail version)
729
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
731
# eg. "/" or "/ivle".
734
# In the local file system, where are the student/user file spaces located.
735
# The user jails are expected to be located immediately in subdirectories of
739
# The hostname for serving publicly accessible pages
741
""" % (repr(root_dir),repr(public_host)))
744
except IOError, (errno, strerror):
745
print "IO error(%s): %s" % (errno, strerror)
748
print "Successfully wrote lib/conf/jailconf.py"
750
# Write trampoline/conf.h
753
conf = open(conf_hfile, "w")
755
conf.write("""/* IVLE Configuration File
757
* Administrator settings required by trampoline.
758
* Note: trampoline will have to be rebuilt in order for changes to this file
762
/* In the local file system, where are the jails located.
763
* The trampoline does not allow the creation of a jail anywhere besides
764
* jail_base or a subdirectory of jail_base.
766
static const char* jail_base = "%s";
768
/* Which user IDs are allowed to run the trampoline.
769
* This list should be limited to the web server user.
770
* (Note that root is an implicit member of this list).
772
static const int allowed_uids[] = { %s };
773
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
774
# Note: The above uses PYTHON reprs, not C reprs
775
# However they should be the same with the exception of the outer
776
# characters, which are stripped off and replaced
779
except IOError, (errno, strerror):
780
print "IO error(%s): %s" % (errno, strerror)
783
print "Successfully wrote trampoline/conf.h"
785
# Write www/php/phpBB3/config.php
788
conf = open(phpBBconffile, "w")
791
if db_host == 'localhost':
792
forumdb_host = '127.0.0.1'
794
forumdb_host = db_host
797
// phpBB 3.0.x auto-generated configuration file
798
// Do not change anything in this file!
800
$dbhost = '""" + forumdb_host + """';
801
$dbport = '""" + str(db_port) + """';
802
$dbname = '""" + db_forumdbname + """';
803
$dbuser = '""" + db_user + """';
804
$dbpasswd = '""" + db_password + """';
806
$table_prefix = 'phpbb_';
808
$load_extensions = '';
809
@define('PHPBB_INSTALLED', true);
810
// @define('DEBUG', true);
811
//@define('DEBUG_EXTRA', true);
815
except IOError, (errno, strerror):
816
print "IO error(%s): %s" % (errno, strerror)
819
print "Successfully wrote www/php/phpBB3/config.php"
822
print "You may modify the configuration at any time by editing"
831
# Get "dry" variable from command line
832
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
834
dry = '-n' in opts or '--dry' in opts
837
print "Dry run (no actions will be executed\n"
839
# Compile the trampoline
841
os.chdir('trampoline')
842
action_runprog('make', [], dry)
845
# Create the jail and its subdirectories
846
# Note: Other subdirs will be made by copying files
847
action_mkdir('jail', dry)
848
action_mkdir('jail/home', dry)
849
action_mkdir('jail/tmp', dry)
851
# Chmod the tmp directory to world writable
852
action_chmod_w('jail/tmp', dry)
854
# Copy all console and operating system files into the jail
855
action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
856
copy_os_files_jail(dry)
857
# Chmod the python console
858
action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
859
action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
861
# Also copy the IVLE lib directory into the jail
862
# This is necessary for running certain scripts
863
action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
864
# IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
865
# which could compromise security if left in the jail (such as the DB
867
# The "safe" version is in jailconf.py. Delete conf.py and replace it with
869
action_copyfile('lib/conf/jailconf.py',
870
'jail/opt/ivle/lib/conf/conf.py', dry)
872
# Compile .py files into .pyc or .pyo files
873
compileall.compile_dir('www', quiet=True)
874
compileall.compile_dir('lib', quiet=True)
875
compileall.compile_dir('scripts', quiet=True)
876
compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
878
# Set up ivle.pth inside the jail
879
# Need to set /opt/ivle/lib to be on the import path
881
"jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
882
f = open(ivle_pth, 'w')
883
f.write('/opt/ivle/lib\n')
888
def copy_os_files_jail(dry):
889
"""Copies necessary Operating System files from their usual locations
890
into the jail/ directory of the cwd."""
891
# Currently source paths are configured for Ubuntu.
892
for filename in JAIL_FILES:
893
copy_file_to_jail(filename, dry)
894
for src, dst in JAIL_LINKS.items():
895
action_symlink(src, dst, dry)
896
for src, dst in JAIL_COPYTREES.items():
897
action_copytree(src, dst, dry)
899
def copy_file_to_jail(src, dry):
900
"""Copies a single file from an absolute location into the same location
901
within the jail. src must begin with a '/'. The jail will be located
902
in a 'jail' subdirectory of the current path."""
903
action_copyfile(src, 'jail' + src, dry)
906
# Get "dry" and "nojail" variables from command line
907
(opts, args) = getopt.gnu_getopt(args, "n",
908
['dry', 'nojail', 'nosubjects'])
910
dry = '-n' in opts or '--dry' in opts
911
nojail = '--nojail' in opts
912
nosubjects = '--nosubjects' in opts
915
print "Dry run (no actions will be executed\n"
917
if not dry and os.geteuid() != 0:
918
print >>sys.stderr, "Must be root to run install"
919
print >>sys.stderr, "(I need to chown some files)."
922
# Create the target (install) directory
923
action_mkdir(ivle_install_dir, dry)
925
# Create bin and copy the compiled files there
926
action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
927
tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
928
action_copyfile('trampoline/trampoline', tramppath, dry)
929
# chown trampoline to root and set setuid bit
930
action_chown_setuid(tramppath, dry)
932
# Create a scripts directory to put the usrmgt-server in.
933
action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
934
usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
935
action_copyfile('scripts/usrmgt-server', usrmgtpath, dry)
936
action_chmod_x(usrmgtpath, dry)
938
# Copy the www and lib directories using the list
939
action_copylist(install_list.list_www, ivle_install_dir, dry)
940
action_copylist(install_list.list_lib, ivle_install_dir, dry)
942
# Copy the php directory
943
action_copytree('www/php/phpBB3',os.path.join(ivle_install_dir,'www/php/phpBB3'),
947
# Copy the local jail directory built by the build action
948
# to the jails template directory (it will be used as a template
949
# for all the students' jails).
950
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
952
# Copy the subjects and exercises directories across
953
action_copylist(install_list.list_subjects, subjects_base, dry,
955
action_copylist(install_list.list_exercises, exercises_base, dry,
956
srcdir="./exercises")
958
# Append IVLE path to ivle.pth in python site packages
959
# (Unless it's already there)
960
ivle_pth = os.path.join(sys.prefix,
961
"lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
962
ivle_www = os.path.join(ivle_install_dir, "www")
963
ivle_lib = os.path.join(ivle_install_dir, "lib")
964
write_ivle_pth = True
965
write_ivle_lib_pth = True
967
file = open(ivle_pth, 'r')
969
if line.strip() == ivle_www:
970
write_ivle_pth = False
971
elif line.strip() == ivle_lib:
972
write_ivle_lib_pth = False
974
except (IOError, OSError):
977
action_append(ivle_pth, ivle_www)
978
if write_ivle_lib_pth:
979
action_append(ivle_pth, ivle_lib)
983
def updatejails(args):
984
# Get "dry" variable from command line
985
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
987
dry = '-n' in opts or '--dry' in opts
990
print "Dry run (no actions will be executed\n"
992
if not dry and os.geteuid() != 0:
993
print >>sys.stderr, "Must be root to run install"
994
print >>sys.stderr, "(I need to chown some files)."
997
# Update the template jail directory in case it hasn't been installed
999
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
1001
# Re-link all the files in all students jails.
1002
for dir in os.listdir(jail_base):
1003
if dir == 'template': continue
1004
# First back up the student's home directory
1005
temp_home = os.tmpnam()
1006
action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
1007
# Delete the student's jail and relink the jail files
1008
action_linktree(os.path.join(jail_base, 'template'),
1009
os.path.join(jail_base, dir), dry)
1010
# Restore the student's home directory
1011
action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
1012
# Set up the user's home directory just in case they don't have a
1013
# directory for this yet
1014
action_mkdir(os.path.join(jail_base, dir, 'home', dir), dry)
1018
# The actions call Python os functions but print actions and handle dryness.
1019
# May still throw os exceptions if errors occur.
1022
"""Represents an error when running a program (nonzero return)."""
1023
def __init__(self, prog, retcode):
1025
self.retcode = retcode
1027
return str(self.prog) + " returned " + repr(self.retcode)
1029
def action_runprog(prog, args, dry):
1030
"""Runs a unix program. Searches in $PATH. Synchronous (waits for the
1031
program to return). Runs in the current environment. First prints the
1032
action as a "bash" line.
1034
Throws a RunError with a retcode of the return value of the program,
1035
if the program did not return 0.
1037
prog: String. Name of the program. (No path required, if in $PATH).
1038
args: [String]. Arguments to the program.
1039
dry: Bool. If True, prints but does not execute.
1041
print prog, string.join(args, ' ')
1043
ret = os.spawnvp(os.P_WAIT, prog, args)
1045
raise RunError(prog, ret)
1047
def action_remove(path, dry):
1048
"""Calls rmtree, deleting the target file if it exists."""
1052
shutil.rmtree(path, True)
1053
except OSError, (err, msg):
1054
if err != errno.EEXIST:
1056
# Otherwise, didn't exist, so we don't care
1058
def action_rename(src, dst, dry):
1059
"""Calls rename. Deletes the target if it already exists."""
1060
action_remove(dst, dry)
1061
print "mv ", src, dst
1065
except OSError, (err, msg):
1066
if err != errno.EEXIST:
1069
def action_mkdir(path, dry):
1070
"""Calls mkdir. Silently ignored if the directory already exists.
1071
Creates all parent directories as necessary."""
1072
print "mkdir -p", path
1076
except OSError, (err, msg):
1077
if err != errno.EEXIST:
1080
def action_copytree(src, dst, dry):
1081
"""Copies an entire directory tree. Symlinks are seen as normal files and
1082
copies of the entire file (not the link) are made. Creates all parent
1083
directories as necessary.
1085
See shutil.copytree."""
1086
# Allow copying over itself
1087
if (os.path.normpath(os.path.join(os.getcwd(),src)) ==
1088
os.path.normpath(os.path.join(os.getcwd(),dst))):
1090
action_remove(dst, dry)
1091
print "cp -r", src, dst
1093
shutil.copytree(src, dst, True)
1095
def action_linktree(src, dst, dry):
1096
"""Hard-links an entire directory tree. Same as copytree but the created
1097
files are hard-links not actual copies. Removes the existing destination.
1099
action_remove(dst, dry)
1100
print "<cp with hardlinks> -r", src, dst
1102
common.makeuser.linktree(src, dst)
1104
def action_copylist(srclist, dst, dry, srcdir="."):
1105
"""Copies all files in a list to a new location. The files in the list
1106
are read relative to the current directory, and their destinations are the
1107
same paths relative to dst. Creates all parent directories as necessary.
1108
srcdir is "." by default, can be overridden.
1110
for srcfile in srclist:
1111
dstfile = os.path.join(dst, srcfile)
1112
srcfile = os.path.join(srcdir, srcfile)
1113
dstdir = os.path.split(dstfile)[0]
1114
if not os.path.isdir(dstdir):
1115
action_mkdir(dstdir, dry)
1116
print "cp -f", srcfile, dstfile
1119
shutil.copyfile(srcfile, dstfile)
1120
shutil.copymode(srcfile, dstfile)
1121
except shutil.Error:
1124
def action_copyfile(src, dst, dry):
1125
"""Copies one file to a new location. Creates all parent directories
1127
Warn if file not found.
1129
dstdir = os.path.split(dst)[0]
1130
if not os.path.isdir(dstdir):
1131
action_mkdir(dstdir, dry)
1132
print "cp -f", src, dst
1135
shutil.copyfile(src, dst)
1136
shutil.copymode(src, dst)
1137
except (shutil.Error, IOError), e:
1138
print "Warning: " + str(e)
1140
def action_symlink(src, dst, dry):
1141
"""Creates a symlink in a given location. Creates all parent directories
1144
dstdir = os.path.split(dst)[0]
1145
if not os.path.isdir(dstdir):
1146
action_mkdir(dstdir, dry)
1147
# Delete existing file
1148
if os.path.exists(dst):
1150
print "ln -fs", src, dst
1152
os.symlink(src, dst)
1154
def action_append(ivle_pth, ivle_www):
1155
file = open(ivle_pth, 'a+')
1156
file.write(ivle_www + '\n')
1159
def action_chown_setuid(file, dry):
1160
"""Chowns a file to root, and sets the setuid bit on the file.
1161
Calling this function requires the euid to be root.
1162
The actual mode of path is set to: rws--s--s
1164
print "chown root:root", file
1166
os.chown(file, 0, 0)
1167
print "chmod a+xs", file
1168
print "chmod u+rw", file
1170
os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
1171
| stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
1173
def action_chmod_x(file, dry):
1174
"""Chmod 755 a file (sets permissions to rwxr-xr-x)."""
1175
print "chmod 755", file
1177
os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1178
| stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
1181
def action_chmod_w(file, dry):
1182
"""Chmod 777 a file (sets permissions to rwxrwxrwx)."""
1183
print "chmod 777", file
1185
os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1186
| stat.S_IXGRP | stat.S_IWGRP | stat.S_IRGRP | stat.S_IXOTH
1187
| stat.S_IWOTH | stat.S_IROTH)
1189
def query_user(default, prompt):
1190
"""Prompts the user for a string, which is read from a line of stdin.
1191
Exits silently if EOF is encountered. Returns the string, with spaces
1192
removed from the beginning and end.
1194
Returns default if a 0-length line (after spaces removed) was read.
1196
sys.stdout.write('%s\n (default: "%s")\n>' % (prompt, default))
1198
val = sys.stdin.readline()
1199
except KeyboardInterrupt:
1201
sys.stdout.write("\n")
1203
sys.stdout.write("\n")
1205
if val == '': sys.exit(1)
1206
# If empty line, return default
1208
if val == '': return default
1211
def filter_mutate(function, list):
1212
"""Like built-in filter, but mutates the given list instead of returning a
1213
new one. Returns None."""
1216
# Delete elements which do not match
1217
if not function(list[i]):
1221
88
if __name__ == "__main__":
added
removed
setup.py
