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

« back to all changes in this revision

Viewing changes to ivle/makeuser.py

  • Committer: William Grant
  • Date: 2009-07-05 12:23:11 UTC
  • mto: (1294.4.2 ui-the-third)
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: grantw@unimelb.edu.au-20090705122311-wfyih6snxs4c144p
Recenter the breadcrumb text.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.pulldown_subj
48
 
 
49
 
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)
50
35
 
51
36
def chown_to_webserver(filename):
52
 
    """
53
 
    Chowns a file so the web server user owns it.
54
 
    (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.
55
40
    Assumes root.
56
41
    """
57
 
    try:
58
 
        os.system("chown -R www-data:www-data %s" % filename)
59
 
    except:
60
 
        pass
 
42
    subprocess.call(['chown', '-R', 'www-data:www-data', filename])
61
43
 
62
44
def make_svn_repo(path, throw_on_error=True):
63
 
    """Create a Subversion repository at the given path.
64
 
    """
 
45
    """Create a Subversion repository at the given path."""
65
46
    try:
66
 
        res = os.system("svnadmin create '%s'" % path)
 
47
        res = subprocess.call(['svnadmin', 'create', path])
67
48
        if res != 0 and throw_on_error:
68
49
            raise Exception("Cannot create repository: %s" % path)
69
50
    except Exception, exc:
75
56
 
76
57
def rebuild_svn_config(store, config):
77
58
    """Build the complete SVN configuration file.
 
59
 
78
60
    @param config: An ivle.config.Config object.
79
61
    """
80
 
    users = store.find(ivle.database.User)
81
 
    groups = {}
82
 
    # TODO: Populate groups with per-offering tutors/lecturers/etc.
 
62
    users = store.find(User)
83
63
    conf_name = config['paths']['svn']['conf']
84
64
    temp_name = conf_name + ".new"
85
65
    f = open(temp_name, "w")
86
 
    f.write("# IVLE SVN Repositories Configuration\n")
87
 
    f.write("# Auto-generated on %s\n" % time.asctime())
88
 
    f.write("\n")
89
 
    f.write("[groups]\n")
90
 
    for (g,ls) in groups.iteritems():
91
 
        f.write("%s = %s\n" % (g, ",".join(ls)))
92
 
    f.write("\n")
 
66
    f.write("""\
 
67
# IVLE SVN repository authorisation configuration
 
68
# Generated: %(time)s
 
69
""" % {'time': time.asctime()})
 
70
 
93
71
    for u in users:
94
 
        f.write("[%s:/]\n" % u.login)
95
 
        f.write("%s = rw\n" % u.login)
96
 
        #f.write("@tutor = r\n")
97
 
        #f.write("@lecturer = rw\n")
98
 
        #f.write("@admin = rw\n")
99
 
        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
                )
 
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
 
100
120
    f.close()
101
121
    os.rename(temp_name, conf_name)
102
122
    chown_to_webserver(conf_name)
103
123
 
104
124
def rebuild_svn_group_config(store, config):
105
125
    """Build the complete SVN configuration file for groups
 
126
 
106
127
    @param config: An ivle.config.Config object.
107
128
    """
108
129
    conf_name = config['paths']['svn']['group_conf']
109
130
    temp_name = conf_name + ".new"
110
131
    f = open(temp_name, "w")
111
 
    f.write("# IVLE SVN Group Repositories Configuration\n")
112
 
    f.write("# Auto-generated on %s\n" % time.asctime())
113
 
    f.write("\n")
 
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 = {}
114
140
    for group in store.find(ProjectGroup):
115
141
        offering = group.project_set.offering
116
142
        reponame = "_".join([offering.subject.short_name,
117
143
                             offering.semester.year,
118
144
                             offering.semester.semester,
119
145
                             group.name])
120
 
        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()
121
150
        for user in group.members:
 
151
            group_members_cache[group.id].add(user.login)
122
152
            f.write("%s = rw\n" % user.login)
123
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
 
124
202
    f.close()
125
203
    os.rename(temp_name, conf_name)
126
204
    chown_to_webserver(conf_name)
127
205
 
128
206
def make_svn_auth(store, login, config, throw_on_error=True):
129
 
    """Setup svn authentication for the given user.
130
 
       Uses the given DB store object. Does not commit to the db.
 
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.
131
211
    """
132
212
    # filename is, eg, /var/lib/ivle/svn/ivle.auth
