← 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 06:02:41 UTC
  • Revision ID: grantw@unimelb.edu.au-20090428060241-t4gnwl35maukfvfg
Move ivle.conf.mimetypes to ivle.mimetypes, and rename things in it.

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
25
import datetime
29
26
 
30
27
import ivle.conf
31
 
import ivle.conf.mimetypes
32
28
 
33
29
class IVLEError(Exception):
34
30
    """
70
66
    def __repr__(self):
71
67
        return "<Fake %s %s>"%(self.type, self.name)
72
68
 
73
 
 
74
69
def make_path(path):
75
70
    """Given a path relative to the IVLE root, makes the path relative to the
76
71
    site root using ivle.conf.root_dir. This path can be used in URLs sent to
77
72
    the client."""
78
73
    return os.path.join(ivle.conf.root_dir, path)
79
74
 
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
75
def unmake_path(path):
87
76
    """Given a path relative to the site root, makes the path relative to the
88
77
    IVLE root by removing ivle.conf.root_dir if it appears at the beginning. If
134
123
    else:
135
124
        return tuple(splitpath)
136
125
 
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 get_terms_of_service():
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
 
        return open(ivle.conf.tos_path).read()
189
 
    except IOError:
190
 
        return """\
191
 
<p><b>*** SAMPLE ONLY ***</b></p>
192
 
<p>This is the text of the IVLE Terms of Service.</p>
193
 
<p>The administrator should create a license file with an appropriate
194
 
"Terms of Service" license for your organisation.</p>
195
 
<h2>Instructions for Administrators</h2>
196
 
<p>You are seeing this message because you have not configured a Terms of
197
 
Service document.</p>
198
 
<p>When you configured IVLE, you specified a path to the Terms of Service
199
 
document (this is found in <b><tt>ivle/conf/conf.py</tt></b> under
200
 
"<tt>tos_path</tt>").</p>
201
 
<p>Create a file at this location; an HTML file with the appropriately-worded
202
 
license.</p>
203
 
<p>This should be a normal XHTML file, except it should not contain
204
 
<tt>html</tt>, <tt>head</tt> or <tt>body</tt> elements - it should
205
 
just be the contents of a body element (IVLE will wrap it accordingly).</p>
206
 
<p>This will automatically be used as the license text instead of this
207
 
placeholder text.</p>
208
 
"""
209
 
 
210
 
def parse_iso8601(str):
211
 
    """Parses ISO8601 string into a datetime object."""
212
 
    # FIXME: Terrific hack that means we only accept the format that is 
213
 
    # produced by json.js module when it encodes date objects.
214
 
    return datetime.datetime.strptime(str, "%Y-%m-%dT%H:%M:%SZ")
215
 
 
216
126
def incomplete_utf8_sequence(byteseq):
217
127
    """
218
128
    str -> int