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

« back to all changes in this revision

Viewing changes to setup/install.py

setup: Removed 'config' mode. It's now standalone.
setup.configure: Renamed to setup/ivle-config.
    Made executable and standalone Python script (with a Main function).

You now run ./setup/ivle-config as a standalone script, not 'setup.py config'.
This will eventually get moved out but can't right now due to having to
generate the Trampoline conf.h file.

Show diffs side-by-side

added added

removed removed

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