← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: mattgiuca
  • Date: 2008-01-25 03:53:12 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:308
util.js: Multipart/form-data output: Newlines are \r\n instead of \n.
    \n caused mod_python's handler to complain.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
28
34
# setup.py conf [args]
29
35
# Configures IVLE with machine-specific details, most notably, various paths.
30
36
# Either prompts the administrator for these details or accepts them as
42
48
#   (eg. python and Python libs, ld.so, etc).
43
49
# Generates .pyc files for all the IVLE .py files.
44
50
 
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
 
61
import stat
 
62
import shutil
63
63
import sys
64
64
import getopt
65
65
import string
66
66
import errno
 
67
import mimetypes
 
68
import compileall
 
69
import getopt
 
70
 
 
71
# Import modules from the website is tricky since they're in the www
 
72
# directory.
 
73
sys.path.append(os.path.join(os.getcwd(), 'www'))
 
74
import conf
 
75
import common.makeuser
 
76
 
 
77
# Operating system files to copy over into the jail.
 
78
# These will be copied from the given place on the OS file system into the
 
79
# same place within the jail.
 
80
JAIL_FILES = [
 
81
    '/lib/ld-linux.so.2',
 
82
    '/lib/tls/i686/cmov/libc.so.6',
 
83
    '/lib/tls/i686/cmov/libdl.so.2',
 
84
    '/lib/tls/i686/cmov/libm.so.6',
 
85
    '/lib/tls/i686/cmov/libpthread.so.0',
 
86
    '/lib/tls/i686/cmov/libutil.so.1',
 
87
    '/etc/ld.so.conf',
 
88
    '/etc/ld.so.cache',
 
89
    # These 2 files do not exist in Ubuntu
 
90
    #'/etc/ld.so.preload',
 
91
    #'/etc/ld.so.nohwcap',
 
92
    # UNIX commands
 
93
    '/usr/bin/strace',
 
94
    '/bin/ls',
 
95
    '/bin/echo',
 
96
    # Needed by python
 
97
    '/usr/bin/python2.5',
 
98
    # Needed by matplotlib
 
99
    '/usr/lib/i686/cmov/libssl.so.0.9.8',
 
100
    '/usr/lib/i686/cmov/libcrypto.so.0.9.8',
 
101
    '/lib/tls/i686/cmov/libnsl.so.1',
 
102
    '/usr/lib/libz.so.1',
 
103
    '/usr/lib/atlas/liblapack.so.3',
 
104
    '/usr/lib/atlas/libblas.so.3',
 
105
    '/usr/lib/libg2c.so.0',
 
106
    '/usr/lib/libstdc++.so.6',
 
107
    '/usr/lib/libfreetype.so.6',
 
108
    '/usr/lib/libpng12.so.0',
 
109
    '/usr/lib/libBLT.2.4.so.8.4',
 
110
    '/usr/lib/libtk8.4.so.0',
 
111
    '/usr/lib/libtcl8.4.so.0',
 
112
    '/usr/lib/tcl8.4/init.tcl',
 
113
    '/usr/lib/libX11.so.6',
 
114
    '/usr/lib/libXau.so.6',
 
115
    '/usr/lib/libXdmcp.so.6',
 
116
    '/lib/libgcc_s.so.1',
 
117
    '/etc/matplotlibrc',
 
118
]
 
119
# Symlinks to make within the jail. Src mapped to dst.
 
120
JAIL_LINKS = {
 
121
    'python2.5': 'jail/usr/bin/python',
 
122
}
 
123
# Trees to copy. Src mapped to dst (these will be passed to action_copytree).
 
124
JAIL_COPYTREES = {
 
125
    '/usr/lib/python2.5': 'jail/usr/lib/python2.5',
 
126
    '/usr/share/matplotlib': 'jail/usr/share/matplotlib',
 
127
    '/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
 
128
}
67
129
 
68
130
# Try importing existing conf, but if we can't just set up defaults
69
131
# The reason for this is that these settings are used by other phases
71
133
# Also this allows you to hit Return to accept the existing value.
72
134
try:
73
135
    confmodule = __import__("www/conf/conf")
74
 
    root_dir = confmodule.root_dir
75
 
    ivle_install_dir = confmodule.ivle_install_dir
76
 
    jail_base = confmodule.jail_base
 
