← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/makeuser.py

  • Committer: William Grant
  • Date: 2009-05-28 02:43:56 UTC
  • Revision ID: grantw@unimelb.edu.au-20090528024356-mlrhizz7omnr71hd
Test ivle.mimetypes.nice_filetype.

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).
37
 
 
38
 
import md5
 
18
"""User and group filesystem management helpers."""
 
19
 
 
20
import hashlib
39
21
import os
40
22
import stat
41
23
import shutil
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:
74
54
 
75
55
    chown_to_webserver(path)
76
56
 
77
 
def rebuild_svn_config(store):
 
57
def rebuild_svn_config(store, config):
78
58
    """Build the complete SVN configuration file.
 
59
 
 
60
    @param config: An ivle.config.Config object.
79
61
    """
80
 
    users = store.find(ivle.database.User)
81
 
    groups = {}
82
 
    for u in users:
83
 
        role = str(u.role)
84
 
        if role not in groups:
85
 
            groups[role] = []
86
 
        groups[role].append(u.login)
87
 
    f = open(ivle.conf.svn_conf + ".new", "w")
88
 
    f.write("# IVLE SVN Repositories Configuration\n")
89
 
    f.write("# Auto-generated on %s\n" % time.asctime())
90
 
    f.write("\n")
91
 
    f.write("[groups]\n")
92
 
    for (g,ls) in groups.iteritems():
93
 
        f.write("%s = %s\n" % (g, ",".join(ls)))
94
 
    f.write("\n")
95
 
    for u in users:
96
 
        f.write("[%s:/]\n" % u.login)
97
 
        f.write("%s = rw\n" % u.login)
98
 
        #f.write("@tutor = r\n")
99
 
        #f.write("@lecturer = rw\n")
100
 
        #f.write("@admin = rw\n")
101
 
        f.write("\n")
 
62
    users = store.find(User)
 
63
    conf_name = config['paths']['svn']['conf']
 
64
    temp_name = conf_name + ".new"
 
65
    f = open(temp_name, "w")
 
66
    f.write("""\
 
67
# IVLE SVN repository authorisation configuration
 
68
# Generated: %(time)s
 
69
""" % {'time': time.asctime()})
 
70
 
 
71
    for u in users:
 
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
                )
 
107
            )
 
108
 
 
109
        f.write("""
 
110
# Submission %(id)d
 
111
[%(login)s:%(path)s]
 
112
""" % {'login': login, 'id': psid, 'path': pspath})
 
113
 
 
114
        for viewer_login in offering_viewers_cache[offeringid]:
 
115
            # We don't want to override the owner's write privilege,
 
116
            # so we don't add them to the read-only ACL.
 
117
            if login != viewer_login:
 
118
                f.write("%s = r\n" % viewer_login)
 
119
 
102
120
    f.close()
103
 
    os.rename(ivle.conf.svn_conf + ".new", ivle.conf.svn_conf)
104
 
    chown_to_webserver(ivle.conf.svn_conf)
 
121
    os.rename(temp_name, conf_name)
 
122
    chown_to_webserver(conf_name)
105
123
 
106
 
def rebuild_svn_group_config(store):
 
124
def rebuild_svn_group_config(store, config):
107
125
    """Build the complete SVN configuration file for groups
 
126
 
 
127
    @param config: An ivle.config.Config object.
108
128
    """
109
 
    f = open(ivle.conf.svn_group_conf + ".new", "w")
110
 
    f.write("# IVLE SVN Group Repositories Configuration\n")
111
 
    f.write("# Auto-generated on %s\n" % time.asctime())
112
 
    f.write("\n")
 
129
    conf_name = config['paths']['svn']['group_conf']
 
130
    temp_name = conf_name + ".new"
 
131
    f = open(temp_name, "w")
 
132
 
 
133
    f.write("""\
 
134
# IVLE SVN group repository authorisation configuration
 
135
# Generated: %(time)s
 
136
 
 
137
""" % {'time': time.asctime()})
 
138
 
 
139
    group_members_cache = {}
113
140
    for group in store.find(ProjectGroup):
114
141
        offering = group.project_set.offering
115
142
        reponame = "_".join([offering.subject.short_name,
116
143
                             offering.semester.year,
117
144
                             offering.semester.semester,
118
145
                             group.name])
119
 
        f.write("[%s:/]\n"%reponame)
 
146
 
 
147
        f.write("[%s:/]\n" % reponame)
 
148
        if group.id not in group_members_cache:
 
149
            group_members_cache[group.id] = set()
120
150
        for user in group.members:
 
151
            group_members_cache[group.id].add(user.login)
121
152
            f.write("%s = rw\n" % user.login)
122
153
        f.write("\n")
 
