← 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-06-13 09:13:30 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:763
Zip file uploading now works.
(Patch submitted by wagrant, modified and approved by mgiuca).

2 bugs fixed: Paths were being created as filesystem-relative which should
have been jail-relative. Zip was being passed the string contents of the file,
when it should have been passed the file object.

common/zip.py: Now accepts an absolute path, not a URL path.
    (Doesn't munge the path).
    This is so it can be called from inside or outside the jail;
    the caller decides which filesystem it is relative to.
fileservice_lib/action.py:
    1. Now passes the absolute path within the jail.
    2. Now passes the field "file" not "data" (file object, not string).
        Static Typing: Sometimes It Is Good

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.
55
55
# Copy trampoline/trampoline to $target/bin.
56
56
# chown and chmod the installed trampoline.
57
57
# Copy www/ to $target.
58
 
# Copy jail/ to jails template directory (unless --nojail specified).
 
58
# Copy jail/ to jails __staging__ directory (unless --nojail specified).
59
59
 
60
60
import os
61
61
import stat
67
67
import mimetypes
68
68
import compileall
69
69
import getopt
 
70
import hashlib
 
71
import uuid
 
72
import pysvn
70
73
 
71
74
# Import modules from the website is tricky since they're in the www
72
75
# directory.
73
 
sys.path.append(os.path.join(os.getcwd(), 'www'))
 
76
sys.path.append(os.path.join(os.getcwd(), 'lib'))
74
77
import conf
75
78
import common.makeuser
76
79
 
100
103
    '/bin/echo',
101
104
    # Needed by python
102
105
    '/usr/bin/python%s' % PYTHON_VERSION,
 
106
    # Needed by fileservice
 
107
    '/lib/libcom_err.so.2',
 
108
    '/lib/libcrypt.so.1',
 
109
    '/lib/libkeyutils.so.1',
 
110
    '/lib/libresolv.so.2',
 
111
    '/lib/librt.so.1',
 
112
    '/lib/libuuid.so.1',
 
113
    '/usr/lib/libapr-1.so.0',
 
114
    '/usr/lib/libaprutil-1.so.0',
 
115
    '/usr/lib/libapt-pkg-libc6.6-6.so.4.5',
 
116
    '/usr/lib/libdb-4.6.so',
 
117
    '/usr/lib/libexpat.so.1',
 
118
    '/usr/lib/libgcrypt.so.11',
 
119
    '/usr/lib/libgnutls.so.13',
 
120
    '/usr/lib/libgpg-error.so.0',
 
121
    '/usr/lib/libgssapi_krb5.so.2',
 
122
    '/usr/lib/libk5crypto.so.3',
 
123
    '/usr/lib/libkrb5.so.3',
 
124
    '/usr/lib/libkrb5support.so.0',
 
125
    '/usr/lib/liblber.so.2',
 
126
    '/usr/lib/liblber-2.4.so.2',
 
127
    '/usr/lib/libldap_r.so.2',
 
128
    '/usr/lib/libldap_r-2.4.so.2',
 
129
    '/usr/lib/libneon.so.27',
 
130
    '/usr/lib/libpq.so.5',
 
131
    '/usr/lib/libsasl2.so.2',
 
132
    '/usr/lib/libsqlite3.so.0',
 
133
    '/usr/lib/libsvn_client-1.so.1',
 
134
    '/usr/lib/libsvn_delta-1.so.1',
 
135
    '/usr/lib/libsvn_diff-1.so.1',
 
136
    '/usr/lib/libsvn_fs-1.so.1',
 
137
    '/usr/lib/libsvn_fs_base-1.so.1',
 
138
    '/usr/lib/libsvn_fs_fs-1.so.1',
 
139
    '/usr/lib/libsvn_ra-1.so.1',
 
140
    '/usr/lib/libsvn_ra_dav-1.so.1',
 
141
    '/usr/lib/libsvn_ra_local-1.so.1',
 
142
    '/usr/lib/libsvn_ra_svn-1.so.1',
 
143
    '/usr/lib/libsvn_repos-1.so.1',
 
144
    '/usr/lib/libsvn_subr-1.so.1',
 
145
    '/usr/lib/libsvn_wc-1.so.1',
 
146
    '/usr/lib/libtasn1.so.3',
 
147
    '/usr/lib/libxml2.so.2',
103
148
    # Needed by matplotlib
104
149
    '/usr/lib/i686/cmov/libssl.so.0.9.8',
105
150
    '/usr/lib/i686/cmov/libcrypto.so.0.9.8',
120
165
    '/usr/lib/libXdmcp.so.6',
121
166
    '/lib/libgcc_s.so.1',
122
167
    '/etc/matplotlibrc',
 
168
    # Needed for resolv
 
169
    '/lib/libnss_dns.so.2',
 
170
    '/lib/libnss_mdns4_minimal.so.2',
 
171
    '/etc/hosts',
 
172
    '/etc/resolv.conf',
 
173
    #'/etc/hosts.conf',
 
174
    #'/etc/hostname',
 
175
    '/etc/nsswitch.conf',
 
176
    '/lib/libnss_files.so.2',
 
177
    # Needed for PIL
 
178
    '/usr/lib/libjpeg.so.62',
 
179
    # Needed by lxml
 
180
    '/usr/lib/libxslt.so.1',
 
181
    '/usr/lib/libexslt.so.0',
 
182
    # Needed by elementtree
 
183
    '/usr/lib/libtidy-0.99.so.0',
123
184
]
124
185
# Symlinks to make within the jail. Src mapped to dst.
125
186
JAIL_LINKS = {
129
190
JAIL_COPYTREES = {
130
191
    '/usr/lib/python%s' % PYTHON_VERSION:
131
192
        'jail/usr/lib/python%s' % PYTHON_VERSION,
 
193
    '/var/lib/python-support/python%s' % PYTHON_VERSION:
 
194
        'jail/var/lib/python-support/python%s' %PYTHON_VERSION,
132
195
    '/usr/share/matplotlib': 'jail/usr/share/matplotlib',
133
196
    '/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
 
197
    '/usr/share/pycentral': 'jail/usr/share/pycentral',
 
198
    '/usr/share/pycentral-data': 'jail/usr/share/pycentral-data',
 
199
    '/usr/share/nltk': 'jail/usr/share/nltk',
134
200
}
135
201
 
136
202
class ConfigOption:
152
218
 
153
219
# Configuration options, defaults and descriptions
154
220
config_options = []
155
 
config_options.append(ConfigOption("root_dir", "/ivle",
 
221
config_options.append(ConfigOption("root_dir", "/",
156
222
    """Root directory where IVLE is located (in URL space):""",
157
223
    """
158
224
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
165
231
# In the local file system, where IVLE is actually installed.
166
232
# This directory should contain the "www" and "bin" directories."""))
167
233
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
168
 
    """Root directory where the jails (containing user files) are stored
 
234
    """Location of Directories
 
235
=======================
 
236
Root directory where the jails (containing user files) are stored
169
237
(on the local file system):""",
170
238
    """
171
239
# In the local file system, where are the student/user file spaces located.
179
247
# In the local file system, where are the per-subject file spaces located.
180
248
# The individual subject directories are expected to be located immediately
181
249
# in subdirectories of this location."""))
 
250
config_options.append(ConfigOption("exercises_base",
 
251
    "/home/informatics/exercises",
 
252
    """Root directory where the exercise directories (containing
 
253
subject-independent exercise sheets) are stored (on the local file
 
254
system):""",
 
255
    """
 
256
# In the local file system, where are the subject-independent exercise sheet
 
257
# file spaces located."""))
 
258
config_options.append(ConfigOption("tos_path",
 
259
    "/home/informatics/tos.html",
 
260
    """Location where the Terms of Service document is stored (on the local
 
261
    file system):""",
 
262
    """
 
263
# In the local file system, where is the Terms of Service document located."""))
 
264
config_options.append(ConfigOption("motd_path",
 
265
    "/home/informatics/motd.html",
 
266
    """Location where the Message of the Day document is stored (on the local
 
267
    file system):""",
 
268
    """
 
269
# In the local file system, where is the Message of the Day document
 
270
# located. This is an HTML file (just the body fragment), which will
 
271
# be displayed on the login page. It is optional."""))
182
272
config_options.append(ConfigOption("public_host", "public.localhost",
183
273
    """Hostname which will cause the server to go into "public mode",
184
274
providing login-free access to student's published work:""",
214
304
    """Database name:""",
215
305
    """
216
306
# Database name"""))
 
307
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
 
308
    """Forum Database name:""",
 
309
    """
 
310
# Forum Database name"""))
217
311
config_options.append(ConfigOption("db_user", "postgres",
218
312
    """Username for DB server login:""",
219
313
    """
220
314
# Database username"""))
221
315
config_options.append(ConfigOption("db_password", "",
222
316
    """Password for DB server login:
223
 
    (Caution: This password is stored in plaintext in www/conf/conf.py)""",
 
317
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
224
318
    """
225
319
# Database password"""))
 
320
config_options.append(ConfigOption("auth_modules", "ldap_auth",
 
321
    """Authentication config
 
322
=====================
 
323
Comma-separated list of authentication modules. Only "ldap" is available
 
324
by default.""",
 
325
    """
 
326
# Comma-separated list of authentication modules.
 
327
# These refer to importable Python modules in the www/auth directory.
 
328
# Modules "ldap" and "guest" are available in the source tree, but
 
329
# other modules may be plugged in to auth against organisation-specific
 
330
# auth backends."""))
 
331
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
 
332
    """(LDAP options are only relevant if "ldap" is included in the list of
 
333
auth modules).
 
334
URL for LDAP authentication server:""",
 
335
    """
 
336
# URL for LDAP authentication server"""))
 
