← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/util.py

  • Committer: Matt Giuca
  • Date: 2009-05-12 14:42:24 UTC
  • mto: This revision was merged to the branch mainline in revision 1247.
  • Revision ID: matt.giuca@gmail.com-20090512144224-fdj5g9dfuajuslxo
ivle-fetchsubmissions: Solo project now shows "Submitter" not "Author".

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/util.py
20
20
# Date: 12/12/2007
21
21
 
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.
25
23
 
26
24
import os
27
 
import mimetypes
28
 
import datetime
29
 
 
30
 
import ivle.conf
31
 
import ivle.conf.mimetypes
 
25
import sys
 
26
import stat
32
27
 
33
28
class IVLEError(Exception):
34
 
    """
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.
38
 
 
39
 
    All other exceptions are considered IVLE bugs and should not occur
40
 
    (they will display a traceback).
41
 
 
42
 
    This error should not be raised directly. Call req.throw_error.
 
29
    """Legacy general IVLE exception.
 
30
 
 
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.
43
33
    """
44
34
    def __init__(self, httpcode, message=None):
45
35
        self.httpcode = httpcode
47
37
        self.args = (httpcode, message)
48
38
 
49
39
class IVLEJailError(Exception):
50
 
    """
 
40
    """Exception proxying an in-jail error.
 
41
 
51
42
    This exception indicates an error that occurred inside an IVLE CGI script
52
43
    inside the jail. It should never be raised directly - only by the 
53
44
    interpreter.
70
61
    def __repr__(self):
71
62
        return "<Fake %s %s>"%(self.type, self.name)
72
63
 
73
 
 
74
 
def make_path(path):
75
 
    """Given a path relative to the IVLE root, makes the path relative to the
76
 
    site root using ivle.conf.root_dir. This path can be used in URLs sent to
77
 
    the client."""
78
 
    return os.path.join(ivle.conf.root_dir, path)
79
 
 
80
 
def make_local_path(path):
81
 
    """Given a path relative to the IVLE root, on the local file system, makes
82
 
    the path relative to the root using ivle.conf.share_path. This path can
83
 
    be used in reading files from the local file system."""
84
 
    return os.path.join(ivle.conf.share_path, 'www', path)
85
 
 
86
 
def unmake_path(path):
87
 
    """Given a path relative to the site root, makes the path relative to the
88
 
    IVLE root by removing ivle.conf.root_dir if it appears at the beginning. If
89
 
    it does not appear at the beginning, returns path unchanged. Also
90
 
    normalises the path."""
91
 
    path = os.path.normpath(path)
92
 
    root = os.path.normpath(ivle.conf.root_dir)
93
 
 
94
 
    if path.startswith(root):
95
 
        path = path[len(root):]
96
 
        # Take out the slash as well
97
 
        if len(path) > 0 and path[0] == os.sep:
98
 
            path = path[1:]
99
 
 
100
 
    return path
101
 
 
102
64
def split_path(path):
103
65
    """Given a path, returns a tuple consisting of the top-level directory in
104
66
    the path, and the rest of the path. Note that both items in the tuple will
134
96
    else:
135
97
        return tuple(splitpath)
136
98
 
137
 
def open_exercise_file(exercisename):
138
 
    """Given an exercise name, opens the corresponding XML file for reading.
139
 
    Returns None if the exercise file was not found.
140
 
    (For tutorials / worksheets).
141
 
    """
142
 
    # First normalise the path
143
 
    exercisename = os.path.normpath(exercisename)
144
 
    # Now if it begins with ".." or separator, then it's illegal
145
 
    if exercisename.startswith("..") or exercisename.startswith(os.sep):
146
 
        exercisefile = None
147
 
    else:
148
 
        exercisefile = os.path.join(ivle.conf.exercises_base, exercisename)
149
 
 
150
 
    try:
151
 
        return open(exercisefile)
152
 
    except (TypeError, IOError):    # TypeError if exercisefile == None
153
 
        return None
154
 
 
155
 
# Initialise mime types library
156
 
mimetypes.init()
157
 
for (ext, mimetype) in ivle.conf.mimetypes.additional_mime_types.items():
158
 
    mimetypes.add_type(mimetype, ext)
159
 
 
160
 
def nice_filetype(filename):
161
 
    """Given a filename or basename, returns a "friendly" name for that
162
 
    file's type.
163
 
    eg. nice_mimetype("file.py") == "Python source code".
164
 
        nice_filetype("file.bzg") == "BZG file".
165
 
        nice_filetype("directory/") == "Directory".
166
 
    """
167
 
    if filename[-1] == os.sep:
168
 
        return "Directory"
169
 
    else:
170
 
        try:
171
 
            return ivle.conf.mimetypes.nice_mimetypes[
172
 
                mimetypes.guess_type(filename)[0]]
173
 
        except KeyError:
174
 
            filename = os.path.basename(filename)
175
 
            try:
176
 
                return filename[filename.rindex('.')+1:].upper() + " file"
177
 
            except ValueError:
178
 
                return "File"
179
 
 
180
 
def send_terms_of_service(req):
181
 
    """
182
 
    Sends the Terms of Service document to the req object.
183
 
    This consults conf to find out where the TOS is located on disk, and sends
184
 
    that. If it isn't found, it sends a generic message explaining to admins
185
 
    how to create a real one.
186
 
    """
