← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/install.py

Added config validation spec: ivle/config/ivle-spec.conf.
ivle.conf.conf: No longer needs to do the cast-to-int hack.
ivle.config: Runs against the validator (with a XXX problem).
setup.util: ivle-spec.conf is installed with a new whitelist.

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup/install.py
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
 
32
33
Create $target/bin.
33
34
Copy bin/trampoline/trampoline to $target/bin.
34
35
Copy bin/timount/timount to $target/bin.
 
36
Copy etc/ivle.conf to /etc/ivle/ivle.conf.
35
37
chown and chmod the installed trampoline.
36
38
Copy www/ to $target.
37
 
Copy jail/ to jail_system directory (unless --nojail specified).
38
39
Copy subjects/ to subjects directory (unless --nosubjects specified).
39
40
"""
40
41
 
43
44
    parser.add_option("-n", "--dry",
44
45
        action="store_true", dest="dry",
45
46
        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
47
    parser.add_option("-S", "--nosubjects",
50
48
        action="store_true", dest="nosubjects",
51
49
        help="Don't copy subject/ to subjects directory.")
 
50
    parser.add_option("-R", "--nosvnrevno",
 
51
        action="store_true", dest="nosvnrevno",
 
52
        help="Don't write out the Subversion revision to the share directory.")
 
53
    parser.add_option("--root",
 
54
        action="store", dest="rootdir",
 
55
        help="Install into a different root directory.",
 
56
        default='/')
52
57
    (options, args) = parser.parse_args(args)
53
58
 
54
59
    # Call the real function
55
 
    return __install(options.dry, options.nojail, options.nosubjects)
 
60
    return __install(options.dry, options.nosubjects, options.rootdir,
 
61
                     options.nosvnrevno)
56
62
 
57
 
def __install(dry=False,nojail=False,nosubjects=False):
 
63
def __install(dry=False, nosubjects=False, rootdir=None, nosvnrevno=False):
58
64
    # We need to import the one in the working copy, not in the system path.
59
65
    confmodule = __import__("ivle/conf/conf")
60
66
    install_list = util.InstallList()
61
67
 
 
68
    # We need to apply make_install_path with the rootdir to an awful lot of
 
69
    # config variables, so make it easy:
 
70
    mip = functools.partial(util.make_install_path, rootdir)
 
71
 
62
72
    # 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
 
73
    lib_path = mip(confmodule.lib_path)
 
74
    share_path = mip(confmodule.share_path)
 
75
    bin_path = mip(confmodule.bin_path)
 
76
    python_site_packages = mip(confmodule.python_site_packages)
 
77
    jail_base = mip(confmodule.jail_base)
 
78
    jail_system = mip(confmodule.jail_system)
 
79
    subjects_base = mip(confmodule.subjects_base)
 
80
    exercises_base = mip(confmodule.exercises_base)
71
81
 
72
82
    # Must be run as root or a dry run  
73
83
    if dry:
74
84
        print "Dry run (no actions will be executed)\n"
75
85
    
76
86
    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)."
 
87
        print >>sys.stderr, "Must be root to run install"
79
88
        return 1
80
89
 
81
90
    # 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)
 
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)
93
102
 
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'),
 
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'),
100
109
                      util.wwwuid, util.wwwuid, dry)
101
110
 
102
111
    # Create lib and copy the compiled files there
110
119
    timountpath = os.path.join(lib_path, 'timount')
111
120
    util.action_copyfile('bin/timount/timount', timountpath, dry)
112
121
 
113
 
    # Create a services directory to put the usrmgt-server in.
114
 
    util.action_mkdir(os.path.join(share_path, 'services'), dry)
 
122
    ivleconfpath = mip('/etc/ivle/ivle.conf')
 
123
    util.action_copyfile('etc/ivle.conf', ivleconfpath, dry)
115
124
 
 
125
    # Copy in the services (only usrmgt-server is needed on the host, but
 
126
    # the jail build requires the rest).
 
127
    util.action_copylist(install_list.list_services, share_path, dry)
116
128
    usrmgtpath = os.path.join(share_path, 'services/usrmgt-server')
117
 
    util.action_copyfile('services/usrmgt-server', usrmgtpath, dry)
118
129
    util.action_chmod_x(usrmgtpath, dry)
119
130
 
120
131
    # Copy the user-executable binaries using the list.
121
132
    util.action_copylist(install_list.list_user_binaries, bin_path, dry,
122
133
                         onlybasename=True)
123
134
 
124
 
    # Copy the www and lib directories using the list
 
135
    # Copy the www directory (using the list)
125
136
    util.action_copylist(install_list.list_www, share_path, dry)
 
137
 
 
138
    # Set appropriate permissions on the php directory
 
139
    forum_dir = "www/php/phpBB3"
 
140
    forum_path = os.path.join(share_path, forum_dir)
 
141
    print "chown -R www-data:www-data %s" % forum_path
 
142
    if not dry:
 
143
        os.system("chown -R www-data:www-data %s" % forum_path)
 
144
 
 
145
    # Copy the lib directory (using the list)
126
146
    util.action_copylist(install_list.list_ivle_lib, python_site_packages, dry)
127
 
    
 
147
 
128
148
    # Make the config file private
129
 
    # XXX Get rid of lib
130
149
    configpath = os.path.join(python_site_packages, 'ivle/conf/conf.py')
131
150
    util.action_make_private(configpath, dry)
132
151
 
133
 
    # Copy the php directory
134
 
    forum_dir = "www/php/phpBB3"
135
 
    forum_path = os.path.join(share_path, forum_dir)
136
 
    util.action_copytree(forum_dir, forum_path, dry)
137
 
    print "chown -R www-data:www-data %s" % forum_path
138
 
    if not dry:
139
 
        os.system("chown -R www-data:www-data %s" % forum_path)
140
 
 
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
152
    if not nosubjects:
148
153
        # Copy the subjects and exercises directories across
149
154
        util.action_mkdir(subjects_base, dry)
164
169
    except (IOError, OSError):
165
170
        pass
166
171
 
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")
 
172
    if not nosvnrevno:
 
173
        # Create the ivle working revision record file
 
174
        ivle_revision_file = os.path.join(share_path, 'revision.txt')
 
175
        if not dry:
 
176
            try:
 
177
                conf = open(ivle_revision_file, "w")
172
178
 
173
 
            conf.write("""# SVN revision r%s
 
179
                conf.write("""# SVN revision r%s
174
180
# Source tree location: %s
175
181
# Modified files:
176
182
""" % (util.get_svn_revision(), os.getcwd()))
177
183
 
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
 
184
                conf.close()
 
185
            except IOError, (errno, strerror):
 
186
                print "IO error(%s): %s" % (errno, strerror)
 
187
                sys.exit(1)
 
188
 
 
189
            os.system("svn status . >> %s" % ivle_revision_file)
 
190
 
 
191
        print "Wrote IVLE code revision status to %s" % ivle_revision_file
186
192
 
187
193
    return 0
188
194