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

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: mattgiuca
  • Date: 2008-01-29 02:57:10 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:322
Added doc/setup - a setup guide specific to our configuration. This is the
result of my successfully configuring IVLE on a production server.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.
70
70
 
71
71
# Import modules from the website is tricky since they're in the www
72
72
# directory.
73
 
sys.path.append(os.path.join(os.getcwd(), 'lib'))
 
73
sys.path.append(os.path.join(os.getcwd(), 'www'))
74
74
import conf
75
75
import common.makeuser
76
76
 
100
100
    '/bin/echo',
101
101
    # Needed by python
102
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
103
    # Needed by matplotlib
143
104
    '/usr/lib/i686/cmov/libssl.so.0.9.8',
144
105
    '/usr/lib/i686/cmov/libcrypto.so.0.9.8',
172
133
    '/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
173
134
}
174
135
 
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
 
    """Location of Directories
208
 
=======================
209
 
Root directory where the jails (containing user files) are stored
210
 
(on the local file system):""",
211
 
    """
212
 
# In the local file system, where are the student/user file spaces located.
213
 
# The user jails are expected to be located immediately in subdirectories of
214
 
# this location."""))
215
 
config_options.append(ConfigOption("subjects_base",
216
 
    "/home/informatics/subjects",
217
 
    """Root directory where the subject directories (containing worksheets
218
 
and other per-subject files) are stored (on the local file system):""",
219
 
    """
220
 
# In the local file system, where are the per-subject file spaces located.
221
 
# The individual subject directories are expected to be located immediately
222
 
# in subdirectories of this location."""))
223
 
config_options.append(ConfigOption("exercises_base",
224
 
    "/home/informatics/exercises",
225
 
    """Root directory where the exercise directories (containing
226
 
subject-independent exercise sheets) are stored (on the local file
227
 
system):""",
228
 
    """
229
 
# In the local file system, where are the subject-independent exercise sheet
230
 
# file spaces located."""))
231
 
config_options.append(ConfigOption("public_host", "public.localhost",
232
 
    """Hostname which will cause the server to go into "public mode",
233
 
providing login-free access to student's published work:""",
234
 
    """
235
 
# The server goes into "public mode" if the browser sends a request with this
236
 
# host. This is for security reasons - we only serve public student files on a
237
 
# separate domain to the main IVLE site.
238
 
# Public mode does not use cookies, and serves only public content.
239
 
# Private mode (normal mode) requires login, and only serves files relevant to
240
 
# the logged-in user."""))
241
 
config_options.append(ConfigOption("allowed_uids", "33",
242
 
    """UID of the web server process which will run IVLE.
243
 
Only this user may execute the trampoline. May specify multiple users as
244
 
a comma-separated list.
245
 
    (eg. "1002,78")""",
246
 
    """
247
 
# The User-ID of the web server process which will run IVLE, and any other
248
 
# users who are allowed to run the trampoline. This is stores as a string of
249
 
# comma-separated integers, simply because it is not used within Python, only
250
 
# used by the setup program to write to conf.h (see setup.py config)."""))
251
 
config_options.append(ConfigOption("db_host", "localhost",
252
 
    """PostgreSQL Database config
253
 
==========================
254
 
Hostname of the DB server:""",
255
 
    """
256
 
### PostgreSQL Database config ###
257
 
# Database server hostname"""))
258
 
config_options.append(ConfigOption("db_port", "5432",
259
 
    """Port of the DB server:""",
260
 
    """
261
 
# Database server port"""))
262
 
config_options.append(ConfigOption("db_dbname", "ivle",
263
 
    """Database name:""",
264
 
    """
265
 
# Database name"""))
266
 
config_options.append(ConfigOption("db_user", "postgres",
267
 
    """Username for DB server login:""",
268
 
    """
269
 
# Database username"""))
270
 
