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

97 by mattgiuca
Moved template.py and setup.py to better places.
1
#!/usr/bin/env python
2
# IVLE - Informatics Virtual Learning Environment
3
# Copyright (C) 2007-2008 The University of Melbourne
4
#
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
9
#
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
# GNU General Public License for more details.
14
#
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
19
# Module: setup
20
# Author: Matt Giuca
21
# Date:   12/12/2007
22
23
# This is a command-line application, for use by the administrator.
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
24
# This program configures, builds and installs IVLE in three separate steps.
25
# It is called with at least one argument, which specifies which operation to
26
# take.
27
118 by mattgiuca
setup.py: Added copytree and copylist actions.
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
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
34
# setup.py conf [args]
35
# Configures IVLE with machine-specific details, most notably, various paths.
36
# Either prompts the administrator for these details or accepts them as
37
# command-line args.
38
# Creates www/conf/conf.py and trampoline/conf.h.
39
40
# setup.py build
41
# Compiles all files and sets up a jail template in the source directory.
42
# Details:
43
# Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
44
# Creates jail/.
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.
50
51
# setup.py install [--nojail] [--dry|n]
52
# (Requires root)
53
# Create target install directory ($target).
54
# Create $target/bin.
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).
97 by mattgiuca
Moved template.py and setup.py to better places.
59
60
import os
119 by mattgiuca
setup.py: Added install action. Completely works!
61
import stat
118 by mattgiuca
setup.py: Added copytree and copylist actions.
62
import shutil
97 by mattgiuca
Moved template.py and setup.py to better places.
63
import sys
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
64
import getopt
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
65
import string
66
import errno
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
67
import mimetypes
116 by mattgiuca
setup.py: mkdir now properly obeys "dry".
68
import compileall
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
69
import getopt
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
70
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
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
251 by mattgiuca
setup.py: Worked the "files to copy into jail" out into a separate list
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',
253 by mattgiuca
setup.py: chmods python-console when building.
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
251 by mattgiuca
setup.py: Worked the "files to copy into jail" out into a separate list
97
    '/usr/bin/python2.5',
253 by mattgiuca
setup.py: chmods python-console when building.
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',
251 by mattgiuca
setup.py: Worked the "files to copy into jail" out into a separate list
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',
253 by mattgiuca
setup.py: chmods python-console when building.
126
    '/usr/share/matplotlib': 'jail/usr/share/matplotlib',
127
    '/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
251 by mattgiuca
setup.py: Worked the "files to copy into jail" out into a separate list
128
}
129
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
130
# Try importing existing conf, but if we can't just set up defaults
131
# The reason for this is that these settings are used by other phases
132
# of setup besides conf, so we need to know them.
133
# Also this allows you to hit Return to accept the existing value.
134
try:
135
    confmodule = __import__("www/conf/conf")
195 by mattgiuca
Configuration: Moved "default_app" setting from conf/conf.py to conf/apps.py.
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:
259 by mattgiuca
setup.py: Added a new config variable "public_host", which lets the admin set
145
        public_host = confmodule.public_host
146
    except:
147
        public_host = "public.localhost"
148
    try:
195 by mattgiuca
Configuration: Moved "default_app" setting from conf/conf.py to conf/apps.py.
149
        jail_base = confmodule.jail_base
150
    except:
151
        jail_base = "/home/informatics/jails"
287 by mattgiuca
setup.py: Added new conf.py variable: subjects_base. This is for storing the
152
    try:
153
        subjects_base = confmodule.subjects_base
154
    except:
155
        subjects_base = "/home/informatics/subjects"
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
156
except ImportError:
157
    # Just set reasonable defaults
158
    root_dir = "/ivle"
159
    ivle_install_dir = "/opt/ivle"
259 by mattgiuca
setup.py: Added a new config variable "public_host", which lets the admin set
160
    public_host = "public.localhost"
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
161
    jail_base = "/home/informatics/jails"
