← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/util.py

Remove the setup.configure import from setup.

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
 
73
74
def make_path(path):
74
75
    """Given a path relative to the IVLE root, makes the path relative to the
75
76
    site root using ivle.conf.root_dir. This path can be used in URLs sent to
76
77
    the client."""
77
78
    return os.path.join(ivle.conf.root_dir, path)
78
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
 
79
86
def unmake_path(path):
80
87
    """Given a path relative to the site root, makes the path relative to the
81
88
    IVLE root by removing ivle.conf.root_dir if it appears at the beginning. If
127
134
    else:
128
135
        return tuple(splitpath)
129
136
 
 
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
 
130
155
# Initialise mime types library
131
156
mimetypes.init()
132
157
for (ext, mimetype) in ivle.conf.mimetypes.additional_mime_types.items():
152
177
            except ValueError:
153
178
                return "File"
154
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 """<h1>Terms of Service</h1>
 
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
 
155
216
def incomplete_utf8_sequence(byteseq):
156
217
    """
157
218
    str -> int