101
96
# 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',
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
98
# Needed by matplotlib
143
99
'/usr/lib/i686/cmov/libssl.so.0.9.8',
144
100
'/usr/lib/i686/cmov/libcrypto.so.0.9.8',
163
119
# Symlinks to make within the jail. Src mapped to dst.
165
'python%s' % PYTHON_VERSION: 'jail/usr/bin/python',
121
'python2.5': 'jail/usr/bin/python',
167
123
# Trees to copy. Src mapped to dst (these will be passed to action_copytree).
168
124
JAIL_COPYTREES = {
169
'/usr/lib/python%s' % PYTHON_VERSION:
170
'jail/usr/lib/python%s' % PYTHON_VERSION,
125
'/usr/lib/python2.5': 'jail/usr/lib/python2.5',
171
126
'/usr/share/matplotlib': 'jail/usr/share/matplotlib',
172
127
'/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
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
184
comment: (Long) comment string stored in conf.py. Each line of this
185
string should begin with a '#'.
187
self.option_name = option_name
188
self.default = default
190
self.comment = comment
192
# Configuration options, defaults and descriptions
194
config_options.append(ConfigOption("root_dir", "/ivle",
195
"""Root directory where IVLE is located (in URL space):""",
197
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
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 '
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):""",
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):""",
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
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:""",
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.
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:""",
254
### PostgreSQL Database config ###
255
# Database server hostname"""))
256
config_options.append(ConfigOption("db_port", "5432",
257
"""Port of the DB server:""",
259
# Database server port"""))
260
config_options.append(ConfigOption("db_dbname", "ivle",
261
"""Database name:""",
264
config_options.append(ConfigOption("db_user", "postgres",
265
"""Username for DB server login:""",
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)""",
272
# Database password"""))
274
130
# Try importing existing conf, but if we can't just set up defaults
275
131
# The reason for this is that these settings are used by other phases
276
132
# of setup besides conf, so we need to know them.
277
133
# Also this allows you to hit Return to accept the existing value.
279
confmodule = __import__("lib/conf/conf")
280
for opt in config_options:
282
globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
284
globals()[opt.option_name] = opt.default
135
confmodule = __import__("www/conf/conf")
137
root_dir = confmodule.root_dir
141
ivle_install_dir = confmodule.ivle_install_dir
143
ivle_install_dir = "/opt/ivle"
145
public_host = confmodule.public_host
147
public_host = "public.localhost"
149
jail_base = confmodule.jail_base
151
jail_base = "/home/informatics/jails"
153
subjects_base = confmodule.subjects_base
155
subjects_base = "/home/informatics/subjects"
285
156
except ImportError:
286
157
# Just set reasonable defaults
287
for opt in config_options:
288
globals()[opt.option_name] = opt.default
159
ivle_install_dir = "/opt/ivle"
160
public_host = "public.localhost"
161
jail_base = "/home/informatics/jails"
162
subjects_base = "/home/informatics/subjects"
290
166
# Try importing install_list, but don't fail if we can't, because listmake can
291
167
# function without it.
441
321
def listmake(args):
442
322
# We build two separate lists, by walking www and console
443
323
list_www = build_list_py_files('www')
444
list_lib = build_list_py_files('lib')
445
list_scripts = build_list_py_files('scripts')
324
list_console = build_list_py_files('console')
446
325
list_subjects = build_list_py_files('subjects', no_top_level=True)
447
list_problems = build_list_py_files('problems', no_top_level=True)
448
326
# Make sure that the files generated by conf are in the list
449
327
# (since listmake is typically run before conf)
450
if "lib/conf/conf.py" not in list_lib:
451
list_lib.append("lib/conf/conf.py")
328
if "www/conf/conf.py" not in list_www:
329
list_www.append("www/conf/conf.py")
452
330
# Make sure that console/python-console is in the list
453
if "scripts/python-console" not in list_scripts:
454
list_scripts.append("scripts/python-console")
455
if "scripts/fileservice" not in list_scripts:
456
list_scripts.append("scripts/fileservice")
331
if "console/python-console" not in list_console:
332
list_console.append("console/python-console")
457
333
# Write these out to a file
458
334
cwd = os.getcwd()
459
335
# the files that will be created/overwritten
561
426
print """This tool will create the following files:
565
429
prompting you for details about your configuration. The file will be
566
430
overwritten if it already exists. It will *not* install or deploy IVLE.
568
432
Please hit Ctrl+C now if you do not wish to do this.
569
""" % (conffile, jailconffile, conf_hfile)
433
""" % (conffile, conf_hfile)
571
435
# Get information from the administrator
572
436
# If EOF is encountered at any time during the questioning, just exit
575
for opt in config_options:
576
globals()[opt.option_name] = \
577
query_user(globals()[opt.option_name], opt.prompt)
439
root_dir = query_user(root_dir,
440
"""Root directory where IVLE is located (in URL space):""")
441
ivle_install_dir = query_user(ivle_install_dir,
442
'Root directory where IVLE will be installed (on the local file '
444
jail_base = query_user(jail_base,
445
"""Root directory where the jails (containing user files) are stored
446
(on the local file system):""")
447
subjects_base = query_user(subjects_base,
448
"""Root directory where the subject directories (containing worksheets
449
and other per-subject files) are stored (on the local file system):""")
450
public_host = query_user(public_host,
451
"""Hostname which will cause the server to go into "public mode",
452
providing login-free access to student's published work:""")
453
allowed_uids = query_user(allowed_uids,
454
"""UID of the web server process which will run IVLE.
455
Only this user may execute the trampoline. May specify multiple users as
456
a comma-separated list.
579
460
opts = dict(opts)
580
461
# Non-interactive mode. Parse the options.
581
for opt in config_options:
582
if '--' + opt.option_name in opts:
583
globals()[opt.option_name] = opts['--' + opt.option_name]
462
if '--root_dir' in opts:
463
root_dir = opts['--root_dir']
464
if '--ivle_install_dir' in opts:
465
ivle_install_dir = opts['--ivle_install_dir']
466
if '--jail_base' in opts:
467
jail_base = opts['--jail_base']
468
if '--subjects_base' in opts:
469
jail_base = opts['--subjects_base']
470
if '--public_host' in opts:
471
public_host = opts['--public_host']
472
if '--allowed_uids' in opts:
473
allowed_uids = opts['--allowed_uids']
585
475
# Error handling on input values
587
allowed_uids_list = map(int, allowed_uids.split(','))
477
allowed_uids = map(int, allowed_uids.split(','))
588
478
except ValueError:
589
479
print >>sys.stderr, (
590
480
"Invalid UID list (%s).\n"
591
481
"Must be a comma-separated list of integers." % allowed_uids)
594
db_port = int(db_port)
595
if db_port < 0 or db_port >= 65536: raise ValueError()
597
print >>sys.stderr, (
598
"Invalid DB port (%s).\n"
599
"Must be an integer between 0 and 65535." % repr(db_port))
602
# Write lib/conf/conf.py
484
# Write www/conf/conf.py
605
487
conf = open(conffile, "w")
609
491
# Miscellaneous application settings
612
for opt in config_options:
613
conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
614
repr(globals()[opt.option_name])))
617
except IOError, (errno, strerror):
618
print "IO error(%s): %s" % (errno, strerror)
621
print "Successfully wrote lib/conf/conf.py"
623
# Write conf/jailconf.py
626
conf = open(jailconffile, "w")
628
# In the "in-jail" version of conf, we don't need MOST of the details
629
# (it would be a security risk to have them here).
630
# So we just write root_dir, and jail_base is "/".
631
# (jail_base being "/" means "jail-relative" paths are relative to "/"
632
# when inside the jail.)
633
conf.write("""# IVLE Configuration File
635
# Miscellaneous application settings
636
# (User jail version)
639
494
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
641
496
# eg. "/" or "/ivle".
499
# In the local file system, where IVLE is actually installed.
500
# This directory should contain the "www" and "bin" directories.
501
ivle_install_dir = "%s"
503
# The server goes into "public mode" if the browser sends a request with this
504
# host. This is for security reasons - we only serve public student files on a
505
# separate domain to the main IVLE site.
506
# Public mode does not use cookies, and serves only public content.
507
# Private mode (normal mode) requires login, and only serves files relevant to
508
# the logged-in user.
644
511
# In the local file system, where are the student/user file spaces located.
645
512
# The user jails are expected to be located immediately in subdirectories of
649
# The hostname for serving publicly accessible pages
651
""" % (repr(root_dir),repr(public_host)))
516
# In the local file system, where are the per-subject file spaces located.
517
# The individual subject directories are expected to be located immediately
518
# in subdirectories of this location.
520
""" % (root_dir, ivle_install_dir, public_host, jail_base, subjects_base))
654
523
except IOError, (errno, strerror):
655
524
print "IO error(%s): %s" % (errno, strerror)
658
print "Successfully wrote lib/conf/jailconf.py"
527
print "Successfully wrote www/conf/conf.py"
660
529
# Write trampoline/conf.h
722
585
action_mkdir('jail/tmp', dry)
724
587
# Copy all console and operating system files into the jail
725
action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
588
action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
726
589
copy_os_files_jail(dry)
727
590
# Chmod the python console
728
action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
729
action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
591
action_chmod_x('jail/opt/ivle/console/python-console', dry)
731
# Also copy the IVLE lib directory into the jail
732
# This is necessary for running certain scripts
733
action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
734
# IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
735
# which could compromise security if left in the jail (such as the DB
737
# The "safe" version is in jailconf.py. Delete conf.py and replace it with
739
action_copyfile('lib/conf/jailconf.py',
740
'jail/opt/ivle/lib/conf/conf.py', dry)
742
594
# Compile .py files into .pyc or .pyo files
743
595
compileall.compile_dir('www', quiet=True)
744
compileall.compile_dir('lib', quiet=True)
745
compileall.compile_dir('scripts', quiet=True)
746
compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
748
# Set up ivle.pth inside the jail
749
# Need to set /opt/ivle/lib to be on the import path
751
"jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
752
f = open(ivle_pth, 'w')
753
f.write('/opt/ivle/lib\n')
596
compileall.compile_dir('console', quiet=True)
809
650
# for all the students' jails).
810
651
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
811
652
if not nosubjects:
812
# Copy the subjects and problems directories across
653
# Copy the subjects directory across
813
654
action_copylist(install_list.list_subjects, subjects_base, dry,
814
655
srcdir="./subjects")
815
action_copylist(install_list.list_problems, problems_base, dry,
818
657
# Append IVLE path to ivle.pth in python site packages
819
658
# (Unless it's already there)
820
659
ivle_pth = os.path.join(sys.prefix,
821
"lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
660
"lib/python2.5/site-packages/ivle.pth")
822
661
ivle_www = os.path.join(ivle_install_dir, "www")
823
ivle_lib = os.path.join(ivle_install_dir, "lib")
824
662
write_ivle_pth = True
825
write_ivle_lib_pth = True
827
664
file = open(ivle_pth, 'r')
828
665
for line in file:
829
666
if line.strip() == ivle_www:
830
667
write_ivle_pth = False
831
elif line.strip() == ivle_lib:
832
write_ivle_lib_pth = False
834
669
except (IOError, OSError):
836
671
if write_ivle_pth:
837
672
action_append(ivle_pth, ivle_www)
838
if write_ivle_lib_pth:
839
action_append(ivle_pth, ivle_lib)
added
removed
setup.py
