← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/makeuser.py

  • Committer: Matt Giuca
  • Date: 2010-02-18 05:16:37 UTC
  • Revision ID: matt.giuca@gmail.com-20100218051637-obexfwxbh9vqg16w
ivle.studpath: Removed svnpublished. This is now very much unused, and it's the only reason this module uses pysvn.

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
49
 
 
50
 
from ivle.database import ProjectGroup
 
28
import subprocess
 
29
 
 
30
from storm.expr import Select, Max
 
31
 
 
32
import ivle.config
 
33
from ivle.database import (User, ProjectGroup, Assessed, ProjectSubmission,
 
34
        Project, ProjectSet, Offering, Enrolment, Subject, Semester)
51
35
 
52
36
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).
 
37
    """chown a directory and its contents to the web server.
 
38
 
 
39
    Recursively chowns a file or directory so the web server user owns it.
56
40
    Assumes root.
57
41
    """
58
 
    try:
59
 
        os.system("chown -R www-data:www-data %s" % filename)
60
 
    except:
61
 
        pass
 
42
    subprocess.call(['chown', '-R', 'www-data:www-data', filename])
62
43
 
63
44
def make_svn_repo(path, throw_on_error=True):
64
 
    """Create a Subversion repository at the given path.
65
 
    """
 
45
    """Create a Subversion repository at the given path."""
66
46
    try:
67
 
        res = os.system("svnadmin create '%s'" % path)
 
47
        res = subprocess.call(['svnadmin', 'create', path])
68
48
        if res != 0 and throw_on_error:
69
49
            raise Exception("Cannot create repository: %s" % path)
70
50
    except Exception, exc:
76
56
 
77
57
def rebuild_svn_config(store, config):
78
58
    """Build the complete SVN configuration file.
 
59
 
79
60
    @param config: An ivle.config.Config object.
80
61
    """
81
 
    users = store.find(ivle.database.User)
82
 
    groups = {}
83
 
    # TODO: Populate groups with per-offering tutors/lecturers/etc.
 
62
    users = store.find(User)
84
63
    conf_name = config['paths']['svn']['conf']
85
64
    temp_name = conf_name + ".new"
86
65
    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")
 
66
    f.write("""\
 
67
# IVLE SVN repository authorisation configuration
 
68
# Generated: %(time)s
 
69
""" % {'time': time.asctime()})
 
70
 
94
71
    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")
 
72
        f.write("""
 
73
[%(login)s:/]
 
74
%(login)s = rw
 
75
""" % {'login': u.login})
 
76
 
 
77
    # Now we need to grant offering tutors and lecturers access to the latest
 
78
    # submissions in their offerings. There are much prettier ways to do this,
 
79
    # but a lot of browser requests call this function, so it needs to be
 
80
    # fast. We can grab all of the paths needing authorisation directives with
 
81
    # a single query, and we cache the list of viewers for each offering.
 
82
    offering_viewers_cache = {}
 
83
    for (login, psid, pspath, offeringid) in store.find(
 
84
        (User.login, ProjectSubmission.id, ProjectSubmission.path,
 
85
         Offering.id),
 
86
            Assessed.id == ProjectSubmission.assessed_id,
 
87
            User.id == Assessed.user_id,
 
88
            Project.id == Assessed.project_id,
 
89
            ProjectSet.id == Project.project_set_id,
 
90
            Offering.id == ProjectSet.id,
 
91
            ProjectSubmission.date_submitted == Select(
 
92
                    Max(ProjectSubmission.date_submitted),
 
93
                    ProjectSubmission.assessed_id == Assessed.id,
 
94
                    tables=ProjectSubmission
 
95
            )
 
96
        ):
 
97
 
 
98
        # Do we already have the list of logins authorised for this offering
 
99
        # cached? If not, get it.
 
100
        if offeringid not in offering_viewers_cache:
 
101
            offering_viewers_cache[offeringid] = list(store.find(
 
102
                    User.login,
 
103
                    User.id == Enrolment.user_id,
 
104
                    Enrolment.offering_id == offeringid,
 
105
                    Enrolment.role.is_in((u'tutor', u'lecturer')),
 
106
                    Enrolment.active == True,
 
107
                )
 
108
            )
 
