← 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-04-29 05:20:14 UTC
  • Revision ID: grantw@unimelb.edu.au-20090429052014-5tzyfz97fwt5mn0k
Replace some of ivle.makeuser's os.system calls with subprocess.call.

This makes Subversion repositories with spaces work.

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
47
import subprocess
 
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
53
    """chown a directory and its contents to the web server.
53
72
 
54
73
def rebuild_svn_config(store, config):
55
74
    """Build the complete SVN configuration file.
56
 
 
57
75
    @param config: An ivle.config.Config object.
58
76
    """
59
 
    users = store.find(User)
 
77
    users = store.find(ivle.database.User)
 
78
    groups = {}
 
79
    # TODO: Populate groups with per-offering tutors/lecturers/etc.
60
80
    conf_name = config['paths']['svn']['conf']
61
81
    temp_name = conf_name + ".new"
62
82
    f = open(temp_name, "w")
63
 
    f.write("""\
64
 
# IVLE SVN repository authorisation configuration
65
 
# Generated: %(time)s
66
 
""" % {'time': time.asctime()})
67
 
 
 
83
    f.write("# IVLE SVN Repositories Configuration\n")
 
84
    f.write("# Auto-generated on %s\n" % time.asctime())
 
85
    f.write("\n")
 
86
    f.write("[groups]\n")
 
87
    for (g,ls) in groups.iteritems():
 
88
        f.write("%s = %s\n" % (g, ",".join(ls)))
 
89
    f.write("\n")
68
90
    for u in users:
69
 
        f.write("""
70
 
[%(login)s:/]
71
 
%(login)s = rw
72
 
""" % {'login': u.login})
73
 
 
 
91
        f.write("[%s:/]\n" % u.login)
 
92
        f.write("%s = rw\n" % u.login)
 
93
        #f.write("@tutor = r\n")
 
94
        #f.write("@lecturer = rw\n")
 
95
        #f.write("@admin = rw\n")
 
96
        f.write("\n")
74
97
    f.close()
75
98
    os.rename(temp_name, conf_name)
76
99
    chown_to_webserver(conf_name)
77
100
 
78
101
def rebuild_svn_group_config(store, config):
79
102
    """Build the complete SVN configuration file for groups
80
 
 
81
103
    @param config: An ivle.config.Config object.
82
104
    """
83
105
    conf_name = config['paths']['svn']['group_conf']
84
106
    temp_name = conf_name + ".new"
85
107
    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
 
 
 
108
    f.write("# IVLE SVN Group Repositories Configuration\n")
 
109
    f.write("# Auto-generated on %s\n" % time.asctime())
 
110
    f.write("\n")
93
111
    for group in store.find(ProjectGroup):
94
112
        offering = group.project_set.offering
95
113
        reponame = "_".join([offering.subject.short_name,
96
114
                             offering.semester.year,
97
115
                             offering.semester.semester,
98
116
                             group.name])
99
 
 
100
 
        f.write("[%s:/]\n" % reponame)
 
117
        f.write("[%s:/]\n"%reponame)
101
118
        for user in group.members:
102
119
            f.write("%s = rw\n" % user.login)
103
120
        f.write("\n")
104
 
 
105
121
    f.close()
106
122
    os.rename(temp_name, conf_name)
107
123
    chown_to_webserver(conf_name)
108
124
 
109
125
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.
 
126
    """Setup svn authentication for the given user.
 
127
       Uses the given DB store object. Does not commit to the db.
