← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: mattgiuca
  • Date: 2008-01-12 16:45:25 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:207
browser.js: Removed trailing slash from the path list
    (this is incorrect since sometimes it displays non-directory files).

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup.py
31
31
# cutting a distribution, and the listfile it generates should be included in
32
32
# the distribution, avoiding the administrator having to run it.
33
33
 
34
 
# setup.py config [args]
 
34
# setup.py conf [args]
35
35
# Configures IVLE with machine-specific details, most notably, various paths.
36
36
# Either prompts the administrator for these details or accepts them as
37
37
# command-line args.
38
 
# Creates lib/conf/conf.py and trampoline/conf.h.
 
38
# Creates www/conf/conf.py and trampoline/conf.h.
39
39
 
40
40
# setup.py build
41
41
# Compiles all files and sets up a jail template in the source directory.
67
67
import mimetypes
68
68
import compileall
69
69
import getopt
70
 
import hashlib
71
 
import uuid
72
 
 
73
 
# Import modules from the website is tricky since they're in the www
74
 
# directory.
75
 
sys.path.append(os.path.join(os.getcwd(), 'lib'))
76
 
import conf
77
 
import common.makeuser
78
 
 
79
 
# Determine which Python version (2.4 or 2.5, for example) we are running,
80
 
# and use that as the filename to the Python directory.
81
 
# Just get the first 3 characters of sys.version.
82
 
PYTHON_VERSION = sys.version[0:3]
83
 
 
84
 
# Operating system files to copy over into the jail.
85
 
# These will be copied from the given place on the OS file system into the
86
 
# same place within the jail.
87
 
JAIL_FILES = [
88
 
    '/lib/ld-linux.so.2',
89
 
    '/lib/tls/i686/cmov/libc.so.6',
90
 
    '/lib/tls/i686/cmov/libdl.so.2',
91
 
    '/lib/tls/i686/cmov/libm.so.6',
92
 
    '/lib/tls/i686/cmov/libpthread.so.0',
93
 
    '/lib/tls/i686/cmov/libutil.so.1',
94
 
    '/etc/ld.so.conf',
95
 
    '/etc/ld.so.cache',
96
 
    # These 2 files do not exist in Ubuntu
97
 
    #'/etc/ld.so.preload',
98
 
    #'/etc/ld.so.nohwcap',
99
 
    # UNIX commands
100
 
    '/usr/bin/strace',
101
 
    '/bin/ls',
102
 
    '/bin/echo',
103
 
    # Needed by python
104
 
    '/usr/bin/python%s' % PYTHON_VERSION,
105
 
    # Needed by fileservice
106
 
    '/lib/libcom_err.so.2',
107
 
    '/lib/libcrypt.so.1',
108
 
    '/lib/libkeyutils.so.1',
109
 
    '/lib/libresolv.so.2',
110
 
    '/lib/librt.so.1',
111
 
    '/lib/libuuid.so.1',
112
 
    '/usr/lib/libapr-1.so.0',
113
 
    '/usr/lib/libaprutil-1.so.0',
114
 
    '/usr/lib/libdb-4.4.so',
115
 
    '/usr/lib/libexpat.so.1',
116
 
    '/usr/lib/libgcrypt.so.11',
117
 
    '/usr/lib/libgnutls.so.13',
118
 
    '/usr/lib/libgpg-error.so.0',
119
 
    '/usr/lib/libgssapi_krb5.so.2',
120
 
    '/usr/lib/libk5crypto.so.3',
121
 
    '/usr/lib/libkrb5.so.3',
122
 
    '/usr/lib/libkrb5support.so.0',
123
 
    '/usr/lib/liblber.so.2',
124
 
    '/usr/lib/libldap_r.so.2',
125
 
    '/usr/lib/libneon.so.26',
126
 
    '/usr/lib/libpq.so.5',
127
 
    '/usr/lib/libsasl2.so.2',
128
 
    '/usr/lib/libsqlite3.so.0',
129
 
    '/usr/lib/libsvn_client-1.so.1',
130
 
    '/usr/lib/libsvn_delta-1.so.1',
131
 
    '/usr/lib/libsvn_diff-1.so.1',
132
 
    '/usr/lib/libsvn_fs-1.so.1',
133
 
    '/usr/lib/libsvn_fs_base-1.so.1',
134
 
    '/usr/lib/libsvn_fs_fs-1.so.1',
135
 
    '/usr/lib/libsvn_ra-1.so.1',
136
 
    '/usr/lib/libsvn_ra_dav-1.so.1',
137
 
    '/usr/lib/libsvn_ra_local-1.so.1',
138
 
    '/usr/lib/libsvn_ra_svn-1.so.1',
139
 
    '/usr/lib/libsvn_repos-1.so.1',
140
 
    '/usr/lib/libsvn_subr-1.so.1',
141
 
    '/usr/lib/libsvn_wc-1.so.1',
142
 
    '/usr/lib/libtasn1.so.3',
143
 
    '/usr/lib/libxml2.so.2',
144
 
    # Needed by matplotlib
145
 
    '/usr/lib/i686/cmov/libssl.so.0.9.8',
146
 
    '/usr/lib/i686/cmov/libcrypto.so.0.9.8',
147
 
    '/lib/tls/i686/cmov/libnsl.so.1',
148
 
    '/usr/lib/libz.so.1',
149
 
    '/usr/lib/atlas/liblapack.so.3',
150
 
    '/usr/lib/atlas/libblas.so.3',
151
 
    '/usr/lib/libg2c.so.0',
152
 
    '/usr/lib/libstdc++.so.6',
153
 
    '/usr/lib/libfreetype.so.6',
154
 
    '/usr/lib/libpng12.so.0',
155
 
    '/usr/lib/libBLT.2.4.so.8.4',
156
 
    '/usr/lib/libtk8.4.so.0',
157
 
    '/usr/lib/libtcl8.4.so.0',
158
 
    '/usr/lib/tcl8.4/init.tcl',
159
 
    '/usr/lib/libX11.so.6',
160
 
    '/usr/lib/libXau.so.6',
161
 
    '/usr/lib/libXdmcp.so.6',
162
 
    '/lib/libgcc_s.so.1',
163
 
    '/etc/matplotlibrc',
164
 
    # Needed for resolv
165
 
    '/lib/libnss_dns.so.2',
166
 
    '/lib/libnss_mdns4_minimal.so.2',
167
 
    '/etc/hosts',
168
 
    '/etc/resolv.conf',
169
 
    #'/etc/hosts.conf',
170
 
    #'/etc/hostname',
171
 
    '/etc/nsswitch.conf',
172
 
    '/lib/libnss_files.so.2',
173
 
]
174
 
# Symlinks to make within the jail. Src mapped to dst.
175
 
