← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/util.py

  • Committer: William Grant
  • Date: 2009-04-28 05:06:00 UTC
  • Revision ID: grantw@unimelb.edu.au-20090428050600-hogd9d6wo7ksyqy8
ivle.database.get_store() now takes a configuration object.

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.
23
25
 
24
26
import os
 
27
import mimetypes
 
28
import datetime
 
29
 
 
30
import ivle.conf
 
31
import ivle.conf.mimetypes
25
32
 
26
33
class IVLEError(Exception):
27
 
    """Legacy general IVLE exception.
28
 
 
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.
 
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.
31
43
    """
32
44
    def __init__(self, httpcode, message=None):
33
45
        self.httpcode = httpcode
35
47
        self.args = (httpcode, message)
36
48
 
37
49
class IVLEJailError(Exception):
38
 
    """Exception proxying an in-jail error.
39
 
 
 
50
    """
40
51
    This exception indicates an error that occurred inside an IVLE CGI script
41
52
    inside the jail. It should never be raised directly - only by the 
42
53
    interpreter.
59
70
    def __repr__(self):
60
71
        return "<Fake %s %s>"%(self.type, self.name)
61
72
 
 
73
def make_path(path):
 
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
 
76
    the client."""
 
77
    return os.path.join(ivle.conf.root_dir, path)
 
78
 
 
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)
 
86
 
 
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:
 
91
            path = path[1:]
 
92
 
 
93
    return path
 
94
 
62
95
def split_path(path):
63
96
    """Given a path, returns a tuple consisting of the top-level directory in
64
97
    the path, and the rest of the path. Note that both items in the tuple will
94
127
    else:
95
128
        return tuple(splitpath)
96
129
 
 
130
# Initialise mime types library
 
131
mimetypes.init()
 
132
for (ext, mimetype) in ivle.conf.mimetypes.additional_mime_types.items():
 
133
    mimetypes.add_type(mimetype, ext)
 
134
 
 
135
def nice_filetype(filename):
 
136
    """Given a filename or basename, returns a "friendly" name for that
 
137
    file's type.
 
138
    eg. nice_mimetype("file.py") == "Python source code".
 
139
        nice_filetype("file.bzg") == "BZG file".
 
140
        nice_filetype("directory/") == "Directory".
 
141
    """
 
142
    if filename[-1] == os.sep:
 
143
        return "Directory"
 
144
    else:
 
145
        try:
 
146
            return ivle.conf.mimetypes.nice_mimetypes[
 
147
                mimetypes.guess_type(filename)[0]]
 
148
        except KeyError:
 
149
            filename = os.path.basename(filename)
 
150
            try:
 
151
                return filename[filename.rindex('.')+1:].upper() + " file"
 
152
            except ValueError:
 
153
                return "File"
 
154
 
97
155
def incomplete_utf8_sequence(byteseq):
98
 
    """Calculate the completeness of a UTF-8 encoded string.
99
 
 
 
156
    """
 
157
    str -> int
100
158
    Given a UTF-8-encoded byte sequence (str), returns the number of bytes at
101
159
    the end of the string which comprise an incomplete UTF-8 character
102
160
    sequence.
174
232
        return count
175
233
 
176
234
def object_to_dict(attrnames, obj):
177
 
    """Convert an object into a dictionary.
178
 
 
179
 
    This takes a shallow copy of the object.
180
 
 
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).
 
235
    """
 
236
    Convert an object into a dictionary. This takes a shallow copy of the
 
237
    object.
 
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).
184
241
    """
185
242
    return dict((k, getattr(obj, k))
186
243
        for k in attrnames if not k.startswith('_'))