config_options.append(ConfigOption("db_password", "",
271
 
    """Password for DB server login:
272
 
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
273
 
    """
274
 
# Database password"""))
275
 
config_options.append(ConfigOption("auth_modules", "ldap_auth",
276
 
    """Authentication config
277
 
=====================
278
 
Comma-separated list of authentication modules. Only "ldap" is available
279
 
by default.""",
280
 
    """
281
 
# Comma-separated list of authentication modules.
282
 
# These refer to importable Python modules in the www/auth directory.
283
 
# Modules "ldap" and "guest" are available in the source tree, but
284
 
# other modules may be plugged in to auth against organisation-specific
285
 
# auth backends."""))
286
 
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
287
 
    """(LDAP options are only relevant if "ldap" is included in the list of
288
 
auth modules).
289
 
URL for LDAP authentication server:""",
290
 
    """
291
 
# URL for LDAP authentication server"""))
292
 
config_options.append(ConfigOption("ldap_format_string",
293
 
    "uid=%s,ou=users,o=example",
294
 
    """Format string for LDAP auth request:
295
 
    (Must contain a single "%s" for the user's login name)""",
296
 
    """
297
 
# Format string for LDAP auth request
298
 
# (Must contain a single "%s" for the user's login name)"""))
299
 
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
300
 
    """Subversion config
301
 
=================
302
 
The base url for accessing subversion repositories:""",
303
 
    """
304
 
# The base url for accessing subversion repositories."""))
305
 
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
306
 
    """The location of the subversion configuration file used by apache
307
 
to host the user repositories:""",
308
 
    """
309
 
# The location of the subversion configuration file used by
310
 
# apache to host the user repositories."""))
311
 
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
312
 
    """The root directory for the subversion repositories:""",
313
 
    """
314
 
# The root directory for the subversion repositories."""))
315
 
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
316
 
    """The location of the password file used to authenticate users
317
 
of the subversion repository from the ivle server:""",
318
 
    """
319
 
# The location of the password file used to authenticate users
320
 
# of the subversion repository from the ivle server."""))
321
 
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
322
 
    """The location of the password file used to authenticate local users
323
 
of the subversion repository:""",
324
 
    """
325
 
# The location of the password file used to authenticate local users
326
 
# of the subversion repository."""))
327
 
config_options.append(ConfigOption("usrmgt_host", "localhost",
328
 
    """User Management Server config
329
 
============================
330
 
The hostname where the usrmgt-server runs:""",
331
 
    """
332
 
# The hostname where the usrmgt-server runs."""))
333
 
config_options.append(ConfigOption("usrmgt_port", "2178",
334
 
    """The port where the usrmgt-server runs:""",
335
 
    """
336
 
# The port where the usrmgt-server runs."""))
337
 
config_options.append(ConfigOption("usrmgt_magic", "",
338
 
    """The password for the usrmgt-server:""",
339
 
    """
340
 
# The password for the usrmgt-server."""))
341
 
 
342
136
# Try importing existing conf, but if we can't just set up defaults
343
137
# The reason for this is that these settings are used by other phases
344
138
# of setup besides conf, so we need to know them.
345
139
# Also this allows you to hit Return to accept the existing value.
346
140
try:
347
 
    confmodule = __import__("lib/conf/conf")
348
 
    for opt in config_options:
349
 
        try:
350
 
            globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
351
 
        except:
352
 
            globals()[opt.option_name] = opt.default
 
141
    confmodule = __import__("www/conf/conf")
 
142
    try:
 
143
        root_dir = confmodule.root_dir
 
144
    except:
 
145
        root_dir = "/ivle"
 
146
    try:
 
147
        ivle_install_dir = confmodule.ivle_install_dir
 
148
    except:
 
149
        ivle_install_dir = "/opt/ivle"
 
150
    try:
 
151
        public_host = confmodule.public_host
 
152
    except:
 
153
        public_host = "public.localhost"
 
154
    try:
 
155
        jail_base = confmodule.jail_base
 
156
    except:
 
157
        jail_base = "/home/informatics/jails"
 
158
    try:
 
159
        subjects_base = confmodule.subjects_base
 
160
    except:
 
161
        subjects_base = "/home/informatics/subjects"
