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
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
29
# TODO: Sanitize login name and other fields.
30
# Users must not be called "temp" or "template".
32
# TODO: When creating a new home directory, chown it to its owner
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."""
48
import ivle.pulldown_subj
50
from ivle.database import ProjectGroup
30
from storm.expr import Select, Max
33
from ivle.database import (User, ProjectGroup, Assessed, ProjectSubmission,
34
Project, ProjectSet, Offering, Enrolment, Subject, Semester)
52
36
def chown_to_webserver(filename):
54
Chowns a file so the web server user owns it.
55
(This is useful in setting up Subversion conf files).
37
"""chown a directory and its contents to the web server.
39
Recursively chowns a file or directory so the web server user owns it.
59
os.system("chown -R www-data:www-data %s" % filename)
42
subprocess.call(['chown', '-R', 'www-data:www-data', filename])
63
44
def make_svn_repo(path, throw_on_error=True):
64
"""Create a Subversion repository at the given path.
45
"""Create a Subversion repository at the given path."""
67
res = os.system("svnadmin create '%s'" % path)
47
res = subprocess.call(['svnadmin', 'create', path])
68
48
if res != 0 and throw_on_error:
69
49
raise Exception("Cannot create repository: %s" % path)
70
50
except Exception, exc:
75
55
chown_to_webserver(path)
77
def rebuild_svn_config(store):
57
def rebuild_svn_config(store, config):
78
58
"""Build the complete SVN configuration file.
60
@param config: An ivle.config.Config object.
80
users = store.find(ivle.database.User)
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())
88
for (g,ls) in groups.iteritems():
89
f.write("%s = %s\n" % (g, ",".join(ls)))
62
users = store.find(User)
63
conf_name = config['paths']['svn']['conf']
64
temp_name = conf_name + ".new"
65
f = open(temp_name, "w")
67
# IVLE SVN repository authorisation configuration
69
""" % {'time': time.asctime()})
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")
75
""" % {'login': u.login})
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,
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
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(
103
User.id == Enrolment.user_id,
104
Enrolment.offering_id == offeringid,
105
Enrolment.role.is_in((u'tutor', u'lecturer'))
112
""" % {'login': login, 'id': psid, 'path': pspath})
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)
99
os.rename(ivle.conf.svn_conf + ".new", ivle.conf.svn_conf)
100
chown_to_webserver(ivle.conf.svn_conf)
121
os.rename(temp_name, conf_name)
122
chown_to_webserver(conf_name)
102
def rebuild_svn_group_config(store):
124
def rebuild_svn_group_config(store, config):
103
125
"""Build the complete SVN configuration file for groups
127
@param config: An ivle.config.Config object.
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())
129
conf_name = config['paths']['svn']['group_conf']
130
temp_name = conf_name + ".new"
131
f = open(temp_name, "w")
134
# IVLE SVN group repository authorisation configuration
135
# Generated: %(time)s
137
""" % {'time': time.asctime()})
139
group_members_cache = {}
109
140
for group in store.find(ProjectGroup):
110
141
offering = group.project_set.offering
111
142
reponame = "_".join([offering.subject.short_name,
112
143
offering.semester.year,
113
144
offering.semester.semester,
115
f.write("[%s:/]\n"%reponame)
147
f.write("[%s:/]\n" % reponame)
148
if group.id not in group_members_cache:
149
group_members_cache[group.id] = set()
116
150
for user in group.members:
151
group_members_cache[group.id].add(user.login)
117
152
f.write("%s = rw\n" % user.login)
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
179
reponame = "_".join([ssn, year, sem, name])
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(
186
User.id == Enrolment.user_id,
187
Enrolment.offering_id == offeringid,
188
Enrolment.role.is_in((u'tutor', u'lecturer'))
195
""" % {'repo': reponame, 'id': psid, 'path': pspath})
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)
120
os.rename(ivle.conf.svn_group_conf + ".new", ivle.conf.svn_group_conf)
121
chown_to_webserver(ivle.conf.svn_group_conf)
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.
203
os.rename(temp_name, conf_name)
204
chown_to_webserver(conf_name)
206
def make_svn_auth(store, login, config, throw_on_error=True):
207
"""Create a Subversion password for a user.
209
Generates a new random Subversion password, and assigns it to the user.
210
The password is added to Apache's Subversion authentication file.
127
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
128
if os.path.exists(ivle.conf.svn_auth_ivle):
212
# filename is, eg, /var/lib/ivle/svn/ivle.auth
213
filename = config['paths']['svn']['auth_ivle']
214
passwd = hashlib.md5(uuid.uuid4().bytes).hexdigest()
215
if os.path.exists(filename):
133
user = ivle.database.User.get_by_login(store, login)
220
user = User.get_by_login(store, login)
134
221
user.svn_pass = unicode(passwd)
136
res = os.system("htpasswd -%smb %s %s %s" % (create,
137
ivle.conf.svn_auth_ivle,
223
res = subprocess.call(['htpasswd', '-%smb' % create,
224
filename, login, passwd])
139
225
if res != 0 and throw_on_error:
140
226
raise Exception("Unable to create ivle-auth for %s" % login)
142
228
# Make sure the file is owned by the web server
143
229
if create == "c":
144
chown_to_webserver(ivle.conf.svn_auth_ivle)
230
chown_to_webserver(filename)
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
153
parent: This is used for the recursive call to track the relative paths
154
that we have decended.
157
cmp = filecmp.dircmp(basedir, targetdir)
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)]
162
# Remove files that are redundant
163
to_remove = [os.path.join(parent,x) for x in cmp.right_only]
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)
174
return (to_add, to_remove)
177
def make_jail(user, force=True):
178
"""Creates a new user's jail space, in the jail directory as configured in
181
This only creates things within /home - everything else is expected to be
182
part of another UnionFS branch.
234
def make_jail(user, config, force=True):
235
"""Create or update a user's jail.
237
Only the user-specific parts of the jail are created here - everything
238
else is expected to be part of another aufs branch.
184
240
Returns the path to the user's home directory.
186
242
Chowns the user's directory within the jail to the given UID.
188
force: If false, exception if jail already exists for this user.
189
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.
191
247
# MUST run as root or some of this may fail
192
248
if os.getuid() != 0:
193
249
raise Exception("Must run make_jail as root")
195
251
# tempdir is for putting backup homes in
196
tempdir = os.path.join(ivle.conf.jail_src_base, '__temp__')
252
jail_src_base = config['paths']['jails']['src']
253
tempdir = os.path.join(jail_src_base, '__temp__')
197
254
if not os.path.exists(tempdir):
198
255
os.makedirs(tempdir)
199
256
elif not os.path.isdir(tempdir):
200
257
os.unlink(tempdir)
201
258
os.mkdir(tempdir)
202
userdir = os.path.join(ivle.conf.jail_src_base, user.login)
259
userdir = os.path.join(jail_src_base, user.login)
203
260
homedir = os.path.join(userdir, 'home')
204
261
userhomedir = os.path.join(homedir, user.login) # Return value
234
293
# Chmod to rwxr-xr-x (755)
235
294
os.chmod(userhomedir, 0755)
237
make_conf_py(user.login, userdir, user.svn_pass)
238
make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
296
make_ivle_conf(user.login, userdir, user.svn_pass, config)
297
make_etc_passwd(user.login, userdir, config['paths']['jails']['template'],
240
300
return userhomedir
242
def make_conf_py(username, user_jail_dir, svn_pass):
302
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
303
"""Generate an ivle.conf for a user's jail.
244
305
Creates (overwriting any existing file, and creating directories) a
245
file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
247
user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
248
svn_pass: User's SVN password.
306
file /etc/ivle/ivle.conf in a given user's jail.
308
@param username: Username.
309
@param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
310
@param svn_pass: User's SVN password.
311
@param sys_config: An ivle.config.Config object (the system-wide config).
250
conf_path = os.path.join(user_jail_dir,
251
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
313
conf_path = os.path.join(user_jail_dir, "etc/ivle/ivle.conf")
252
314
os.makedirs(os.path.dirname(conf_path))
254
316
# In the "in-jail" version of conf, we don't need MOST of the details
255
317
# (it would be a security risk to have them here).
256
# So we just write root_dir, and jail_base is "/".
257
# (jail_base being "/" means "jail-relative" paths are relative to "/"
258
# when inside the jail.)
260
# XXX: jail_base is wrong and shouldn't be here. Unfortunately, jail code
261
# uses ivle.studpath.url_to_{local,jailpaths}, both of which use
262
# jail_base. Note that they don't use the bits of the return value
263
# that depend on jail_base, so it can be any string.
264
conf_file = open(conf_path, "w")
265
conf_file.write("""# IVLE jail configuration
267
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
269
# eg. "/" or "/ivle".
270
root_dir = %(root_dir)r
272
# This value is not relevant inside the jail, but must remain for now. See
273
# the XXX in ivle.makeuser.make_conf_py.
276
# The hostname for serving publicly accessible pages
277
public_host = %(public_host)r
279
# The URL under which the Subversion repositories are located.
280
svn_addr = %(svn_addr)r
282
# The login name for the owner of the jail
285
# The subversion-only password for the owner of the jail
286
svn_pass = %(svn_pass)r
287
""" % {'root_dir': ivle.conf.root_dir,
288
'public_host': ivle.conf.public_host,
289
'svn_addr': ivle.conf.svn_addr,
290
'username': username,
291
'svn_pass': svn_pass,
318
# So we just write root_dir.
319
conf_obj = ivle.config.Config(blank=True)
320
conf_obj.filename = conf_path
321
conf_obj['urls']['root'] = sys_config['urls']['root']
322
conf_obj['urls']['public_host'] = sys_config['urls']['public_host']
323
conf_obj['urls']['svn_addr'] = sys_config['urls']['svn_addr']
324
conf_obj['user_info']['login'] = username
325
conf_obj['user_info']['svn_pass'] = svn_pass
295
328
# Make this file world-readable
296
329
# (chmod 644 conf_path)
added
removed
ivle/makeuser.py