136
    try:
 
137
        root_dir = confmodule.root_dir
 
138
    except:
 
139
        root_dir = "/ivle"
 
140
    try:
 
141
        ivle_install_dir = confmodule.ivle_install_dir
 
142
    except:
 
143
        ivle_install_dir = "/opt/ivle"
 
144
    try:
 
145
        public_host = confmodule.public_host
 
146
    except:
 
147
        public_host = "public.localhost"
 
148
    try:
 
149
        jail_base = confmodule.jail_base
 
150
    except:
 
151
        jail_base = "/home/informatics/jails"
 
152
    try:
 
153
        subjects_base = confmodule.subjects_base
 
154
    except:
 
155
        subjects_base = "/home/informatics/subjects"
77
156
except ImportError:
78
157
    # Just set reasonable defaults
79
158
    root_dir = "/ivle"
80
159
    ivle_install_dir = "/opt/ivle"
 
160
    public_host = "public.localhost"
81
161
    jail_base = "/home/informatics/jails"
 
162
    subjects_base = "/home/informatics/subjects"
82
163
# Always defaults
83
164
allowed_uids = "0"
84
165
 
 
166
# Try importing install_list, but don't fail if we can't, because listmake can
 
167
# function without it.
 
168
try:
 
169
    import install_list
 
170
except:
 
171
    pass
 
172
 
 
173
# Mime types which will automatically be placed in the list by listmake.
 
174
# Note that listmake is not intended to be run by the final user (the system
 
175
# administrator who installs this), so the developers can customize the list
 
176
# as necessary, and include it in the distribution.
 
177
listmake_mimetypes = ['text/x-python', 'text/html',
 
178
    'application/x-javascript', 'application/javascript',
 
179
    'text/css', 'image/png']
 
180
 
85
181
# Main function skeleton from Guido van Rossum
86
182
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
87
183
 
88
 
class Usage(Exception):
89
 
    def __init__(self, msg):
90
 
        self.msg = msg
91
 
 
92
184
def main(argv=None):
93
185
    if argv is None:
94
186
        argv = sys.argv
112
204
        help([])
113
205
        return 1
114
206
 
 
207
    # Disallow run as root unless installing
 
208
    if (operation != 'install' and operation != 'updatejails'
 
209
        and os.geteuid() == 0):
 
210
        print >>sys.stderr, "I do not want to run this stage as root."
 
211
        print >>sys.stderr, "Please run as a normal user."
 
212
        return 1
115
213
    # Call the requested operation's function
116
214
    try:
117
 
        return {
 
215
        oper_func = {
118
216
            'help' : help,
119
217
            'conf' : conf,
120
218
            'build' : build,
121
219
            'listmake' : listmake,
122
220
            'install' : install,
123
 
        }[operation](argv[2:])
 
221
            'updatejails' : updatejails,
 
222
        }[operation]
124
223
    except KeyError:
125
224
        print >>sys.stderr, (
126
225
            """Invalid operation '%s'. Try python setup.py help."""
127
226
            % operation)
128
 
 
129
 
    try:
130
 
        try:
131
 
            opts, args = getopt.getopt(argv[1:], "h", ["help"])
132
 
        except getopt.error, msg:
133
 
            raise Usage(msg)
134
 
        # more code, unchanged
135
 
    except Usage, err:
136
 
        print >>sys.stderr, err.msg
137
 
        print >>sys.stderr, "for help use --help"
138
 
        return 2
 
227
        return 1
 
228
    return oper_func(argv[2:])
139
229
 
140
230
# Operation functions
141
231
 
144
234
        print """Usage: python setup.py operation [args]
145
235
Operation (and args) can be:
146
236
    help [operation]
 
237
    listmake (developer use only)
147
238
    conf [args]
148
239
    build
149
240
    install [--nojail] [-n|--dry]
158
249
    if operation == 'help':
159
250
        print """python setup.py help [operation]
160
251
Prints the usage message or detailed help on an operation, then exits."""
 
252
    elif operation == 'listmake':
 
253
        print """python setup.py listmake
 
254
(For developer use only)
 
255
Recurses through the source tree and builds a list of all files which should
 
256
be copied upon installation. This should be run by the developer before
 
257
cutting a distribution, and the listfile it generates should be included in
 
