1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2008 The University of Melbourne
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.
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.
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
22
# Contains common utility functions.
28
class IVLEError(Exception):
29
"""Legacy general IVLE exception.
31
This is the old "standard" exception class for IVLE errors. It is only
32
used in fileservice, and should not be used in any new code.
37
def __init__(self, httpcode, message=None):
38
self.httpcode = httpcode
39
self.message = message
40
self.args = (httpcode, message)
42
class IVLEJailError(Exception):
43
"""Exception proxying an in-jail error.
45
This exception indicates an error that occurred inside an IVLE CGI script
46
inside the jail. It should never be raised directly - only by the
49
Information will be retrieved from it, and then treated as a normal
52
def __init__(self, type_str, message, info):
53
self.type_str = type_str
54
self.message = message
57
class FakeObject(object):
58
""" A representation of an object that can't be Pickled """
59
def __init__(self, type, name, attrib={}):
65
return "<Fake %s %s>"%(self.type, self.name)
68
"""Given a path, returns a tuple consisting of the top-level directory in
69
the path, and the rest of the path. Note that both items in the tuple will
70
NOT begin with a slash, regardless of whether the original path did. Also
73
Always returns a pair of strings, except for one special case, in which
74
the path is completely empty (or just a single slash). In this case the
75
return value will be (None, ''). But still always returns a pair.
83
>>> split_path("home")
85
>>> split_path("home/docs/files")
86
('home', 'docs/files')
87
>>> split_path("//home/docs/files")
88
('', 'home/docs/files')
90
path = os.path.normpath(path)
91
# Ignore the opening slash
92
if path.startswith(os.sep):
93
path = path[len(os.sep):]
94
if path == '' or path == '.':
96
splitpath = path.split(os.sep, 1)
97
if len(splitpath) == 1:
98
return (splitpath[0], '')
100
return tuple(splitpath)
102
def relpath(path, start=os.path.curdir):
103
"""Return a relative version of a path.
104
XXX Backported from Python 2.6 posixpath.py.
108
raise ValueError("no path specified")
110
start_list = os.path.abspath(start).split(os.path.sep)
111
path_list = os.path.abspath(path).split(os.path.sep)
113
# Work out how much of the filepath is shared by start and path.
114
i = len(os.path.commonprefix([start_list, path_list]))
116
rel_list = [os.path.pardir] * (len(start_list)-i) + path_list[i:]
118
return os.path.curdir
119
return os.path.join(*rel_list)
121
def incomplete_utf8_sequence(byteseq):
122
"""Calculate the completeness of a UTF-8 encoded string.
124
Given a UTF-8-encoded byte sequence (str), returns the number of bytes at
125
the end of the string which comprise an incomplete UTF-8 character
128
If the string is empty or ends with a complete character OR INVALID
130
Otherwise, returns 1-3 indicating the number of bytes in the final
131
incomplete (but valid) character sequence.
133
Does not check any bytes before the final sequence for correctness.
135
>>> incomplete_utf8_sequence("")
137
>>> incomplete_utf8_sequence("xy")
139
>>> incomplete_utf8_sequence("xy\xc3\xbc")
141
>>> incomplete_utf8_sequence("\xc3")
143
>>> incomplete_utf8_sequence("\xbc\xc3")
145
>>> incomplete_utf8_sequence("xy\xbc\xc3")
147
>>> incomplete_utf8_sequence("xy\xe0\xa0")
149
>>> incomplete_utf8_sequence("xy\xf4")
151
>>> incomplete_utf8_sequence("xy\xf4\x8f")
153
>>> incomplete_utf8_sequence("xy\xf4\x8f\xa0")
158
for b in byteseq[::-1]:
162
# 0xxxxxxx (single-byte character)
165
elif b & 0xc0 == 0x80:
166
# 10xxxxxx (subsequent byte)
168
elif b & 0xe0 == 0xc0:
169
# 110xxxxx (start of 2-byte sequence)
172
elif b & 0xf0 == 0xe0:
173
# 1110xxxx (start of 3-byte sequence)
176
elif b & 0xf8 == 0xf0:
177
# 11110xxx (start of 4-byte sequence)
185
# Seen too many "subsequent bytes", invalid
189
# We never saw a "first byte", invalid
192
# We now know expect and count
194
# Complete, or we saw an invalid sequence
200
def object_to_dict(attrnames, obj):
201
"""Convert an object into a dictionary.
203
This takes a shallow copy of the object.
205
@param attrnames: Set (or iterable) of names of attributes to be copied
206
into the dictionary. (We don't auto-lookup, because this
207
function needs to be used on magical objects).
209
return dict((k, getattr(obj, k))
210
for k in attrnames if not k.startswith('_'))
212
def safe_rmtree(path, ignore_errors=False, onerror=None):
213
"""Recursively delete a directory tree.
215
Copied from shutil.rmtree from Python 2.6, which does not follow symbolic
216
links (it is otherwise unsafe to call as root on untrusted directories; do
217
not use shutil.rmtree in this case, as you may be running Python 2.5).
219
If ignore_errors is set, errors are ignored; otherwise, if onerror
220
is set, it is called to handle the error with arguments (func,
221
path, exc_info) where func is os.listdir, os.remove, or os.rmdir;
222
path is the argument to that function that caused it to fail; and
223
exc_info is a tuple returned by sys.exc_info(). If ignore_errors
224
is false and onerror is None, an exception is raised.
230
elif onerror is None:
234
if os.path.islink(path):
235
# symlinks to directories are forbidden, see bug #1669
236
raise OSError("Cannot call safe_rmtree on a symbolic link")
238
onerror(os.path.islink, path, sys.exc_info())
239
# can't continue even if onerror hook returns
243
names = os.listdir(path)
244
except os.error, err:
245
onerror(os.listdir, path, sys.exc_info())
247
fullname = os.path.join(path, name)
249
mode = os.lstat(fullname).st_mode
252
if stat.S_ISDIR(mode):
253
safe_rmtree(fullname, ignore_errors, onerror)
257
except os.error, err:
258
onerror(os.remove, fullname, sys.exc_info())
262
onerror(os.rmdir, path, sys.exc_info())
264
def format_submission_principal(user, principal):
265
"""Render a list of users to fit in the offering project listing.
267
Given a user and a list of submitters, returns 'solo' if the
268
only submitter is the user, or a string of the form
269
'with A, B and C' if there are any other submitters.
271
If submitters is None, we assume that the list of members could
272
not be determined, so we just return 'group'.
274
if principal is None:
277
if principal is user:
280
display_names = sorted(
281
member.display_name for member in principal.members
282
if member is not user)
284
if len(display_names) == 0:
285
return 'solo (%s)' % principal.name
286
elif len(display_names) == 1:
287
return 'with %s (%s)' % (display_names[0], principal.name)
288
elif len(display_names) > 5:
289
return 'with %d others (%s)' % (len(display_names), principal.name)
291
return 'with %s and %s (%s)' % (', '.join(display_names[:-1]),
292
display_names[-1], principal.name)
added
removed
ivle/util.py
