File indexing completed on 2024-05-05 04:50:32

 /*
    SPDX-FileCopyrightText: 2016 (c) Matthieu Gallien <matthieu_gallien@yahoo.fr>
 
    SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
 #ifndef ABSTRACTFILELISTING_H
 #define ABSTRACTFILELISTING_H
 
 #include "elisaLib_export.h"
 #include "datatypes.h"
 
 #include <QObject>
 #include <QString>
 #include <QUrl>
 #include <QHash>
 #include <QDateTime>
 
 #include <memory>
 
 class AbstractFileListingPrivate;
 class FileScanner;
 class QFileInfo;
 
 class ELISALIB_EXPORT AbstractFileListing : public QObject
 {
 
     Q_OBJECT
 
 public:
 
     enum FileSystemWatchingMode {
         DoNotWatchFileSystemChanges,
         WatchChangedDirectories = 1 << 0,
         WatchChangedFiles = 1 << 1,
     };
 
     using FileSystemWatchingModes = QFlags<FileSystemWatchingMode>;
 
     explicit AbstractFileListing(QObject *parent = nullptr);
 
     ~AbstractFileListing() override;
 
     virtual void applicationAboutToQuit();
 
     [[nodiscard]] const QStringList& allRootPaths() const;
 
     [[nodiscard]] virtual bool canHandleRootPaths() const;
 
 Q_SIGNALS:
 
     void tracksList(const DataTypes::ListTrackDataType &tracks, const QHash<QString, QUrl> &covers);
 
     void removedTracksList(const QList<QUrl> &removedTracks);
 
     void modifyTracksList(const DataTypes::ListTrackDataType &modifiedTracks, const QHash<QString, QUrl> &covers);
 
     void indexingStarted();
 
     void indexingFinished();
 
     void askRestoredTracks();
 
     void errorWatchingFileSystemChanges();
 
 public Q_SLOTS:
 
     void refreshContent();
 
     void init();
 
     void stop();
 
     void newTrackFile(const DataTypes::TrackDataType &partialTrack);
 
     void restoredTracks(QHash<QUrl, QDateTime> allFiles);
 
     void setAllRootPaths(const QStringList &allRootPaths);
 
     void databaseFinishedInsertingTracksList();
 
     void databaseFinishedRemovingTracksList();
 
 protected Q_SLOTS:
 
     void directoryChanged(const QString &path);
 
     void fileChanged(const QString &modifiedFileName);
 
 protected:
 
     virtual void executeInit(QHash<QUrl, QDateTime> allFiles);
 
     virtual void triggerRefreshOfContent();
 
     virtual void triggerStop();
 
     void scanDirectory(DataTypes::ListTrackDataType &newFiles, const QUrl &path, FileSystemWatchingModes watchForFileSystemChanges);
 
     virtual DataTypes::TrackDataType scanOneFile(const QUrl &scanFile, const QFileInfo &scanFileInfo, FileSystemWatchingModes watchForFileSystemChanges);
 
     void watchPath(const QString &pathName);
 
     void addFileInDirectory(const QUrl &newFile, const QUrl &directoryName, FileSystemWatchingModes watchForFileSystemChanges);
 
     void scanDirectoryTree(const QString &path);
 
     void setHandleNewFiles(bool handleThem);
 
     void emitNewFiles(const DataTypes::ListTrackDataType &tracks);
 
     void addCover(const DataTypes::TrackDataType &newTrack);
 
     void removeDirectory(const QUrl &removedDirectory, QList<QUrl> &allRemovedFiles);
 
     void removeFile(const QUrl &oneRemovedTrack, QList<QUrl> &allRemovedFiles);
 
     QHash<QUrl, QDateTime>& allFiles();
 
     void checkFilesToRemove();
 
     FileScanner& fileScanner();
 
     [[nodiscard]] bool waitEndTrackRemoval() const;
 
     void setWaitEndTrackRemoval(bool wait);
 
     [[nodiscard]] bool isActive() const;
 
 private:
 
     std::unique_ptr<AbstractFileListingPrivate> d;
 
 };
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(AbstractFileListing::FileSystemWatchingModes)
 
 #endif // ABSTRACTFILELISTING_H