2
# IVLE - Informatics Virtual Learning Environment
3
# Copyright (C) 2007-2008 The University of Melbourne
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23
# This is a command-line application, for use by the administrator.
24
# This program configures, builds and installs IVLE in three separate steps.
25
# It is called with at least one argument, which specifies which operation to
28
# setup.py listmake (for developer use only)
29
# Recurses through the source tree and builds a list of all files which should
30
# be copied upon installation. This should be run by the developer before
31
# cutting a distribution, and the listfile it generates should be included in
32
# the distribution, avoiding the administrator having to run it.
34
# setup.py config [args]
35
# Configures IVLE with machine-specific details, most notably, various paths.
36
# Either prompts the administrator for these details or accepts them as
38
# Creates lib/conf/conf.py and trampoline/conf.h.
41
# Compiles all files and sets up a jail template in the source directory.
43
# Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
45
# Creates standard subdirs inside the jail, eg bin, opt, home, tmp.
46
# Copies console/ to a location within the jail.
47
# Copies OS programs and files to corresponding locations within the jail
48
# (eg. python and Python libs, ld.so, etc).
49
# Generates .pyc files for all the IVLE .py files.
51
# setup.py install [--nojail] [--dry|n]
53
# Create target install directory ($target).
55
# Copy trampoline/trampoline to $target/bin.
56
# chown and chmod the installed trampoline.
57
# Copy www/ to $target.
58
# Copy jail/ to jails template directory (unless --nojail specified).
73
# Import modules from the website is tricky since they're in the www
75
sys.path.append(os.path.join(os.getcwd(), 'lib'))
77
import common.makeuser
79
# Determine which Python version (2.4 or 2.5, for example) we are running,
80
# and use that as the filename to the Python directory.
81
# Just get the first 3 characters of sys.version.
82
PYTHON_VERSION = sys.version[0:3]
84
# Operating system files to copy over into the jail.
85
# These will be copied from the given place on the OS file system into the
86
# same place within the jail.
89
'/lib/tls/i686/cmov/libc.so.6',
90
'/lib/tls/i686/cmov/libdl.so.2',
91
'/lib/tls/i686/cmov/libm.so.6',
92
'/lib/tls/i686/cmov/libpthread.so.0',
93
'/lib/tls/i686/cmov/libutil.so.1',
96
# These 2 files do not exist in Ubuntu
97
#'/etc/ld.so.preload',
98
#'/etc/ld.so.nohwcap',
104
'/usr/bin/python%s' % PYTHON_VERSION,
105
# Needed by fileservice
106
'/lib/libcom_err.so.2',
107
'/lib/libcrypt.so.1',
108
'/lib/libkeyutils.so.1',
109
'/lib/libresolv.so.2',
112
'/usr/lib/libapr-1.so.0',
113
'/usr/lib/libaprutil-1.so.0',
114
'/usr/lib/libdb-4.4.so',
115
'/usr/lib/libexpat.so.1',
116
'/usr/lib/libgcrypt.so.11',
117
'/usr/lib/libgnutls.so.13',
118
'/usr/lib/libgpg-error.so.0',
119
'/usr/lib/libgssapi_krb5.so.2',
120
'/usr/lib/libk5crypto.so.3',
121
'/usr/lib/libkrb5.so.3',
122
'/usr/lib/libkrb5support.so.0',
123
'/usr/lib/liblber.so.2',
124
'/usr/lib/libldap_r.so.2',
125
'/usr/lib/libneon.so.26',
126
'/usr/lib/libpq.so.5',
127
'/usr/lib/libsasl2.so.2',
128
'/usr/lib/libsqlite3.so.0',
129
'/usr/lib/libsvn_client-1.so.1',
130
'/usr/lib/libsvn_delta-1.so.1',
131
'/usr/lib/libsvn_diff-1.so.1',
132
'/usr/lib/libsvn_fs-1.so.1',
133
'/usr/lib/libsvn_fs_base-1.so.1',
134
'/usr/lib/libsvn_fs_fs-1.so.1',
135
'/usr/lib/libsvn_ra-1.so.1',
136
'/usr/lib/libsvn_ra_dav-1.so.1',
137
'/usr/lib/libsvn_ra_local-1.so.1',
138
'/usr/lib/libsvn_ra_svn-1.so.1',
139
'/usr/lib/libsvn_repos-1.so.1',
140
'/usr/lib/libsvn_subr-1.so.1',
141
'/usr/lib/libsvn_wc-1.so.1',
142
'/usr/lib/libtasn1.so.3',
143
'/usr/lib/libxml2.so.2',
144
# Needed by matplotlib
145
'/usr/lib/i686/cmov/libssl.so.0.9.8',
146
'/usr/lib/i686/cmov/libcrypto.so.0.9.8',
147
'/lib/tls/i686/cmov/libnsl.so.1',
148
'/usr/lib/libz.so.1',
149
'/usr/lib/atlas/liblapack.so.3',
150
'/usr/lib/atlas/libblas.so.3',
151
'/usr/lib/libg2c.so.0',
152
'/usr/lib/libstdc++.so.6',
153
'/usr/lib/libfreetype.so.6',
154
'/usr/lib/libpng12.so.0',
155
'/usr/lib/libBLT.2.4.so.8.4',
156
'/usr/lib/libtk8.4.so.0',
157
'/usr/lib/libtcl8.4.so.0',
158
'/usr/lib/tcl8.4/init.tcl',
159
'/usr/lib/libX11.so.6',
160
'/usr/lib/libXau.so.6',
161
'/usr/lib/libXdmcp.so.6',
162
'/lib/libgcc_s.so.1',
165
'/lib/libnss_dns.so.2',
166
'/lib/libnss_mdns4_minimal.so.2',
171
'/etc/nsswitch.conf',
172
'/lib/libnss_files.so.2',
174
# Symlinks to make within the jail. Src mapped to dst.
176
'python%s' % PYTHON_VERSION: 'jail/usr/bin/python',
178
# Trees to copy. Src mapped to dst (these will be passed to action_copytree).
180
'/usr/lib/python%s' % PYTHON_VERSION:
181
'jail/usr/lib/python%s' % PYTHON_VERSION,
182
'/usr/share/matplotlib': 'jail/usr/share/matplotlib',
183
'/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
184
'/usr/share/nltk': 'jail/usr/share/nltk',
188
"""A configuration option; one of the things written to conf.py."""
189
def __init__(self, option_name, default, prompt, comment):
190
"""Creates a configuration option.
191
option_name: Name of the variable in conf.py. Also name of the
192
command-line argument to setup.py conf.
193
default: Default value for this variable.
194
prompt: (Short) string presented during the interactive prompt in
196
comment: (Long) comment string stored in conf.py. Each line of this
197
string should begin with a '#'.
199
self.option_name = option_name
200
self.default = default
202
self.comment = comment
204
# Configuration options, defaults and descriptions
206
config_options.append(ConfigOption("root_dir", "/",
207
"""Root directory where IVLE is located (in URL space):""",
209
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
211
# eg. "/" or "/ivle"."""))
212
config_options.append(ConfigOption("ivle_install_dir", "/opt/ivle",
213
'Root directory where IVLE will be installed (on the local file '
216
# In the local file system, where IVLE is actually installed.
217
# This directory should contain the "www" and "bin" directories."""))
218
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
219
"""Location of Directories
220
=======================
221
Root directory where the jails (containing user files) are stored
222
(on the local file system):""",
224
# In the local file system, where are the student/user file spaces located.
225
# The user jails are expected to be located immediately in subdirectories of
226
# this location."""))
227
config_options.append(ConfigOption("subjects_base",
228
"/home/informatics/subjects",
229
"""Root directory where the subject directories (containing worksheets
230
and other per-subject files) are stored (on the local file system):""",
232
# In the local file system, where are the per-subject file spaces located.
233
# The individual subject directories are expected to be located immediately
234
# in subdirectories of this location."""))
235
config_options.append(ConfigOption("exercises_base",
236
"/home/informatics/exercises",
237
"""Root directory where the exercise directories (containing
238
subject-independent exercise sheets) are stored (on the local file
241
# In the local file system, where are the subject-independent exercise sheet
242
# file spaces located."""))
243
config_options.append(ConfigOption("tos_path",
244
"/home/informatics/tos.html",
245
"""Location where the Terms of Service document is stored (on the local
248
# In the local file system, where is the Terms of Service document located."""))
249
config_options.append(ConfigOption("motd_path",
250
"/home/informatics/motd.html",
251
"""Location where the Message of the Day document is stored (on the local
254
# In the local file system, where is the Message of the Day document
255
# located. This is an HTML file (just the body fragment), which will
256
# be displayed on the login page. It is optional."""))
257
config_options.append(ConfigOption("public_host", "public.localhost",
258
"""Hostname which will cause the server to go into "public mode",
259
providing login-free access to student's published work:""",
261
# The server goes into "public mode" if the browser sends a request with this
262
# host. This is for security reasons - we only serve public student files on a
263
# separate domain to the main IVLE site.
264
# Public mode does not use cookies, and serves only public content.
265
# Private mode (normal mode) requires login, and only serves files relevant to
266
# the logged-in user."""))
267
config_options.append(ConfigOption("allowed_uids", "33",
268
"""UID of the web server process which will run IVLE.
269
Only this user may execute the trampoline. May specify multiple users as
270
a comma-separated list.
273
# The User-ID of the web server process which will run IVLE, and any other
274
# users who are allowed to run the trampoline. This is stores as a string of
275
# comma-separated integers, simply because it is not used within Python, only
276
# used by the setup program to write to conf.h (see setup.py config)."""))
277
config_options.append(ConfigOption("db_host", "localhost",
278
"""PostgreSQL Database config
279
==========================
280
Hostname of the DB server:""",
282
### PostgreSQL Database config ###
283
# Database server hostname"""))
284
config_options.append(ConfigOption("db_port", "5432",
285
"""Port of the DB server:""",
287
# Database server port"""))
288
config_options.append(ConfigOption("db_dbname", "ivle",
289
"""Database name:""",
292
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
293
"""Forum Database name:""",
295
# Forum Database name"""))
296
config_options.append(ConfigOption("db_user", "postgres",
297
"""Username for DB server login:""",
299
# Database username"""))
300
config_options.append(ConfigOption("db_password", "",
301
"""Password for DB server login:
302
(Caution: This password is stored in plaintext in lib/conf/conf.py)""",
304
# Database password"""))
305
config_options.append(ConfigOption("auth_modules", "ldap_auth",
306
"""Authentication config
307
=====================
308
Comma-separated list of authentication modules. Only "ldap" is available
311
# Comma-separated list of authentication modules.
312
# These refer to importable Python modules in the www/auth directory.
313
# Modules "ldap" and "guest" are available in the source tree, but
314
# other modules may be plugged in to auth against organisation-specific
315
# auth backends."""))
316
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
317
"""(LDAP options are only relevant if "ldap" is included in the list of
319
URL for LDAP authentication server:""",
321
# URL for LDAP authentication server"""))
322
config_options.append(ConfigOption("ldap_format_string",
323
"uid=%s,ou=users,o=example",
324
"""Format string for LDAP auth request:
325
(Must contain a single "%s" for the user's login name)""",
327
# Format string for LDAP auth request
328
# (Must contain a single "%s" for the user's login name)"""))
329
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
332
The base url for accessing subversion repositories:""",
334
# The base url for accessing subversion repositories."""))
335
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
336
"""The location of the subversion configuration file used by apache
337
to host the user repositories:""",
339
# The location of the subversion configuration file used by
340
# apache to host the user repositories."""))
341
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
342
"""The root directory for the subversion repositories:""",
344
# The root directory for the subversion repositories."""))
345
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
346
"""The location of the password file used to authenticate users
347
of the subversion repository from the ivle server:""",
349
# The location of the password file used to authenticate users
350
# of the subversion repository from the ivle server."""))
351
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
352
"""The location of the password file used to authenticate local users
353
of the subversion repository:""",
355
# The location of the password file used to authenticate local users
356
# of the subversion repository."""))
357
config_options.append(ConfigOption("usrmgt_host", "localhost",
358
"""User Management Server config
359
============================
360
The hostname where the usrmgt-server runs:""",
362
# The hostname where the usrmgt-server runs."""))
363
config_options.append(ConfigOption("usrmgt_port", "2178",
364
"""The port where the usrmgt-server runs:""",
366
# The port where the usrmgt-server runs."""))
367
config_options.append(ConfigOption("usrmgt_magic", "",
368
"""The password for the usrmgt-server:""",
370
# The password for the usrmgt-server."""))
372
# Try importing existing conf, but if we can't just set up defaults
373
# The reason for this is that these settings are used by other phases
374
# of setup besides conf, so we need to know them.
375
# Also this allows you to hit Return to accept the existing value.
377
confmodule = __import__("lib/conf/conf")
378
for opt in config_options:
380
globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
382
globals()[opt.option_name] = opt.default
384
# Just set reasonable defaults
385
for opt in config_options:
386
globals()[opt.option_name] = opt.default
388
# Try importing install_list, but don't fail if we can't, because listmake can
389
# function without it.
395
# Mime types which will automatically be placed in the list by listmake.
396
# Note that listmake is not intended to be run by the final user (the system
397
# administrator who installs this), so the developers can customize the list
398
# as necessary, and include it in the distribution.
399
listmake_mimetypes = ['text/x-python', 'text/html',
400
'application/x-javascript', 'application/javascript',
401
'text/css', 'image/png', 'image/gif', 'application/xml']
403
# Main function skeleton from Guido van Rossum
404
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
410
# Print the opening spiel including the GPL notice
412
print """IVLE - Informatics Virtual Learning Environment Setup
413
Copyright (C) 2007-2008 The University of Melbourne
414
IVLE comes with ABSOLUTELY NO WARRANTY.
415
This is free software, and you are welcome to redistribute it
416
under certain conditions. See LICENSE.txt for details.
421
# First argument is the name of the setup operation
425
# Print usage message and exit
429
# Disallow run as root unless installing
430
if (operation != 'install' and operation != 'updatejails'
431
and os.geteuid() == 0):
432
print >>sys.stderr, "I do not want to run this stage as root."
433
print >>sys.stderr, "Please run as a normal user."
435
# Call the requested operation's function
441
'listmake' : listmake,
443
'updatejails' : updatejails,
446
print >>sys.stderr, (
447
"""Invalid operation '%s'. Try python setup.py help."""
450
return oper_func(argv[2:])
452
# Operation functions
456
print """Usage: python setup.py operation [args]
457
Operation (and args) can be:
459
listmake (developer use only)
462
install [--nojail] [--nosubjects] [-n|--dry]
466
print """Usage: python setup.py help [operation]"""
471
if operation == 'help':
472
print """python setup.py help [operation]
473
Prints the usage message or detailed help on an operation, then exits."""
474
elif operation == 'listmake':
475
print """python setup.py listmake
476
(For developer use only)
477
Recurses through the source tree and builds a list of all files which should
478
be copied upon installation. This should be run by the developer before
479
cutting a distribution, and the listfile it generates should be included in
480
the distribution, avoiding the administrator having to run it."""
481
elif operation == 'config':
482
print """python setup.py config [args]
483
Configures IVLE with machine-specific details, most notably, various paths.
484
Either prompts the administrator for these details or accepts them as
485
command-line args. Will be interactive only if there are no arguments given.
486
Takes defaults from existing conf file if it exists.
488
To run IVLE out of the source directory (allowing development without having
489
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
490
directory, and run build/install one time.
492
Creates lib/conf/conf.py and trampoline/conf.h.
495
for opt in config_options:
496
print " --" + opt.option_name
497
print """As explained in the interactive prompt or conf.py.
499
elif operation == 'build':
500
print """python -O setup.py build [--dry|-n]
501
Compiles all files and sets up a jail template in the source directory.
502
-O is recommended to cause compilation to be optimised.
504
Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
506
Creates standard subdirs inside the jail, eg bin, opt, home, tmp.
507
Copies console/ to a location within the jail.
508
Copies OS programs and files to corresponding locations within the jail
509
(eg. python and Python libs, ld.so, etc).
510
Generates .pyc or .pyo files for all the IVLE .py files.
512
--dry | -n Print out the actions but don't do anything."""
513
elif operation == 'install':
514
print """sudo python setup.py install [--nojail] [--nosubjects][--dry|-n]
516
Create target install directory ($target).
518
Copy trampoline/trampoline to $target/bin.
519
chown and chmod the installed trampoline.
520
Copy www/ to $target.
521
Copy jail/ to jails template directory (unless --nojail specified).
522
Copy subjects/ to subjects directory (unless --nosubjects specified).
524
--nojail Do not copy the jail.
525
--nosubjects Do not copy the subjects and exercises directories.
526
--dry | -n Print out the actions but don't do anything."""
527
elif operation == 'updatejails':
528
print """sudo python setup.py updatejails [--dry|-n]
530
Copy jail/ to each subdirectory in jails directory.
532
--dry | -n Print out the actions but don't do anything."""
534
print >>sys.stderr, (
535
"""Invalid operation '%s'. Try python setup.py help."""
540
# We build two separate lists, by walking www and console
541
list_www = build_list_py_files('www')
542
list_lib = build_list_py_files('lib')
543
list_subjects = build_list_py_files('subjects', no_top_level=True)
544
list_exercises = build_list_py_files('exercises', no_top_level=True)
546
"scripts/python-console",
547
"scripts/fileservice",
548
"scripts/serveservice",
549
"scripts/usrmgt-server",
550
"scripts/diffservice",
552
# Make sure that the files generated by conf are in the list
553
# (since listmake is typically run before conf)
554
if "lib/conf/conf.py" not in list_lib:
555
list_lib.append("lib/conf/conf.py")
556
# Write these out to a file
558
# the files that will be created/overwritten
559
listfile = os.path.join(cwd, "install_list.py")
562
file = open(listfile, "w")
564
file.write("""# IVLE Configuration File
566
# Provides lists of all files to be installed by `setup.py install' from
567
# certain directories.
568
# Note that any files with the given filename plus 'c' or 'o' (that is,
569
# compiled .pyc or .pyo files) will be copied as well.
571
# List of all installable files in www directory.
573
writelist_pretty(file, list_www)
575
# List of all installable files in lib directory.
577
writelist_pretty(file, list_lib)
579
# List of all installable files in scripts directory.
581
writelist_pretty(file, list_scripts)
583
# List of all installable files in subjects directory.
584
# This is to install sample subjects and material.
586
writelist_pretty(file, list_subjects)
588
# List of all installable files in exercises directory.
589
# This is to install sample exercise material.
590
list_exercises = """)
591
writelist_pretty(file, list_exercises)
594
except IOError, (errno, strerror):
595
print "IO error(%s): %s" % (errno, strerror)
598
print "Successfully wrote install_list.py"
601
print ("You may modify the set of installable files before cutting the "
608
def build_list_py_files(dir, no_top_level=False):
609
"""Builds a list of all py files found in a directory and its
610
subdirectories. Returns this as a list of strings.
611
no_top_level=True means the file paths will not include the top-level
615
for (dirpath, dirnames, filenames) in os.walk(dir):
616
# Exclude directories beginning with a '.' (such as '.svn')
617
filter_mutate(lambda x: x[0] != '.', dirnames)
618
# All *.py files are added to the list
619
pylist += [os.path.join(dirpath, item) for item in filenames
620
if mimetypes.guess_type(item)[0] in listmake_mimetypes]
622
for i in range(0, len(pylist)):
623
_, pylist[i] = pylist[i].split(os.sep, 1)
626
def writelist_pretty(file, list):
627
"""Writes a list one element per line, to a file."""
633
file.write(' %s,\n' % repr(elem))
637
global db_port, usrmgt_port
638
# Set up some variables
641
# the files that will be created/overwritten
642
conffile = os.path.join(cwd, "lib/conf/conf.py")
643
jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
644
conf_hfile = os.path.join(cwd, "trampoline/conf.h")
645
phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
646
usrmgtserver_initdfile = os.path.join(cwd, "doc/setup/usrmgt-server.init")
648
# Get command-line arguments to avoid asking questions.
651
for opt in config_options:
652
optnames.append(opt.option_name + "=")
653
(opts, args) = getopt.gnu_getopt(args, "", optnames)
656
print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
660
# Interactive mode. Prompt the user for all the values.
662
print """This tool will create the following files:
668
prompting you for details about your configuration. The file will be
669
overwritten if it already exists. It will *not* install or deploy IVLE.
671
Please hit Ctrl+C now if you do not wish to do this.
672
""" % (conffile, jailconffile, conf_hfile, phpBBconffile, usrmgtserver_initdfile)
674
# Get information from the administrator
675
# If EOF is encountered at any time during the questioning, just exit
678
for opt in config_options:
679
globals()[opt.option_name] = \
680
query_user(globals()[opt.option_name], opt.prompt)
683
# Non-interactive mode. Parse the options.
684
for opt in config_options:
685
if '--' + opt.option_name in opts:
686
globals()[opt.option_name] = opts['--' + opt.option_name]
688
# Error handling on input values
690
allowed_uids_list = map(int, allowed_uids.split(','))
692
print >>sys.stderr, (
693
"Invalid UID list (%s).\n"
694
"Must be a comma-separated list of integers." % allowed_uids)
697
db_port = int(db_port)
698
if db_port < 0 or db_port >= 65536: raise ValueError()
700
print >>sys.stderr, (
701
"Invalid DB port (%s).\n"
702
"Must be an integer between 0 and 65535." % repr(db_port))
705
usrmgt_port = int(usrmgt_port)
706
if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
708
print >>sys.stderr, (
709
"Invalid user management port (%s).\n"
710
"Must be an integer between 0 and 65535." % repr(usrmgt_port))
713
# Generate the forum secret
714
forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
716
# Write lib/conf/conf.py
719
conf = open(conffile, "w")
721
conf.write("""# IVLE Configuration File
723
# Miscellaneous application settings
726
for opt in config_options:
727
conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
728
repr(globals()[opt.option_name])))
730
# Add the forum secret to the config file (regenerated each config)
731
conf.write('forum_secret = "%s"\n' % (forum_secret))
734
except IOError, (errno, strerror):
735
print "IO error(%s): %s" % (errno, strerror)
738
print "Successfully wrote lib/conf/conf.py"
740
# Write conf/jailconf.py
743
conf = open(jailconffile, "w")
745
# In the "in-jail" version of conf, we don't need MOST of the details
746
# (it would be a security risk to have them here).
747
# So we just write root_dir, and jail_base is "/".
748
# (jail_base being "/" means "jail-relative" paths are relative to "/"
749
# when inside the jail.)
750
conf.write("""# IVLE Configuration File
752
# Miscellaneous application settings
753
# (User jail version)
756
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
758
# eg. "/" or "/ivle".
761
# In the local file system, where are the student/user file spaces located.
762
# The user jails are expected to be located immediately in subdirectories of
766
# The hostname for serving publicly accessible pages
768
""" % (repr(root_dir),repr(public_host)))
771
except IOError, (errno, strerror):
772
print "IO error(%s): %s" % (errno, strerror)
775
print "Successfully wrote lib/conf/jailconf.py"
777
# Write trampoline/conf.h
780
conf = open(conf_hfile, "w")
782
conf.write("""/* IVLE Configuration File
784
* Administrator settings required by trampoline.
785
* Note: trampoline will have to be rebuilt in order for changes to this file
789
/* In the local file system, where are the jails located.
790
* The trampoline does not allow the creation of a jail anywhere besides
791
* jail_base or a subdirectory of jail_base.
793
static const char* jail_base = "%s";
795
/* Which user IDs are allowed to run the trampoline.
796
* This list should be limited to the web server user.
797
* (Note that root is an implicit member of this list).
799
static const int allowed_uids[] = { %s };
800
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
801
# Note: The above uses PYTHON reprs, not C reprs
802
# However they should be the same with the exception of the outer
803
# characters, which are stripped off and replaced
806
except IOError, (errno, strerror):
807
print "IO error(%s): %s" % (errno, strerror)
810
print "Successfully wrote trampoline/conf.h"
812
# Write www/php/phpBB3/config.php
815
conf = open(phpBBconffile, "w")
818
if db_host == 'localhost':
819
forumdb_host = '127.0.0.1'
821
forumdb_host = db_host
824
// phpBB 3.0.x auto-generated configuration file
825
// Do not change anything in this file!
827
$dbhost = '""" + forumdb_host + """';
828
$dbport = '""" + str(db_port) + """';
829
$dbname = '""" + db_forumdbname + """';
830
$dbuser = '""" + db_user + """';
831
$dbpasswd = '""" + db_password + """';
833
$table_prefix = 'phpbb_';
835
$load_extensions = '';
836
@define('PHPBB_INSTALLED', true);
837
// @define('DEBUG', true);
838
//@define('DEBUG_EXTRA', true);
840
$forum_secret = '""" + forum_secret +"""';
844
except IOError, (errno, strerror):
845
print "IO error(%s): %s" % (errno, strerror)
848
print "Successfully wrote www/php/phpBB3/config.php"
850
# Write lib/conf/usrmgt-server.init
853
conf = open(usrmgtserver_initdfile, "w")
855
conf.write( '''#! /bin/sh
857
# Works for Ubuntu. Check before using on other distributions
860
# Provides: usrmgt-server
861
# Required-Start: $syslog $networking $urandom
862
# Required-Stop: $syslog
863
# Default-Start: 2 3 4 5
865
# Short-Description: IVLE user management server
866
# Description: Daemon connecting to the IVLE user management database.
869
PATH=/sbin:/bin:/usr/sbin:/usr/bin
870
DESC="IVLE user management server"
872
DAEMON=/opt/ivle/scripts/$NAME
873
DAEMON_ARGS="''' + str(usrmgt_port) + ''' ''' + usrmgt_magic + '''"
874
PIDFILE=/var/run/$NAME.pid
875
SCRIPTNAME=/etc/init.d/usrmgt-server
877
# Exit if the daemon does not exist
878
test -f $DAEMON || exit 0
880
# Load the VERBOSE setting and other rcS variables
881
[ -f /etc/default/rcS ] && . /etc/default/rcS
883
# Define LSB log_* functions.
884
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
885
. /lib/lsb/init-functions
888
# Function that starts the daemon/service
893
# 0 if daemon has been started
894
# 1 if daemon was already running
895
# 2 if daemon could not be started
896
start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
898
start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
901
# Add code here, if necessary, that waits for the process to be ready
902
# to handle requests from services started subsequently which depend
903
# on this one. As a last resort, sleep for some time.
907
# Function that stops the daemon/service
912
# 0 if daemon has been stopped
913
# 1 if daemon was already stopped
914
# 2 if daemon could not be stopped
915
# other if a failure occurred
916
start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
918
[ "$RETVAL" = 2 ] && return 2
919
# Wait for children to finish too if this is a daemon that forks
920
# and if the daemon is only ever run from this initscript.
921
# If the above conditions are not satisfied then add some other code
922
# that waits for the process to drop all resources that could be
923
# needed by services started subsequently. A last resort is to
924
# sleep for some time.
925
start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
926
[ "$?" = 2 ] && return 2
927
# Many daemons don't delete their pidfiles when they exit.
933
# Function that sends a SIGHUP to the daemon/service
937
# If the daemon can reload its configuration without
938
# restarting (for example, when it is sent a SIGHUP),
939
# then implement that here.
941
start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
947
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
950
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
951
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
955
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
958
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
959
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
962
#reload|force-reload)
964
# If do_reload() is not implemented then leave this commented out
965
# and leave 'force-reload' as an alias for 'restart'.
967
#log_daemon_msg "Reloading $DESC" "$NAME"
971
restart|force-reload)
973
# If the "reload" option is implemented then remove the
974
# 'force-reload' alias
976
log_daemon_msg "Restarting $DESC" "$NAME"
983
1) log_end_msg 1 ;; # Old process is still running
984
*) log_end_msg 1 ;; # Failed to start
994
#echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
995
echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
1004
except IOError, (errno, strerror):
1005
print "IO error(%s): %s" % (errno, strerror)
1008
# fix permissions as the file contains the database password
1010
os.chmod('doc/setup/usrmgt-server.init', 0600)
1011
except OSError, (errno, strerror):
1012
print "WARNING: Couldn't chmod doc/setup/usrmgt-server.init:"
1013
print "OS error(%s): %s" % (errno, strerror)
1015
print "Successfully wrote lib/conf/usrmgt-server.init"
1018
print "You may modify the configuration at any time by editing"
1023
print usrmgtserver_initdfile
1028
# Get "dry" variable from command line
1029
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
1031
dry = '-n' in opts or '--dry' in opts
1034
print "Dry run (no actions will be executed\n"
1036
# Compile the trampoline
1037
curdir = os.getcwd()
1038
os.chdir('trampoline')
1039
action_runprog('make', [], dry)
1042
# Create the jail and its subdirectories
1043
# Note: Other subdirs will be made by copying files
1044
action_mkdir('jail', dry)
1045
action_mkdir('jail/home', dry)
1046
action_mkdir('jail/tmp', dry)
1048
# Chmod the tmp directory to world writable
1049
action_chmod_w('jail/tmp', dry)
1051
# Copy all console and operating system files into the jail
1052
action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
1053
copy_os_files_jail(dry)
1054
# Chmod the python console
1055
action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
1056
action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
1057
action_chmod_x('jail/opt/ivle/scripts/serveservice', dry)
1059
# Also copy the IVLE lib directory into the jail
1060
# This is necessary for running certain scripts
1061
action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
1062
# IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
1063
# which could compromise security if left in the jail (such as the DB
1065
# The "safe" version is in jailconf.py. Delete conf.py and replace it with
1067
action_copyfile('lib/conf/jailconf.py',
1068
'jail/opt/ivle/lib/conf/conf.py', dry)
1070
# Compile .py files into .pyc or .pyo files
1071
compileall.compile_dir('www', quiet=True)
1072
compileall.compile_dir('lib', quiet=True)
1073
compileall.compile_dir('scripts', quiet=True)
1074
compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
1076
# Set up ivle.pth inside the jail
1077
# Need to set /opt/ivle/lib to be on the import path
1079
"jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
1080
f = open(ivle_pth, 'w')
1081
f.write('/opt/ivle/lib\n')
1086
def copy_os_files_jail(dry):
1087
"""Copies necessary Operating System files from their usual locations
1088
into the jail/ directory of the cwd."""
1089
# Currently source paths are configured for Ubuntu.
1090
for filename in JAIL_FILES:
1091
copy_file_to_jail(filename, dry)
1092
for src, dst in JAIL_LINKS.items():
1093
action_symlink(src, dst, dry)
1094
for src, dst in JAIL_COPYTREES.items():
1095
action_copytree(src, dst, dry)
1097
def copy_file_to_jail(src, dry):
1098
"""Copies a single file from an absolute location into the same location
1099
within the jail. src must begin with a '/'. The jail will be located
1100
in a 'jail' subdirectory of the current path."""
1101
action_copyfile(src, 'jail' + src, dry)
1104
# Get "dry" and "nojail" variables from command line
1105
(opts, args) = getopt.gnu_getopt(args, "n",
1106
['dry', 'nojail', 'nosubjects'])
1108
dry = '-n' in opts or '--dry' in opts
1109
nojail = '--nojail' in opts
1110
nosubjects = '--nosubjects' in opts
1113
print "Dry run (no actions will be executed\n"
1115
if not dry and os.geteuid() != 0:
1116
print >>sys.stderr, "Must be root to run install"
1117
print >>sys.stderr, "(I need to chown some files)."
1120
# Create the target (install) directory
1121
action_mkdir(ivle_install_dir, dry)
1123
# Create bin and copy the compiled files there
1124
action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
1125
tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
1126
action_copyfile('trampoline/trampoline', tramppath, dry)
1127
# chown trampoline to root and set setuid bit
1128
action_chown_setuid(tramppath, dry)
1130
# Create a scripts directory to put the usrmgt-server in.
1131
action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
1132
usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
1133
action_copyfile('scripts/usrmgt-server', usrmgtpath, dry)
1134
action_chmod_x(usrmgtpath, dry)
1136
# Copy the www and lib directories using the list
1137
action_copylist(install_list.list_www, ivle_install_dir, dry)
1138
action_copylist(install_list.list_lib, ivle_install_dir, dry)
1140
# Copy the php directory
1141
forum_dir = "www/php/phpBB3"
1142
forum_path = os.path.join(ivle_install_dir, forum_dir)
1143
action_copytree(forum_dir, forum_path, dry)
1144
print "chown -R www-data:www-data %s" % forum_path
1146
os.system("chown -R www-data:www-data %s" % forum_path)
1149
# Copy the local jail directory built by the build action
1150
# to the jails template directory (it will be used as a template
1151
# for all the students' jails).
1152
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
1154
# Copy the subjects and exercises directories across
1155
action_copylist(install_list.list_subjects, subjects_base, dry,
1156
srcdir="./subjects")
1157
action_copylist(install_list.list_exercises, exercises_base, dry,
1158
srcdir="./exercises")
1160
# Append IVLE path to ivle.pth in python site packages
1161
# (Unless it's already there)
1162
ivle_pth = os.path.join(sys.prefix,
1163
"lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
1164
ivle_www = os.path.join(ivle_install_dir, "www")
1165
ivle_lib = os.path.join(ivle_install_dir, "lib")
1166
write_ivle_pth = True
1167
write_ivle_lib_pth = True
1169
file = open(ivle_pth, 'r')
1171
if line.strip() == ivle_www:
1172
write_ivle_pth = False
1173
elif line.strip() == ivle_lib:
1174
write_ivle_lib_pth = False
1176
except (IOError, OSError):
1179
action_append(ivle_pth, ivle_www)
1180
if write_ivle_lib_pth:
1181
action_append(ivle_pth, ivle_lib)
1185
def updatejails(args):
1186
# Get "dry" variable from command line
1187
(opts, args) = getopt.gnu_getopt(args, "n", ['dry'])
1189
dry = '-n' in opts or '--dry' in opts
1192
print "Dry run (no actions will be executed\n"
1194
if not dry and os.geteuid() != 0:
1195
print >>sys.stderr, "Must be root to run install"
1196
print >>sys.stderr, "(I need to chown some files)."
1199
# Update the template jail directory in case it hasn't been installed
1201
action_copytree('jail', os.path.join(jail_base, 'template'), dry)
1203
# Re-link all the files in all students jails.
1204
for dir in os.listdir(jail_base):
1205
if dir == 'template': continue
1206
# First back up the student's home directory
1207
temp_home = os.tmpnam()
1208
action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
1209
# Delete the student's jail and relink the jail files
1210
action_linktree(os.path.join(jail_base, 'template'),
1211
os.path.join(jail_base, dir), dry)
1212
# Restore the student's home directory
1213
action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
1214
# Set up the user's home directory just in case they don't have a
1215
# directory for this yet
1216
action_mkdir(os.path.join(jail_base, dir, 'home', dir), dry)
1220
# The actions call Python os functions but print actions and handle dryness.
1221
# May still throw os exceptions if errors occur.
1224
"""Represents an error when running a program (nonzero return)."""
1225
def __init__(self, prog, retcode):
1227
self.retcode = retcode
1229
return str(self.prog) + " returned " + repr(self.retcode)
1231
def action_runprog(prog, args, dry):
1232
"""Runs a unix program. Searches in $PATH. Synchronous (waits for the
1233
program to return). Runs in the current environment. First prints the
1234
action as a "bash" line.
1236
Throws a RunError with a retcode of the return value of the program,
1237
if the program did not return 0.
1239
prog: String. Name of the program. (No path required, if in $PATH).
1240
args: [String]. Arguments to the program.
1241
dry: Bool. If True, prints but does not execute.
1243
print prog, string.join(args, ' ')
1245
ret = os.spawnvp(os.P_WAIT, prog, args)
1247
raise RunError(prog, ret)
1249
def action_remove(path, dry):
1250
"""Calls rmtree, deleting the target file if it exists."""
1254
shutil.rmtree(path, True)
1255
except OSError, (err, msg):
1256
if err != errno.EEXIST:
1258
# Otherwise, didn't exist, so we don't care
1260
def action_rename(src, dst, dry):
1261
"""Calls rename. Deletes the target if it already exists."""
1262
action_remove(dst, dry)
1263
print "mv ", src, dst
1267
except OSError, (err, msg):
1268
if err != errno.EEXIST:
1271
def action_mkdir(path, dry):
1272
"""Calls mkdir. Silently ignored if the directory already exists.
1273
Creates all parent directories as necessary."""
1274
print "mkdir -p", path
1278
except OSError, (err, msg):
1279
if err != errno.EEXIST:
1282
def action_copytree(src, dst, dry):
1283
"""Copies an entire directory tree. Symlinks are seen as normal files and
1284
copies of the entire file (not the link) are made. Creates all parent
1285
directories as necessary.
1287
See shutil.copytree."""
1288
# Allow copying over itself
1289
if (os.path.normpath(os.path.join(os.getcwd(),src)) ==
1290
os.path.normpath(os.path.join(os.getcwd(),dst))):
1292
action_remove(dst, dry)
1293
print "cp -r", src, dst
1295
shutil.copytree(src, dst, True)
1297
def action_linktree(src, dst, dry):
1298
"""Hard-links an entire directory tree. Same as copytree but the created
1299
files are hard-links not actual copies. Removes the existing destination.
1301
action_remove(dst, dry)
1302
print "<cp with hardlinks> -r", src, dst
1304
common.makeuser.linktree(src, dst)
1306
def action_copylist(srclist, dst, dry, srcdir="."):
1307
"""Copies all files in a list to a new location. The files in the list
1308
are read relative to the current directory, and their destinations are the
1309
same paths relative to dst. Creates all parent directories as necessary.
1310
srcdir is "." by default, can be overridden.
1312
for srcfile in srclist:
1313
dstfile = os.path.join(dst, srcfile)
1314
srcfile = os.path.join(srcdir, srcfile)
1315
dstdir = os.path.split(dstfile)[0]
1316
if not os.path.isdir(dstdir):
1317
action_mkdir(dstdir, dry)
1318
print "cp -f", srcfile, dstfile
1321
shutil.copyfile(srcfile, dstfile)
1322
shutil.copymode(srcfile, dstfile)
1323
except shutil.Error:
1326
def action_copyfile(src, dst, dry):
1327
"""Copies one file to a new location. Creates all parent directories
1329
Warn if file not found.
1331
dstdir = os.path.split(dst)[0]
1332
if not os.path.isdir(dstdir):
1333
action_mkdir(dstdir, dry)
1334
print "cp -f", src, dst
1337
shutil.copyfile(src, dst)
1338
shutil.copymode(src, dst)
1339
except (shutil.Error, IOError), e:
1340
print "Warning: " + str(e)
1342
def action_symlink(src, dst, dry):
1343
"""Creates a symlink in a given location. Creates all parent directories
1346
dstdir = os.path.split(dst)[0]
1347
if not os.path.isdir(dstdir):
1348
action_mkdir(dstdir, dry)
1349
# Delete existing file
1350
if os.path.exists(dst):
1352
print "ln -fs", src, dst
1354
os.symlink(src, dst)
1356
def action_append(ivle_pth, ivle_www):
1357
file = open(ivle_pth, 'a+')
1358
file.write(ivle_www + '\n')
1361
def action_chown_setuid(file, dry):
1362
"""Chowns a file to root, and sets the setuid bit on the file.
1363
Calling this function requires the euid to be root.
1364
The actual mode of path is set to: rws--s--s
1366
print "chown root:root", file
1368
os.chown(file, 0, 0)
1369
print "chmod a+xs", file
1370
print "chmod u+rw", file
1372
os.chmod(file, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
1373
| stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
1375
def action_chmod_x(file, dry):
1376
"""Chmod 755 a file (sets permissions to rwxr-xr-x)."""
1377
print "chmod 755", file
1379
os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1380
| stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
1383
def action_chmod_w(file, dry):
1384
"""Chmod 777 a file (sets permissions to rwxrwxrwx)."""
1385
print "chmod 777", file
1387
os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
1388
| stat.S_IXGRP | stat.S_IWGRP | stat.S_IRGRP | stat.S_IXOTH
1389
| stat.S_IWOTH | stat.S_IROTH)
1391
def query_user(default, prompt):
1392
"""Prompts the user for a string, which is read from a line of stdin.
1393
Exits silently if EOF is encountered. Returns the string, with spaces
1394
removed from the beginning and end.
1396
Returns default if a 0-length line (after spaces removed) was read.
1398
sys.stdout.write('%s\n (default: "%s")\n>' % (prompt, default))
1400
val = sys.stdin.readline()
1401
except KeyboardInterrupt:
1403
sys.stdout.write("\n")
1405
sys.stdout.write("\n")
1407
if val == '': sys.exit(1)
1408
# If empty line, return default
1410
if val == '': return default
1413
def filter_mutate(function, list):
1414
"""Like built-in filter, but mutates the given list instead of returning a
1415
new one. Returns None."""
1418
# Delete elements which do not match
1419
if not function(list[i]):
1423
if __name__ == "__main__":
added
removed
setup.py