154
 
 
155
    # Now we need to grant offering tutors and lecturers access to the latest
 
156
    # submissions in their offerings. There are much prettier ways to do this,
 
157
    # but a lot of browser requests call this function, so it needs to be
 
158
    # fast. We can grab all of the paths needing authorisation directives with
 
159
    # a single query, and we cache the list of viewers for each offering.
 
160
    offering_viewers_cache = {}
 
161
    for (ssn, year, sem, name, psid, pspath, gid, offeringid) in store.find(
 
162
        (Subject.short_name, Semester.year, Semester.semester,
 
163
         ProjectGroup.name, ProjectSubmission.id, ProjectSubmission.path,
 
164
         ProjectGroup.id, Offering.id),
 
165
            Assessed.id == ProjectSubmission.assessed_id,
 
166
            ProjectGroup.id == Assessed.project_group_id,
 
167
            Project.id == Assessed.project_id,
 
168
            ProjectSet.id == Project.project_set_id,
 
169
            Offering.id == ProjectSet.offering_id,
 
170
            Subject.id == Offering.subject_id,
 
171
            Semester.id == Offering.semester_id,
 
172
            ProjectSubmission.date_submitted == Select(
 
173
                    Max(ProjectSubmission.date_submitted),
 
174
                    ProjectSubmission.assessed_id == Assessed.id,
 
175
                    tables=ProjectSubmission
 
176
            )
 
177
        ):
 
178
 
 
179
        reponame = "_".join([ssn, year, sem, name])
 
180
 
 
181
        # Do we already have the list of logins authorised for this offering
 
182
        # cached? If not, get it.
 
183
        if offeringid not in offering_viewers_cache:
 
184
            offering_viewers_cache[offeringid] = list(store.find(
 
185
                    User.login,
 
186
                    User.id == Enrolment.user_id,
 
187
                    Enrolment.offering_id == offeringid,
 
188
                    Enrolment.role.is_in((u'tutor', u'lecturer'))
 
189
                )
 
190
            )
 
191
 
 
192
        f.write("""
 
193
# Submission %(id)d
 
194
[%(repo)s:%(path)s]
 
195
""" % {'repo': reponame, 'id': psid, 'path': pspath})
 
196
 
 
197
        for viewer_login in offering_viewers_cache[offeringid]:
 
198
            # Skip existing group members, or they can't write to it any more.
 
199
            if viewer_login not in group_members_cache[gid]:
 
200
                f.write("%s = r\n" % viewer_login)
 
201
 
123
202
    f.close()
124
 
    os.rename(ivle.conf.svn_group_conf + ".new", ivle.conf.svn_group_conf)
125
 
    chown_to_webserver(ivle.conf.svn_group_conf)
126
 
 
127
 
def make_svn_auth(store, login, throw_on_error=True):
128
 
    """Setup svn authentication for the given user.
129
 
       Uses the given DB store object. Does not commit to the db.
 
203
    os.rename(temp_name, conf_name)
 
204
    chown_to_webserver(conf_name)
 
205
 
 
206
def make_svn_auth(store, login, config, throw_on_error=True):
 
207
    """Create a Subversion password for a user.
 
208
 
 
209
    Generates a new random Subversion password, and assigns it to the user.
 
210
    The password is added to Apache's Subversion authentication file.
130
211
    """
131
 
    passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
132
 
    if os.path.exists(ivle.conf.svn_auth_ivle):
 
212
    # filename is, eg, /var/lib/ivle/svn/ivle.auth
 
213
    filename = config['paths']['svn']['auth_ivle']
 
214
    passwd = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
215
    if os.path.exists(filename):
133
216
        create = ""
134
217
    else:
135
218
        create = "c"
136
219
 
137
 
    user = ivle.database.User.get_by_login(store, login)
 
220
    user = User.get_by_login(store, login)
138
221
    user.svn_pass = unicode(passwd)
139
222
 
140
 
    res = os.system("htpasswd -%smb %s %s %s" % (create,
141
 
                                              ivle.conf.svn_auth_ivle,
142
 
                                              login, passwd))
 
223
    res = subprocess.call(['htpasswd', '-%smb' % create,
 
224
                           filename, login, passwd])
143
225
    if res != 0 and throw_on_error:
144
226
        raise Exception("Unable to create ivle-auth for %s" % login)
145
227
 
146
228
    # Make sure the file is owned by the web server
147
229
    if create == "c":
148
 
        chown_to_webserver(ivle.conf.svn_auth_ivle)
 
230
        chown_to_webserver(filename)
149
231
 
150
232
    return passwd
151
233
 
152
 
def generate_manifest(basedir, targetdir, parent=''):
153
 
    """ From a basedir and a targetdir work out which files are missing or out 
154
 
    of date and need to be added/updated and which files are redundant and need 