353
162
except ImportError:
354
163
    # Just set reasonable defaults
355
 
    for opt in config_options:
356
 
        globals()[opt.option_name] = opt.default
 
164
    root_dir = "/ivle"
 
165
    ivle_install_dir = "/opt/ivle"
 
166
    public_host = "public.localhost"
 
167
    jail_base = "/home/informatics/jails"
 
168
    subjects_base = "/home/informatics/subjects"
 
169
# Always defaults
 
170
allowed_uids = "0"
357
171
 
358
172
# Try importing install_list, but don't fail if we can't, because listmake can
359
173
# function without it.
459
273
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
460
274
directory, and run build/install one time.
461
275
 
462
 
Creates lib/conf/conf.py and trampoline/conf.h.
 
276
Creates www/conf/conf.py and trampoline/conf.h.
463
277
 
464
 
Args are:"""
465
 
        for opt in config_options:
466
 
            print "    --" + opt.option_name
467
 
        print """As explained in the interactive prompt or conf.py.
 
278
Args are:
 
279
    --root_dir
 
280
    --ivle_install_dir
 
281
    --public_host
 
282
    --jail_base
 
283
    --subjects_base
 
284
    --allowed_uids
 
285
As explained in the interactive prompt or conf.py.
468
286
"""
469
287
    elif operation == 'build':
470
288
        print """python -O setup.py build [--dry|-n]
492
310
Copy subjects/ to subjects directory (unless --nosubjects specified).
493
311
 
494
312
--nojail        Do not copy the jail.
495
 
--nosubjects    Do not copy the subjects and exercises directories.
 
313
--nosubjects    Do not copy the subjects.
496
314
--dry | -n  Print out the actions but don't do anything."""
497
315
    elif operation == 'updatejails':
498
316
        print """sudo python setup.py updatejails [--dry|-n]
509
327
def listmake(args):
510
328
    # We build two separate lists, by walking www and console
511
329
    list_www = build_list_py_files('www')
512
 
    list_lib = build_list_py_files('lib')
 
330
    list_console = build_list_py_files('console')
513
331
    list_subjects = build_list_py_files('subjects', no_top_level=True)
514
 
    list_exercises = build_list_py_files('exercises', no_top_level=True)
515
 
    list_scripts = [
516
 
        "scripts/python-console",
517
 
        "scripts/fileservice",
518
 
        "scripts/usrmgt-server",
519
 
    ]
520
332
    # Make sure that the files generated by conf are in the list
521
333
    # (since listmake is typically run before conf)
522
 
    if "lib/conf/conf.py" not in list_lib:
523
 
        list_lib.append("lib/conf/conf.py")
 
334
    if "www/conf/conf.py" not in list_www:
 
335
        list_www.append("www/conf/conf.py")
 
336
    # Make sure that console/python-console is in the list
 
337
    if "console/python-console" not in list_console:
 
338
        list_console.append("console/python-console")
524
339
    # Write these out to a file
525
340
    cwd = os.getcwd()
526
341
    # the files that will be created/overwritten
540
355
list_www = """)
541
356
        writelist_pretty(file, list_www)
542
357
        file.write("""
543
 
# List of all installable files in lib directory.
544
 
list_lib = """)
545
 
        writelist_pretty(file, list_lib)
546
 
        file.write("""
547
 
# List of all installable files in scripts directory.
548
 
list_scripts = """)
549
 
        writelist_pretty(file, list_scripts)
 
358
# List of all installable files in console directory.
 
359
list_console = """)
 
360
        writelist_pretty(file, list_console)
550
361
        file.write("""
551
362
# List of all installable files in subjects directory.
552
363
# This is to install sample subjects and material.
553
364
list_subjects = """)
554
365
        writelist_pretty(file, list_subjects)
555
 
        file.write("""
556
 
# List of all installable files in exercises directory.
557
 
# This is to install sample exercise material.
558
 
