thumbsdb.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-05-29
 * Description : Thumbnails database interface.
 *
 * Copyright (C)      2009 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_THUMBS_DB_H
#define DIGIKAM_THUMBS_DB_H
 
// Qt includes
 
#include <QDateTime>
#include <QString>
#include <QHash>
#include <QList>
 
// Local includes
 
#include "dbenginesqlquery.h"
#include "thumbsdbbackend.h"
#include "thumbsdbaccess.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
namespace DatabaseThumbnail
{
 
enum Type
{
    UndefinedType = 0,
    NoThumbnail,
    PGF,
    JPEG,              // Warning : no alpha channel support. Cannot be used as well.
    JPEG2000,
    PNG
    //FreeDesktopHash
};
 
} // namespace DatabaseThumbnail
 
class DIGIKAM_EXPORT ThumbsDbInfo
{
 
public:
 
    explicit ThumbsDbInfo()
        : id             (-1),
          type           (DatabaseThumbnail::UndefinedType),
          orientationHint(0)
    {
    }
 
    int                     id;
    DatabaseThumbnail::Type type;
    QDateTime               modificationDate;
    int                     orientationHint;
    QByteArray              data;
};
 
// ------------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT ThumbsDb
{
 
public:
 
    bool setSetting(const QString& keyword, const QString& value);
    QString getSetting(const QString& keyword);
    QString getLegacySetting(const QString& keyword);
 
    ThumbsDbInfo findByHash(const QString& uniqueHash, qlonglong fileSize);
    ThumbsDbInfo findByFilePath(const QString& path);
    ThumbsDbInfo findByCustomIdentifier(const QString& id);
 
    ThumbsDbInfo findByFilePath(const QString& path, const QString& uniqueHash);
 
    QList<int> findAll();
 
    BdEngineBackend::QueryState insertUniqueHash(const QString& uniqueHash, qlonglong fileSize, int thumbId);
    BdEngineBackend::QueryState insertFilePath(const QString& path, int thumbId);
    BdEngineBackend::QueryState insertCustomIdentifier(const QString& id, int thumbId);
 
    BdEngineBackend::QueryState remove(int thumbId);
 
    BdEngineBackend::QueryState removeByUniqueHash(const QString& uniqueHash, qlonglong fileSize);
 
    BdEngineBackend::QueryState removeByFilePath(const QString& path);
    BdEngineBackend::QueryState removeByCustomIdentifier(const QString& id);
 
    BdEngineBackend::QueryState renameByFilePath(const QString& oldPath, const QString& newPath);
 
    BdEngineBackend::QueryState insertThumbnail(const ThumbsDbInfo& info, QVariant* const lastInsertId = nullptr);
    BdEngineBackend::QueryState replaceThumbnail(const ThumbsDbInfo& info);
 
    QHash<QString, int> getFilePathsWithThumbnail();
 
    void replaceUniqueHash(const QString& oldUniqueHash, int oldFileSize, const QString& newUniqueHash, int newFileSize);
    BdEngineBackend::QueryState updateModificationDate(int thumbId, const QDateTime& modificationDate);
 
    // ----------- Database shrinking methods ----------
 
    bool integrityCheck();
 
    void vacuum();
 
private:
 
    explicit ThumbsDb(ThumbsDbBackend* const backend);
    ~ThumbsDb();
 
    ThumbsDbInfo fillThumbnailInfo(const QList<QVariant>& values);
 
private:
 
    // Disable
    ThumbsDb(const ThumbsDb&)            = delete;
    ThumbsDb& operator=(const ThumbsDb&) = delete;
 
    class Private;
    Private* const d;
 
    friend class ThumbsDbAccess;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_THUMBS_DB_H