← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup/install.py

Replaced Python config files (conf.py) with new config files system, using
    configobj (INI-file style config files).

setup.py config now produces ./etc/ivle.conf, a new-style config file.
ivle/conf/conf.py is now part of the IVLE source code. It reads the new config
file and provides the same legacy interface, so all of IVLE still functions,
including setup.py config.

Added /etc to the source tree (config files will be stored here).
Added configobj as a dependency in doc/setup/install_proc.txt.

setup.py install copies ./etc/ivle.conf into /etc/ivle/ivle.conf.

Removed boilerplate code generation from setup/configure.py (that code is now
part of ivle/conf/conf.py which is now in the source tree).

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup/install.py
26
26
 
27
27
from setup import util
28
28
 
29
 
PYTHON_VERSION = sys.version[:3]
30
 
 
31
29
def install(args):
32
30
    usage = """usage: %prog install [options]
33
31
(Requires root)
35
33
Create $target/bin.
36
34
Copy bin/trampoline/trampoline to $target/bin.
37
35
Copy bin/timount/timount to $target/bin.
 
36
Copy etc/ivle.conf to /etc/ivle/ivle.conf.
38
37
chown and chmod the installed trampoline.
 
38
Copy www/ to $target.
 
39
Copy subjects/ to subjects directory (unless --nosubjects specified).
39
40
"""
40
41
 
41
42
    # Parse arguments
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.")
 
47
    parser.add_option("-S", "--nosubjects",
 
48
        action="store_true", dest="nosubjects",
 
49
        help="Don't copy subject/ to subjects directory.")
46
50
    parser.add_option("-R", "--nosvnrevno",
47
51
        action="store_true", dest="nosvnrevno",
48
52
        help="Don't write out the Subversion revision to the share directory.")
50
54
        action="store", dest="rootdir",
51
55
        help="Install into a different root directory.",
52
56
        default='/')
53
 
    parser.add_option("--prefix",
54
 
        action="store", dest="prefix",
55
 
        help="Base prefix to install IVLE into (default: /usr/local).",
56
 
        default='/usr/local')
57
 
    parser.add_option("--python-site-packages",
58
 
        action="store", dest="python_site_packages",
59
 
        help="Path to Python site packages directory.",
60
 
        default='/usr/local/lib/python%s/site-packages' % PYTHON_VERSION)
61
57
    (options, args) = parser.parse_args(args)
62
58
 
63
59
    # Call the real function
64
 
    return __install(prefix=options.prefix,
65
 
                     python_site_packages=options.python_site_packages,
66
 
                     dry=options.dry, rootdir=options.rootdir,
67
 
                     nosvnrevno=options.nosvnrevno)
 
60
    return __install(options.dry, options.nosubjects, options.rootdir,
 
61
                     options.nosvnrevno)
68
62
 
69
 
def __install(prefix, python_site_packages, dry=False, rootdir=None,
70
 
              nosvnrevno=False):
 
63
def __install(dry=False, nosubjects=False, rootdir=None, nosvnrevno=False):
 
64
    # We need to import the one in the working copy, not in the system path.
 
65
    confmodule = __import__("ivle/conf/conf")
71
66
    install_list = util.InstallList()
72
67
 
73
68
    # We need to apply make_install_path with the rootdir to an awful lot of
74
69
    # config variables, so make it easy:
75
70
    mip = functools.partial(util.make_install_path, rootdir)
76
71
 
77
 
    # Compute the lib_path, share_path and bin_path (copied from
78
 
    # ivle/conf/conf.py).
79
 
    lib_path = mip(os.path.join(prefix, 'lib/ivle'))
80
 
    share_path = mip(os.path.join(prefix, 'share/ivle'))
81
 
    bin_path = mip(os.path.join(prefix, 'bin'))
82
 
    python_site_packages = mip(python_site_packages)
 
72
    # Pull the required varibles out of the config
 
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)
83
81
 
84
82
    # Must be run as root or a dry run  
85
83
    if dry:
89
87
        print >>sys.stderr, "Must be root to run install"
90
88
        return 1
91
89
 
92
 
    # Create the config directory.
93
 
    util.action_mkdir(mip('/etc/ivle/plugins.d'), dry)
 
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)
94
110
 
95
111
    # Create lib and copy the compiled files there
96
112
    util.action_mkdir(lib_path, dry)
103
119
    timountpath = os.path.join(lib_path, 'timount')
104
120
    util.action_copyfile('bin/timount/timount', timountpath, dry)
105
121
 
 
122
    ivleconfpath = mip('/etc/ivle/ivle.conf')
 
123
    util.action_copyfile('etc/ivle.conf', ivleconfpath, dry)
 
124
 
106
125
    # Copy in the services (only usrmgt-server is needed on the host, but
107
126
    # the jail build requires the rest).
108
127
    util.action_copylist(install_list.list_services, share_path, dry)
113
132
    util.action_copylist(install_list.list_user_binaries, bin_path, dry,
114
133
                         onlybasename=True)
115
134
 
 
135
    # Copy the www directory (using the list)
 
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
 
116
145
    # Copy the lib directory (using the list)
117
146
    util.action_copylist(install_list.list_ivle_lib, python_site_packages, dry)
118
147
 
 
148
    # Make the config file private
 
149
    configpath = os.path.join(python_site_packages, 'ivle/conf/conf.py')
 
150
    util.action_make_private(configpath, dry)
 
151
 
 
152
    if not nosubjects:
 
153
        # Copy the subjects and exercises directories across
 
154
        util.action_mkdir(subjects_base, dry)
 
155
        util.action_copylist(install_list.list_subjects, subjects_base, dry,
 
156
            srcdir="./subjects")
 
157
        util.action_mkdir(exercises_base, dry)
 
158
        util.action_copylist(install_list.list_exercises, exercises_base, dry,
 
159
            srcdir="./exercises")
 
160
 
 
161
    # XXX We shouldn't have ivle.pth at all any more.
 
162
    # We may still need the www packages to be importable.
 
163
    # Anything from www that is needed from the outside should go to lib.
 
164
    ivle_pth = os.path.join(python_site_packages, "ivle.pth")
 
165
    try:
 
166
        file = open(ivle_pth, 'w')
 
167
        file.write(os.path.join(share_path, "www"))
 
168
        file.close()
 
169
    except (IOError, OSError):
 
170
        pass
 
171
 
119
172
    if not nosvnrevno:
120
173
        # Create the ivle working revision record file
121
174
        ivle_revision_file = os.path.join(share_path, 'revision.txt')