287 by mattgiuca
setup.py: Added new conf.py variable: subjects_base. This is for storing the
162
    subjects_base = "/home/informatics/subjects"
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
163
# Always defaults
164
allowed_uids = "0"
165
118 by mattgiuca
setup.py: Added copytree and copylist actions.
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
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
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
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
181
# Main function skeleton from Guido van Rossum
182
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
183
184
def main(argv=None):
185
    if argv is None:
186
        argv = sys.argv
187
188
    # Print the opening spiel including the GPL notice
189
190
    print """IVLE - Informatics Virtual Learning Environment Setup
97 by mattgiuca
Moved template.py and setup.py to better places.
191
Copyright (C) 2007-2008 The University of Melbourne
192
IVLE comes with ABSOLUTELY NO WARRANTY.
193
This is free software, and you are welcome to redistribute it
194
under certain conditions. See LICENSE.txt for details.
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
195
196
IVLE Setup
197
"""
198
199
    # First argument is the name of the setup operation
200
    try:
201
        operation = argv[1]
202
    except IndexError:
203
        # Print usage message and exit
204
        help([])
205
        return 1
206
131 by mattgiuca
setup.py:
207
    # Disallow run as root unless installing
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
208
    if (operation != 'install' and operation != 'updatejails'
209
        and os.geteuid() == 0):
131 by mattgiuca
setup.py:
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
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
213
    # Call the requested operation's function
214
    try:
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
215
        oper_func = {
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
216
            'help' : help,
217
            'conf' : conf,
218
            'build' : build,
219
            'listmake' : listmake,
220
            'install' : install,
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
221
            'updatejails' : updatejails,
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
222
        }[operation]
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
223
    except KeyError:
224
        print >>sys.stderr, (
225
            """Invalid operation '%s'. Try python setup.py help."""
226
            % operation)
129 by mattgiuca
setup.py: Minor fix, exits cleanly if arguments are invalid.
227
        return 1
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
228
    return oper_func(argv[2:])
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
229
230
# Operation functions
231
232
def help(args):
233
    if args == []:
234
        print """Usage: python setup.py operation [args]
235
Operation (and args) can be:
236
    help [operation]
131 by mattgiuca
setup.py:
237
    listmake (developer use only)
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
238
    conf [args]
239
    build
240
    install [--nojail] [-n|--dry]
241
"""
242
        return 1
243
    elif len(args) != 1:
244
        print """Usage: python setup.py help [operation]"""
245
        return 2
246
    else:
247
        operation = args[0]
248
249
    if operation == 'help':
250
        print """python setup.py help [operation]
251
Prints the usage message or detailed help on an operation, then exits."""
118 by mattgiuca
setup.py: Added copytree and copylist actions.
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."""
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
259
    elif operation == 'conf':
260
        print """python setup.py conf [args]
261
Configures IVLE with machine-specific details, most notably, various paths.
262
Either prompts the administrator for these details or accepts them as
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
263
command-line args. Will be interactive only if there are no arguments given.
264
Takes defaults from existing conf file if it exists.
133 by mattgiuca
setup.py: Now allows IVLE to be installed over itself, in order to allow
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
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
270
Creates www/conf/conf.py and trampoline/conf.h.
133 by mattgiuca
setup.py: Now allows IVLE to be installed over itself, in order to allow
271
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
272
Args are:
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
273
    --root_dir
274
    --ivle_install_dir
259 by mattgiuca
setup.py: Added a new config variable "public_host", which lets the admin set
275
    --public_host
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
276
    --jail_base
287 by mattgiuca
setup.py: Added new conf.py variable: subjects_base. This is for storing the
277
    --subjects_base
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
278
    --allowed_uids
279
As explained in the interactive prompt or conf.py.
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
280
"""
281
    elif operation == 'build':
118 by mattgiuca
setup.py: Added copytree and copylist actions.
282
        print """python -O setup.py build [--dry|-n]
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
283
Compiles all files and sets up a jail template in the source directory.
116 by mattgiuca
setup.py: mkdir now properly obeys "dry".
284
-O is recommended to cause compilation to be optimised.
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
285
Details:
286
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
287
Creates jail/.
288
Creates standard subdirs inside the jail, eg bin, opt, home, tmp.
289
Copies console/ to a location within the jail.
290
Copies OS programs and files to corresponding locations within the jail
291
  (eg. python and Python libs, ld.so, etc).
