mpd/src/db/update/Walk.cxx

503 lines
12 KiB
C++
Raw Normal View History

/*
2020-01-18 19:22:19 +01:00
* Copyright 2003-2020 The Music Player Daemon Project
* http://www.musicpd.org
*
* 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.
*
* 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.
*/
#include "Walk.hxx"
2013-01-02 19:22:15 +01:00
#include "UpdateIO.hxx"
#include "Editor.hxx"
#include "UpdateDomain.hxx"
2014-01-24 16:18:50 +01:00
#include "db/DatabaseLock.hxx"
#include "db/Uri.hxx"
2014-02-26 09:17:41 +01:00
#include "db/plugins/simple/Directory.hxx"
#include "db/plugins/simple/Song.hxx"
#include "storage/StorageInterface.hxx"
2013-01-03 09:51:35 +01:00
#include "ExcludeList.hxx"
#include "fs/AllocatedPath.hxx"
#include "fs/Traits.hxx"
2013-02-02 15:23:57 +01:00
#include "fs/FileSystem.hxx"
#include "storage/FileInfo.hxx"
#include "input/InputStream.hxx"
#include "input/Error.hxx"
#include "util/Alloc.hxx"
#include "util/StringCompare.hxx"
2019-08-09 15:54:13 +02:00
#include "util/UriExtract.hxx"
#include "Log.hxx"
#include <cassert>
#include <cerrno>
2019-07-05 09:59:00 +02:00
#include <exception>
#include <memory>
#include <string.h>
#include <stdlib.h>
UpdateWalk::UpdateWalk(const UpdateConfig &_config,
EventLoop &_loop, DatabaseListener &_listener,
2018-01-21 11:22:17 +01:00
Storage &_storage) noexcept
:config(_config), cancel(false),
storage(_storage),
editor(_loop, _listener)
{
}
static void
directory_set_stat(Directory &dir, const StorageFileInfo &info)
{
dir.inode = info.inode;
dir.device = info.device;
}
inline void
UpdateWalk::RemoveExcludedFromDirectory(Directory &directory,
2018-01-21 11:22:17 +01:00
const ExcludeList &exclude_list) noexcept
2009-10-16 18:11:43 +02:00
{
2015-12-15 23:27:05 +01:00
const ScopeDatabaseLock protect;
directory.ForEachChildSafe([&](Directory &child){
2020-10-27 19:02:46 +01:00
const auto name_fs =
AllocatedPath::FromUTF8(child.GetName());
2020-10-27 19:02:46 +01:00
if (name_fs.IsNull() || exclude_list.Check(name_fs)) {
editor.DeleteDirectory(&child);
modified = true;
}
});
directory.ForEachSongSafe([&](Song &song){
2020-10-27 19:02:46 +01:00
assert(&song.parent == &directory);
const auto name_fs = AllocatedPath::FromUTF8(song.filename);
if (name_fs.IsNull() || exclude_list.Check(name_fs)) {
editor.DeleteSong(directory, &song);
modified = true;
}
});
}
inline void
2018-01-21 11:22:17 +01:00
UpdateWalk::PurgeDeletedFromDirectory(Directory &directory) noexcept
{
directory.ForEachChildSafe([&](Directory &child){
if (child.IsMount())
2020-10-28 14:23:01 +01:00
/* mount points are always preserved */
return;
if (DirectoryExists(storage, child) &&
child.IsPluginAvailable())
2020-10-27 19:02:46 +01:00
return;
2020-10-28 14:23:01 +01:00
/* the directory was deleted (or the plugin which
handles this "virtual" directory is unavailable) */
2020-10-27 19:02:46 +01:00
editor.LockDeleteDirectory(&child);
2020-10-27 19:02:46 +01:00
modified = true;
});
directory.ForEachSongSafe([&](Song &song){
2020-10-27 19:02:46 +01:00
if (!directory_child_is_regular(storage, directory,
song.filename) ||
!song.IsPluginAvailable()) {
/* the song file was deleted (or the decoder
plugin is unavailable) */
2020-10-27 19:02:46 +01:00
editor.LockDeleteSong(directory, &song);
2020-10-27 19:02:46 +01:00
modified = true;
}
});
2013-10-19 18:48:38 +02:00
for (auto i = directory.playlists.begin(),
end = directory.playlists.end();
2013-01-02 22:16:52 +01:00
i != end;) {
if (!directory_child_is_regular(storage, directory, i->name)) {
2015-12-15 23:27:05 +01:00
const ScopeDatabaseLock protect;
2013-10-19 18:48:38 +02:00
i = directory.playlists.erase(i);
2013-01-02 22:16:52 +01:00
} else
++i;
}
}
#ifndef _WIN32
static bool
2018-01-21 11:22:17 +01:00
update_directory_stat(Storage &storage, Directory &directory) noexcept
{
StorageFileInfo info;
if (!GetInfo(storage, directory.GetPath(), info))
return false;
directory_set_stat(directory, info);
return true;
}
#endif
/**
* Check the ancestors of the given #Directory and see if there's one
* with the same device/inode number, building a loop.
*
* @return 1 if a loop was found, 0 if not, -1 on I/O error
*/
static int
FindAncestorLoop(Storage &storage, Directory *parent,
2018-01-21 11:22:17 +01:00
unsigned inode, unsigned device) noexcept
{
#ifndef _WIN32
if (device == 0 && inode == 0)
/* can't detect loops if the Storage does not support
these numbers */
return 0;
while (parent) {
if (parent->device == 0 && parent->inode == 0 &&
!update_directory_stat(storage, *parent))
return -1;
2012-06-13 20:48:30 +02:00
if (parent->inode == inode && parent->device == device) {
LogDebug(update_domain, "recursive directory found");
return 1;
}
2012-06-13 20:48:30 +02:00
parent = parent->parent;
}
#else
(void)storage;
(void)parent;
(void)inode;
(void)device;
#endif
return 0;
}
inline bool
UpdateWalk::UpdateRegularFile(Directory &directory,
2018-01-21 11:22:17 +01:00
const char *name,
const StorageFileInfo &info) noexcept
{
const char *suffix = uri_get_suffix(name);
2013-10-19 18:19:03 +02:00
if (suffix == nullptr)
return false;
return UpdateSongFile(directory, name, suffix, info) ||
UpdateArchiveFile(directory, name, suffix, info) ||
UpdatePlaylistFile(directory, name, suffix, info);
}
void
UpdateWalk::UpdateDirectoryChild(Directory &directory,
const ExcludeList &exclude_list,
2018-01-21 11:22:17 +01:00
const char *name, const StorageFileInfo &info) noexcept
try {
assert(std::strchr(name, '/') == nullptr);
if (info.IsRegular()) {
UpdateRegularFile(directory, name, info);
} else if (info.IsDirectory()) {
if (FindAncestorLoop(storage, &directory,
info.inode, info.device))
return;
2015-12-15 23:27:05 +01:00
Directory *subdir;
{
const ScopeDatabaseLock protect;
subdir = directory.MakeChild(name);
}
2013-10-19 18:48:38 +02:00
assert(&directory == subdir->parent);
if (!UpdateDirectory(*subdir, exclude_list, info))
editor.LockDeleteDirectory(subdir);
} else {
FormatDebug(update_domain,
"%s is not a directory, archive or music", name);
}
} catch (...) {
LogError(std::current_exception());
}
/* we don't look at files with newlines in their name */
2013-08-04 23:48:01 +02:00
gcc_pure
static bool
skip_path(const char *name_utf8) noexcept
{
return std::strchr(name_utf8, '\n') != nullptr;
}
2013-08-04 23:48:01 +02:00
gcc_pure
bool
UpdateWalk::SkipSymlink(const Directory *directory,
std::string_view utf8_name) const noexcept
{
#ifndef _WIN32
const auto path_fs = storage.MapChildFS(directory->GetPath(),
utf8_name);
if (path_fs.IsNull())
/* not a local file: don't skip */
return false;
const auto target = ReadLink(path_fs);
if (target.IsNull())
/* don't skip if this is not a symlink */
return errno != EINVAL;
if (!config.follow_inside_symlinks &&
!config.follow_outside_symlinks) {
/* ignore all symlinks */
return true;
} else if (config.follow_inside_symlinks &&
config.follow_outside_symlinks) {
/* consider all symlinks */
return false;
}
if (target.IsAbsolute()) {
/* if the symlink points to an absolute path, see if
that path is inside the music directory */
const auto target_utf8 = target.ToUTF8();
if (target_utf8.empty())
return true;
auto relative =
storage.MapToRelativeUTF8(target_utf8.c_str());
return relative.data() != nullptr
? !config.follow_inside_symlinks
: !config.follow_outside_symlinks;
}
const char *p = target.c_str();
while (*p == '.') {
if (p[1] == '.' && PathTraitsFS::IsSeparator(p[2])) {
/* "../" moves to parent directory */
directory = directory->parent;
2013-10-19 18:19:03 +02:00
if (directory == nullptr) {
/* we have moved outside the music
directory - skip this symlink
if such symlinks are not allowed */
return !config.follow_outside_symlinks;
}
p += 3;
} else if (PathTraitsFS::IsSeparator(p[1]))
/* eliminate "./" */
p += 2;
else
break;
}
/* we are still in the music directory, so this symlink points
to a song which is already in the database - skip according
to the follow_inside_symlinks param*/
return !config.follow_inside_symlinks;
#else
/* no symlink checking on WIN32 */
(void)directory;
(void)utf8_name;
return false;
#endif
}
bool
UpdateWalk::UpdateDirectory(Directory &directory,
const ExcludeList &exclude_list,
2018-01-21 11:22:17 +01:00
const StorageFileInfo &info) noexcept
{
assert(info.IsDirectory());
directory_set_stat(directory, info);
std::unique_ptr<StorageDirectoryReader> reader;
try {
reader = storage.OpenDirectory(directory.GetPath());
} catch (...) {
LogError(std::current_exception());
return false;
}
ExcludeList child_exclude_list(exclude_list);
try {
Mutex mutex;
auto is = InputStream::OpenReady(storage.MapUTF8(PathTraitsUTF8::Build(directory.GetPath(),
2020-07-06 20:45:29 +02:00
".mpdignore")).c_str(),
2018-07-06 19:41:53 +02:00
mutex);
child_exclude_list.Load(std::move(is));
} catch (...) {
if (!IsFileNotFound(std::current_exception()))
LogError(std::current_exception());
}
if (!child_exclude_list.IsEmpty())
RemoveExcludedFromDirectory(directory, child_exclude_list);
2009-10-16 18:11:43 +02:00
PurgeDeletedFromDirectory(directory);
const char *name_utf8;
while (!cancel && (name_utf8 = reader->Read()) != nullptr) {
if (skip_path(name_utf8))
continue;
{
const auto name_fs = AllocatedPath::FromUTF8(name_utf8);
if (name_fs.IsNull() || child_exclude_list.Check(name_fs))
continue;
}
if (SkipSymlink(&directory, name_utf8)) {
modified |= editor.DeleteNameIn(directory, name_utf8);
continue;
}
StorageFileInfo info2;
if (!GetInfo(*reader, info2)) {
modified |= editor.DeleteNameIn(directory, name_utf8);
continue;
}
UpdateDirectoryChild(directory, child_exclude_list, name_utf8, info2);
}
directory.mtime = info.mtime;
return true;
}
inline Directory *
UpdateWalk::DirectoryMakeChildChecked(Directory &parent,
const char *uri_utf8,
std::string_view name_utf8) noexcept
{
2015-12-15 23:27:05 +01:00
Directory *directory;
{
const ScopeDatabaseLock protect;
directory = parent.FindChild(name_utf8);
}
2012-06-13 20:48:30 +02:00
if (directory != nullptr) {
if (directory->IsMount())
directory = nullptr;
return directory;
}
StorageFileInfo info;
if (!GetInfo(storage, uri_utf8, info) ||
FindAncestorLoop(storage, &parent, info.inode, info.device))
2013-10-19 18:19:03 +02:00
return nullptr;
if (SkipSymlink(&parent, name_utf8))
2013-10-19 18:19:03 +02:00
return nullptr;
/* if we're adding directory paths, make sure to delete filenames
with potentially the same name */
2015-12-15 23:27:05 +01:00
{
const ScopeDatabaseLock protect;
Song *conflicting = parent.FindSong(name_utf8);
if (conflicting)
editor.DeleteSong(parent, conflicting);
2015-12-15 23:27:05 +01:00
directory = parent.CreateChild(name_utf8);
}
directory_set_stat(*directory, info);
return directory;
}
inline Directory *
2018-01-21 11:22:17 +01:00
UpdateWalk::DirectoryMakeUriParentChecked(Directory &root,
std::string_view _uri) noexcept
{
Directory *directory = &root;
StringView uri(_uri);
while (true) {
auto s = uri.Split('/');
const std::string_view name = s.first;
const auto rest = s.second;
if (rest == nullptr)
break;
if (!name.empty()) {
directory = DirectoryMakeChildChecked(*directory,
std::string(name).c_str(),
s.first);
if (directory == nullptr)
break;
}
uri = s.second;
}
return directory;
}
inline void
2018-01-21 11:22:17 +01:00
UpdateWalk::UpdateUri(Directory &root, const char *uri) noexcept
try {
Directory *parent = DirectoryMakeUriParentChecked(root, uri);
2013-10-19 18:19:03 +02:00
if (parent == nullptr)
return;
const char *name = PathTraitsUTF8::GetBase(uri);
if (SkipSymlink(parent, name)) {
modified |= editor.DeleteNameIn(*parent, name);
return;
}
StorageFileInfo info;
if (!GetInfo(storage, uri, info)) {
modified |= editor.DeleteNameIn(*parent, name);
return;
}
ExcludeList exclude_list;
UpdateDirectoryChild(*parent, exclude_list, name, info);
} catch (...) {
LogError(std::current_exception());
}
bool
2018-01-21 11:22:17 +01:00
UpdateWalk::Walk(Directory &root, const char *path, bool discard) noexcept
{
walk_discard = discard;
modified = false;
2013-10-19 18:19:03 +02:00
if (path != nullptr && !isRootDirectory(path)) {
UpdateUri(root, path);
} else {
StorageFileInfo info;
if (!GetInfo(storage, "", info))
return false;
if (!info.IsDirectory()) {
FormatError(update_domain, "Not a directory: %s",
storage.MapUTF8("").c_str());
return false;
}
ExcludeList exclude_list;
UpdateDirectory(root, exclude_list, info);
}
return modified;
}