2018-02-27 18:06:05 +01:00
|
|
|
/*
|
|
|
|
* Strawberry Music Player
|
|
|
|
* This file was part of Clementine.
|
|
|
|
* Copyright 2010, David Sansome <me@davidsansome.com>
|
2019-08-11 22:30:28 +02:00
|
|
|
* Copyright 2018-2019, Jonas Kvinge <jonas@jkvinge.net>
|
2018-02-27 18:06:05 +01:00
|
|
|
*
|
|
|
|
* Strawberry 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.
|
|
|
|
*
|
|
|
|
* Strawberry 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 Strawberry. If not, see <http://www.gnu.org/licenses/>.
|
2018-08-09 18:39:44 +02:00
|
|
|
*
|
2018-02-27 18:06:05 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef COLLECTIONWATCHER_H
|
|
|
|
#define COLLECTIONWATCHER_H
|
|
|
|
|
|
|
|
#include "config.h"
|
|
|
|
|
2018-05-01 00:41:33 +02:00
|
|
|
#include <QtGlobal>
|
2018-02-27 18:06:05 +01:00
|
|
|
#include <QObject>
|
2018-05-01 00:41:33 +02:00
|
|
|
#include <QHash>
|
2018-02-27 18:06:05 +01:00
|
|
|
#include <QMap>
|
2018-05-01 00:41:33 +02:00
|
|
|
#include <QSet>
|
|
|
|
#include <QString>
|
|
|
|
#include <QStringList>
|
2020-02-08 03:40:30 +01:00
|
|
|
#include <QUrl>
|
2018-02-27 18:06:05 +01:00
|
|
|
|
2018-05-01 00:41:33 +02:00
|
|
|
#include "directory.h"
|
2018-02-27 18:06:05 +01:00
|
|
|
#include "core/song.h"
|
|
|
|
|
2020-02-08 03:40:30 +01:00
|
|
|
class QThread;
|
|
|
|
class QTimer;
|
|
|
|
|
2018-02-27 18:06:05 +01:00
|
|
|
class CollectionBackend;
|
2018-05-01 00:41:33 +02:00
|
|
|
class FileSystemWatcherInterface;
|
2018-02-27 18:06:05 +01:00
|
|
|
class TaskManager;
|
2018-05-01 00:41:33 +02:00
|
|
|
class CueParser;
|
2018-02-27 18:06:05 +01:00
|
|
|
|
|
|
|
class CollectionWatcher : public QObject {
|
|
|
|
Q_OBJECT
|
|
|
|
|
|
|
|
public:
|
2020-04-07 16:49:15 +02:00
|
|
|
explicit CollectionWatcher(Song::Source source, QObject *parent = nullptr);
|
2018-02-27 18:06:05 +01:00
|
|
|
|
|
|
|
void set_backend(CollectionBackend *backend) { backend_ = backend; }
|
|
|
|
void set_task_manager(TaskManager *task_manager) { task_manager_ = task_manager; }
|
|
|
|
void set_device_name(const QString& device_name) { device_name_ = device_name; }
|
|
|
|
|
|
|
|
void IncrementalScanAsync();
|
|
|
|
void FullScanAsync();
|
2019-06-30 21:06:07 +02:00
|
|
|
void RescanTracksAsync(const SongList &songs);
|
2018-02-27 18:06:05 +01:00
|
|
|
void SetRescanPausedAsync(bool pause);
|
|
|
|
void ReloadSettingsAsync();
|
|
|
|
|
|
|
|
void Stop() { stop_requested_ = true; }
|
|
|
|
|
2019-07-24 19:16:51 +02:00
|
|
|
void ExitAsync();
|
|
|
|
|
2020-04-07 16:49:15 +02:00
|
|
|
signals:
|
2018-02-27 18:06:05 +01:00
|
|
|
void NewOrUpdatedSongs(const SongList &songs);
|
|
|
|
void SongsMTimeUpdated(const SongList &songs);
|
|
|
|
void SongsDeleted(const SongList &songs);
|
2019-08-11 22:30:28 +02:00
|
|
|
void SongsUnavailable(const SongList &songs);
|
2018-02-27 18:06:05 +01:00
|
|
|
void SongsReadded(const SongList &songs, bool unavailable = false);
|
|
|
|
void SubdirsDiscovered(const SubdirectoryList &subdirs);
|
|
|
|
void SubdirsMTimeUpdated(const SubdirectoryList &subdirs);
|
|
|
|
void CompilationsNeedUpdating();
|
2019-07-24 19:16:51 +02:00
|
|
|
void ExitFinished();
|
2018-02-27 18:06:05 +01:00
|
|
|
|
|
|
|
void ScanStarted(int task_id);
|
|
|
|
|
|
|
|
public slots:
|
|
|
|
void ReloadSettings();
|
|
|
|
void AddDirectory(const Directory &dir, const SubdirectoryList &subdirs);
|
|
|
|
void RemoveDirectory(const Directory &dir);
|
|
|
|
void SetRescanPaused(bool pause);
|
|
|
|
|
|
|
|
private:
|
|
|
|
// This class encapsulates a full or partial scan of a directory.
|
2018-05-01 00:41:33 +02:00
|
|
|
// Each directory has one or more subdirectories, and any number of subdirectories can be scanned during one transaction.
|
|
|
|
// ScanSubdirectory() adds its results to the members of this transaction class,
|
|
|
|
// and they are "committed" through calls to the CollectionBackend in the transaction's dtor.
|
|
|
|
// The transaction also caches the list of songs in this directory according to the collection.
|
|
|
|
// Multiple calls to FindSongsInSubdirectory during one transaction will only result in one call to CollectionBackend::FindSongsInDirectory.
|
2018-02-27 18:06:05 +01:00
|
|
|
class ScanTransaction {
|
|
|
|
public:
|
2019-08-11 22:30:28 +02:00
|
|
|
ScanTransaction(CollectionWatcher *watcher, const int dir, const bool incremental, const bool ignores_mtime, const bool mark_songs_unavailable);
|
2018-02-27 18:06:05 +01:00
|
|
|
~ScanTransaction();
|
|
|
|
|
|
|
|
SongList FindSongsInSubdirectory(const QString &path);
|
|
|
|
bool HasSeenSubdir(const QString &path);
|
|
|
|
void SetKnownSubdirs(const SubdirectoryList &subdirs);
|
|
|
|
SubdirectoryList GetImmediateSubdirs(const QString &path);
|
|
|
|
SubdirectoryList GetAllSubdirs();
|
|
|
|
|
|
|
|
void AddToProgress(int n = 1);
|
|
|
|
void AddToProgressMax(int n);
|
|
|
|
|
2019-06-30 21:06:07 +02:00
|
|
|
// Emits the signals for new & deleted songs etc and clears the lists. This causes the new stuff to be updated on UI.
|
|
|
|
void CommitNewOrUpdatedSongs();
|
|
|
|
|
2018-02-27 18:06:05 +01:00
|
|
|
int dir() const { return dir_; }
|
|
|
|
bool is_incremental() const { return incremental_; }
|
|
|
|
bool ignores_mtime() const { return ignores_mtime_; }
|
|
|
|
|
|
|
|
SongList deleted_songs;
|
|
|
|
SongList readded_songs;
|
|
|
|
SongList new_songs;
|
|
|
|
SongList touched_songs;
|
|
|
|
SubdirectoryList new_subdirs;
|
|
|
|
SubdirectoryList touched_subdirs;
|
2019-08-05 18:40:47 +02:00
|
|
|
SubdirectoryList deleted_subdirs;
|
2018-02-27 18:06:05 +01:00
|
|
|
|
|
|
|
private:
|
|
|
|
ScanTransaction(const ScanTransaction&) {}
|
|
|
|
ScanTransaction& operator=(const ScanTransaction&) { return *this; }
|
|
|
|
|
|
|
|
int task_id_;
|
|
|
|
int progress_;
|
|
|
|
int progress_max_;
|
|
|
|
|
|
|
|
int dir_;
|
|
|
|
// Incremental scan enters a directory only if it has changed since the last scan.
|
|
|
|
bool incremental_;
|
2018-05-01 00:41:33 +02:00
|
|
|
// This type of scan updates every file in a folder that's being scanned.
|
|
|
|
// Even if it detects the file hasn't changed since the last scan.
|
|
|
|
// Also, since it's ignoring mtimes on folders too, it will go as deep in the folder hierarchy as it's possible.
|
2018-02-27 18:06:05 +01:00
|
|
|
bool ignores_mtime_;
|
|
|
|
|
2019-06-30 21:06:07 +02:00
|
|
|
// Set this to true to prevent deleting missing files from database.
|
|
|
|
// Useful for unstable network connections.
|
2019-08-11 22:30:28 +02:00
|
|
|
bool mark_songs_unavailable_;
|
2019-06-30 21:06:07 +02:00
|
|
|
|
2018-02-27 18:06:05 +01:00
|
|
|
CollectionWatcher *watcher_;
|
|
|
|
|
|
|
|
SongList cached_songs_;
|
|
|
|
bool cached_songs_dirty_;
|
|
|
|
|
|
|
|
SubdirectoryList known_subdirs_;
|
|
|
|
bool known_subdirs_dirty_;
|
|
|
|
};
|
|
|
|
|
|
|
|
private slots:
|
2019-07-24 19:16:51 +02:00
|
|
|
void Exit();
|
2018-02-27 18:06:05 +01:00
|
|
|
void DirectoryChanged(const QString &path);
|
|
|
|
void IncrementalScanNow();
|
|
|
|
void FullScanNow();
|
2019-06-30 21:06:07 +02:00
|
|
|
void RescanTracksNow();
|
2018-02-27 18:06:05 +01:00
|
|
|
void RescanPathsNow();
|
|
|
|
void ScanSubdirectory(const QString &path, const Subdirectory &subdir, ScanTransaction *t, bool force_noincremental = false);
|
|
|
|
|
|
|
|
private:
|
|
|
|
static bool FindSongByPath(const SongList &list, const QString &path, Song *out);
|
|
|
|
inline static QString NoExtensionPart(const QString &fileName);
|
|
|
|
inline static QString ExtensionPart(const QString &fileName);
|
|
|
|
inline static QString DirectoryPart(const QString &fileName);
|
|
|
|
QString PickBestImage(const QStringList &images);
|
2019-07-07 21:14:24 +02:00
|
|
|
QUrl ImageForSong(const QString &path, QMap<QString, QStringList> &album_art);
|
2018-02-27 18:06:05 +01:00
|
|
|
void AddWatch(const Directory &dir, const QString &path);
|
2019-08-05 18:40:47 +02:00
|
|
|
void RemoveWatch(const Directory &dir, const Subdirectory &subdir);
|
2018-02-27 18:06:05 +01:00
|
|
|
uint GetMtimeForCue(const QString &cue_path);
|
|
|
|
void PerformScan(bool incremental, bool ignore_mtimes);
|
|
|
|
|
2018-05-01 00:41:33 +02:00
|
|
|
// Updates the sections of a cue associated and altered (according to mtime) media file during a scan.
|
2019-07-07 21:14:24 +02:00
|
|
|
void UpdateCueAssociatedSongs(const QString &file, const QString &path, const QString &matching_cue, const QUrl &image, ScanTransaction *t);
|
2018-05-01 00:41:33 +02:00
|
|
|
// Updates a single non-cue associated and altered (according to mtime) song during a scan.
|
2019-07-07 21:14:24 +02:00
|
|
|
void UpdateNonCueAssociatedSong(const QString &file, const Song &matching_song, const QUrl &image, bool cue_deleted, ScanTransaction *t);
|
2018-05-01 00:41:33 +02:00
|
|
|
// Updates a new song with some metadata taken from it's equivalent old song (for example rating and score).
|
2019-07-07 21:14:24 +02:00
|
|
|
void PreserveUserSetData(const QString &file, const QUrl &image, const Song &matching_song, Song *out, ScanTransaction *t);
|
2018-02-27 18:06:05 +01:00
|
|
|
// Scans a single media file that's present on the disk but not yet in the collection.
|
2018-05-01 00:41:33 +02:00
|
|
|
// It may result in a multiple files added to the collection when the media file has many sections (like a CUE related media file).
|
2018-02-27 18:06:05 +01:00
|
|
|
SongList ScanNewFile(const QString &file, const QString &path, const QString &matching_cue, QSet<QString> *cues_processed);
|
|
|
|
|
|
|
|
private:
|
2019-04-08 23:00:07 +02:00
|
|
|
Song::Source source_;
|
2018-02-27 18:06:05 +01:00
|
|
|
CollectionBackend *backend_;
|
|
|
|
TaskManager *task_manager_;
|
|
|
|
QString device_name_;
|
|
|
|
|
|
|
|
FileSystemWatcherInterface *fs_watcher_;
|
|
|
|
QHash<QString, Directory> subdir_mapping_;
|
|
|
|
|
2018-05-01 00:41:33 +02:00
|
|
|
// A list of words use to try to identify the (likely) best image found in an directory to use as cover artwork.
|
|
|
|
// e.g. using ["front", "cover"] would identify front.jpg and exclude back.jpg.
|
2018-02-27 18:06:05 +01:00
|
|
|
QStringList best_image_filters_;
|
|
|
|
|
|
|
|
bool scan_on_startup_;
|
|
|
|
bool monitor_;
|
2019-08-11 22:30:28 +02:00
|
|
|
bool mark_songs_unavailable_;
|
2019-06-30 21:06:07 +02:00
|
|
|
bool live_scanning_;
|
|
|
|
|
|
|
|
bool stop_requested_;
|
|
|
|
bool rescan_in_progress_; // True if RescanTracksNow() has been called and is working.
|
2018-02-27 18:06:05 +01:00
|
|
|
|
|
|
|
QMap<int, Directory> watched_dirs_;
|
|
|
|
QTimer *rescan_timer_;
|
|
|
|
QMap<int, QStringList> rescan_queue_; // dir id -> list of subdirs to be scanned
|
|
|
|
bool rescan_paused_;
|
|
|
|
|
|
|
|
int total_watches_;
|
|
|
|
|
|
|
|
CueParser *cue_parser_;
|
|
|
|
|
|
|
|
static QStringList sValidImages;
|
2019-06-30 21:06:07 +02:00
|
|
|
|
|
|
|
SongList song_rescan_queue_; // Set by ui thread
|
|
|
|
|
2019-07-24 19:16:51 +02:00
|
|
|
QThread *original_thread_;
|
|
|
|
|
2018-02-27 18:06:05 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
inline QString CollectionWatcher::NoExtensionPart(const QString& fileName) {
|
|
|
|
return fileName.contains('.') ? fileName.section('.', 0, -2) : "";
|
|
|
|
}
|
|
|
|
// Thanks Amarok
|
|
|
|
inline QString CollectionWatcher::ExtensionPart(const QString& fileName) {
|
|
|
|
return fileName.contains( '.' ) ? fileName.mid( fileName.lastIndexOf('.') + 1 ).toLower() : "";
|
|
|
|
}
|
|
|
|
inline QString CollectionWatcher::DirectoryPart(const QString& fileName) {
|
|
|
|
return fileName.section('/', 0, -2);
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif // COLLECTIONWATCHER_H
|
|
|
|
|