22
22
# Contains common utility functions.
28
29
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.
31
This is the "standard" exception class for IVLE errors.
32
It is the ONLY exception which should propagate to the top - it will then
33
be displayed to the user as an HTTP error with the given code.
35
All other exceptions are considered IVLE bugs and should not occur
36
(they will display a traceback).
38
This error should not be raised directly. Call req.throw_error.
37
40
def __init__(self, httpcode, message=None):
38
41
self.httpcode = httpcode
39
42
self.message = message
40
43
self.args = (httpcode, message)
42
45
class IVLEJailError(Exception):
43
"""Exception proxying an in-jail error.
45
47
This exception indicates an error that occurred inside an IVLE CGI script
46
48
inside the jail. It should never be raised directly - only by the
64
66
def __repr__(self):
65
67
return "<Fake %s %s>"%(self.type, self.name)
70
"""Given a path relative to the IVLE root, makes the path relative to the
71
site root using ivle.conf.root_dir. This path can be used in URLs sent to
73
return os.path.join(ivle.conf.root_dir, path)
75
def unmake_path(path):
76
"""Given a path relative to the site root, makes the path relative to the
77
IVLE root by removing ivle.conf.root_dir if it appears at the beginning. If
78
it does not appear at the beginning, returns path unchanged. Also
79
normalises the path."""
80
path = os.path.normpath(path)
81
root = os.path.normpath(ivle.conf.root_dir)
83
if path.startswith(root):
84
path = path[len(root):]
85
# Take out the slash as well
86
if len(path) > 0 and path[0] == os.sep:
67
91
def split_path(path):
68
92
"""Given a path, returns a tuple consisting of the top-level directory in
69
93
the path, and the rest of the path. Note that both items in the tuple will
100
124
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
126
def incomplete_utf8_sequence(byteseq):
122
"""Calculate the completeness of a UTF-8 encoded string.
124
129
Given a UTF-8-encoded byte sequence (str), returns the number of bytes at
125
130
the end of the string which comprise an incomplete UTF-8 character
200
205
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).
207
Convert an object into a dictionary. This takes a shallow copy of the
209
attrnames: Set (or iterable) of names of attributes to be copied into the
210
dictionary. (We don't auto-lookup, because this function needs to be
211
used on magical objects).
209
213
return dict((k, getattr(obj, k))
210
214
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