118 by mattgiuca
setup.py: Added copytree and copylist actions.
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."""
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
295
    elif operation == 'install':
296
        print """sudo python setup.py install [--nojail] [--dry|-n]
297
(Requires root)
298
Create target install directory ($target).
299
Create $target/bin.
300
Copy trampoline/trampoline to $target/bin.
301
chown and chmod the installed trampoline.
302
Copy www/ to $target.
303
Copy jail/ to jails template directory (unless --nojail specified).
304
305
--nojail    Do not copy the jail.
306
--dry | -n  Print out the actions but don't do anything."""
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
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."""
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
313
    else:
314
        print >>sys.stderr, (
315
            """Invalid operation '%s'. Try python setup.py help."""
316
            % operation)
317
    return 1
318
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
319
def listmake(args):
320
    # We build two separate lists, by walking www and console
321
    list_www = build_list_py_files('www')
322
    list_console = build_list_py_files('console')
323
    # Make sure that the files generated by conf are in the list
324
    # (since listmake is typically run before conf)
325
    if "www/conf/conf.py" not in list_www:
326
        list_www.append("www/conf/conf.py")
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
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")
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
330
    # Write these out to a file
331
    cwd = os.getcwd()
332
    # the files that will be created/overwritten
333
    listfile = os.path.join(cwd, "install_list.py")
334
335
    try:
336
        file = open(listfile, "w")
337
338
        file.write("""# IVLE Configuration File
339
# install_list.py
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
340
# Provides lists of all files to be installed by `setup.py install' from
341
# certain directories.
116 by mattgiuca
setup.py: mkdir now properly obeys "dry".
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.
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
344
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
345
# List of all installable files in www directory.
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
346
list_www = """)
347
        writelist_pretty(file, list_www)
348
        file.write("""
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
349
# List of all installable files in console directory.
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
350
list_console = """)
351
        writelist_pretty(file, list_console)
352
353
        file.close()
354
    except IOError, (errno, strerror):
355
        print "IO error(%s): %s" % (errno, strerror)
356
        sys.exit(1)
357
358
    print "Successfully wrote install_list.py"
359
360
    print
361
    print ("You may modify the set of installable files before cutting the "
362
            "distribution:")
363
    print listfile
364
    print
365
366
    return 0
367
368
def build_list_py_files(dir):
369
    """Builds a list of all py files found in a directory and its
370
    subdirectories. Returns this as a list of strings."""
371
    pylist = []
372
    for (dirpath, dirnames, filenames) in os.walk(dir):
373
        # Exclude directories beginning with a '.' (such as '.svn')
374
        filter_mutate(lambda x: x[0] != '.', dirnames)
375
        # All *.py files are added to the list
376
        pylist += [os.path.join(dirpath, item) for item in filenames
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
377
            if mimetypes.guess_type(item)[0] in listmake_mimetypes]
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
378
    return pylist
379
380
def writelist_pretty(file, list):
381
    """Writes a list one element per line, to a file."""
382
    if list == []:
383
        file.write("[]\n")
384
    else:
385
        file.write('[\n')
386
        for elem in list:
387
            file.write('    %s,\n' % repr(elem))
388
        file.write(']\n')
389
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
390
def conf(args):
287 by mattgiuca
setup.py: Added new conf.py variable: subjects_base. This is for storing the
391
    global root_dir, ivle_install_dir, jail_base, subjects_base
392
    global public_host, allowed_uids
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
393
    # Set up some variables
394
395
    cwd = os.getcwd()
396
    # the files that will be created/overwritten
397
    conffile = os.path.join(cwd, "www/conf/conf.py")
398
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
399
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
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:
100 by mattgiuca
setup.py: Added a new config variable, ivle_install_dir.
413
    %s
414
    %s
97 by mattgiuca
Moved template.py and setup.py to better places.
415
prompting you for details about your configuration. The file will be
416
overwritten if it already exists. It will *not* install or deploy IVLE.
417
418
Please hit Ctrl+C now if you do not wish to do this.
100 by mattgiuca
setup.py: Added a new config variable, ivle_install_dir.
419
""" % (conffile, conf_hfile)
97 by mattgiuca
Moved template.py and setup.py to better places.
420
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
421
        # Get information from the administrator
