← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/makeuser.py

Fix ProjectView's total assigned count by dealing with ResultSets only.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/makeuser.py
1
1
# IVLE - Informatics Virtual Learning Environment
2
 
# Copyright (C) 2007-2008 The University of Melbourne
 
2
# Copyright (C) 2007-2009 The University of Melbourne
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
17
 
18
 
# Module: MakeUser
19
 
# Author: Matt Giuca
20
 
# Date:   1/2/2008
21
 
 
22
 
# Allows creation of users. This sets up the following:
23
 
# * User's jail and home directory within the jail.
24
 
# * Subversion repository (TODO)
25
 
# * Check out Subversion workspace into jail (TODO)
26
 
# * Database details for user
27
 
# * Unix user account
28
 
 
29
 
# TODO: Sanitize login name and other fields.
30
 
# Users must not be called "temp" or "template".
31
 
 
32
 
# TODO: When creating a new home directory, chown it to its owner
33
 
 
34
 
# TODO: In chown_to_webserver:
35
 
# Do not call os.system("chown www-data") - use Python lib
36
 
# and use the web server uid given in conf. (Several places).
 
18
"""User and group filesystem management helpers."""
37
19
 
38
20
import hashlib
39
21
import os
42
24
import time
43
25
import uuid
44
26
import warnings
45
 
import filecmp
46
27
import logging
47
 
import ivle.conf
48
 
import ivle.pulldown_subj
 
28
import subprocess
49
29
 
50
 
from ivle.database import ProjectGroup
 
30
import ivle.config
 
31
from ivle.database import ProjectGroup, User
51
32
 
52
33
def chown_to_webserver(filename):
53
 
    """
54
 
    Chowns a file so the web server user owns it.
55
 
    (This is useful in setting up Subversion conf files).
 
34
    """chown a directory and its contents to the web server.
 
35
 
 
36
    Recursively chowns a file or directory so the web server user owns it.
56
37
    Assumes root.
57
38
    """
58
 
    try:
59
 
        os.system("chown -R www-data:www-data %s" % filename)
60
 
    except:
61
 
        pass
 
39
    subprocess.call(['chown', '-R', 'www-data:www-data', filename])
62
40
 
63
41
def make_svn_repo(path, throw_on_error=True):
64
 
    """Create a Subversion repository at the given path.
65
 
    """
 
42
    """Create a Subversion repository at the given path."""
66
43
    try:
67
 
        res = os.system("svnadmin create '%s'" % path)
 
44
        res = subprocess.call(['svnadmin', 'create', path])
68
45
        if res != 0 and throw_on_error:
69
46
            raise Exception("Cannot create repository: %s" % path)
70
47
    except Exception, exc:
76
53
 
77
54
def rebuild_svn_config(store, config):
78
55
    """Build the complete SVN configuration file.
 
56
 
79
57
    @param config: An ivle.config.Config object.
80
58
    """
81
 
    users = store.find(ivle.database.User)
82
 
    groups = {}
83
 
    # TODO: Populate groups with per-offering tutors/lecturers/etc.
 
59
    users = store.find(User)
84
60
    conf_name = config['paths']['svn']['conf']
85
61
    temp_name = conf_name + ".new"
86
62
    f = open(temp_name, "w")
87
 
    f.write("# IVLE SVN Repositories Configuration\n")
88
 
    f.write("# Auto-generated on %s\n" % time.asctime())
89
 
    f.write("\n")
90
 
    f.write("[groups]\n")
91
 
    for (g,ls) in groups.iteritems():
92
 
        f.write("%s = %s\n" % (g, ",".join(ls)))
93
 
    f.write("\n")
 
63
    f.write("""\
 
64
# IVLE SVN repository authorisation configuration
 
65
# Generated: %(time)s
 
66
""" % {'time': time.asctime()})
 
67
 
94
68
    for u in users:
95
 
        f.write("[%s:/]\n" % u.login)
96
 
        f.write("%s = rw\n" % u.login)
97
 
        #f.write("@tutor = r\n")
98
 
        #f.write("@lecturer = rw\n")
99
 
        #f.write("@admin = rw\n")
100
 
        f.write("\n")
 
69
        f.write("""
 
70
[%(login)s:/]
 
71
%(login)s = rw
 
72
""" % {'login': u.login})
 
73
 
101
74
    f.close()
102
75
    os.rename(temp_name, conf_name)
103
76
    chown_to_webserver(conf_name)
104
77
 
105
78
def rebuild_svn_group_config(store, config):
106
79
    """Build the complete SVN configuration file for groups
 
