← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/install.py

Add an ivle-createdatadirs script, to create the hierarchy under /var/lib/ivle.

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup/install.py
19
19
# Author: Matt Giuca, Refactored by David Coles
20
20
# Date:   03/07/2008
21
21
 
22
 
# setup/build.py
23
 
# Compiles all files and sets up a jail template in the source directory.
24
 
# Details:
25
 
# Compiles (GCC) trampoline/trampoline.c to trampoline/trampoline.
26
 
# Creates jail/.
27
 
# Creates standard subdirs inside the jail, eg bin, opt, home, tmp.
28
 
# Copies console/ to a location within the jail.
29
 
# Copies OS programs and files to corresponding locations within the jail
30
 
#   (eg. python and Python libs, ld.so, etc).
31
 
# Generates .pyc files for all the IVLE .py files.
32
 
 
33
22
import optparse
34
23
import os
35
 
from setuputil import *
 
24
import sys
 
25
import functools
 
26
 
 
27
from setup import util
 
28
 
 
29
PYTHON_VERSION = sys.version[:3]
36
30
 
37
31
def install(args):
38
32
    usage = """usage: %prog install [options]
39
33
(Requires root)
40
34
Create target install directory ($target).
41
35
Create $target/bin.
42
 
Copy trampoline/trampoline to $target/bin.
43
 
Copy timount/timount to $target/bin.
 
36
Copy bin/trampoline/trampoline to $target/bin.
 
37
Copy bin/timount/timount to $target/bin.
 
38
Copy etc/ivle.conf to /etc/ivle/ivle.conf.
44
39
chown and chmod the installed trampoline.
45
40
Copy www/ to $target.
46
 
Copy jail/ to jail_system directory (unless --nojail specified).
47
 
Copy subjects/ to subjects directory (unless --nosubjects specified).
48
41
"""
49
42
 
50
43
    # Parse arguments
52
45
    parser.add_option("-n", "--dry",
53
46
        action="store_true", dest="dry",
54
47
        help="Print out the actions but don't do anything.")
55
 
    parser.add_option("-J", "--nojail",
56
 
        action="store_true", dest="nojail",
57
 
        help="Don't copy jail/ to jail_system directory")
58
 
    parser.add_option("-S", "--nosubjects",
59
 
        action="store_true", dest="nosubjects",
60
 
        help="Don't copy subject/ to subjects directory.")
 
48
    parser.add_option("-R", "--nosvnrevno",
 
49
        action="store_true", dest="nosvnrevno",
 
50
        help="Don't write out the Subversion revision to the share directory.")
 
51
    parser.add_option("--root",
 
52
        action="store", dest="rootdir",
 
53
        help="Install into a different root directory.",
 
54
        default='/')
 
55
    parser.add_option("--prefix",
 
56
        action="store", dest="prefix",
 
57
        help="Base prefix to install IVLE into (default: /usr/local).",
 
58
        default='/usr/local')
 
59
    parser.add_option("--python-site-packages",
 
60
        action="store", dest="python_site_packages",
 
61
        help="Path to Python site packages directory.",
 
62
        default='/usr/local/lib/python%s/site-packages' % PYTHON_VERSION)
61
63
    (options, args) = parser.parse_args(args)
62
64
 
63
65
    # Call the real function
64
 
    __install(options.dry, options.nojail, options.nosubjects)
65
 
 
66
 
def __install(dry=False,nojail=False,nosubjects=False):
67
 
    # Importing configuration is a little tricky
68
 
    sys.path.append('lib')
69
 
    import conf.conf
70
 
    import install_list
71
 
 
72
 
    # Pull the required varibles out of the config
73
 
    ivle_install_dir = conf.conf.ivle_install_dir
74
 
    jail_base = conf.conf.jail_base
75
 
    jail_system = conf.conf.jail_system
76
 
    subjects_base = conf.conf.subjects_base
77
 
    exercises_base = conf.conf.exercises_base
 
66
    return __install(prefix=options.prefix,
 
67
                     python_site_packages=options.python_site_packages,
 
68
                     dry=options.dry, rootdir=options.rootdir,
 
69
                     nosvnrevno=options.nosvnrevno)
 
70
 
 
71
def __install(prefix, python_site_packages, dry=False, rootdir=None,
 
72
              nosvnrevno=False):
 