109
 
 
110
        f.write("""
 
111
# Submission %(id)d
 
112
[%(login)s:%(path)s]
 
113
""" % {'login': login, 'id': psid, 'path': pspath})
 
114
 
 
115
        for viewer_login in offering_viewers_cache[offeringid]:
 
116
            # We don't want to override the owner's write privilege,
 
117
            # so we don't add them to the read-only ACL.
 
118
            if login != viewer_login:
 
119
                f.write("%s = r\n" % viewer_login)
 
120
 
101
121
    f.close()
102
122
    os.rename(temp_name, conf_name)
103
123
    chown_to_webserver(conf_name)
104
124
 
105
125
def rebuild_svn_group_config(store, config):
106
126
    """Build the complete SVN configuration file for groups
 
127
 
107
128
    @param config: An ivle.config.Config object.
108
129
    """
109
130
    conf_name = config['paths']['svn']['group_conf']
110
131
    temp_name = conf_name + ".new"
111
132
    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")
 
133
 
 
134
    f.write("""\
 
135
# IVLE SVN group repository authorisation configuration
 
136
# Generated: %(time)s
 
137
 
 
138
""" % {'time': time.asctime()})
 
139
 
 
140
    group_members_cache = {}
115
141
    for group in store.find(ProjectGroup):
116
142
        offering = group.project_set.offering
117
143
        reponame = "_".join([offering.subject.short_name,
118
144
                             offering.semester.year,
119
145
                             offering.semester.semester,
120
146
                             group.name])
121
 
        f.write("[%s:/]\n"%reponame)
 
147
 
 
148
        f.write("[%s:/]\n" % reponame)
 
149
        if group.id not in group_members_cache:
 
150
            group_members_cache[group.id] = set()
122
151
        for user in group.members:
 
152
            group_members_cache[group.id].add(user.login)
123
153
            f.write("%s = rw\n" % user.login)
124
154
        f.write("\n")
 
155
 
 
156
    # Now we need to grant offering tutors and lecturers access to the latest
 
157
    # submissions in their offerings. There are much prettier ways to do this,
 
158
    # but a lot of browser requests call this function, so it needs to be
 
159
    # fast. We can grab all of the paths needing authorisation directives with
 
160
    # a single query, and we cache the list of viewers for each offering.
 
161
    offering_viewers_cache = {}
 
162
    for (ssn, year, sem, name, psid, pspath, gid, offeringid) in store.find(
 
163
        (Subject.short_name, Semester.year, Semester.semester,
 
164
         ProjectGroup.name, ProjectSubmission.id, ProjectSubmission.path,
 
165
         ProjectGroup.id, Offering.id),
 
166
            Assessed.id == ProjectSubmission.assessed_id,
 
167
            ProjectGroup.id == Assessed.project_group_id,
 
168
            Project.id == Assessed.project_id,
 
169
            ProjectSet.id == Project.project_set_id,
 
170
            Offering.id == ProjectSet.offering_id,
 
171
            Subject.id == Offering.subject_id,
 
172
            Semester.id == Offering.semester_id,
 
173
            ProjectSubmission.date_submitted == Select(
 
174
                    Max(ProjectSubmission.date_submitted),
 
175
                    ProjectSubmission.assessed_id == Assessed.id,
 
176
                    tables=ProjectSubmission
 
177
            )
 
178
        ):
 
179
 
 
180
        reponame = "_".join([ssn, year, sem, name])
 
181
 
 
182
        # Do we already have the list of logins authorised for this offering
 
183
        # cached? If not, get it.
 
184
        if offeringid not in offering_viewers_cache:
 
185
            offering_viewers_cache[offeringid] = list(store.find(
 
186
                    User.login,
 
187
                    User.id == Enrolment.user_id,
 
188
                    Enrolment.offering_id == offeringid,
 
189
                    Enrolment.role.is_in((u'tutor', u'lecturer')),
 
190
                    Enrolment.active == True,
 
191
                )
 
192
            )
 
