itemscanner.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-09-19
 * Description : Scanning a single item.
 *
 * Copyright (C) 2007-2013 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2013-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_ITEM_SCANNER_H
#define DIGIKAM_ITEM_SCANNER_H
 
// Qt includes
 
#include <QFileInfo>
 
// Local includes
 
#include "dimg.h"
#include "iteminfo.h"
#include "dmetadata.h"
#include "coredbalbuminfo.h"
#include "coredbinfocontainers.h"
 
namespace Digikam
{
 
class DIGIKAM_DATABASE_EXPORT ItemScanner
{
 
public:
 
    enum ScanMode
    {
        NewScan,
        ModifiedScan,
        Rescan
    };
 
public:
 
    ItemScanner(const QFileInfo& info, const ItemScanInfo& Iteminfo);
 
    explicit ItemScanner(const QFileInfo& info);
 
    explicit ItemScanner(qlonglong imageid);
 
    ~ItemScanner();
 
    void setCategory(DatabaseItem::Category category);
 
    const ItemScanInfo& itemScanInfo() const;
 
    void loadFromDisk();
 
    static QString formatToString(const QString& format);
 
private:
 
    static bool hasValidField(const QVariantList& list);
    static bool lessThanForIdentity(const ItemScanInfo& a, const ItemScanInfo& b);
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    void newFile(int albumId);
 
    void newFileFullScan(int albumId);
 
    void rescan();
 
    void commit();
 
    qlonglong id() const;
 
    void copiedFrom(int albumId, qlonglong srcId);
 
    static void sortByProximity(QList<ItemInfo>& infos, const ItemInfo& subject);
 
protected:
 
    bool copyFromSource(qlonglong src);
    void commitCopyImageAttributes();
 
    void prepareAddImage(int albumId);
    bool commitAddImage();
 
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    void fileModified();
 
    static void fillCommonContainer(qlonglong imageid, ImageCommonContainer* const container);
 
    static QDateTime creationDateFromFilesystem(const QFileInfo& info);
 
protected:
 
    void prepareUpdateImage();
    void commitUpdateImage();
 
    bool scanFromIdenticalFile();
    void scanFile(ScanMode mode);
 
    void scanItemInformation();
    void commitItemInformation();
 
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    static QString iptcCorePropertyName(MetadataInfo::Field field);
 
    static MetadataFields allImageMetadataFields();
 
protected:
 
    QString detectImageFormat() const;
 
    void scanImageMetadata();
    void commitImageMetadata();
    void scanItemPosition();
    void commitItemPosition();
    void scanItemComments();
    void commitItemComments();
    void scanItemCopyright();
    void commitItemCopyright();
    void scanIPTCCore();
    void commitIPTCCore();
    void scanTags();
    void commitTags();
    void scanFaces();
    void commitFaces();
 
    bool checkRatingFromMetadata(const QVariant& ratingFromMetadata) const;
    void checkCreationDateFromMetadata(QVariant& dateFromMetadata)   const;
 
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    static void fillVideoMetadataContainer(qlonglong imageid, VideoMetadataContainer* const container);
 
protected:
 
    void scanVideoInformation();
    void scanVideoMetadata();
    void commitVideoMetadata();
    QString detectVideoFormat() const;
    QString detectAudioFormat() const;
    static MetadataFields allVideoMetadataFields();
 
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    bool hasHistoryToResolve() const;
 
 
    static bool resolveImageHistory(qlonglong id, QList<qlonglong>* needTaggingIds = nullptr);
    static bool resolveImageHistory(qlonglong imageId, const QString& historyXml, QList<qlonglong>* needTaggingIds = nullptr);
 
    static void tagItemHistoryGraph(qlonglong id);
 
    static DImageHistory resolvedImageHistory(const DImageHistory& history, bool mustBeAvailable = false);
 
    static bool sameReferredImage(const HistoryImageId& id1, const HistoryImageId& id2);
 
    static QList<qlonglong> resolveHistoryImageId(const HistoryImageId& historyId);
 
protected:
 
    void scanImageHistory();
    void commitImageHistory();
    void scanImageHistoryIfModified();
 
    QString uniqueHash() const;
 
 
public:
 
    void scanBalooInfo();
 
private:
 
    // Disable
    ItemScanner(const ItemScanner&)            = delete;
    ItemScanner& operator=(const ItemScanner&) = delete;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ITEM_SCANNER_H