73
    install_list = util.InstallList()
 
74
 
 
75
    # We need to apply make_install_path with the rootdir to an awful lot of
 
76
    # config variables, so make it easy:
 
77
    mip = functools.partial(util.make_install_path, rootdir)
 
78
 
 
79
    # Compute the lib_path, share_path and bin_path (copied from
 
80
    # ivle/conf/conf.py).
 
81
    lib_path = mip(os.path.join(prefix, 'lib/ivle'))
 
82
    share_path = mip(os.path.join(prefix, 'share/ivle'))
 
83
    bin_path = mip(os.path.join(prefix, 'bin'))
 
84
    python_site_packages = mip(python_site_packages)
78
85
 
79
86
    # Must be run as root or a dry run  
80
87
    if dry:
81
88
        print "Dry run (no actions will be executed)\n"
82
89
    
83
90
    if not dry and os.geteuid() != 0:
84
 
        print >>sys.stderr, "Must be root to run build"
85
 
        print >>sys.stderr, "(I need to chown)."
 
91
        print >>sys.stderr, "Must be root to run install"
86
92
        return 1
87
 
    
88
 
    # Create the target (install) directory
89
 
    action_mkdir(ivle_install_dir, dry)
90
 
 
91
 
    # Create bin and copy the compiled files there
92
 
    action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
93
 
    tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
94
 
    action_copyfile('trampoline/trampoline', tramppath, dry)
 
93
 
 
94
    # Create the config directory.
 
95
    util.action_mkdir('/etc/ivle', dry)
 
96
 
 
97
    # Create lib and copy the compiled files there
 
98
    util.action_mkdir(lib_path, dry)
 
99
 
 
100
    tramppath = os.path.join(lib_path, 'trampoline')
 
101
    util.action_copyfile('bin/trampoline/trampoline', tramppath, dry)
95
102
    # chown trampoline to root and set setuid bit
96
 
    action_chown_setuid(tramppath, dry)
97
 
 
98
 
    timountpath = os.path.join(ivle_install_dir, 'bin/timount')
99
 
    action_copyfile('timount/timount', timountpath, dry)
100
 
 
101
 
    # Create a services directory to put the usrmgt-server in.
102
 
    action_mkdir(os.path.join(ivle_install_dir, 'services'), dry)
103
 
    usrmgtpath = os.path.join(ivle_install_dir, 'services/usrmgt-server')
104
 
    action_copyfile('services/usrmgt-server', usrmgtpath, dry)
105
 
    action_chmod_x(usrmgtpath, dry)
106
 
 
107
 
    # Copy the www and lib directories using the list
108
 
    action_copylist(install_list.list_www, ivle_install_dir, dry)
109
 
    action_copylist(install_list.list_lib, ivle_install_dir, dry)
110
 
    
111
 
    # Make the config file private
112
 
    configpath = os.path.join(ivle_install_dir, 'lib/conf/conf.py')
113
 
    action_make_private(configpath, dry)
114
 
 
115
 
    # Copy the php directory
 
103
    util.action_chown_setuid(tramppath, dry)
 
104
 
 
105
    timountpath = os.path.join(lib_path, 'timount')
 
106
    util.action_copyfile('bin/timount/timount', timountpath, dry)
 
107
 
 
108
    # Copy in the services (only usrmgt-server is needed on the host, but
 
109
    # the jail build requires the rest).
 
110
    util.action_copylist(install_list.list_services, share_path, dry)
 
111
    usrmgtpath = os.path.join(share_path, 'services/usrmgt-server')
 
112
    util.action_chmod_x(usrmgtpath, dry)
 
113
 
 
114
    # Copy the user-executable binaries using the list.
 
115
    util.action_copylist(install_list.list_user_binaries, bin_path, dry,
 
116
                         onlybasename=True)
 
117
 
 
118
    # Copy the www directory (using the list)
 
119
    util.action_copylist(install_list.list_www, share_path, dry)
 
120
 
 
121
    # Set appropriate permissions on the php directory
116
122
    forum_dir = "www/php/phpBB3"
117
 
    forum_path = os.path.join(ivle_install_dir, forum_dir)
118
 
    action_copytree(forum_dir, forum_path, dry)
 