337
config_options.append(ConfigOption("ldap_format_string",
 
338
    "uid=%s,ou=users,o=example",
 
339
    """Format string for LDAP auth request:
 
340
    (Must contain a single "%s" for the user's login name)""",
 
341
    """
 
342
# Format string for LDAP auth request
 
343
# (Must contain a single "%s" for the user's login name)"""))
 
344
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
 
345
    """Subversion config
 
346
=================
 
347
The base url for accessing subversion repositories:""",
 
348
    """
 
349
# The base url for accessing subversion repositories."""))
 
350
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
 
351
    """The location of the subversion configuration file used by apache
 
352
to host the user repositories:""",
 
353
    """
 
354
# The location of the subversion configuration file used by
 
355
# apache to host the user repositories."""))
 
356
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
 
357
    """The root directory for the subversion repositories:""",
 
358
    """
 
359
# The root directory for the subversion repositories."""))
 
360
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
 
361
    """The location of the password file used to authenticate users
 
362
of the subversion repository from the ivle server:""",
 
363
    """
 
364
# The location of the password file used to authenticate users
 
365
# of the subversion repository from the ivle server."""))
 
366
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
 
367
    """The location of the password file used to authenticate local users
 
368
of the subversion repository:""",
 
369
    """
 
370
# The location of the password file used to authenticate local users
 
371
# of the subversion repository."""))
 