114
128
    """
115
129
    # filename is, eg, /var/lib/ivle/svn/ivle.auth
116
130
    filename = config['paths']['svn']['auth_ivle']
120
134
    else:
121
135
        create = "c"
122
136
 
123
 
    user = User.get_by_login(store, login)
 
137
    user = ivle.database.User.get_by_login(store, login)
124
138
    user.svn_pass = unicode(passwd)
125
139
 
126
 
    res = subprocess.call(['htpasswd', '-%smb' % create,
127
 
                           filename, login, passwd])
 
140
    res = os.system("htpasswd -%smb %s %s %s" % (create, filename,
 
141
                                              login, passwd))
128
142
    if res != 0 and throw_on_error:
129
143
        raise Exception("Unable to create ivle-auth for %s" % login)
130
144
 
134
148
 
135
149
    return passwd
136
150
 
 
151
def generate_manifest(basedir, targetdir, parent=''):
 
152
    """ From a basedir and a targetdir work out which files are missing or out 
 
153
    of date and need to be added/updated and which files are redundant and need 
 
154
    to be removed.
 
155
    
 
156
    parent: This is used for the recursive call to track the relative paths 
 
157
    that we have decended.
 
158
    """
 
159
    
 
160
    cmp = filecmp.dircmp(basedir, targetdir)
 
161
 
 
162
    # Add all new files and files that have changed
 
163
    to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
 
164
 
 
165
    # Remove files that are redundant
 
166
    to_remove = [os.path.join(parent,x) for x in cmp.right_only]
 
167
    
 
168
    # Recurse
 
169
    for d in cmp.common_dirs:
 
170
        newbasedir = os.path.join(basedir, d)
 
171
        newtargetdir = os.path.join(targetdir, d)
 
172
        newparent = os.path.join(parent, d)
 
173
        (sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
 
174
        to_add += sadd
 
175
        to_remove += sremove
 
176
 
 
177
    return (to_add, to_remove)
 
178
 
 
179
 
137
180
def make_jail(user, config, force=True):
138
 
    """Create or update a user's jail.
 
181
    """Creates a new user's jail space, in the jail directory as configured in
 
182
    conf.py.
139
183
 
140
 
    Only the user-specific parts of the jail are created here - everything
141
 
    else is expected to be part of another aufs branch.
 
184
    This only creates things within /home - everything else is expected to be
 
185
    part of another UnionFS branch.
142
186
 
143
187
    Returns the path to the user's home directory.
144
188
 
145
189
    Chowns the user's directory within the jail to the given UID.
146
190
 
147
 
    @param force: If False, raise an exception if the user already has a jail.
148
 
                  If True (default), rebuild the jail preserving /home.
 
191
    force: If false, exception if jail already exists for this user.
 
192
    If true (default), overwrites it, but preserves home directory.
149
193
    """
150
194
    # MUST run as root or some of this may fail
151
195
    if os.getuid() != 0:
203
247
    return userhomedir
204
248
 
205
249
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
206
 
    """Generate an ivle.conf for a user's jail.
207
 
 
 
250
    """
208
251
    Creates (overwriting any existing file, and creating directories) a
209
252
    file /etc/ivle/ivle.conf in a given user's jail.
210
 
 
211
253
    @param username: Username.
212
254
    @param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
213
255
    @param svn_pass: User's SVN password.
234
276
                        | stat.S_IROTH)
235
277
 
236
278
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
237
 
    """Create a passwd file for a user's jail.
238
 
 
 
279
    """
239
280
    Creates /etc/passwd in the given user's jail. This will be identical to
240
281
    that in the template jail, except for the added entry for this user.
241
282
    """
249
290
    passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
250
291
                      % (username, unixid, unixid, username))
251
292
    passwd_file.close()
 
293
 
 
294
def mount_jail(login, config):
 
295
    # This is where we'll mount to...
 
296
    destdir = os.path.join(config['paths']['jails']['mounts'], login)
 
297
    # ... and this is where we'll get the user bits.
 
298
    srcdir = os.path.join(config['paths']['jails']['src'], login)
 
299
    try:
 
300
        if not os.path.exists(destdir):
 
301
            os.mkdir(destdir)
 
302
        if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
 
303
                     % (srcdir, config['paths']['jails']['template'],
 
304
                        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))