← 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 04:50:39 UTC
  • Revision ID: grantw@unimelb.edu.au-20090428045039-ibb7gwtjrhe9osq3
Populate req.config in a cleaner manner.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/util.py
70
70
    def __repr__(self):
71
71
        return "<Fake %s %s>"%(self.type, self.name)
72
72
 
73
 
 
74
73
def make_path(path):
75
74
    """Given a path relative to the IVLE root, makes the path relative to the
76
75
    site root using ivle.conf.root_dir. This path can be used in URLs sent to
77
76
    the client."""
78
77
    return os.path.join(ivle.conf.root_dir, path)
79
78
 
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
79
def unmake_path(path):
87
80
    """Given a path relative to the site root, makes the path relative to the
88
81
    IVLE root by removing ivle.conf.root_dir if it appears at the beginning. If
134
127
    else:
135
128
        return tuple(splitpath)
136
129
 
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
130
# Initialise mime types library
156
131
mimetypes.init()
157
132
for (ext, mimetype) in ivle.conf.mimetypes.additional_mime_types.items():
177
152
            except ValueError:
178
153
                return "File"
179
154
 
180
 
def send_terms_of_service(req):
 
155
def get_terms_of_service():
181
156
    """
182
157
    Sends the Terms of Service document to the req object.
183
158
    This consults conf to find out where the TOS is located on disk, and sends
185
160
    how to create a real one.
186
161
    """
187
162
    try:
188
 
        req.sendfile(ivle.conf.tos_path)
 
163
        return open(ivle.conf.tos_path).read()
189
164
    except IOError:
190
 
        req.write(
191
 
"""<h1>Terms of Service</h1>
 
165
        return """\
192
166
<p><b>*** SAMPLE ONLY ***</b></p>
193
167
<p>This is the text of the IVLE Terms of Service.</p>
194
168
<p>The administrator should create a license file with an appropriate
206
180
just be the contents of a body element (IVLE will wrap it accordingly).</p>
207
181
<p>This will automatically be used as the license text instead of this
208
182
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")
 
183
"""
216
184
 
217
185
def incomplete_utf8_sequence(byteseq):
218
186
    """