141 lines
4.1 KiB
Python
141 lines
4.1 KiB
Python
import logging
|
|
import os
|
|
import re
|
|
# pylint: disable = W0402
|
|
import string
|
|
# pylint: enable = W0402
|
|
import sys
|
|
import urllib
|
|
|
|
import glib
|
|
|
|
logger = logging.getLogger('mopidy.utils.path')
|
|
|
|
DATA_PATH = os.path.join(str(glib.get_user_data_dir()), 'mopidy')
|
|
SETTINGS_PATH = os.path.join(str(glib.get_user_config_dir()), 'mopidy')
|
|
SETTINGS_FILE = os.path.join(SETTINGS_PATH, 'settings.py')
|
|
XDG_DIRS = {
|
|
'XDG_CACHE_DIR': glib.get_user_cache_dir(),
|
|
'XDG_DATA_DIR': glib.get_user_data_dir(),
|
|
'XDG_MUSIC_DIR': glib.get_user_special_dir(glib.USER_DIRECTORY_MUSIC),
|
|
}
|
|
|
|
|
|
def get_or_create_folder(folder):
|
|
folder = os.path.expanduser(folder)
|
|
if os.path.isfile(folder):
|
|
raise OSError(
|
|
u'A file with the same name as the desired dir, '
|
|
u'"%s", already exists.' % folder)
|
|
elif not os.path.isdir(folder):
|
|
logger.info(u'Creating dir %s', folder)
|
|
os.makedirs(folder, 0755)
|
|
return folder
|
|
|
|
|
|
def get_or_create_file(filename):
|
|
filename = os.path.expanduser(filename)
|
|
if not os.path.isfile(filename):
|
|
logger.info(u'Creating file %s', filename)
|
|
open(filename, 'w')
|
|
return filename
|
|
|
|
|
|
def path_to_uri(*paths):
|
|
path = os.path.join(*paths)
|
|
path = path.encode('utf-8')
|
|
if sys.platform == 'win32':
|
|
return 'file:' + urllib.pathname2url(path)
|
|
return 'file://' + urllib.pathname2url(path)
|
|
|
|
|
|
def uri_to_path(uri):
|
|
if sys.platform == 'win32':
|
|
path = urllib.url2pathname(re.sub('^file:', '', uri))
|
|
else:
|
|
path = urllib.url2pathname(re.sub('^file://', '', uri))
|
|
return path.encode('latin1').decode('utf-8') # Undo double encoding
|
|
|
|
|
|
def split_path(path):
|
|
parts = []
|
|
while True:
|
|
path, part = os.path.split(path)
|
|
if part:
|
|
parts.insert(0, part)
|
|
if not path or path == '/':
|
|
break
|
|
return parts
|
|
|
|
|
|
def expand_path(path):
|
|
path = string.Template(path).safe_substitute(XDG_DIRS)
|
|
path = os.path.expanduser(path)
|
|
path = os.path.abspath(path)
|
|
return path
|
|
|
|
|
|
def find_files(path):
|
|
if os.path.isfile(path):
|
|
if not isinstance(path, unicode):
|
|
path = path.decode('utf-8')
|
|
if not os.path.basename(path).startswith('.'):
|
|
yield path
|
|
else:
|
|
for dirpath, dirnames, filenames in os.walk(path):
|
|
# Filter out hidden folders by modifying dirnames in place.
|
|
for dirname in dirnames:
|
|
if dirname.startswith('.'):
|
|
dirnames.remove(dirname)
|
|
|
|
for filename in filenames:
|
|
# Skip hidden files.
|
|
if filename.startswith('.'):
|
|
continue
|
|
|
|
filename = os.path.join(dirpath, filename)
|
|
if not isinstance(filename, unicode):
|
|
try:
|
|
filename = filename.decode('utf-8')
|
|
except UnicodeDecodeError:
|
|
filename = filename.decode('latin1')
|
|
yield filename
|
|
|
|
|
|
def check_file_path_is_inside_base_dir(file_path, base_path):
|
|
assert not file_path.endswith(os.sep), (
|
|
'File path %s cannot end with a path separator' % file_path)
|
|
|
|
# Expand symlinks
|
|
real_base_path = os.path.realpath(base_path)
|
|
real_file_path = os.path.realpath(file_path)
|
|
|
|
# Use dir of file for prefix comparision, so we don't accept
|
|
# /tmp/foo.m3u as being inside /tmp/foo, simply because they have a
|
|
# common prefix, /tmp/foo, which matches the base path, /tmp/foo.
|
|
real_dir_path = os.path.dirname(real_file_path)
|
|
|
|
# Check if dir of file is the base path or a subdir
|
|
common_prefix = os.path.commonprefix([real_base_path, real_dir_path])
|
|
assert common_prefix == real_base_path, (
|
|
'File path %s must be in %s' % (real_file_path, real_base_path))
|
|
|
|
|
|
# FIXME replace with mock usage in tests.
|
|
class Mtime(object):
|
|
def __init__(self):
|
|
self.fake = None
|
|
|
|
def __call__(self, path):
|
|
if self.fake is not None:
|
|
return self.fake
|
|
return int(os.stat(path).st_mtime)
|
|
|
|
def set_fake_time(self, time):
|
|
self.fake = time
|
|
|
|
def undo_fake(self):
|
|
self.fake = None
|
|
|
|
mtime = Mtime()
|