list_exercises = """)
559
 
        writelist_pretty(file, list_exercises)
560
366
 
561
367
        file.close()
562
368
    except IOError, (errno, strerror):
602
408
        file.write(']\n')
603
409
 
604
410
def conf(args):
605
 
    global db_port, usrmgt_port
 
411
    global root_dir, ivle_install_dir, jail_base, subjects_base
 
412
    global public_host, allowed_uids
606
413
    # Set up some variables
607
414
 
608
415
    cwd = os.getcwd()
609
416
    # the files that will be created/overwritten
610
 
    conffile = os.path.join(cwd, "lib/conf/conf.py")
611
 
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
 
417
    conffile = os.path.join(cwd, "www/conf/conf.py")
612
418
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
613
419
 
614
420
    # Get command-line arguments to avoid asking questions.
615
421
 
616
 
    optnames = []
617
 
    for opt in config_options:
618
 
        optnames.append(opt.option_name + "=")
619
 
    (opts, args) = getopt.gnu_getopt(args, "", optnames)
 
422
    (opts, args) = getopt.gnu_getopt(args, "", ['root_dir=',
 
423
                    'ivle_install_dir=', 'jail_base=', 'allowed_uids='])
620
424
 
621
425
    if args != []:
622
426
        print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
628
432
        print """This tool will create the following files:
629
433
    %s
630
434
    %s
631
 
    %s
632
435
prompting you for details about your configuration. The file will be
633
436
overwritten if it already exists. It will *not* install or deploy IVLE.
634
437
 
635
438
Please hit Ctrl+C now if you do not wish to do this.
636
 
""" % (conffile, jailconffile, conf_hfile)
 
439
""" % (conffile, conf_hfile)
637
440
 
638
441
        # Get information from the administrator
639
442
        # If EOF is encountered at any time during the questioning, just exit
640
443
        # silently
641
444
 
642
 
        for opt in config_options:
643
 
            globals()[opt.option_name] = \
644
 
                query_user(globals()[opt.option_name], opt.prompt)
 
445
        root_dir = query_user(root_dir,
 
446
        """Root directory where IVLE is located (in URL space):""")
 
447
        ivle_install_dir = query_user(ivle_install_dir,
 
448
        'Root directory where IVLE will be installed (on the local file '
 
449
        'system):')
 
450
        jail_base = query_user(jail_base,
 
451
        """Root directory where the jails (containing user files) are stored
 
452
(on the local file system):""")
 
453
        subjects_base = query_user(subjects_base,
 
454
        """Root directory where the subject directories (containing worksheets
 
455
and other per-subject files) are stored (on the local file system):""")
 
456
        public_host = query_user(public_host,
 
457
        """Hostname which will cause the server to go into "public mode",
 
458
providing login-free access to student's published work:""")
 
459
        allowed_uids = query_user(allowed_uids,
 
460
        """UID of the web server process which will run IVLE.
 
461
Only this user may execute the trampoline. May specify multiple users as
 
462
a comma-separated list.
 
463
    (eg. "1002,78")""")
 
464
 
645
465
    else:
646
466
        opts = dict(opts)
647
467
        # Non-interactive mode. Parse the options.
648
 
        for opt in config_options:
649
 
            if '--' + opt.option_name in opts:
650
 
                globals()[opt.option_name] = opts['--' + opt.option_name]
 
468
        if '--root_dir' in opts:
 
469
            root_dir = opts['--root_dir']
 
470
        if '--ivle_install_dir' in opts:
 
471
            ivle_install_dir = opts['--ivle_install_dir']
 
472
        if '--jail_base' in opts:
 
473
            jail_base = opts['--jail_base']
 
474
        if '--subjects_base' in opts:
 
475
            jail_base = opts['--subjects_base']
 
476
        if '--public_host' in opts:
 
477
            public_host = opts['--public_host']
 
478
        if '--allowed_uids' in opts:
 
479
            allowed_uids = opts['--allowed_uids']
651
480
 
652
481
    # Error handling on input values
653
482
    try:
654
 
        allowed_uids_list = map(int, allowed_uids.split(','))
 
483
        allowed_uids = map(int, allowed_uids.split(','))
655
484
    except ValueError:
656
485
        print >>sys.stderr, (
657
486
        "Invalid UID list (%s).\n"
658
487
        "Must be a comma-separated list of integers." % allowed_uids)
659
488
        return 1
660
 
    try:
661
 
        db_port = int(db_port)
662
 
        if db_port < 0 or db_port >= 65536: raise ValueError()
663
 
    except ValueError:
664
 
        print >>sys.stderr, (
665
 
        "Invalid DB port (%s).\n"
666
 
        "Must be an integer between 0 and 65535." % repr(db_port))
667
 
        return 1
668
 
    try:
669
 
        usrmgt_port = int(usrmgt_port)
670
 
        if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
671
 
    except ValueError:
672
 
        print >>sys.stderr, (
673
 
        "Invalid user management port (%s).\n"
674
 
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
675
 
        return 1
676
489
 
677
 
    # Write lib/conf/conf.py
 
490
    # Write www/conf/conf.py
678
491
 
679
492
    try:
680
493
        conf = open(conffile, "w")
683
496
# conf.py
684
497
# Miscellaneous application settings
685
498
 
686
 
""")
687
 
        for opt in config_options:
688
 
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
689
 
                repr(globals()[opt.option_name])))
690
 
 
691
 
        conf.close()
692
 
    except IOError, (errno, strerror):
693
 
        print "IO error(%s): %s" % (errno, strerror)
694
 
        sys.exit(1)
695
 
 
696
 
    print "Successfully wrote lib/conf/conf.py"
697
 
 
698
 
    # Write conf/jailconf.py
699
 
 
700
 
    try:
701
 
        conf = open(jailconffile, "w")
702
 
 
703
 
        # In the "in-jail" version of conf, we don't need MOST of the details
704
 
        # (it would be a security risk to have them here).
705
 
        # So we just write root_dir, and jail_base is "/".
706
 
        # (jail_base being "/" means "jail-relative" paths are relative to "/"
707
 
        # when inside the jail.)
708
 
        conf.write("""# IVLE Configuration File
709
 
# conf.py
710
 
# Miscellaneous application settings
711
 
# (User jail version)
712
 
 
713
499
 
714
500
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
715
501
# with this).
716
502
# eg. "/" or "/ivle".
717
 
root_dir = %s
 
503
root_dir = "%s"
 
504
 
 
505
# In the local file system, where IVLE is actually installed.
 
506
# This directory should contain the "www" and "bin" directories.
 
507
ivle_install_dir = "%s"
 
508
 
 
509
# The server goes into "public mode" if the browser sends a request with this
 
510
# host. This is for security reasons - we only serve public student files on a
 
511
# separate domain to the main IVLE site.
 
512
# Public mode does not use cookies, and serves only public content.
 
513
# Private mode (normal mode) requires login, and only serves files relevant to
 
514
# the logged-in user.
 
515
public_host = "%s"
718
516
 
719
517
# In the local file system, where are the student/user file spaces located.
720
518
# The user jails are expected to be located immediately in subdirectories of
721
519
# this location.
722
 
jail_base = '/'
 
520
jail_base = "%s"
723
521
 
724
 
# The hostname for serving publicly accessible pages
725
 
public_host = %s
726
 
""" % (repr(root_dir),repr(public_host)))
 
522
# In the local file system, where are the per-subject file spaces located.
 
523
# The individual subject directories are expected to be located immediately
 
524
# in subdirectories of this location.
 
525
subjects_base = "%s"
 
526
""" % (root_dir, ivle_install_dir, public_host, jail_base, subjects_base))
727
527
 
728
528
        conf.close()
729
529
    except IOError, (errno, strerror):
730
530
        print "IO error(%s): %s" % (errno, strerror)
731
531
        sys.exit(1)
732
532
 
733
 
    print "Successfully wrote lib/conf/jailconf.py"
 
533
    print "Successfully wrote www/conf/conf.py"
734
534
 
735
535
    # Write trampoline/conf.h
736
536
 
755
555
 * (Note that root is an implicit member of this list).
756
556
 */