155
 
    to be removed.
156
 
    
157
 
    parent: This is used for the recursive call to track the relative paths 
158
 
    that we have decended.
159
 
    """
160
 
    
161
 
    cmp = filecmp.dircmp(basedir, targetdir)
162
 
 
163
 
    # Add all new files and files that have changed
164
 
    to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
165
 
 
166
 
    # Remove files that are redundant
167
 
    to_remove = [os.path.join(parent,x) for x in cmp.right_only]
168
 
    
169
 
    # Recurse
170
 
    for d in cmp.common_dirs:
171
 
        newbasedir = os.path.join(basedir, d)
172
 
        newtargetdir = os.path.join(targetdir, d)
173
 
        newparent = os.path.join(parent, d)
174
 
        (sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
175
 
        to_add += sadd
176
 
        to_remove += sremove
177
 
 
178
 
    return (to_add, to_remove)
179
 
 
180
 
 
181
 
def make_jail(user, force=True):
182
 
    """Creates a new user's jail space, in the jail directory as configured in
183
 
    conf.py.
184
 
 
185
 
    This only creates things within /home - everything else is expected to be
186
 
    part of another UnionFS branch.
 
234
def make_jail(user, config, force=True):
 
235
    """Create or update a user's jail.
 
236
 
 
237
    Only the user-specific parts of the jail are created here - everything
 
238
    else is expected to be part of another aufs branch.
187
239
 
188
240
    Returns the path to the user's home directory.
189
241
 
190
242
    Chowns the user's directory within the jail to the given UID.
191
243
 
192
 
    force: If false, exception if jail already exists for this user.
193
 
    If true (default), overwrites it, but preserves home directory.
 
244
    @param force: If False, raise an exception if the user already has a jail.
 
245
                  If True (default), rebuild the jail preserving /home.
194
246
    """
195
247
    # MUST run as root or some of this may fail
196
248
    if os.getuid() != 0:
197
249
        raise Exception("Must run make_jail as root")
198
250
    
199
251
    # tempdir is for putting backup homes in
200
 
    tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
 
252
    jail_src_base = config['paths']['jails']['src']
 
253
    tempdir = os.path.join(jail_src_base, '__temp__')
201
254
    if not os.path.exists(tempdir):
202
255
        os.makedirs(tempdir)
203
256
    elif not os.path.isdir(tempdir):
204
257
        os.unlink(tempdir)
205
258
        os.mkdir(tempdir)
206
 
    userdir = os.path.join(ivle.conf.jail_src_base, user.login)
 
259
    userdir = os.path.join(jail_src_base, user.login)
207
260
    homedir = os.path.join(userdir, 'home')
208
261
    userhomedir = os.path.join(homedir, user.login)   # Return value
209
262
 
217
270
        warnings.simplefilter('ignore')
218
271
        homebackup = os.tempnam(tempdir)
219
272
        warnings.resetwarnings()
220
 
        # Note: shutil.move does not behave like "mv" - it does not put a file
221
 
        # into a directory if it already exists, just fails. Therefore it is
222
 
        # not susceptible to tmpnam symlink attack.
 
273
        # Back up the /home directory, delete the entire jail, recreate the
 
274
        # jail directory tree, then copy the /home back
 
275
        # NOTE that shutil.move changed in Python 2.6, it now moves a
 
276
        # directory INTO the target (like `mv`), which it didn't use to do.
 
277
        # This code works regardless.
223
278
        shutil.move(homedir, homebackup)
224
279
        shutil.rmtree(userdir)
225
 
        os.makedirs(homedir)
 
280
        os.makedirs(userdir)
226
281
        shutil.move(homebackup, homedir)
227
282
        # Change the ownership of all the files to the right unixid
228
283
        logging.debug("chown %s's home directory files to uid %d"
229
284
            %(user.login, user.unixid))
230
 
        os.chown(userhomedir, user.unixid, user.unixid)
231
 
        for root, dirs, files in os.walk(userhomedir):
232
 
            for fsobj in dirs + files:
233
 
                os.chown(os.path.join(root, fsobj), user.unixid, user.unixid)
 
285
        os.spawnvp(os.P_WAIT, 'chown', ['chown', '-R', '%d:%d' % (user.unixid,
 
286
                                        user.unixid), userhomedir])
234
287
    else:
235
288
        # No user jail exists
236
289
        # Set up the user's home directory
240
293
        # Chmod to rwxr-xr-x (755)
241
294
        os.chmod(userhomedir, 0755)
242
295
 
243
 
    make_conf_py(user.login, userdir, user.svn_pass)
244
 
    make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
 
296
    make_ivle_conf(user.login, userdir, user.svn_pass, config)
 