372
config_options.append(ConfigOption("usrmgt_host", "localhost",
 
373
    """User Management Server config
 
374
============================
 
375
The hostname where the usrmgt-server runs:""",
 
376
    """
 
377
# The hostname where the usrmgt-server runs."""))
 
378
config_options.append(ConfigOption("usrmgt_port", "2178",
 
379
    """The port where the usrmgt-server runs:""",
 
380
    """
 
381
# The port where the usrmgt-server runs."""))
 
382
config_options.append(ConfigOption("usrmgt_magic", "",
 
383
    """The password for the usrmgt-server:""",
 
384
    """
 
385
# The password for the usrmgt-server."""))
226
386
 
227
387
# Try importing existing conf, but if we can't just set up defaults
228
388
# The reason for this is that these settings are used by other phases
229
389
# of setup besides conf, so we need to know them.
230
390
# Also this allows you to hit Return to accept the existing value.
231
391
try:
232
 
    confmodule = __import__("www/conf/conf")
 
392
    confmodule = __import__("lib/conf/conf")
233
393
    for opt in config_options:
234
394
        try:
235
395
            globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
253
413
# as necessary, and include it in the distribution.
254
414
listmake_mimetypes = ['text/x-python', 'text/html',
255
415
    'application/x-javascript', 'application/javascript',
256
 
    'text/css', 'image/png', 'application/xml']
 
416
    'text/css', 'image/png', 'image/gif', 'application/xml']
257
417
 
258
418
# Main function skeleton from Guido van Rossum
259
419
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
344
504
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
345
505
directory, and run build/install one time.
346
506
 
347
 
Creates www/conf/conf.py and trampoline/conf.h.
 
507
Creates lib/conf/conf.py and trampoline/conf.h.
348
508
 
349
509
Args are:"""
350
510
        for opt in config_options:
373
533
Copy trampoline/trampoline to $target/bin.
374
534
chown and chmod the installed trampoline.
375
535
Copy www/ to $target.
376
 
Copy jail/ to jails template directory (unless --nojail specified).
 
536
Copy jail/ to jails __staging__ directory (unless --nojail specified).
377
537
Copy subjects/ to subjects directory (unless --nosubjects specified).
378
538
 
379
539
--nojail        Do not copy the jail.
380
 
--nosubjects    Do not copy the subjects.
 
540
--nosubjects    Do not copy the subjects and exercises directories.
381
541
--dry | -n  Print out the actions but don't do anything."""
382
542
    elif operation == 'updatejails':
383
543
        print """sudo python setup.py updatejails [--dry|-n]
394
554
def listmake(args):
395
555
    # We build two separate lists, by walking www and console
396
556
    list_www = build_list_py_files('www')
397
 
    list_console = build_list_py_files('console')
 
557
    list_lib = build_list_py_files('lib')
398
558
    list_subjects = build_list_py_files('subjects', no_top_level=True)
 
559
    list_exercises = build_list_py_files('exercises', no_top_level=True)
 
560
    list_scripts = [
 
561
        "scripts/python-console",
 
562
        "scripts/fileservice",
 
563
        "scripts/serveservice",
 
564
        "scripts/usrmgt-server",
 
565
        "scripts/diffservice",
 
566
    ]
399
567
    # Make sure that the files generated by conf are in the list
400
568
    # (since listmake is typically run before conf)
401
 
    if "www/conf/conf.py" not in list_www:
402
 
        list_www.append("www/conf/conf.py")
403
 
    # Make sure that console/python-console is in the list
404
 
    if "console/python-console" not in list_console:
405
 
        list_console.append("console/python-console")
 
569
    if "lib/conf/conf.py" not in list_lib:
 
570
        list_lib.append("lib/conf/conf.py")
406
571
    # Write these out to a file
407
572
    cwd = os.getcwd()
408
573
    # the files that will be created/overwritten
422
587
list_www = """)
423
588
        writelist_pretty(file, list_www)
