2008-11-14 03:03:42 +08:00
|
|
|
import os
|
2011-02-21 22:16:29 +08:00
|
|
|
import stat
|
2012-12-08 18:13:52 +08:00
|
|
|
import sys
|
2014-02-09 20:37:14 +08:00
|
|
|
import tempfile
|
2015-01-28 20:35:27 +08:00
|
|
|
from os.path import abspath, dirname, isabs, join, normcase, normpath, sep
|
2012-12-08 18:13:52 +08:00
|
|
|
|
2014-11-12 01:59:49 +08:00
|
|
|
from django.core.exceptions import SuspiciousFileOperation
|
2012-08-08 18:56:12 +08:00
|
|
|
from django.utils import six
|
2015-01-28 20:35:27 +08:00
|
|
|
from django.utils.encoding import force_text
|
2007-08-12 20:49:01 +08:00
|
|
|
|
2011-12-23 06:38:10 +08:00
|
|
|
try:
|
|
|
|
WindowsError = WindowsError
|
|
|
|
except NameError:
|
|
|
|
class WindowsError(Exception):
|
|
|
|
pass
|
|
|
|
|
2013-09-02 18:06:32 +08:00
|
|
|
if six.PY2:
|
2012-12-08 18:13:52 +08:00
|
|
|
fs_encoding = sys.getfilesystemencoding() or sys.getdefaultencoding()
|
|
|
|
|
2011-12-23 06:38:10 +08:00
|
|
|
|
2012-08-08 18:56:12 +08:00
|
|
|
# Under Python 2, define our own abspath function that can handle joining
|
|
|
|
# unicode paths to a current working directory that has non-ASCII characters
|
|
|
|
# in it. This isn't necessary on Windows since the Windows version of abspath
|
|
|
|
# handles this correctly. It also handles drive letters differently than the
|
|
|
|
# pure Python implementation, so it's best not to replace it.
|
|
|
|
if six.PY3 or os.name == 'nt':
|
2008-11-14 03:03:42 +08:00
|
|
|
abspathu = abspath
|
|
|
|
else:
|
|
|
|
def abspathu(path):
|
|
|
|
"""
|
|
|
|
Version of os.path.abspath that uses the unicode representation
|
|
|
|
of the current working directory, thus avoiding a UnicodeDecodeError
|
|
|
|
in join when the cwd has non-ASCII characters.
|
|
|
|
"""
|
|
|
|
if not isabs(path):
|
|
|
|
path = join(os.getcwdu(), path)
|
|
|
|
return normpath(path)
|
|
|
|
|
2013-11-03 04:12:09 +08:00
|
|
|
|
2012-12-08 18:13:52 +08:00
|
|
|
def upath(path):
|
|
|
|
"""
|
|
|
|
Always return a unicode path.
|
|
|
|
"""
|
2013-09-02 18:06:32 +08:00
|
|
|
if six.PY2 and not isinstance(path, six.text_type):
|
2012-12-08 18:13:52 +08:00
|
|
|
return path.decode(fs_encoding)
|
|
|
|
return path
|
|
|
|
|
2013-11-03 04:12:09 +08:00
|
|
|
|
2012-12-08 18:13:52 +08:00
|
|
|
def npath(path):
|
|
|
|
"""
|
|
|
|
Always return a native path, that is unicode on Python 3 and bytestring on
|
|
|
|
Python 2.
|
|
|
|
"""
|
2013-09-02 18:06:32 +08:00
|
|
|
if six.PY2 and not isinstance(path, bytes):
|
2012-12-08 18:13:52 +08:00
|
|
|
return path.encode(fs_encoding)
|
|
|
|
return path
|
|
|
|
|
2013-11-03 07:53:29 +08:00
|
|
|
|
2007-08-12 20:49:01 +08:00
|
|
|
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).
|
|
|
|
"""
|
2012-07-21 16:00:10 +08:00
|
|
|
base = force_text(base)
|
|
|
|
paths = [force_text(p) for p in paths]
|
2011-05-23 07:56:42 +08:00
|
|
|
final_path = abspathu(join(base, *paths))
|
|
|
|
base_path = abspathu(base)
|
|
|
|
# Ensure final_path starts with base_path (using normcase to ensure we
|
2012-09-08 04:49:22 +08:00
|
|
|
# don't false-negative on case insensitive operating systems like Windows),
|
|
|
|
# further, one of the following conditions must be true:
|
|
|
|
# a) The next character is the path separator (to prevent conditions like
|
|
|
|
# safe_join("/dir", "/../d"))
|
|
|
|
# b) The final path must be the same as the base path.
|
|
|
|
# c) The base path must be the most root path (meaning either "/" or "C:\\")
|
|
|
|
if (not normcase(final_path).startswith(normcase(base_path + sep)) and
|
2013-11-26 17:43:46 +08:00
|
|
|
normcase(final_path) != normcase(base_path) and
|
|
|
|
dirname(normcase(base_path)) != normcase(base_path)):
|
2014-11-12 01:59:49 +08:00
|
|
|
raise SuspiciousFileOperation(
|
|
|
|
'The joined path ({}) is located outside of the base path '
|
|
|
|
'component ({})'.format(final_path, base_path))
|
2007-08-12 20:49:01 +08:00
|
|
|
return final_path
|
2010-12-31 22:22:55 +08:00
|
|
|
|
2011-12-23 06:38:10 +08:00
|
|
|
|
2010-12-31 22:22:55 +08:00
|
|
|
def rmtree_errorhandler(func, path, exc_info):
|
|
|
|
"""
|
|
|
|
On Windows, some files are read-only (e.g. in in .svn dirs), so when
|
|
|
|
rmtree() tries to remove them, an exception is thrown.
|
|
|
|
We catch that here, remove the read-only attribute, and hopefully
|
|
|
|
continue without problems.
|
|
|
|
"""
|
|
|
|
exctype, value = exc_info[:2]
|
2012-04-30 22:15:36 +08:00
|
|
|
# looking for a windows error
|
2010-12-31 22:22:55 +08:00
|
|
|
if exctype is not WindowsError or 'Access is denied' not in str(value):
|
|
|
|
raise
|
|
|
|
# file type should currently be read only
|
|
|
|
if ((os.stat(path).st_mode & stat.S_IREAD) != stat.S_IREAD):
|
|
|
|
raise
|
|
|
|
# convert to read/write
|
|
|
|
os.chmod(path, stat.S_IWRITE)
|
|
|
|
# use the original function to repeat the operation
|
|
|
|
func(path)
|
2014-02-09 20:37:14 +08:00
|
|
|
|
|
|
|
|
|
|
|
def symlinks_supported():
|
|
|
|
"""
|
|
|
|
A function to check if creating symlinks are supported in the
|
|
|
|
host platform and/or if they are allowed to be created (e.g.
|
|
|
|
on Windows it requires admin permissions).
|
|
|
|
"""
|
|
|
|
tmpdir = tempfile.mkdtemp()
|
|
|
|
original_path = os.path.join(tmpdir, 'original')
|
|
|
|
symlink_path = os.path.join(tmpdir, 'symlink')
|
|
|
|
os.makedirs(original_path)
|
|
|
|
try:
|
|
|
|
os.symlink(original_path, symlink_path)
|
|
|
|
supported = True
|
|
|
|
except (OSError, NotImplementedError, AttributeError):
|
|
|
|
supported = False
|
|
|
|
else:
|
|
|
|
os.remove(symlink_path)
|
|
|
|
finally:
|
2014-06-23 19:25:50 +08:00
|
|
|
os.rmdir(original_path)
|
|
|
|
os.rmdir(tmpdir)
|
2014-02-09 20:37:14 +08:00
|
|
|
return supported
|