← 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: 2009-04-28 11:02:02 UTC
  • Revision ID: matt.giuca@gmail.com-20090428110202-pqr7ip8jpnqj199o
ivle.makeuser: mount_jail now requires a config argument
    (Though nobody ever seems to call this function...)

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-2009 The University of Melbourne
 
2
# Copyright (C) 2007-2008 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
 
"""User and group filesystem management helpers."""
 
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).
19
37
 
20
38
import hashlib
21
39
import os
24
42
import time
25
43
import uuid
26
44
import warnings
 
45
import filecmp
27
46
import logging
28
 
import subprocess
 
47
import ivle.conf
 
48
import ivle.pulldown_subj
29
49
 
30
 
import ivle.config
31
 
from ivle.database import ProjectGroup, User
 
50
from ivle.database import ProjectGroup
32
51
 
33
52
def chown_to_webserver(filename):
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.
 
53
    """
 
54
    Chowns a file so the web server user owns it.
 
55
    (This is useful in setting up Subversion conf files).
37
56
    Assumes root.
38
57
    """
39
 
    subprocess.call(['chown', '-R', 'www-data:www-data', filename])
 
58
    try:
 
59
        os.system("chown -R www-data:www-data %s" % filename)
 
60
    except:
 
61
        pass
40
62
 
41
63
def make_svn_repo(path, throw_on_error=True):
42
 
    """Create a Subversion repository at the given path."""
 
64
    """Create a Subversion repository at the given path.
 
65
    """
43
66
    try:
44
 
        res = subprocess.call(['svnadmin', 'create', path])
 
67
        res = os.system("svnadmin create '%s'" % path)
45
68
        if res != 0 and throw_on_error:
46
69
            raise Exception("Cannot create repository: %s" % path)
47
70
    except Exception, exc:
53
76
 
54
77
def rebuild_svn_config(store, config):
55
78
    """Build the complete SVN configuration file.
56
 
 
57
79
    @param config: An ivle.config.Config object.
58
80
    """
59
 
    users = store.find(User)
 
81
    users = store.find(ivle.database.User)
 
82
    groups = {}
 
83
    # TODO: Populate groups with per-offering tutors/lecturers/etc.
60
84
    conf_name = config['paths']['svn']['conf']
61
85
    temp_name = conf_name + ".new"
62
86
    f = open(temp_name, "w")
63
 
    f.write("""\
64
 
# IVLE SVN repository authorisation configuration
65
 
# Generated: %(time)s
66
 
""" % {'time': time.asctime()})
67
 
 
 
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")
68
94
    for u in users:
69
 
        f.write("""
70
 
[%(login)s:/]
71
 
%(login)s = rw
72
 
""" % {'login': u.login})
73
 
 
 
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")
74
101
    f.close()
75
102
    os.rename(temp_name, conf_name)
76
103
    chown_to_webserver(conf_name)
77
104
 
78
105
def rebuild_svn_group_config(store, config):
79
106
    """Build the complete SVN configuration file for groups
80
 
 
81
107
    @param config: An ivle.config.Config object.
82
108
    """
83
109
    conf_name = config['paths']['svn']['group_conf']
84
110
    temp_name = conf_name + ".new"
85
111
    f = open(temp_name, "w")
86
 
 
87
 
    f.write("""\
88
 
# IVLE SVN group repository authorisation configuration
89
 
# Generated: %(time)s
90
 
 
91
 
""" % {'time': time.asctime()})
92
 
 
 
112
    f.write("# IVLE SVN Group Repositories Configuration\n")
 
113
    f.write("# Auto-generated on %s\n" % time.asctime())
 
114
    f.write("\n")
93
115
    for group in store.find(ProjectGroup):
94
116
        offering = group.project_set.offering
95
117
        reponame = "_".join([offering.subject.short_name,
96
118
                             offering.semester.year,
97
119
                             offering.semester.semester,
98
120
                             group.name])
99
 
 
100
 
        f.write("[%s:/]\n" % reponame)
 
121
        f.write("[%s:/]\n"%reponame)