193
 
 
194
        f.write("""
 
195
# Submission %(id)d
 
196
[%(repo)s:%(path)s]
 
197
""" % {'repo': reponame, 'id': psid, 'path': pspath})
 
198
 
 
199
        for viewer_login in offering_viewers_cache[offeringid]:
 
200
            # Skip existing group members, or they can't write to it any more.
 
201
            if viewer_login not in group_members_cache[gid]:
 
202
                f.write("%s = r\n" % viewer_login)
 
203
 
125
204
    f.close()
126
205
    os.rename(temp_name, conf_name)
127
206
    chown_to_webserver(conf_name)
128
207
 
129
208
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.
 
209
    """Create a Subversion password for a user.
 
210
 
 
211
    Generates a new random Subversion password, and assigns it to the user.
 
212
    The password is added to Apache's Subversion authentication file.
132
213
    """
133
214
    # filename is, eg, /var/lib/ivle/svn/ivle.auth
134
215
    filename = config['paths']['svn']['auth_ivle']
135
 
    passwd = hashlib.md5(uuid.uuid4().bytes).hexdigest()
136
216
    if os.path.exists(filename):
137
217
        create = ""
138
218
    else:
139
219
        create = "c"
140
220
 
141
 
    user = ivle.database.User.get_by_login(store, login)
142
 
    user.svn_pass = unicode(passwd)
143
 
 
144
 
    res = os.system("htpasswd -%smb %s %s %s" % (create, filename,
145
 
                                              login, passwd))
 
221
    user = User.get_by_login(store, login)
 
222
 
 
223
    if user.svn_pass is None:
 
224
        passwd = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
225
        user.svn_pass = unicode(passwd)
 
226
 
 
227
    res = subprocess.call(['htpasswd', '-%smb' % create,
 
228
                           filename, login, user.svn_pass])
146
229
    if res != 0 and throw_on_error:
147
230
        raise Exception("Unable to create ivle-auth for %s" % login)
148
231
 
150
233
    if create == "c":
151
234
        chown_to_webserver(filename)
152
235
 
153
 
    return passwd
154
 
 
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.
 
236
    return user.svn_pass
 
237
 
 
238
def make_jail(user, config, force=True):
 
239
    """Create or update a user's jail.
 
240
 
 
241
    Only the user-specific parts of the jail are created here - everything
 
242
    else is expected to be part of another aufs branch.
190
243
 
191
244
    Returns the path to the user's home directory.
192
245
 
193
246
    Chowns the user's directory within the jail to the given UID.
194
247
 
195
 
    force: If false, exception if jail already exists for this user.
196
 
    If true (default), overwrites it, but preserves home directory.
 
248
    @param force: If False, raise an exception if the user already has a jail.
 
249
                  If True (default), rebuild the jail preserving /home.
197
250
    """
198
251
    # MUST run as root or some of this may fail
199
252
    if os.getuid() != 0:
200
253
        raise Exception("Must run make_jail as root")
201
254
    
202
255
    # tempdir is for putting backup homes in
203
 
    tempdir = os.path.join(ivle.conf.jail_src_base, '__temp__')
 
256
    jail_src_base = config['paths']['jails']['src']
 
257
    tempdir = os.path.join(jail_src_base, '__temp__')
204
258
    if not os.path.exists(tempdir):
205
259
        os.makedirs(tempdir)
206
260
    elif not os.path.isdir(tempdir):
207
261
        os.unlink(tempdir)
208
262
        os.mkdir(tempdir)
209
 
    userdir = os.path.join(ivle.conf.jail_src_base, user.login)
 
263
    userdir = os.path.join(jail_src_base, user.login)
210
264
    homedir = os.path.join(userdir, 'home')
 
265
    tmpdir = os.path.join(userdir, 'tmp')
211
266
    userhomedir = os.path.join(homedir, user.login)   # Return value
212
267
 
213
268
    if os.path.exists(userdir):
216
271
        # User jail already exists. Blow it away but preserve their home
217
272
        # directory. It should be all that is there anyway, but you never
218
273
        # know!
219
 
        # Ignore warnings about the use of tmpnam
 
