~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
316 by drtomc
setup.py - name the configuration command "config" to bring it into line with
34
# setup.py config [args]
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
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.
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
38
# Creates lib/conf/conf.py and trampoline/conf.h.
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
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.
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
73
sys.path.append(os.path.join(os.getcwd(), 'lib'))
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
74
import conf
75
import common.makeuser
76
317 by mattgiuca
doc/dependencies: Added dependency on matplotlib.
77
# Determine which Python version (2.4 or 2.5, for example) we are running,
78
# and use that as the filename to the Python directory.
79
# Just get the first 3 characters of sys.version.
80
PYTHON_VERSION = sys.version[0:3]
81
251 by mattgiuca
setup.py: Worked the "files to copy into jail" out into a separate list
82
# Operating system files to copy over into the jail.
83
# These will be copied from the given place on the OS file system into the
84
# same place within the jail.
85
JAIL_FILES = [
86
    '/lib/ld-linux.so.2',
87
    '/lib/tls/i686/cmov/libc.so.6',
88
    '/lib/tls/i686/cmov/libdl.so.2',
89
    '/lib/tls/i686/cmov/libm.so.6',
90
    '/lib/tls/i686/cmov/libpthread.so.0',
91
    '/lib/tls/i686/cmov/libutil.so.1',
253 by mattgiuca
setup.py: chmods python-console when building.
92
    '/etc/ld.so.conf',
93
    '/etc/ld.so.cache',
94
    # These 2 files do not exist in Ubuntu
95
    #'/etc/ld.so.preload',
96
    #'/etc/ld.so.nohwcap',
97
    # UNIX commands
98
    '/usr/bin/strace',
99
    '/bin/ls',
100
    '/bin/echo',
101
    # Needed by python
317 by mattgiuca
doc/dependencies: Added dependency on matplotlib.
102
    '/usr/bin/python%s' % PYTHON_VERSION,
434 by drtomc
setup.py: add a bunch of shared objects to be added to the jail for svn.
103
    # Needed by fileservice
104
    '/lib/libcom_err.so.2',
105
    '/lib/libcrypt.so.1',
106
    '/lib/libkeyutils.so.1',
107
    '/lib/libresolv.so.2',
108
    '/lib/librt.so.1',
109
    '/lib/libuuid.so.1',
110
    '/usr/lib/libapr-1.so.0',
111
    '/usr/lib/libaprutil-1.so.0',
112
    '/usr/lib/libdb-4.4.so',
113
    '/usr/lib/libexpat.so.1',
114
    '/usr/lib/libgcrypt.so.11',
115
    '/usr/lib/libgnutls.so.13',
116
    '/usr/lib/libgpg-error.so.0',
117
    '/usr/lib/libgssapi_krb5.so.2',
118
    '/usr/lib/libk5crypto.so.3',
119
    '/usr/lib/libkrb5.so.3',
120
    '/usr/lib/libkrb5support.so.0',
121
    '/usr/lib/liblber.so.2',
122
    '/usr/lib/libldap_r.so.2',
123
    '/usr/lib/libneon.so.26',
124
    '/usr/lib/libpq.so.5',
125
    '/usr/lib/libsasl2.so.2',
126
    '/usr/lib/libsqlite3.so.0',
127
    '/usr/lib/libsvn_client-1.so.1',
128
    '/usr/lib/libsvn_delta-1.so.1',
129
    '/usr/lib/libsvn_diff-1.so.1',
130
    '/usr/lib/libsvn_fs-1.so.1',
131
    '/usr/lib/libsvn_fs_base-1.so.1',
132
    '/usr/lib/libsvn_fs_fs-1.so.1',
133
    '/usr/lib/libsvn_ra-1.so.1',
134
    '/usr/lib/libsvn_ra_dav-1.so.1',
135
    '/usr/lib/libsvn_ra_local-1.so.1',
136
    '/usr/lib/libsvn_ra_svn-1.so.1',
137
    '/usr/lib/libsvn_repos-1.so.1',
138
    '/usr/lib/libsvn_subr-1.so.1',
139
    '/usr/lib/libsvn_wc-1.so.1',
140
    '/usr/lib/libtasn1.so.3',
141
    '/usr/lib/libxml2.so.2',
253 by mattgiuca
setup.py: chmods python-console when building.
142
    # Needed by matplotlib
143
    '/usr/lib/i686/cmov/libssl.so.0.9.8',
144
    '/usr/lib/i686/cmov/libcrypto.so.0.9.8',
145
    '/lib/tls/i686/cmov/libnsl.so.1',
146
    '/usr/lib/libz.so.1',
147
    '/usr/lib/atlas/liblapack.so.3',
148
    '/usr/lib/atlas/libblas.so.3',
149
    '/usr/lib/libg2c.so.0',
150
    '/usr/lib/libstdc++.so.6',
151
    '/usr/lib/libfreetype.so.6',
152
    '/usr/lib/libpng12.so.0',
153
    '/usr/lib/libBLT.2.4.so.8.4',
154
    '/usr/lib/libtk8.4.so.0',
155
    '/usr/lib/libtcl8.4.so.0',
156
    '/usr/lib/tcl8.4/init.tcl',
157
    '/usr/lib/libX11.so.6',
158
    '/usr/lib/libXau.so.6',
159
    '/usr/lib/libXdmcp.so.6',
160
    '/lib/libgcc_s.so.1',
161
    '/etc/matplotlibrc',
251 by mattgiuca
setup.py: Worked the "files to copy into jail" out into a separate list
162
]
163
# Symlinks to make within the jail. Src mapped to dst.
164
JAIL_LINKS = {
317 by mattgiuca
doc/dependencies: Added dependency on matplotlib.
165
    'python%s' % PYTHON_VERSION: 'jail/usr/bin/python',
251 by mattgiuca
setup.py: Worked the "files to copy into jail" out into a separate list
166
}
167
# Trees to copy. Src mapped to dst (these will be passed to action_copytree).
168
JAIL_COPYTREES = {
317 by mattgiuca
doc/dependencies: Added dependency on matplotlib.
169
    '/usr/lib/python%s' % PYTHON_VERSION:
170
        'jail/usr/lib/python%s' % PYTHON_VERSION,
253 by mattgiuca
setup.py: chmods python-console when building.
171
    '/usr/share/matplotlib': 'jail/usr/share/matplotlib',
172
    '/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
173
}
174
358 by mattgiuca
setup.py: Gutted out the config options code. It was getting so there were
175
class ConfigOption:
176
    """A configuration option; one of the things written to conf.py."""
