← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/makeuser.py

  • Committer: wagrant
  • Date: 2008-12-23 05:23:56 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1066
Fix the console to use codeop.CommandCompiler, which remembers activated
feature flags. This lets __future__ imports work in the console.

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 hashlib
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, config):
78
 
    """Build the complete SVN configuration file.
79
 
    @param config: An ivle.config.Config object.
80
 
    """
81
 
    users = store.find(ivle.database.User)
82
 
    groups = {}
83
 
    # TODO: Populate groups with per-offering tutors/lecturers/etc.
84
 
    conf_name = config['paths']['svn']['conf']
85
 
    temp_name = conf_name + ".new"
86
 
    f = open(temp_name, "w")
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")
94
 
    for u in users:
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")
101
 
    f.close()
102
 
    os.rename(temp_name, conf_name)
103
 
    chown_to_webserver(conf_name)
104
 
 
105
 
def rebuild_svn_group_config(store, config):
106
 
    """Build the complete SVN configuration file for groups
107
 
    @param config: An ivle.config.Config object.
108
 
    """
109
 
    conf_name = config['paths']['svn']['group_conf']
110
 
    temp_name = conf_name + ".new"
111
 
    f = open(temp_name, "w")
112
 
    f.write("# IVLE SVN Group Repositories Configuration\n")
113
 
    f.write("# Auto-generated on %s\n" % time.asctime())
114
 
    f.write("\n")
115
 
    for group in store.find(ProjectGroup):
116
 
        offering = group.project_set.offering
117
 
        reponame = "_".join([offering.subject.short_name,
118
 
                             offering.semester.year,
119
 
                             offering.semester.semester,
120
 
                             group.name])
121
 
        f.write("[%s:/]\n"%reponame)
122
 
        for user in group.members:
123
 
            f.write("%s = rw\n" % user.login)
124
 
        f.write("\n")
125
 
    f.close()
126
 
    os.rename(temp_name, conf_name)
127
 
    chown_to_webserver(conf_name)
128
 
 
129
 
def make_svn_auth(store, login, config, throw_on_error=True):
130
 
    """Setup svn authentication for the given user.
131
 
       Uses the given DB store object. Does not commit to the db.
132
 
    """
133
 
    # filename is, eg, /var/lib/ivle/svn/ivle.auth
134
 
    filename = config['paths']['svn']['auth_ivle']
135
 
    passwd = hashlib.md5(uuid.uuid4().bytes).hexdigest()
136
 
    if os.path.exists(filename):
137
 
        create = ""
138
 
    else:
139
 
        create = "c"
140
 
 
141
 
    user = ivle.database.User.get_by_login(store, login)
142
 
    user.svn_pass = unicode(passwd)
143
 
 
144
 
    res = os.system("htpasswd -%smb %s %s %s" % (create, filename,
145
 
                                              login, passwd))
146
 
    if res != 0 and throw_on_error:
147
 
        raise Exception("Unable to create ivle-auth for %s" % login)
148
 
 
149
 
    # Make sure the file is owned by the web server
150
 
    if create == "c":
151
 
        chown_to_webserver(filename)
152
 
 
153
 
    return passwd
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
 
 
184
 
def make_jail(user, config, force=True):
185
 
    """Creates a new user's jail space, in the jail directory as configured in
186
 
    conf.py.
187
 
 
188
 
    This only creates things within /home - everything else is expected to be
189
 
    part of another UnionFS branch.
190
 
 
191
 
    Returns the path to the user's home directory.
192
 
 
193
 
    Chowns the user's directory within the jail to the given UID.
194
 
 
195
 
    force: If false, exception if jail already exists for this user.
196
 
    If true (default), overwrites it, but preserves home directory.
197
 
    """
198
 
    # MUST run as root or some of this may fail
199
 
    if os.getuid() != 0:
200
 
        raise Exception("Must run make_jail as root")
201
 
    
202
 
    # tempdir is for putting backup homes in
203
 
    jail_src_base = config['paths']['jails']['src']
204
 
    tempdir = os.path.join(jail_src_base, '__temp__')
205
 
    if not os.path.exists(tempdir):
206
 
        os.makedirs(tempdir)
207
 
    elif not os.path.isdir(tempdir):
208
 
        os.unlink(tempdir)
209
 
        os.mkdir(tempdir)
210
 
    userdir = os.path.join(jail_src_base, user.login)
211
 
    homedir = os.path.join(userdir, 'home')
212
 
    userhomedir = os.path.join(homedir, user.login)   # Return value
213
 
 
214
 
    if os.path.exists(userdir):
