← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/install.py

[Uber-commit of holiday work because I lacked a local copy of the branch.]

 ivle.makeuser: Don't use jailconf.py as a header for the in-jail conf.py;
     generate the whole thing using string formatting operators and include
     the template inline.

 ivle.makeuser.make_conf_py: XXX the inclusion of ivle.conf.jail_base in
     the jail. It is simply there to placate ivle.studpath, and needs
     to go before we can entirely remove the in-jail config.

 ivle-buildjail:
   - Add. Converted from setup.buildjail.
   - Build the jail in __base_build__ and rsync it to __base__ when
     done, rather than operating only in ./jail
   - Rename --rebuildjail/-j to --recreate/-r, as the whole script
     is now for jail rebuilding. Also add a warning to the usage string about
     the large volume likely to be downloaded.
   - Check existence before removing trees.
   - Don't copy jailconf.py over conf.py in the jail. Also make
     sure that we remove conf.pyc.

 setup.configure:
   - Stop generating jailconf.py at all.
   - Add a jail_system_build setting, defaulting to __base_build__ next to
     the existing __base__.
   - Don't use an OptionParser before calling the real function, as that
     adds options dynamically.

 setup.install:
   - Add an option (-R) to avoid writing out svn revision info to
     $PREFIX/share/ivle/revision.txt.
   - Remove jail-copying things.
   - Install all services to the host, rather than just usrmgt-server. We do
     this so we can build the jail from the host without the source tree.
   - Shuffle some things, and don't install phpBB3 twice.
   - Add a --root argument, to take an alternate root directory to install
     into (as given to autotools in $DESTDIR).

 setup.build:
   - Allow running as non-root.
   - Take a --no-compile option to not byte-compile Python files.

 setup.util:
   - Include usrmgt-server in the list of services.
   - Add make_install_path(), a wrapper around os.path.join() that ensures
     the second path is relative.
   - Install ivle-buildjail with the other binaries.

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
import optparse
 
23
import os
 
24
import sys
 
25
import functools
 
26
 
 
27
from setup import util
 
28
 
 
29
def install(args):
 
30
    usage = """usage: %prog install [options]
 
31
(Requires root)
 
32
Create target install directory ($target).
 
33
Create $target/bin.
 
34
Copy bin/trampoline/trampoline to $target/bin.
 
35
Copy bin/timount/timount to $target/bin.
 
36
chown and chmod the installed trampoline.
 
37
Copy www/ to $target.
 
38
Copy subjects/ to subjects directory (unless --nosubjects specified).
 
39
"""
 
40
 
 
41
    # Parse arguments
 
42
    parser = optparse.OptionParser(usage)
 
43
    parser.add_option("-n", "--dry",
 
44
        action="store_true", dest="dry",
 
45
        help="Print out the actions but don't do anything.")
 
46
    parser.add_option("-S", "--nosubjects",
 
47
        action="store_true", dest="nosubjects",
 
48
        help="Don't copy subject/ to subjects directory.")
 
49
    parser.add_option("-R", "--nosvnrevno",
 
50
        action="store_true", dest="nosvnrevno",
 
51
        help="Don't write out the Subversion revision to the share directory.")
 
52
    parser.add_option("--root",
 
53
        action="store", dest="rootdir",
 
54
        help="Install into a different root directory.",
 
55
        default='/')
 
56
    (options, args) = parser.parse_args(args)
 
57
 
 
58
    # Call the real function
 
59
    return __install(options.dry, options.nosubjects, options.rootdir,
 
60
                     options.nosvnrevno)
 
61
 
 
62
def __install(dry=False, nosubjects=False, rootdir=None, nosvnrevno=False):
 
63
    # We need to import the one in the working copy, not in the system path.
 
64
    confmodule = __import__("ivle/conf/conf")
 
65
    install_list = util.InstallList()
 
66
 
 
67
    # We need to apply make_install_path with the rootdir to an awful lot of
 
68
    # config variables, so make it easy:
 
69
    mip = functools.partial(util.make_install_path, rootdir)
 
70
 
 
71
    # Pull the required varibles out of the config
 
72
    lib_path = mip(confmodule.lib_path)
 
73
    share_path = mip(confmodule.share_path)
 
74
    bin_path = mip(confmodule.bin_path)
 
75
    python_site_packages = mip(confmodule.python_site_packages)
 
76
    jail_base = mip(confmodule.jail_base)
 
77
    jail_system = mip(confmodule.jail_system)
 
78
    subjects_base = mip(confmodule.subjects_base)
 
79
    exercises_base = mip(confmodule.exercises_base)
 
80
 
 
81
    # Must be run as root or a dry run  
 
82
    if dry:
 
83
        print "Dry run (no actions will be executed)\n"
 
84
    
 
85
    if not dry and os.geteuid() != 0:
 
86
        print >>sys.stderr, "Must be root to run build"
 
87
        print >>sys.stderr, "(I need to chown)."
 
88
        return 1
 
89
 
 
90
    # Make some directories for data.
 
91
    util.action_mkdir(mip(confmodule.log_path), dry)
 
92
    util.action_mkdir(mip(confmodule.data_path), dry)
 
93
    util.action_mkdir(mip(confmodule.jail_base), dry)
 
