22
22
# Contains common utility functions.
23
# Also initialises mime types library. You must import util before using
24
# Python's builtin mimetypes module to make sure local settings are applied.
31
import ivle.conf.mimetypes
28
33
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.
35
This is the "standard" exception class for IVLE errors.
36
It is the ONLY exception which should propagate to the top - it will then
37
be displayed to the user as an HTTP error with the given code.
39
All other exceptions are considered IVLE bugs and should not occur
40
(they will display a traceback).
42
This error should not be raised directly. Call req.throw_error.
34
44
def __init__(self, httpcode, message=None):
35
45
self.httpcode = httpcode
61
70
def __repr__(self):
62
71
return "<Fake %s %s>"%(self.type, self.name)
74
"""Given a path relative to the IVLE root, makes the path relative to the
75
site root using ivle.conf.root_dir. This path can be used in URLs sent to
77
return os.path.join(ivle.conf.root_dir, path)
79
def unmake_path(path):
80
"""Given a path relative to the site root, makes the path relative to the
81
IVLE root by removing ivle.conf.root_dir if it appears at the beginning. If
82
it does not appear at the beginning, returns path unchanged. Also
83
normalises the path."""
84
path = os.path.normpath(path)
85
root = os.path.normpath(ivle.conf.root_dir)
87
if path.startswith(root):
88
path = path[len(root):]
89
# Take out the slash as well
90
if len(path) > 0 and path[0] == os.sep:
64
95
def split_path(path):
65
96
"""Given a path, returns a tuple consisting of the top-level directory in
66
97
the path, and the rest of the path. Note that both items in the tuple will
97
128
return tuple(splitpath)
99
def relpath(path, start=os.path.curdir):
100
"""Return a relative version of a path.
101
XXX Backported from Python 2.6 posixpath.py.
130
# Initialise mime types library
132
for (ext, mimetype) in ivle.conf.mimetypes.additional_mime_types.items():
133
mimetypes.add_type(mimetype, ext)
135
def nice_filetype(filename):
136
"""Given a filename or basename, returns a "friendly" name for that
138
eg. nice_mimetype("file.py") == "Python source code".
139
nice_filetype("file.bzg") == "BZG file".
140
nice_filetype("directory/") == "Directory".
105
raise ValueError("no path specified")
107
start_list = os.path.abspath(start).split(os.path.sep)
108
path_list = os.path.abspath(path).split(os.path.sep)
110
# Work out how much of the filepath is shared by start and path.
111
i = len(os.path.commonprefix([start_list, path_list]))
113
rel_list = [os.path.pardir] * (len(start_list)-i) + path_list[i:]
115
return os.path.curdir
116
return os.path.join(*rel_list)
142
if filename[-1] == os.sep:
146
return ivle.conf.mimetypes.nice_mimetypes[
147
mimetypes.guess_type(filename)[0]]
149
filename = os.path.basename(filename)
151
return filename[filename.rindex('.')+1:].upper() + " file"
118
155
def incomplete_utf8_sequence(byteseq):
119
"""Calculate the completeness of a UTF-8 encoded string.
121
158
Given a UTF-8-encoded byte sequence (str), returns the number of bytes at
122
159
the end of the string which comprise an incomplete UTF-8 character
197
234
def object_to_dict(attrnames, obj):
198
"""Convert an object into a dictionary.
200
This takes a shallow copy of the object.
202
@param attrnames: Set (or iterable) of names of attributes to be copied
203
into the dictionary. (We don't auto-lookup, because this
204
function needs to be used on magical objects).
236
Convert an object into a dictionary. This takes a shallow copy of the
238
attrnames: Set (or iterable) of names of attributes to be copied into the
239
dictionary. (We don't auto-lookup, because this function needs to be
240
used on magical objects).
206
242
return dict((k, getattr(obj, k))
207
243
for k in attrnames if not k.startswith('_'))
209
def safe_rmtree(path, ignore_errors=False, onerror=None):
210
"""Recursively delete a directory tree.
212
Copied from shutil.rmtree from Python 2.6, which does not follow symbolic
213
links (it is otherwise unsafe to call as root on untrusted directories; do
214
not use shutil.rmtree in this case, as you may be running Python 2.5).
216
If ignore_errors is set, errors are ignored; otherwise, if onerror
217
is set, it is called to handle the error with arguments (func,
218
path, exc_info) where func is os.listdir, os.remove, or os.rmdir;
219
path is the argument to that function that caused it to fail; and
220
exc_info is a tuple returned by sys.exc_info(). If ignore_errors
221
is false and onerror is None, an exception is raised.
227
elif onerror is None:
231
if os.path.islink(path):
232
# symlinks to directories are forbidden, see bug #1669
233
raise OSError("Cannot call safe_rmtree on a symbolic link")
235
onerror(os.path.islink, path, sys.exc_info())
236
# can't continue even if onerror hook returns
240
names = os.listdir(path)
241
except os.error, err:
242
onerror(os.listdir, path, sys.exc_info())
244
fullname = os.path.join(path, name)
246
mode = os.lstat(fullname).st_mode
249
if stat.S_ISDIR(mode):
250
safe_rmtree(fullname, ignore_errors, onerror)
254
except os.error, err:
255
onerror(os.remove, fullname, sys.exc_info())
259
onerror(os.rmdir, path, sys.exc_info())
added
removed
ivle/util.py
