You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
142 lines
3.2 KiB
C++
142 lines
3.2 KiB
C++
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
// Copyright The Music Player Daemon Project
|
|
|
|
#ifndef MPD_SIMPLE_DATABASE_PLUGIN_HXX
|
|
#define MPD_SIMPLE_DATABASE_PLUGIN_HXX
|
|
|
|
#include "ExportedSong.hxx"
|
|
#include "db/Interface.hxx"
|
|
#include "db/Ptr.hxx"
|
|
#include "fs/AllocatedPath.hxx"
|
|
#include "util/Manual.hxx"
|
|
#include "config.h"
|
|
|
|
#include <cassert>
|
|
|
|
struct ConfigBlock;
|
|
struct Directory;
|
|
struct DatabasePlugin;
|
|
class EventLoop;
|
|
class DatabaseListener;
|
|
class PrefixedLightSong;
|
|
|
|
class SimpleDatabase : public Database {
|
|
const AllocatedPath path;
|
|
std::string path_utf8;
|
|
|
|
/**
|
|
* The path where cache files for Mount() are located.
|
|
*/
|
|
const AllocatedPath cache_path;
|
|
|
|
Directory *root;
|
|
|
|
std::chrono::system_clock::time_point mtime;
|
|
|
|
/**
|
|
* A buffer for GetSong() when prefixing the #LightSong
|
|
* instance from a mounted #Database.
|
|
*/
|
|
mutable PrefixedLightSong *prefixed_light_song = nullptr;
|
|
|
|
/**
|
|
* A buffer for GetSong().
|
|
*/
|
|
mutable Manual<ExportedSong> exported_song;
|
|
|
|
#ifndef NDEBUG
|
|
mutable unsigned borrowed_song_count;
|
|
#endif
|
|
|
|
#ifdef ENABLE_ZLIB
|
|
const bool compress;
|
|
#endif
|
|
|
|
const bool hide_playlist_targets;
|
|
|
|
public:
|
|
SimpleDatabase(const ConfigBlock &block);
|
|
SimpleDatabase(AllocatedPath &&_path, bool _compress,
|
|
bool _hide_playlist_targets) noexcept;
|
|
|
|
static DatabasePtr Create(EventLoop &main_event_loop,
|
|
EventLoop &io_event_loop,
|
|
DatabaseListener &listener,
|
|
const ConfigBlock &block);
|
|
|
|
[[gnu::pure]]
|
|
Directory &GetRoot() noexcept {
|
|
assert(root != NULL);
|
|
|
|
return *root;
|
|
}
|
|
|
|
bool HasCache() const noexcept {
|
|
return !cache_path.IsNull();
|
|
}
|
|
|
|
void Save();
|
|
|
|
/**
|
|
* Returns true if there is a valid database file on the disk.
|
|
*/
|
|
bool FileExists() const {
|
|
return mtime >= std::chrono::system_clock::time_point(std::chrono::system_clock::duration::zero());
|
|
}
|
|
|
|
/**
|
|
* @param db the #Database to be mounted; must be "open"; on
|
|
* success, this object gains ownership of the given #Database
|
|
*/
|
|
[[gnu::nonnull]]
|
|
void Mount(const char *uri, DatabasePtr db);
|
|
|
|
/**
|
|
* Throws #std::runtime_error on error.
|
|
*
|
|
* @return false if the mounted database needs to be updated
|
|
*/
|
|
[[gnu::nonnull]]
|
|
bool Mount(const char *local_uri, const char *storage_uri);
|
|
|
|
[[gnu::nonnull]]
|
|
bool Unmount(const char *uri) noexcept;
|
|
|
|
/* virtual methods from class Database */
|
|
void Open() override;
|
|
void Close() noexcept override;
|
|
|
|
const LightSong *GetSong(std::string_view uri_utf8) const override;
|
|
void ReturnSong(const LightSong *song) const noexcept override;
|
|
|
|
void Visit(const DatabaseSelection &selection,
|
|
VisitDirectory visit_directory,
|
|
VisitSong visit_song,
|
|
VisitPlaylist visit_playlist) const override;
|
|
|
|
RecursiveMap<std::string> CollectUniqueTags(const DatabaseSelection &selection,
|
|
std::span<const TagType> tag_types) const override;
|
|
|
|
DatabaseStats GetStats(const DatabaseSelection &selection) const override;
|
|
|
|
std::chrono::system_clock::time_point GetUpdateStamp() const noexcept override {
|
|
return mtime;
|
|
}
|
|
|
|
private:
|
|
void Configure(const ConfigBlock &block);
|
|
|
|
void Check() const;
|
|
|
|
/**
|
|
* Throws #std::runtime_error on error.
|
|
*/
|
|
void Load();
|
|
|
|
DatabasePtr LockUmountSteal(const char *uri) noexcept;
|
|
};
|
|
|
|
extern const DatabasePlugin simple_db_plugin;
|
|
|
|
#endif
|