← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/install.py

  • Committer: wagrant
  • Date: 2008-08-19 12:49:58 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1031
Example worksheets: Fix the element names in worksheet 1 to be actually
                    correct. Also fix the first exercise so it too
                    functions properly.

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
 
22
33
import optparse
23
34
import os
24
 
import sys
25
 
import functools
26
 
import distutils.sysconfig
27
 
 
28
 
from setup import util
 
35
from setuputil import *
29
36
 
30
37
def install(args):
31
38
    usage = """usage: %prog install [options]
32
39
(Requires root)
33
40
Create target install directory ($target).
34
41
Create $target/bin.
35
 
Copy bin/trampoline/trampoline to $target/bin.
36
 
Copy bin/timount/timount to $target/bin.
 
42
Copy trampoline/trampoline to $target/bin.
 
43
Copy timount/timount to $target/bin.
37
44
chown and chmod the installed trampoline.
 
45
Copy www/ to $target.
 
46
Copy jail/ to jail_system directory (unless --nojail specified).
 
47
Copy subjects/ to subjects directory (unless --nosubjects specified).
38
48
"""
39
49
 
40
50
    # Parse arguments
42
52
    parser.add_option("-n", "--dry",
43
53
        action="store_true", dest="dry",
44
54
        help="Print out the actions but don't do anything.")
45
 
    parser.add_option("-R", "--nosvnrevno",
46
 
        action="store_true", dest="nosvnrevno",
47
 
        help="Don't write out the Subversion revision to the share directory.")
48
 
    parser.add_option("--root",
49
 
        action="store", dest="rootdir",
50
 
        help="Install into a different root directory.",
51
 
        default='/')
52
 
    parser.add_option("--prefix",
53
 
        action="store", dest="prefix",
54
 
        help="Base prefix to install IVLE into (default: /usr/local).",
55
 
        default='/usr/local')
56
 
    parser.add_option("--python-site-packages",
57
 
        action="store", dest="python_site_packages",
58
 
        help="Path to Python site packages directory.",
59
 
        default=None)
 
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.")
60
61
    (options, args) = parser.parse_args(args)
61
62
 
62
 
    # Prefix must be absolute (not really necessary, but since a relative
63
 
    # prefix will be taken relative to *root* not working directory, it is
64
 
    # confusing if we allow it).
65
 
    if options.prefix[:1] not in (os.path.sep, os.path.altsep):
66
 
        print >>sys.stderr, """prefix must be an absolute path.
67
 
    (This will be interpreted relative to root, so provide --root=. if you
68
 
    want a path relative to the working directory)."""
69
 
        return 1
70
 
 
71
 
    # Calculate python_site_packages using the supplied prefix
72
 
    if options.python_site_packages is None:
73
 
        options.python_site_packages = distutils.sysconfig.get_python_lib(
74
 
            prefix=options.prefix)
75
 
 
76
63
    # Call the real function
77
 
    return __install(prefix=options.prefix,
78
 
                     python_site_packages=options.python_site_packages,
79
 
                     dry=options.dry, rootdir=options.rootdir,
80
 
                     nosvnrevno=options.nosvnrevno)
81
 
 
82
 
def __install(prefix, python_site_packages, dry=False, rootdir=None,
83
 
              nosvnrevno=False):
84
 
    install_list = util.InstallList()
85
 
 
86
 
    # We need to apply make_install_path with the rootdir to an awful lot of
87
 
    # config variables, so make it easy:
88
 
    mip = functools.partial(util.make_install_path, rootdir)
89
 
 
90
 
    # Compute the lib_path, share_path and bin_path (copied from
91
 
    # ivle/conf/conf.py).
92
 
    lib_path = mip(os.path.join(prefix, 'lib/ivle'))
93
 
    share_path = mip(os.path.join(prefix, 'share/ivle'))
94
 
    bin_path = mip(os.path.join(prefix, 'bin'))
95
 
    python_site_packages = mip(python_site_packages)
 
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
96
78
 
97
79
    # Must be run as root or a dry run  
98
80
    if dry:
99
81
        print "Dry run (no actions will be executed)\n"
100
82
    
101
83
    if not dry and os.geteuid() != 0:
102
 
        print >>sys.stderr, "Must be root to run install"
 
84
        print >>sys.stderr, "Must be root to run build"
 
85
        print >>sys.stderr, "(I need to chown)."
103
86
        return 1
104
 
 
105
 
    # Create the config directory.
106
 
    util.action_mkdir(mip('/etc/ivle/plugins.d'), dry)
107
 
 
108
 
    # Create lib and copy the compiled files there
109
 
    util.action_mkdir(lib_path, dry)
110
 
 
111
 
    tramppath = os.path.join(lib_path, 'trampoline')
112
 
    util.action_copyfile('bin/trampoline/trampoline', tramppath, dry)
 
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)
113
95
    # chown trampoline to root and set setuid bit
114
 
    util.action_chown_setuid(tramppath, dry)
115
 
 
116
 
    timountpath = os.path.join(lib_path, 'timount')
117
 
    util.action_copyfile('bin/timount/timount', timountpath, dry)
118
 
 
119
 
    # Copy in the services (only usrmgt-server is needed on the host, but
120
 
    # the jail build requires the rest).
121
 
    util.action_copylist(install_list.list_services, share_path, dry)
122
 
    usrmgtpath = os.path.join(share_path, 'services/usrmgt-server')
123
 
    util.action_chmod_x(usrmgtpath, dry)
124
 
 
125
 
    # Copy the user-executable binaries using the list.
126
 
    util.action_copylist(install_list.list_user_binaries, bin_path, dry,
127
 
                         onlybasename=True)
128
 
 
129
 
    # Copy the lib directory (using the list)
130
 
    util.action_copylist(install_list.list_ivle_lib, python_site_packages, dry)
131
 
 
132
 
    if not nosvnrevno:
133
 
        # Create the ivle working revision record file
134
 
        ivle_revision_file = os.path.join(share_path, 'revision.txt')
135
 
        if not dry:
136
 
            try:
137
 
                conf = open(ivle_revision_file, "w")
138
 
 
139
 
                conf.write("""# SVN revision r%s
140
 
# Source tree location: %s
141
 
# Modified files:
142
 
""" % (util.get_svn_revision(), os.getcwd()))
143
 
 
144
 
                conf.close()
145
 
            except IOError, (errno, strerror):
146
 
                print "IO error(%s): %s" % (errno, strerror)
147
 
                sys.exit(1)
148
 
 
149
 
            os.system("svn status . >> %s" % ivle_revision_file)
150
 
 
151
 
        print "Wrote IVLE code revision status to %s" % ivle_revision_file
 
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 scripts directory to put the usrmgt-server in.
 
102
    action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
 
103
    usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
 
104
    action_copyfile('scripts/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
 
116
    forum_dir = "www/php/phpBB3"
 
117
    forum_path = os.path.join(ivle_install_dir, forum_dir)
 
118
    action_copytree(forum_dir, forum_path, dry)
 
119
    print "chown -R www-data:www-data %s" % forum_path
 
120
    if not dry:
 
121
        os.system("chown -R www-data:www-data %s" % forum_path)
 
122
 
 
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")
 
134
 
 
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
 
143
    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
 
150
        file.close()
 
151
    except (IOError, OSError):
 
152
        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
152
176
 
153
177
    return 0
154
178