qgshistoryproviderregistry.h

Go to the documentation of this file.

/***************************************************************************
                            qgshistoryproviderregistry.h
                            --------------------------
    begin                : April 2019
    copyright            : (C) 2019 by Nyall Dawson
    email                : nyall dot dawson 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 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSHISTORYPROVIDERREGISTRY_H
#define QGSHISTORYPROVIDERREGISTRY_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgis.h"
 
#include <QObject>
#include <QMap>
#include <QString>
#include <QDateTime>
#include <QVariant>
#include <QVector>
 
#include "qgssqliteutils.h"
 
class QgsAbstractHistoryProvider;
 
class GUI_EXPORT QgsHistoryEntry
{
  public:
 
    QgsHistoryEntry( const QString &providerId, const QDateTime &timestamp, const QVariantMap &entry );
 
    QgsHistoryEntry( const QVariantMap &entry );
 
    QDateTime timestamp;
 
    QString providerId;
 
    QVariantMap entry;
 
#ifdef SIP_RUN
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QString str = QStringLiteral( "<QgsHistoryEntry: %1 %2>" ).arg( sipCpp->providerId, sipCpp->timestamp.toString( Qt::ISODate ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
#endif
 
};
 
class GUI_EXPORT QgsHistoryProviderRegistry : public QObject
{
    Q_OBJECT
 
  public:
 
    QgsHistoryProviderRegistry( QObject *parent = nullptr, bool useMemoryDatabase = false );
 
    ~QgsHistoryProviderRegistry() override;
 
    void addDefaultProviders() SIP_SKIP;
 
    bool addProvider( QgsAbstractHistoryProvider *provider SIP_TRANSFER );
 
    QgsAbstractHistoryProvider *providerById( const QString &id );
 
    bool removeProvider( const QString &id );
 
    QStringList providerIds() const;
 
    class HistoryEntryOptions
    {
      public:
 
        HistoryEntryOptions() {}
 
        Qgis::HistoryProviderBackends storageBackends = Qgis::HistoryProviderBackend::LocalProfile;
    };
 
    long long addEntry( const QString &providerId, const QVariantMap &entry, bool &ok SIP_OUT, QgsHistoryProviderRegistry::HistoryEntryOptions options = QgsHistoryProviderRegistry::HistoryEntryOptions() );
 
    long long addEntry( const QgsHistoryEntry &entry, bool &ok SIP_OUT, QgsHistoryProviderRegistry::HistoryEntryOptions options = QgsHistoryProviderRegistry::HistoryEntryOptions() );
 
    bool addEntries( const QList< QgsHistoryEntry > &entries, QgsHistoryProviderRegistry::HistoryEntryOptions options = QgsHistoryProviderRegistry::HistoryEntryOptions() );
 
    QgsHistoryEntry entry( long long id, bool &ok, Qgis::HistoryProviderBackend backend = Qgis::HistoryProviderBackend::LocalProfile ) const;
 
    bool updateEntry( long long id, const QVariantMap &entry, Qgis::HistoryProviderBackend backend = Qgis::HistoryProviderBackend::LocalProfile );
 
    QList< QgsHistoryEntry > queryEntries( const QDateTime &start = QDateTime(), const QDateTime &end = QDateTime(),
                                           const QString &providerId = QString(), Qgis::HistoryProviderBackends backends = Qgis::HistoryProviderBackend::LocalProfile ) const;
 
    static QString userHistoryDbPath();
 
    bool clearHistory( Qgis::HistoryProviderBackend backend );
 
  private:
 
    bool createDatabase( const QString &filename, QString &error );
 
    bool openDatabase( const QString &filename, QString &error );
 
    void createTables();
 
    bool runEmptyQuery( const QString &query );
 
    QMap< QString, QgsAbstractHistoryProvider * > mProviders;
 
    sqlite3_database_unique_ptr mLocalDB;
 
};
 
#endif //QGSHISTORYPROVIDERREGISTRY_H