757
557
static const int allowed_uids[] = { %s };
758
 
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
759
 
    # Note: The above uses PYTHON reprs, not C reprs
760
 
    # However they should be the same with the exception of the outer
761
 
    # characters, which are stripped off and replaced
 
558
""" % (jail_base, repr(allowed_uids)[1:-1]))
762
559
 
763
560
        conf.close()
764
561
    except IOError, (errno, strerror):
770
567
    print
771
568
    print "You may modify the configuration at any time by editing"
772
569
    print conffile
773
 
    print jailconffile
774
570
    print conf_hfile
775
571
    print
776
572
    return 0
785
581
        print "Dry run (no actions will be executed\n"
786
582
 
787
583
    # Compile the trampoline
788
 
    curdir = os.getcwd()
789
 
    os.chdir('trampoline')
790
 
    action_runprog('make', [], dry)
791
 
    os.chdir(curdir)
 
584
    action_runprog('gcc', ['-Wall', '-o', 'trampoline/trampoline',
 
585
        'trampoline/trampoline.c'], dry)
792
586
 
793
587
    # Create the jail and its subdirectories
794
588
    # Note: Other subdirs will be made by copying files
797
591
    action_mkdir('jail/tmp', dry)
798
592
 
799
593
    # Copy all console and operating system files into the jail
800
 
    action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
 
594
    action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
801
595
    copy_os_files_jail(dry)
802
596
    # Chmod the python console
803
 
    action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
804
 
    action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
 
597
    action_chmod_x('jail/opt/ivle/console/python-console', dry)
805
598
    
806
 
    # Also copy the IVLE lib directory into the jail
807
 
    # This is necessary for running certain scripts
808
 
    action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
809
 
    # IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
810
 
    # which could compromise security if left in the jail (such as the DB
811
 
    # password).
812
 
    # The "safe" version is in jailconf.py. Delete conf.py and replace it with
813
 
    # jailconf.py.
814
 
    action_copyfile('lib/conf/jailconf.py',
815
 
        'jail/opt/ivle/lib/conf/conf.py', dry)
816
599
 
817
600
    # Compile .py files into .pyc or .pyo files
818
601
    compileall.compile_dir('www', quiet=True)
819
 
    compileall.compile_dir('lib', quiet=True)
820
 
    compileall.compile_dir('scripts', quiet=True)
821
 
    compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
822
 
 
823
 
    # Set up ivle.pth inside the jail
824
 
    # Need to set /opt/ivle/lib to be on the import path
825
 
    ivle_pth = \
826
 
        "jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
827
 
    f = open(ivle_pth, 'w')
828
 
    f.write('/opt/ivle/lib\n')
829
 
    f.close()
 
602
    compileall.compile_dir('console', quiet=True)
830
603
 
831
604
    return 0
832
605
 
874
647
    # chown trampoline to root and set setuid bit
875
648
    action_chown_setuid(tramppath, dry)
876
649
 
877
 
    # Create a scripts directory to put the usrmgt-server in.
878
 
    action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
879
 
    usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
880
 
    action_copyfile('scripts/usrmgt-server', usrmgtpath, dry)
881
 
    action_chmod_x(usrmgtpath, dry)
882
 
 
883
 
    # Copy the www and lib directories using the list
 
650
    # Copy the www directory using the list
884
651
    action_copylist(install_list.list_www, ivle_install_dir, dry)
885
 
    action_copylist(install_list.list_lib, ivle_install_dir, dry)
886
 
    
887
 
    # Copy the php directory
888
 
    action_copytree('www/php/phpBB3',os.path.join(ivle_install_dir,'www/php/phpBB3'), 
889
 
    dry)
890
652
 
891
653
    if not nojail:
892
654
        # Copy the local jail directory built by the build action
894
656
        # for all the students' jails).
895
657
        action_copytree('jail', os.path.join(jail_base, 'template'), dry)
896
658
    if not nosubjects:
897
 
        # Copy the subjects and exercises directories across
 
659
        # Copy the subjects directory across
898
660
        action_copylist(install_list.list_subjects, subjects_base, dry,
899
661
            srcdir="./subjects")
900
 
        action_copylist(install_list.list_exercises, exercises_base, dry,
901
 
            srcdir="./exercises")
902
662
 
903
663
    # Append IVLE path to ivle.pth in python site packages
904
664
    # (Unless it's already there)
905
665
    ivle_pth = os.path.join(sys.prefix,
906
666
        "lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
907
667
    ivle_www = os.path.join(ivle_install_dir, "www")
908
 
    ivle_lib = os.path.join(ivle_install_dir, "lib")
909
668
    write_ivle_pth = True
910
 
    write_ivle_lib_pth = True
911
669
    try:
912
670
        file = open(ivle_pth, 'r')
913
671
        for line in file:
914
672
            if line.strip() == ivle_www:
915
673
                write_ivle_pth = False
916
 
            elif line.strip() == ivle_lib:
917
 
                write_ivle_lib_pth = False
918
 
        file.close()
 
674
                break
919
675
    except (IOError, OSError):
920
676
        pass
921
677
    if write_ivle_pth:
922
678
        action_append(ivle_pth, ivle_www)
923
 
    if write_ivle_lib_pth:
924
 
        action_append(ivle_pth, ivle_lib)
925
679
 
926
680
    return 0
927
681
 
989
743
    if ret != 0:
990
744
        raise RunError(prog, ret)
991
745
 
992
 
def action_remove(path, dry):
993
 
    """Calls rmtree, deleting the target file if it exists."""
994
 
    try:
995
 
        print "rm -r", path
996
 
        if not dry:
997
 
            shutil.rmtree(path, True)
998
 
    except OSError, (err, msg):
999
 
        if err != errno.EEXIST:
1000
 
            raise
1001
 
        # Otherwise, didn't exist, so we don't care
1002
 
 
1003
746
def action_rename(src, dst, dry):
1004
747
    """Calls rename. Deletes the target if it already exists."""
1005
 
    action_remove(dst, dry)
 
748
    if os.access(dst, os.F_OK):
 
749
        print "rm -r", dst
 
750
        if not dry:
 
751
            shutil.rmtree(dst, True)
1006
752
    print "mv ", src, dst
1007
753
    if dry: return
1008
754
    try:
1028
774
    directories as necessary.
1029
775
 
1030
776
    See shutil.copytree."""