424
589
        file.write("""
425
 
# List of all installable files in console directory.
426
 
list_console = """)
427
 
        writelist_pretty(file, list_console)
 
590
# List of all installable files in lib directory.
 
591
list_lib = """)
 
592
        writelist_pretty(file, list_lib)
 
593
        file.write("""
 
594
# List of all installable files in scripts directory.
 
595
list_scripts = """)
 
596
        writelist_pretty(file, list_scripts)
428
597
        file.write("""
429
598
# List of all installable files in subjects directory.
430
599
# This is to install sample subjects and material.
431
600
list_subjects = """)
432
601
        writelist_pretty(file, list_subjects)
 
602
        file.write("""
 
603
# List of all installable files in exercises directory.
 
604
# This is to install sample exercise material.
 
605
list_exercises = """)
 
606
        writelist_pretty(file, list_exercises)
433
607
 
434
608
        file.close()
435
609
    except IOError, (errno, strerror):
475
649
        file.write(']\n')
476
650
 
477
651
def conf(args):
478
 
    global db_port
 
652
    global db_port, usrmgt_port
479
653
    # Set up some variables
480
654
 
481
655
    cwd = os.getcwd()
482
656
    # the files that will be created/overwritten
483
 
    conffile = os.path.join(cwd, "www/conf/conf.py")
 
657
    conffile = os.path.join(cwd, "lib/conf/conf.py")
 
658
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
484
659
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
 
660
    phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
 
661
    usrmgtserver_initdfile = os.path.join(cwd, "doc/setup/usrmgt-server.init")
485
662
 
486
663
    # Get command-line arguments to avoid asking questions.
487
664
 
500
677
        print """This tool will create the following files:
501
678
    %s
502
679
    %s
 
680
    %s
 
681
    %s
 
682
    %s
503
683
prompting you for details about your configuration. The file will be
504
684
overwritten if it already exists. It will *not* install or deploy IVLE.
505
685
 
506
686
Please hit Ctrl+C now if you do not wish to do this.
507
 
""" % (conffile, conf_hfile)
 
687
""" % (conffile, jailconffile, conf_hfile, phpBBconffile, usrmgtserver_initdfile)
508
688
 
509
689
        # Get information from the administrator
510
690
        # If EOF is encountered at any time during the questioning, just exit
536
716
        "Invalid DB port (%s).\n"
537
717
        "Must be an integer between 0 and 65535." % repr(db_port))
538
718
        return 1
539
 
 
540
 
    # Write www/conf/conf.py
 
719
    try:
 
720
        usrmgt_port = int(usrmgt_port)
 
721
        if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
 
722
    except ValueError:
 
723
        print >>sys.stderr, (
 
724
        "Invalid user management port (%s).\n"
 
725
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
 
726
        return 1
 
727
 
 
728
    # Generate the forum secret
 
729
    forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
730
 
 
731
    # Write lib/conf/conf.py
541
732
 
542
733
    try:
543
734
        conf = open(conffile, "w")
551
742
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
552
743
                repr(globals()[opt.option_name])))
553
744
 
554
 
        conf.close()
555
 
    except IOError, (errno, strerror):
556
 
        print "IO error(%s): %s" % (errno, strerror)
557
 
        sys.exit(1)
558
 
 
559
 
    print "Successfully wrote www/conf/conf.py"
 
745
        # Add the forum secret to the config file (regenerated each config)
 
746
        conf.write('forum_secret = "%s"\n' % (forum_secret))
 
747
 
 
748
        conf.close()
 
749
    except IOError, (errno, strerror):
 
750
        print "IO error(%s): %s" % (errno, strerror)
 
751
        sys.exit(1)
 
752
 
 
753
    print "Successfully wrote lib/conf/conf.py"
 
754
 
 
755
    # Write conf/jailconf.py
 
756
 
 
757
    try:
 
758
        conf = open(jailconffile, "w")
 
759
 
 
760
        # In the "in-jail" version of conf, we don't need MOST of the details
 
761
        # (it would be a security risk to have them here).
 
762
        # So we just write root_dir, and jail_base is "/".
 
763
        # (jail_base being "/" means "jail-relative" paths are relative to "/"
 
764
        # when inside the jail.)
 
