app/django/utils/_os.py
author Todd Larsen <tlarsen@google.com>
Fri, 21 Nov 2008 07:07:55 +0000
changeset 529 7c5ec72cdcf1
parent 323 ff1a9aa48cfd
permissions -rw-r--r--
Replace nick_name and its variants with public_name. Remove the soc/templates/soc/person/edit.html template, since it does not appear to be referenced anywhere (and contained a nick_name reference that would otherwise need to be remedied). Patch by: Todd Larsen

from os.path import join, normcase, abspath, sep
from django.utils.encoding import force_unicode

def safe_join(base, *paths):
    """
    Joins one or more path components to the base path component intelligently.
    Returns a normalized, absolute version of the final path.

    The final path must be located inside of the base path component (otherwise
    a ValueError is raised).
    """
    # We need to use normcase to ensure we don't false-negative on case
    # insensitive operating systems (like Windows).
    base = force_unicode(base)
    paths = [force_unicode(p) for p in paths]
    final_path = normcase(abspath(join(base, *paths)))
    base_path = normcase(abspath(base))
    base_path_len = len(base_path)
    # Ensure final_path starts with base_path and that the next character after
    # the final path is os.sep (or nothing, in which case final_path must be
    # equal to base_path).
    if not final_path.startswith(base_path) \
       or final_path[base_path_len:base_path_len+1] not in ('', sep):
        raise ValueError('the joined path is located outside of the base path'
                         ' component')
    return final_path