1031
 
    # Allow copying over itself
1032
 
    if (os.path.normpath(os.path.join(os.getcwd(),src)) ==
1033
 
        os.path.normpath(os.path.join(os.getcwd(),dst))):
1034
 
        return
1035
 
    action_remove(dst, dry)
 
777
    if os.access(dst, os.F_OK):
 
778
        print "rm -r", dst
 
779
        if not dry:
 
780
            shutil.rmtree(dst, True)
1036
781
    print "cp -r", src, dst
1037
782
    if dry: return
1038
783
    shutil.copytree(src, dst, True)
1041
786
    """Hard-links an entire directory tree. Same as copytree but the created
1042
787
    files are hard-links not actual copies. Removes the existing destination.
1043
788
    """
1044
 
    action_remove(dst, dry)
 
789
    if os.access(dst, os.F_OK):
 
790
        print "rm -r", dst
 
791
        if not dry:
 
792
            shutil.rmtree(dst, True)
1045
793
    print "<cp with hardlinks> -r", src, dst
1046
794
    if dry: return
1047
795
    common.makeuser.linktree(src, dst)
1116
864
            | stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
1117
865
 
1118
866
def action_chmod_x(file, dry):
1119
 
    """Chmod 755 a file (sets permissions to rwxr-xr-x)."""
1120
 
    print "chmod 755", file
 
867
    """Chmod +xs a file (sets execute permission)."""
 
868
    print "chmod u+rwx", file
1121
869
    if not dry:
1122
 
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1123
 
            | stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
 
870
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR)
1124
871
 
1125
872
def query_user(default, prompt):
1126
873
    """Prompts the user for a string, which is read from a line of stdin.