2009-03-13 18:43:16 +01:00
|
|
|
/*
|
2014-01-13 22:30:36 +01:00
|
|
|
* Copyright (C) 2003-2014 The Music Player Daemon Project
|
2009-03-13 18:43:16 +01:00
|
|
|
* http://www.musicpd.org
|
2008-10-14 11:10:49 +02:00
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
2009-03-13 18:43:16 +01:00
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
2008-10-14 11:10:49 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Maps directory and song objects to file system paths.
|
|
|
|
*/
|
|
|
|
|
2009-11-12 09:12:38 +01:00
|
|
|
#include "config.h"
|
2013-01-02 22:43:56 +01:00
|
|
|
#include "Mapper.hxx"
|
2013-01-02 22:52:08 +01:00
|
|
|
#include "Directory.hxx"
|
2013-07-28 13:25:12 +02:00
|
|
|
#include "Song.hxx"
|
2014-01-07 21:39:47 +01:00
|
|
|
#include "DetachedSong.hxx"
|
2013-10-17 21:59:35 +02:00
|
|
|
#include "fs/AllocatedPath.hxx"
|
2013-10-17 23:23:25 +02:00
|
|
|
#include "fs/Traits.hxx"
|
2013-10-17 22:13:54 +02:00
|
|
|
#include "fs/Charset.hxx"
|
2013-01-23 19:38:09 +01:00
|
|
|
#include "fs/FileSystem.hxx"
|
|
|
|
#include "fs/DirectoryReader.hxx"
|
2013-09-27 22:31:24 +02:00
|
|
|
#include "util/Domain.hxx"
|
|
|
|
#include "Log.hxx"
|
2008-10-15 19:36:33 +02:00
|
|
|
|
2008-12-29 17:28:32 +01:00
|
|
|
#include <assert.h>
|
|
|
|
#include <string.h>
|
2011-11-28 09:37:05 +01:00
|
|
|
#include <sys/stat.h>
|
|
|
|
#include <errno.h>
|
2008-10-15 19:36:33 +02:00
|
|
|
|
2013-09-27 22:31:24 +02:00
|
|
|
static constexpr Domain mapper_domain("mapper");
|
|
|
|
|
2012-08-13 23:37:50 +02:00
|
|
|
/**
|
|
|
|
* The absolute path of the music directory encoded in UTF-8.
|
|
|
|
*/
|
2013-10-17 19:54:58 +02:00
|
|
|
static std::string music_dir_utf8;
|
2012-08-13 23:37:50 +02:00
|
|
|
static size_t music_dir_utf8_length;
|
2008-10-15 19:36:33 +02:00
|
|
|
|
2012-08-13 23:37:50 +02:00
|
|
|
/**
|
|
|
|
* The absolute path of the music directory encoded in the filesystem
|
|
|
|
* character set.
|
|
|
|
*/
|
2013-10-17 21:59:35 +02:00
|
|
|
static AllocatedPath music_dir_fs = AllocatedPath::Null();
|
2012-08-13 23:37:50 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The absolute path of the playlist directory encoded in the
|
|
|
|
* filesystem character set.
|
|
|
|
*/
|
2013-10-17 21:59:35 +02:00
|
|
|
static AllocatedPath playlist_dir_fs = AllocatedPath::Null();
|
2009-01-18 16:15:45 +01:00
|
|
|
|
2011-11-28 09:35:50 +01:00
|
|
|
static void
|
2013-10-17 21:59:35 +02:00
|
|
|
check_directory(const char *path_utf8, const AllocatedPath &path_fs)
|
2011-11-28 09:35:50 +01:00
|
|
|
{
|
2011-11-28 09:37:05 +01:00
|
|
|
struct stat st;
|
2013-01-23 19:38:09 +01:00
|
|
|
if (!StatFile(path_fs, st)) {
|
2013-09-27 22:31:24 +02:00
|
|
|
FormatErrno(mapper_domain,
|
|
|
|
"Failed to stat directory \"%s\"",
|
|
|
|
path_utf8);
|
2011-11-28 09:37:05 +01:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!S_ISDIR(st.st_mode)) {
|
2013-09-27 22:31:24 +02:00
|
|
|
FormatError(mapper_domain,
|
|
|
|
"Not a directory: %s", path_utf8);
|
2011-11-28 09:37:05 +01:00
|
|
|
return;
|
|
|
|
}
|
2011-11-28 09:44:36 +01:00
|
|
|
|
|
|
|
#ifndef WIN32
|
2013-10-17 21:59:35 +02:00
|
|
|
const auto x = AllocatedPath::Build(path_fs, ".");
|
2013-01-23 19:38:09 +01:00
|
|
|
if (!StatFile(x, st) && errno == EACCES)
|
2013-09-27 22:31:24 +02:00
|
|
|
FormatError(mapper_domain,
|
|
|
|
"No permission to traverse (\"execute\") directory: %s",
|
|
|
|
path_utf8);
|
2011-11-28 09:44:36 +01:00
|
|
|
#endif
|
2011-11-28 09:56:03 +01:00
|
|
|
|
2013-01-23 19:38:09 +01:00
|
|
|
const DirectoryReader reader(path_fs);
|
2013-05-05 09:34:12 +02:00
|
|
|
if (reader.HasFailed() && errno == EACCES)
|
2013-09-27 22:31:24 +02:00
|
|
|
FormatError(mapper_domain,
|
|
|
|
"No permission to read directory: %s", path_utf8);
|
2011-11-28 09:35:50 +01:00
|
|
|
}
|
|
|
|
|
2013-08-07 19:54:38 +02:00
|
|
|
static void
|
2013-10-17 21:59:35 +02:00
|
|
|
mapper_set_music_dir(AllocatedPath &&path)
|
2009-01-18 16:56:07 +01:00
|
|
|
{
|
2013-08-07 19:54:38 +02:00
|
|
|
assert(!path.IsNull());
|
2013-01-27 08:26:17 +01:00
|
|
|
|
2013-10-01 18:50:12 +02:00
|
|
|
music_dir_fs = std::move(path);
|
2013-10-14 22:26:23 +02:00
|
|
|
music_dir_fs.ChopSeparators();
|
2013-01-27 08:26:17 +01:00
|
|
|
|
2013-10-17 19:54:58 +02:00
|
|
|
music_dir_utf8 = music_dir_fs.ToUTF8();
|
|
|
|
music_dir_utf8_length = music_dir_utf8.length();
|
2011-11-28 09:35:50 +01:00
|
|
|
|
2013-10-17 19:54:58 +02:00
|
|
|
check_directory(music_dir_utf8.c_str(), music_dir_fs);
|
2009-01-18 16:56:07 +01:00
|
|
|
}
|
|
|
|
|
2013-08-07 19:54:38 +02:00
|
|
|
static void
|
2013-10-17 21:59:35 +02:00
|
|
|
mapper_set_playlist_dir(AllocatedPath &&path)
|
2009-01-18 16:15:45 +01:00
|
|
|
{
|
2013-08-07 19:54:38 +02:00
|
|
|
assert(!path.IsNull());
|
|
|
|
|
2013-10-01 18:50:12 +02:00
|
|
|
playlist_dir_fs = std::move(path);
|
2013-01-27 08:26:17 +01:00
|
|
|
|
2013-08-07 19:54:38 +02:00
|
|
|
const auto utf8 = playlist_dir_fs.ToUTF8();
|
|
|
|
check_directory(utf8.c_str(), playlist_dir_fs);
|
2009-01-18 16:15:45 +01:00
|
|
|
}
|
2008-10-31 16:47:14 +01:00
|
|
|
|
2013-08-07 19:54:38 +02:00
|
|
|
void
|
2013-10-17 21:59:35 +02:00
|
|
|
mapper_init(AllocatedPath &&_music_dir, AllocatedPath &&_playlist_dir)
|
2008-10-15 19:36:33 +02:00
|
|
|
{
|
2013-08-07 19:54:38 +02:00
|
|
|
if (!_music_dir.IsNull())
|
|
|
|
mapper_set_music_dir(std::move(_music_dir));
|
2013-01-27 08:26:17 +01:00
|
|
|
|
2013-08-07 19:54:38 +02:00
|
|
|
if (!_playlist_dir.IsNull())
|
|
|
|
mapper_set_playlist_dir(std::move(_playlist_dir));
|
2008-10-15 19:36:33 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
void mapper_finish(void)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2012-02-13 20:10:19 +01:00
|
|
|
const char *
|
2012-08-13 23:37:50 +02:00
|
|
|
mapper_get_music_directory_utf8(void)
|
2009-01-18 16:56:07 +01:00
|
|
|
{
|
2013-11-22 00:02:17 +01:00
|
|
|
return music_dir_utf8.empty()
|
|
|
|
? nullptr
|
|
|
|
: music_dir_utf8.c_str();
|
2012-08-13 23:37:50 +02:00
|
|
|
}
|
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
const AllocatedPath &
|
2012-08-13 23:37:50 +02:00
|
|
|
mapper_get_music_directory_fs(void)
|
|
|
|
{
|
|
|
|
return music_dir_fs;
|
2009-01-18 16:56:07 +01:00
|
|
|
}
|
|
|
|
|
2010-07-25 13:18:57 +02:00
|
|
|
const char *
|
|
|
|
map_to_relative_path(const char *path_utf8)
|
|
|
|
{
|
2013-10-17 19:54:58 +02:00
|
|
|
return !music_dir_utf8.empty() &&
|
|
|
|
memcmp(path_utf8, music_dir_utf8.c_str(),
|
2012-08-13 23:37:50 +02:00
|
|
|
music_dir_utf8_length) == 0 &&
|
2013-12-04 22:53:43 +01:00
|
|
|
PathTraitsUTF8::IsSeparator(path_utf8[music_dir_utf8_length])
|
2012-08-13 23:37:50 +02:00
|
|
|
? path_utf8 + music_dir_utf8_length + 1
|
2010-07-25 13:18:57 +02:00
|
|
|
: path_utf8;
|
|
|
|
}
|
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
AllocatedPath
|
2009-01-02 10:48:11 +01:00
|
|
|
map_uri_fs(const char *uri)
|
2008-12-24 22:04:24 +01:00
|
|
|
{
|
2013-10-28 23:58:17 +01:00
|
|
|
assert(uri != nullptr);
|
2008-12-24 22:04:24 +01:00
|
|
|
assert(*uri != '/');
|
|
|
|
|
2013-01-23 19:38:09 +01:00
|
|
|
if (music_dir_fs.IsNull())
|
2013-10-17 21:59:35 +02:00
|
|
|
return AllocatedPath::Null();
|
2009-01-18 16:56:07 +01:00
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
const auto uri_fs = AllocatedPath::FromUTF8(uri);
|
2013-01-17 00:56:57 +01:00
|
|
|
if (uri_fs.IsNull())
|
2013-10-17 21:59:35 +02:00
|
|
|
return AllocatedPath::Null();
|
2009-01-08 21:20:46 +01:00
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
return AllocatedPath::Build(music_dir_fs, uri_fs);
|
2008-12-24 22:04:24 +01:00
|
|
|
}
|
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
AllocatedPath
|
2013-10-19 18:48:38 +02:00
|
|
|
map_directory_fs(const Directory &directory)
|
2008-10-14 11:10:49 +02:00
|
|
|
{
|
2013-01-23 19:38:09 +01:00
|
|
|
assert(!music_dir_fs.IsNull());
|
2009-01-18 16:56:07 +01:00
|
|
|
|
2013-10-19 18:48:38 +02:00
|
|
|
if (directory.IsRoot())
|
2013-01-23 19:38:09 +01:00
|
|
|
return music_dir_fs;
|
2008-10-14 11:10:49 +02:00
|
|
|
|
2013-10-19 18:48:38 +02:00
|
|
|
return map_uri_fs(directory.GetPath());
|
2008-10-14 11:10:49 +02:00
|
|
|
}
|
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
AllocatedPath
|
2013-10-19 18:48:38 +02:00
|
|
|
map_directory_child_fs(const Directory &directory, const char *name)
|
2008-10-14 11:10:49 +02:00
|
|
|
{
|
2013-01-23 19:38:09 +01:00
|
|
|
assert(!music_dir_fs.IsNull());
|
2008-10-14 11:10:49 +02:00
|
|
|
|
2008-10-31 16:48:58 +01:00
|
|
|
/* check for invalid or unauthorized base names */
|
2013-10-28 23:58:17 +01:00
|
|
|
if (*name == 0 || strchr(name, '/') != nullptr ||
|
2008-10-31 16:48:58 +01:00
|
|
|
strcmp(name, ".") == 0 || strcmp(name, "..") == 0)
|
2013-10-17 21:59:35 +02:00
|
|
|
return AllocatedPath::Null();
|
2008-10-31 16:48:58 +01:00
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
const auto parent_fs = map_directory_fs(directory);
|
2013-01-17 00:56:57 +01:00
|
|
|
if (parent_fs.IsNull())
|
2013-10-17 21:59:35 +02:00
|
|
|
return AllocatedPath::Null();
|
2008-10-14 11:10:49 +02:00
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
const auto name_fs = AllocatedPath::FromUTF8(name);
|
2013-01-17 00:56:57 +01:00
|
|
|
if (name_fs.IsNull())
|
2013-10-17 21:59:35 +02:00
|
|
|
return AllocatedPath::Null();
|
2009-01-08 21:20:46 +01:00
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
return AllocatedPath::Build(parent_fs, name_fs);
|
2008-10-14 11:10:49 +02:00
|
|
|
}
|
|
|
|
|
2012-08-15 22:44:21 +02:00
|
|
|
/**
|
|
|
|
* Map a song object that was created by song_dup_detached(). It does
|
|
|
|
* not have a real parent directory, only the dummy object
|
|
|
|
* #detached_root.
|
|
|
|
*/
|
2013-10-17 21:59:35 +02:00
|
|
|
static AllocatedPath
|
2012-08-15 22:44:21 +02:00
|
|
|
map_detached_song_fs(const char *uri_utf8)
|
|
|
|
{
|
2013-10-17 21:59:35 +02:00
|
|
|
auto uri_fs = AllocatedPath::FromUTF8(uri_utf8);
|
2013-01-17 00:56:57 +01:00
|
|
|
if (uri_fs.IsNull())
|
2013-10-17 21:59:35 +02:00
|
|
|
return uri_fs;
|
2012-08-15 22:44:21 +02:00
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
return AllocatedPath::Build(music_dir_fs, uri_fs);
|
2012-08-15 22:44:21 +02:00
|
|
|
}
|
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
AllocatedPath
|
2013-10-19 18:48:38 +02:00
|
|
|
map_song_fs(const Song &song)
|
2008-10-14 11:10:49 +02:00
|
|
|
{
|
2014-01-07 21:39:47 +01:00
|
|
|
return song.parent == nullptr
|
|
|
|
? map_detached_song_fs(song.uri)
|
|
|
|
: map_directory_child_fs(*song.parent, song.uri);
|
|
|
|
}
|
2008-10-14 11:10:49 +02:00
|
|
|
|
2014-01-07 21:39:47 +01:00
|
|
|
AllocatedPath
|
|
|
|
map_song_fs(const DetachedSong &song)
|
|
|
|
{
|
|
|
|
if (song.IsAbsoluteFile())
|
|
|
|
return AllocatedPath::FromUTF8(song.GetURI());
|
2008-10-15 22:35:13 +02:00
|
|
|
else
|
2014-01-07 21:39:47 +01:00
|
|
|
return map_uri_fs(song.GetURI());
|
2008-10-14 11:10:49 +02:00
|
|
|
}
|
|
|
|
|
2013-10-14 21:43:41 +02:00
|
|
|
std::string
|
2009-01-04 18:59:47 +01:00
|
|
|
map_fs_to_utf8(const char *path_fs)
|
2008-10-14 11:10:49 +02:00
|
|
|
{
|
2013-12-04 22:53:43 +01:00
|
|
|
if (PathTraitsFS::IsSeparator(path_fs[0])) {
|
2013-10-14 22:09:02 +02:00
|
|
|
path_fs = music_dir_fs.RelativeFS(path_fs);
|
|
|
|
if (path_fs == nullptr || *path_fs == 0)
|
|
|
|
return std::string();
|
|
|
|
}
|
2009-01-30 13:47:52 +01:00
|
|
|
|
2013-10-17 22:13:54 +02:00
|
|
|
return PathToUTF8(path_fs);
|
2008-10-14 11:10:49 +02:00
|
|
|
}
|
2008-10-31 16:47:14 +01:00
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
const AllocatedPath &
|
2008-10-31 16:47:14 +01:00
|
|
|
map_spl_path(void)
|
|
|
|
{
|
2012-08-13 23:37:50 +02:00
|
|
|
return playlist_dir_fs;
|
2008-10-31 16:47:14 +01:00
|
|
|
}
|
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
AllocatedPath
|
2009-01-01 19:17:44 +01:00
|
|
|
map_spl_utf8_to_fs(const char *name)
|
2008-10-31 16:47:14 +01:00
|
|
|
{
|
2013-01-23 19:38:09 +01:00
|
|
|
if (playlist_dir_fs.IsNull())
|
2013-10-17 21:59:35 +02:00
|
|
|
return AllocatedPath::Null();
|
2009-01-18 16:15:45 +01:00
|
|
|
|
2013-10-17 19:54:58 +02:00
|
|
|
std::string filename_utf8 = name;
|
|
|
|
filename_utf8.append(PLAYLIST_FILE_SUFFIX);
|
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
const auto filename_fs =
|
|
|
|
AllocatedPath::FromUTF8(filename_utf8.c_str());
|
2013-01-17 00:56:57 +01:00
|
|
|
if (filename_fs.IsNull())
|
2013-10-17 21:59:35 +02:00
|
|
|
return AllocatedPath::Null();
|
2009-01-01 19:17:44 +01:00
|
|
|
|
2013-10-17 21:59:35 +02:00
|
|
|
return AllocatedPath::Build(playlist_dir_fs, filename_fs);
|
2008-10-31 16:47:14 +01:00
|
|
|
}
|