Reload cover resources when the database has been updated

src/libs/scanner/CMakeLists.txt

@@ -1,8 +1,8 @@
 
 add_library(lmsscanner SHARED
 	impl/AcousticBrainzUtils.cpp
-	impl/MediaScanner.cpp
-	impl/MediaScannerStats.cpp
+	impl/Scanner.cpp
+	impl/ScannerStats.cpp
 	)
 
 target_include_directories(lmsscanner INTERFACE

src/libs/scanner/impl/Scanner.cpp

@@ -17,7 +17,7 @@
  * along with LMS.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "MediaScanner.hpp"
+#include "Scanner.hpp"
 
 #include <ctime>
 #include <boost/asio/placeholders.hpp>
@@ -242,13 +242,13 @@ getOrCreateClusters(Session& session, const MetaData::Clusters& clustersNames)
 
 namespace Scanner {
 
-std::unique_ptr<IMediaScanner>
-createMediaScanner(Database::Db& db, Recommendation::IEngine& recommendationEngine)
+std::unique_ptr<IScanner>
+createScanner(Database::Db& db, Recommendation::IEngine& recommendationEngine)
 {
-	return std::make_unique<MediaScanner>(db, recommendationEngine);
+	return std::make_unique<Scanner>(db, recommendationEngine);
 }
 
-MediaScanner::MediaScanner(Database::Db& db, Recommendation::IEngine& recommendationEngine)
+Scanner::Scanner(Database::Db& db, Recommendation::IEngine& recommendationEngine)
 : _recommendationEngine {recommendationEngine}
 , _dbSession {db}
 {
@@ -262,14 +262,14 @@ MediaScanner::MediaScanner(Database::Db& db, Recommendation::IEngine& recommenda
 	start();
 }
 
-MediaScanner::~MediaScanner()
+Scanner::~Scanner()
 {
-	LMS_LOG(DBUPDATER, INFO) << "Shutting down MediaScanner...";
+	LMS_LOG(DBUPDATER, INFO) << "Shutting down Scanner...";
 	stop();
 }
 
 void
-MediaScanner::start()
+Scanner::start()
 {
 	std::scoped_lock lock {_controlMutex};
 
@@ -290,7 +290,7 @@ MediaScanner::start()
 }
 
 void
-MediaScanner::stop()
+Scanner::stop()
 {
 	std::scoped_lock lock {_controlMutex};
 
@@ -301,7 +301,7 @@ MediaScanner::stop()
 }
 
 void
-MediaScanner::abortScan()
+Scanner::abortScan()
 {
 	LMS_LOG(DBUPDATER, DEBUG) << "Aborting scan...";
 	std::scoped_lock lock {_controlMutex};
@@ -319,7 +319,7 @@ MediaScanner::abortScan()
 }
 
 void
-MediaScanner::requestImmediateScan(bool force)
+Scanner::requestImmediateScan(bool force)
 {
 	abortScan();
 	_ioService.post([=]()
@@ -332,7 +332,7 @@ MediaScanner::requestImmediateScan(bool force)
 }
 
 void
-MediaScanner::requestReload()
+Scanner::requestReload()
 {
 	abortScan();
 	_ioService.post([=]()
@@ -344,8 +344,8 @@ MediaScanner::requestReload()
 	});
 }
 
-MediaScanner::Status
-MediaScanner::getStatus() const
+Scanner::Status
+Scanner::getStatus() const
 {
 	Status res;
 
@@ -360,7 +360,7 @@ MediaScanner::getStatus() const
 }
 
 void
-MediaScanner::scheduleNextScan()
+Scanner::scheduleNextScan()
 {
 	LMS_LOG(DBUPDATER, INFO) << "Scheduling next scan";
 
@@ -411,11 +411,11 @@ MediaScanner::scheduleNextScan()
 		_nextScheduledScan = nextScanDateTime;
 	}
 
-	_sigScheduled.emit(_nextScheduledScan);
+	_events.scanScheduled.emit(_nextScheduledScan);
 }
 
 void
-MediaScanner::countAllFiles(ScanStats& stats)
+Scanner::countAllFiles(ScanStats& stats)
 {
 	ScanStepStats stepStats{stats.startTime, ScanProgressStep::DiscoveringFiles};
 
@@ -440,7 +440,7 @@ MediaScanner::countAllFiles(ScanStats& stats)
 }
 
 void
-MediaScanner::scheduleScan(bool force, const Wt::WDateTime& dateTime)
+Scanner::scheduleScan(bool force, const Wt::WDateTime& dateTime)
 {
 	auto cb {[=](boost::system::error_code ec)
 	{
@@ -469,9 +469,9 @@ MediaScanner::scheduleScan(bool force, const Wt::WDateTime& dateTime)
 }
 
 void
-MediaScanner::scan(bool forceScan)
+Scanner::scan(bool forceScan)
 {
-	scanStarted().emit();
+	_events.scanStarted.emit();
 
 	{
 		std::unique_lock lock {_statusMutex};
@@ -517,14 +517,14 @@ MediaScanner::scan(bool forceScan)
 		{
 			std::unique_lock lock {_statusMutex};
 
-			_lastCompleteScanStats = std::move(stats);
+			_lastCompleteScanStats = stats;
 			_currentScanStepStats.reset();
 		}
 
 		LMS_LOG(DBUPDATER, DEBUG) << "Scan not aborted, scheduling next scan!";
 		scheduleNextScan();
 
-		scanComplete().emit();
+		_events.scanComplete.emit(stats);
 	}
 	else
 	{
@@ -538,7 +538,7 @@ MediaScanner::scan(bool forceScan)
 }
 
 bool
-MediaScanner::fetchTrackFeatures(Database::IdType trackId, const UUID& MBID)
+Scanner::fetchTrackFeatures(Database::IdType trackId, const UUID& MBID)
 {
 	std::map<std::string, double> features;
 
@@ -564,7 +564,7 @@ MediaScanner::fetchTrackFeatures(Database::IdType trackId, const UUID& MBID)
 }
 
 void
-MediaScanner::fetchTrackFeatures(ScanStats& stats)
+Scanner::fetchTrackFeatures(ScanStats& stats)
 {
 	if (_recommendationEngineType != ScanSettings::RecommendationEngineType::Features)
 		return;
@@ -614,7 +614,7 @@ MediaScanner::fetchTrackFeatures(ScanStats& stats)
 }
 
 void
-MediaScanner::refreshScanSettings()
+Scanner::refreshScanSettings()
 {
 	auto transaction {_dbSession.createSharedTransaction()};
 
@@ -646,7 +646,7 @@ MediaScanner::refreshScanSettings()
 }
 
 void
-MediaScanner::notifyInProgress(const ScanStepStats& stepStats)
+Scanner::notifyInProgress(const ScanStepStats& stepStats)
 {
 	{
 		std::unique_lock lock {_statusMutex};
@@ -654,12 +654,12 @@ MediaScanner::notifyInProgress(const ScanStepStats& stepStats)
 	}
 
 	const std::chrono::system_clock::time_point now {std::chrono::system_clock::now()};
-	_sigScanInProgress(stepStats);
+	_events.scanInProgress(stepStats);
 	_lastScanInProgressEmit = now;
 }
 
 void
-MediaScanner::notifyInProgressIfNeeded(const ScanStepStats& stepStats)
+Scanner::notifyInProgressIfNeeded(const ScanStepStats& stepStats)
 {
 	std::chrono::system_clock::time_point now {std::chrono::system_clock::now()};
 
@@ -668,7 +668,7 @@ MediaScanner::notifyInProgressIfNeeded(const ScanStepStats& stepStats)
 }
 
 void
-MediaScanner::scanAudioFile(const std::filesystem::path& file, bool forceScan, ScanStats& stats)
+Scanner::scanAudioFile(const std::filesystem::path& file, bool forceScan, ScanStats& stats)
 {
 	Wt::WDateTime lastWriteTime;
 	try
@@ -831,7 +831,7 @@ MediaScanner::scanAudioFile(const std::filesystem::path& file, bool forceScan, S
 }
 
 void
-MediaScanner::scanMediaDirectory(const std::filesystem::path& mediaDirectory, bool forceScan, ScanStats& stats)
+Scanner::scanMediaDirectory(const std::filesystem::path& mediaDirectory, bool forceScan, ScanStats& stats)
 {
 	ScanStepStats stepStats{stats.startTime, ScanProgressStep::ScanningFiles};
 	stepStats.totalElems = stats.filesScanned;
@@ -899,7 +899,7 @@ checkFile(const std::filesystem::path& p, const std::filesystem::path& mediaDire
 }
 
 void
-MediaScanner::removeMissingTracks(ScanStats& stats)
+Scanner::removeMissingTracks(ScanStats& stats)
 {
 	static constexpr std::size_t batchSize {50};
 
@@ -966,7 +966,7 @@ MediaScanner::removeMissingTracks(ScanStats& stats)
 }
 
 void
-MediaScanner::removeOrphanEntries()
+Scanner::removeOrphanEntries()
 {
 	LMS_LOG(DBUPDATER, DEBUG) << "Checking orphan clusters...";
 	{
@@ -1009,7 +1009,7 @@ MediaScanner::removeOrphanEntries()
 }
 
 void
-MediaScanner::checkDuplicatedAudioFiles(ScanStats& stats)
+Scanner::checkDuplicatedAudioFiles(ScanStats& stats)
 {
 	LMS_LOG(DBUPDATER, INFO) << "Checking duplicated audio files";
 
@@ -1029,7 +1029,7 @@ MediaScanner::checkDuplicatedAudioFiles(ScanStats& stats)
 }
 
 void
-MediaScanner::reloadSimilarityEngine(ScanStats& stats)
+Scanner::reloadSimilarityEngine(ScanStats& stats)
 {
 	ScanStepStats stepStats {stats.startTime, ScanProgressStep::ReloadingSimilarityEngine};
 

src/libs/scanner/impl/Scanner.hpp

@@ -33,7 +33,7 @@
 #include "database/ScanSettings.hpp"
 #include "database/Session.hpp"
 #include "metadata/IParser.hpp"
-#include "scanner/IMediaScanner.hpp"
+#include "scanner/IScanner.hpp"
 
 class UUID;
 
@@ -44,29 +44,24 @@ namespace Recommendation
 
 namespace Scanner {
 
-class MediaScanner : public IMediaScanner
+class Scanner : public IScanner
 {
 	public:
-		MediaScanner(Database::Db& db, Recommendation::IEngine& recommendationEngine);
-		~MediaScanner();
+		Scanner(Database::Db& db, Recommendation::IEngine& recommendationEngine);
+		~Scanner();
 
-		MediaScanner(const MediaScanner&) = delete;
-		MediaScanner(MediaScanner&&) = delete;
-		MediaScanner& operator=(const MediaScanner&) = delete;
-		MediaScanner& operator=(MediaScanner&&) = delete;
+		Scanner(const Scanner&) = delete;
+		Scanner(Scanner&&) = delete;
+		Scanner& operator=(const Scanner&) = delete;
+		Scanner& operator=(Scanner&&) = delete;
 
 		void requestReload() override;
 		void requestImmediateScan(bool force) override;
 
-		Status getStatus() const override;
-
-		Wt::Signal<>& scanStarted() override { return _sigScanStarted; }
-		Wt::Signal<>& scanComplete() override { return _sigScanComplete; }
-		Wt::Signal<ScanStepStats>& scanInProgress() override { return _sigScanInProgress; }
-		Wt::Signal<Wt::WDateTime>& scheduled() override { return _sigScheduled; }
+		Status	getStatus() const override;
+		Events&	getEvents() override { return _events; }
 
 	private:
-
 		void start();
 		void stop();
 
@@ -102,11 +97,8 @@ class MediaScanner : public IMediaScanner
 		std::atomic<bool>						_abortScan {};
 		Wt::WIOService							_ioService;
 		boost::asio::system_timer				_scheduleTimer {_ioService};
-		Wt::Signal<>							_sigScanStarted;
-		Wt::Signal<>							_sigScanComplete;
-		Wt::Signal<ScanStepStats>		_sigScanInProgress;
+		Events									_events;
 		std::chrono::system_clock::time_point	_lastScanInProgressEmit {};
-		Wt::Signal<Wt::WDateTime>				_sigScheduled;
 		Database::Session						_dbSession;
 		std::unique_ptr<MetaData::IParser>		_metadataParser;
 
@@ -124,7 +116,7 @@ class MediaScanner : public IMediaScanner
 		std::filesystem::path			_mediaDirectory;
 		Database::ScanSettings::RecommendationEngineType _recommendationEngineType;
 
-}; // class MediaScanner
+}; // class Scanner
 
 } // Scanner
 

src/libs/scanner/impl/ScannerStats.cpp

@@ -17,7 +17,7 @@
  * along with LMS.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "scanner/MediaScannerStats.hpp"
+#include "scanner/ScannerStats.hpp"
 
 namespace Scanner {
 

src/libs/scanner/include/scanner/IMediaScanner.hpp

@@ -1,84 +0,0 @@
-/*
- * Copyright (C) 2013 Emeric Poupon
- *
- * This file is part of LMS.
- *
- * LMS 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 3 of the License, or
- * (at your option) any later version.
- *
- * LMS 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 LMS.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#pragma once
-
-#include <optional>
-
-#include <Wt/WDateTime.h>
-#include <Wt/WSignal.h>
-
-#include "MediaScannerStats.hpp"
-
-namespace Database
-{
-	class Db;
-}
-
-namespace Recommendation
-{
-	class IEngine;
-}
-
-namespace Scanner {
-
-class IMediaScanner
-{
-	public:
-		virtual ~IMediaScanner() = default;
-
-		// Async requests
-		virtual void requestReload() = 0;
-		virtual void requestImmediateScan(bool force) = 0;
-
-		enum class State
-		{
-			NotScheduled,
-			Scheduled,
-			InProgress,
-		};
-
-		struct Status
-		{
-			State								currentState {State::NotScheduled};
-			Wt::WDateTime						nextScheduledScan;
-			std::optional<ScanStats>			lastCompleteScanStats;
-			std::optional<ScanStepStats> 		currentScanStepStats;
-		};
-
-		virtual Status getStatus() const = 0;
-
-		// Called just after scan start
-		virtual Wt::Signal<>& scanStarted() = 0;
-
-		// Called just after scan complete
-		virtual Wt::Signal<>& scanComplete() = 0;
-
-		// Called during scan in progress
-		virtual Wt::Signal<ScanStepStats>& scanInProgress() = 0;
-
-		// Called after a schedule
-		virtual Wt::Signal<Wt::WDateTime>& scheduled() = 0;
-
-};
-
-std::unique_ptr<IMediaScanner> createMediaScanner(Database::Db& db, Recommendation::IEngine& recommendationEngine);
-
-} // Scanner
-

src/libs/scanner/include/scanner/IScanner.hpp

@@ -0,0 +1,72 @@
+/*
+ * Copyright (C) 2013 Emeric Poupon
+ *
+ * This file is part of LMS.
+ *
+ * LMS 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 3 of the License, or
+ * (at your option) any later version.
+ *
+ * LMS 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 LMS.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <optional>
+
+#include "ScannerEvents.hpp"
+#include "ScannerStats.hpp"
+
+namespace Database
+{
+	class Db;
+}
+
+namespace Recommendation
+{
+	class IEngine;
+}
+
+namespace Scanner
+{
+
+	class IScanner
+	{
+		public:
+			virtual ~IScanner() = default;
+
+			// Async requests
+			virtual void requestReload() = 0;
+			virtual void requestImmediateScan(bool force) = 0;
+
+			enum class State
+			{
+				NotScheduled,
+				Scheduled,
+				InProgress,
+			};
+
+			struct Status
+			{
+				State								currentState {State::NotScheduled};
+				Wt::WDateTime						nextScheduledScan;
+				std::optional<ScanStats>			lastCompleteScanStats;
+				std::optional<ScanStepStats> 		currentScanStepStats;
+			};
+
+			virtual Status getStatus() const = 0;
+
+			virtual Events& getEvents() = 0;
+	};
+
+	std::unique_ptr<IScanner> createScanner(Database::Db& db, Recommendation::IEngine& recommendationEngine);
+
+} // Scanner
+

src/libs/scanner/include/scanner/ScannerEvents.hpp

@@ -0,0 +1,46 @@
+/*
+ * Copyright (C) 2020 Emeric Poupon
+ *
+ * This file is part of LMS.
+ *
+ * LMS 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 3 of the License, or
+ * (at your option) any later version.
+ *
+ * LMS 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 LMS.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <Wt/WDateTime.h>
+#include <Wt/WSignal.h>
+
+#include "ScannerStats.hpp"
+
+namespace Scanner
+{
+
+	struct Events
+	{
+		// Called just after scan start
+		Wt::Signal<> 				scanStarted;
+
+		// Called just after scan complete (true if changes have been made)
+		Wt::Signal<ScanStats>		scanComplete;
+
+		// Called during scan in progress
+		Wt::Signal<ScanStepStats>	scanInProgress;
+
+		// Called after a schedule
+		Wt::Signal<Wt::WDateTime>	scanScheduled;
+	};
+
+} // ns Scanner
+

src/libs/subsonic/impl/Scan.cpp

@@ -19,7 +19,7 @@
 
 #include "Scan.hpp"
 
-#include "scanner/IMediaScanner.hpp"
+#include "scanner/IScanner.hpp"
 #include "utils/Service.hpp"
 
 namespace API::Subsonic::Scan
@@ -32,10 +32,10 @@ namespace API::Subsonic::Scan
 	{
 		Response::Node statusResponse;
 
-		const IMediaScanner::Status scanStatus {Service<IMediaScanner>::get()->getStatus()};
+		const IScanner::Status scanStatus {Service<IScanner>::get()->getStatus()};
 
-		statusResponse.setAttribute("scanning", scanStatus.currentState == IMediaScanner::State::InProgress);
-		if (scanStatus.currentState == IMediaScanner::State::InProgress)
+		statusResponse.setAttribute("scanning", scanStatus.currentState == IScanner::State::InProgress);
+		if (scanStatus.currentState == IScanner::State::InProgress)
 		{
 			std::size_t count{};
 
@@ -61,7 +61,7 @@ namespace API::Subsonic::Scan
 	Response
 	handleStartScan(RequestContext& context)
 	{
-		Service<IMediaScanner>::get()->requestImmediateScan(false);
+		Service<IScanner>::get()->requestImmediateScan(false);
 
 		Response response {Response::createOkResponse(context)};
 		response.addNode("scanStatus", createStatusResponseNode());