qgsblockingnetworkrequest.h

Go to the documentation of this file.

/***************************************************************************
    qgsblockingnetworkrequest.h
    ---------------------------
    begin                : November 2018
    copyright            : (C) 2018 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 QGSBLOCKINGNETWORKREQUEST_H
#define QGSBLOCKINGNETWORKREQUEST_H

#include "qgis_core.h"
#include "qgsnetworkreply.h"
#include "qgsfeedback.h"
#include <QThread>
#include <QObject>
#include <functional>
#include <QPointer>

class QNetworkRequest;
class QNetworkReply;

class CORE_EXPORT QgsBlockingNetworkRequest : public QObject
{
    Q_OBJECT
  public:

    enum ErrorCode
    {
      NoError, 
      NetworkError, 
      TimeoutError, 
      ServerExceptionError, 
    };

    explicit QgsBlockingNetworkRequest();

    ~QgsBlockingNetworkRequest() override;

    ErrorCode get( QNetworkRequest &request, bool forceRefresh = false, QgsFeedback *feedback = nullptr );

    ErrorCode post( QNetworkRequest &request, const QByteArray &data, bool forceRefresh = false, QgsFeedback *feedback = nullptr );

    QString errorMessage() const { return mErrorMessage; }

    QgsNetworkReplyContent reply() const { return mReplyContent; }

    QString authCfg() const;

    void setAuthCfg( const QString &authCfg );

  public slots:

    void abort();

  signals:

    void downloadProgress( qint64, qint64 );

    void downloadFinished();

  private slots:
    void replyProgress( qint64, qint64 );
    void replyFinished();
    void requestTimedOut( QNetworkReply *reply );

  private :

    enum Method
    {
      Get,
      Post
    };

    QNetworkReply *mReply = nullptr;

    Method mMethod = Get;
    QByteArray mPostData;

    QString mAuthCfg;

    QString mErrorMessage;

    ErrorCode mErrorCode = NoError;

    QgsNetworkReplyContent mReplyContent;

    bool mIsAborted = false;

    bool mForceRefresh = false;

    bool mTimedout = false;

    bool mGotNonEmptyResponse = false;

    int mExpirationSec = 30;

    QPointer< QgsFeedback > mFeedback;

    ErrorCode doRequest( Method method, QNetworkRequest &request, bool forceRefresh, QgsFeedback *feedback = nullptr );

    QString errorMessageFailedAuth();

};

#ifndef SIP_RUN

class DownloaderThread : public QThread
{
    Q_OBJECT

  public:
    DownloaderThread( const std::function<void()> &function, QObject *parent = nullptr )
      : QThread( parent )
      , mFunction( function )
    {
    }

    void run() override
    {
      mFunction();
    }

  private:
    std::function<void()> mFunction;
};

#endif

#endif // QGSBLOCKINGNETWORKREQUEST_H