← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/install.py

  • Committer: dcoles
  • Date: 2008-07-03 04:20:54 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:803
Setup: Modularised setup.py so it is now no longer over 1000 lines. This should 
allow us to get in there and tidy up each module much easier. Also removed 
updatejails since this functionality seems to be duplicated with remakeuser.py 
and remakealluser.py scripts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup/install.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2008 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Module: setup/install
 
19
# Author: Matt Giuca, Refactored by David Coles
 
20
# Date:   03/07/2008
 
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
import optparse
 
34
import os
 
35
from setuputil import *
 
36
 
 
37
def install(args):
 
38
    usage = """usage: %prog install [options]
 
39
(Requires root)
 
40
Create target install directory ($target).
 
41
Create $target/bin.
 
42
Copy trampoline/trampoline to $target/bin.
 
43
chown and chmod the installed trampoline.
 
44
Copy www/ to $target.
 
45
Copy jail/ to jails __staging__ directory (unless --nojail specified).
 
46
Copy subjects/ to subjects directory (unless --nosubjects specified).
 
47
"""
 
48
 
 
49
    # Parse arguments
 
50
    parser = optparse.OptionParser(usage)
 
51
    parser.add_option("-n", "--dry",
 
52
        action="store_true", dest="dry",
 
53
        help="Print out the actions but don't do anything.")
 
54
    parser.add_option("-J", "--nojail",
 
55
        action="store_true", dest="nojail",
 
56
        help="Don't copy jail/ to jail __staging__ directory")
 
57
    parser.add_option("-S", "--nosubjects",
 
58
        action="store_true", dest="nosubjects",
 
59
        help="Don't copy subject/ to subjects directory.")
 
60
    (options, args) = parser.parse_args(args)
 
61
 
 
62
    # Call the real function
 
63
    __install(options.dry, options.nojail, options.nosubjects)
 
64
 
 
65
def __install(dry=False,nojail=False,nosubjects=False):
 
66
    # Importing configuration is a little tricky
 
67
    sys.path.append(os.path.join(os.pardir, 'lib'))
 
68
    sys.path.append(os.pardir)
 
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
    subjects_base = conf.conf.subjects_base
 
76
    exercises_base = conf.conf.exercises_base
 
77
 
 
78
    # Must be run as root or a dry run  
 
79
    if dry:
 
80
        print "Dry run (no actions will be executed)\n"
 
81
    
 
82
    if not dry and os.geteuid() != 0:
 
83
        print >>sys.stderr, "Must be root to run build"
 
84
        print >>sys.stderr, "(I need to chown)."
 
85
        return 1
 
86
    
 
87
    # Create the target (install) directory
 
88
    action_mkdir(ivle_install_dir, dry)
 
89
 
 
90
    # Create bin and copy the compiled files there
 
91
    action_mkdir(os.path.join(ivle_install_dir, 'bin'), dry)
 
92
    tramppath = os.path.join(ivle_install_dir, 'bin/trampoline')
 
93
    action_copyfile('trampoline/trampoline', tramppath, dry)
 
94
    # chown trampoline to root and set setuid bit
 
95
    action_chown_setuid(tramppath, dry)
 
96
 
 
97
    # Create a scripts directory to put the usrmgt-server in.
 
98
    action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
 
99
    usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
 
100
    action_copyfile('scripts/usrmgt-server', usrmgtpath, dry)
 
101
    action_chmod_x(usrmgtpath, dry)
 
102
 
 
103
    # Copy the www and lib directories using the list
 
104
    action_copylist(install_list.list_www, ivle_install_dir, dry)
 
105
    action_copylist(install_list.list_lib, ivle_install_dir, dry)
 
106
    
 
107
    # Copy the php directory
 
108
    forum_dir = "www/php/phpBB3"
 
109
    forum_path = os.path.join(ivle_install_dir, forum_dir)
 
110
    action_copytree(forum_dir, forum_path, dry)
 
111
    print "chown -R www-data:www-data %s" % forum_path
 
112
    if not dry:
 
113
        os.system("chown -R www-data:www-data %s" % forum_path)
 
114
 
 
115
    if not nojail:
 
116
        # Copy the local jail directory built by the build action
 
117
        # to the jails __staging__ directory (it will be used to help build
 
118
        # all the students' jails).
 
119
        action_copytree('jail', os.path.join(jail_base, '__staging__'), dry)
 
120
    if not nosubjects:
 
121
        # Copy the subjects and exercises directories across
 
122
        action_copylist(install_list.list_subjects, subjects_base, dry,
 
123
            srcdir="./subjects")
 
124
        action_copylist(install_list.list_exercises, exercises_base, dry,
 
125
            srcdir="./exercises")
 
126
 
 
127
    # Append IVLE path to ivle.pth in python site packages
 
128
    # (Unless it's already there)
 
129
    ivle_pth = os.path.join(sys.prefix,
 
130
        "lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
 
131
    ivle_www = os.path.join(ivle_install_dir, "www")
 
132
    ivle_lib = os.path.join(ivle_install_dir, "lib")
 
133
    write_ivle_pth = True
 
134
    write_ivle_lib_pth = True
 
135
    try:
 
136
        file = open(ivle_pth, 'r')
 
137
        for line in file:
 
138
            if line.strip() == ivle_www:
 
139
                write_ivle_pth = False
 
140
            elif line.strip() == ivle_lib:
 
141
                write_ivle_lib_pth = False
 
142
        file.close()
 
143
    except (IOError, OSError):
 
144
        pass
 
145
    if write_ivle_pth:
 
146
        action_append(ivle_pth, ivle_www)
 
147
    if write_ivle_lib_pth:
 
148
        action_append(ivle_pth, ivle_lib)
 
149
 
 
150
 
 
151
    # Create the ivle working revision record file
 
152
    action_mkdir(os.path.join(ivle_install_dir, 'version'), dry)
 
153
    ivle_revision_record_file = os.path.join(ivle_install_dir, 'version/ivle-revision.txt')
 
154
    if not dry:
 
155
        try:
 
156
            conf = open(ivle_revision_record_file, "w")
 
157
 
 
158
            conf.write( "# IVLE code revision listing generated by running 'svn status -v ..' from " + os.getcwd() + "\n#\n\n")
 
159
 
 
160
            conf.close()
 
161
        except IOError, (errno, strerror):
 
162
            print "IO error(%s): %s" % (errno, strerror)
 
163
            sys.exit(1)
 
164
 
 
165
        os.system("svn status -v .. >> %s" % ivle_revision_record_file)
 
166
 
 
167
    print "Wrote IVLE code revision status to %s" % ivle_revision_record_file
 
168
 
 
169
    return 0
 
170