collectionscanner.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-03-21
 * Description : Collection scanning to database.
 *
 * Copyright (C) 2005      by Renchi Raju <renchi dot raju at gmail dot com>
 * Copyright (C) 2005-2006 by Tom Albers <tomalbers at kde dot nl>
 * Copyright (C) 2007-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2009-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * 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_COLLECTION_SCANNER_H
#define DIGIKAM_COLLECTION_SCANNER_H
 
// Qt includes
 
#include <QString>
#include <QObject>
#include <QList>
 
// Local includes
 
#include "iteminfo.h"
#include "digikam_export.h"
#include "coredbaccess.h"
#include "coredbalbuminfo.h"
#include "collectionscannerhints.h"
 
class QFileInfo;
 
namespace Digikam
{
 
class DIGIKAM_DATABASE_EXPORT CollectionScanner : public QObject
{
    Q_OBJECT
 
public:
 
    enum FileScanMode
    {
        NormalScan,
 
        ModifiedScan,
 
        Rescan
    };
 
public:
 
    explicit CollectionScanner();
    ~CollectionScanner() override;
 
 
    static CollectionScannerHintContainer* createHintContainer();
    void setHintContainer(CollectionScannerHintContainer* const container);
    void setUpdateHashHint(bool hint = true);
 
    void setSignalsEnabled(bool on);
 
    void setNeedFileCount(bool on);
 
    void setPerformFastScan(bool on);
 
    void setObserver(CollectionScannerObserver* const observer);
 
    void setDeferredFileScanning(bool defer);
    QStringList deferredAlbumPaths() const;
 
    QList<qlonglong> getNewIdsList() const;
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    void completeScan();
 
    void finishCompleteScan(const QStringList& albumPaths);
 
    static bool databaseInitialScanDone();
 
    void partialScan(const QString& filePath);
 
    void partialScan(const QString& albumRoot, const QString& album);
 
    qlonglong scanFile(const QString& filePath, FileScanMode mode = ModifiedScan);
 
    qlonglong scanFile(const QString& albumRoot,
                       const QString& album,
                       const QString& fileName,
                       FileScanMode mode = ModifiedScan);
 
    void scanFile(const ItemInfo& info, FileScanMode mode = ModifiedScan);
 
protected:
 
    void scanForStaleAlbums(const QList<CollectionLocation>& locations);
    void scanForStaleAlbums(const QList<int>& locationIdsToScan);
    void scanAlbumRoot(const CollectionLocation& location);
    void scanAlbum(const CollectionLocation& location, const QString& album, bool checkDate = false);
    void scanExistingFile(const QFileInfo& fi, qlonglong id);
    void scanFileNormal(const QFileInfo& info, const ItemScanInfo& scanInfo, bool checkSidecar = true);
    void scanModifiedFile(const QFileInfo& info, const ItemScanInfo& scanInfo);
    void scanFileUpdateHashReuseThumbnail(const QFileInfo& fi, const ItemScanInfo& scanInfo, bool fileWasEdited);
    void rescanFile(const QFileInfo& info, const ItemScanInfo& scanInfo);
    void completeScanCleanupPart();
    void completeHistoryScanning();
    void finishHistoryScanning();
    void historyScanningStage2(const QList<qlonglong>& ids);
    void historyScanningStage3(const QList<qlonglong>& ids);
 
    qlonglong scanFile(const QFileInfo& fi, int albumId, qlonglong id, FileScanMode mode);
    qlonglong scanNewFile(const QFileInfo& info, int albumId);
    qlonglong scanNewFileFullScan(const QFileInfo& info, int albumId);
 
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    void safelyRemoveAlbums(const QList<int>& albumIds);
 
    static void copyFileProperties(const ItemInfo& source, const ItemInfo& dest);
 
protected:
 
    void markDatabaseAsScanned();
    void mainEntryPoint(bool complete);
    int  checkAlbum(const CollectionLocation& location, const QString& album);
    void itemsWereRemoved(const QList<qlonglong>& removedIds);
    void updateRemovedItemsTime();
    void incrementDeleteRemovedCompleteScanCount();
    void resetDeleteRemovedSettings();
    bool checkDeleteRemoved();
    void loadNameFilters();
    int  countItemsInFolder(const QString& path);
    DatabaseItem::Category category(const QFileInfo& info);
 
 
Q_SIGNALS:
 
    void totalFilesToScan(int count);
 
 
    void startScanningAlbumRoot(const QString& albumRoot);
    void startScanningAlbum(const QString& albumRoot, const QString& album);
    void startScanningForStaleAlbums();
    void startScanningAlbumRoots();
    void startCompleteScan();
    void signalScannedNewImage(const QFileInfo& info);
 
 
    void finishedScanningAlbumRoot(const QString& albumRoot);
    void finishedScanningAlbum(const QString& albumRoot, const QString& album, int filesScanned);
    void finishedScanningForStaleAlbums();
    void finishedCompleteScan();
 
    void scannedFiles(int filesScanned);
 
    void cancelled();
 
private:
 
    // Disable
    CollectionScanner(QObject*) = delete;
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_COLLECTION_SCANNER_H