22
22
# Contains common utility functions.
26
class IVLEError(Exception):
27
"""Legacy general IVLE exception.
29
This is the old "standard" exception class for IVLE errors. It is only
30
used in fileservice, and should not be used in any new code.
32
def __init__(self, httpcode, message=None):
33
self.httpcode = httpcode
34
self.message = message
35
self.args = (httpcode, message)
28
37
class IVLEJailError(Exception):
29
38
"""Exception proxying an in-jail error.
86
95
return tuple(splitpath)
88
def relpath(path, start=os.path.curdir):
89
"""Return a relative version of a path.
90
XXX Backported from Python 2.6 posixpath.py.
94
raise ValueError("no path specified")
96
start_list = os.path.abspath(start).split(os.path.sep)
97
path_list = os.path.abspath(path).split(os.path.sep)
99
# Work out how much of the filepath is shared by start and path.
100
i = len(os.path.commonprefix([start_list, path_list]))
102
rel_list = [os.path.pardir] * (len(start_list)-i) + path_list[i:]
104
return os.path.curdir
105
return os.path.join(*rel_list)
107
97
def incomplete_utf8_sequence(byteseq):
108
98
"""Calculate the completeness of a UTF-8 encoded string.
186
def safe_rmtree(path, ignore_errors=False, onerror=None):
187
"""Recursively delete a directory tree.
189
Copied from shutil.rmtree from Python 2.6, which does not follow symbolic
190
links (it is otherwise unsafe to call as root on untrusted directories; do
191
not use shutil.rmtree in this case, as you may be running Python 2.5).
193
If ignore_errors is set, errors are ignored; otherwise, if onerror
194
is set, it is called to handle the error with arguments (func,
195
path, exc_info) where func is os.listdir, os.remove, or os.rmdir;
196
path is the argument to that function that caused it to fail; and
197
exc_info is a tuple returned by sys.exc_info(). If ignore_errors
198
is false and onerror is None, an exception is raised.
204
elif onerror is None:
208
if os.path.islink(path):
209
# symlinks to directories are forbidden, see bug #1669
210
raise OSError("Cannot call safe_rmtree on a symbolic link")
212
onerror(os.path.islink, path, sys.exc_info())
213
# can't continue even if onerror hook returns
217
names = os.listdir(path)
218
except os.error, err:
219
onerror(os.listdir, path, sys.exc_info())
221
fullname = os.path.join(path, name)
223
mode = os.lstat(fullname).st_mode
226
if stat.S_ISDIR(mode):
227
safe_rmtree(fullname, ignore_errors, onerror)
231
except os.error, err:
232
onerror(os.remove, fullname, sys.exc_info())
236
onerror(os.rmdir, path, sys.exc_info())
238
def format_submission_principal(user, principal):
239
"""Render a list of users to fit in the offering project listing.
241
Given a user and a list of submitters, returns 'solo' if the
242
only submitter is the user, or a string of the form
243
'with A, B and C' if there are any other submitters.
245
If submitters is None, we assume that the list of members could
246
not be determined, so we just return 'group'.
248
if principal is None:
251
if principal is user:
254
display_names = sorted(
255
member.display_name for member in principal.members
256
if member is not user)
258
if len(display_names) == 0:
259
return 'solo (%s)' % principal.name
260
elif len(display_names) == 1:
261
return 'with %s (%s)' % (display_names[0], principal.name)
262
elif len(display_names) > 5:
263
return 'with %d others (%s)' % (len(display_names), principal.name)
265
return 'with %s and %s (%s)' % (', '.join(display_names[:-1]),
266
display_names[-1], principal.name)
176
def object_to_dict(attrnames, obj):
177
"""Convert an object into a dictionary.
179
This takes a shallow copy of the object.
181
@param attrnames: Set (or iterable) of names of attributes to be copied
182
into the dictionary. (We don't auto-lookup, because this
183
function needs to be used on magical objects).
185
return dict((k, getattr(obj, k))
186
for k in attrnames if not k.startswith('_'))
added
removed
ivle/util.py
