« back to all changes in this revision
Viewing changes to setup.py
- browse files at revision 106
- compare with another revision
- download diff
- download tarball
- view history from revision 106
- Committer: mattgiuca
- Date: 2007-12-20 22:46:43 UTC
- Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:106
Renamed "student_dir" to "jail_base" across the suite.
- files added:
- www/common/jail.py
- files removed:
- console/console.js
- www/apps/fileservice
- www/auth
- www/media/browser
- www/media/common
- files modified:
- console/index.html
added
removed
setup.py
25
25
# It is called with at least one argument, which specifies which operation to
26
26
# take.
27
27
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.
33
34
28
# setup.py conf [args]
35
29
# Configures IVLE with machine-specific details, most notably, various paths.
36
30
# Either prompts the administrator for these details or accepts them as
48
42
# (eg. python and Python libs, ld.so, etc).
49
43
# Generates .pyc files for all the IVLE .py files.
50
44
45
# setup.py listmake (for developer use only)
46
# Recurses through the source tree and builds a list of all files which should
47
# be copied upon installation. This should be run by the developer before
48
# cutting a distribution, and the listfile it generates should be included in
49
# the distribution, avoiding the administrator having to run it.
50
51
51
# setup.py install [--nojail] [--dry|n]
52
52
# (Requires root)
53
53
# Create target install directory ($target).
57
57
# Copy www/ to $target.
58
58
# Copy jail/ to jails template directory (unless --nojail specified).
59
59
60
# TODO: List in help, and handle, args for the conf operation
61
60
62
import os
61
import stat
62
import shutil
63
63
import sys
64
64
import getopt
65
import string
66
import errno
67
import mimetypes
68
import compileall
69
import getopt
70
71
# Try importing existing conf, but if we can't just set up defaults
72
# The reason for this is that these settings are used by other phases
73
# of setup besides conf, so we need to know them.
74
# Also this allows you to hit Return to accept the existing value.
75
try:
76
confmodule = __import__("www/conf/conf")
77
root_dir = confmodule.root_dir
78
ivle_install_dir = confmodule.ivle_install_dir
79
jail_base = confmodule.jail_base
80
except ImportError:
81
# Just set reasonable defaults
82
root_dir = "/ivle"
83
ivle_install_dir = "/opt/ivle"
84
jail_base = "/home/informatics/jails"
85
# Always defaults
86
allowed_uids = "0"
87
88
# Try importing install_list, but don't fail if we can't, because listmake can
89
# function without it.
90
try:
91
import install_list
92
except:
93
pass
94
95
# Mime types which will automatically be placed in the list by listmake.
96
# Note that listmake is not intended to be run by the final user (the system
97
# administrator who installs this), so the developers can customize the list
98
# as necessary, and include it in the distribution.
99
listmake_mimetypes = ['text/x-python', 'text/html',
100
'application/x-javascript', 'application/javascript',
101
'text/css', 'image/png']
102
65
103
66
# Main function skeleton from Guido van Rossum
104
67
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
105
68
69
class Usage(Exception):
70
def __init__(self, msg):
71
self.msg = msg
72
106
73
def main(argv=None):
107
74
if argv is None:
108
75
argv = sys.argv
126
93
help([])
127
94
return 1
128
95
129
# Disallow run as root unless installing
130
if operation != 'install' and os.geteuid() == 0:
131
print >>sys.stderr, "I do not want to run this stage as root."
132
print >>sys.stderr, "Please run as a normal user."
133
return 1
134
96
# Call the requested operation's function
135
97
try:
136
oper_func = {
98
return {
137
99
'help' : help,
138
100
'conf' : conf,
139
101
'build' : build,
140
102
'listmake' : listmake,
141
103
'install' : install,
142
}[operation]
104
}[operation](argv[2:])
143
105
except KeyError:
144
106
print >>sys.stderr, (
145
107
"""Invalid operation '%s'. Try python setup.py help."""
146
108
% operation)
147
return 1
148
return oper_func(argv[2:])
109
110
try:
111
try:
112
opts, args = getopt.getopt(argv[1:], "h", ["help"])
113
except getopt.error, msg:
114
raise Usage(msg)
115
# more code, unchanged
116
except Usage, err:
117
print >>sys.stderr, err.msg
118
print >>sys.stderr, "for help use --help"
119
return 2
149
120
150
121
# Operation functions
151
122
154
125
print """Usage: python setup.py operation [args]
155
126
Operation (and args) can be:
156
127
help [operation]
157
listmake (developer use only)
158
128
conf [args]
159
129
build
160
130
install [--nojail] [-n|--dry]
169
139
if operation == 'help':
170
140
print """python setup.py help [operation]
171
141
Prints the usage message or detailed help on an operation, then exits."""
172
elif operation == 'listmake':
173
print """python setup.py listmake
174
(For developer use only)
175
Recurses through the source tree and builds a list of all files which should
176
be copied upon installation. This should be run by the developer before
177
cutting a distribution, and the listfile it generates should be included in
178
the distribution, avoiding the administrator having to run it."""
179
142
elif operation == 'conf':
180
143
print """python setup.py conf [args]
181
144
Configures IVLE with machine-specific details, most notably, various paths.
182
145
Either prompts the administrator for these details or accepts them as
183
command-line args. Will be interactive only if there are no arguments given.
184
Takes defaults from existing conf file if it exists.
185
186
To run IVLE out of the source directory (allowing development without having
187
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
188
directory, and run build/install one time.
189
146
command-line args.
190
147
Creates www/conf/conf.py and trampoline/conf.h.
191
192
148
Args are:
193
--root_dir
194
--ivle_install_dir
195
--jail_base
196
--allowed_uids
197
As explained in the interactive prompt or conf.py.
198
149
"""
199
150
elif operation == 'build':
200
print """python -O setup.py build [--dry|-n]
151
print """python setup.py build
201
152
Compiles all files and sets up a jail template in the source directory.
202
-O is recommended to cause compilation to be optimised.
203
153
Details:
204
154
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
205
155
Creates jail/.
207
157
Copies console/ to a location within the jail.
208
158
Copies OS programs and files to corresponding locations within the jail
209
159
(eg. python and Python libs, ld.so, etc).
210
Generates .pyc or .pyo files for all the IVLE .py files.
211
212
--dry | -n Print out the actions but don't do anything."""
160
Generates .pyc files for all the IVLE .py files."""
161
elif operation == 'listmake':
162
print """python setup.py listmake
163
(For developer use only)
164
Recurses through the source tree and builds a list of all files which should
165
be copied upon installation. This should be run by the developer before
166
cutting a distribution, and the listfile it generates should be included in
167
the distribution, avoiding the administrator having to run it."""
213
168
elif operation == 'install':
214
169
print """sudo python setup.py install [--nojail] [--dry|-n]
215
170
(Requires root)
228
183
% operation)
229
184
return 1
230
185
231
def listmake(args):
232
# We build two separate lists, by walking www and console
233
list_www = build_list_py_files('www')
234
list_console = build_list_py_files('console')
235
# Make sure that the files generated by conf are in the list
236
# (since listmake is typically run before conf)
237
if "www/conf/conf.py" not in list_www:
238
list_www.append("www/conf/conf.py")
239
# Make sure that console/python-console is in the list
240
if "console/python-console" not in list_console:
241
list_console.append("console/python-console")
242
# Write these out to a file
243
cwd = os.getcwd()
244
# the files that will be created/overwritten
245
listfile = os.path.join(cwd, "install_list.py")
246
247
try:
248
file = open(listfile, "w")
249
250
file.write("""# IVLE Configuration File
251
# install_list.py
252
# Provides lists of all files to be installed by `setup.py install' from
253
# certain directories.
254
# Note that any files with the given filename plus 'c' or 'o' (that is,
255
# compiled .pyc or .pyo files) will be copied as well.
256
257
# List of all installable files in www directory.
258
list_www = """)
259
writelist_pretty(file, list_www)
260
file.write("""
261
# List of all installable files in console directory.
262
list_console = """)
263
writelist_pretty(file, list_console)
264
265
file.close()
266
except IOError, (errno, strerror):
267
print "IO error(%s): %s" % (errno, strerror)
268
sys.exit(1)
269
270
print "Successfully wrote install_list.py"
271
272
print
273
print ("You may modify the set of installable files before cutting the "
274
"distribution:")
275
print listfile
276
print
277
278
return 0
279
280
def build_list_py_files(dir):
281
"""Builds a list of all py files found in a directory and its
282
subdirectories. Returns this as a list of strings."""
283
pylist = []
284
for (dirpath, dirnames, filenames) in os.walk(dir):
285
# Exclude directories beginning with a '.' (such as '.svn')
286
filter_mutate(lambda x: x[0] != '.', dirnames)
287
# All *.py files are added to the list
288
pylist += [os.path.join(dirpath, item) for item in filenames
289
if mimetypes.guess_type(item)[0] in listmake_mimetypes]
290
return pylist
291
292
def writelist_pretty(file, list):
293
"""Writes a list one element per line, to a file."""
294
if list == []:
295
file.write("[]\n")
296
else:
297
file.write('[\n')
298
for elem in list:
299
file.write(' %s,\n' % repr(elem))
300
file.write(']\n')
301
302
186
def conf(args):
303
global root_dir, ivle_install_dir, jail_base, allowed_uids
304
187
# Set up some variables
305
188
306
189
cwd = os.getcwd()
309
192
conf_hfile = os.path.join(cwd, "trampoline/conf.h")
310
193
311
194
# Fixed config options that we don't ask the admin
195
312
196
default_app = "dummy"
313
197
314
# Get command-line arguments to avoid asking questions.
315
316
(opts, args) = getopt.gnu_getopt(args, "", ['root_dir=',
317
'ivle_install_dir=', 'jail_base=', 'allowed_uids='])
318
319
if args != []:
320
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
321
return 2
322
323
if opts == []:
324
# Interactive mode. Prompt the user for all the values.
325
326
print """This tool will create the following files:
198
print """This tool will create the following files:
327
199
%s
328
200
%s
329
201
prompting you for details about your configuration. The file will be
332
204
Please hit Ctrl+C now if you do not wish to do this.
333
205
""" % (conffile, conf_hfile)
334
206
335
# Get information from the administrator
336
# If EOF is encountered at any time during the questioning, just exit
337
# silently
338
339
root_dir = query_user(root_dir,
340
"""Root directory where IVLE is located (in URL space):""")
341
ivle_install_dir = query_user(ivle_install_dir,
342
'Root directory where IVLE will be installed (on the local file '
343
'system):')
344
jail_base = query_user(jail_base,
345
"""Root directory where the jails (containing user files) are stored
346
(on the local file system):""")
347
allowed_uids = query_user(allowed_uids,
348
"""UID of the web server process which will run IVLE.
349
Only this user may execute the trampoline. May specify multiple users as
350
a comma-separated list.
351
(eg. "1002,78")""")
352
353
else:
354
opts = dict(opts)
355
# Non-interactive mode. Parse the options.
356
if '--root_dir' in opts:
357
root_dir = opts['--root_dir']
358
if '--ivle_install_dir' in opts:
359
ivle_install_dir = opts['--ivle_install_dir']
360
if '--jail_base' in opts:
361
jail_base = opts['--jail_base']
362
if '--allowed_uids' in opts:
363
allowed_uids = opts['--allowed_uids']
364
365
# Error handling on input values
366
try:
367
allowed_uids = map(int, allowed_uids.split(','))
368
except ValueError:
369
print >>sys.stderr, (
370
"Invalid UID list (%s).\n"
371
"Must be a comma-separated list of integers." % allowed_uids)
372
return 1
207
# Get information from the administrator
208
# If EOF is encountered at any time during the questioning, just exit
209
# silently
210
211
root_dir = query_user(
212
"""Root directory where IVLE is located (in URL space):
213
(eg. "/" or "/ivle")""")
214
ivle_install_dir = query_user(
215
'Root directory where IVLE is located (on the local file system):\n'
216
'(eg. "/home/informatics/ivle")')
217
jail_base = query_user(
218
"""Root directory where user files are stored (on the local file system):
219
(eg. "/home/informatics/jails")""")
373
220
374
221
# Write www/conf/conf.py
375
222
401
248
# presented with the login screen.
402
249
default_app = "%s"
403
250
""" % (root_dir, ivle_install_dir, jail_base, default_app))
404
251
405
252
conf.close()
406
253
except IOError, (errno, strerror):
407
254
print "IO error(%s): %s" % (errno, strerror)
426
273
* jail_base or a subdirectory of jail_base.
427
274
*/
428
275
static const char* jail_base = "%s";
429
430
/* Which user IDs are allowed to run the trampoline.
431
* This list should be limited to the web server user.
432
* (Note that root is an implicit member of this list).
433
*/
434
static const int allowed_uids[] = { %s };
435
""" % (jail_base, repr(allowed_uids)[1:-1]))
276
""" % (jail_base))
436
277
437
278
conf.close()
438
279
except IOError, (errno, strerror):
449
290
return 0
450
291
451
292
def build(args):
452
# Get "dry" variable from command line
453
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
454
opts = dict(opts)
455
dry = '-n' in opts or '--dry' in opts
456
457
if dry:
458
print "Dry run (no actions will be executed\n"
459
460
# Compile the trampoline
461
action_runprog('gcc', ['-Wall', '-o', 'trampoline/trampoline',
462
'trampoline/trampoline.c'], dry)
463
464
# Create the jail and its subdirectories
465
# Note: Other subdirs will be made by copying files
466
action_mkdir('jail', dry)
467
action_mkdir('jail/home', dry)
468
action_mkdir('jail/tmp', dry)
469
470
# Copy all console and operating system files into the jail
471
action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
472
copy_os_files_jail(dry)
473
474
# Compile .py files into .pyc or .pyo files
475
compileall.compile_dir('www', quiet=True)
476
compileall.compile_dir('console', quiet=True)
477
478
return 0
479
480
def copy_os_files_jail(dry):
481
"""Copies necessary Operating System files from their usual locations
482
into the jail/ directory of the cwd."""
483
# Currently source paths are configured for Ubuntu.
484
copy_file_to_jail('/lib/ld-linux.so.2', dry)
485
copy_file_to_jail('/lib/tls/i686/cmov/libc.so.6', dry)
486
copy_file_to_jail('/lib/tls/i686/cmov/libdl.so.2', dry)
487
copy_file_to_jail('/lib/tls/i686/cmov/libm.so.6', dry)
488
copy_file_to_jail('/lib/tls/i686/cmov/libpthread.so.0', dry)
489
copy_file_to_jail('/lib/tls/i686/cmov/libutil.so.1', dry)
490
copy_file_to_jail('/usr/bin/python2.5', dry)
491
action_symlink('python2.5', 'jail/usr/bin/python', dry)
492
action_copytree('/usr/lib/python2.5', 'jail/usr/lib/python2.5', dry)
493
494
def copy_file_to_jail(src, dry):
495
"""Copies a single file from an absolute location into the same location
496
within the jail. src must begin with a '/'. The jail will be located
497
in a 'jail' subdirectory of the current path."""
498
action_copyfile(src, 'jail' + src, dry)
293
print "Build"
294
return 0
295
296
def listmake(args):
297
print "Listmake"
298
return 0
499
299
500
300
def install(args):
501
# Get "dry" and "nojail" variables from command line
502
(opts, args) = getopt.gnu_getopt(args, "n", ['dry', 'nojail'])
503
opts = dict(opts)
504
dry = '-n' in opts or '--dry' in opts
505
nojail = '--nojail' in opts
506
507
if dry:
508
print "Dry run (no actions will be executed\n"
509
510
if not dry and os.geteuid() != 0:
511
print >>sys.stderr, "Must be root to run install"
512
print >>sys.stderr, "(I need to chown some files)."
513
return 1
514
515
# Create the target (install) directory
516
action_mkdir(ivle_install_dir, dry)
517
518
# Create bin and copy the compiled files there
519
action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
520
tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
521
action_copyfile('trampoline/trampoline', tramppath, dry)
522
# chown trampoline to root and set setuid bit
523
action_chown_setuid(tramppath, dry)
524
525
# Copy the www directory using the list
526
action_copylist(install_list.list_www, ivle_install_dir, dry)
527
528
if not nojail:
529
# Copy the local jail directory built by the build action
530
# to the jails template directory (it will be used as a template
531
# for all the students' jails).
532
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
533
301
print "Install"
534
302
return 0
535
303
536
# The actions call Python os functions but print actions and handle dryness.
537
# May still throw os exceptions if errors occur.
538
539
class RunError:
540
"""Represents an error when running a program (nonzero return)."""
541
def __init__(self, prog, retcode):
542
self.prog = prog
543
self.retcode = retcode
544
def __str__(self):
545
return str(self.prog) + " returned " + repr(self.retcode)
546
547
def action_runprog(prog, args, dry):
548
"""Runs a unix program. Searches in $PATH. Synchronous (waits for the
549
program to return). Runs in the current environment. First prints the
550
action as a "bash" line.
551
552
Throws a RunError with a retcode of the return value of the program,
553
if the program did not return 0.
554
555
prog: String. Name of the program. (No path required, if in $PATH).
556
args: [String]. Arguments to the program.
557
dry: Bool. If True, prints but does not execute.
558
"""
559
print prog, string.join(args, ' ')
560
if dry: return
561
ret = os.spawnvp(os.P_WAIT, prog, args)
562
if ret != 0:
563
raise RunError(prog, ret)
564
565
def action_mkdir(path, dry):
566
"""Calls mkdir. Silently ignored if the directory already exists.
567
Creates all parent directories as necessary."""
568
print "mkdir -p", path
569
if dry: return
570
try:
571
os.makedirs(path)
572
except OSError, (err, msg):
573
if err != errno.EEXIST:
574
raise
575
576
def action_copytree(src, dst, dry):
577
"""Copies an entire directory tree. Symlinks are seen as normal files and
578
copies of the entire file (not the link) are made. Creates all parent
579
directories as necessary.
580
581
See shutil.copytree."""
582
if os.access(dst, os.F_OK):
583
print "rm -r", dst
584
if not dry:
585
shutil.rmtree(dst, True)
586
print "cp -r", src, dst
587
if dry: return
588
shutil.copytree(src, dst, True)
589
590
def action_copylist(srclist, dst, dry):
591
"""Copies all files in a list to a new location. The files in the list
592
are read relative to the current directory, and their destinations are the
593
same paths relative to dst. Creates all parent directories as necessary.
594
"""
595
for srcfile in srclist:
596
dstfile = os.path.join(dst, srcfile)
597
dstdir = os.path.split(dstfile)[0]
598
if not os.path.isdir(dstdir):
599
action_mkdir(dstdir, dry)
600
print "cp -f", srcfile, dstfile
601
if not dry:
602
try:
603
shutil.copyfile(srcfile, dstfile)
604
shutil.copymode(srcfile, dstfile)
605
except shutil.Error:
606
pass
607
608
def action_copyfile(src, dst, dry):
609
"""Copies one file to a new location. Creates all parent directories
610
as necessary.
611
"""
612
dstdir = os.path.split(dst)[0]
613
if not os.path.isdir(dstdir):
614
action_mkdir(dstdir, dry)
615
print "cp -f", src, dst
616
if not dry:
617
try:
618
shutil.copyfile(src, dst)
619
shutil.copymode(src, dst)
620
except shutil.Error:
621
pass
622
623
def action_symlink(src, dst, dry):
624
"""Creates a symlink in a given location. Creates all parent directories
625
as necessary.
626
"""
627
dstdir = os.path.split(dst)[0]
628
if not os.path.isdir(dstdir):
629
action_mkdir(dstdir, dry)
630
# Delete existing file
631
if os.path.exists(dst):
632
os.remove(dst)
633
print "ln -fs", src, dst
634
if not dry:
635
os.symlink(src, dst)
636
637
def action_chown_setuid(file, dry):
638
"""Chowns a file to root, and sets the setuid bit on the file.
639
Calling this function requires the euid to be root.
640
The actual mode of path is set to: rws--s--s
641
"""
642
print "chown root:root", file
643
if not dry:
644
os.chown(file, 0, 0)
645
print "chmod a+xs", file
646
print "chmod u+rw", file
647
if not dry:
648
os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
649
| stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
650
651
def query_user(default, prompt):
304
def query_user(prompt):
652
305
"""Prompts the user for a string, which is read from a line of stdin.
653
306
Exits silently if EOF is encountered. Returns the string, with spaces
654
307
removed from the beginning and end.
655
656
Returns default if a 0-length line (after spaces removed) was read.
657
308
"""
658
sys.stdout.write('%s\n (default: "%s")\n>' % (prompt, default))
309
sys.stdout.write(prompt)
310
sys.stdout.write("\n>")
659
311
try:
660
312
val = sys.stdin.readline()
661
313
except KeyboardInterrupt:
663
315
sys.stdout.write("\n")
664
316
sys.exit(1)
665
317
sys.stdout.write("\n")
666
# If EOF, exit
667
318
if val == '': sys.exit(1)
668
# If empty line, return default
669
val = val.strip()
670
if val == '': return default
671
return val
672
673
def filter_mutate(function, list):
674
"""Like built-in filter, but mutates the given list instead of returning a
675
new one. Returns None."""
676
i = len(list)-1
677
while i >= 0:
678
# Delete elements which do not match
679
if not function(list[i]):
680
del list[i]
681
i -= 1
319
return val.strip()
682
320
683
321
if __name__ == "__main__":
684
322
sys.exit(main())
Loggerhead is a web-based interface for Breezy
Version: 2.0.1