101
122
        for user in group.members:
102
123
            f.write("%s = rw\n" % user.login)
103
124
        f.write("\n")
104
 
 
105
125
    f.close()
106
126
    os.rename(temp_name, conf_name)
107
127
    chown_to_webserver(conf_name)
108
128
 
109
129
def make_svn_auth(store, login, config, throw_on_error=True):
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.
 
130
    """Setup svn authentication for the given user.
 
131
       Uses the given DB store object. Does not commit to the db.
114
132
    """
115
133
    # filename is, eg, /var/lib/ivle/svn/ivle.auth
116
134
    filename = config['paths']['svn']['auth_ivle']
120
138
    else:
121
139
        create = "c"
122
140
 
123
 
    user = User.get_by_login(store, login)
 
141
    user = ivle.database.User.get_by_login(store, login)
124
142
    user.svn_pass = unicode(passwd)
125
143
 
126
 
    res = subprocess.call(['htpasswd', '-%smb' % create,
127
 
                           filename, login, passwd])
 
144
    res = os.system("htpasswd -%smb %s %s %s" % (create, filename,
 
145
                                              login, passwd))
128
146
    if res != 0 and throw_on_error:
129
147
        raise Exception("Unable to create ivle-auth for %s" % login)
130
148
 
134
152
 
135
153
    return passwd
136
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
 
137
184
def make_jail(user, config, force=True):
138
 
    """Create or update a user's jail.
 
185
    """Creates a new user's jail space, in the jail directory as configured in
 
186
    conf.py.
139
187
 
140
 
    Only the user-specific parts of the jail are created here - everything
141
 
    else is expected to be part of another aufs branch.
 
188
    This only creates things within /home - everything else is expected to be
 
189
    part of another UnionFS branch.
142
190
 
143
191
    Returns the path to the user's home directory.
144
192
 
145
193
    Chowns the user's directory within the jail to the given UID.
146
194
 
147
 
    @param force: If False, raise an exception if the user already has a jail.
148
 
                  If True (default), rebuild the jail preserving /home.
 
195
    force: If false, exception if jail already exists for this user.
 
196
    If true (default), overwrites it, but preserves home directory.
149
197
    """
150
198
    # MUST run as root or some of this may fail
151
199
    if os.getuid() != 0:
203
251
    return userhomedir
204
252
 
205
253
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
206
 
    """Generate an ivle.conf for a user's jail.
207
 
 
 
254
    """
208
255
    Creates (overwriting any existing file, and creating directories) a
209
256
    file /etc/ivle/ivle.conf in a given user's jail.
210
 
 
211
257
    @param username: Username.
212
 
    @param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
 
258
    @param user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
213
259
    @param svn_pass: User's SVN password.
214
260
    @param sys_config: An ivle.config.Config object (the system-wide config).
215
261
    """
234
280
                        | stat.S_IROTH)
235
281
 
236
282
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
237
 
    """Create a passwd file for a user's jail.
238
 
 
 
283
    """
239
284
    Creates /etc/passwd in the given user's jail. This will be identical to
240
285
    that in the template jail, except for the added entry for this user.
241
286
    """
249
294
    passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
250
295
                      % (username, unixid, unixid, username))
251
296
    passwd_file.close()
 
297
 
 
298
def mount_jail(login, config):
 
299
    # This is where we'll mount to...
 
300
    destdir = os.path.join(config['paths']['jails']['mounts'], login)
 
301
    # ... and this is where we'll get the user bits.
 
302
    srcdir = os.path.join(config['paths']['jails']['src'], login)
 
303
    try:
 
304
        if not os.path.exists(destdir):
 
305
            os.mkdir(destdir)
 
306
        if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
 
307
                     % (srcdir, config['paths']['jails']['template'],
 
308
                        destdir)) == 0:
 
309
            logging.info("mounted user %s's jail." % login)
 
310
        else:
 
311
            logging.error("failed to mount user %s's jail!" % login)
 
312
    except Exception, message:
 
313
        logging.warning(str(message))