1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2008 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
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.
32
root_dir = conf.root_dir
35
"""Given a path relative to the IVLE root, makes the path relative to the
36
site root using conf.root_dir. This path can be used in URLs sent to the
38
return os.path.join(root_dir, path)
40
def make_local_path(path):
41
"""Given a path relative to the IVLE root, on the local file system, makes
42
the path relative to the root using conf.ivle_install_dir. This path can
43
be used in reading files from the local file system."""
44
return os.path.join(conf.ivle_install_dir, 'www', path)
46
def unmake_path(path):
47
"""Given a path relative to the site root, makes the path relative to the
48
IVLE root by removing conf.root_dir if it appears at the beginning. If it
49
does not appear at the beginning, returns path unchanged. Also normalises
51
path = os.path.normpath(path)
52
root = os.path.normpath(root_dir)
54
if path.startswith(root):
55
path = path[len(root):]
56
# Take out the slash as well
57
if len(path) > 0 and path[0] == os.sep:
63
"""Given a path, returns a tuple consisting of the top-level directory in
64
the path, and the rest of the path. Note that both items in the tuple will
65
NOT begin with a slash, regardless of whether the original path did. Also
68
Always returns a pair of strings, except for one special case, in which
69
the path is completely empty (or just a single slash). In this case the
70
return value will be (None, ''). But still always returns a pair.
78
>>> split_path("home")
80
>>> split_path("home/docs/files")
81
('home', 'docs/files')
82
>>> split_path("//home/docs/files")
83
('', 'home/docs/files')
85
path = os.path.normpath(path)
86
# Ignore the opening slash
87
if path.startswith(os.sep):
88
path = path[len(os.sep):]
89
if path == '' or path == '.':
91
splitpath = path.split(os.sep, 1)
92
if len(splitpath) == 1:
93
return (splitpath[0], '')
95
return tuple(splitpath)
97
# Initialise mime types library
99
for (ext, mimetype) in conf.mimetypes.additional_mime_types.items():
100
mimetypes.add_type(mimetype, ext)
102
def nice_filetype(filename):
103
"""Given a filename or basename, returns a "friendly" name for that
105
eg. nice_mimetype("file.py") == "Python source code".
106
nice_filetype("file.bzg") == "BZG file".
107
nice_filetype("directory/") == "Directory".
109
if filename[-1] == os.sep:
113
return conf.mimetypes.nice_mimetypes[
114
mimetypes.guess_type(filename)[0]]
116
filename = os.path.basename(filename)
118
return filename[filename.rindex('.')+1:].upper() + " file"
added
removed
www/common/util.py