94
    util.action_mkdir(mip(confmodule.jail_src_base), dry)
 
95
    util.action_mkdir(mip(confmodule.content_path), dry)
 
96
    util.action_mkdir(mip(confmodule.notices_path), dry)
 
97
    util.action_mkdir(os.path.join(mip(confmodule.data_path), 'sessions'), dry)
 
98
    util.action_mkdir(mip(confmodule.svn_path), dry)
 
99
    util.action_mkdir(mip(confmodule.svn_repo_path), dry)
 
100
    util.action_mkdir(os.path.join(mip(confmodule.svn_repo_path), 'users'),dry)
 
101
    util.action_mkdir(os.path.join(mip(confmodule.svn_repo_path),'groups'),dry)
 
102
 
 
103
    util.action_chown(mip(confmodule.log_path), util.wwwuid, util.wwwuid, dry)
 
104
    util.action_chown(os.path.join(mip(confmodule.data_path), 'sessions'),
 
105
                      util.wwwuid, util.wwwuid, dry)
 
106
    util.action_chown(os.path.join(mip(confmodule.svn_repo_path), 'users'),
 
107
                      util.wwwuid, util.wwwuid, dry)
 
108
    util.action_chown(os.path.join(mip(confmodule.svn_repo_path), 'groups'),
 
109
                      util.wwwuid, util.wwwuid, dry)
 
110
 
 
111
    # Create lib and copy the compiled files there
 
112
    util.action_mkdir(lib_path, dry)
 
113
 
 
114
    tramppath = os.path.join(lib_path, 'trampoline')
 
115
    util.action_copyfile('bin/trampoline/trampoline', tramppath, dry)
 
116
    # chown trampoline to root and set setuid bit
 
117
    util.action_chown_setuid(tramppath, dry)
 
118
 
 
119
    timountpath = os.path.join(lib_path, 'timount')
 
120
    util.action_copyfile('bin/timount/timount', timountpath, dry)
 
121
 
 
122
    # Copy in the services (only usrmgt-server is needed on the host, but
 
123
    # the jail build requires the rest).
 
124
    util.action_copylist(install_list.list_services, share_path, dry)
 
125
    usrmgtpath = os.path.join(share_path, 'services/usrmgt-server')
 
126
    util.action_chmod_x(usrmgtpath, dry)
 
127
 
 
128
    # Copy the user-executable binaries using the list.
 
129
    util.action_copylist(install_list.list_user_binaries, bin_path, dry,
 
130
                         onlybasename=True)
 
131
 
 
132
    # Copy the www directory (using the list)
 
133
    util.action_copylist(install_list.list_www, share_path, dry)
 
134
 
 
135
    # Set appropriate permissions on the php directory
 
136
    forum_dir = "www/php/phpBB3"
 
137
    forum_path = os.path.join(share_path, forum_dir)
 
138
    print "chown -R www-data:www-data %s" % forum_path
 
139
    if not dry:
 
140
        os.system("chown -R www-data:www-data %s" % forum_path)
 
141
 
 
142
    # Copy the lib directory (using the list)
 
143
    util.action_copylist(install_list.list_ivle_lib, python_site_packages, dry)
 
144
 
 
145
    # Make the config file private
 
146
    configpath = os.path.join(python_site_packages, 'ivle/conf/conf.py')
 
147
    util.action_make_private(configpath, dry)
 
148
 
 
149
    if not nosubjects:
 
150
        # Copy the subjects and exercises directories across
 
151
        util.action_mkdir(subjects_base, dry)
 
152
        util.action_copylist(install_list.list_subjects, subjects_base, dry,
 
153
            srcdir="./subjects")
 
154
        util.action_mkdir(exercises_base, dry)
 
155
        util.action_copylist(install_list.list_exercises, exercises_base, dry,
 
156
            srcdir="./exercises")
 
157
 
 
158
    # XXX We shouldn't have ivle.pth at all any more.
 
159
    # We may still need the www packages to be importable.
 
160
    # Anything from www that is needed from the outside should go to lib.
 
161
    ivle_pth = os.path.join(python_site_packages, "ivle.pth")
 
162
    try:
 
163
        file = open(ivle_pth, 'w')
 
164
        file.write(os.path.join(share_path, "www"))
 
165
        file.close()
 
166
    except (IOError, OSError):
 
167
        pass
 
168
 
 
169
    if not nosvnrevno:
 
170
        # Create the ivle working revision record file
 
171
        ivle_revision_file = os.path.join(share_path, 'revision.txt')
 
172
        if not dry:
 
173
            try:
 
174
                conf = open(ivle_revision_file, "w")
 
175
 
 
176
                conf.write("""# SVN revision r%s
 
177
# Source tree location: %s
 
178
# Modified files:
 
179
""" % (util.get_svn_revision(), os.getcwd()))
 
180
 
 
181
                conf.close()
 
182
            except IOError, (errno, strerror):
 
183
                print "IO error(%s): %s" % (errno, strerror)
 
184
                sys.exit(1)
 
185
 
 
186
            os.system("svn status . >> %s" % ivle_revision_file)
 
187
 
 
188
        print "Wrote IVLE code revision status to %s" % ivle_revision_file
 
189
 
 
190
    return 0
 
191