422
        # If EOF is encountered at any time during the questioning, just exit
423
        # silently
97 by mattgiuca
Moved template.py and setup.py to better places.
424
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
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
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
432
(on the local file system):""")
287 by mattgiuca
setup.py: Added new conf.py variable: subjects_base. This is for storing the
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):""")
259 by mattgiuca
setup.py: Added a new config variable "public_host", which lets the admin set
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:""")
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
439
        allowed_uids = query_user(allowed_uids,
440
        """UID of the web server process which will run IVLE.
112 by mattgiuca
setup.py: A few comment changes.
441
Only this user may execute the trampoline. May specify multiple users as
442
a comma-separated list.
443
    (eg. "1002,78")""")
110 by mattgiuca
setup.py: Added to trampoline/conf.h an "allowed_uids" array. Asks the user
444
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
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']
287 by mattgiuca
setup.py: Added new conf.py variable: subjects_base. This is for storing the
454
        if '--subjects_base' in opts:
455
            jail_base = opts['--subjects_base']
259 by mattgiuca
setup.py: Added a new config variable "public_host", which lets the admin set
456
        if '--public_host' in opts:
457
            public_host = opts['--public_host']
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
458
        if '--allowed_uids' in opts:
459
            allowed_uids = opts['--allowed_uids']
460
110 by mattgiuca
setup.py: Added to trampoline/conf.h an "allowed_uids" array. Asks the user
461
    # Error handling on input values
462
    try:
112 by mattgiuca
setup.py: A few comment changes.
463
        allowed_uids = map(int, allowed_uids.split(','))
110 by mattgiuca
setup.py: Added to trampoline/conf.h an "allowed_uids" array. Asks the user
464
    except ValueError:
112 by mattgiuca
setup.py: A few comment changes.
465
        print >>sys.stderr, (
466
        "Invalid UID list (%s).\n"
467
        "Must be a comma-separated list of integers." % allowed_uids)
110 by mattgiuca
setup.py: Added to trampoline/conf.h an "allowed_uids" array. Asks the user
468
        return 1
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
469
470
    # Write www/conf/conf.py
471
472
    try:
473
        conf = open(conffile, "w")
474
475
        conf.write("""# IVLE Configuration File
97 by mattgiuca
Moved template.py and setup.py to better places.
476
# conf.py
477
# Miscellaneous application settings
478
479
480
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
481
# with this).
482
# eg. "/" or "/ivle".
100 by mattgiuca
setup.py: Added a new config variable, ivle_install_dir.
483
root_dir = "%s"
484
485
# In the local file system, where IVLE is actually installed.
486
# This directory should contain the "www" and "bin" directories.
487
ivle_install_dir = "%s"
97 by mattgiuca
Moved template.py and setup.py to better places.
488
259 by mattgiuca
setup.py: Added a new config variable "public_host", which lets the admin set
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
97 by mattgiuca
Moved template.py and setup.py to better places.
497
# In the local file system, where are the student/user file spaces located.
498
# The user jails are expected to be located immediately in subdirectories of
499
# this location.
106 by mattgiuca
Renamed "student_dir" to "jail_base" across the suite.
500
jail_base = "%s"
287 by mattgiuca
setup.py: Added new conf.py variable: subjects_base. This is for storing the
501
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))
110 by mattgiuca
setup.py: Added to trampoline/conf.h an "allowed_uids" array. Asks the user
507
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
508
        conf.close()
509
    except IOError, (errno, strerror):
510
        print "IO error(%s): %s" % (errno, strerror)
511
        sys.exit(1)
512
513
    print "Successfully wrote www/conf/conf.py"
514
515
    # Write trampoline/conf.h