177
    def __init__(self, option_name, default, prompt, comment):
178
        """Creates a configuration option.
179
        option_name: Name of the variable in conf.py. Also name of the
180
            command-line argument to setup.py conf.
181
        default: Default value for this variable.
182
        prompt: (Short) string presented during the interactive prompt in
183
            setup.py conf.
184
        comment: (Long) comment string stored in conf.py. Each line of this
185
            string should begin with a '#'.
186
        """
187
        self.option_name = option_name
188
        self.default = default
189
        self.prompt = prompt
190
        self.comment = comment
191
192
# Configuration options, defaults and descriptions
193
config_options = []
194
config_options.append(ConfigOption("root_dir", "/ivle",
195
    """Root directory where IVLE is located (in URL space):""",
196
    """
197
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
198
# with this).
199
# eg. "/" or "/ivle"."""))
200
config_options.append(ConfigOption("ivle_install_dir", "/opt/ivle",
201
    'Root directory where IVLE will be installed (on the local file '
202
    'system):',
203
    """
204
# In the local file system, where IVLE is actually installed.
205
# This directory should contain the "www" and "bin" directories."""))
206
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
207
    """Root directory where the jails (containing user files) are stored
208
(on the local file system):""",
209
    """
210
# In the local file system, where are the student/user file spaces located.
211
# The user jails are expected to be located immediately in subdirectories of
212
# this location."""))
213
config_options.append(ConfigOption("subjects_base",
214
    "/home/informatics/subjects",
215
    """Root directory where the subject directories (containing worksheets
216
and other per-subject files) are stored (on the local file system):""",
217
    """
218
# In the local file system, where are the per-subject file spaces located.
219
# The individual subject directories are expected to be located immediately
220
# in subdirectories of this location."""))
395 by mattgiuca
Tutorial: split subjects directory into subjects and problems.
221
config_options.append(ConfigOption("problems_base",
222
    "/home/informatics/problems",
223
    """Root directory where the problem directories (containing
224
subject-independent problem sheets) are stored (on the local file
225
system):""",
226
    """
227
# In the local file system, where are the subject-independent problem sheet
228
# file spaces located."""))
358 by mattgiuca
setup.py: Gutted out the config options code. It was getting so there were
229
config_options.append(ConfigOption("public_host", "public.localhost",
230
    """Hostname which will cause the server to go into "public mode",
231
providing login-free access to student's published work:""",
232
    """
233
# The server goes into "public mode" if the browser sends a request with this
234
# host. This is for security reasons - we only serve public student files on a
235
# separate domain to the main IVLE site.
236
# Public mode does not use cookies, and serves only public content.
237
# Private mode (normal mode) requires login, and only serves files relevant to
238
# the logged-in user."""))
239
config_options.append(ConfigOption("allowed_uids", "33",
240
    """UID of the web server process which will run IVLE.
241
Only this user may execute the trampoline. May specify multiple users as
242
a comma-separated list.
243
    (eg. "1002,78")""",
244
    """
245
# The User-ID of the web server process which will run IVLE, and any other
246
# users who are allowed to run the trampoline. This is stores as a string of
247
# comma-separated integers, simply because it is not used within Python, only
248
# used by the setup program to write to conf.h (see setup.py config)."""))
359 by mattgiuca
setup.py: Added config options for database settings.
249
config_options.append(ConfigOption("db_host", "localhost",
250
    """PostgreSQL Database config
251
==========================
252
Hostname of the DB server:""",
253
    """
254
### PostgreSQL Database config ###
255
# Database server hostname"""))
256
config_options.append(ConfigOption("db_port", "5432",
257
    """Port of the DB server:""",
258
    """
259
# Database server port"""))
363 by mattgiuca
setup.py: Added new config option - "database name"
260
config_options.append(ConfigOption("db_dbname", "ivle",
261
    """Database name:""",
262
    """
263
# Database name"""))
359 by mattgiuca
setup.py: Added config options for database settings.
264
config_options.append(ConfigOption("db_user", "postgres",
265
    """Username for DB server login:""",
266
    """
267
# Database username"""))
268
config_options.append(ConfigOption("db_password", "",
269
    """Password for DB server login:
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
270
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
359 by mattgiuca
setup.py: Added config options for database settings.
271
    """
272
# Database password"""))
358 by mattgiuca
setup.py: Gutted out the config options code. It was getting so there were
273
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
274
# Try importing existing conf, but if we can't just set up defaults
275
# The reason for this is that these settings are used by other phases
276
# of setup besides conf, so we need to know them.
277
# Also this allows you to hit Return to accept the existing value.
278
try:
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
279
    confmodule = __import__("lib/conf/conf")
358 by mattgiuca
setup.py: Gutted out the config options code. It was getting so there were
280
    for opt in config_options:
281
        try:
282
            globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
283
        except:
284
            globals()[opt.option_name] = opt.default
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
285
except ImportError:
286
    # Just set reasonable defaults
358 by mattgiuca
setup.py: Gutted out the config options code. It was getting so there were
287
    for opt in config_options:
288
        globals()[opt.option_name] = opt.default
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
289
118 by mattgiuca
setup.py: Added copytree and copylist actions.
290
# Try importing install_list, but don't fail if we can't, because listmake can
291
# function without it.
292
try:
293
    import install_list
294
except:
295
    pass
296
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
297
# Mime types which will automatically be placed in the list by listmake.
298
# Note that listmake is not intended to be run by the final user (the system
299
# administrator who installs this), so the developers can customize the list
300
# as necessary, and include it in the distribution.
301
listmake_mimetypes = ['text/x-python', 'text/html',
302
    'application/x-javascript', 'application/javascript',
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
303
    'text/css', 'image/png', 'application/xml']
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
304
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
305
# Main function skeleton from Guido van Rossum
306
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
307
308
def main(argv=None):
309
    if argv is None:
310
        argv = sys.argv
311
312
    # Print the opening spiel including the GPL notice
313
314
    print """IVLE - Informatics Virtual Learning Environment Setup
97 by mattgiuca
Moved template.py and setup.py to better places.
315
Copyright (C) 2007-2008 The University of Melbourne
316
IVLE comes with ABSOLUTELY NO WARRANTY.
317
This is free software, and you are welcome to redistribute it
318
under certain conditions. See LICENSE.txt for details.
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
319
320
IVLE Setup
321
"""
322
323
    # First argument is the name of the setup operation
324
    try:
325
        operation = argv[1]
326
    except IndexError:
327
        # Print usage message and exit
328
        help([])
329
        return 1
330
131 by mattgiuca
setup.py:
331
    # Disallow run as root unless installing
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
332
    if (operation != 'install' and operation != 'updatejails'
333
        and os.geteuid() == 0):
131 by mattgiuca
setup.py:
334
        print >>sys.stderr, "I do not want to run this stage as root."
335
        print >>sys.stderr, "Please run as a normal user."
336
        return 1
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
337
    # Call the requested operation's function
338
    try:
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
339
        oper_func = {
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
340
            'help' : help,
316 by drtomc
setup.py - name the configuration command "config" to bring it into line with
341
            'config' : conf,
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
342
            'build' : build,
343
            'listmake' : listmake,
344
            'install' : install,
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
345
            'updatejails' : updatejails,
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
346
        }[operation]
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
347
    except KeyError:
348
        print >>sys.stderr, (
349
            """Invalid operation '%s'. Try python setup.py help."""
350
            % operation)
129 by mattgiuca
setup.py: Minor fix, exits cleanly if arguments are invalid.
351
        return 1
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
352
    return oper_func(argv[2:])
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
353
354
# Operation functions
355
356
def help(args):
357
    if args == []:
358
        print """Usage: python setup.py operation [args]
359
Operation (and args) can be:
360
    help [operation]
131 by mattgiuca
setup.py:
361
    listmake (developer use only)
316 by drtomc
setup.py - name the configuration command "config" to bring it into line with
362
    config [args]
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
363
    build
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
364
    install [--nojail] [--nosubjects] [-n|--dry]
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
365
"""
366
        return 1
367
    elif len(args) != 1:
368
        print """Usage: python setup.py help [operation]"""
369
        return 2
370
    else:
371
        operation = args[0]
372
373
    if operation == 'help':
374
        print """python setup.py help [operation]
375
Prints the usage message or detailed help on an operation, then exits."""
118 by mattgiuca
setup.py: Added copytree and copylist actions.
376
    elif operation == 'listmake':
377
        print """python setup.py listmake
378
(For developer use only)
379
Recurses through the source tree and builds a list of all files which should
380
be copied upon installation. This should be run by the developer before
381
cutting a distribution, and the listfile it generates should be included in
382
the distribution, avoiding the administrator having to run it."""
316 by drtomc
setup.py - name the configuration command "config" to bring it into line with
383
    elif operation == 'config':
384
        print """python setup.py config [args]
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
385
Configures IVLE with machine-specific details, most notably, various paths.
386
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!
387
command-line args. Will be interactive only if there are no arguments given.
388
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
389
390
To run IVLE out of the source directory (allowing development without having
391
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
392
directory, and run build/install one time.
393
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
394
Creates lib/conf/conf.py and trampoline/conf.h.
133 by mattgiuca
setup.py: Now allows IVLE to be installed over itself, in order to allow
395
358 by mattgiuca
setup.py: Gutted out the config options code. It was getting so there were
396
Args are:"""
397
        for opt in config_options:
398
            print "    --" + opt.option_name
399
        print """As explained in the interactive prompt or conf.py.
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
400
"""
401
    elif operation == 'build':
118 by mattgiuca
setup.py: Added copytree and copylist actions.
402
        print """python -O setup.py build [--dry|-n]
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
403
Compiles all files and sets up a jail template in the source directory.
116 by mattgiuca
setup.py: mkdir now properly obeys "dry".
404
-O is recommended to cause compilation to be optimised.
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
405
Details:
406
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
407
Creates jail/.
408
Creates standard subdirs inside the jail, eg bin, opt, home, tmp.
409
Copies console/ to a location within the jail.
410
Copies OS programs and files to corresponding locations within the jail
411
  (eg. python and Python libs, ld.so, etc).
118 by mattgiuca
setup.py: Added copytree and copylist actions.
412
Generates .pyc or .pyo files for all the IVLE .py files.
413
414
--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
415
    elif operation == 'install':
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
416
        print """sudo python setup.py install [--nojail] [--nosubjects][--dry|-n]
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
417
(Requires root)
418
Create target install directory ($target).
419
Create $target/bin.
420
Copy trampoline/trampoline to $target/bin.
421
chown and chmod the installed trampoline.
422
Copy www/ to $target.
423
Copy jail/ to jails template directory (unless --nojail specified).
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
424
Copy subjects/ to subjects directory (unless --nosubjects specified).
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
425
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
426
--nojail        Do not copy the jail.
395 by mattgiuca
Tutorial: split subjects directory into subjects and problems.
427
--nosubjects    Do not copy the subjects and problems directories.
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
428
--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
429
    elif operation == 'updatejails':
430
        print """sudo python setup.py updatejails [--dry|-n]
431
(Requires root)
432
Copy jail/ to each subdirectory in jails directory.
433
434
--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
435
    else:
436
        print >>sys.stderr, (
437
            """Invalid operation '%s'. Try python setup.py help."""
438
            % operation)
439
    return 1
440
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
441
def listmake(args):
442
    # We build two separate lists, by walking www and console
443
    list_www = build_list_py_files('www')
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
444
    list_lib = build_list_py_files('lib')
418 by mattgiuca
Renamed trunk/console to trunk/scripts. We are now able to put more scripts in
445
    list_scripts = build_list_py_files('scripts')
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
446
    list_subjects = build_list_py_files('subjects', no_top_level=True)
395 by mattgiuca
Tutorial: split subjects directory into subjects and problems.
447
    list_problems = build_list_py_files('problems', no_top_level=True)
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
448
    # Make sure that the files generated by conf are in the list
449
    # (since listmake is typically run before conf)
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
450
    if "lib/conf/conf.py" not in list_lib:
427 by mattgiuca
setup.py: Fix (put conf.py in wrong list in listmake)
451
        list_lib.append("lib/conf/conf.py")
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
452
    # Make sure that console/python-console is in the list
418 by mattgiuca
Renamed trunk/console to trunk/scripts. We are now able to put more scripts in
453
    if "scripts/python-console" not in list_scripts:
454
        list_scripts.append("scripts/python-console")
455
    if "scripts/fileservice" not in list_scripts:
456
        list_scripts.append("scripts/fileservice")
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
457
    # Write these out to a file
458
    cwd = os.getcwd()
459
    # the files that will be created/overwritten
460
    listfile = os.path.join(cwd, "install_list.py")
461
462
    try:
463
        file = open(listfile, "w")
464
465
        file.write("""# IVLE Configuration File
466
# install_list.py
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
467
# Provides lists of all files to be installed by `setup.py install' from
468
# certain directories.
116 by mattgiuca
setup.py: mkdir now properly obeys "dry".
469
# Note that any files with the given filename plus 'c' or 'o' (that is,
470
# compiled .pyc or .pyo files) will be copied as well.
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
471
117 by mattgiuca
setup.py: listmake uses mimetypes to select all files with certain mime types,
472
# List of all installable files in www directory.
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
473
list_www = """)
474
        writelist_pretty(file, list_www)
475
        file.write("""
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
476
# List of all installable files in lib directory.
477
list_lib = """)
478
        writelist_pretty(file, list_lib)
479
        file.write("""
418 by mattgiuca
Renamed trunk/console to trunk/scripts. We are now able to put more scripts in
480
# List of all installable files in scripts directory.
481
list_scripts = """)
482
        writelist_pretty(file, list_scripts)
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
483
        file.write("""
484
# List of all installable files in subjects directory.
485
# This is to install sample subjects and material.
486
list_subjects = """)
487
        writelist_pretty(file, list_subjects)
395 by mattgiuca
Tutorial: split subjects directory into subjects and problems.
488
        file.write("""
489
# List of all installable files in problems directory.
490
# This is to install sample exercise material.
491
list_problems = """)
492
        writelist_pretty(file, list_problems)
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
493
494
        file.close()
495
    except IOError, (errno, strerror):
496
        print "IO error(%s): %s" % (errno, strerror)
497
        sys.exit(1)
498
499
    print "Successfully wrote install_list.py"
500
501
    print
502
    print ("You may modify the set of installable files before cutting the "
503
            "distribution:")
504
    print listfile
505
    print
506
507
    return 0
508
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
509
def build_list_py_files(dir, no_top_level=False):
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
510
    """Builds a list of all py files found in a directory and its
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
511
    subdirectories. Returns this as a list of strings.
512
    no_top_level=True means the file paths will not include the top-level
513
    directory.
514
    """
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
515
    pylist = []
516
    for (dirpath, dirnames, filenames) in os.walk(dir):
517
        # Exclude directories beginning with a '.' (such as '.svn')
518
        filter_mutate(lambda x: x[0] != '.', dirnames)
519
        # All *.py files are added to the list
520
        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,
521
            if mimetypes.guess_type(item)[0] in listmake_mimetypes]
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
522
    if no_top_level:
523
        for i in range(0, len(pylist)):
524
            _, pylist[i] = pylist[i].split(os.sep, 1)
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
525
    return pylist
526
527
def writelist_pretty(file, list):
528
    """Writes a list one element per line, to a file."""
529
    if list == []:
530
        file.write("[]\n")
531
    else:
532
        file.write('[\n')
533
        for elem in list:
534
            file.write('    %s,\n' % repr(elem))
535
        file.write(']\n')
536
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
537
def conf(args):
364 by mattgiuca
setup.py: Fixed config command-line args (forgot to make general).
538
    global db_port
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
539
    # Set up some variables
540
541
    cwd = os.getcwd()
542
    # the files that will be created/overwritten
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
543
    conffile = os.path.join(cwd, "lib/conf/conf.py")
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
544
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
545
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
546
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
547
    # Get command-line arguments to avoid asking questions.
548
364 by mattgiuca
setup.py: Fixed config command-line args (forgot to make general).
549
    optnames = []
550
    for opt in config_options:
551
        optnames.append(opt.option_name + "=")
552
    (opts, args) = getopt.gnu_getopt(args, "", optnames)
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
553
554
    if args != []:
555
        print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
556
        return 2
557
558
    if opts == []:
559
        # Interactive mode. Prompt the user for all the values.
560
561
        print """This tool will create the following files:
100 by mattgiuca
setup.py: Added a new config variable, ivle_install_dir.
562
    %s
563
    %s
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
564
    %s
97 by mattgiuca
Moved template.py and setup.py to better places.
565
prompting you for details about your configuration. The file will be
566
overwritten if it already exists. It will *not* install or deploy IVLE.
567
568
Please hit Ctrl+C now if you do not wish to do this.
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
569
""" % (conffile, jailconffile, conf_hfile)
97 by mattgiuca
Moved template.py and setup.py to better places.
570
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
571
        # Get information from the administrator
572
        # If EOF is encountered at any time during the questioning, just exit
573
        # silently
97 by mattgiuca
Moved template.py and setup.py to better places.
574
358 by mattgiuca
setup.py: Gutted out the config options code. It was getting so there were
575
        for opt in config_options:
576
            globals()[opt.option_name] = \
577
                query_user(globals()[opt.option_name], opt.prompt)
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
578
    else:
579
        opts = dict(opts)
580
        # Non-interactive mode. Parse the options.
358 by mattgiuca
setup.py: Gutted out the config options code. It was getting so there were
581
        for opt in config_options:
582
            if '--' + opt.option_name in opts:
583
                globals()[opt.option_name] = opts['--' + opt.option_name]
120 by mattgiuca
setup.py: Added command-line argument mode for conf. This completely works!
584
110 by mattgiuca
setup.py: Added to trampoline/conf.h an "allowed_uids" array. Asks the user
585
    # Error handling on input values
586
    try:
358 by mattgiuca
setup.py: Gutted out the config options code. It was getting so there were
587
        allowed_uids_list = map(int, allowed_uids.split(','))
110 by mattgiuca
setup.py: Added to trampoline/conf.h an "allowed_uids" array. Asks the user
588
    except ValueError:
112 by mattgiuca
setup.py: A few comment changes.
589
        print >>sys.stderr, (
590
        "Invalid UID list (%s).\n"
591
        "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
592
        return 1
364 by mattgiuca
setup.py: Fixed config command-line args (forgot to make general).
593
    try:
594
        db_port = int(db_port)
595
        if db_port < 0 or db_port >= 65536: raise ValueError()
596
    except ValueError:
597
        print >>sys.stderr, (
598
        "Invalid DB port (%s).\n"
599
        "Must be an integer between 0 and 65535." % repr(db_port))
600
        return 1
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
601
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
602
    # Write lib/conf/conf.py
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
603
604
    try:
605
        conf = open(conffile, "w")
606
607
        conf.write("""# IVLE Configuration File
97 by mattgiuca
Moved template.py and setup.py to better places.
608
# conf.py
609
# Miscellaneous application settings
610
358 by mattgiuca
setup.py: Gutted out the config options code. It was getting so there were
611
""")
612
        for opt in config_options:
364 by mattgiuca
setup.py: Fixed config command-line args (forgot to make general).
613
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
614
                repr(globals()[opt.option_name])))
110 by mattgiuca
setup.py: Added to trampoline/conf.h an "allowed_uids" array. Asks the user
615
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
616
        conf.close()
617
    except IOError, (errno, strerror):
618
        print "IO error(%s): %s" % (errno, strerror)
619
        sys.exit(1)
620
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
621
    print "Successfully wrote lib/conf/conf.py"
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
622
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
623
    # Write conf/jailconf.py
624
625
    try:
626
        conf = open(jailconffile, "w")
627
628
        # In the "in-jail" version of conf, we don't need MOST of the details
629
        # (it would be a security risk to have them here).
630
        # So we just write root_dir, and jail_base is "/".
631
        # (jail_base being "/" means "jail-relative" paths are relative to "/"
632
        # when inside the jail.)
633
        conf.write("""# IVLE Configuration File
634
# conf.py
635
# Miscellaneous application settings
636
# (User jail version)
637
638
639
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
640
# with this).
641
# eg. "/" or "/ivle".
642
root_dir = %s
643
644
# In the local file system, where are the student/user file spaces located.
645
# The user jails are expected to be located immediately in subdirectories of
646
# this location.
647
jail_base = '/'
435 by drtomc
setup.py: Fix a couple of jail config glitches.
648
649
# The hostname for serving publicly accessible pages
650
public_host = %s
651
""" % (repr(root_dir),repr(public_host)))
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
652
653
        conf.close()
654
    except IOError, (errno, strerror):
655
        print "IO error(%s): %s" % (errno, strerror)
656
        sys.exit(1)
657
658
    print "Successfully wrote lib/conf/jailconf.py"
659
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
660
    # Write trampoline/conf.h
661
662
    try:
663
        conf = open(conf_hfile, "w")
664
665
        conf.write("""/* IVLE Configuration File
100 by mattgiuca
setup.py: Added a new config variable, ivle_install_dir.
666
 * conf.h
667
 * Administrator settings required by trampoline.
668
 * Note: trampoline will have to be rebuilt in order for changes to this file
669
 * to take effect.
670
 */
671
672
/* In the local file system, where are the jails located.
673
 * The trampoline does not allow the creation of a jail anywhere besides
674
 * jail_base or a subdirectory of jail_base.
675
 */
676
static const char* jail_base = "%s";
110 by mattgiuca
setup.py: Added to trampoline/conf.h an "allowed_uids" array. Asks the user
677
678
/* Which user IDs are allowed to run the trampoline.
679
 * This list should be limited to the web server user.
680
 * (Note that root is an implicit member of this list).
681
 */
112 by mattgiuca
setup.py: A few comment changes.
682
static const int allowed_uids[] = { %s };
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
683
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
684
    # Note: The above uses PYTHON reprs, not C reprs
685
    # However they should be the same with the exception of the outer
686
    # characters, which are stripped off and replaced
100 by mattgiuca
setup.py: Added a new config variable, ivle_install_dir.
687
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
688
        conf.close()
689
    except IOError, (errno, strerror):
690
        print "IO error(%s): %s" % (errno, strerror)
691
        sys.exit(1)
692
693
    print "Successfully wrote trampoline/conf.h"
694
695
    print
696
    print "You may modify the configuration at any time by editing"
697
    print conffile
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
698
    print jailconffile
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
699
    print conf_hfile
700
    print
701
    return 0
702
703
def build(args):
121 by mattgiuca
setup: build and install now read command line options
704
    # Get "dry" variable from command line
705
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
706
    opts = dict(opts)
707
    dry = '-n' in opts or '--dry' in opts
708
709
    if dry:
710
        print "Dry run (no actions will be executed\n"
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
711
712
    # Compile the trampoline
349 by mattgiuca
setup.py: Changed so instead of directly calling gcc on the trampoline, calls
713
    curdir = os.getcwd()
714
    os.chdir('trampoline')
715
    action_runprog('make', [], dry)
716
    os.chdir(curdir)
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
717
718
    # Create the jail and its subdirectories
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
719
    # Note: Other subdirs will be made by copying files
116 by mattgiuca
setup.py: mkdir now properly obeys "dry".
720
    action_mkdir('jail', dry)
721
    action_mkdir('jail/home', dry)
722
    action_mkdir('jail/tmp', dry)
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
723
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
724
    # Copy all console and operating system files into the jail
418 by mattgiuca
Renamed trunk/console to trunk/scripts. We are now able to put more scripts in
725
    action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
726
    copy_os_files_jail(dry)
253 by mattgiuca
setup.py: chmods python-console when building.
727
    # Chmod the python console
418 by mattgiuca
Renamed trunk/console to trunk/scripts. We are now able to put more scripts in
728
    action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
729
    action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
253 by mattgiuca
setup.py: chmods python-console when building.
730
    
422 by mattgiuca
setup.py: Needs to copy the "lib" directory into the jail. Now does this and
731
    # Also copy the IVLE lib directory into the jail
732
    # This is necessary for running certain scripts
733
    action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
734
    # IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
735
    # which could compromise security if left in the jail (such as the DB
736
    # password).
737
    # The "safe" version is in jailconf.py. Delete conf.py and replace it with
738
    # jailconf.py.
435 by drtomc
setup.py: Fix a couple of jail config glitches.
739
    action_copyfile('lib/conf/jailconf.py',
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
740
        'jail/opt/ivle/lib/conf/conf.py', dry)
118 by mattgiuca
setup.py: Added copytree and copylist actions.
741
116 by mattgiuca
setup.py: mkdir now properly obeys "dry".
742
    # Compile .py files into .pyc or .pyo files
743
    compileall.compile_dir('www', quiet=True)
422 by mattgiuca
setup.py: Needs to copy the "lib" directory into the jail. Now does this and
744
    compileall.compile_dir('lib', quiet=True)
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
745
    compileall.compile_dir('scripts', quiet=True)
422 by mattgiuca
setup.py: Needs to copy the "lib" directory into the jail. Now does this and
746
    compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
747
748
    # Set up ivle.pth inside the jail
749
    # Need to set /opt/ivle/lib to be on the import path
750
    ivle_pth = \
751
        "jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
752
    f = open(ivle_pth, 'w')
753
    f.write('/opt/ivle/lib\n')
754
    f.close()
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
755
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
756
    return 0
757
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
758
def copy_os_files_jail(dry):
759
    """Copies necessary Operating System files from their usual locations
760
    into the jail/ directory of the cwd."""
761
    # Currently source paths are configured for Ubuntu.
251 by mattgiuca
setup.py: Worked the "files to copy into jail" out into a separate list
762
    for filename in JAIL_FILES:
763
        copy_file_to_jail(filename, dry)
764
    for src, dst in JAIL_LINKS.items():
765
        action_symlink(src, dst, dry)
766
    for src, dst in JAIL_COPYTREES.items():
767
        action_copytree(src, dst, dry)
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
768
769
def copy_file_to_jail(src, dry):
770
    """Copies a single file from an absolute location into the same location
771
    within the jail. src must begin with a '/'. The jail will be located
772
    in a 'jail' subdirectory of the current path."""
773
    action_copyfile(src, 'jail' + src, dry)
774
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
775
def install(args):
121 by mattgiuca
setup: build and install now read command line options
776
    # Get "dry" and "nojail" variables from command line
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
777
    (opts, args) = getopt.gnu_getopt(args, "n",
778
        ['dry', 'nojail', 'nosubjects'])
121 by mattgiuca
setup: build and install now read command line options
779
    opts = dict(opts)
780
    dry = '-n' in opts or '--dry' in opts
781
    nojail = '--nojail' in opts
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
782
    nosubjects = '--nosubjects' in opts
121 by mattgiuca
setup: build and install now read command line options
783
784
    if dry:
785
        print "Dry run (no actions will be executed\n"
119 by mattgiuca
setup.py: Added install action. Completely works!
786
787
    if not dry and os.geteuid() != 0:
788
        print >>sys.stderr, "Must be root to run install"
789
        print >>sys.stderr, "(I need to chown some files)."
790
        return 1
791
792
    # Create the target (install) directory
793
    action_mkdir(ivle_install_dir, dry)
794
795
    # Create bin and copy the compiled files there
796
    action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
797
    tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
798
    action_copyfile('trampoline/trampoline', tramppath, dry)
799
    # chown trampoline to root and set setuid bit
800
    action_chown_setuid(tramppath, dry)
801
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
802
    # Copy the www and lib directories using the list
119 by mattgiuca
setup.py: Added install action. Completely works!
803
    action_copylist(install_list.list_www, ivle_install_dir, dry)
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
804
    action_copylist(install_list.list_lib, ivle_install_dir, dry)
119 by mattgiuca
setup.py: Added install action. Completely works!
805
806
    if not nojail:
807
        # Copy the local jail directory built by the build action
808
        # to the jails template directory (it will be used as a template
809
        # for all the students' jails).
810
        action_copytree('jail', os.path.join(jail_base, 'template'), dry)
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
811
    if not nosubjects:
395 by mattgiuca
Tutorial: split subjects directory into subjects and problems.
812
        # Copy the subjects and problems directories across
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
813
        action_copylist(install_list.list_subjects, subjects_base, dry,
814
            srcdir="./subjects")
395 by mattgiuca
Tutorial: split subjects directory into subjects and problems.
815
        action_copylist(install_list.list_problems, problems_base, dry,
816
            srcdir="./problems")
119 by mattgiuca
setup.py: Added install action. Completely works!
817
256 by mattgiuca
Changed the way IVLE's path is loaded into Python's sys.path. Now a file
818
    # Append IVLE path to ivle.pth in python site packages
819
    # (Unless it's already there)
820
    ivle_pth = os.path.join(sys.prefix,
317 by mattgiuca
doc/dependencies: Added dependency on matplotlib.
821
        "lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
256 by mattgiuca
Changed the way IVLE's path is loaded into Python's sys.path. Now a file
822
    ivle_www = os.path.join(ivle_install_dir, "www")
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
823
    ivle_lib = os.path.join(ivle_install_dir, "lib")
256 by mattgiuca
Changed the way IVLE's path is loaded into Python's sys.path. Now a file
824
    write_ivle_pth = True
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
825
    write_ivle_lib_pth = True
256 by mattgiuca
Changed the way IVLE's path is loaded into Python's sys.path. Now a file
826
    try:
827
        file = open(ivle_pth, 'r')
828
        for line in file:
829
            if line.strip() == ivle_www:
830
                write_ivle_pth = False
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
831
            elif line.strip() == ivle_lib:
832
                write_ivle_lib_pth = False
833
        file.close()
256 by mattgiuca
Changed the way IVLE's path is loaded into Python's sys.path. Now a file
834
    except (IOError, OSError):
835
        pass
836
    if write_ivle_pth:
837
        action_append(ivle_pth, ivle_www)
409 by mattgiuca
Moved www/conf and www/common to a new directory lib. This separates the "web"
838
    if write_ivle_lib_pth:
839
        action_append(ivle_pth, ivle_lib)
256 by mattgiuca
Changed the way IVLE's path is loaded into Python's sys.path. Now a file
840
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
841
    return 0
842
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
843
def updatejails(args):
844
    # Get "dry" variable from command line
845
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
846
    opts = dict(opts)
847
    dry = '-n' in opts or '--dry' in opts
848
849
    if dry:
850
        print "Dry run (no actions will be executed\n"
851
852
    if not dry and os.geteuid() != 0:
853
        print >>sys.stderr, "Must be root to run install"
854
        print >>sys.stderr, "(I need to chown some files)."
855
        return 1
856
857
    # Update the template jail directory in case it hasn't been installed
858
    # recently.
859
    action_copytree('jail', os.path.join(jail_base, 'template'), dry)
860
861
    # Re-link all the files in all students jails.
862
    for dir in os.listdir(jail_base):
863
        if dir == 'template': continue
864
        # First back up the student's home directory
865
        temp_home = os.tmpnam()
866
        action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
867
        # Delete the student's jail and relink the jail files
868
        action_linktree(os.path.join(jail_base, 'template'),
869
            os.path.join(jail_base, dir), dry)
870
        # Restore the student's home directory
871
        action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
872
        # Set up the user's home directory just in case they don't have a
873
        # directory for this yet
874
        action_mkdir(os.path.join(jail_base, dir, 'home', dir), dry)
875
876
    return 0
877
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
878
# The actions call Python os functions but print actions and handle dryness.
879
# May still throw os exceptions if errors occur.
880
108 by mattgiuca
setup.py: Added RunError class. action_runprog now throws a RunError if the
881
class RunError:
882
    """Represents an error when running a program (nonzero return)."""
883
    def __init__(self, prog, retcode):
884
        self.prog = prog
885
        self.retcode = retcode
886
    def __str__(self):
887
        return str(self.prog) + " returned " + repr(self.retcode)
888
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
889
def action_runprog(prog, args, dry):
890
    """Runs a unix program. Searches in $PATH. Synchronous (waits for the
891
    program to return). Runs in the current environment. First prints the
892
    action as a "bash" line.
893
108 by mattgiuca
setup.py: Added RunError class. action_runprog now throws a RunError if the
894
    Throws a RunError with a retcode of the return value of the program,
895
    if the program did not return 0.
896
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
897
    prog: String. Name of the program. (No path required, if in $PATH).
898
    args: [String]. Arguments to the program.
899
    dry: Bool. If True, prints but does not execute.
900
    """
901
    print prog, string.join(args, ' ')
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
902
    if dry: return
903
    ret = os.spawnvp(os.P_WAIT, prog, args)
904
    if ret != 0:
905
        raise RunError(prog, ret)
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
906
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
907
def action_remove(path, dry):
908
    """Calls rmtree, deleting the target file if it exists."""
434 by drtomc
setup.py: add a bunch of shared objects to be added to the jail for svn.
909
    try:
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
910
        print "rm -r", path
911
        if not dry:
912
            shutil.rmtree(path, True)
434 by drtomc
setup.py: add a bunch of shared objects to be added to the jail for svn.
913
    except OSError, (err, msg):
914
        if err != errno.EEXIST:
915
            raise
916
        # Otherwise, didn't exist, so we don't care
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
917
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
918
def action_rename(src, dst, dry):
919
    """Calls rename. Deletes the target if it already exists."""
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
920
    action_remove(dst, dry)
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
921
    print "mv ", src, dst
922
    if dry: return
923
    try:
924
        os.rename(src, dst)
925
    except OSError, (err, msg):
926
        if err != errno.EEXIST:
927
            raise
928
116 by mattgiuca
setup.py: mkdir now properly obeys "dry".
929
def action_mkdir(path, dry):
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
930
    """Calls mkdir. Silently ignored if the directory already exists.
931
    Creates all parent directories as necessary."""
932
    print "mkdir -p", path
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
933
    if dry: return
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
934
    try:
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
935
        os.makedirs(path)
107 by mattgiuca
setup.py: Added "action" functions which encapsulate calling OS functions.
936
    except OSError, (err, msg):
937
        if err != errno.EEXIST:
938
            raise
939
118 by mattgiuca
setup.py: Added copytree and copylist actions.
940
def action_copytree(src, dst, dry):
941
    """Copies an entire directory tree. Symlinks are seen as normal files and
942
    copies of the entire file (not the link) are made. Creates all parent
943
    directories as necessary.
944
945
    See shutil.copytree."""
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
946
    action_remove(dst, dry)
118 by mattgiuca
setup.py: Added copytree and copylist actions.
947
    print "cp -r", src, dst
948
    if dry: return
132 by mattgiuca
setup.py: File copying is more robust - preserves symlinks and permissions
949
    shutil.copytree(src, dst, True)
118 by mattgiuca
setup.py: Added copytree and copylist actions.
950
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
951
def action_linktree(src, dst, dry):
952
    """Hard-links an entire directory tree. Same as copytree but the created
953
    files are hard-links not actual copies. Removes the existing destination.
954
    """
433 by mattgiuca
setup.py: Conf now writes another file, lib/conf/jailconf.py. This file is a
955
    action_remove(dst, dry)
252 by mattgiuca
setup.py: Added action "updatejails" which wipes all student jails, replacing
956
    print "<cp with hardlinks> -r", src, dst
957
    if dry: return
958
    common.makeuser.linktree(src, dst)
959
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
960
def action_copylist(srclist, dst, dry, srcdir="."):
118 by mattgiuca
setup.py: Added copytree and copylist actions.
961
    """Copies all files in a list to a new location. The files in the list
962
    are read relative to the current directory, and their destinations are the
963
    same paths relative to dst. Creates all parent directories as necessary.
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
964
    srcdir is "." by default, can be overridden.
118 by mattgiuca
setup.py: Added copytree and copylist actions.
965
    """
966
    for srcfile in srclist:
967
        dstfile = os.path.join(dst, srcfile)
313 by mattgiuca
test/test_framework: Updated examples, a bit of better descriptions, sample
968
        srcfile = os.path.join(srcdir, srcfile)
118 by mattgiuca
setup.py: Added copytree and copylist actions.
969
        dstdir = os.path.split(dstfile)[0]
970
        if not os.path.isdir(dstdir):
971
            action_mkdir(dstdir, dry)
972
        print "cp -f", srcfile, dstfile
973
        if not dry:
133 by mattgiuca
setup.py: Now allows IVLE to be installed over itself, in order to allow
974
            try:
975
                shutil.copyfile(srcfile, dstfile)
976
                shutil.copymode(srcfile, dstfile)
977
            except shutil.Error:
978
                pass
118 by mattgiuca
setup.py: Added copytree and copylist actions.
979
119 by mattgiuca
setup.py: Added install action. Completely works!
980
def action_copyfile(src, dst, dry):
981
    """Copies one file to a new location. Creates all parent directories
982
    as necessary.
318 by mattgiuca
setup.py: action_copyfile now handles errors as warnings, instead of quitting
983
    Warn if file not found.
119 by mattgiuca
setup.py: Added install action. Completely works!
984
    """
985
    dstdir = os.path.split(dst)[0]
986
    if not os.path.isdir(dstdir):
987
        action_mkdir(dstdir, dry)
988
    print "cp -f", src, dst
989
    if not dry:
133 by mattgiuca
setup.py: Now allows IVLE to be installed over itself, in order to allow
990
        try:
991
            shutil.copyfile(src, dst)
992
            shutil.copymode(src, dst)
318 by mattgiuca
setup.py: action_copyfile now handles errors as warnings, instead of quitting
993
        except (shutil.Error, IOError), e:
994
            print "Warning: " + str(e)
119 by mattgiuca
setup.py: Added install action. Completely works!
995
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
996
def action_symlink(src, dst, dry):
997
    """Creates a symlink in a given location. Creates all parent directories
998
    as necessary.
999
    """
1000
    dstdir = os.path.split(dst)[0]
1001
    if not os.path.isdir(dstdir):
1002
        action_mkdir(dstdir, dry)
131 by mattgiuca
setup.py:
1003
    # Delete existing file
1004
    if os.path.exists(dst):
1005
        os.remove(dst)
1006
    print "ln -fs", src, dst
122 by mattgiuca
setup.py: build action now copies all operating system files into the jail.
1007
    if not dry:
1008
        os.symlink(src, dst)
1009
256 by mattgiuca
Changed the way IVLE's path is loaded into Python's sys.path. Now a file
1010
def action_append(ivle_pth, ivle_www):
1011
    file = open(ivle_pth, 'a+')
1012
    file.write(ivle_www + '\n')
1013
    file.close()
1014
119 by mattgiuca
setup.py: Added install action. Completely works!
1015
def action_chown_setuid(file, dry):
1016
    """Chowns a file to root, and sets the setuid bit on the file.
1017
    Calling this function requires the euid to be root.
1018
    The actual mode of path is set to: rws--s--s
1019
    """
1020
    print "chown root:root", file
1021
    if not dry:
1022
        os.chown(file, 0, 0)
1023
    print "chmod a+xs", file
1024
    print "chmod u+rw", file
1025
    if not dry:
1026
        os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
1027
            | stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
1028
253 by mattgiuca
setup.py: chmods python-console when building.
1029
def action_chmod_x(file, dry):
371 by mattgiuca
setup.py: Fixed chmodding python-console. (Turns out this was a bug in setup,
1030
    """Chmod 755 a file (sets permissions to rwxr-xr-x)."""
1031
    print "chmod 755", file
253 by mattgiuca
setup.py: chmods python-console when building.
1032
    if not dry:
371 by mattgiuca
setup.py: Fixed chmodding python-console. (Turns out this was a bug in setup,
1033
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1034
            | stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
253 by mattgiuca
setup.py: chmods python-console when building.
1035
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
1036
def query_user(default, prompt):
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
1037
    """Prompts the user for a string, which is read from a line of stdin.
1038
    Exits silently if EOF is encountered. Returns the string, with spaces
1039
    removed from the beginning and end.
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
1040
1041
    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
1042
    """
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
1043
    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
1044
    try:
1045
        val = sys.stdin.readline()
1046
    except KeyboardInterrupt:
1047
        # Ctrl+C
1048
        sys.stdout.write("\n")
1049
        sys.exit(1)
1050
    sys.stdout.write("\n")
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
1051
    # If EOF, exit
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
1052
    if val == '': sys.exit(1)
113 by mattgiuca
setup.py: Now loads defaults, if possible, from the existing conf.py.
1053
    # If empty line, return default
1054
    val = val.strip()
1055
    if val == '': return default
1056
    return val
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
1057
114 by mattgiuca
setup.py: Wrote listmake (and ancillary functions).
1058
def filter_mutate(function, list):
1059
    """Like built-in filter, but mutates the given list instead of returning a
1060
    new one. Returns None."""
1061
    i = len(list)-1
1062
    while i >= 0:
1063
        # Delete elements which do not match
1064
        if not function(list[i]):
1065
            del list[i]
1066
        i -= 1
1067
104 by mattgiuca
setup.py: Replaced the simple script with a full options processing script
1068
if __name__ == "__main__":
1069
    sys.exit(main())