187
 
    try:
188
 
        req.sendfile(ivle.conf.tos_path)
189
 
    except IOError:
190
 
        req.write(
191
 
"""<h1>Terms of Service</h1>
192
 
<p><b>*** SAMPLE ONLY ***</b></p>
193
 
<p>This is the text of the IVLE Terms of Service.</p>
194
 
<p>The administrator should create a license file with an appropriate
195
 
"Terms of Service" license for your organisation.</p>
196
 
<h2>Instructions for Administrators</h2>
197
 
<p>You are seeing this message because you have not configured a Terms of
198
 
Service document.</p>
199
 
<p>When you configured IVLE, you specified a path to the Terms of Service
200
 
document (this is found in <b><tt>ivle/conf/conf.py</tt></b> under
201
 
"<tt>tos_path</tt>").</p>
202
 
<p>Create a file at this location; an HTML file with the appropriately-worded
203
 
license.</p>
204
 
<p>This should be a normal XHTML file, except it should not contain
205
 
<tt>html</tt>, <tt>head</tt> or <tt>body</tt> elements - it should
206
 
just be the contents of a body element (IVLE will wrap it accordingly).</p>
207
 
<p>This will automatically be used as the license text instead of this
208
 
placeholder text.</p>
209
 
""")
210
 
 
211
 
def parse_iso8601(str):
212
 
    """Parses ISO8601 string into a datetime object."""
213
 
    # FIXME: Terrific hack that means we only accept the format that is 
214
 
    # produced by json.js module when it encodes date objects.
215
 
    return datetime.datetime.strptime(str, "%Y-%m-%dT%H:%M:%SZ")
216
 
 
217
99
def incomplete_utf8_sequence(byteseq):
218
 
    """
219
 
    str -> int
 
100
    """Calculate the completeness of a UTF-8 encoded string.
 
101
 
220
102
    Given a UTF-8-encoded byte sequence (str), returns the number of bytes at
221
103
    the end of the string which comprise an incomplete UTF-8 character
222
104
    sequence.
294
176
        return count
295
177
 
296
178
def object_to_dict(attrnames, obj):
297
 
    """
298
 
    Convert an object into a dictionary. This takes a shallow copy of the
299
 
    object.
300
 
    attrnames: Set (or iterable) of names of attributes to be copied into the
301
 
        dictionary. (We don't auto-lookup, because this function needs to be
302
 
        used on magical objects).
 
179
    """Convert an object into a dictionary.
 
180
 
 
181
    This takes a shallow copy of the object.
 
182
 
 
183
    @param attrnames: Set (or iterable) of names of attributes to be copied
 
184
                      into the dictionary. (We don't auto-lookup, because this
 
185
                      function needs to be used on magical objects).
303
186
    """
304
187
    return dict((k, getattr(obj, k))
305
188
        for k in attrnames if not k.startswith('_'))
 
189
 
 
190
def safe_rmtree(path, ignore_errors=False, onerror=None):
 
191
    """Recursively delete a directory tree.
 
192
 
 
193
    Copied from shutil.rmtree from Python 2.6, which does not follow symbolic
 
194
    links (it is otherwise unsafe to call as root on untrusted directories; do
 
195
    not use shutil.rmtree in this case, as you may be running Python 2.5).
 
196
 
 
197
    If ignore_errors is set, errors are ignored; otherwise, if onerror
 
198
    is set, it is called to handle the error with arguments (func,
 
199
    path, exc_info) where func is os.listdir, os.remove, or os.rmdir;
 
200
    path is the argument to that function that caused it to fail; and
 
201
    exc_info is a tuple returned by sys.exc_info().  If ignore_errors
 
202
    is false and onerror is None, an exception is raised.
 
203
 
 
204
    """
 
205
    if ignore_errors:
 
206
        def onerror(*args):
 
207
            pass
 
208
    elif onerror is None:
 
209
        def onerror(*args):
 
210
            raise
 
211
    try:
 
212
        if os.path.islink(path):
 
213
            # symlinks to directories are forbidden, see bug #1669
 
214
            raise OSError("Cannot call safe_rmtree on a symbolic link")
 
215
    except OSError:
 
216
        onerror(os.path.islink, path, sys.exc_info())
 
217
        # can't continue even if onerror hook returns
 
218
        return
 
219
    names = []
 
220
    try:
 
221
        names = os.listdir(path)
 
222
    except os.error, err:
 
223
        onerror(os.listdir, path, sys.exc_info())
 
224
    for name in names:
 
225
        fullname = os.path.join(path, name)
 
226
        try:
 
227
            mode = os.lstat(fullname).st_mode
 
228
        except os.error:
 
229
            mode = 0
 
230
        if stat.S_ISDIR(mode):
 
231
            safe_rmtree(fullname, ignore_errors, onerror)
 
232
        else:
 
233
            try:
 
234
                os.remove(fullname)
 
235
            except os.error, err:
 
236
                onerror(os.remove, fullname, sys.exc_info())
 
237
    try:
 
238
        os.rmdir(path)
 
239
    except os.error:
 
240
        onerror(os.rmdir, path, sys.exc_info())