516
517
    try:
518
        conf = open(conf_hfile, "w")
519
520
        conf.write("""/* IVLE Configuration File
100 by mattgiuca
setup.py: Added a new config variable, ivle_install_dir.
521
 * conf.h
522
 * Administrator settings required by trampoline.
523
 * Note: trampoline will have to be rebuilt in order for changes to this file
524
 * to take effect.
525
 */
526
527
/* In the local file system, where are the jails located.
528
 * The trampoline does not allow the creation of a jail anywhere besides
529
 * jail_base or a subdirectory of jail_base.
530
 */
531
static const char* jail_base = "%s";
110 by mattgiuca
setup.py: Added to trampoline/conf.h an "allowed_uids" array. Asks the user
532
533
/* Which user IDs are allowed to run the trampoline.
534
 * This list should be limited to the web server user.
535
 * (Note that root is an implicit member of this list).
536
 */
112 by mattgiuca
setup.py: A few comment changes.
537
static const int allowed_uids[] = { %s };
538
""" % (jail_base, repr(allowed_uids)[1:-1]))
100 by mattgiuca
setup.py: Added a new config variable, ivle_install_dir.
539
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
540
        conf.close()
541
    except IOError, (errno, strerror):
542
        print "IO error(%s): %s" % (errno, strerror)
543
        sys.exit(1)
544
545
    print "Successfully wrote trampoline/conf.h"
546
547
    print
548
    print "You may modify the configuration at any time by editing"
549
    print conffile
550
    print conf_hfile
551
    print
552
    return 0
553
554
def build(args):
121 by mattgiuca
setup: build and install now read command line options
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"
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
562
563
    # Compile the trampoline
564
    action_runprog('gcc', ['-Wall', '-o', 'trampoline/trampoline',
565
        'trampoline/trampoline.c'], dry)
566
567
    # Create the jail and its subdirectories
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
568
    # Note: Other subdirs will be made by copying files
116 by mattgiuca
setup.py: mkdir now properly obeys "dry".
569
    action_mkdir('jail', dry)
570
    action_mkdir('jail/home', dry)
571
    action_mkdir('jail/tmp', dry)
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
572
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
573
    # Copy all console and operating system files into the jail
118 by mattgiuca
setup.py: Added copytree and copylist actions.
574
    action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
575
    copy_os_files_jail(dry)
253 by mattgiuca
setup.py: chmods python-console when building.
576
    # Chmod the python console
577
    action_chmod_x('jail/opt/ivle/console/python-console', dry)
578
    
118 by mattgiuca
setup.py: Added copytree and copylist actions.
579
116 by mattgiuca
setup.py: mkdir now properly obeys "dry".
580
    # Compile .py files into .pyc or .pyo files
581
    compileall.compile_dir('www', quiet=True)
582
    compileall.compile_dir('console', quiet=True)
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
583
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
584
    return 0
585
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
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.
251 by mattgiuca
setup.py: Worked the "files to copy into jail" out into a separate list
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)
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
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
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
603
def install(args):
121 by mattgiuca
setup: build and install now read command line options
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"
119 by mattgiuca
setup.py: Added install action. Completely works!
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
256 by mattgiuca
Changed the way IVLE's path is loaded into Python's sys.path. Now a file
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
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
654
    return 0
655
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
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
689
    return 0
690
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
691
# The actions call Python os functions but print actions and handle dryness.
692
# May still throw os exceptions if errors occur.
693
108 by mattgiuca
setup.py: Added RunError class. action_runprog now throws a RunError if the
694
class RunError:
695
    """Represents an error when running a program (nonzero return)."""
696
    def __init__(self, prog, retcode):
697
        self.prog = prog
698
        self.retcode = retcode
699
    def __str__(self):
700
        return str(self.prog) + " returned " + repr(self.retcode)
