mpd/src/db/update/Walk.hxx

158 lines
4.3 KiB
C++
Raw Normal View History

/*
2017-01-03 20:48:59 +01:00
* Copyright 2003-2017 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.
*/
#ifndef MPD_UPDATE_WALK_HXX
#define MPD_UPDATE_WALK_HXX
#include "check.h"
#include "Config.hxx"
#include "Editor.hxx"
#include "Compiler.h"
#include <atomic>
struct StorageFileInfo;
struct Directory;
struct ArchivePlugin;
class ArchiveFile;
class Storage;
class ExcludeList;
class UpdateWalk final {
#ifdef ENABLE_ARCHIVE
friend class UpdateArchiveVisitor;
#endif
const UpdateConfig config;
bool walk_discard;
bool modified;
/**
* Set to true by the main thread when the update thread shall
* cancel as quickly as possible. Access to this flag is
* unprotected.
*/
std::atomic_bool cancel;
Storage &storage;
DatabaseEditor editor;
public:
UpdateWalk(EventLoop &_loop, DatabaseListener &_listener,
2018-01-21 11:22:17 +01:00
Storage &_storage) noexcept;
/**
* Cancel the current update and quit the Walk() method as
* soon as possible.
*/
2018-01-21 11:22:17 +01:00
void Cancel() noexcept {
cancel = true;
}
/**
* Returns true if the database was modified.
*/
2018-01-21 11:22:17 +01:00
bool Walk(Directory &root, const char *path, bool discard) noexcept;
private:
gcc_pure
bool SkipSymlink(const Directory *directory,
const char *utf8_name) const noexcept;
void RemoveExcludedFromDirectory(Directory &directory,
2018-01-21 11:22:17 +01:00
const ExcludeList &exclude_list) noexcept;
2018-01-21 11:22:17 +01:00
void PurgeDeletedFromDirectory(Directory &directory) noexcept;
void UpdateSongFile2(Directory &directory,
const char *name, const char *suffix,
2018-01-21 11:22:17 +01:00
const StorageFileInfo &info) noexcept;
bool UpdateSongFile(Directory &directory,
const char *name, const char *suffix,
2018-01-21 11:22:17 +01:00
const StorageFileInfo &info) noexcept;
bool UpdateContainerFile(Directory &directory,
const char *name, const char *suffix,
2018-01-21 11:22:17 +01:00
const StorageFileInfo &info) noexcept;
#ifdef ENABLE_ARCHIVE
void UpdateArchiveTree(ArchiveFile &archive, Directory &parent,
2018-01-21 11:22:17 +01:00
const char *name) noexcept;
bool UpdateArchiveFile(Directory &directory,
const char *name, const char *suffix,
2018-01-21 11:22:17 +01:00
const StorageFileInfo &info) noexcept;
void UpdateArchiveFile(Directory &directory, const char *name,
const StorageFileInfo &info,
2018-01-21 11:22:17 +01:00
const ArchivePlugin &plugin) noexcept;
#else
bool UpdateArchiveFile(gcc_unused Directory &directory,
gcc_unused const char *name,
gcc_unused const char *suffix,
2018-01-21 11:22:17 +01:00
gcc_unused const StorageFileInfo &info) noexcept {
return false;
}
#endif
bool UpdatePlaylistFile(Directory &directory,
const char *name, const char *suffix,
2018-01-21 11:22:17 +01:00
const StorageFileInfo &info) noexcept;
bool UpdateRegularFile(Directory &directory,
2018-01-21 11:22:17 +01:00
const char *name, const StorageFileInfo &info) noexcept;
void UpdateDirectoryChild(Directory &directory,
const ExcludeList &exclude_list,
const char *name,
2018-01-21 11:22:17 +01:00
const StorageFileInfo &info) noexcept;
bool UpdateDirectory(Directory &directory,
const ExcludeList &exclude_list,
2018-01-21 11:22:17 +01:00
const StorageFileInfo &info) noexcept;
/**
* Create the specified directory object if it does not exist
2016-03-01 22:08:13 +01:00
* already or if the #StorageFileInfo object indicates that it has been
* modified since the last update. Returns nullptr when it
* exists already and is unmodified.
*
* The caller must lock the database.
*/
Directory *MakeDirectoryIfModified(Directory &parent, const char *name,
2018-01-21 11:22:17 +01:00
const StorageFileInfo &info) noexcept;
Directory *DirectoryMakeChildChecked(Directory &parent,
const char *uri_utf8,
2018-01-21 11:22:17 +01:00
const char *name_utf8) noexcept;
Directory *DirectoryMakeUriParentChecked(Directory &root,
2018-01-21 11:22:17 +01:00
const char *uri) noexcept;
2018-01-21 11:22:17 +01:00
void UpdateUri(Directory &root, const char *uri) noexcept;
};
#endif