765
        conf.write("""# IVLE Configuration File
 
766
# conf.py
 
767
# Miscellaneous application settings
 
768
# (User jail version)
 
769
 
 
770
 
 
771
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
 
772
# with this).
 
773
# eg. "/" or "/ivle".
 
774
root_dir = %s
 
775
 
 
776
# In the local file system, where are the student/user file spaces located.
 
777
# The user jails are expected to be located immediately in subdirectories of
 
778
# this location.
 
779
jail_base = '/'
 
780
 
 
781
# The hostname for serving publicly accessible pages
 
782
public_host = %s
 
783
""" % (repr(root_dir),repr(public_host)))
 
784
 
 
785
        conf.close()
 
786
    except IOError, (errno, strerror):
 
787
        print "IO error(%s): %s" % (errno, strerror)
 
788
        sys.exit(1)
 
789
 
 
790
    print "Successfully wrote lib/conf/jailconf.py"
560
791
 
561
792
    # Write trampoline/conf.h
562
793
 
581
812
 * (Note that root is an implicit member of this list).
582
813
 */
583
814
static const int allowed_uids[] = { %s };
584
 
""" % (jail_base, repr(allowed_uids_list)[1:-1]))
 
815
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
 
816
    # Note: The above uses PYTHON reprs, not C reprs
 
817
    # However they should be the same with the exception of the outer
 
818
    # characters, which are stripped off and replaced
585
819
 
586
820
        conf.close()
587
821
    except IOError, (errno, strerror):
590
824
 
591
825
    print "Successfully wrote trampoline/conf.h"
592
826
 
 
827
    # Write www/php/phpBB3/config.php
 
828
 
 
829
    try:
 
830
        conf = open(phpBBconffile, "w")
 
831
        
 
832
        # php-pg work around
 
833
        if db_host == 'localhost':
 
834
            forumdb_host = '127.0.0.1'
 
835
        else:
 
836
            forumdb_host = db_host
 
837
 
 
838
        conf.write( """<?php
 
839
// phpBB 3.0.x auto-generated configuration file
 
840
// Do not change anything in this file!
 
841
$dbms = 'postgres';
 
842
$dbhost = '""" + forumdb_host + """';
 
843
$dbport = '""" + str(db_port) + """';
 
844
$dbname = '""" + db_forumdbname + """';
 
845
$dbuser = '""" + db_user + """';
 
846
$dbpasswd = '""" + db_password + """';
 
847
 
 
848
$table_prefix = 'phpbb_';
 
849
$acm_type = 'file';
 
850
$load_extensions = '';
 
851
@define('PHPBB_INSTALLED', true);
 
852
// @define('DEBUG', true);
 
853
//@define('DEBUG_EXTRA', true);
 
854
 
 
855
$forum_secret = '""" + forum_secret +"""';
 
