← 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-10 22:11:40 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:170
browser: Added CSS and JS files (not much in them).
media/common: Added json2.js, a minified version of the official JSON
    JavaScript library.

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.
68
68
import compileall
69
69
import getopt
70
70
 
71
 
# Import modules from the website is tricky since they're in the www
72
 
# directory.
73
 
sys.path.append(os.path.join(os.getcwd(), 'lib'))
74
 
import conf
75
 
import common.makeuser
76
 
 
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
 
 
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',
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
102
 
    '/usr/bin/python%s' % PYTHON_VERSION,
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',
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',
162
 
]
163
 
# Symlinks to make within the jail. Src mapped to dst.
164
 
JAIL_LINKS = {
165
 
    'python%s' % PYTHON_VERSION: 'jail/usr/bin/python',
166
 
}
167
 
# Trees to copy. Src mapped to dst (these will be passed to action_copytree).
168
 
JAIL_COPYTREES = {
169
 
    '/usr/lib/python%s' % PYTHON_VERSION:
170
 
        'jail/usr/lib/python%s' % PYTHON_VERSION,
171
 
    '/usr/share/matplotlib': 'jail/usr/share/matplotlib',
172
 
    '/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
173
 
}
174
 
 
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", "/",
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."""))
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."""))
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)."""))
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"""))
260
 
config_options.append(ConfigOption("db_dbname", "ivle",
261
 
    """Database name:""",
262
 
    """
263
 
# Database name"""))
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:
270
 
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
271
 
    """
272
 
# Database password"""))
273
 
 
274
 
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
275
 
    """URL for LDAP authentication server:""",
276
 
    """
277
 
# URL for LDAP authentication server"""))
278
 
config_options.append(ConfigOption("ldap_format_string",
279
 
    "uid=%s,ou=users,o=example",
280
 
    """Format string for LDAP auth request:
281
 
    (Must contain a single "%s" for the user's login name)""",
282
 
    """
283
 
# Format string for LDAP auth request
284
 
# (Must contain a single "%s" for the user's login name)"""))
285
 
 
286
 
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
287
 
    """The location of the subversion configuration file used by apache
288
 
to host the user repositories:""",
289
 
    """
290
 
# The location of the subversion configuration file used by
291
 
# apache to host the user repositories."""))
292
 
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
293
 
    """The root directory for the subversion repositories:""",
294
 
    """
295
 
# The root directory for the subversion repositories."""))
296
 
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
297
 
    """The location of the password file used to authenticate users
298
 
of the subversion repository from the ivle server:""",
299
 
    """
300
 
# The location of the password file used to authenticate users
301
 
# of the subversion repository from the ivle server."""))
302
 
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
303
 
    """The location of the password file used to authenticate local users
304
 
of the subversion repository:""",
305
 
    """
306
 
# The location of the password file used to authenticate local users
307
 
# of the subversion repository."""))
308
 
config_options.append(ConfigOption("usrmgt_host", "localhost",
309
 
    """The hostname where the usrmgt-server runs:""",
310
 
    """
311
 
# The hostname where the usrmgt-server runs."""))
312
 
config_options.append(ConfigOption("usrmgt_port", "2178",
313
 
    """The port where the usrmgt-server runs:""",
314
 
    """
315
 
# The port where the usrmgt-server runs."""))
316
 
config_options.append(ConfigOption("usrmgt_magic", "",
317
 
    """The password for the usrmgt-server:""",
318
 
    """
319
 
# The password for the usrmgt-server."""))
320
 
 
321
71
# Try importing existing conf, but if we can't just set up defaults
322
72
# The reason for this is that these settings are used by other phases
323
73
# of setup besides conf, so we need to know them.
324
74
# Also this allows you to hit Return to accept the existing value.
325
75
try:
326
 
    confmodule = __import__("lib/conf/conf")
327
 
    for opt in config_options:
328
 
        try:
