Add a factory class for Directory objects.

Create a DirectoryFactory class that is owned by the Library or Device objects
and provided to methods that need to create Directory objects. This will allow
information to be provided through the Directory object. For example:
- If the directory is on a removable device.
- A mount point that may change on future uses.
- Whether paths should be relative or absolute.

Author: jbroadus

src/core/metatypes.cpp

@@ -70,6 +70,7 @@ void RegisterMetaTypes() {
   qRegisterMetaType<GstElement*>("GstElement*");
   qRegisterMetaType<GstEngine::OutputDetails>("GstEngine::OutputDetails");
   qRegisterMetaType<GstEnginePipeline*>("GstEnginePipeline*");
+  qRegisterMetaType<DirectoryFactory*>("DirectoryFactory*");
   qRegisterMetaType<PlaylistItemList>("PlaylistItemList");
   qRegisterMetaType<PlaylistItemPtr>("PlaylistItemPtr");
   qRegisterMetaType<PodcastEpisodeList>("PodcastEpisodeList");

src/devices/connecteddevice.cpp

@@ -16,13 +16,14 @@
 */
 
 #include "connecteddevice.h"
-#include "devicelister.h"
-#include "devicemanager.h"
 #include "core/application.h"
 #include "core/database.h"
 #include "core/logging.h"
+#include "devicelister.h"
+#include "devicemanager.h"
 #include "library/library.h"
 #include "library/librarybackend.h"
+#include "library/librarydirectorymodel.h"
 #include "library/librarymodel.h"
 
 #include <QtDebug>
@@ -39,6 +40,7 @@ ConnectedDevice::ConnectedDevice(const QUrl& url, DeviceLister* lister,
       unique_id_(unique_id),
       database_id_(database_id),
       manager_(manager),
+      directory_factory_(new DirectoryFactory),
       model_(nullptr),
       song_count_(0) {
   qLog(Info) << "connected" << url << unique_id << first_time;
@@ -59,12 +61,12 @@ ConnectedDevice::ConnectedDevice(const QUrl& url, DeviceLister* lister,
   model_ = new LibraryModel(backend_, app_, this);
 }
 
-ConnectedDevice::~ConnectedDevice() {}
+ConnectedDevice::~ConnectedDevice() { delete directory_factory_; }
 
 void ConnectedDevice::InitBackendDirectory(const QString& mount_point,
                                            bool first_time, bool rewrite_path) {
-  if (first_time || backend_->GetAllDirectories().isEmpty()) {
-    backend_->AddDirectory(mount_point);
+  if (first_time || backend_->GetAllDirectories(directory_factory_).isEmpty()) {
+    backend_->AddDirectory(directory_factory_, mount_point);
   } else {
     if (rewrite_path) {
       // This is a bit of a hack.  The device might not be mounted at the same
@@ -74,7 +76,7 @@ void ConnectedDevice::InitBackendDirectory(const QString& mount_point,
 
       // Get the directory it was mounted at last time.  Devices only have one
       // directory (the root).
-      Directory dir = backend_->GetAllDirectories()[0];
+      Directory dir = backend_->GetAllDirectories(directory_factory_)[0];
       if (dir.path != mount_point) {
         // The directory is different, commence the munging.
         qLog(Info) << "Changing path from" << dir.path << "to" << mount_point;
@@ -83,7 +85,7 @@ void ConnectedDevice::InitBackendDirectory(const QString& mount_point,
     }
 
     // Load the directory properly now
-    backend_->LoadDirectoriesAsync();
+    backend_->LoadDirectoriesAsync(directory_factory_);
   }
 }
 

src/devices/connecteddevice.h

@@ -31,6 +31,7 @@ class Application;
 class Database;
 class DeviceLister;
 class DeviceManager;
+class DirectoryFactory;
 class LibraryBackend;
 class LibraryModel;
 
@@ -43,7 +44,7 @@ class ConnectedDevice : public QObject,
   ConnectedDevice(const QUrl& url, DeviceLister* lister,
                   const QString& unique_id, DeviceManager* manager,
                   Application* app, int database_id, bool first_time);
-  ~ConnectedDevice();
+  virtual ~ConnectedDevice();
 
   virtual void Init() = 0;
   virtual void ConnectAsync();
@@ -85,6 +86,7 @@ class ConnectedDevice : public QObject,
   DeviceManager* manager_;
 
   std::shared_ptr<LibraryBackend> backend_;
+  DirectoryFactory* directory_factory_;
   LibraryModel* model_;
 
   int song_count_;

src/library/directory.h

@@ -39,6 +39,17 @@ Q_DECLARE_METATYPE(Directory)
 typedef QList<Directory> DirectoryList;
 Q_DECLARE_METATYPE(DirectoryList)
 
+struct DirectoryFactory {
+  DirectoryFactory() {}
+  virtual ~DirectoryFactory() {}
+  virtual Directory GetDirectory(const QString& path) const {
+    Directory dir;
+    dir.path = path;
+    return dir;
+  }
+};
+Q_DECLARE_METATYPE(DirectoryFactory)
+
 struct Subdirectory {
   Subdirectory() : directory_id(-1), mtime(0) {}
 

src/library/library.cpp

@@ -39,6 +39,7 @@ Library::Library(Application* app, QObject* parent)
     : QObject(parent),
       app_(app),
       backend_(nullptr),
+      directory_factory_(new DirectoryFactory),
       model_(nullptr),
       watcher_(nullptr),
       watcher_thread_(nullptr),
@@ -57,7 +58,7 @@ Library::Library(Application* app, QObject* parent)
   using smart_playlists::SearchTerm;
 
   model_ = new LibraryModel(backend_, app_, this);
-  dir_model_ = new LibraryDirectoryModel(backend_, this);
+  dir_model_ = new LibraryDirectoryModel(backend_, directory_factory_, this);
   model_->set_show_smart_playlists(true);
   model_->set_default_smart_playlists(
       LibraryModel::DefaultGenerators()
@@ -170,7 +171,7 @@ void Library::Init() {
   connect(app_->player(), SIGNAL(Stopped()), SLOT(Stopped()));
 
   // This will start the watcher checking for updates
-  backend_->LoadDirectoriesAsync();
+  backend_->LoadDirectoriesAsync(directory_factory_.get());
 }
 
 void Library::IncrementalScan() { watcher_->IncrementalScanAsync(); }

src/library/library.h

@@ -28,6 +28,7 @@
 
 class Application;
 class Database;
+class DirectoryFactory;
 class LibraryBackend;
 class LibraryModel;
 class LibraryDirectoryModel;
@@ -81,6 +82,7 @@ class Library : public QObject {
  private:
   Application* app_;
   std::shared_ptr<LibraryBackend> backend_;
+  std::shared_ptr<DirectoryFactory> directory_factory_;
   LibraryModel* model_;
   LibraryDirectoryModel* dir_model_;
 

src/library/librarybackend.cpp

@@ -57,8 +57,9 @@ void LibraryBackend::Init(Database* db, const QString& songs_table,
   fts_table_ = fts_table;
 }
 
-void LibraryBackend::LoadDirectoriesAsync() {
-  metaObject()->invokeMethod(this, "LoadDirectories", Qt::QueuedConnection);
+void LibraryBackend::LoadDirectoriesAsync(DirectoryFactory* directory_factory) {
+  metaObject()->invokeMethod(this, "LoadDirectories", Qt::QueuedConnection,
+                             Q_ARG(DirectoryFactory*, directory_factory));
 }
 
 void LibraryBackend::UpdateTotalSongCountAsync() {
@@ -93,8 +94,8 @@ void LibraryBackend::UpdateSongsRatingAsync(const QList<int>& ids,
                              Q_ARG(float, rating));
 }
 
-void LibraryBackend::LoadDirectories() {
-  DirectoryList dirs = GetAllDirectories();
+void LibraryBackend::LoadDirectories(DirectoryFactory* info) {
+  DirectoryList dirs = GetAllDirectories(info);
 
   QMutexLocker l(db_->Mutex());
   QSqlDatabase db(db_->Connect());
@@ -150,7 +151,9 @@ void LibraryBackend::ChangeDirPath(int id, const QString& old_path,
   t.Commit();
 }
 
-DirectoryList LibraryBackend::GetAllDirectories() {
+DirectoryList LibraryBackend::GetAllDirectories(
+    DirectoryFactory* directory_factory) {
+  Q_ASSERT(directory_factory);
   QMutexLocker l(db_->Mutex());
   QSqlDatabase db(db_->Connect());
 
@@ -162,9 +165,8 @@ DirectoryList LibraryBackend::GetAllDirectories() {
   if (db_->CheckErrors(q)) return ret;
 
   while (q.next()) {
-    Directory dir;
+    Directory dir = directory_factory->GetDirectory(q.value(1).toString());
     dir.id = q.value(0).toInt();
-    dir.path = q.value(1).toString();
 
     ret << dir;
   }
@@ -212,7 +214,9 @@ void LibraryBackend::UpdateTotalSongCount() {
   emit TotalSongCountUpdated(q.value(0).toInt());
 }
 
-void LibraryBackend::AddDirectory(const QString& path) {
+void LibraryBackend::AddDirectory(DirectoryFactory* directory_factory,
+                                  const QString& path) {
+  Q_ASSERT(directory_factory);
   QString canonical_path = QFileInfo(path).canonicalFilePath();
   QString db_path = canonical_path;
 
@@ -234,8 +238,7 @@ void LibraryBackend::AddDirectory(const QString& path) {
   q.exec();
   if (db_->CheckErrors(q)) return;
 
-  Directory dir;
-  dir.path = canonical_path;
+  Directory dir = directory_factory->GetDirectory(canonical_path);
   dir.id = q.lastInsertId().toInt();
 
   emit DirectoryDiscovered(dir, SubdirectoryList());

src/library/librarybackend.h

@@ -69,14 +69,14 @@ class LibraryBackendInterface : public QObject {
   virtual QString songs_table() const = 0;
 
   // Get a list of directories in the library.  Emits DirectoriesDiscovered.
-  virtual void LoadDirectoriesAsync() = 0;
+  virtual void LoadDirectoriesAsync(DirectoryFactory* directory_factory) = 0;
 
   // Counts the songs in the library.  Emits TotalSongCountUpdated
   virtual void UpdateTotalSongCountAsync() = 0;
 
   virtual SongList FindSongsInDirectory(int id) = 0;
   virtual SubdirectoryList SubdirsInDirectory(int id) = 0;
-  virtual DirectoryList GetAllDirectories() = 0;
+  virtual DirectoryList GetAllDirectories(DirectoryFactory* info) = 0;
   virtual void ChangeDirPath(int id, const QString& old_path,
                              const QString& new_path) = 0;
 
@@ -118,7 +118,8 @@ class LibraryBackendInterface : public QObject {
   // songs.
   virtual Song GetSongByUrl(const QUrl& url, qint64 beginning = 0) = 0;
 
-  virtual void AddDirectory(const QString& path) = 0;
+  virtual void AddDirectory(DirectoryFactory* directory_factory,
+                            const QString& path) = 0;
   virtual void RemoveDirectory(int dir_id) = 0;
 
   virtual bool ExecQuery(LibraryQuery* q) = 0;
@@ -141,14 +142,14 @@ class LibraryBackend : public LibraryBackendInterface {
   QString subdirs_table() const { return subdirs_table_; }
 
   // Get a list of directories in the library.  Emits DirectoriesDiscovered.
-  void LoadDirectoriesAsync();
+  void LoadDirectoriesAsync(DirectoryFactory* directory_factory);
 
   // Counts the songs in the library.  Emits TotalSongCountUpdated
   void UpdateTotalSongCountAsync();
 
   SongList FindSongsInDirectory(int id);
   SubdirectoryList SubdirsInDirectory(int id);
-  DirectoryList GetAllDirectories();
+  DirectoryList GetAllDirectories(DirectoryFactory* directory_factory);
   void ChangeDirPath(int id, const QString& old_path, const QString& new_path);
 
   QStringList GetAll(const QString& column,
@@ -185,7 +186,7 @@ class LibraryBackend : public LibraryBackendInterface {
   SongList GetSongsByUrl(const QUrl& url);
   Song GetSongByUrl(const QUrl& url, qint64 beginning = 0);
 
-  void AddDirectory(const QString& path);
+  void AddDirectory(DirectoryFactory* directory_factory, const QString& path);
   void RemoveDirectory(int dir_id);
 
   bool ExecQuery(LibraryQuery* q);
@@ -202,7 +203,7 @@ class LibraryBackend : public LibraryBackendInterface {
   void DeleteAll();
 
  public slots:
-  void LoadDirectories();
+  void LoadDirectories(DirectoryFactory* directory_factory);
   void UpdateTotalSongCount();
   void AddOrUpdateSongs(const SongList& songs);
   void UpdateMTimesOnly(const SongList& songs);

src/library/librarydirectorymodel.cpp

@@ -24,10 +24,12 @@
 #include "ui/iconloader.h"
 
 LibraryDirectoryModel::LibraryDirectoryModel(
-    std::shared_ptr<LibraryBackend> backend, QObject* parent)
+    std::shared_ptr<LibraryBackend> backend,
+    std::shared_ptr<DirectoryFactory> directory_factory, QObject* parent)
     : QStandardItemModel(parent),
       dir_icon_(IconLoader::Load("document-open-folder", IconLoader::Base)),
-      backend_(backend) {
+      backend_(backend),
+      directory_factory_(directory_factory) {
   connect(backend_.get(),
           SIGNAL(DirectoryDiscovered(Directory, SubdirectoryList)),
           SLOT(DirectoryDiscovered(Directory)));
@@ -66,7 +68,7 @@ void LibraryDirectoryModel::DirectoryDeleted(int dir_id) {
 void LibraryDirectoryModel::AddDirectory(const QString& path) {
   if (!backend_) return;
 
-  backend_->AddDirectory(path);
+  backend_->AddDirectory(directory_factory_.get(), path);
 }
 
 void LibraryDirectoryModel::RemoveDirectory(const QModelIndex& index) {

src/library/librarydirectorymodel.h

@@ -33,6 +33,7 @@ class LibraryDirectoryModel : public QStandardItemModel {
 
  public:
   LibraryDirectoryModel(std::shared_ptr<LibraryBackend> backend,
+                        std::shared_ptr<DirectoryFactory> directory_factory,
                         QObject* parent = nullptr);
   ~LibraryDirectoryModel();
 
@@ -52,6 +53,7 @@ class LibraryDirectoryModel : public QStandardItemModel {
 
   QIcon dir_icon_;
   std::shared_ptr<LibraryBackend> backend_;
+  std::shared_ptr<DirectoryFactory> directory_factory_;
   QList<std::shared_ptr<MusicStorage> > storage_;
 };