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
33
class IVLEError(Exception):
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.
44
def __init__(self, httpcode, message=None):
45
self.httpcode = httpcode
46
self.message = message
47
self.args = (httpcode, message)
28
49
class IVLEJailError(Exception):
29
"""Exception proxying an in-jail error.
31
51
This exception indicates an error that occurred inside an IVLE CGI script
32
52
inside the jail. It should never be raised directly - only by the
50
70
def __repr__(self):
51
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:
53
95
def split_path(path):
54
96
"""Given a path, returns a tuple consisting of the top-level directory in
55
97
the path, and the rest of the path. Note that both items in the tuple will
86
128
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)
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".
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"
155
def get_terms_of_service():
157
Sends the Terms of Service document to the req object.
158
This consults conf to find out where the TOS is located on disk, and sends
159
that. If it isn't found, it sends a generic message explaining to admins
160
how to create a real one.
163
return open(ivle.conf.tos_path).read()
166
<p><b>*** SAMPLE ONLY ***</b></p>
167
<p>This is the text of the IVLE Terms of Service.</p>
168
<p>The administrator should create a license file with an appropriate
169
"Terms of Service" license for your organisation.</p>
170
<h2>Instructions for Administrators</h2>
171
<p>You are seeing this message because you have not configured a Terms of
172
Service document.</p>
173
<p>When you configured IVLE, you specified a path to the Terms of Service
174
document (this is found in <b><tt>ivle/conf/conf.py</tt></b> under
175
"<tt>tos_path</tt>").</p>
176
<p>Create a file at this location; an HTML file with the appropriately-worded
178
<p>This should be a normal XHTML file, except it should not contain
179
<tt>html</tt>, <tt>head</tt> or <tt>body</tt> elements - it should
180
just be the contents of a body element (IVLE will wrap it accordingly).</p>
181
<p>This will automatically be used as the license text instead of this
182
placeholder text.</p>
107
185
def incomplete_utf8_sequence(byteseq):
108
"""Calculate the completeness of a UTF-8 encoded string.
110
188
Given a UTF-8-encoded byte sequence (str), returns the number of bytes at
111
189
the end of the string which comprise an incomplete UTF-8 character
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)
264
def object_to_dict(attrnames, obj):
266
Convert an object into a dictionary. This takes a shallow copy of the
268
attrnames: Set (or iterable) of names of attributes to be copied into the
269
dictionary. (We don't auto-lookup, because this function needs to be
270
used on magical objects).
272
return dict((k, getattr(obj, k))
273
for k in attrnames if not k.startswith('_'))
added
removed
ivle/util.py