329
 
            globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
330
 
        except:
331
 
            globals()[opt.option_name] = opt.default
 
76
    confmodule = __import__("www/conf/conf")
 
77
    root_dir = confmodule.root_dir
 
78
    ivle_install_dir = confmodule.ivle_install_dir
 
79
    jail_base = confmodule.jail_base
332
80
except ImportError:
333
81
    # Just set reasonable defaults
334
 
    for opt in config_options:
335
 
        globals()[opt.option_name] = opt.default
 
82
    root_dir = "/ivle"
 
83
    ivle_install_dir = "/opt/ivle"
 
84
    jail_base = "/home/informatics/jails"
 
85
# Always defaults
 
86
allowed_uids = "0"
336
87
 
337
88
# Try importing install_list, but don't fail if we can't, because listmake can
338
89
# function without it.
347
98
# as necessary, and include it in the distribution.
348
99
listmake_mimetypes = ['text/x-python', 'text/html',
349
100
    'application/x-javascript', 'application/javascript',
350
 
    'text/css', 'image/png', 'application/xml']
 
101
    'text/css', 'image/png']
351
102
 
352
103
# Main function skeleton from Guido van Rossum
353
104
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
376
127
        return 1
377
128
 
378
129
    # Disallow run as root unless installing
379
 
    if (operation != 'install' and operation != 'updatejails'
380
 
        and os.geteuid() == 0):
 
130
    if operation != 'install' and os.geteuid() == 0:
381
131
        print >>sys.stderr, "I do not want to run this stage as root."
382
132
        print >>sys.stderr, "Please run as a normal user."
383
133
        return 1
385
135
    try:
386
136
        oper_func = {
387
137
            'help' : help,
388
 
            'config' : conf,
 
138
            'conf' : conf,
389
139
            'build' : build,
390
140
            'listmake' : listmake,
391
141
            'install' : install,
392
 
            'updatejails' : updatejails,
393
142
        }[operation]
394
143
    except KeyError:
395
144
        print >>sys.stderr, (
406
155
Operation (and args) can be:
407
156
    help [operation]
408
157
    listmake (developer use only)
409
 
    config [args]
 
158
    conf [args]
410
159
    build
411
 
    install [--nojail] [--nosubjects] [-n|--dry]
 
160
    install [--nojail] [-n|--dry]
412
161
"""
413
162
        return 1
414
163
    elif len(args) != 1:
427
176
be copied upon installation. This should be run by the developer before
428
177
cutting a distribution, and the listfile it generates should be included in
429
178
the distribution, avoiding the administrator having to run it."""
430
 
    elif operation == 'config':
431
 
        print """python setup.py config [args]
 
179
    elif operation == 'conf':
 
180
        print """python setup.py conf [args]
432
181
Configures IVLE with machine-specific details, most notably, various paths.
433
182
Either prompts the administrator for these details or accepts them as
434
183
command-line args. Will be interactive only if there are no arguments given.
438
187
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
439
188
directory, and run build/install one time.
440
189
 
441
 
Creates lib/conf/conf.py and trampoline/conf.h.
 
190
Creates www/conf/conf.py and trampoline/conf.h.
442
191
 
443
 
Args are:"""
444
 
        for opt in config_options:
445
 
            print "    --" + opt.option_name
446
 
        print """As explained in the interactive prompt or conf.py.
 
192
Args are:
 
193
    --root_dir
 
194
    --ivle_install_dir
 
195
    --jail_base
 
196
    --allowed_uids
 
197
As explained in the interactive prompt or conf.py.
447
198
"""
448
199
    elif operation == 'build':
449
200
        print """python -O setup.py build [--dry|-n]
460
211
 
461
212
--dry | -n  Print out the actions but don't do anything."""
462
213
    elif operation == 'install':
463
 
        print """sudo python setup.py install [--nojail] [--nosubjects][--dry|-n]
 
214
        print """sudo python setup.py install [--nojail] [--dry|-n]
464
215
(Requires root)
465
216
Create target install directory ($target).
466
217
Create $target/bin.
468
219
chown and chmod the installed trampoline.
469
220
Copy www/ to $target.
470
221
Copy jail/ to jails template directory (unless --nojail specified).
471
 
Copy subjects/ to subjects directory (unless --nosubjects specified).
472
 
 
473
 
--nojail        Do not copy the jail.
474
 
--nosubjects    Do not copy the subjects and problems directories.
475
 
--dry | -n  Print out the actions but don't do anything."""
476
 
    elif operation == 'updatejails':
477
 
        print """sudo python setup.py updatejails [--dry|-n]
478
 
(Requires root)
479
 
Copy jail/ to each subdirectory in jails directory.
480
 
 
 
222
 
 
223
--nojail    Do not copy the jail.
481
224
--dry | -n  Print out the actions but don't do anything."""
482
225
    else:
483
226
        print >>sys.stderr, (
488
231
def listmake(args):
489
232
    # We build two separate lists, by walking www and console
490
233
    list_www = build_list_py_files('www')
491
 
    list_lib = build_list_py_files('lib')
492
 
    list_subjects = build_list_py_files('subjects', no_top_level=True)
493
 
    list_problems = build_list_py_files('problems', no_top_level=True)
494
 
    list_scripts = [
495
 
        "scripts/python-console",
496
 
        "scripts/fileservice",
497
 
        "scripts/usrmgt-server",
498
 
    ]
 
234
    list_console = build_list_py_files('console')
499
235
    # Make sure that the files generated by conf are in the list
500
236
    # (since listmake is typically run before conf)
501
 
    if "lib/conf/conf.py" not in list_lib:
502
 
        list_lib.append("lib/conf/conf.py")
 
237
    if "www/conf/conf.py" not in list_www:
 
238
        list_www.append("www/conf/conf.py")
 
239
    # Make sure that console/python-console is in the list
 
240
    if "console/python-console" not in list_console:
 
241
        list_console.append("console/python-console")
503
242
    # Write these out to a file
504
243
    cwd = os.getcwd()
505
244
    # the files that will be created/overwritten
519
258
list_www = """)
520
259
        writelist_pretty(file, list_www)
521
260
        file.write("""
522
 
# List of all installable files in lib directory.
523
 
list_lib = """)
524
 
        writelist_pretty(file, list_lib)
525
 
        file.write("""
526
 
# List of all installable files in scripts directory.
527
 
list_scripts = """)
528
 
        writelist_pretty(file, list_scripts)
529
 
        file.write("""
530
 
# List of all installable files in subjects directory.
531
 
# This is to install sample subjects and material.
532
 
list_subjects = """)
533
 
        writelist_pretty(file, list_subjects)
534
 
        file.write("""
535
 
# List of all installable files in problems directory.
536
 
# This is to install sample exercise material.
537
 
list_problems = """)
538
 
        writelist_pretty(file, list_problems)
 
261
# List of all installable files in console directory.
 
262
list_console = """)
 
263
        writelist_pretty(file, list_console)
539
264
 
540
265
        file.close()
541
266
    except IOError, (errno, strerror):
552
277
 
553
278
    return 0
554
279
 
555
 
def build_list_py_files(dir, no_top_level=False):
 
280
def build_list_py_files(dir):
556
281
    """Builds a list of all py files found in a directory and its
557
 
    subdirectories. Returns this as a list of strings.
558
 
    no_top_level=True means the file paths will not include the top-level
559
 
    directory.
560
 
    """
 
282
    subdirectories. Returns this as a list of strings."""
561
283
    pylist = []
562
284
    for (dirpath, dirnames, filenames) in os.walk(dir):
563
285
        # Exclude directories beginning with a '.' (such as '.svn')
565
287
        # All *.py files are added to the list
566
288
        pylist += [os.path.join(dirpath, item) for item in filenames
567
289
            if mimetypes.guess_type(item)[0] in listmake_mimetypes]
568
 
    if no_top_level:
569
 
        for i in range(0, len(pylist)):
570
 
            _, pylist[i] = pylist[i].split(os.sep, 1)
571
290
    return pylist
572
291
 
573
292
def writelist_pretty(file, list):
581
300
        file.write(']\n')
582
301
 
583
302
def conf(args):
584
 
    global db_port, usrmgt_port
 
303
    global root_dir, ivle_install_dir, jail_base, allowed_uids
585
304
    # Set up some variables
586
305
 
587
306
    cwd = os.getcwd()
588
307
    # the files that will be created/overwritten
589
 
    conffile = os.path.join(cwd, "lib/conf/conf.py")
590
 
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
 
308
    conffile = os.path.join(cwd, "www/conf/conf.py")
591
309
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
592
310
 
 
311
    # Fixed config options that we don't ask the admin
 
312
    default_app = "dummy"
 
313
 
593
314
    # Get command-line arguments to avoid asking questions.
594
315
 
595
 
    optnames = []
596
 
    for opt in config_options:
597
 
        optnames.append(opt.option_name + "=")
598
 
    (opts, args) = getopt.gnu_getopt(args, "", optnames)
 
316
    (opts, args) = getopt.gnu_getopt(args, "", ['root_dir=',
 
317
                    'ivle_install_dir=', 'jail_base=', 'allowed_uids='])
599
318
 
600
319
    if args != []:
601
320
        print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
607
326
        print """This tool will create the following files:
608
327
    %s
609
328
    %s
610
 
    %s
611
329
prompting you for details about your configuration. The file will be
612
330
overwritten if it already exists. It will *not* install or deploy IVLE.
613
331
 
614
332
Please hit Ctrl+C now if you do not wish to do this.
615
 
""" % (conffile, jailconffile, conf_hfile)
 
333
""" % (conffile, conf_hfile)
616
334
 
617
335
        # Get information from the administrator
618
336
        # If EOF is encountered at any time during the questioning, just exit
619
337
        # silently
620
338
 
621
 
        for opt in config_options:
622
 
            globals()[opt.option_name] = \
623
 
                query_user(globals()[opt.option_name], opt.prompt)
 
339
        root_dir = query_user(root_dir,
 
340
        """Root directory where IVLE is located (in URL space):""")
 
341
        ivle_install_dir = query_user(ivle_install_dir,
 
342
        'Root directory where IVLE will be installed (on the local file '
 
343
        'system):')
 
344
        jail_base = query_user(jail_base,
 
345
        """Root directory where the jails (containing user files) are stored
 
346
(on the local file system):""")
 
347
        allowed_uids = query_user(allowed_uids,
 
348
        """UID of the web server process which will run IVLE.
 
349
Only this user may execute the trampoline. May specify multiple users as
 
350
a comma-separated list.
 
351
    (eg. "1002,78")""")
 
352
 
624
353
    else:
625
354
        opts = dict(opts)
626
355
        # Non-interactive mode. Parse the options.
627
 
        for opt in config_options:
628
 
            if '--' + opt.option_name in opts:
629
 
                globals()[opt.option_name] = opts['--' + opt.option_name]
 
356
        if '--root_dir' in opts:
 
357
            root_dir = opts['--root_dir']
 
358
        if '--ivle_install_dir' in opts:
 
359
            ivle_install_dir = opts['--ivle_install_dir']
 
360
        if '--jail_base' in opts:
 
361
            jail_base = opts['--jail_base']
 
362
        if '--allowed_uids' in opts:
 
363
            allowed_uids = opts['--allowed_uids']
630
364
 
631
365
    # Error handling on input values
632
366
    try:
633
 
        allowed_uids_list = map(int, allowed_uids.split(','))
 
367
        allowed_uids = map(int, allowed_uids.split(','))
634
368
    except ValueError:
635
369
        print >>sys.stderr, (
636
370
        "Invalid UID list (%s).\n"
637
371
        "Must be a comma-separated list of integers." % allowed_uids)
638
372
        return 1
639
 
    try:
640
 
        db_port = int(db_port)
641
 
        if db_port < 0 or db_port >= 65536: raise ValueError()
642
 
    except ValueError:
643
 
        print >>sys.stderr, (
644
 
        "Invalid DB port (%s).\n"
645
 
        "Must be an integer between 0 and 65535." % repr(db_port))
646
 
        return 1
647
 
    try:
648
 
        usrmgt_port = int(usrmgt_port)
649
 
        if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
650
 
    except ValueError:
651
 
        print >>sys.stderr, (
652
 
        "Invalid user management port (%s).\n"
653
 
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
654
 
        return 1
655
373
 
656
 
    # Write lib/conf/conf.py
 
374
    # Write www/conf/conf.py
657
375
 
658
376
    try:
659
377
        conf = open(conffile, "w")
662
380
# conf.py
663
381
# Miscellaneous application settings
664
382
 
665
 
""")
666
 
        for opt in config_options:
667
 
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
668
 
                repr(globals()[opt.option_name])))
669
 
 
670
 
        conf.close()
671
 
    except IOError, (errno, strerror):
672
 
        print "IO error(%s): %s" % (errno, strerror)
673
 
        sys.exit(1)
674
 
 
675
 
    print "Successfully wrote lib/conf/conf.py"
676
 
 
677
 
    # Write conf/jailconf.py
678
 
 
679
 
    try:
680
 
        conf = open(jailconffile, "w")
681
 
 
682
 
        # In the "in-jail" version of conf, we don't need MOST of the details
683
 
        # (it would be a security risk to have them here).
684
 
        # So we just write root_dir, and jail_base is "/".
685
 
        # (jail_base being "/" means "jail-relative" paths are relative to "/"
686
 
        # when inside the jail.)
687
 
        conf.write("""# IVLE Configuration File
688
 
# conf.py
689
 
# Miscellaneous application settings
690
 
# (User jail version)
691
 
 
692
383
 
693
384
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
694
385
# with this).
695
386
# eg. "/" or "/ivle".
696
 
root_dir = %s
 
387
root_dir = "%s"
 
388
 
 
389
# In the local file system, where IVLE is actually installed.
 
390
# This directory should contain the "www" and "bin" directories.
 
391
ivle_install_dir = "%s"
697
392
 
698
393
# In the local file system, where are the student/user file spaces located.
699
394
# The user jails are expected to be located immediately in subdirectories of
700
395
# this location.
701
 
jail_base = '/'
 
396
jail_base = "%s"
702
397
 
703
 
# The hostname for serving publicly accessible pages
704
 
public_host = %s
705
 
""" % (repr(root_dir),repr(public_host)))
 
398
# Which application to load by default (if the user navigates to the top level
 
399
# of the site). This is the app's URL name.
 
400
# Note that if this app requires authentication, the user will first be
 
401
# presented with the login screen.
 
402
default_app = "%s"
 
403
""" % (root_dir, ivle_install_dir, jail_base, default_app))
706
404
 
707
405
        conf.close()
708
406
    except IOError, (errno, strerror):
709
407
        print "IO error(%s): %s" % (errno, strerror)
710
408
        sys.exit(1)
711
409
 
712
 
    print "Successfully wrote lib/conf/jailconf.py"
 
410
    print "Successfully wrote www/conf/conf.py"
713
411
 
714
412
    # Write trampoline/conf.h
715
413
 
734
432
 * (Note that root is an implicit member of this list).
735
433
 */
736
434
static const int allowed_uids[] = { %s };
737
 
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
738
 
    # Note: The above uses PYTHON reprs, not C reprs
739
 
    # However they should be the same with the exception of the outer
740
 
    # characters, which are stripped off and replaced
 
435
""" % (jail_base, repr(allowed_uids)[1:-1]))
741
436
 
742
437
        conf.close()
743
438
    except IOError, (errno, strerror):
749
444
    print
750
445
    print "You may modify the configuration at any time by editing"
751
446
    print conffile
752
 
    print jailconffile
753
447
    print conf_hfile
754
448
    print
755
449
    return 0
764
458
        print "Dry run (no actions will be executed\n"
765
459
 
766
460
    # Compile the trampoline
767
 
    curdir = os.getcwd()
768
 
    os.chdir('trampoline')
769
 
    action_runprog('make', [], dry)
770
 
    os.chdir(curdir)
 
461
    action_runprog('gcc', ['-Wall', '-o', 'trampoline/trampoline',
 
462
        'trampoline/trampoline.c'], dry)
771
463
 
772
464
    # Create the jail and its subdirectories
773
465
    # Note: Other subdirs will be made by copying files
776
468
    action_mkdir('jail/tmp', dry)
777
469
 
778
470
    # Copy all console and operating system files into the jail
779
 
    action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
 
471
    action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
780
472
    copy_os_files_jail(dry)
781
 
    # Chmod the python console
782
 
    action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
783
 
    action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
784
 
    
785
 
    # Also copy the IVLE lib directory into the jail
786
 
    # This is necessary for running certain scripts
787
 
    action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
788
 
    # IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
789
 
    # which could compromise security if left in the jail (such as the DB
790
 
    # password).
791
 
    # The "safe" version is in jailconf.py. Delete conf.py and replace it with
792
 
    # jailconf.py.
793
 
    action_copyfile('lib/conf/jailconf.py',
794
 
        'jail/opt/ivle/lib/conf/conf.py', dry)
795
473
 
796
474
    # Compile .py files into .pyc or .pyo files
797
475
    compileall.compile_dir('www', quiet=True)
798
 
    compileall.compile_dir('lib', quiet=True)
799
 
    compileall.compile_dir('scripts', quiet=True)
800
 
    compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
801
 
 
802
 
    # Set up ivle.pth inside the jail
803
 
    # Need to set /opt/ivle/lib to be on the import path
804
 
    ivle_pth = \
805
 
        "jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
806
 
    f = open(ivle_pth, 'w')
807
 
    f.write('/opt/ivle/lib\n')
808
 
    f.close()
 
476
    compileall.compile_dir('console', quiet=True)
809
477
 
810
478
    return 0
811
479
 
813
481
    """Copies necessary Operating System files from their usual locations
814
482
    into the jail/ directory of the cwd."""
815
483
    # Currently source paths are configured for Ubuntu.
816
 
    for filename in JAIL_FILES:
817
 
        copy_file_to_jail(filename, dry)
818
 
    for src, dst in JAIL_LINKS.items():
819
 
        action_symlink(src, dst, dry)
820
 
    for src, dst in JAIL_COPYTREES.items():
821
 
        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)
822
493
 
823
494
def copy_file_to_jail(src, dry):
824
495
    """Copies a single file from an absolute location into the same location
828
499
 
829
500
def install(args):
830
501
    # Get "dry" and "nojail" variables from command line
831
 
    (opts, args) = getopt.gnu_getopt(args, "n",
832
 
        ['dry', 'nojail', 'nosubjects'])
 
502
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry', 'nojail'])
833
503
    opts = dict(opts)
834
504
    dry = '-n' in opts or '--dry' in opts
835
505
    nojail = '--nojail' in opts
836
 
    nosubjects = '--nosubjects' in opts
837
506
 
838
507
    if dry:
839
508
        print "Dry run (no actions will be executed\n"
853
522
    # chown trampoline to root and set setuid bit
854
523
    action_chown_setuid(tramppath, dry)
855
524
 
856
 
    # Copy the www and lib directories using the list
 
525
    # Copy the www directory using the list
857
526
    action_copylist(install_list.list_www, ivle_install_dir, dry)
858
 
    action_copylist(install_list.list_lib, ivle_install_dir, dry)
859
527
 
860
528
    if not nojail:
861
529
        # Copy the local jail directory built by the build action
862
530
        # to the jails template directory (it will be used as a template
863
531
        # for all the students' jails).
864
532
        action_copytree('jail', os.path.join(jail_base, 'template'), dry)
865
 
    if not nosubjects:
866
 
        # Copy the subjects and problems directories across
867
 
        action_copylist(install_list.list_subjects, subjects_base, dry,
868
 
            srcdir="./subjects")
869
 
        action_copylist(install_list.list_problems, problems_base, dry,
870
 
            srcdir="./problems")
871
 
 
872
 
    # Append IVLE path to ivle.pth in python site packages
873
 
    # (Unless it's already there)
874
 
    ivle_pth = os.path.join(sys.prefix,
875
 
        "lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
876
 
    ivle_www = os.path.join(ivle_install_dir, "www")
877
 
    ivle_lib = os.path.join(ivle_install_dir, "lib")
878
 
    write_ivle_pth = True
879
 
    write_ivle_lib_pth = True
880
 
    try:
881
 
        file = open(ivle_pth, 'r')
882
 
        for line in file:
883
 
            if line.strip() == ivle_www:
884
 
                write_ivle_pth = False
885
 
            elif line.strip() == ivle_lib:
886
 
                write_ivle_lib_pth = False
887
 
        file.close()
888
 
    except (IOError, OSError):
889
 
        pass
890
 
    if write_ivle_pth:
891
 
        action_append(ivle_pth, ivle_www)
892
 
    if write_ivle_lib_pth:
893
 
        action_append(ivle_pth, ivle_lib)
894
 
 
895
 
    return 0
896
 
 
897
 
def updatejails(args):
898
 
    # Get "dry" variable from command line
899
 
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
900
 
    opts = dict(opts)
901
 
    dry = '-n' in opts or '--dry' in opts
902
 
 
903
 
    if dry:
904
 
        print "Dry run (no actions will be executed\n"
905
 
 
906
 
    if not dry and os.geteuid() != 0:
907
 
        print >>sys.stderr, "Must be root to run install"
908
 
        print >>sys.stderr, "(I need to chown some files)."
909
 
        return 1
910
 
 
911
 
    # Update the template jail directory in case it hasn't been installed
912
 
    # recently.
913
 
    action_copytree('jail', os.path.join(jail_base, 'template'), dry)
914
 
 
915
 
    # Re-link all the files in all students jails.
916
 
    for dir in os.listdir(jail_base):
917
 
        if dir == 'template': continue
918
 
        # First back up the student's home directory
919
 
        temp_home = os.tmpnam()
920
 
        action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
921
 
        # Delete the student's jail and relink the jail files
922
 
        action_linktree(os.path.join(jail_base, 'template'),
923
 
            os.path.join(jail_base, dir), dry)
924
 
        # Restore the student's home directory
925
 
        action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
926
 
        # Set up the user's home directory just in case they don't have a
927
 
        # directory for this yet
928
 
        action_mkdir(os.path.join(jail_base, dir, 'home', dir), dry)
929
533
 
930
534
    return 0
931
535
 
958
562
    if ret != 0:
959
563
        raise RunError(prog, ret)
960
564
 
961
 
def action_remove(path, dry):
962
 
    """Calls rmtree, deleting the target file if it exists."""
963
 
    try:
964
 
        print "rm -r", path
965
 
        if not dry:
966
 
            shutil.rmtree(path, True)
967
 
    except OSError, (err, msg):
968
 
        if err != errno.EEXIST:
969
 
            raise
970
 
        # Otherwise, didn't exist, so we don't care
971
 
 
972
 
def action_rename(src, dst, dry):
973
 
    """Calls rename. Deletes the target if it already exists."""
974
 
    action_remove(dst, dry)
975
 
    print "mv ", src, dst
976
 
    if dry: return
977
 
    try:
978
 
        os.rename(src, dst)
979
 
    except OSError, (err, msg):
980
 
        if err != errno.EEXIST:
981
 
            raise
982
 
 
983
565
def action_mkdir(path, dry):
984
566
    """Calls mkdir. Silently ignored if the directory already exists.
985
567
    Creates all parent directories as necessary."""
997
579
    directories as necessary.
998
580
 
999
581
    See shutil.copytree."""
1000
 
    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)
1001
586
    print "cp -r", src, dst
1002
587
    if dry: return
1003
588
    shutil.copytree(src, dst, True)
1004
589
 
1005
 
def action_linktree(src, dst, dry):
1006
 
    """Hard-links an entire directory tree. Same as copytree but the created
1007
 
    files are hard-links not actual copies. Removes the existing destination.
1008
 
    """
1009
 
    action_remove(dst, dry)
1010
 
    print "<cp with hardlinks> -r", src, dst
1011
 
    if dry: return
1012
 
    common.makeuser.linktree(src, dst)
1013
 
 
1014
 
def action_copylist(srclist, dst, dry, srcdir="."):
 
590
def action_copylist(srclist, dst, dry):
1015
591
    """Copies all files in a list to a new location. The files in the list
1016
592
    are read relative to the current directory, and their destinations are the
1017
593
    same paths relative to dst. Creates all parent directories as necessary.
1018
 
    srcdir is "." by default, can be overridden.
1019
594
    """
1020
595
    for srcfile in srclist:
1021
596
        dstfile = os.path.join(dst, srcfile)
1022
 
        srcfile = os.path.join(srcdir, srcfile)
1023
597
        dstdir = os.path.split(dstfile)[0]
1024
598
        if not os.path.isdir(dstdir):
1025
599
            action_mkdir(dstdir, dry)
1034
608
def action_copyfile(src, dst, dry):
1035
609
    """Copies one file to a new location. Creates all parent directories
1036
610
    as necessary.
1037
 
    Warn if file not found.
1038
611
    """
1039
612
    dstdir = os.path.split(dst)[0]
1040
613
    if not os.path.isdir(dstdir):
1044
617
        try:
1045
618
            shutil.copyfile(src, dst)
1046
619
            shutil.copymode(src, dst)
1047
 
        except (shutil.Error, IOError), e:
1048
 
            print "Warning: " + str(e)
 
620
        except shutil.Error:
 
621
            pass
1049
622
 
1050
623
def action_symlink(src, dst, dry):
1051
624
    """Creates a symlink in a given location. Creates all parent directories
1061
634
    if not dry:
1062
635
        os.symlink(src, dst)
1063
636
 
1064
 
def action_append(ivle_pth, ivle_www):
1065
 
    file = open(ivle_pth, 'a+')
1066
 
    file.write(ivle_www + '\n')
1067
 
    file.close()
1068
 
 
1069
637
def action_chown_setuid(file, dry):
1070
638
    """Chowns a file to root, and sets the setuid bit on the file.
1071
639
    Calling this function requires the euid to be root.
1080
648
        os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
1081
649
            | stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
1082
650
 
1083
 
def action_chmod_x(file, dry):
1084
 
    """Chmod 755 a file (sets permissions to rwxr-xr-x)."""
1085
 
    print "chmod 755", file
1086
 
    if not dry:
1087
 
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1088
 
            | stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
1089
 
 
1090
651
def query_user(default, prompt):
1091
652
    """Prompts the user for a string, which is read from a line of stdin.
1092
653
    Exits silently if EOF is encountered. Returns the string, with spaces