80
 
107
81
    @param config: An ivle.config.Config object.
108
82
    """
109
83
    conf_name = config['paths']['svn']['group_conf']
110
84
    temp_name = conf_name + ".new"
111
85
    f = open(temp_name, "w")
112
 
    f.write("# IVLE SVN Group Repositories Configuration\n")
113
 
    f.write("# Auto-generated on %s\n" % time.asctime())
114
 
    f.write("\n")
 
86
 
 
87
    f.write("""\
 
88
# IVLE SVN group repository authorisation configuration
 
89
# Generated: %(time)s
 
90
 
 
91
""" % {'time': time.asctime()})
 
92
 
115
93
    for group in store.find(ProjectGroup):
116
94
        offering = group.project_set.offering
117
95
        reponame = "_".join([offering.subject.short_name,
118
96
                             offering.semester.year,
119
97
                             offering.semester.semester,
120
98
                             group.name])
121
 
        f.write("[%s:/]\n"%reponame)
 
99
 
 
100
        f.write("[%s:/]\n" % reponame)
122
101
        for user in group.members:
123
102
            f.write("%s = rw\n" % user.login)
124
103
        f.write("\n")
 
104
 
125
105
    f.close()
126
106
    os.rename(temp_name, conf_name)
127
107
    chown_to_webserver(conf_name)
128
108
 
129
109
def make_svn_auth(store, login, config, throw_on_error=True):
130
 
    """Setup svn authentication for the given user.
131
 
       Uses the given DB store object. Does not commit to the db.
 
110
    """Create a Subversion password for a user.
 
111
 
 
112
    Generates a new random Subversion password, and assigns it to the user.
 
113
    The password is added to Apache's Subversion authentication file.
132
114
    """
133
115
    # filename is, eg, /var/lib/ivle/svn/ivle.auth
134
116
    filename = config['paths']['svn']['auth_ivle']
138
120
    else:
139
121
        create = "c"
140
122
 
141
 
    user = ivle.database.User.get_by_login(store, login)
 
123
    user = User.get_by_login(store, login)
142
124
    user.svn_pass = unicode(passwd)
143
125
 
144
 
    res = os.system("htpasswd -%smb %s %s %s" % (create, filename,
145
 
                                              login, passwd))
 
126
    res = subprocess.call(['htpasswd', '-%smb' % create,
 
127
                           filename, login, passwd])
146
128
    if res != 0 and throw_on_error:
147
129
        raise Exception("Unable to create ivle-auth for %s" % login)
148
130
 
152
134
 
153
135
    return passwd
154
136
 
155
 
def generate_manifest(basedir, targetdir, parent=''):
156
 
    """ From a basedir and a targetdir work out which files are missing or out 
157
 
    of date and need to be added/updated and which files are redundant and need 
158
 
    to be removed.
159
 
    
160
 
    parent: This is used for the recursive call to track the relative paths 
161
 
    that we have decended.
162
 
    """
163
 
    
164
 
    cmp = filecmp.dircmp(basedir, targetdir)
165
 
 
166
 
    # Add all new files and files that have changed
167
 
    to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
168
 
 
169
 
    # Remove files that are redundant
170
 
    to_remove = [os.path.join(parent,x) for x in cmp.right_only]
171
 
    
172
 
    # Recurse
173
 
    for d in cmp.common_dirs:
174
 
        newbasedir = os.path.join(basedir, d)
175
 
        newtargetdir = os.path.join(targetdir, d)
176
 
        newparent = os.path.join(parent, d)