856
?>"""   )
 
857
    
 
858
        conf.close()
 
859
    except IOError, (errno, strerror):
 
860
        print "IO error(%s): %s" % (errno, strerror)
 
861
        sys.exit(1)
 
862
 
 
863
    print "Successfully wrote www/php/phpBB3/config.php"
 
864
 
 
865
    # Write lib/conf/usrmgt-server.init
 
866
 
 
867
    try:
 
868
        conf = open(usrmgtserver_initdfile, "w")
 
869
 
 
870
        conf.write( '''#! /bin/sh
 
871
 
 
872
# Works for Ubuntu. Check before using on other distributions
 
873
 
 
874
### BEGIN INIT INFO
 
875
# Provides:          usrmgt-server
 
876
# Required-Start:    $syslog $networking $urandom
 
877
# Required-Stop:     $syslog
 
878
# Default-Start:     2 3 4 5
 
879
# Default-Stop:      1
 
880
# Short-Description: IVLE user management server
 
881
# Description:       Daemon connecting to the IVLE user management database.
 
882
### END INIT INFO
 
883
 
 
884
PATH=/sbin:/bin:/usr/sbin:/usr/bin
 
885
DESC="IVLE user management server"
 
886
NAME=usrmgt-server
 
887
DAEMON=/opt/ivle/scripts/$NAME
 
888
DAEMON_ARGS="''' + str(usrmgt_port) + ''' ''' + usrmgt_magic + '''"
 
889
PIDFILE=/var/run/$NAME.pid
 
890
SCRIPTNAME=/etc/init.d/usrmgt-server
 
891
 
 
892
# Exit if the daemon does not exist 
 
893
test -f $DAEMON || exit 0
 
894
 
 
895
# Load the VERBOSE setting and other rcS variables
 
896
[ -f /etc/default/rcS ] && . /etc/default/rcS
 
897
 
 
898
# Define LSB log_* functions.
 
899
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
 
900
. /lib/lsb/init-functions
 
901
 
 
902
#
 
903
# Function that starts the daemon/service
 
904
#
 
905
do_start()
 
906
{
 
907
        # Return
 
908
        #   0 if daemon has been started
 
909
        #   1 if daemon was already running
 
910
        #   2 if daemon could not be started
 
911
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
 
912
                || return 1
 
913
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
 
914
                $DAEMON_ARGS \
 
915
                || return 2
 
916
        # Add code here, if necessary, that waits for the process to be ready
 
917
        # to handle requests from services started subsequently which depend
 
918
        # on this one.  As a last resort, sleep for some time.
 
919
}
 
920
 
 
921
#
 
922
# Function that stops the daemon/service
 
923
#
 
924
do_stop()
 
925
{
 
926
        # Return
 
927
        #   0 if daemon has been stopped
 
928
        #   1 if daemon was already stopped
 
929
        #   2 if daemon could not be stopped
 
930
        #   other if a failure occurred
 
931
        start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
 
932
        RETVAL="$?"
 
933
        [ "$RETVAL" = 2 ] && return 2
 
934
        # Wait for children to finish too if this is a daemon that forks
 
935
        # and if the daemon is only ever run from this initscript.
 
936
        # If the above conditions are not satisfied then add some other code
 
937
        # that waits for the process to drop all resources that could be
 
938
        # needed by services started subsequently.  A last resort is to
 
939
        # sleep for some time.
 
940
        start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
 
941
        [ "$?" = 2 ] && return 2
 
942
        # Many daemons don't delete their pidfiles when they exit.
 
943
        rm -f $PIDFILE
 
944
        return "$RETVAL"
 
945
}
 
946
 
 
947
#
 
948
# Function that sends a SIGHUP to the daemon/service
 
949
#
 
950
do_reload() {
 
951
        #
 
952
        # If the daemon can reload its configuration without
 
953
        # restarting (for example, when it is sent a SIGHUP),
 
954
        # then implement that here.
 
955
        #
 
956
        start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
 
957
        return 0
 
958
}
 
959
 
 
960
case "$1" in
 
961
  start)
 
962
    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
 
963
        do_start
 
964
        case "$?" in
 
965
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
 
966
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
 
967
        esac
 
968
        ;;
 
969
  stop)
 
970
        [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
 
971
        do_stop
 
972
        case "$?" in
 
973
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
 
974
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
 
975
        esac
 
976
        ;;
 
977
  #reload|force-reload)
 
978
        #
 
979
        # If do_reload() is not implemented then leave this commented out
 
980
        # and leave 'force-reload' as an alias for 'restart'.
 
981
        #
 
982
        #log_daemon_msg "Reloading $DESC" "$NAME"
 
983
        #do_reload
 
984
        #log_end_msg $?
 
985
        #;;
 
986
  restart|force-reload)
 
987
        #
 
988
        # If the "reload" option is implemented then remove the
 
989
        # 'force-reload' alias
 
990
        #
 
991
        log_daemon_msg "Restarting $DESC" "$NAME"
 
992
        do_stop
 
993
        case "$?" in
 
994
          0|1)
 
995
                do_start
 
996
                case "$?" in
 
997
                        0) log_end_msg 0 ;;
 
998
                        1) log_end_msg 1 ;; # Old process is still running
 
999
                        *) log_end_msg 1 ;; # Failed to start
 
1000
                esac
 
1001
                ;;
 
1002
          *)
 
1003
                # Failed to stop
 
1004
                log_end_msg 1
 
1005
                ;;
 
1006
        esac
 
1007
        ;;
 
1008
  *)
 
1009
        #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
 
1010
        echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
 
1011
        exit 3
 
1012
        ;;
 
1013
esac
 
1014
 
 
1015
:
 
1016
''')
 
1017
        
 
1018
        conf.close()
 
1019
    except IOError, (errno, strerror):
 
1020
        print "IO error(%s): %s" % (errno, strerror)
 
1021
        sys.exit(1)
 
1022
 
 
1023
    # fix permissions as the file contains the database password
 
1024
    try:
 
1025
        os.chmod('doc/setup/usrmgt-server.init', 0600)
 
1026
    except OSError, (errno, strerror):
 
1027
        print "WARNING: Couldn't chmod doc/setup/usrmgt-server.init:"
 
1028
        print "OS error(%s): %s" % (errno, strerror)
 
1029
 
 
1030
    print "Successfully wrote lib/conf/usrmgt-server.init"
 
1031
 
593
1032
    print
594
1033
    print "You may modify the configuration at any time by editing"
595
1034
    print conffile
 
1035
    print jailconffile
596
1036
    print conf_hfile
 
1037
    print phpBBconffile
 
1038
    print usrmgtserver_initdfile
597
1039
    print
598
1040
    return 0
599
1041
 
605
1047
 
606
1048
    if dry:
607
1049
        print "Dry run (no actions will be executed\n"
 
1050
    
 
1051
    # Find out the revison number
 
1052
    revnum = get_svn_revision()
 
1053
    print "Building Revision %s"%str(revnum)
 
1054
    if not dry:
 
1055
        vfile = open('BUILD-VERSION','w')
 
1056
        vfile.write(str(revnum) + '\n')
 
1057
        vfile.close()
608
1058
 
609
1059
    # Compile the trampoline
610
1060
    curdir = os.getcwd()
618
1068
    action_mkdir('jail/home', dry)
619
1069
    action_mkdir('jail/tmp', dry)
620
1070
 
 
1071
    # Chmod the tmp directory to world writable
 
1072
    action_chmod_w('jail/tmp', dry)
 
1073
 
621
1074
    # Copy all console and operating system files into the jail
622
 
    action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
 
1075
    action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
623
1076
    copy_os_files_jail(dry)
624
1077
    # Chmod the python console
625
 
    action_chmod_x('jail/opt/ivle/console/python-console', dry)
 
1078
    action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
 
1079
    action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
 
1080
    action_chmod_x('jail/opt/ivle/scripts/serveservice', dry)
626
1081
    
 
1082
    # Also copy the IVLE lib directory into the jail
 
1083
    # This is necessary for running certain scripts
 
1084
    action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
 
1085
    # IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
 
1086
    # which could compromise security if left in the jail (such as the DB
 
1087
    # password).
 
1088
    # The "safe" version is in jailconf.py. Delete conf.py and replace it with
 
1089
    # jailconf.py.
 
1090
    action_copyfile('lib/conf/jailconf.py',
 
1091
        'jail/opt/ivle/lib/conf/conf.py', dry)
627
1092
 
628
1093
    # Compile .py files into .pyc or .pyo files
629
1094
    compileall.compile_dir('www', quiet=True)
630
 
    compileall.compile_dir('console', quiet=True)
 
1095
    compileall.compile_dir('lib', quiet=True)
 
1096
    compileall.compile_dir('scripts', quiet=True)
 
1097
    compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
 
1098
 
 
1099
    # Set up ivle.pth inside the jail
 
1100
    # Need to set /opt/ivle/lib to be on the import path
 
1101
    ivle_pth = \
 
1102
        "jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
 
1103
    f = open(ivle_pth, 'w')
 
1104
    f.write('/opt/ivle/lib\n')
 
1105
    f.close()
631
1106
 
632
1107
    return 0
633
1108
 
675
1150
    # chown trampoline to root and set setuid bit
676
1151
    action_chown_setuid(tramppath, dry)
677
1152
 
678
 
    # Copy the www directory using the list
 
1153
    # Create a scripts directory to put the usrmgt-server in.
 
1154
    action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
 
1155
    usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
 
1156
    action_copyfile('scripts/usrmgt-server', usrmgtpath, dry)
 
1157
    action_chmod_x(usrmgtpath, dry)
 
1158
 
 
1159
    # Copy the www and lib directories using the list
679
1160
    action_copylist(install_list.list_www, ivle_install_dir, dry)
 
1161
    action_copylist(install_list.list_lib, ivle_install_dir, dry)
 
1162
    
 
1163
    # Copy the php directory
 
1164
    forum_dir = "www/php/phpBB3"
 
1165
    forum_path = os.path.join(ivle_install_dir, forum_dir)
 
1166
    action_copytree(forum_dir, forum_path, dry)
 
1167
    print "chown -R www-data:www-data %s" % forum_path
 
1168
    if not dry:
 
1169
        os.system("chown -R www-data:www-data %s" % forum_path)
680
1170
 
681
1171
    if not nojail:
682
1172
        # Copy the local jail directory built by the build action
683
 
        # to the jails template directory (it will be used as a template
684
 
        # for all the students' jails).
685
 
        action_copytree('jail', os.path.join(jail_base, 'template'), dry)
 
1173
        # to the jails __staging__ directory (it will be used to help build
 
1174
        # all the students' jails).
 
1175
        action_copytree('jail', os.path.join(jail_base, '__staging__'), dry)
686
1176
    if not nosubjects:
687
 
        # Copy the subjects directory across
 
1177
        # Copy the subjects and exercises directories across
688
1178
        action_copylist(install_list.list_subjects, subjects_base, dry,
689
1179
            srcdir="./subjects")
 
1180
        action_copylist(install_list.list_exercises, exercises_base, dry,
 
1181
            srcdir="./exercises")
690
1182
 
691
1183
    # Append IVLE path to ivle.pth in python site packages
692
1184
    # (Unless it's already there)
693
1185
    ivle_pth = os.path.join(sys.prefix,
694
1186
        "lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
695
1187
    ivle_www = os.path.join(ivle_install_dir, "www")
 
1188
    ivle_lib = os.path.join(ivle_install_dir, "lib")
696
1189
    write_ivle_pth = True
 
1190
    write_ivle_lib_pth = True
697
1191
    try:
698
1192
        file = open(ivle_pth, 'r')
699
1193
        for line in file:
700
1194
            if line.strip() == ivle_www:
701
1195
                write_ivle_pth = False
702
 
                break
 
1196
            elif line.strip() == ivle_lib:
 
1197
                write_ivle_lib_pth = False
 
1198
        file.close()
703
1199
    except (IOError, OSError):
704
1200
        pass
705
1201
    if write_ivle_pth:
706
1202
        action_append(ivle_pth, ivle_www)
 
1203
    if write_ivle_lib_pth:
 
1204
        action_append(ivle_pth, ivle_lib)
707
1205
 
708
1206
    return 0
709
1207
 
721
1219
        print >>sys.stderr, "(I need to chown some files)."
722
1220
        return 1
723
1221
 
724
 
    # Update the template jail directory in case it hasn't been installed
 
1222
    # Update the staging jail directory in case it hasn't been installed
725
1223
    # recently.
726
 
    action_copytree('jail', os.path.join(jail_base, 'template'), dry)
 
1224
    action_copytree('jail', os.path.join(jail_base, '__staging__'), dry)
727
1225
 
728
1226
    # Re-link all the files in all students jails.
729
1227
    for dir in os.listdir(jail_base):
730
 
        if dir == 'template': continue
 
1228
        if dir == '__staging__': continue
731
1229
        # First back up the student's home directory
732
1230
        temp_home = os.tmpnam()
733
1231
        action_rename(os.path.join(jail_base, dir, 'home'), temp_home, dry)
734
1232
        # Delete the student's jail and relink the jail files
735
 
        action_linktree(os.path.join(jail_base, 'template'),
 
1233
        action_linktree(os.path.join(jail_base, '__staging__'),
736
1234
            os.path.join(jail_base, dir), dry)
737
1235
        # Restore the student's home directory
738
1236
        action_rename(temp_home, os.path.join(jail_base, dir, 'home'), dry)
771
1269
    if ret != 0:
772
1270
        raise RunError(prog, ret)
773
1271
 
 
1272
def action_remove(path, dry):
 
1273
    """Calls rmtree, deleting the target file if it exists."""
 
1274
    try:
 
1275
        print "rm -r", path
 
1276
        if not dry:
 
1277
            shutil.rmtree(path, True)
 
1278
    except OSError, (err, msg):
 
1279
        if err != errno.EEXIST:
 
1280
            raise
 
1281
        # Otherwise, didn't exist, so we don't care
 
1282
 
774
1283
def action_rename(src, dst, dry):
775
1284
    """Calls rename. Deletes the target if it already exists."""
776
 
    if os.access(dst, os.F_OK):
777
 
        print "rm -r", dst
778
 
        if not dry:
779
 
            shutil.rmtree(dst, True)
 
1285
    action_remove(dst, dry)
780
1286
    print "mv ", src, dst
781
1287
    if dry: return
782
1288
    try:
802
1308
    directories as necessary.
803
1309
 
804
1310
    See shutil.copytree."""
