← Back to branch summary

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

« back to all changes in this revision

Viewing changes to src/common/util.py

  • Committer: mattgiuca
  • Date: 2007-12-16 23:02:54 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:67
doc: Added app_howto doc, a guide on IVLE apps interface.
        Added Makefile for this directory.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/common/util.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2008 The University of Melbourne
 
3
#
 
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.
 
8
#
 
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.
 
13
#
 
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
 
17
 
 
18
# Module: common.util
 
19
# Author: Matt Giuca
 
20
# Date: 12/12/2007
 
21
 
 
22
# Contains common utility functions.
 
23
 
 
24
import os
 
25
 
 
26
import conf
 
27
 
 
28
root_dir = conf.root_dir
 
29
 
 
30
def make_path(path):
 
31
    """Given a path relative to the IVLE root, makes the path relative to the
 
32
    site root using conf.root_dir. This path can be used in URLs sent to the
 
33
    client."""
 
34
    return os.path.join(root_dir, path)
 
35
 
 
36
def unmake_path(path):
 
37
    """Given a path relative to the site root, makes the path relative to the
 
38
    IVLE root by removing conf.root_dir if it appears at the beginning. If it
 
39
    does not appear at the beginning, returns path unchanged. Also normalises
 
40
    the path."""
 
41
    path = os.path.normpath(path)
 
42
    root = os.path.normpath(root_dir)
 
43
 
 
44
    if path.startswith(root):
 
45
        # +1 to take out the slash as well
 
46
        return path[len(root)+1:]
 
47
    else:
 
48
        return path
 
49
 
 
50
def split_path(path):
 
51
    """Given a path, returns a tuple consisting of the top-level directory in
 
52
    the path, and the rest of the path. Note that both items in the tuple will
 
53
    NOT begin with a slash, regardless of whether the original path did. Also
 
54
    normalises the path.
 
55
 
 
56
    Always returns a pair of strings, except for one special case, in which
 
57
    the path is completely empty (or just a single slash). In this case the
 
58
    return value will be (None, ''). But still always returns a pair.
 
59
 
 
60
    Examples:
 
61
 
 
62
    >>> split_path("")
 
63
    (None, '')
 
64
    >>> split_path("/")
 
65
    (None, '')
 
66
    >>> split_path("home")
 
67
    ('home', '')
 
68
    >>> split_path("home/docs/files")
 
69
    ('home', 'docs/files')
 
70
    >>> split_path("//home/docs/files")
 
71
    ('', 'home/docs/files')
 
72
    """
 
73
    path = os.path.normpath(path)
 
74
    # Ignore the opening slash
 
75
    if path.startswith(os.sep):
 
76
        path = path[len(os.sep):]
 
77
    if path == '' or path == '.':
 
78
        return (None, '')
 
79
    splitpath = path.split(os.sep, 1)
 
80
    if len(splitpath) == 1:
 
81
        return (splitpath[0], '')
 
82
    else:
 
83
        return tuple(splitpath)