177
 
        (sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
178
 
        to_add += sadd
179
 
        to_remove += sremove
180
 
 
181
 
    return (to_add, to_remove)
182
 
 
183
 
 
184
 
def make_jail(user, force=True):
185
 
    """Creates a new user's jail space, in the jail directory as configured in
186
 
    conf.py.
187
 
 
188
 
    This only creates things within /home - everything else is expected to be
189
 
    part of another UnionFS branch.
 
137
def make_jail(user, config, force=True):
 
138
    """Create or update a user's jail.
 
139
 
 
140
    Only the user-specific parts of the jail are created here - everything
 
141
    else is expected to be part of another aufs branch.
190
142
 
191
143
    Returns the path to the user's home directory.
192
144
 
193
145
    Chowns the user's directory within the jail to the given UID.
194
146
 
195
 
    force: If false, exception if jail already exists for this user.
196
 
    If true (default), overwrites it, but preserves home directory.
 
147
    @param force: If False, raise an exception if the user already has a jail.
 
148
                  If True (default), rebuild the jail preserving /home.
197
149
    """
198
150
    # MUST run as root or some of this may fail
199
151
    if os.getuid() != 0:
200
152
        raise Exception("Must run make_jail as root")
201
153
    
202
154
    # tempdir is for putting backup homes in
203
 
    tempdir = os.path.join(ivle.conf.jail_src_base, '__temp__')
 
155
    jail_src_base = config['paths']['jails']['src']
 
156
    tempdir = os.path.join(jail_src_base, '__temp__')
204
157
    if not os.path.exists(tempdir):
205
158
        os.makedirs(tempdir)
206
159
    elif not os.path.isdir(tempdir):
207
160
        os.unlink(tempdir)
208
161
        os.mkdir(tempdir)
209
 
    userdir = os.path.join(ivle.conf.jail_src_base, user.login)
 
162
    userdir = os.path.join(jail_src_base, user.login)
210
163
    homedir = os.path.join(userdir, 'home')
211
164
    userhomedir = os.path.join(homedir, user.login)   # Return value
212
165
 
243
196
        # Chmod to rwxr-xr-x (755)
244
197
        os.chmod(userhomedir, 0755)
245
198
 
246
 
    make_ivle_conf(user.login, userdir, user.svn_pass)
247
 
    make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
 
199
    make_ivle_conf(user.login, userdir, user.svn_pass, config)
 
200
    make_etc_passwd(user.login, userdir, config['paths']['jails']['template'],
 
201
                    user.unixid)
248
202
 
249
203
    return userhomedir
250
204
 
251
 
def make_ivle_conf(username, user_jail_dir, svn_pass):
252
 
    """
 
205
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
 
206
    """Generate an ivle.conf for a user's jail.
 
207
 
253
208
    Creates (overwriting any existing file, and creating directories) a
254
209
    file /etc/ivle/ivle.conf in a given user's jail.
255
 
    username: Username.
256
 
    user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
257
 
    svn_pass: User's SVN password.
 
210
 
 
211
    @param username: Username.
 
212
    @param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
 
213
    @param svn_pass: User's SVN password.
 
214
    @param sys_config: An ivle.config.Config object (the system-wide config).
258
215
    """
259
216
    conf_path = os.path.join(user_jail_dir, "etc/ivle/ivle.conf")
260
217
    os.makedirs(os.path.dirname(conf_path))
264
221
    # So we just write root_dir.
265
222
    conf_obj = ivle.config.Config(blank=True)
266
223
    conf_obj.filename = conf_path
267
 
    conf_obj['urls']['root'] = ivle.conf.root_dir
268
 
    conf_obj['urls']['public_host'] = ivle.conf.public_host
269
 
    conf_obj['urls']['svn_addr'] = ivle.conf.svn_addr
 
224
    conf_obj['urls']['root'] = sys_config['urls']['root']
 
225
    conf_obj['urls']['public_host'] = sys_config['urls']['public_host']
 
226
    conf_obj['urls']['svn_addr'] = sys_config['urls']['svn_addr']
270
227
    conf_obj['user_info']['login'] = username
271
228
    conf_obj['user_info']['svn_pass'] = svn_pass
272
229
    conf_obj.write()
277
234
                        | stat.S_IROTH)
278
235
 
279
236
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
280
 
    """
 
237
    """Create a passwd file for a user's jail.
 
238
 
281
239
    Creates /etc/passwd in the given user's jail. This will be identical to
282
240
    that in the template jail, except for the added entry for this user.
283
241
    """
291
249
    passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
292
250
                      % (username, unixid, unixid, username))
293
251
    passwd_file.close()
294
 
 
295
 
def mount_jail(login):
296
 
    # This is where we'll mount to...
297
 
    destdir = os.path.join(ivle.conf.jail_base, login)
298
 
    # ... and this is where we'll get the user bits.
299
 
    srcdir = os.path.join(ivle.conf.jail_src_base, login)
300
 
    try:
301
 
        if not os.path.exists(destdir):
302
 
            os.mkdir(destdir)
303
 
        if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
304
 
                     % (srcdir, ivle.conf.jail_system, destdir)) == 0:
305
 
            logging.info("mounted user %s's jail." % login)
306
 
        else:
307
 
            logging.error("failed to mount user %s's jail!" % login)
308
 
    except Exception, message:
309
 
        logging.warning(str(message))