« back to all changes in this revision
Viewing changes to setup.py
- browse files at revision 105
- compare with another revision
- download diff
- download tarball
- view history from revision 105
- Committer: mattgiuca
- Date: 2007-12-20 22:41:14 UTC
- Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:105
Removed all use of ivlepath variable. It is no longer set.
Instead, use ivle_install_dir which is taken from the admin-setup
configuration file.
Instead, use ivle_install_dir which is taken from the admin-setup
configuration file.
- files added:
- www/common/jail.py
- files removed:
- console/console.js
- 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
62
60
import os
63
import stat
64
import shutil
65
61
import sys
66
62
import getopt
67
import string
68
import errno
69
import mimetypes
70
import compileall
71
72
# Try importing existing conf, but if we can't just set up defaults
73
# The reason for this is that these settings are used by other phases
74
# of setup besides conf, so we need to know them.
75
# Also this allows you to hit Return to accept the existing value.
76
try:
77
confmodule = __import__("www/conf/conf")
78
root_dir = confmodule.root_dir
79
ivle_install_dir = confmodule.ivle_install_dir
80
jail_base = confmodule.jail_base
81
except ImportError:
82
# Just set reasonable defaults
83
root_dir = "/ivle"
84
ivle_install_dir = "/opt/ivle"
85
jail_base = "/home/informatics/jails"
86
# Always defaults
87
allowed_uids = "0"
88
89
# Try importing install_list, but don't fail if we can't, because listmake can
90
# function without it.
91
try:
92
import install_list
93
except:
94
pass
95
96
# Mime types which will automatically be placed in the list by listmake.
97
# Note that listmake is not intended to be run by the final user (the system
98
# administrator who installs this), so the developers can customize the list
99
# as necessary, and include it in the distribution.
100
listmake_mimetypes = ['text/x-python', 'text/html',
101
'application/x-javascript', 'application/javascript',
102
'text/css', 'image/png']
103
63
104
64
# Main function skeleton from Guido van Rossum
105
65
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
177
137
if operation == 'help':
178
138
print """python setup.py help [operation]
179
139
Prints the usage message or detailed help on an operation, then exits."""
180
elif operation == 'listmake':
181
print """python setup.py listmake
182
(For developer use only)
183
Recurses through the source tree and builds a list of all files which should
184
be copied upon installation. This should be run by the developer before
185
cutting a distribution, and the listfile it generates should be included in
186
the distribution, avoiding the administrator having to run it."""
187
140
elif operation == 'conf':
188
141
print """python setup.py conf [args]
189
142
Configures IVLE with machine-specific details, most notably, various paths.
193
146
Args are:
194
147
"""
195
148
elif operation == 'build':
196
print """python -O setup.py build [--dry|-n]
149
print """python setup.py build
197
150
Compiles all files and sets up a jail template in the source directory.
198
-O is recommended to cause compilation to be optimised.
199
151
Details:
200
152
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
201
153
Creates jail/.
203
155
Copies console/ to a location within the jail.
204
156
Copies OS programs and files to corresponding locations within the jail
205
157
(eg. python and Python libs, ld.so, etc).
206
Generates .pyc or .pyo files for all the IVLE .py files.
207
208
--dry | -n Print out the actions but don't do anything."""
158
Generates .pyc files for all the IVLE .py files."""
159
elif operation == 'listmake':
160
print """python setup.py listmake
161
(For developer use only)
162
Recurses through the source tree and builds a list of all files which should
163
be copied upon installation. This should be run by the developer before
164
cutting a distribution, and the listfile it generates should be included in
165
the distribution, avoiding the administrator having to run it."""
209
166
elif operation == 'install':
210
167
print """sudo python setup.py install [--nojail] [--dry|-n]
211
168
(Requires root)
224
181
% operation)
225
182
return 1
226
183
227
def listmake(args):
228
# We build two separate lists, by walking www and console
229
list_www = build_list_py_files('www')
230
list_console = build_list_py_files('console')
231
# Make sure that the files generated by conf are in the list
232
# (since listmake is typically run before conf)
233
if "www/conf/conf.py" not in list_www:
234
list_www.append("www/conf/conf.py")
235
# Make sure that console/python-console is in the list
236
if "console/python-console" not in list_console:
237
list_console.append("console/python-console")
238
# Write these out to a file
239
cwd = os.getcwd()
240
# the files that will be created/overwritten
241
listfile = os.path.join(cwd, "install_list.py")
242
243
try:
244
file = open(listfile, "w")
245
246
file.write("""# IVLE Configuration File
247
# install_list.py
248
# Provides lists of all files to be installed by `setup.py install' from
249
# certain directories.
250
# Note that any files with the given filename plus 'c' or 'o' (that is,
251
# compiled .pyc or .pyo files) will be copied as well.
252
253
# List of all installable files in www directory.
254
list_www = """)
255
writelist_pretty(file, list_www)
256
file.write("""
257
# List of all installable files in console directory.
258
list_console = """)
259
writelist_pretty(file, list_console)
260
261
file.close()
262
except IOError, (errno, strerror):
263
print "IO error(%s): %s" % (errno, strerror)
264
sys.exit(1)
265
266
print "Successfully wrote install_list.py"
267
268
print
269
print ("You may modify the set of installable files before cutting the "
270
"distribution:")
271
print listfile
272
print
273
274
return 0
275
276
def build_list_py_files(dir):
277
"""Builds a list of all py files found in a directory and its
278
subdirectories. Returns this as a list of strings."""
279
pylist = []
280
for (dirpath, dirnames, filenames) in os.walk(dir):
281
# Exclude directories beginning with a '.' (such as '.svn')
282
filter_mutate(lambda x: x[0] != '.', dirnames)
283
# All *.py files are added to the list
284
pylist += [os.path.join(dirpath, item) for item in filenames
285
if mimetypes.guess_type(item)[0] in listmake_mimetypes]
286
return pylist
287
288
def writelist_pretty(file, list):
289
"""Writes a list one element per line, to a file."""
290
if list == []:
291
file.write("[]\n")
292
else:
293
file.write('[\n')
294
for elem in list:
295
file.write(' %s,\n' % repr(elem))
296
file.write(']\n')
297
298
184
def conf(args):
299
global root_dir, ivle_install_dir, jail_base, allowed_uids
300
185
# Set up some variables
301
186
302
187
cwd = os.getcwd()
321
206
# If EOF is encountered at any time during the questioning, just exit
322
207
# silently
323
208
324
root_dir = query_user(root_dir,
325
"""Root directory where IVLE is located (in URL space):""")
326
ivle_install_dir = query_user(ivle_install_dir,
327
'Root directory where IVLE will be installed (on the local file '
328
'system):')
329
jail_base = query_user(jail_base,
330
"""Root directory where the jails (containing user files) are stored
331
(on the local file system):""")
332
allowed_uids = query_user(allowed_uids,
333
"""UID of the web server process which will run IVLE.
334
Only this user may execute the trampoline. May specify multiple users as
335
a comma-separated list.
336
(eg. "1002,78")""")
337
338
# Error handling on input values
339
340
try:
341
allowed_uids = map(int, allowed_uids.split(','))
342
except ValueError:
343
print >>sys.stderr, (
344
"Invalid UID list (%s).\n"
345
"Must be a comma-separated list of integers." % allowed_uids)
346
return 1
209
root_dir = query_user(
210
"""Root directory where IVLE is located (in URL space):
211
(eg. "/" or "/ivle")""")
212
ivle_install_dir = query_user(
213
'Root directory where IVLE is located (on the local file system):\n'
214
'(eg. "/home/informatics/ivle")')
215
student_dir = query_user(
216
"""Root directory where user files are stored (on the local file system):
217
(eg. "/home/informatics/jails")""")
347
218
348
219
# Write www/conf/conf.py
349
220
367
238
# In the local file system, where are the student/user file spaces located.
368
239
# The user jails are expected to be located immediately in subdirectories of
369
240
# this location.
370
jail_base = "%s"
241
student_dir = "%s"
371
242
372
243
# Which application to load by default (if the user navigates to the top level
373
244
# of the site). This is the app's URL name.
374
245
# Note that if this app requires authentication, the user will first be
375
246
# presented with the login screen.
376
247
default_app = "%s"
377
""" % (root_dir, ivle_install_dir, jail_base, default_app))
378
248
""" % (root_dir, ivle_install_dir, student_dir, default_app))
249
379
250
conf.close()
380
251
except IOError, (errno, strerror):
381
252
print "IO error(%s): %s" % (errno, strerror)
400
271
* jail_base or a subdirectory of jail_base.
401
272
*/
402
273
static const char* jail_base = "%s";
403
404
/* Which user IDs are allowed to run the trampoline.
405
* This list should be limited to the web server user.
406
* (Note that root is an implicit member of this list).
407
*/
408
static const int allowed_uids[] = { %s };
409
""" % (jail_base, repr(allowed_uids)[1:-1]))
274
""" % (student_dir))
410
275
411
276
conf.close()
412
277
except IOError, (errno, strerror):
423
288
return 0
424
289
425
290
def build(args):
426
dry = False # Set to True later if --dry
427
428
# Compile the trampoline
429
action_runprog('gcc', ['-Wall', '-o', 'trampoline/trampoline',
430
'trampoline/trampoline.c'], dry)
431
432
# Create the jail and its subdirectories
433
action_mkdir('jail', dry)
434
action_mkdir('jail/bin', dry)
435
action_mkdir('jail/lib', dry)
436
action_mkdir('jail/usr/bin', dry)
437
action_mkdir('jail/usr/lib', dry)
438
action_mkdir('jail/opt/ivle', dry)
439
action_mkdir('jail/home', dry)
440
action_mkdir('jail/tmp', dry)
441
442
# Copy all console files into the jail
443
action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
444
445
# TODO: Copy operating system files into the jail
446
447
# Compile .py files into .pyc or .pyo files
448
compileall.compile_dir('www', quiet=True)
449
compileall.compile_dir('console', quiet=True)
450
291
print "Build"
292
return 0
293
294
def listmake(args):
295
print "Listmake"
451
296
return 0
452
297
453
298
def install(args):
454
# Create the target directory
455
nojail = False # Set to True later if --nojail
456
dry = False # Set to True later if --dry
457
458
if not dry and os.geteuid() != 0:
459
print >>sys.stderr, "Must be root to run install"
460
print >>sys.stderr, "(I need to chown some files)."
461
return 1
462
463
# Create the target (install) directory
464
action_mkdir(ivle_install_dir, dry)
465
466
# Create bin and copy the compiled files there
467
action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
468
tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
469
action_copyfile('trampoline/trampoline', tramppath, dry)
470
# chown trampoline to root and set setuid bit
471
action_chown_setuid(tramppath, dry)
472
473
# Copy the www directory using the list
474
action_copylist(install_list.list_www, ivle_install_dir, dry)
475
476
if not nojail:
477
# Copy the local jail directory built by the build action
478
# to the jails template directory (it will be used as a template
479
# for all the students' jails).
480
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
481
299
print "Install"
482
300
return 0
483
301
484
# The actions call Python os functions but print actions and handle dryness.
485
# May still throw os exceptions if errors occur.
486
487
class RunError:
488
"""Represents an error when running a program (nonzero return)."""
489
def __init__(self, prog, retcode):
490
self.prog = prog
491
self.retcode = retcode
492
def __str__(self):
493
return str(self.prog) + " returned " + repr(self.retcode)
494
495
def action_runprog(prog, args, dry):
496
"""Runs a unix program. Searches in $PATH. Synchronous (waits for the
497
program to return). Runs in the current environment. First prints the
498
action as a "bash" line.
499
500
Throws a RunError with a retcode of the return value of the program,
501
if the program did not return 0.
502
503
prog: String. Name of the program. (No path required, if in $PATH).
504
args: [String]. Arguments to the program.
505
dry: Bool. If True, prints but does not execute.
506
"""
507
print prog, string.join(args, ' ')
508
if dry: return
509
ret = os.spawnvp(os.P_WAIT, prog, args)
510
if ret != 0:
511
raise RunError(prog, ret)
512
513
def action_mkdir(path, dry):
514
"""Calls mkdir. Silently ignored if the directory already exists.
515
Creates all parent directories as necessary."""
516
print "mkdir -p", path
517
if dry: return
518
try:
519
os.makedirs(path)
520
except OSError, (err, msg):
521
if err != errno.EEXIST:
522
raise
523
524
def action_copytree(src, dst, dry):
525
"""Copies an entire directory tree. Symlinks are seen as normal files and
526
copies of the entire file (not the link) are made. Creates all parent
527
directories as necessary.
528
529
See shutil.copytree."""
530
if os.access(dst, os.F_OK):
531
print "rm -r", dst
532
if not dry:
533
shutil.rmtree(dst, True)
534
print "cp -r", src, dst
535
if dry: return
536
shutil.copytree(src, dst)
537
538
def action_copylist(srclist, dst, dry):
539
"""Copies all files in a list to a new location. The files in the list
540
are read relative to the current directory, and their destinations are the
541
same paths relative to dst. Creates all parent directories as necessary.
542
"""
543
for srcfile in srclist:
544
dstfile = os.path.join(dst, srcfile)
545
dstdir = os.path.split(dstfile)[0]
546
if not os.path.isdir(dstdir):
547
action_mkdir(dstdir, dry)
548
print "cp -f", srcfile, dstfile
549
if not dry:
550
shutil.copyfile(srcfile, dstfile)
551
552
def action_copyfile(src, dst, dry):
553
"""Copies one file to a new location. Creates all parent directories
554
as necessary.
555
"""
556
dstdir = os.path.split(dst)[0]
557
if not os.path.isdir(dstdir):
558
action_mkdir(dstdir, dry)
559
print "cp -f", src, dst
560
if not dry:
561
shutil.copyfile(src, dst)
562
563
def action_chown_setuid(file, dry):
564
"""Chowns a file to root, and sets the setuid bit on the file.
565
Calling this function requires the euid to be root.
566
The actual mode of path is set to: rws--s--s
567
"""
568
print "chown root:root", file
569
if not dry:
570
os.chown(file, 0, 0)
571
print "chmod a+xs", file
572
print "chmod u+rw", file
573
if not dry:
574
os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
575
| stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
576
577
def query_user(default, prompt):
302
def query_user(prompt):
578
303
"""Prompts the user for a string, which is read from a line of stdin.
579
304
Exits silently if EOF is encountered. Returns the string, with spaces
580
305
removed from the beginning and end.
581
582
Returns default if a 0-length line (after spaces removed) was read.
583
306
"""
584
sys.stdout.write('%s\n (default: "%s")\n>' % (prompt, default))
307
sys.stdout.write(prompt)
308
sys.stdout.write("\n>")
585
309
try:
586
310
val = sys.stdin.readline()
587
311
except KeyboardInterrupt:
589
313
sys.stdout.write("\n")
590
314
sys.exit(1)
591
315
sys.stdout.write("\n")
592
# If EOF, exit
593
316
if val == '': sys.exit(1)
594
# If empty line, return default
595
val = val.strip()
596
if val == '': return default
597
return val
598
599
def filter_mutate(function, list):
600
"""Like built-in filter, but mutates the given list instead of returning a
601
new one. Returns None."""
602
i = len(list)-1
603
while i >= 0:
604
# Delete elements which do not match
605
if not function(list[i]):
606
del list[i]
607
i -= 1
317
return val.strip()
608
318
609
319
if __name__ == "__main__":
610
320
sys.exit(main())
Loggerhead is a web-based interface for Breezy
Version: 2.0.1