123
    forum_path = os.path.join(share_path, forum_dir)
119
124
    print "chown -R www-data:www-data %s" % forum_path
120
125
    if not dry:
121
126
        os.system("chown -R www-data:www-data %s" % forum_path)
122
127
 
123
 
    if not nojail:
124
 
        # Copy the local jail directory built by the build action
125
 
        # to the jail_system directory (it will be used to help build
126
 
        # all the students' jails).
127
 
        action_copytree('jail', jail_system, dry)
128
 
    if not nosubjects:
129
 
        # Copy the subjects and exercises directories across
130
 
        action_copylist(install_list.list_subjects, subjects_base, dry,
131
 
            srcdir="./subjects")
132
 
        action_copylist(install_list.list_exercises, exercises_base, dry,
133
 
            srcdir="./exercises")
 
128
    # Copy the lib directory (using the list)
 
129
    util.action_copylist(install_list.list_ivle_lib, python_site_packages, dry)
134
130
 
135
 
    # Append IVLE path to ivle.pth in python site packages
136
 
    # (Unless it's already there)
137
 
    ivle_pth = os.path.join(sys.prefix,
138
 
        "lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
139
 
    ivle_www = os.path.join(ivle_install_dir, "www")
140
 
    ivle_lib = os.path.join(ivle_install_dir, "lib")
141
 
    write_ivle_pth = True
142
 
    write_ivle_lib_pth = True
 
131
    # XXX We shouldn't have ivle.pth at all any more.
 
132
    # We may still need the www packages to be importable.
 
133
    # Anything from www that is needed from the outside should go to lib.
 
134
    ivle_pth = os.path.join(python_site_packages, "ivle.pth")
143
135
    try:
144
 
        file = open(ivle_pth, 'r')
145
 
        for line in file:
146
 
            if line.strip() == ivle_www:
147
 
                write_ivle_pth = False
148
 
            elif line.strip() == ivle_lib:
149
 
                write_ivle_lib_pth = False
 
136
        file = open(ivle_pth, 'w')
 
137
        file.write(os.path.join(share_path, "www"))
150
138
        file.close()
151
139
    except (IOError, OSError):
152
140
        pass
153
 
    if write_ivle_pth:
154
 
        action_append(ivle_pth, ivle_www)
155
 
    if write_ivle_lib_pth:
156
 
        action_append(ivle_pth, ivle_lib)
157
 
 
158
 
 
159
 
    # Create the ivle working revision record file
160
 
    action_mkdir(os.path.join(ivle_install_dir, 'version'), dry)
161
 
    ivle_revision_record_file = os.path.join(ivle_install_dir, 'version/ivle-revision.txt')
162
 
    if not dry:
163
 
        try:
164
 
            conf = open(ivle_revision_record_file, "w")
165
 
 
166
 
            conf.write( "# IVLE code revision listing generated by running 'svn status -v ..' from " + os.getcwd() + "\n#\n\n")
167
 
 
168
 
            conf.close()
169
 
        except IOError, (errno, strerror):
170
 
            print "IO error(%s): %s" % (errno, strerror)
171
 
            sys.exit(1)
172
 
 
173
 
        os.system("svn status -v . >> %s" % ivle_revision_record_file)
174
 
 
175
 
    print "Wrote IVLE code revision status to %s" % ivle_revision_record_file
 
141
 
 
142
    if not nosvnrevno:
 
143
        # Create the ivle working revision record file
 
144
        ivle_revision_file = os.path.join(share_path, 'revision.txt')
 
145
        if not dry:
 
146
            try:
 
147
                conf = open(ivle_revision_file, "w")
 
148
 
 
149
                conf.write("""# SVN revision r%s
 
150
# Source tree location: %s
 
151
# Modified files:
 
152
""" % (util.get_svn_revision(), os.getcwd()))
 
153
 
 
154
                conf.close()
 
155
            except IOError, (errno, strerror):
 
156
                print "IO error(%s): %s" % (errno, strerror)
 
157
                sys.exit(1)
 
158
 
 
159
            os.system("svn status . >> %s" % ivle_revision_file)
 
160
 
 
161
        print "Wrote IVLE code revision status to %s" % ivle_revision_file
176
162
 
177
163
    return 0
178
164