scancontroller.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2005-10-28
 * Description : scan item controller.
 *
 * Copyright (C) 2005-2006 by Tom Albers <tomalbers at kde dot nl>
 * Copyright (C) 2006-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2007-2013 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * This program 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 2, or (at your option)
 * any later version.
 *
 * This program 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.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_SCAN_CONTROLLER_H
#define DIGIKAM_SCAN_CONTROLLER_H
 
// Qt includes
 
#include <QThread>
#include <QString>
#include <QList>
 
// Local includes
 
#include "digikam_export.h"
#include "collectionscannerobserver.h"
#include "collectionscannerhints.h"
#include "iteminfo.h"
#include "loadingcache.h"
#include "coredbchangesets.h"
 
namespace Digikam
{
 
class CollectionScanner;
class PAlbum;
 
class DIGIKAM_GUI_EXPORT ScanController : public QThread,
                                          public InitializationObserver
{
    Q_OBJECT
 
public:
 
    enum Advice
    {
        Success,
        ContinueWithoutDatabase,
        AbortImmediately
    };
 
public:
 
    class FileMetadataWrite
    {
    public:
 
        explicit FileMetadataWrite(const ItemInfo& info);
        ~FileMetadataWrite();
 
        void changed(bool wasChanged);
 
    protected:
 
        ItemInfo m_info;
        bool     m_changed;
    };
 
public:
 
    static ScanController* instance();
 
    void updateUniqueHash();
 
    void allowToScanDeferredFiles();
 
    ItemInfo scannedInfo(const QString& filePath);
 
    QList<qlonglong> getNewIdsList() const;
 
protected:
 
    void run() override;
 
private:
 
    explicit ScanController();
    ~ScanController() override;
 
    void setInitializationMessage();
    void createProgressDialog();
 
    bool continueQuery()                                            override;
    void connectCollectionScanner(CollectionScanner* const scanner) override;
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    Advice databaseInitialization();
 
    void completeCollectionScan(bool defer = false);
    void completeCollectionScanDeferFiles();
 
    void completeCollectionScanInBackground(bool defer, bool fastScan = true);
 
    void scheduleCollectionScan(const QString& path);
 
    void scheduleCollectionScanRelaxed(const QString& path);
 
    void scheduleCollectionScanExternal(const QString& path);
 
    void beginFileMetadataWrite(const ItemInfo& info);
 
    void resumeCollectionScan();
 
Q_SIGNALS:
 
    void databaseInitialized(bool success);
    void collectionScanStarted(const QString& message);
 
private Q_SLOTS:
 
    void slotStartCompleteScan();
    void slotStartScanningAlbum(const QString& albumRoot, const QString& album);
    void slotStartScanningAlbumRoot(const QString& albumRoot);
    void slotStartScanningForStaleAlbums();
    void slotStartScanningAlbumRoots();
 
private:
 
    void scanFileDirectly(const QString& filePath);
    void scanFileDirectlyNormal(const ItemInfo& info);
    void completeCollectionScanCore(bool needTotalFiles, bool defer, bool fastScan);
 
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    void hintAtMoveOrCopyOfAlbum(const PAlbum* const album,
                                 const PAlbum* const dstAlbum,
                                 const QString& newAlbumName = QString());
    void hintAtMoveOrCopyOfAlbum(const PAlbum* const album,
                                 const QString& dstPath,
                                 const QString& newAlbumName = QString());
 
    void hintAtMoveOrCopyOfItems(const QList<qlonglong>& ids,
                                 const PAlbum* const dstAlbum,
                                 const QStringList& itemNames);
    void hintAtMoveOrCopyOfItem(qlonglong id,
                                const PAlbum* const dstAlbum,
                                const QString& itemName);
 
    void hintAtModificationOfItems(const QList<qlonglong>& ids);
    void hintAtModificationOfItem(qlonglong id);
 
Q_SIGNALS:
 
    void totalFilesToScan(int);
    void filesScanned(int);
    void scanningProgress(float progress);
    void triggerShowProgressDialog();
    void incrementProgressDialog(int);
    void progressFromInitialization(const QString&, int);
 
private Q_SLOTS:
 
    void slotTotalFilesToScan(int count);
    void slotScannedFiles(int scanned);
    void slotShowProgressDialog();
    void slotTriggerShowProgressDialog();
    void slotProgressFromInitialization(const QString& message, int numberOfSteps);
    void slotErrorFromInitialization(const QString& errorMessage);
 
private:
 
    void moreSchemaUpdateSteps(int numberOfSteps)                        override;
    void schemaUpdateProgress(const QString& message, int numberOfSteps) override;
    void error(const QString& errorMessage) override;
 
    AlbumCopyMoveHint hintForAlbum(const PAlbum* const album,
                                   int dstAlbumRootId,
                                   const QString& relativeDstPath,
                                   const QString& albumName);
 
    QList<AlbumCopyMoveHint> hintsForAlbum(const PAlbum* const album,
                                           int dstAlbumRootId,
                                           const QString& relativeDstPath,
                                           const QString& albumName);
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    void shutDown();
 
    void abortInitialization();
 
    void cancelCompleteScan();
 
    void cancelAllAndSuspendCollectionScan();
 
    void suspendCollectionScan();
 
    void finishFileMetadataWrite(const ItemInfo& info, bool changed);
 
Q_SIGNALS:
 
    void collectionScanFinished();
    void newImages(const ItemInfoList&);
    void partialScanDone(const QString& path);
    void completeScanDone();
    void completeScanCanceled();
    void errorFromInitialization(const QString&);
 
private Q_SLOTS:
 
    void slotCancelPressed();
    void slotRelaxedScanning();
 
private:
 
    void finishedSchemaUpdate(UpdateResult result) override;
 
 
private:
 
    // Disable
    ScanController(QObject*)                         = delete;
    ScanController(const ScanController&)            = delete;
    ScanController& operator=(const ScanController&) = delete;
 
private:
 
    friend class ScanControllerCreator;
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_SCAN_CONTROLLER_H