JAIL_LINKS = {
176
 
    'python%s' % PYTHON_VERSION: 'jail/usr/bin/python',
177
 
}
178
 
# Trees to copy. Src mapped to dst (these will be passed to action_copytree).
179
 
JAIL_COPYTREES = {
180
 
    '/usr/lib/python%s' % PYTHON_VERSION:
181
 
        'jail/usr/lib/python%s' % PYTHON_VERSION,
182
 
    '/usr/share/matplotlib': 'jail/usr/share/matplotlib',
183
 
    '/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
184
 
    '/usr/share/nltk': 'jail/usr/share/nltk',
185
 
}
186
 
 
187
 
class ConfigOption:
188
 
    """A configuration option; one of the things written to conf.py."""
189
 
    def __init__(self, option_name, default, prompt, comment):
190
 
        """Creates a configuration option.
191
 
        option_name: Name of the variable in conf.py. Also name of the
192
 
            command-line argument to setup.py conf.
193
 
        default: Default value for this variable.
194
 
        prompt: (Short) string presented during the interactive prompt in
195
 
            setup.py conf.
196
 
        comment: (Long) comment string stored in conf.py. Each line of this
197
 
            string should begin with a '#'.
198
 
        """
199
 
        self.option_name = option_name
200
 
        self.default = default
201
 
        self.prompt = prompt
202
 
        self.comment = comment
203
 
 
204
 
# Configuration options, defaults and descriptions
205
 
config_options = []
206
 
config_options.append(ConfigOption("root_dir", "/",
207
 
    """Root directory where IVLE is located (in URL space):""",
208
 
    """
209
 
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
210
 
# with this).
211
 
# eg. "/" or "/ivle"."""))
212
 
config_options.append(ConfigOption("ivle_install_dir", "/opt/ivle",
213
 
    'Root directory where IVLE will be installed (on the local file '
214
 
    'system):',
215
 
    """
216
 
# In the local file system, where IVLE is actually installed.
217
 
# This directory should contain the "www" and "bin" directories."""))
218
 
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
219
 
    """Location of Directories
220
 
=======================
221
 
Root directory where the jails (containing user files) are stored
222
 
(on the local file system):""",
223
 
    """
224
 
# In the local file system, where are the student/user file spaces located.
225
 
# The user jails are expected to be located immediately in subdirectories of
226
 
# this location."""))
227
 
config_options.append(ConfigOption("subjects_base",
228
 
    "/home/informatics/subjects",
229
 
    """Root directory where the subject directories (containing worksheets
230
 
and other per-subject files) are stored (on the local file system):""",
231
 
    """
232
 
# In the local file system, where are the per-subject file spaces located.
233
 
# The individual subject directories are expected to be located immediately
234
 
# in subdirectories of this location."""))
235
 
config_options.append(ConfigOption("exercises_base",
236
 
    "/home/informatics/exercises",
237
 
    """Root directory where the exercise directories (containing
238
 
subject-independent exercise sheets) are stored (on the local file
239
 
system):""",
240
 
    """
241
 
# In the local file system, where are the subject-independent exercise sheet
242
 
# file spaces located."""))
243
 
config_options.append(ConfigOption("tos_path",
244
 
    "/home/informatics/tos.html",
245
 
    """Location where the Terms of Service document is stored (on the local
246
 
    file system):""",
247
 
    """
248
 
# In the local file system, where is the Terms of Service document located."""))
249
 
config_options.append(ConfigOption("public_host", "public.localhost",
250
 
    """Hostname which will cause the server to go into "public mode",
251
 
providing login-free access to student's published work:""",
252
 
    """
253
 
# The server goes into "public mode" if the browser sends a request with this
254
 
# host. This is for security reasons - we only serve public student files on a
255
 
# separate domain to the main IVLE site.
256
 
# Public mode does not use cookies, and serves only public content.
257
 
# Private mode (normal mode) requires login, and only serves files relevant to
258
 
# the logged-in user."""))
259
 
config_options.append(ConfigOption("allowed_uids", "33",
260
 
    """UID of the web server process which will run IVLE.
261
 
Only this user may execute the trampoline. May specify multiple users as
262
 
a comma-separated list.
263
 
    (eg. "1002,78")""",
264
 
    """
265
 
# The User-ID of the web server process which will run IVLE, and any other
266
 
# users who are allowed to run the trampoline. This is stores as a string of
267
 
# comma-separated integers, simply because it is not used within Python, only
268
 
# used by the setup program to write to conf.h (see setup.py config)."""))
269
 
config_options.append(ConfigOption("db_host", "localhost",
270
 
    """PostgreSQL Database config
271
 
==========================
272
 
Hostname of the DB server:""",
273
 
    """
274
 
### PostgreSQL Database config ###
275
 
# Database server hostname"""))
276
 
config_options.append(ConfigOption("db_port", "5432",
277
 
    """Port of the DB server:""",
278
 
    """
279
 
# Database server port"""))
280
 
config_options.append(ConfigOption("db_dbname", "ivle",
281
 
    """Database name:""",
282
 
    """
283
 
# Database name"""))
284
 
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
285
 
    """Forum Database name:""",
286
 
    """
287
 
# Forum Database name"""))
288
 
config_options.append(ConfigOption("db_user", "postgres",
289
 
    """Username for DB server login:""",
290
 
    """
291
 
# Database username"""))
292
 
config_options.append(ConfigOption("db_password", "",
293
 
    """Password for DB server login:
294
 
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
295
 
    """
296
 
# Database password"""))
297
 
config_options.append(ConfigOption("auth_modules", "ldap_auth",
298
 
    """Authentication config
299
 
=====================
300
 
Comma-separated list of authentication modules. Only "ldap" is available
301
 
by default.""",
302
 
    """
303
 
# Comma-separated list of authentication modules.
304
 
# These refer to importable Python modules in the www/auth directory.
305
 
# Modules "ldap" and "guest" are available in the source tree, but
306
 
# other modules may be plugged in to auth against organisation-specific
307
 
# auth backends."""))
308
 
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
309
 
    """(LDAP options are only relevant if "ldap" is included in the list of
310
 
auth modules).
311
 
URL for LDAP authentication server:""",
312
 
    """
313
 
# URL for LDAP authentication server"""))
314
 
config_options.append(ConfigOption("ldap_format_string",
315
 
    "uid=%s,ou=users,o=example",
316
 
    """Format string for LDAP auth request:
317
 
    (Must contain a single "%s" for the user's login name)""",
318
 
    """
319
 
# Format string for LDAP auth request
320
 
# (Must contain a single "%s" for the user's login name)"""))
321
 
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
322
 
    """Subversion config
323
 
=================
324
 
The base url for accessing subversion repositories:""",
325
 
    """
326
 
# The base url for accessing subversion repositories."""))
327
 
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
328
 
    """The location of the subversion configuration file used by apache
329
 
to host the user repositories:""",
330
 
    """
331
 
# The location of the subversion configuration file used by
332
 
# apache to host the user repositories."""))
333
 
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
334
 
    """The root directory for the subversion repositories:""",