274
        # Ignore warnings about the use of tempnam
220
275
        warnings.simplefilter('ignore')
221
276
        homebackup = os.tempnam(tempdir)
222
277
        warnings.resetwarnings()
225
280
        # NOTE that shutil.move changed in Python 2.6, it now moves a
226
281
        # directory INTO the target (like `mv`), which it didn't use to do.
227
282
        # This code works regardless.
228
 
        shutil.move(homedir, homebackup)
 
283
        shutil.move(userhomedir, homebackup)
229
284
        shutil.rmtree(userdir)
230
 
        os.makedirs(userdir)
231
 
        shutil.move(homebackup, homedir)
 
285
        os.makedirs(homedir)
 
286
        shutil.move(homebackup, userhomedir)
232
287
        # Change the ownership of all the files to the right unixid
233
288
        logging.debug("chown %s's home directory files to uid %d"
234
289
            %(user.login, user.unixid))
243
298
        # Chmod to rwxr-xr-x (755)
244
299
        os.chmod(userhomedir, 0755)
245
300
 
246
 
    make_ivle_conf(user.login, userdir, user.svn_pass)
247
 
    make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
 
301
    make_ivle_conf(user.login, userdir, user.svn_pass, config)
 
302
    make_etc_passwd(user.login, userdir, config['paths']['jails']['template'],
 
303
                    user.unixid)
 
304
    os.makedirs(tmpdir)
 
305
    os.chmod(tmpdir, 01777)
248
306
 
249
307
    return userhomedir
250
308
 
251
 
def make_ivle_conf(username, user_jail_dir, svn_pass):
252
 
    """
 
309
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
 
310
    """Generate an ivle.conf for a user's jail.
 
311
 
253
312
    Creates (overwriting any existing file, and creating directories) a
254
313
    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.
 
314
 
 
315
    @param username: Username.
 
316
    @param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
 
317
    @param svn_pass: User's SVN password.
 
318
    @param sys_config: An ivle.config.Config object (the system-wide config).
258
319
    """
259
 
    conf_path = os.path.join(user_jail_dir, "etc/ivle/ivle.conf")
260
 
    os.makedirs(os.path.dirname(conf_path))
 
320
    conf_path = os.path.join(user_jail_dir, "home/.ivle.conf")
 
321
    if not os.path.exists(os.path.dirname(conf_path)):
 
322
        os.makedirs(os.path.dirname(conf_path))
261
323
 
262
324
    # In the "in-jail" version of conf, we don't need MOST of the details
263
325
    # (it would be a security risk to have them here).
264
326
    # So we just write root_dir.
265
327
    conf_obj = ivle.config.Config(blank=True)
266
328
    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
 
329
    conf_obj['urls'] = {}
 
330
    conf_obj['urls']['root'] = sys_config['urls']['root']
 
331
    conf_obj['urls']['public_host'] = sys_config['urls']['public_host']
 
332
    conf_obj['urls']['svn_addr'] = sys_config['urls']['svn_addr']
 
333
    conf_obj['user_info'] = {}
270
334
    conf_obj['user_info']['login'] = username
271
335
    conf_obj['user_info']['svn_pass'] = svn_pass
272
336
    conf_obj.write()
277
341
                        | stat.S_IROTH)
278
342
 
279
343
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
280
 
    """
 
344
    """Create a passwd file for a user's jail.
 
345
 
281
346
    Creates /etc/passwd in the given user's jail. This will be identical to
282
347
    that in the template jail, except for the added entry for this user.
283
348
    """
284
 
    template_passwd_path = os.path.join(template_dir, "etc/passwd")
285
 
    passwd_path = os.path.join(user_jail_dir, "etc/passwd")
 
349
    template_passwd_path = os.path.join(template_dir, "home/.passwd")
 
350
    passwd_path = os.path.join(user_jail_dir, "home/.passwd")
286
351
    passwd_dir = os.path.dirname(passwd_path)
287
352
    if not os.path.exists(passwd_dir):
288
353
        os.makedirs(passwd_dir)
291
356
    passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
292
357
                      % (username, unixid, unixid, username))
293
358
    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))