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
18
"""User and group filesystem management helpers."""
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).
30
from storm.expr import Select, Max
33
from ivle.database import (User, ProjectGroup, Assessed, ProjectSubmission,
34
Project, ProjectSet, Offering, Enrolment, Subject, Semester)
49
import ivle.pulldown_subj
51
from ivle.database import ProjectGroup
36
53
def chown_to_webserver(filename):
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.
55
Chowns a file so the web server user owns it.
56
(This is useful in setting up Subversion conf files).
42
subprocess.call(['chown', '-R', 'www-data:www-data', filename])
60
os.system("chown -R www-data:www-data %s" % filename)
44
64
def make_svn_repo(path, throw_on_error=True):
45
"""Create a Subversion repository at the given path."""
65
"""Create a Subversion repository at the given path.
47
res = subprocess.call(['svnadmin', 'create', path])
68
res = os.system("svnadmin create '%s'" % path)
48
69
if res != 0 and throw_on_error:
49
70
raise Exception("Cannot create repository: %s" % path)
50
71
except Exception, exc:
55
76
chown_to_webserver(path)
57
def rebuild_svn_config(store, config):
78
def rebuild_svn_config(store):
58
79
"""Build the complete SVN configuration file.
60
@param config: An ivle.config.Config object.
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()})
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)
81
users = store.find(ivle.database.User)
85
if role not in groups:
87
groups[role].append(u.login)
88
f = open(ivle.conf.svn_conf + ".new", "w")
89
f.write("# IVLE SVN Repositories Configuration\n")
90
f.write("# Auto-generated on %s\n" % time.asctime())
93
for (g,ls) in groups.iteritems():
94
f.write("%s = %s\n" % (g, ",".join(ls)))
97
f.write("[%s:/]\n" % u.login)
98
f.write("%s = rw\n" % u.login)
99
#f.write("@tutor = r\n")
100
#f.write("@lecturer = rw\n")
101
#f.write("@admin = rw\n")
121
os.rename(temp_name, conf_name)
122
chown_to_webserver(conf_name)
104
os.rename(ivle.conf.svn_conf + ".new", ivle.conf.svn_conf)
105
chown_to_webserver(ivle.conf.svn_conf)
124
def rebuild_svn_group_config(store, config):
107
def rebuild_svn_group_config(store):
125
108
"""Build the complete SVN configuration file for groups
127
@param config: An ivle.config.Config object.
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 = {}
110
f = open(ivle.conf.svn_group_conf + ".new", "w")
111
f.write("# IVLE SVN Group Repositories Configuration\n")
112
f.write("# Auto-generated on %s\n" % time.asctime())
140
114
for group in store.find(ProjectGroup):
141
115
offering = group.project_set.offering
142
116
reponame = "_".join([offering.subject.short_name,
143
117
offering.semester.year,
144
118
offering.semester.semester,
147
f.write("[%s:/]\n" % reponame)
148
if group.id not in group_members_cache:
149
group_members_cache[group.id] = set()
120
f.write("[%s:/]\n"%reponame)
150
121
for user in group.members:
151
group_members_cache[group.id].add(user.login)
152
122
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)
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.
125
os.rename(ivle.conf.svn_group_conf + ".new", ivle.conf.svn_group_conf)
126
chown_to_webserver(ivle.conf.svn_group_conf)
128
def make_svn_auth(store, login, throw_on_error=True):
129
"""Setup svn authentication for the given user.
130
Uses the given DB store object. Does not commit to the db.
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):
132
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
133
if os.path.exists(ivle.conf.svn_auth_ivle):
220
user = User.get_by_login(store, login)
138
user = ivle.database.User.get_by_login(store, login)
221
139
user.svn_pass = unicode(passwd)
223
res = subprocess.call(['htpasswd', '-%smb' % create,
224
filename, login, passwd])
141
res = os.system("htpasswd -%smb %s %s %s" % (create,
142
ivle.conf.svn_auth_ivle,
225
144
if res != 0 and throw_on_error:
226
145
raise Exception("Unable to create ivle-auth for %s" % login)
228
147
# Make sure the file is owned by the web server
229
148
if create == "c":
230
chown_to_webserver(filename)
149
chown_to_webserver(ivle.conf.svn_auth_ivle)
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.
153
def generate_manifest(basedir, targetdir, parent=''):
154
""" From a basedir and a targetdir work out which files are missing or out
155
of date and need to be added/updated and which files are redundant and need
158
parent: This is used for the recursive call to track the relative paths
159
that we have decended.
162
cmp = filecmp.dircmp(basedir, targetdir)
164
# Add all new files and files that have changed
165
to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
167
# Remove files that are redundant
168
to_remove = [os.path.join(parent,x) for x in cmp.right_only]
171
for d in cmp.common_dirs:
172
newbasedir = os.path.join(basedir, d)
173
newtargetdir = os.path.join(targetdir, d)
174
newparent = os.path.join(parent, d)
175
(sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
179
return (to_add, to_remove)
182
def make_jail(user, force=True):
183
"""Creates a new user's jail space, in the jail directory as configured in
186
This only creates things within /home - everything else is expected to be
187
part of another UnionFS branch.
240
189
Returns the path to the user's home directory.
242
191
Chowns the user's directory within the jail to the given UID.
244
@param force: If False, raise an exception if the user already has a jail.
245
If True (default), rebuild the jail preserving /home.
193
force: If false, exception if jail already exists for this user.
194
If true (default), overwrites it, but preserves home directory.
247
196
# MUST run as root or some of this may fail
248
197
if os.getuid() != 0:
249
198
raise Exception("Must run make_jail as root")
251
200
# tempdir is for putting backup homes in
252
jail_src_base = config['paths']['jails']['src']
253
tempdir = os.path.join(jail_src_base, '__temp__')
201
tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
254
202
if not os.path.exists(tempdir):
255
203
os.makedirs(tempdir)
256
204
elif not os.path.isdir(tempdir):
257
205
os.unlink(tempdir)
258
206
os.mkdir(tempdir)
259
userdir = os.path.join(jail_src_base, user.login)
207
userdir = os.path.join(ivle.conf.jail_src_base, user.login)
260
208
homedir = os.path.join(userdir, 'home')
261
tmpdir = os.path.join(userdir, 'tmp')
262
209
userhomedir = os.path.join(homedir, user.login) # Return value
264
211
if os.path.exists(userdir):
294
241
# Chmod to rwxr-xr-x (755)
295
242
os.chmod(userhomedir, 0755)
297
make_ivle_conf(user.login, userdir, user.svn_pass, config)
298
make_etc_passwd(user.login, userdir, config['paths']['jails']['template'],
301
os.chmod(tmpdir, 01777)
244
make_conf_py(user.login, userdir, ivle.conf.jail_system, user.svn_pass)
245
make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
303
247
return userhomedir
305
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
306
"""Generate an ivle.conf for a user's jail.
249
def make_conf_py(username, user_jail_dir, staging_dir, svn_pass):
308
251
Creates (overwriting any existing file, and creating directories) a
309
file /etc/ivle/ivle.conf in a given user's jail.
311
@param username: Username.
312
@param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
313
@param svn_pass: User's SVN password.
314
@param sys_config: An ivle.config.Config object (the system-wide config).
252
file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
254
user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
255
staging_dir: The dir with the staging copy of the jail. (With the
256
template conf.py file).
257
svn_pass: As with make_jail. User's SVN password, but if not supplied,
258
will look up in the DB.
316
conf_path = os.path.join(user_jail_dir, "home/.ivle.conf")
317
if not os.path.exists(os.path.dirname(conf_path)):
318
os.makedirs(os.path.dirname(conf_path))
320
# In the "in-jail" version of conf, we don't need MOST of the details
321
# (it would be a security risk to have them here).
322
# So we just write root_dir.
323
conf_obj = ivle.config.Config(blank=True)
324
conf_obj.filename = conf_path
325
conf_obj['urls']['root'] = sys_config['urls']['root']
326
conf_obj['urls']['public_host'] = sys_config['urls']['public_host']
327
conf_obj['urls']['svn_addr'] = sys_config['urls']['svn_addr']
328
conf_obj['user_info']['login'] = username
329
conf_obj['user_info']['svn_pass'] = svn_pass
260
template_conf_path = os.path.join(staging_dir,
261
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
262
conf_path = os.path.join(user_jail_dir,
263
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
264
os.makedirs(os.path.dirname(conf_path))
266
# Read the contents of the template conf file
268
template_conf_file = open(template_conf_path, "r")
269
template_conf_data = template_conf_file.read()
270
template_conf_file.close()
272
# Couldn't open template conf.py for some reason
273
# Just treat it as empty file
274
template_conf_data = ("# Warning: Problem building config script.\n"
275
"# Could not find template conf.py file.\n")
277
conf_file = open(conf_path, "w")
278
conf_file.write(template_conf_data)
279
conf_file.write("\n# The login name for the owner of the jail\n")
280
conf_file.write("login = %s\n" % repr(username))
281
conf_file.write("\n")
282
conf_file.write("# The subversion-only password for the owner of "
284
conf_file.write("svn_pass = %s\n" % repr(svn_pass))
332
287
# Make this file world-readable
333
288
# (chmod 644 conf_path)
added
removed
ivle/makeuser.py
