← 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-02-25 03:04:08 UTC
  • mto: This revision was merged to the branch mainline in revision 1119.
  • Revision ID: matt.giuca@gmail.com-20090225030408-5e13v4felqc4aybr
(almost) all HTML pages updated: Moved <h1>s outside of the ivle-padding div.
    Added new <h1>s to pages which didn't have any, and reduced <h1s> down to
    <h2s> if they didn't represent the page heading.

h1s now represent the top-level heading of a page. The new style sheet styles
them specially, designed to appear directly underneath the tab bar. Therefore,
they need to appear outside of any padding.

util.py: Removed the <h1> from the default-generated terms of service page.
    (All other TOS pages should follow). There is now a <h1> at the top of the
    TOS template page instead.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/makeuser.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2008 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
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
 
39
import os
 
40
import stat
 
41
import shutil
 
42
import time
 
43
import uuid
 
44
import warnings
 
45
import filecmp
 
46
import logging
 
47
import ivle.conf
 
48
import ivle.pulldown_subj
 
49
 
 
50
from ivle.database import ProjectGroup
 
51
 
 
52
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).
 
56
    Assumes root.
 
57
    """
 
58
    try:
 
59
        os.system("chown -R www-data:www-data %s" % filename)
 
60
    except:
 
61
        pass
 
62
 
 
63
def make_svn_repo(path, throw_on_error=True):
 
64
    """Create a Subversion repository at the given path.
 
65
    """
 
66
    try:
 
67
        res = os.system("svnadmin create '%s'" % path)
 
68
        if res != 0 and throw_on_error:
 
69
            raise Exception("Cannot create repository: %s" % path)
 
70
    except Exception, exc:
 
71
        print repr(exc)
 
72
        if throw_on_error:
 
73
            raise
 
74
 
 
75
    chown_to_webserver(path)
 
76
 
 
77
def rebuild_svn_config(store):
 
78
    """Build the complete SVN configuration file.
 
79
    """
 
80
    users = store.find(ivle.database.User)
 
81
    groups = {}
 
82
    # TODO: Populate groups with per-offering tutors/lecturers/etc.
 
83
    f = open(ivle.conf.svn_conf + ".new", "w")
 
84
    f.write("# IVLE SVN Repositories Configuration\n")
 
85
    f.write("# Auto-generated on %s\n" % time.asctime())
 
86
    f.write("\n")
 
87
    f.write("[groups]\n")
 
88
    for (g,ls) in groups.iteritems():
 
89
        f.write("%s = %s\n" % (g, ",".join(ls)))
 
90
    f.write("\n")
 
91
    for u in users:
 
92
        f.write("[%s:/]\n" % u.login)
 
93
        f.write("%s = rw\n" % u.login)
 
94
        #f.write("@tutor = r\n")
 
95
        #f.write("@lecturer = rw\n")
 
96
        #f.write("@admin = rw\n")
 
97
        f.write("\n")
 
98
    f.close()
 
99
    os.rename(ivle.conf.svn_conf + ".new", ivle.conf.svn_conf)
 
100
    chown_to_webserver(ivle.conf.svn_conf)
 
101
 
 
102
def rebuild_svn_group_config(store):
 
103
    """Build the complete SVN configuration file for groups
 
104
    """
 
105
    f = open(ivle.conf.svn_group_conf + ".new", "w")
 
106
    f.write("# IVLE SVN Group Repositories Configuration\n")
 
107
    f.write("# Auto-generated on %s\n" % time.asctime())
 
108
    f.write("\n")
 
109
    for group in store.find(ProjectGroup):
 
110
        offering = group.project_set.offering
 
111
        reponame = "_".join([offering.subject.short_name,
 
112
                             offering.semester.year,
 
113
                             offering.semester.semester,
 
114
                             group.name])
 
115
        f.write("[%s:/]\n"%reponame)
 
116
        for user in group.members:
 
117
            f.write("%s = rw\n" % user.login)
 
118
        f.write("\n")
 
119
    f.close()
 
120
    os.rename(ivle.conf.svn_group_conf + ".new", ivle.conf.svn_group_conf)
 
121
    chown_to_webserver(ivle.conf.svn_group_conf)
 
122
 
 
123
def make_svn_auth(store, login, throw_on_error=True):
 
124
    """Setup svn authentication for the given user.
 
125
       Uses the given DB store object. Does not commit to the db.
 