133
213
    filename = config['paths']['svn']['auth_ivle']
137
217
    else:
138
218
        create = "c"
139
219
 
140
 
    user = ivle.database.User.get_by_login(store, login)
 
220
    user = User.get_by_login(store, login)
141
221
    user.svn_pass = unicode(passwd)
142
222
 
143
 
    res = os.system("htpasswd -%smb %s %s %s" % (create, filename,
144
 
                                              login, passwd))
 
223
    res = subprocess.call(['htpasswd', '-%smb' % create,
 
224
                           filename, login, passwd])
145
225
    if res != 0 and throw_on_error:
146
226
        raise Exception("Unable to create ivle-auth for %s" % login)
147
227
 
151
231
 
152
232
    return passwd
153
233
 
154
 
def generate_manifest(basedir, targetdir, parent=''):
155
 
    """ From a basedir and a targetdir work out which files are missing or out 
156
 
    of date and need to be added/updated and which files are redundant and need 
157
 
    to be removed.
158
 
    
159
 
    parent: This is used for the recursive call to track the relative paths 
160
 
    that we have decended.
161
 
    """
162
 
    
163
 
    cmp = filecmp.dircmp(basedir, targetdir)
164
 
 
165
 
    # Add all new files and files that have changed
166
 
    to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
167
 
 
168
 
    # Remove files that are redundant
169
 
    to_remove = [os.path.join(parent,x) for x in cmp.right_only]
170
 
    
171
 
    # Recurse
172
 
    for d in cmp.common_dirs:
173
 
        newbasedir = os.path.join(basedir, d)
174
 
        newtargetdir = os.path.join(targetdir, d)
175
 
        newparent = os.path.join(parent, d)
176
 
        (sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
177
 
        to_add += sadd
178
 
        to_remove += sremove
179
 
 
180
 
    return (to_add, to_remove)
181
 
 
182
 
 
183
234
def make_jail(user, config, force=True):
184
 
    """Creates a new user's jail space, in the jail directory as configured in
185
 
    conf.py.
 
235
    """Create or update a user's jail.
186
236
 
187
 
    This only creates things within /home - everything else is expected to be
188
 
    part of another UnionFS branch.
 
237
    Only the user-specific parts of the jail are created here - everything
 
238
    else is expected to be part of another aufs branch.
189
239
 
190
240
    Returns the path to the user's home directory.
191
241
 
192
242
    Chowns the user's directory within the jail to the given UID.
193
243
 
194
 
    force: If false, exception if jail already exists for this user.
195
 
    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.
196
246
    """
197
247
    # MUST run as root or some of this may fail
198
248
    if os.getuid() != 0:
250
300
    return userhomedir
251
301
 
252
302
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
253
 
    """
 
303
    """Generate an ivle.conf for a user's jail.
 
304
 
254
305
    Creates (overwriting any existing file, and creating directories) a
255
306
    file /etc/ivle/ivle.conf in a given user's jail.
 
307
 
256
308
    @param username: Username.
257
 
    @param user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
 
309
    @param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
258
310
    @param svn_pass: User's SVN password.
259
311
    @param sys_config: An ivle.config.Config object (the system-wide config).
260
312
    """
279
331
                        | stat.S_IROTH)
280
332
 
281
333
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
282
 
    """
 
334
    """Create a passwd file for a user's jail.
 
335
 
283
336
    Creates /etc/passwd in the given user's jail. This will be identical to
284
337
    that in the template jail, except for the added entry for this user.
285
338
    """
293
346
    passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
294
347
                      % (username, unixid, unixid, username))
295
348
    passwd_file.close()
296
 
 
297
 
def mount_jail(login, config):
298
 
    # This is where we'll mount to...
299
 
    destdir = os.path.join(config['paths']['jails']['mounts'], login)
300
 
    # ... and this is where we'll get the user bits.
301
 
    srcdir = os.path.join(config['paths']['jails']['src'], login)
302
 
    try:
303
 
        if not os.path.exists(destdir):
304
 
            os.mkdir(destdir)
305
 
        if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
306
 
                     % (srcdir, config['paths']['jails']['template'],
307
 
                        destdir)) == 0:
308
 
            logging.info("mounted user %s's jail." % login)
309
 
        else:
310
 
            logging.error("failed to mount user %s's jail!" % login)
311
 
    except Exception, message:
312
 
        logging.warning(str(message))