215
 
        if not force:
216
 
            raise Exception("User's jail already exists")
217
 
        # User jail already exists. Blow it away but preserve their home
218
 
        # directory. It should be all that is there anyway, but you never
219
 
        # know!
220
 
        # Ignore warnings about the use of tmpnam
221
 
        warnings.simplefilter('ignore')
222
 
        homebackup = os.tempnam(tempdir)
223
 
        warnings.resetwarnings()
224
 
        # Back up the /home directory, delete the entire jail, recreate the
225
 
        # jail directory tree, then copy the /home back
226
 
        # NOTE that shutil.move changed in Python 2.6, it now moves a
227
 
        # directory INTO the target (like `mv`), which it didn't use to do.
228
 
        # This code works regardless.
229
 
        shutil.move(homedir, homebackup)
230
 
        shutil.rmtree(userdir)
231
 
        os.makedirs(userdir)
232
 
        shutil.move(homebackup, homedir)
233
 
        # Change the ownership of all the files to the right unixid
234
 
        logging.debug("chown %s's home directory files to uid %d"
235
 
            %(user.login, user.unixid))
236
 
        os.spawnvp(os.P_WAIT, 'chown', ['chown', '-R', '%d:%d' % (user.unixid,
237
 
                                        user.unixid), userhomedir])
238
 
    else:
239
 
        # No user jail exists
240
 
        # Set up the user's home directory
241
 
        os.makedirs(userhomedir)
242
 
        # Chown (and set the GID to the same as the UID).
243
 
        os.chown(userhomedir, user.unixid, user.unixid)
244
 
        # Chmod to rwxr-xr-x (755)
245
 
        os.chmod(userhomedir, 0755)
246
 
 
247
 
    make_ivle_conf(user.login, userdir, user.svn_pass, config)
248
 
    make_etc_passwd(user.login, userdir, config['paths']['jails']['template'],
249
 
                    user.unixid)
250
 
 
251
 
    return userhomedir
252
 
 
253
 
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
254
 
    """
255
 
    Creates (overwriting any existing file, and creating directories) a
256
 
    file /etc/ivle/ivle.conf in a given user's jail.
257
 
    @param username: Username.
258
 
    @param user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
259
 
    @param svn_pass: User's SVN password.
260
 
    @param sys_config: An ivle.config.Config object (the system-wide config).
261
 
    """
262
 
    conf_path = os.path.join(user_jail_dir, "etc/ivle/ivle.conf")
263
 
    os.makedirs(os.path.dirname(conf_path))
264
 
 
265
 
    # In the "in-jail" version of conf, we don't need MOST of the details
266
 
    # (it would be a security risk to have them here).
267
 
    # So we just write root_dir.
268
 
    conf_obj = ivle.config.Config(blank=True)
269
 
    conf_obj.filename = conf_path
270
 
    conf_obj['urls']['root'] = sys_config['urls']['root']
271
 
    conf_obj['urls']['public_host'] = sys_config['urls']['public_host']
272
 
    conf_obj['urls']['svn_addr'] = sys_config['urls']['svn_addr']
273
 
    conf_obj['user_info']['login'] = username
274
 
    conf_obj['user_info']['svn_pass'] = svn_pass
275
 
    conf_obj.write()
276
 
 
277
 
    # Make this file world-readable
278
 
    # (chmod 644 conf_path)
279
 
    os.chmod(conf_path, stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP
280
 
                        | stat.S_IROTH)
281
 
 
282
 
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
283
 
    """
284
 
    Creates /etc/passwd in the given user's jail. This will be identical to
285
 
    that in the template jail, except for the added entry for this user.
286
 
    """
287
 
    template_passwd_path = os.path.join(template_dir, "etc/passwd")
288
 
    passwd_path = os.path.join(user_jail_dir, "etc/passwd")
289
 
    passwd_dir = os.path.dirname(passwd_path)
290
 
    if not os.path.exists(passwd_dir):
291
 
        os.makedirs(passwd_dir)
292
 
    shutil.copy(template_passwd_path, passwd_path)
293
 
    passwd_file = open(passwd_path, 'a')
294
 
    passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
295
 
                      % (username, unixid, unixid, username))
296
 
    passwd_file.close()
297
 
 
298
 
def mount_jail(login):
299
 
    # This is where we'll mount to...
300
 
    destdir = os.path.join(ivle.conf.jail_base, login)
301
 
    # ... and this is where we'll get the user bits.
302
 
    srcdir = os.path.join(ivle.conf.jail_src_base, 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, ivle.conf.jail_system, 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))