126
    """
 
127
    passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
 
128
    if os.path.exists(ivle.conf.svn_auth_ivle):
 
129
        create = ""
 
130
    else:
 
131
        create = "c"
 
132
 
 
133
    user = ivle.database.User.get_by_login(store, login)
 
134
    user.svn_pass = unicode(passwd)
 
135
 
 
136
    res = os.system("htpasswd -%smb %s %s %s" % (create,
 
137
                                              ivle.conf.svn_auth_ivle,
 
138
                                              login, passwd))
 
139
    if res != 0 and throw_on_error:
 
140
        raise Exception("Unable to create ivle-auth for %s" % login)
 
141
 
 
142
    # Make sure the file is owned by the web server
 
143
    if create == "c":
 
144
        chown_to_webserver(ivle.conf.svn_auth_ivle)
 
145
 
 
146
    return passwd
 
147
 
 
148
def generate_manifest(basedir, targetdir, parent=''):
 
149
    """ From a basedir and a targetdir work out which files are missing or out 
 
150
    of date and need to be added/updated and which files are redundant and need 
 
151
    to be removed.
 
152
    
 
153
    parent: This is used for the recursive call to track the relative paths 
 
154
    that we have decended.
 
155
    """
 
156
    
 
157
    cmp = filecmp.dircmp(basedir, targetdir)
 
158
 
 
159
    # Add all new files and files that have changed
 
160
    to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
 
161
 
 
162
    # Remove files that are redundant
 
163
    to_remove = [os.path.join(parent,x) for x in cmp.right_only]
 
164
    
 
165
    # Recurse
 
166
    for d in cmp.common_dirs:
 
167
        newbasedir = os.path.join(basedir, d)
 
168
        newtargetdir = os.path.join(targetdir, d)
 
169
        newparent = os.path.join(parent, d)
 
170
        (sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
 
171
        to_add += sadd
 
172
        to_remove += sremove
 
173
 
 
174
    return (to_add, to_remove)
 
175
 
 
176
 
 
177
def make_jail(user, force=True):
 
178
    """Creates a new user's jail space, in the jail directory as configured in
 
179
    conf.py.
 
180
 
 
181
    This only creates things within /home - everything else is expected to be
 
182
    part of another UnionFS branch.
 
183
 
 
184
    Returns the path to the user's home directory.
 
185
 
 
186
    Chowns the user's directory within the jail to the given UID.
 
187
 
 
188
    force: If false, exception if jail already exists for this user.
 
189
    If true (default), overwrites it, but preserves home directory.
 
190
    """
 
191
    # MUST run as root or some of this may fail
 
192
    if os.getuid() != 0:
 
193
        raise Exception("Must run make_jail as root")
 
194
    
 
195
    # tempdir is for putting backup homes in
 
196
    tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
 
197
    if not os.path.exists(tempdir):
 
198
        os.makedirs(tempdir)
 
199
    elif not os.path.isdir(tempdir):
 
200
        os.unlink(tempdir)
 
201
        os.mkdir(tempdir)
 
202
    userdir = os.path.join(ivle.conf.jail_src_base, user.login)
 
203
    homedir = os.path.join(userdir, 'home')
 
204
    userhomedir = os.path.join(homedir, user.login)   # Return value
 
205
 
 
206
    if os.path.exists(userdir):
 
207
        if not force:
 
208
            raise Exception("User's jail already exists")
 
209
        # User jail already exists. Blow it away but preserve their home
 
210
        # directory. It should be all that is there anyway, but you never
 
211
        # know!
 
212
        # Ignore warnings about the use of tmpnam
 
213
        warnings.simplefilter('ignore')
 
214
        homebackup = os.tempnam(tempdir)
 
215
        warnings.resetwarnings()
 
216
        # Note: shutil.move does not behave like "mv" - it does not put a file
 
217
        # into a directory if it already exists, just fails. Therefore it is
 
218
        # not susceptible to tmpnam symlink attack.
 
219
        shutil.move(homedir, homebackup)
 
220
        shutil.rmtree(userdir)
 
221
        os.makedirs(homedir)
 
222
        shutil.move(homebackup, homedir)
 
223
        # Change the ownership of all the files to the right unixid
 
224
        logging.debug("chown %s's home directory files to uid %d"
 
225
            %(user.login, user.unixid))
 
226
        os.chown(userhomedir, user.unixid, user.unixid)
 
227
        for root, dirs, files in os.walk(userhomedir):
 
228
            for fsobj in dirs + files:
 
229
                os.chown(os.path.join(root, fsobj), user.unixid, user.unixid)
 
230
    else:
 
231
        # No user jail exists
 
232
        # Set up the user's home directory
 
233
        os.makedirs(userhomedir)
 
234
        # Chown (and set the GID to the same as the UID).
 
235
        os.chown(userhomedir, user.unixid, user.unixid)
 
236
        # Chmod to rwxr-xr-x (755)
 
237
        os.chmod(userhomedir, 0755)
 
238
 
 
239
    make_conf_py(user.login, userdir, user.svn_pass)
 
240
    make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
 
241
 
 
242
    return userhomedir
 
243
 
 
244
def make_conf_py(username, user_jail_dir, svn_pass):
 
245
    """
 