805
 
    if os.access(dst, os.F_OK):
806
 
        print "rm -r", dst
807
 
        if not dry:
808
 
            shutil.rmtree(dst, True)
 
1311
    # Allow copying over itself
 
1312
    if (os.path.normpath(os.path.join(os.getcwd(),src)) ==
 
1313
        os.path.normpath(os.path.join(os.getcwd(),dst))):
 
1314
        return
 
1315
    action_remove(dst, dry)
809
1316
    print "cp -r", src, dst
810
1317
    if dry: return
811
1318
    shutil.copytree(src, dst, True)
814
1321
    """Hard-links an entire directory tree. Same as copytree but the created
815
1322
    files are hard-links not actual copies. Removes the existing destination.
816
1323
    """
817
 
    if os.access(dst, os.F_OK):
818
 
        print "rm -r", dst
819
 
        if not dry:
820
 
            shutil.rmtree(dst, True)
 
1324
    action_remove(dst, dry)
821
1325
    print "<cp with hardlinks> -r", src, dst
822
1326
    if dry: return
823
1327
    common.makeuser.linktree(src, dst)
898
1402
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
899
1403
            | stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
900
1404
 
 
1405
 
 
1406
def action_chmod_w(file, dry):
 
1407
    """Chmod 777 a file (sets permissions to rwxrwxrwx)."""
 
1408
    print "chmod 777", file
 
1409
    if not dry:
 
1410
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
 
1411
            | stat.S_IXGRP | stat.S_IWGRP | stat.S_IRGRP | stat.S_IXOTH
 
1412
            | stat.S_IWOTH | stat.S_IROTH)
 
1413
 
901
1414
def query_user(default, prompt):
902
1415
    """Prompts the user for a string, which is read from a line of stdin.
903
1416
    Exits silently if EOF is encountered. Returns the string, with spaces
930
1443
            del list[i]
931
1444
        i -= 1
932
1445
 
 
1446
def get_svn_revision():
 
1447
    """Returns either the current SVN revision of this build, or None"""
 
1448
    try:
 
1449
        svn = pysvn.Client()
 
1450
        entry = svn.info('.')
 
1451
        revnum = entry.revision.number
 
1452
    except pysvn.ClientError, e:
 
1453
        revnum = None
 
1454
    return revnum
 
1455
 
933
1456
if __name__ == "__main__":
934
1457
    sys.exit(main())
 
1458