701
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
702
def action_runprog(prog, args, dry):
703
    """Runs a unix program. Searches in $PATH. Synchronous (waits for the
704
    program to return). Runs in the current environment. First prints the
705
    action as a "bash" line.
706
108 by mattgiuca
setup.py: Added RunError class. action_runprog now throws a RunError if the
707
    Throws a RunError with a retcode of the return value of the program,
708
    if the program did not return 0.
709
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
710
    prog: String. Name of the program. (No path required, if in $PATH).
711
    args: [String]. Arguments to the program.
712
    dry: Bool. If True, prints but does not execute.
713
    """
714
    print prog, string.join(args, ' ')
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
715
    if dry: return
716
    ret = os.spawnvp(os.P_WAIT, prog, args)
717
    if ret != 0:
718
        raise RunError(prog, ret)
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
719
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
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
116 by mattgiuca
setup.py: mkdir now properly obeys "dry".
734
def action_mkdir(path, dry):
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
735
    """Calls mkdir. Silently ignored if the directory already exists.
736
    Creates all parent directories as necessary."""
737
    print "mkdir -p", path
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
738
    if dry: return
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
739
    try:
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
740
        os.makedirs(path)
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
741
    except OSError, (err, msg):
742
        if err != errno.EEXIST:
743
            raise
744
118 by mattgiuca
setup.py: Added copytree and copylist actions.
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
132 by mattgiuca
setup.py: File copying is more robust - preserves symlinks and permissions
757
    shutil.copytree(src, dst, True)
118 by mattgiuca
setup.py: Added copytree and copylist actions.
758
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
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
118 by mattgiuca
setup.py: Added copytree and copylist actions.
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:
133 by mattgiuca
setup.py: Now allows IVLE to be installed over itself, in order to allow
783
            try:
784
                shutil.copyfile(srcfile, dstfile)
785
                shutil.copymode(srcfile, dstfile)
786
            except shutil.Error:
787
                pass
118 by mattgiuca
setup.py: Added copytree and copylist actions.
788
119 by mattgiuca
setup.py: Added install action. Completely works!
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:
133 by mattgiuca
setup.py: Now allows IVLE to be installed over itself, in order to allow
798
        try:
799
            shutil.copyfile(src, dst)
800
            shutil.copymode(src, dst)
801
        except shutil.Error:
802
            pass
119 by mattgiuca
setup.py: Added install action. Completely works!
803
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
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)
131 by mattgiuca
setup.py:
811
    # Delete existing file
812
    if os.path.exists(dst):
813
        os.remove(dst)
814
    print "ln -fs", src, dst
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
815
    if not dry:
816
        os.symlink(src, dst)
817
256 by mattgiuca
Changed the way IVLE's path is loaded into Python's sys.path. Now a file
818
def action_append(ivle_pth, ivle_www):
819
    file = open(ivle_pth, 'a+')
820
    file.write(ivle_www + '\n')
821
    file.close()
822
119 by mattgiuca
setup.py: Added install action. Completely works!
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
253 by mattgiuca
setup.py: chmods python-console when building.
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
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
843
def query_user(default, prompt):
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
844
    """Prompts the user for a string, which is read from a line of stdin.
845
    Exits silently if EOF is encountered. Returns the string, with spaces
846
    removed from the beginning and end.
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
847
848
    Returns default if a 0-length line (after spaces removed) was read.
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
849
    """
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
850
    sys.stdout.write('%s\n    (default: "%s")\n>' % (prompt, default))
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
851
    try:
852
        val = sys.stdin.readline()
853
    except KeyboardInterrupt:
854
        # Ctrl+C
855
        sys.stdout.write("\n")
856
        sys.exit(1)
857
    sys.stdout.write("\n")
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
858
    # If EOF, exit
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
859
    if val == '': sys.exit(1)
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
860
    # If empty line, return default
861
    val = val.strip()
862
    if val == '': return default
863
    return val
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
864
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
865
def filter_mutate(function, list):
866
    """Like built-in filter, but mutates the given list instead of returning a
867
    new one. Returns None."""
868
    i = len(list)-1
869
    while i >= 0:
870
        # Delete elements which do not match
871
        if not function(list[i]):
872
            del list[i]
873
        i -= 1
874
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
875
if __name__ == "__main__":
876
    sys.exit(main())