246
    Creates (overwriting any existing file, and creating directories) a
 
247
    file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
 
248
    username: Username.
 
249
    user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
 
250
    svn_pass: User's SVN password.
 
251
    """
 
252
    conf_path = os.path.join(user_jail_dir,
 
253
            ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
 
254
    os.makedirs(os.path.dirname(conf_path))
 
255
 
 
256
    # In the "in-jail" version of conf, we don't need MOST of the details
 
257
    # (it would be a security risk to have them here).
 
258
    # So we just write root_dir, and jail_base is "/".
 
259
    # (jail_base being "/" means "jail-relative" paths are relative to "/"
 
260
    # when inside the jail.)
 
261
 
 
262
    # XXX: jail_base is wrong and shouldn't be here. Unfortunately, jail code
 
263
    #      uses ivle.studpath.url_to_{local,jailpaths}, both of which use
 
264
    #      jail_base. Note that they don't use the bits of the return value
 
265
    #      that depend on jail_base, so it can be any string.
 
266
    conf_file = open(conf_path, "w")
 
267
    conf_file.write("""# IVLE jail configuration
 
268
 
 
269
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
 
270
# with this).
 
271
# eg. "/" or "/ivle".
 
272
root_dir = %(root_dir)r
 
273
 
 
274
# This value is not relevant inside the jail, but must remain for now. See
 
275
# the XXX in ivle.makeuser.make_conf_py.
 
276
jail_base = '/'
 
277
 
 
278
# The hostname for serving publicly accessible pages
 
279
public_host = %(public_host)r
 
280
 
 
281
# The URL under which the Subversion repositories are located.
 
282
svn_addr = %(svn_addr)r
 
283
 
 
284
# The login name for the owner of the jail
 
285
login = %(username)r
 
286
 
 
287
# The subversion-only password for the owner of the jail
 
288
svn_pass = %(svn_pass)r
 
289
""" % {'root_dir': ivle.conf.root_dir,
 
290
       'public_host': ivle.conf.public_host,
 
291
       'svn_addr': ivle.conf.svn_addr,
 
292
       'username': username,
 
293
       'svn_pass': svn_pass,
 
294
      })
 
295
    conf_file.close()
 
296
 
 
297
    # Make this file world-readable
 
298
    # (chmod 644 conf_path)
 
299
    os.chmod(conf_path, stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP
 
300
                        | stat.S_IROTH)
 
301
 
 
302
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
 
303
    """
 
304
    Creates /etc/passwd in the given user's jail. This will be identical to
 
305
    that in the template jail, except for the added entry for this user.
 
306
    """
 
307
    template_passwd_path = os.path.join(template_dir, "etc/passwd")
 
308
    passwd_path = os.path.join(user_jail_dir, "etc/passwd")
 
309
    passwd_dir = os.path.dirname(passwd_path)
 
310
    if not os.path.exists(passwd_dir):
 
311
        os.makedirs(passwd_dir)
 
312
    shutil.copy(template_passwd_path, passwd_path)
 
313
    passwd_file = open(passwd_path, 'a')
 
314
    passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
 
315
                      % (username, unixid, unixid, username))
 
316
    passwd_file.close()
 
317
 
 
318
def mount_jail(login):
 
319
    # This is where we'll mount to...
 
320
    destdir = os.path.join(ivle.conf.jail_base, login)
 
321
    # ... and this is where we'll get the user bits.
 
322
    srcdir = os.path.join(ivle.conf.jail_src_base, login)
 
323
    try:
 
324
        if not os.path.exists(destdir):
 
325
            os.mkdir(destdir)
 
326
        if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
 
327
                     % (srcdir, ivle.conf.jail_system, destdir)) == 0:
 
328
            logging.info("mounted user %s's jail." % login)
 
329
        else:
 
330
            logging.error("failed to mount user %s's jail!" % login)
 
331
    except Exception, message:
 
332
        logging.warning(str(message))