2014-01-29 20:16:43 +01:00
|
|
|
/*
|
2017-01-03 20:48:59 +01:00
|
|
|
* Copyright 2003-2017 The Music Player Daemon Project
|
2014-01-29 20:16:43 +01:00
|
|
|
* 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"
|
2018-07-17 22:36:37 +02:00
|
|
|
#include "Config.hxx"
|
2014-01-29 20:16:43 +01:00
|
|
|
#include "Editor.hxx"
|
2014-08-30 00:46:52 +02:00
|
|
|
#include "Compiler.h"
|
2014-01-29 20:16:43 +01:00
|
|
|
|
2017-12-22 12:02:44 +01:00
|
|
|
#include <atomic>
|
|
|
|
|
2015-02-28 20:50:15 +01:00
|
|
|
struct StorageFileInfo;
|
2014-01-29 20:16:43 +01:00
|
|
|
struct Directory;
|
2014-02-08 13:22:13 +01:00
|
|
|
struct ArchivePlugin;
|
2016-02-26 15:00:41 +01:00
|
|
|
class ArchiveFile;
|
2014-02-05 17:03:43 +01:00
|
|
|
class Storage;
|
2014-01-29 20:16:43 +01:00
|
|
|
class ExcludeList;
|
|
|
|
|
|
|
|
class UpdateWalk final {
|
|
|
|
#ifdef ENABLE_ARCHIVE
|
|
|
|
friend class UpdateArchiveVisitor;
|
|
|
|
#endif
|
|
|
|
|
2018-07-17 22:36:37 +02:00
|
|
|
const UpdateConfig config;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
bool walk_discard;
|
|
|
|
bool modified;
|
|
|
|
|
2014-02-27 16:36:11 +01:00
|
|
|
/**
|
|
|
|
* Set to true by the main thread when the update thread shall
|
|
|
|
* cancel as quickly as possible. Access to this flag is
|
|
|
|
* unprotected.
|
|
|
|
*/
|
2017-12-22 12:02:44 +01:00
|
|
|
std::atomic_bool cancel;
|
2014-02-27 16:36:11 +01:00
|
|
|
|
2014-02-05 17:03:43 +01:00
|
|
|
Storage &storage;
|
2014-01-29 18:14:57 +01:00
|
|
|
|
2014-01-29 20:16:43 +01:00
|
|
|
DatabaseEditor editor;
|
|
|
|
|
|
|
|
public:
|
2014-02-05 17:50:04 +01:00
|
|
|
UpdateWalk(EventLoop &_loop, DatabaseListener &_listener,
|
2018-01-21 11:22:17 +01:00
|
|
|
Storage &_storage) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
2014-02-27 16:36:11 +01:00
|
|
|
/**
|
|
|
|
* Cancel the current update and quit the Walk() method as
|
|
|
|
* soon as possible.
|
|
|
|
*/
|
2018-01-21 11:22:17 +01:00
|
|
|
void Cancel() noexcept {
|
2014-02-27 16:36:11 +01:00
|
|
|
cancel = true;
|
|
|
|
}
|
|
|
|
|
2014-01-29 20:16:43 +01:00
|
|
|
/**
|
|
|
|
* 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;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
private:
|
|
|
|
gcc_pure
|
|
|
|
bool SkipSymlink(const Directory *directory,
|
2017-05-08 14:44:49 +02:00
|
|
|
const char *utf8_name) const noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
void RemoveExcludedFromDirectory(Directory &directory,
|
2018-01-21 11:22:17 +01:00
|
|
|
const ExcludeList &exclude_list) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
2018-01-21 11:22:17 +01:00
|
|
|
void PurgeDeletedFromDirectory(Directory &directory) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
void UpdateSongFile2(Directory &directory,
|
|
|
|
const char *name, const char *suffix,
|
2018-01-21 11:22:17 +01:00
|
|
|
const StorageFileInfo &info) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
bool UpdateSongFile(Directory &directory,
|
|
|
|
const char *name, const char *suffix,
|
2018-01-21 11:22:17 +01:00
|
|
|
const StorageFileInfo &info) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
bool UpdateContainerFile(Directory &directory,
|
|
|
|
const char *name, const char *suffix,
|
2018-01-21 11:22:17 +01:00
|
|
|
const StorageFileInfo &info) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
|
|
|
|
#ifdef ENABLE_ARCHIVE
|
2016-02-26 15:00:41 +01:00
|
|
|
void UpdateArchiveTree(ArchiveFile &archive, Directory &parent,
|
2018-01-21 11:22:17 +01:00
|
|
|
const char *name) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
bool UpdateArchiveFile(Directory &directory,
|
|
|
|
const char *name, const char *suffix,
|
2018-01-21 11:22:17 +01:00
|
|
|
const StorageFileInfo &info) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
void UpdateArchiveFile(Directory &directory, const char *name,
|
2015-02-28 20:50:15 +01:00
|
|
|
const StorageFileInfo &info,
|
2018-01-21 11:22:17 +01:00
|
|
|
const ArchivePlugin &plugin) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
|
|
|
|
#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 {
|
2014-01-29 20:16:43 +01:00
|
|
|
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;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
bool UpdateRegularFile(Directory &directory,
|
2018-01-21 11:22:17 +01:00
|
|
|
const char *name, const StorageFileInfo &info) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
void UpdateDirectoryChild(Directory &directory,
|
2015-09-29 19:39:07 +02:00
|
|
|
const ExcludeList &exclude_list,
|
2015-02-28 20:50:15 +01:00
|
|
|
const char *name,
|
2018-01-21 11:22:17 +01:00
|
|
|
const StorageFileInfo &info) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
2015-02-28 20:50:15 +01:00
|
|
|
bool UpdateDirectory(Directory &directory,
|
2015-09-29 19:39:07 +02:00
|
|
|
const ExcludeList &exclude_list,
|
2018-01-21 11:22:17 +01:00
|
|
|
const StorageFileInfo &info) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
2014-01-29 20:16:43 +01:00
|
|
|
* 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;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
|
|
|
Directory *DirectoryMakeChildChecked(Directory &parent,
|
2014-01-29 18:14:57 +01:00
|
|
|
const char *uri_utf8,
|
2018-01-21 11:22:17 +01:00
|
|
|
const char *name_utf8) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
2014-02-04 08:57:40 +01:00
|
|
|
Directory *DirectoryMakeUriParentChecked(Directory &root,
|
2018-01-21 11:22:17 +01:00
|
|
|
const char *uri) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
|
2018-01-21 11:22:17 +01:00
|
|
|
void UpdateUri(Directory &root, const char *uri) noexcept;
|
2014-01-29 20:16:43 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|