qgsnewsfeedparser.h

Go to the documentation of this file.

/***************************************************************************
    qgsnewsfeedparser.h
    -------------------
    begin                : July 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 QGSNEWSFEEDPARSER_H
#define QGSNEWSFEEDPARSER_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include <QObject>
#include <QUrl>
#include <QPixmap>
#include <QDateTime>

class QgsNetworkContentFetcher;

class CORE_EXPORT QgsNewsFeedParser : public QObject
{
    Q_OBJECT
  public:

    class Entry
    {
      public:

        int key = 0;

        QString title;

        QString imageUrl;

        QPixmap image;

        QString content;

        QUrl link;

        bool sticky = false;

        QDateTime expiry;
    };

    QgsNewsFeedParser( const QUrl &feedUrl, const QString &authcfg = QString(), QObject *parent SIP_TRANSFERTHIS = nullptr );

    QList< QgsNewsFeedParser::Entry > entries() const;

    void dismissEntry( int key );

    void dismissAll();

    QString authcfg() const;

    static QString keyForFeed( const QString &baseUrl );

  public slots:

    void fetch();

  signals:

    void fetched( const QList< QgsNewsFeedParser::Entry > &entries );

    void entryAdded( const QgsNewsFeedParser::Entry &entry );

    void entryDismissed( const QgsNewsFeedParser::Entry &entry );

    void imageFetched( int key, const QPixmap &pixmap );

  private slots:

    void onFetch( const QString &content );

  private:

    QString mBaseUrl;
    QUrl mFeedUrl;
    QString mAuthCfg;
    uint mFetchStartTime = 0;
    QString mSettingsKey;

    QList< Entry > mEntries;
    bool mBlockSignals = false;

    void readStoredEntries();
    Entry readEntryFromSettings( int key );
    void storeEntryInSettings( const Entry &entry );
    void fetchImageForEntry( const Entry &entry );

    friend class TestQgsNewsFeedParser;

};

#endif // QGSNEWSFEEDPARSER_H