258
the distribution, avoiding the administrator having to run it."""
161
259
    elif operation == 'conf':
162
260
        print """python setup.py conf [args]
163
261
Configures IVLE with machine-specific details, most notably, various paths.
164
262
Either prompts the administrator for these details or accepts them as
165
 
command-line args.
 
263
command-line args. Will be interactive only if there are no arguments given.
 
264
Takes defaults from existing conf file if it exists.
 
265
 
 
266
To run IVLE out of the source directory (allowing development without having
 
267
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
 
268
directory, and run build/install one time.
 
269
 
166
270
Creates www/conf/conf.py and trampoline/conf.h.
 
271
 
167
272
Args are:
 
273
    --root_dir
 
274
    --ivle_install_dir
 
275
    --public_host
 
276
    --jail_base
 
277
    --subjects_base
 
278
    --allowed_uids
 
279
As explained in the interactive prompt or conf.py.
168
280
"""
169
281
    elif operation == 'build':
170
 
        print """python setup.py build
 
282
        print """python -O setup.py build [--dry|-n]
171
283
Compiles all files and sets up a jail template in the source directory.
 
284
-O is recommended to cause compilation to be optimised.
172
285
Details:
173
286
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
174
287
Creates jail/.
176
289
Copies console/ to a location within the jail.
177
290
Copies OS programs and files to corresponding locations within the jail
178
291
  (eg. python and Python libs, ld.so, etc).
179
 
Generates .pyc files for all the IVLE .py files."""
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."""
 
292
Generates .pyc or .pyo files for all the IVLE .py files.
 
293
 
 
294
--dry | -n  Print out the actions but don't do anything."""
187
295
    elif operation == 'install':
188
296
        print """sudo python setup.py install [--nojail] [--dry|-n]
189
297
(Requires root)
196
304
 
197
305
--nojail    Do not copy the jail.
198
306
--dry | -n  Print out the actions but don't do anything."""
 
307
    elif operation == 'updatejails':
 
308
        print """sudo python setup.py updatejails [--dry|-n]
 
309
(Requires root)
 
310
Copy jail/ to each subdirectory in jails directory.
 
311
 
 
312
--dry | -n  Print out the actions but don't do anything."""
199
313
    else:
200
314
        print >>sys.stderr, (
201
315
            """Invalid operation '%s'. Try python setup.py help."""
210
324
    # (since listmake is typically run before conf)
211
325
    if "www/conf/conf.py" not in list_www:
212
326
        list_www.append("www/conf/conf.py")
 
327
    # Make sure that console/python-console is in the list
 
328
    if "console/python-console" not in list_console:
 
329
        list_console.append("console/python-console")
213
330
    # Write these out to a file
214
331
    cwd = os.getcwd()
215
332
    # the files that will be created/overwritten
220
337
 
221
338
        file.write("""# IVLE Configuration File
222
339
# install_list.py
223
 
# Provides lists of all Python files to be installed by `setup.py install'.
 
340
# Provides lists of all files to be installed by `setup.py install' from
 
341
# certain directories.
 
342
# Note that any files with the given filename plus 'c' or 'o' (that is,
 
343
# compiled .pyc or .pyo files) will be copied as well.
224
344
 
225
 
# List of all installable Python files in www directory.
 
345
# List of all installable files in www directory.
226
346
list_www = """)
227
347
        writelist_pretty(file, list_www)
228
348
        file.write("""
229
 
# List of all installable Python files in console directory.
 
349
# List of all installable files in console directory.
230
350
list_console = """)
231
351
        writelist_pretty(file, list_console)
232
352
 
254
374
        filter_mutate(lambda x: x[0] != '.', dirnames)
255
375
        # All *.py files are added to the list
256
376
        pylist += [os.path.join(dirpath, item) for item in filenames
257
 
            if item.endswith('.py')]
 
377
            if mimetypes.guess_type(item)[0] in listmake_mimetypes]
258
378
    return pylist
259
379
 
260
380
def writelist_pretty(file, list):
268
388
        file.write(']\n')
269
389
 
270
390
def conf(args):
271
 
    global root_dir, ivle_install_dir, jail_base, allowed_uids
 
391
    global root_dir, ivle_install_dir, jail_base, subjects_base
 
392
    global public_host, allowed_uids
272
393
    # Set up some variables
273
394
 
274
395
    cwd = os.getcwd()
276
397
    conffile = os.path.join(cwd, "www/conf/conf.py")
277
398
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
278
399
 
279
 
    # Fixed config options that we don't ask the admin
280
 
 
281
 
    default_app = "dummy"
282
 
 
283
 
    print """This tool will create the following files:
 
400
    # Get command-line arguments to avoid asking questions.
 
401
 
 
402
    (opts, args) = getopt.gnu_getopt(args, "", ['root_dir=',
 
403
                    'ivle_install_dir=', 'jail_base=', 'allowed_uids='])
 
404
 
 
405
    if args != []:
 
406
        print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
 
407
        return 2
 
408
 
 
409
    if opts == []:
 
410
        # Interactive mode. Prompt the user for all the values.
 
411
 
 
412
        print """This tool will create the following files:
284
413
    %s
285
414
    %s
286
415
prompting you for details about your configuration. The file will be
289
418
Please hit Ctrl+C now if you do not wish to do this.
290
419
""" % (conffile, conf_hfile)
291
420
 
292
 
    # Get information from the administrator
293
 
    # If EOF is encountered at any time during the questioning, just exit
294
 
    # silently
 
421
        # Get information from the administrator
 
422
        # If EOF is encountered at any time during the questioning, just exit
 
423
        # silently
295
424
 
296
 
    root_dir = query_user(root_dir,
297
 
    """Root directory where IVLE is located (in URL space):""")
298
 
    ivle_install_dir = query_user(ivle_install_dir,
299
 
    'Root directory where IVLE will be installed (on the local file '
300
 
    'system):')
301
 
    jail_base = query_user(jail_base,
302
 
    """Root directory where the jails (containing user files) are stored
 
425
        root_dir = query_user(root_dir,
 
426
        """Root directory where IVLE is located (in URL space):""")
 
427
        ivle_install_dir = query_user(ivle_install_dir,
 
428
        'Root directory where IVLE will be installed (on the local file '
 
429
        'system):')
 
430
        jail_base = query_user(jail_base,
 
431
        """Root directory where the jails (containing user files) are stored
303
432
(on the local file system):""")
304
 
    allowed_uids = query_user(allowed_uids,
305
 
    """UID of the web server process which will run IVLE.
 
433
        subjects_base = query_user(subjects_base,
 
434
        """Root directory where the subject directories (containing worksheets
 
435
and other per-subject files) are stored (on the local file system):""")
 
436
        public_host = query_user(public_host,
 
437
        """Hostname which will cause the server to go into "public mode",
 
438
providing login-free access to student's published work:""")
 
439
        allowed_uids = query_user(allowed_uids,
 
440
        """UID of the web server process which will run IVLE.
306
441
Only this user may execute the trampoline. May specify multiple users as
307
442
a comma-separated list.
308
443
    (eg. "1002,78")""")
309
444
 
 
445
    else:
 
446
        opts = dict(opts)
 
447
        # Non-interactive mode. Parse the options.
 
448
        if '--root_dir' in opts:
 
449
            root_dir = opts['--root_dir']
 
450
        if '--ivle_install_dir' in opts:
 
451
            ivle_install_dir = opts['--ivle_install_dir']
 
452
        if '--jail_base' in opts:
 
453
            jail_base = opts['--jail_base']
 
454
        if '--subjects_base' in opts:
 
455
            jail_base = opts['--subjects_base']
 
456
        if '--public_host' in opts:
 
457
            public_host = opts['--public_host']
 
458
        if '--allowed_uids' in opts:
 
459
            allowed_uids = opts['--allowed_uids']
 
460
 
310
461
    # Error handling on input values
311
 
 
312
462
    try:
313
463
        allowed_uids = map(int, allowed_uids.split(','))
314
464
    except ValueError:
336
486
# This directory should contain the "www" and "bin" directories.
337
487
ivle_install_dir = "%s"
338
488
 
 
489
# The server goes into "public mode" if the browser sends a request with this
 
490
# host. This is for security reasons - we only serve public student files on a
 
491
# separate domain to the main IVLE site.
 
492
# Public mode does not use cookies, and serves only public content.
 
493
# Private mode (normal mode) requires login, and only serves files relevant to
 
494
# the logged-in user.
 
495
public_host = "%s"
 
496
 
339
497
# In the local file system, where are the student/user file spaces located.
340
498
# The user jails are expected to be located immediately in subdirectories of
341
499
# this location.
342
500
jail_base = "%s"
343
501
 
344
 
# Which application to load by default (if the user navigates to the top level
345
 
# of the site). This is the app's URL name.
346
 
# Note that if this app requires authentication, the user will first be
347
 
# presented with the login screen.
348
 
default_app = "%s"
349
 
""" % (root_dir, ivle_install_dir, jail_base, default_app))
 
502
# In the local file system, where are the per-subject file spaces located.
 
503
# The individual subject directories are expected to be located immediately
 
504
# in subdirectories of this location.
 
505
subjects_base = "%s"
 
506
""" % (root_dir, ivle_install_dir, public_host, jail_base, subjects_base))
350
507
 
351
508
        conf.close()
352
509
    except IOError, (errno, strerror):
395
552
    return 0
396
553
 
397
554
def build(args):
398
 
    dry = False     # Set to True later if --dry
 
555
    # Get "dry" variable from command line
 
556
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
 
557
    opts = dict(opts)
 
558
    dry = '-n' in opts or '--dry' in opts
 
559
 
 
560
    if dry:
 
561
        print "Dry run (no actions will be executed\n"
399
562
 
400
563
    # Compile the trampoline
401
564
    action_runprog('gcc', ['-Wall', '-o', 'trampoline/trampoline',
402
565
        'trampoline/trampoline.c'], dry)
403
566
 
404
567
    # Create the jail and its subdirectories
405
 
    action_mkdir('jail')
406
 
    action_mkdir('jail/bin')
407
 
    action_mkdir('jail/lib')
408
 
    action_mkdir('jail/usr/bin')
409
 
    action_mkdir('jail/usr/lib')
410
 
    action_mkdir('jail/opt/ivle')
411
 
    action_mkdir('jail/home')
412
 
    action_mkdir('jail/tmp')
413
 
 
414
 
    # TODO: Copy console into the jail
415
 
    # TODO: Copy operating system files into the jail
416
 
    # TODO: Compile .py files into .pyc files
 
568
    # Note: Other subdirs will be made by copying files
 
569
    action_mkdir('jail', dry)
 
570
    action_mkdir('jail/home', dry)
 
571
    action_mkdir('jail/tmp', dry)
 
572
 
 
573
    # Copy all console and operating system files into the jail
 
574
    action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
 
575
    copy_os_files_jail(dry)
 
576
    # Chmod the python console
 
577
    action_chmod_x('jail/opt/ivle/console/python-console', dry)
 
578
    
 
579
 
 
580
    # Compile .py files into .pyc or .pyo files
 
581
    compileall.compile_dir('www', quiet=True)
 
582
    compileall.compile_dir('console', quiet=True)
417
583
 
418
584
    return 0
419
585
 
 
586
def copy_os_files_jail(dry):
 
587
    """Copies necessary Operating System files from their usual locations
 
588
    into the jail/ directory of the cwd."""
 
589
    # Currently source paths are configured for Ubuntu.
 
590
    for filename in JAIL_FILES:
 
591
        copy_file_to_jail(filename, dry)
 
592
    for src, dst in JAIL_LINKS.items():
 
593
        action_symlink(src, dst, dry)
 
594
    for src, dst in JAIL_COPYTREES.items():
 
595
        action_copytree(src, dst, dry)
 
596
 
 
597
def copy_file_to_jail(src, dry):
 
598
    """Copies a single file from an absolute location into the same location
 
599
    within the jail. src must begin with a '/'. The jail will be located
 
600
    in a 'jail' subdirectory of the current path."""
 
601
    action_copyfile(src, 'jail' + src, dry)
 
602
 
420
603
def install(args):
421
 
    print "Install"
 
604
    # Get "dry" and "nojail" variables from command line
 
605
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry', 'nojail'])
 
606
    opts = dict(opts)
 
607
    dry = '-n' in opts or '--dry' in opts
 
608
    nojail = '--nojail' in opts
 
609
 
 
610
    if dry:
 
611
        print "Dry run (no actions will be executed\n"
 
612
 
 
613
    if not dry and os.geteuid() != 0:
 
614
        print >>sys.stderr, "Must be root to run install"
 
615
        print >>sys.stderr, "(I need to chown some files)."
 
616
        return 1
 
617
 
 
618
    # Create the target (install) directory
 
619
    action_mkdir(ivle_install_dir, dry)
 
620
 
 
621
    # Create bin and copy the compiled files there
 
622
    action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
 
623
    tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
 
624
    action_copyfile('trampoline/trampoline', tramppath, dry)
 
625
    # chown trampoline to root and set setuid bit
 
626
    action_chown_setuid(tramppath, dry)
 
627
 
 
628
    # Copy the www directory using the list
 
629
    action_copylist(install_list.list_www, ivle_install_dir, dry)
 
630
 
 
631
    if not nojail:
 
632
        # Copy the local jail directory built by the build action
 
633
        # to the jails template directory (it will be used as a template
 
634
        # for all the students' jails).
 
635
        action_copytree('jail', os.path.join(jail_base, 'template'), dry)
 
636
 
 
637
    # Append IVLE path to ivle.pth in python site packages
 
638
    # (Unless it's already there)
 
639
    ivle_pth = os.path.join(sys.prefix,
 
640
        "lib/python2.5/site-packages/ivle.pth")
 
641
    ivle_www = os.path.join(ivle_install_dir, "www")
 
642
    write_ivle_pth = True
 
643
    try:
 
644
        file = open(ivle_pth, 'r')
 
645
        for line in file:
 
646
            if line.strip() == ivle_www:
 
647
                write_ivle_pth = False
 
648
                break
 
649
    except (IOError, OSError):
 
650
        pass
 
651
    if write_ivle_pth:
 
652
        action_append(ivle_pth, ivle_www)
 
653
 
 
654
    return 0
 
655
 
 
656
def updatejails(args):
 
657
    # Get "dry" variable from command line
 
658
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
 
659
    opts = dict(opts)
 
660
    dry = '-n' in opts or '--dry' in opts
 
661
 
 
662
    if dry:
 
663
        print "Dry run (no actions will be executed\n"
 
664
 
 
665
    if not dry and os.geteuid() != 0:
 
666
        print >>sys.stderr, "Must be root to run install"
 
667
        print >>sys.stderr, "(I need to chown some files)."
 
668
        return 1
 
669
 
 
670
    # Update the template jail directory in case it hasn't been installed
 
671
    # recently.
 
672
    action_copytree('jail', os.path.join(jail_base, 'template'), dry)
 
673
 
 
674
    # Re-link all the files in all students jails.
 
675
    for dir in os.listdir(jail_base):
 
676
        if dir == 'template': continue
 
677
        # First back up the student's home directory
 
678
        temp_home = os.tmpnam()
 
679
        action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
 
680
        # Delete the student's jail and relink the jail files
 
681
        action_linktree(os.path.join(jail_base, 'template'),
 
682
            os.path.join(jail_base, dir), dry)
 
683
        # Restore the student's home directory
 
684
        action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
 
685
        # Set up the user's home directory just in case they don't have a
 
686
        # directory for this yet
 
687
        action_mkdir(os.path.join(jail_base, dir, 'home', dir), dry)
 
688
 
422
689
    return 0
423
690
 
424
691
# The actions call Python os functions but print actions and handle dryness.
450
717
    if ret != 0:
451
718
        raise RunError(prog, ret)
452
719
 
453
 
def action_mkdir(path):
 
720
def action_rename(src, dst, dry):
 
721
    """Calls rename. Deletes the target if it already exists."""
 
722
    if os.access(dst, os.F_OK):
 
723
        print "rm -r", dst
 
724
        if not dry:
 
725
            shutil.rmtree(dst, True)
 
726
    print "mv ", src, dst
 
727
    if dry: return
 
728
    try:
 
729
        os.rename(src, dst)
 
730
    except OSError, (err, msg):
 
731
        if err != errno.EEXIST:
 
732
            raise
 
733
 
 
734
def action_mkdir(path, dry):
454
735
    """Calls mkdir. Silently ignored if the directory already exists.
455
736
    Creates all parent directories as necessary."""
456
737
    print "mkdir -p", path
461
742
        if err != errno.EEXIST:
462
743
            raise
463
744
 
 
745
def action_copytree(src, dst, dry):
 
746
    """Copies an entire directory tree. Symlinks are seen as normal files and
 
747
    copies of the entire file (not the link) are made. Creates all parent
 
748
    directories as necessary.
 
749
 
 
750
    See shutil.copytree."""
 
751
    if os.access(dst, os.F_OK):
 
752
        print "rm -r", dst
 
753
        if not dry:
 
754
            shutil.rmtree(dst, True)
 
755
    print "cp -r", src, dst
 
756
    if dry: return
 
757
    shutil.copytree(src, dst, True)
 
758
 
 
759
def action_linktree(src, dst, dry):
 
760
    """Hard-links an entire directory tree. Same as copytree but the created
 
761
    files are hard-links not actual copies. Removes the existing destination.
 
762
    """
 
763
    if os.access(dst, os.F_OK):
 
764
        print "rm -r", dst
 
765
        if not dry:
 
766
            shutil.rmtree(dst, True)
 
767
    print "<cp with hardlinks> -r", src, dst
 
768
    if dry: return
 
769
    common.makeuser.linktree(src, dst)
 
770
 
 
771
def action_copylist(srclist, dst, dry):
 
772
    """Copies all files in a list to a new location. The files in the list
 
773
    are read relative to the current directory, and their destinations are the
 
774
    same paths relative to dst. Creates all parent directories as necessary.
 
775
    """
 
776
    for srcfile in srclist:
 
777
        dstfile = os.path.join(dst, srcfile)
 
778
        dstdir = os.path.split(dstfile)[0]
 
779
        if not os.path.isdir(dstdir):
 
780
            action_mkdir(dstdir, dry)
 
781
        print "cp -f", srcfile, dstfile
 
782
        if not dry:
 
783
            try:
 
784
                shutil.copyfile(srcfile, dstfile)
 
785
                shutil.copymode(srcfile, dstfile)
 
786
            except shutil.Error:
 
787
                pass
 
788
 
 
789
def action_copyfile(src, dst, dry):
 
790
    """Copies one file to a new location. Creates all parent directories
 
791
    as necessary.
 
792
    """
 
793
    dstdir = os.path.split(dst)[0]
 
794
    if not os.path.isdir(dstdir):
 
795
        action_mkdir(dstdir, dry)
 
796
    print "cp -f", src, dst
 
797
    if not dry:
 
798
        try:
 
799
            shutil.copyfile(src, dst)
 
800
            shutil.copymode(src, dst)
 
801
        except shutil.Error:
 
802
            pass
 
803
 
 
804
def action_symlink(src, dst, dry):
 
805
    """Creates a symlink in a given location. Creates all parent directories
 
806
    as necessary.
 
807
    """
 
808
    dstdir = os.path.split(dst)[0]
 
809
    if not os.path.isdir(dstdir):
 
810
        action_mkdir(dstdir, dry)
 
811
    # Delete existing file
 
812
    if os.path.exists(dst):
 
813
        os.remove(dst)
 
814
    print "ln -fs", src, dst
 
815
    if not dry:
 
816
        os.symlink(src, dst)
 
817
 
 
818
def action_append(ivle_pth, ivle_www):
 
819
    file = open(ivle_pth, 'a+')
 
820
    file.write(ivle_www + '\n')
 
821
    file.close()
 
822
 
 
823
def action_chown_setuid(file, dry):
 
824
    """Chowns a file to root, and sets the setuid bit on the file.
 
825
    Calling this function requires the euid to be root.
 
826
    The actual mode of path is set to: rws--s--s
 
827
    """
 
828
    print "chown root:root", file
 
829
    if not dry:
 
830
        os.chown(file, 0, 0)
 
831
    print "chmod a+xs", file
 
832
    print "chmod u+rw", file
 
833
    if not dry:
 
834
        os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
 
835
            | stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
 
836
 
 
837
def action_chmod_x(file, dry):
 
838
    """Chmod +xs a file (sets execute permission)."""
 
839
    print "chmod u+rwx", file
 
840
    if not dry:
 
841
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR)
 
842
 
464
843
def query_user(default, prompt):
465
844
    """Prompts the user for a string, which is read from a line of stdin.
466
845
    Exits silently if EOF is encountered. Returns the string, with spaces