335
 
    """
336
 
# The root directory for the subversion repositories."""))
337
 
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
338
 
    """The location of the password file used to authenticate users
339
 
of the subversion repository from the ivle server:""",
340
 
    """
341
 
# The location of the password file used to authenticate users
342
 
# of the subversion repository from the ivle server."""))
343
 
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
344
 
    """The location of the password file used to authenticate local users
345
 
of the subversion repository:""",
346
 
    """
347
 
# The location of the password file used to authenticate local users
348
 
# of the subversion repository."""))
349
 
config_options.append(ConfigOption("usrmgt_host", "localhost",
350
 
    """User Management Server config
351
 
============================
352
 
The hostname where the usrmgt-server runs:""",
353
 
    """
354
 
# The hostname where the usrmgt-server runs."""))
355
 
config_options.append(ConfigOption("usrmgt_port", "2178",
356
 
    """The port where the usrmgt-server runs:""",
357
 
    """
358
 
# The port where the usrmgt-server runs."""))
359
 
config_options.append(ConfigOption("usrmgt_magic", "",
360
 
    """The password for the usrmgt-server:""",
361
 
    """
362
 
# The password for the usrmgt-server."""))
363
70
 
364
71
# Try importing existing conf, but if we can't just set up defaults
365
72
# The reason for this is that these settings are used by other phases
366
73
# of setup besides conf, so we need to know them.
367
74
# Also this allows you to hit Return to accept the existing value.
368
75
try:
369
 
    confmodule = __import__("lib/conf/conf")
370
 
    for opt in config_options:
371
 
        try:
372
 
            globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
373
 
        except:
374
 
            globals()[opt.option_name] = opt.default
 
76
    confmodule = __import__("www/conf/conf")
 
77
    try:
 
78
        root_dir = confmodule.root_dir
 
79
    except:
 
80
        root_dir = "/ivle"
 
81
    try:
 
82
        ivle_install_dir = confmodule.ivle_install_dir
 
83
    except:
 
84
        ivle_install_dir = "/opt/ivle"
 
85
    try:
 
86
        jail_base = confmodule.jail_base
 
87
    except:
 
88
        jail_base = "/home/informatics/jails"
375
89
except ImportError:
376
90
    # Just set reasonable defaults
377
 
    for opt in config_options:
378
 
        globals()[opt.option_name] = opt.default
 
91
    root_dir = "/ivle"
 
92
    ivle_install_dir = "/opt/ivle"
 
93
    jail_base = "/home/informatics/jails"
 
94
# Always defaults
 
95
allowed_uids = "0"
379
96
 
380
97
# Try importing install_list, but don't fail if we can't, because listmake can
381
98
# function without it.
390
107
# as necessary, and include it in the distribution.
391
108
listmake_mimetypes = ['text/x-python', 'text/html',
392
109
    'application/x-javascript', 'application/javascript',
393
 
    'text/css', 'image/png', 'image/gif', 'application/xml']
 
110
    'text/css', 'image/png']
394
111
 
395
112
# Main function skeleton from Guido van Rossum
396
113
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
419
136
        return 1
420
137
 
421
138
    # Disallow run as root unless installing
422
 
    if (operation != 'install' and operation != 'updatejails'
423
 
        and os.geteuid() == 0):
 
139
    if operation != 'install' and os.geteuid() == 0:
424
140
        print >>sys.stderr, "I do not want to run this stage as root."
425
141
        print >>sys.stderr, "Please run as a normal user."
426
142
        return 1
428
144
    try:
429
145
        oper_func = {
430
146
            'help' : help,
431
 
            'config' : conf,
 
147
            'conf' : conf,
432
148
            'build' : build,
433
149
            'listmake' : listmake,
434
150
            'install' : install,
435
 
            'updatejails' : updatejails,
436
151
        }[operation]
437
152
    except KeyError:
438
153
        print >>sys.stderr, (
449
164
Operation (and args) can be:
450
165
    help [operation]
451
166
    listmake (developer use only)
452
 
    config [args]
 
167
    conf [args]
453
168
    build
454
 
    install [--nojail] [--nosubjects] [-n|--dry]
 
169
    install [--nojail] [-n|--dry]
455
170
"""
456
171
        return 1
457
172
    elif len(args) != 1:
470
185
be copied upon installation. This should be run by the developer before
471
186
cutting a distribution, and the listfile it generates should be included in
472
187
the distribution, avoiding the administrator having to run it."""
473
 
    elif operation == 'config':
474
 
        print """python setup.py config [args]
 
188
    elif operation == 'conf':
 
189
        print """python setup.py conf [args]
475
190
Configures IVLE with machine-specific details, most notably, various paths.
476
191
Either prompts the administrator for these details or accepts them as
477
192
command-line args. Will be interactive only if there are no arguments given.
481
196
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
482
197
directory, and run build/install one time.
483
198
 
484
 
Creates lib/conf/conf.py and trampoline/conf.h.
 
199
Creates www/conf/conf.py and trampoline/conf.h.
485
200
 
486
 
Args are:"""
487
 
        for opt in config_options:
488
 
            print "    --" + opt.option_name
489
 
        print """As explained in the interactive prompt or conf.py.
 
201
Args are:
 
202
    --root_dir
 
203
    --ivle_install_dir
 
204
    --jail_base
 
205
    --allowed_uids
 
206
As explained in the interactive prompt or conf.py.
490
207
"""
491
208
    elif operation == 'build':
492
209
        print """python -O setup.py build [--dry|-n]
503
220
 
504
221
--dry | -n  Print out the actions but don't do anything."""
505
222
    elif operation == 'install':
506
 
        print """sudo python setup.py install [--nojail] [--nosubjects][--dry|-n]
 
223
        print """sudo python setup.py install [--nojail] [--dry|-n]
507
224
(Requires root)
508
225
Create target install directory ($target).
509
226
Create $target/bin.
511
228
chown and chmod the installed trampoline.
512
229
Copy www/ to $target.
513
230
Copy jail/ to jails template directory (unless --nojail specified).
514
 
Copy subjects/ to subjects directory (unless --nosubjects specified).
515
 
 
516
 
--nojail        Do not copy the jail.
517
 
--nosubjects    Do not copy the subjects and exercises directories.
518
 
--dry | -n  Print out the actions but don't do anything."""
519
 
    elif operation == 'updatejails':
520
 
        print """sudo python setup.py updatejails [--dry|-n]
521
 
(Requires root)
522
 
Copy jail/ to each subdirectory in jails directory.
523
 
 
 
231
 
 
232
--nojail    Do not copy the jail.
524
233
--dry | -n  Print out the actions but don't do anything."""
525
234
    else:
526
235
        print >>sys.stderr, (
531
240
def listmake(args):
532
241
    # We build two separate lists, by walking www and console
533
242
    list_www = build_list_py_files('www')
534
 
    list_lib = build_list_py_files('lib')
535
 
    list_subjects = build_list_py_files('subjects', no_top_level=True)
536
 
    list_exercises = build_list_py_files('exercises', no_top_level=True)
537
 
    list_scripts = [
538
 
        "scripts/python-console",
539
 
        "scripts/fileservice",
540
 
        "scripts/serveservice",
541
 
        "scripts/usrmgt-server",
542
 
        "scripts/diffservice",
543
 
    ]
 
243
    list_console = build_list_py_files('console')
544
244
    # Make sure that the files generated by conf are in the list
545
245
    # (since listmake is typically run before conf)
546
 
    if "lib/conf/conf.py" not in list_lib:
547
 
        list_lib.append("lib/conf/conf.py")
 
246
    if "www/conf/conf.py" not in list_www:
 
247
        list_www.append("www/conf/conf.py")
 
248
    # Make sure that console/python-console is in the list
 
249
    if "console/python-console" not in list_console:
 
250
        list_console.append("console/python-console")
548
251
    # Write these out to a file
549
252
    cwd = os.getcwd()
550
253
    # the files that will be created/overwritten
564
267
list_www = """)
565
268
        writelist_pretty(file, list_www)
566
269
        file.write("""
567
 
# List of all installable files in lib directory.
568
 
list_lib = """)
569
 
        writelist_pretty(file, list_lib)
570
 
        file.write("""
571
 
# List of all installable files in scripts directory.
572
 
list_scripts = """)
573
 
        writelist_pretty(file, list_scripts)
574
 
        file.write("""
575
 
# List of all installable files in subjects directory.
576
 
# This is to install sample subjects and material.
577
 
list_subjects = """)
578
 
        writelist_pretty(file, list_subjects)
579
 
        file.write("""
580
 
# List of all installable files in exercises directory.
581
 
# This is to install sample exercise material.
582
 
list_exercises = """)
583
 
        writelist_pretty(file, list_exercises)
 
270
# List of all installable files in console directory.
 
271
list_console = """)
 
272
        writelist_pretty(file, list_console)
584
273
 
585
274
        file.close()
586
275
    except IOError, (errno, strerror):
597
286
 
598
287
    return 0
599
288
 
600
 
def build_list_py_files(dir, no_top_level=False):
 
289
def build_list_py_files(dir):
601
290
    """Builds a list of all py files found in a directory and its
602
 
    subdirectories. Returns this as a list of strings.
603
 
    no_top_level=True means the file paths will not include the top-level
604
 
    directory.
605
 
    """
 
291
    subdirectories. Returns this as a list of strings."""
606
292
    pylist = []
607
293
    for (dirpath, dirnames, filenames) in os.walk(dir):
608
294
        # Exclude directories beginning with a '.' (such as '.svn')
610
296
        # All *.py files are added to the list
611
297
        pylist += [os.path.join(dirpath, item) for item in filenames
612
298
            if mimetypes.guess_type(item)[0] in listmake_mimetypes]
613
 
    if no_top_level:
614
 
        for i in range(0, len(pylist)):
615
 
            _, pylist[i] = pylist[i].split(os.sep, 1)
616
299
    return pylist
617
300
 
618
301
def writelist_pretty(file, list):
626
309
        file.write(']\n')
627
310
 
628
311
def conf(args):
629
 
    global db_port, usrmgt_port
 
312
    global root_dir, ivle_install_dir, jail_base, allowed_uids
630
313
    # Set up some variables
631
314
 
632
315
    cwd = os.getcwd()
633
316
    # the files that will be created/overwritten
634
 
    conffile = os.path.join(cwd, "lib/conf/conf.py")
635
 
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
 
317
    conffile = os.path.join(cwd, "www/conf/conf.py")
636
318
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
637
 
    phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
638
 
    usrmgtserver_initdfile = os.path.join(cwd, "doc/setup/usrmgt-server.init")
639
319
 
640
320
    # Get command-line arguments to avoid asking questions.
641
321
 
642
 
    optnames = []
643
 
    for opt in config_options:
644
 
        optnames.append(opt.option_name + "=")
645
 
    (opts, args) = getopt.gnu_getopt(args, "", optnames)
 
322
    (opts, args) = getopt.gnu_getopt(args, "", ['root_dir=',
 
323
                    'ivle_install_dir=', 'jail_base=', 'allowed_uids='])
646
324
 
647
325
    if args != []:
648
326
        print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
654
332
        print """This tool will create the following files:
655
333
    %s
656
334
    %s
657
 
    %s
658
 
    %s
659
 
    %s
660
335
prompting you for details about your configuration. The file will be
661
336
overwritten if it already exists. It will *not* install or deploy IVLE.
662
337
 
663
338
Please hit Ctrl+C now if you do not wish to do this.
664
 
""" % (conffile, jailconffile, conf_hfile, phpBBconffile, usrmgtserver_initdfile)
 
339
""" % (conffile, conf_hfile)
665
340
 
666
341
        # Get information from the administrator
667
342
        # If EOF is encountered at any time during the questioning, just exit
668
343
        # silently
669
344
 
670
 
        for opt in config_options:
671
 
            globals()[opt.option_name] = \
672
 
                query_user(globals()[opt.option_name], opt.prompt)
 
345
        root_dir = query_user(root_dir,
 
346
        """Root directory where IVLE is located (in URL space):""")
 
347
        ivle_install_dir = query_user(ivle_install_dir,
 
348
        'Root directory where IVLE will be installed (on the local file '
 
349
        'system):')
 
350
        jail_base = query_user(jail_base,
 
351
        """Root directory where the jails (containing user files) are stored
 
352
(on the local file system):""")
 
353
        allowed_uids = query_user(allowed_uids,
 
354
        """UID of the web server process which will run IVLE.
 
355
Only this user may execute the trampoline. May specify multiple users as
 
356
a comma-separated list.
 
357
    (eg. "1002,78")""")
 
358
 
673
359
    else:
674
360
        opts = dict(opts)
675
361
        # Non-interactive mode. Parse the options.
676
 
        for opt in config_options:
677
 
            if '--' + opt.option_name in opts:
678
 
                globals()[opt.option_name] = opts['--' + opt.option_name]
 
362
        if '--root_dir' in opts:
 
363
            root_dir = opts['--root_dir']
 
364
        if '--ivle_install_dir' in opts:
 
365
            ivle_install_dir = opts['--ivle_install_dir']
 
366
        if '--jail_base' in opts:
 
367
            jail_base = opts['--jail_base']
 
368
        if '--allowed_uids' in opts:
 
369
            allowed_uids = opts['--allowed_uids']
679
370
 
680
371
    # Error handling on input values
681
372
    try:
682
 
        allowed_uids_list = map(int, allowed_uids.split(','))
 
373
        allowed_uids = map(int, allowed_uids.split(','))
683
374
    except ValueError:
684
375
        print >>sys.stderr, (
685
376
        "Invalid UID list (%s).\n"
686
377
        "Must be a comma-separated list of integers." % allowed_uids)
687
378
        return 1
688
 
    try:
689
 
        db_port = int(db_port)
690
 
        if db_port < 0 or db_port >= 65536: raise ValueError()
691
 
    except ValueError:
692
 
        print >>sys.stderr, (
693
 
        "Invalid DB port (%s).\n"
694
 
        "Must be an integer between 0 and 65535." % repr(db_port))
695
 
        return 1
696
 
    try:
697
 
        usrmgt_port = int(usrmgt_port)
698
 
        if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
699
 
    except ValueError:
700
 
        print >>sys.stderr, (
701
 
        "Invalid user management port (%s).\n"
702
 
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
703
 
        return 1
704
 
 
705
 
    # Generate the forum secret
706
 
    forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
707
 
 
708
 
    # Write lib/conf/conf.py
 
379
 
 
380
    # Write www/conf/conf.py
709
381
 
710
382
    try:
711
383
        conf = open(conffile, "w")
714
386
# conf.py
715
387
# Miscellaneous application settings
716
388
 
717
 
""")
718
 
        for opt in config_options:
719
 
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
720
 
                repr(globals()[opt.option_name])))
721
 
 
722
 
        # Add the forum secret to the config file (regenerated each config)
723
 
        conf.write('forum_secret = "%s"\n' % (forum_secret))
724
 
 
725
 
        conf.close()
726
 
    except IOError, (errno, strerror):
727
 
        print "IO error(%s): %s" % (errno, strerror)
728
 
        sys.exit(1)
729
 
 
730
 
    print "Successfully wrote lib/conf/conf.py"
731
 
 
732
 
    # Write conf/jailconf.py
733
 
 
734
 
    try:
735
 
        conf = open(jailconffile, "w")
736
 
 
737
 
        # In the "in-jail" version of conf, we don't need MOST of the details
738
 
        # (it would be a security risk to have them here).
739
 
        # So we just write root_dir, and jail_base is "/".
740
 
        # (jail_base being "/" means "jail-relative" paths are relative to "/"
741
 
        # when inside the jail.)
742
 
        conf.write("""# IVLE Configuration File
743
 
# conf.py
744
 
# Miscellaneous application settings
745
 
# (User jail version)
746
 
 
747
389
 
748
390
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
749
391
# with this).
750
392
# eg. "/" or "/ivle".
751
 
root_dir = %s
 
393
root_dir = "%s"
 
394
 
 
395
# In the local file system, where IVLE is actually installed.
 
396
# This directory should contain the "www" and "bin" directories.
 
397
ivle_install_dir = "%s"
752
398
 
753
399
# In the local file system, where are the student/user file spaces located.
754
400
# The user jails are expected to be located immediately in subdirectories of
755
401
# this location.
756
 
jail_base = '/'
757
 
 
758
 
# The hostname for serving publicly accessible pages
759
 
public_host = %s
760
 
""" % (repr(root_dir),repr(public_host)))
 
402
jail_base = "%s"
 
403
""" % (root_dir, ivle_install_dir, jail_base))
761
404
 
762
405
        conf.close()
763
406
    except IOError, (errno, strerror):
764
407
        print "IO error(%s): %s" % (errno, strerror)
765
408
        sys.exit(1)
766
409
 
767
 
    print "Successfully wrote lib/conf/jailconf.py"
 
410
    print "Successfully wrote www/conf/conf.py"
768
411
 
769
412
    # Write trampoline/conf.h
770
413
 
789
432
 * (Note that root is an implicit member of this list).
790
433
 */
791
434
static const int allowed_uids[] = { %s };
792
 
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
793
 
    # Note: The above uses PYTHON reprs, not C reprs
794
 
    # However they should be the same with the exception of the outer
795
 
    # characters, which are stripped off and replaced
 
435
""" % (jail_base, repr(allowed_uids)[1:-1]))
796
436
 
797
437
        conf.close()
798
438
    except IOError, (errno, strerror):
801
441
 
802
442
    print "Successfully wrote trampoline/conf.h"
803
443
 
804
 
    # Write www/php/phpBB3/config.php
805
 
 
806
 
    try:
807
 
        conf = open(phpBBconffile, "w")
808
 
        
809
 
        # php-pg work around
810
 
        if db_host == 'localhost':
811
 
            forumdb_host = '127.0.0.1'
812
 
        else:
813
 
            forumdb_host = db_host
814
 
 
815
 
        conf.write( """<?php
816
 
// phpBB 3.0.x auto-generated configuration file
817
 
// Do not change anything in this file!
818
 
$dbms = 'postgres';
819
 
$dbhost = '""" + forumdb_host + """';
820
 
$dbport = '""" + str(db_port) + """';
821
 
$dbname = '""" + db_forumdbname + """';
822
 
$dbuser = '""" + db_user + """';
823
 
$dbpasswd = '""" + db_password + """';
824
 
 
825
 
$table_prefix = 'phpbb_';
826
 
$acm_type = 'file';
827
 
$load_extensions = '';
828
 
@define('PHPBB_INSTALLED', true);
829
 
// @define('DEBUG', true);
830
 
//@define('DEBUG_EXTRA', true);
831
 
 
832
 
$forum_secret = '""" + forum_secret +"""';
833
 
?>"""   )
834
 
    
835
 
        conf.close()
836
 
    except IOError, (errno, strerror):
837
 
        print "IO error(%s): %s" % (errno, strerror)
838
 
        sys.exit(1)
839
 
 
840
 
    print "Successfully wrote www/php/phpBB3/config.php"
841
 
 
842
 
    # Write lib/conf/usrmgt-server.init
843
 
 
844
 
    try:
845
 
        conf = open(usrmgtserver_initdfile, "w")
846
 
 
847
 
        conf.write( '''#! /bin/sh
848
 
 
849
 
# Works for Ubuntu. Check before using on other distributions
850
 
 
851
 
### BEGIN INIT INFO
852
 
# Provides:          usrmgt-server
853
 
# Required-Start:    $syslog $networking $urandom
854
 
# Required-Stop:     $syslog
855
 
# Default-Start:     2 3 4 5
856
 
# Default-Stop:      1
857
 
# Short-Description: IVLE user management server
858
 
# Description:       Daemon connecting to the IVLE user management database.
859
 
### END INIT INFO
860
 
 
861
 
PATH=/sbin:/bin:/usr/sbin:/usr/bin
862
 
DESC="IVLE user management server"
863
 
NAME=usrmgt-server
864
 
DAEMON=/opt/ivle/scripts/$NAME
865
 
DAEMON_ARGS="''' + str(usrmgt_port) + ''' ''' + usrmgt_magic + '''"
866
 
PIDFILE=/var/run/$NAME.pid
867
 
SCRIPTNAME=/etc/init.d/usrmgt-server
868
 
 
869
 
# Exit if the daemon does not exist 
870
 
test -f $DAEMON || exit 0
871
 
 
872
 
# Load the VERBOSE setting and other rcS variables
873
 
[ -f /etc/default/rcS ] && . /etc/default/rcS
874
 
 
875
 
# Define LSB log_* functions.
876
 
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
877
 
. /lib/lsb/init-functions
878
 
 
879
 
#
880
 
# Function that starts the daemon/service
881
 
#
882
 
do_start()
883
 
{
884
 
        # Return
885
 
        #   0 if daemon has been started
886
 
        #   1 if daemon was already running
887
 
        #   2 if daemon could not be started
888
 
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
889
 
                || return 1
890
 
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
891
 
                $DAEMON_ARGS \
892
 
                || return 2
893
 
        # Add code here, if necessary, that waits for the process to be ready
894
 
        # to handle requests from services started subsequently which depend
895
 
        # on this one.  As a last resort, sleep for some time.
896
 
}
897
 
 
898
 
#
899
 
# Function that stops the daemon/service
900
 
#
901
 
do_stop()
902
 
{
903
 
        # Return
904
 
        #   0 if daemon has been stopped
905
 
        #   1 if daemon was already stopped
906
 
        #   2 if daemon could not be stopped
907
 
        #   other if a failure occurred
908
 
        start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
909
 
        RETVAL="$?"
910
 
        [ "$RETVAL" = 2 ] && return 2
911
 
        # Wait for children to finish too if this is a daemon that forks
912
 
        # and if the daemon is only ever run from this initscript.
913
 
        # If the above conditions are not satisfied then add some other code
914
 
        # that waits for the process to drop all resources that could be
915
 
        # needed by services started subsequently.  A last resort is to
916
 
        # sleep for some time.
917
 
        start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
918
 
        [ "$?" = 2 ] && return 2
919
 
        # Many daemons don't delete their pidfiles when they exit.
920
 
        rm -f $PIDFILE
921
 
        return "$RETVAL"
922
 
}
923
 
 
924
 
#
925
 
# Function that sends a SIGHUP to the daemon/service
926
 
#
927
 
do_reload() {
928
 
        #
929
 
        # If the daemon can reload its configuration without
930
 
        # restarting (for example, when it is sent a SIGHUP),
931
 
        # then implement that here.
932
 
        #
933
 
        start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
934
 
        return 0
935
 
}
936
 
 
937
 
case "$1" in
938
 
  start)
939
 
    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
940
 
        do_start
941
 
        case "$?" in
942
 
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
943
 
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
944
 
        esac
945
 
        ;;
946
 
  stop)
947
 
        [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
948
 
        do_stop
949
 
        case "$?" in
950
 
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
951
 
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
952
 
        esac
953
 
        ;;
954
 
  #reload|force-reload)
955
 
        #
956
 
        # If do_reload() is not implemented then leave this commented out
957
 
        # and leave 'force-reload' as an alias for 'restart'.
958
 
        #
959
 
        #log_daemon_msg "Reloading $DESC" "$NAME"
960
 
        #do_reload
961
 
        #log_end_msg $?
962
 
        #;;
963
 
  restart|force-reload)
964
 
        #
965
 
        # If the "reload" option is implemented then remove the
966
 
        # 'force-reload' alias
967
 
        #
968
 
        log_daemon_msg "Restarting $DESC" "$NAME"
969
 
        do_stop
970
 
        case "$?" in
971
 
          0|1)
972
 
                do_start
973
 
                case "$?" in
974
 
                        0) log_end_msg 0 ;;
975
 
                        1) log_end_msg 1 ;; # Old process is still running
976
 
                        *) log_end_msg 1 ;; # Failed to start
977
 
                esac
978
 
                ;;
979
 
          *)
980
 
                # Failed to stop
981
 
                log_end_msg 1
982
 
                ;;
983
 
        esac
984
 
        ;;
985
 
  *)
986
 
        #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
987
 
        echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
988
 
        exit 3
989
 
        ;;
990
 
esac
991
 
 
992
 
:
993
 
''')
994
 
        
995
 
        conf.close()
996
 
    except IOError, (errno, strerror):
997
 
        print "IO error(%s): %s" % (errno, strerror)
998
 
        sys.exit(1)
999
 
 
1000
 
    # fix permissions as the file contains the database password
1001
 
    try:
1002
 
        os.chmod('doc/setup/usrmgt-server.init', 0600)
1003
 
    except OSError, (errno, strerror):
1004
 
        print "WARNING: Couldn't chmod doc/setup/usrmgt-server.init:"
1005
 
        print "OS error(%s): %s" % (errno, strerror)
1006
 
 
1007
 
    print "Successfully wrote lib/conf/usrmgt-server.init"
1008
 
 
1009
444
    print
1010
445
    print "You may modify the configuration at any time by editing"
1011
446
    print conffile
1012
 
    print jailconffile
1013
447
    print conf_hfile
1014
 
    print phpBBconffile
1015
 
    print usrmgtserver_initdfile
1016
448
    print
1017
449
    return 0
1018
450
 
1026
458
        print "Dry run (no actions will be executed\n"
1027
459
 
1028
460
    # Compile the trampoline
1029
 
    curdir = os.getcwd()
1030
 
    os.chdir('trampoline')
1031
 
    action_runprog('make', [], dry)
1032
 
    os.chdir(curdir)
 
461
    action_runprog('gcc', ['-Wall', '-o', 'trampoline/trampoline',
 
462
        'trampoline/trampoline.c'], dry)
1033
463
 
1034
464
    # Create the jail and its subdirectories
1035
465
    # Note: Other subdirs will be made by copying files
1037
467
    action_mkdir('jail/home', dry)
1038
468
    action_mkdir('jail/tmp', dry)
1039
469
 
1040
 
    # Chmod the tmp directory to world writable
1041
 
    action_chmod_w('jail/tmp', dry)
1042
 
 
1043
470
    # Copy all console and operating system files into the jail
1044
 
    action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
 
471
    action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
1045
472
    copy_os_files_jail(dry)
1046
 
    # Chmod the python console
1047
 
    action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
1048
 
    action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
1049
 
    action_chmod_x('jail/opt/ivle/scripts/serveservice', dry)
1050
 
    
1051
 
    # Also copy the IVLE lib directory into the jail
1052
 
    # This is necessary for running certain scripts
1053
 
    action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
1054
 
    # IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
1055
 
    # which could compromise security if left in the jail (such as the DB
1056
 
    # password).
1057
 
    # The "safe" version is in jailconf.py. Delete conf.py and replace it with
1058
 
    # jailconf.py.
1059
 
    action_copyfile('lib/conf/jailconf.py',
1060
 
        'jail/opt/ivle/lib/conf/conf.py', dry)
1061
473
 
1062
474
    # Compile .py files into .pyc or .pyo files
1063
475
    compileall.compile_dir('www', quiet=True)
1064
 
    compileall.compile_dir('lib', quiet=True)
1065
 
    compileall.compile_dir('scripts', quiet=True)
1066
 
    compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
1067
 
 
1068
 
    # Set up ivle.pth inside the jail
1069
 
    # Need to set /opt/ivle/lib to be on the import path
1070
 
    ivle_pth = \
1071
 
        "jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
1072
 
    f = open(ivle_pth, 'w')
1073
 
    f.write('/opt/ivle/lib\n')
1074
 
    f.close()
 
476
    compileall.compile_dir('console', quiet=True)
1075
477
 
1076
478
    return 0
1077
479
 
1079
481
    """Copies necessary Operating System files from their usual locations
1080
482
    into the jail/ directory of the cwd."""
1081
483
    # Currently source paths are configured for Ubuntu.
1082
 
    for filename in JAIL_FILES:
1083
 
        copy_file_to_jail(filename, dry)
1084
 
    for src, dst in JAIL_LINKS.items():
1085
 
        action_symlink(src, dst, dry)
1086
 
    for src, dst in JAIL_COPYTREES.items():
1087
 
        action_copytree(src, dst, dry)
 
484
    copy_file_to_jail('/lib/ld-linux.so.2', dry)
 
485
    copy_file_to_jail('/lib/tls/i686/cmov/libc.so.6', dry)
 
486
    copy_file_to_jail('/lib/tls/i686/cmov/libdl.so.2', dry)
 
487
    copy_file_to_jail('/lib/tls/i686/cmov/libm.so.6', dry)
 
488
    copy_file_to_jail('/lib/tls/i686/cmov/libpthread.so.0', dry)
 
489
    copy_file_to_jail('/lib/tls/i686/cmov/libutil.so.1', dry)
 
490
    copy_file_to_jail('/usr/bin/python2.5', dry)
 
491
    action_symlink('python2.5', 'jail/usr/bin/python', dry)
 
492
    action_copytree('/usr/lib/python2.5', 'jail/usr/lib/python2.5', dry)
1088
493
 
1089
494
def copy_file_to_jail(src, dry):
1090
495
    """Copies a single file from an absolute location into the same location
1094
499
 
1095
500
def install(args):
1096
501
    # Get "dry" and "nojail" variables from command line
1097
 
    (opts, args) = getopt.gnu_getopt(args, "n",
1098
 
        ['dry', 'nojail', 'nosubjects'])
 
502
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry', 'nojail'])
1099
503
    opts = dict(opts)
1100
504
    dry = '-n' in opts or '--dry' in opts
1101
505
    nojail = '--nojail' in opts
1102
 
    nosubjects = '--nosubjects' in opts
1103
506
 
1104
507
    if dry:
1105
508
        print "Dry run (no actions will be executed\n"
1119
522
    # chown trampoline to root and set setuid bit
1120
523
    action_chown_setuid(tramppath, dry)
1121
524
 
1122
 
    # Create a scripts directory to put the usrmgt-server in.
1123
 
    action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
1124
 
    usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
1125
 
    action_copyfile('scripts/usrmgt-server', usrmgtpath, dry)
1126
 
    action_chmod_x(usrmgtpath, dry)
1127
 
 
1128
 
    # Copy the www and lib directories using the list
 
525
    # Copy the www directory using the list
1129
526
    action_copylist(install_list.list_www, ivle_install_dir, dry)
1130
 
    action_copylist(install_list.list_lib, ivle_install_dir, dry)
1131
 
    
1132
 
    # Copy the php directory
1133
 
    forum_dir = "www/php/phpBB3"
1134
 
    forum_path = os.path.join(ivle_install_dir, forum_dir)
1135
 
    action_copytree(forum_dir, forum_path, dry)
1136
 
    print "chown -R www-data:www-data %s" % forum_path
1137
 
    if not dry:
1138
 
        os.system("chown -R www-data:www-data %s" % forum_path)
1139
527
 
1140
528
    if not nojail:
1141
529
        # Copy the local jail directory built by the build action
1142
530
        # to the jails template directory (it will be used as a template
1143
531
        # for all the students' jails).
1144
532
        action_copytree('jail', os.path.join(jail_base, 'template'), dry)
1145
 
    if not nosubjects:
1146
 
        # Copy the subjects and exercises directories across
1147
 
        action_copylist(install_list.list_subjects, subjects_base, dry,
1148
 
            srcdir="./subjects")
1149
 
        action_copylist(install_list.list_exercises, exercises_base, dry,
1150
 
            srcdir="./exercises")
1151
 
 
1152
 
    # Append IVLE path to ivle.pth in python site packages
1153
 
    # (Unless it's already there)
1154
 
    ivle_pth = os.path.join(sys.prefix,
1155
 
        "lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
1156
 
    ivle_www = os.path.join(ivle_install_dir, "www")
1157
 
    ivle_lib = os.path.join(ivle_install_dir, "lib")
1158
 
    write_ivle_pth = True
1159
 
    write_ivle_lib_pth = True
1160
 
    try:
1161
 
        file = open(ivle_pth, 'r')
1162
 
        for line in file:
1163
 
            if line.strip() == ivle_www:
1164
 
                write_ivle_pth = False
1165
 
            elif line.strip() == ivle_lib:
1166
 
                write_ivle_lib_pth = False
1167
 
        file.close()
1168
 
    except (IOError, OSError):
1169
 
        pass
1170
 
    if write_ivle_pth:
1171
 
        action_append(ivle_pth, ivle_www)
1172
 
    if write_ivle_lib_pth:
1173
 
        action_append(ivle_pth, ivle_lib)
1174
 
 
1175
 
    return 0
1176
 
 
1177
 
def updatejails(args):
1178
 
    # Get "dry" variable from command line
1179
 
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
1180
 
    opts = dict(opts)
1181
 
    dry = '-n' in opts or '--dry' in opts
1182
 
 
1183
 
    if dry:
1184
 
        print "Dry run (no actions will be executed\n"
1185
 
 
1186
 
    if not dry and os.geteuid() != 0:
1187
 
        print >>sys.stderr, "Must be root to run install"
1188
 
        print >>sys.stderr, "(I need to chown some files)."
1189
 
        return 1
1190
 
 
1191
 
    # Update the template jail directory in case it hasn't been installed
1192
 
    # recently.
1193
 
    action_copytree('jail', os.path.join(jail_base, 'template'), dry)
1194
 
 
1195
 
    # Re-link all the files in all students jails.
1196
 
    for dir in os.listdir(jail_base):
1197
 
        if dir == 'template': continue
1198
 
        # First back up the student's home directory
1199
 
        temp_home = os.tmpnam()
1200
 
        action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
1201
 
        # Delete the student's jail and relink the jail files
1202
 
        action_linktree(os.path.join(jail_base, 'template'),
1203
 
            os.path.join(jail_base, dir), dry)
1204
 
        # Restore the student's home directory
1205
 
        action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
1206
 
        # Set up the user's home directory just in case they don't have a
1207
 
        # directory for this yet
1208
 
        action_mkdir(os.path.join(jail_base, dir, 'home', dir), dry)
1209
533
 
1210
534
    return 0
1211
535
 
1238
562
    if ret != 0:
1239
563
        raise RunError(prog, ret)
1240
564
 
1241
 
def action_remove(path, dry):
1242
 
    """Calls rmtree, deleting the target file if it exists."""
1243
 
    try:
1244
 
        print "rm -r", path
1245
 
        if not dry:
1246
 
            shutil.rmtree(path, True)
1247
 
    except OSError, (err, msg):
1248
 
        if err != errno.EEXIST:
1249
 
            raise
1250
 
        # Otherwise, didn't exist, so we don't care
1251
 
 
1252
 
def action_rename(src, dst, dry):
1253
 
    """Calls rename. Deletes the target if it already exists."""
1254
 
    action_remove(dst, dry)
1255
 
    print "mv ", src, dst
1256
 
    if dry: return
1257
 
    try:
1258
 
        os.rename(src, dst)
1259
 
    except OSError, (err, msg):
1260
 
        if err != errno.EEXIST:
1261
 
            raise
1262
 
 
1263
565
def action_mkdir(path, dry):
1264
566
    """Calls mkdir. Silently ignored if the directory already exists.
1265
567
    Creates all parent directories as necessary."""
1277
579
    directories as necessary.
1278
580
 
1279
581
    See shutil.copytree."""
1280
 
    # Allow copying over itself
1281
 
    if (os.path.normpath(os.path.join(os.getcwd(),src)) ==
1282
 
        os.path.normpath(os.path.join(os.getcwd(),dst))):
1283
 
        return
1284
 
    action_remove(dst, dry)
 
582
    if os.access(dst, os.F_OK):
 
583
        print "rm -r", dst
 
584
        if not dry:
 
585
            shutil.rmtree(dst, True)
1285
586
    print "cp -r", src, dst
1286
587
    if dry: return
1287
588
    shutil.copytree(src, dst, True)
1288
589
 
1289
 
def action_linktree(src, dst, dry):
1290
 
    """Hard-links an entire directory tree. Same as copytree but the created
1291
 
    files are hard-links not actual copies. Removes the existing destination.
1292
 
    """
1293
 
    action_remove(dst, dry)
1294
 
    print "<cp with hardlinks> -r", src, dst
1295
 
    if dry: return
1296
 
    common.makeuser.linktree(src, dst)
1297
 
 
1298
 
def action_copylist(srclist, dst, dry, srcdir="."):
 
590
def action_copylist(srclist, dst, dry):
1299
591
    """Copies all files in a list to a new location. The files in the list
1300
592
    are read relative to the current directory, and their destinations are the
1301
593
    same paths relative to dst. Creates all parent directories as necessary.
1302
 
    srcdir is "." by default, can be overridden.
1303
594
    """
1304
595
    for srcfile in srclist:
1305
596
        dstfile = os.path.join(dst, srcfile)
1306
 
        srcfile = os.path.join(srcdir, srcfile)
1307
597
        dstdir = os.path.split(dstfile)[0]
1308
598
        if not os.path.isdir(dstdir):
1309
599
            action_mkdir(dstdir, dry)
1318
608
def action_copyfile(src, dst, dry):
1319
609
    """Copies one file to a new location. Creates all parent directories
1320
610
    as necessary.
1321
 
    Warn if file not found.
1322
611
    """
1323
612
    dstdir = os.path.split(dst)[0]
1324
613
    if not os.path.isdir(dstdir):
1328
617
        try:
1329
618
            shutil.copyfile(src, dst)
1330
619
            shutil.copymode(src, dst)
1331
 
        except (shutil.Error, IOError), e:
1332
 
            print "Warning: " + str(e)
 
620
        except shutil.Error:
 
621
            pass
1333
622
 
1334
623
def action_symlink(src, dst, dry):
1335
624
    """Creates a symlink in a given location. Creates all parent directories
1345
634
    if not dry:
1346
635
        os.symlink(src, dst)
1347
636
 
1348
 
def action_append(ivle_pth, ivle_www):
1349
 
    file = open(ivle_pth, 'a+')
1350
 
    file.write(ivle_www + '\n')
1351
 
    file.close()
1352
 
 
1353
637
def action_chown_setuid(file, dry):
1354
638
    """Chowns a file to root, and sets the setuid bit on the file.
1355
639
    Calling this function requires the euid to be root.
1364
648
        os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
1365
649
            | stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
1366
650
 
1367
 
def action_chmod_x(file, dry):
1368
 
    """Chmod 755 a file (sets permissions to rwxr-xr-x)."""
1369
 
    print "chmod 755", file
1370
 
    if not dry:
1371
 
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1372
 
            | stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
1373
 
 
1374
 
 
1375
 
def action_chmod_w(file, dry):
1376
 
    """Chmod 777 a file (sets permissions to rwxrwxrwx)."""
1377
 
    print "chmod 777", file
1378
 
    if not dry:
1379
 
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1380
 
            | stat.S_IXGRP | stat.S_IWGRP | stat.S_IRGRP | stat.S_IXOTH
1381
 
            | stat.S_IWOTH | stat.S_IROTH)
1382
 
 
1383
651
def query_user(default, prompt):
1384
652
    """Prompts the user for a string, which is read from a line of stdin.
1385
653
    Exits silently if EOF is encountered. Returns the string, with spaces