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.ivlepath. This path can be used
43
in reading files from the local file system."""
44
return os.path.join(conf.ivlepath, 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
# +1 to take out the slash as well
56
return path[len(root)+1:]
61
"""Given a path, returns a tuple consisting of the top-level directory in
62
the path, and the rest of the path. Note that both items in the tuple will
63
NOT begin with a slash, regardless of whether the original path did. Also
66
Always returns a pair of strings, except for one special case, in which
67
the path is completely empty (or just a single slash). In this case the
68
return value will be (None, ''). But still always returns a pair.
76
>>> split_path("home")
78
>>> split_path("home/docs/files")
79
('home', 'docs/files')
80
>>> split_path("//home/docs/files")
81
('', 'home/docs/files')
83
path = os.path.normpath(path)
84
# Ignore the opening slash
85
if path.startswith(os.sep):
86
path = path[len(os.sep):]
87
if path == '' or path == '.':
89
splitpath = path.split(os.sep, 1)
90
if len(splitpath) == 1:
91
return (splitpath[0], '')
93
return tuple(splitpath)
95
# Initialise mime types library
97
for (ext, mimetype) in conf.mimetypes.additional_mime_types.items():
98
mimetypes.add_type(mimetype, ext)
added
removed
src/common/util.py