297
    make_etc_passwd(user.login, userdir, config['paths']['jails']['template'],
 
298
                    user.unixid)
245
299
 
246
300
    return userhomedir
247
301
 
248
 
def make_conf_py(username, user_jail_dir, svn_pass):
249
 
    """
 
302
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
 
303
    """Generate an ivle.conf for a user's jail.
 
304
 
250
305
    Creates (overwriting any existing file, and creating directories) a
251
 
    file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
252
 
    username: Username.
253
 
    user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
254
 
    svn_pass: User's SVN password.
 
306
    file /etc/ivle/ivle.conf in a given user's jail.
 
307
 
 
308
    @param username: Username.
 
309
    @param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
 
310
    @param svn_pass: User's SVN password.
 
311
    @param sys_config: An ivle.config.Config object (the system-wide config).
255
312
    """
256
 
    conf_path = os.path.join(user_jail_dir,
257
 
            ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
 
313
    conf_path = os.path.join(user_jail_dir, "etc/ivle/ivle.conf")
258
314
    os.makedirs(os.path.dirname(conf_path))
259
315
 
260
316
    # In the "in-jail" version of conf, we don't need MOST of the details
261
317
    # (it would be a security risk to have them here).
262
 
    # So we just write root_dir, and jail_base is "/".
263
 
    # (jail_base being "/" means "jail-relative" paths are relative to "/"
264
 
    # when inside the jail.)
265
 
 
266
 
    # XXX: jail_base is wrong and shouldn't be here. Unfortunately, jail code
267
 
    #      uses ivle.studpath.url_to_{local,jailpaths}, both of which use
268
 
    #      jail_base. Note that they don't use the bits of the return value
269
 
    #      that depend on jail_base, so it can be any string.
270
 
    conf_file = open(conf_path, "w")
271
 
    conf_file.write("""# IVLE jail configuration
272
 
 
273
 
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
274
 
# with this).
275
 
# eg. "/" or "/ivle".
276
 
root_dir = %(root_dir)r
277
 
 
278
 
# This value is not relevant inside the jail, but must remain for now. See
279
 
# the XXX in ivle.makeuser.make_conf_py.
280
 
jail_base = '/'
281
 
 
282
 
# The hostname for serving publicly accessible pages
283
 
public_host = %(public_host)r
284
 
 
285
 
# The URL under which the Subversion repositories are located.
286
 
svn_addr = %(svn_addr)r
287
 
 
288
 
# The login name for the owner of the jail
289
 
login = %(username)r
290
 
 
291
 
# The subversion-only password for the owner of the jail
292
 
svn_pass = %(svn_pass)r
293
 
""" % {'root_dir': ivle.conf.root_dir,
294
 
       'public_host': ivle.conf.public_host,
295
 
       'svn_addr': ivle.conf.svn_addr,
296
 
       'username': username,
297
 
       'svn_pass': svn_pass,
298
 
      })
299
 
    conf_file.close()
 
318
    # So we just write root_dir.
 
319
    conf_obj = ivle.config.Config(blank=True)
 
320
    conf_obj.filename = conf_path
 
321
    conf_obj['urls']['root'] = sys_config['urls']['root']
 
322
    conf_obj['urls']['public_host'] = sys_config['urls']['public_host']
 
323
    conf_obj['urls']['svn_addr'] = sys_config['urls']['svn_addr']
 
324
    conf_obj['user_info']['login'] = username
 
325
    conf_obj['user_info']['svn_pass'] = svn_pass
 
326
    conf_obj.write()
300
327
 
301
328
    # Make this file world-readable
302
329
    # (chmod 644 conf_path)
304
331
                        | stat.S_IROTH)
305
332
 
306
333
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
307
 
    """
 
334
    """Create a passwd file for a user's jail.
 
335
 
308
336
    Creates /etc/passwd in the given user's jail. This will be identical to
309
337
    that in the template jail, except for the added entry for this user.
310
338
    """
318
346
    passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
319
347
                      % (username, unixid, unixid, username))
320
348
    passwd_file.close()
321
 
 
322
 
def mount_jail(login):
323
 
    # This is where we'll mount to...
324
 
    destdir = os.path.join(ivle.conf.jail_base, login)
325
 
    # ... and this is where we'll get the user bits.
326
 
    srcdir = os.path.join(ivle.conf.jail_src_base, login)
327
 
    try:
328
 
        if not os.path.exists(destdir):
329
 
            os.mkdir(destdir)
330
 
        if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
331
 
                     % (srcdir, ivle.conf.jail_system, destdir)) == 0:
332
 
            logging.info("mounted user %s's jail." % login)
333
 
        else:
334
 
            logging.error("failed to mount user %s's jail!" % login)
335
 
    except Exception, message:
336
 
        logging.warning(str(message))