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 "qgssettingstree.h"
 
#include <QDateTime>
#include <QObject>
#include <QPixmap>
#include <QString>
#include <QUrl>
 
using namespace Qt::StringLiterals;
 
class QgsNetworkContentFetcher;
class QgsSettingsEntryBool;
class QgsSettingsEntryInteger64;
class QgsSettingsEntryString;
class QgsSettingsEntryDouble;
class QgsSettingsEntryVariant;

class CORE_EXPORT QgsNewsFeedParser : public QObject
{
    Q_OBJECT
 
    Q_PROPERTY( bool enabled READ enabled WRITE setEnabled NOTIFY enabledChanged );
    Q_PROPERTY( bool isFetching READ isFetching NOTIFY isFetchingChanged );
 
  public:
#ifndef SIP_RUN
    static inline QgsSettingsTreeNamedListNode *sTreeNewsFeed = QgsSettingsTree::sTreeApp->createNamedListNode( u"news-feed"_s );
    static const QgsSettingsEntryBool *settingsFeedDisabled;
    static const QgsSettingsEntryInteger64 *settingsFeedLastFetchTime;
    static const QgsSettingsEntryString *settingsFeedLanguage;
    static const QgsSettingsEntryDouble *settingsFeedLatitude;
    static const QgsSettingsEntryDouble *settingsFeedLongitude;
 
    static inline QgsSettingsTreeNamedListNode *sTreeNewsFeedEntries = sTreeNewsFeed->createNamedListNode( u"entries"_s );
    static const QgsSettingsEntryString *settingsFeedEntryTitle;
    static const QgsSettingsEntryString *settingsFeedEntryImageUrl;
    static const QgsSettingsEntryString *settingsFeedEntryContent;
    static const QgsSettingsEntryString *settingsFeedEntryLink;
    static const QgsSettingsEntryBool *settingsFeedEntrySticky;
    static const QgsSettingsEntryVariant *settingsFeedEntryPublished;
    static const QgsSettingsEntryVariant *settingsFeedEntryExpiry;
#endif

    class Entry
    {
      public:
        int key = 0;

        QString title;

        QString imageUrl;

        QPixmap image;

        QString content;

        QUrl link;

        bool sticky = false;

        QDateTime published;

        QDateTime expiry;
    };

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

    bool enabled() const SIP_SKIP { return mEnabled; }

    void setEnabled( bool enabled ) SIP_SKIP;

    bool isFetching() const { return mIsFetching; }

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

    Q_INVOKABLE void dismissEntry( int key );

    Q_INVOKABLE 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 entryUpdated( const QgsNewsFeedParser::Entry &entry );

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

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

    void enabledChanged();

    void isFetchingChanged();
 
  private slots:
 
    void onFetch( const QString &content );
 
  private:
    QString mBaseUrl;
    QUrl mFeedUrl;
    QString mAuthCfg;
    qint64 mFetchStartTime = 0;
    QString mFeedKey;
 
    QList< Entry > mEntries;
    bool mBlockSignals = false;
 
    bool mEnabled = true;
    bool mIsFetching = false;
 
    void readStoredEntries();
    Entry readEntryFromSettings( int key );
    void storeEntryInSettings( const Entry &entry );
    void fetchImageForEntry( const Entry &entry );
 
    friend class TestQgsNewsFeedParser;
};
 
#endif // QGSNEWSFEEDPARSER_H