← 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-02-25 02:54:45 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:563
install_proc: Notes on apt-get for epydoc and docutils.

Show diffs side-by-side

added added

removed removed

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