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 <functional>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsfeedback.h"
#include "qgsnetworkreply.h"
 
#include <QHttpMultiPart>
#include <QObject>
#include <QPointer>
#include <QThread>
 
class QNetworkRequest;
class QNetworkReply;

class CORE_EXPORT QgsBlockingNetworkRequest : public QObject
{
    Q_OBJECT
  public:
    enum ErrorCode
    {
      NoError,              
      NetworkError,         
      TimeoutError,         
      ServerExceptionError, 
    };

    enum class RequestFlag : int SIP_ENUM_BASETYPE( IntFlag )
    {
      EmptyResponseIsValid = 1 << 0, 
    };
    Q_ENUM( RequestFlag )
    Q_DECLARE_FLAGS( RequestFlags, RequestFlag )
    Q_FLAG( RequestFlags )

    explicit QgsBlockingNetworkRequest( Qgis::NetworkRequestFlags flags = Qgis::NetworkRequestFlags() );
 
    ~QgsBlockingNetworkRequest() override;

    Qgis::NetworkRequestFlags flags() const { return mFlags; }

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

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

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

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

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

    ErrorCode put( QNetworkRequest &request, QIODevice *data, QgsFeedback *feedback = nullptr );

    ErrorCode put( QNetworkRequest &request, const QByteArray &data, QgsFeedback *feedback = nullptr );

    ErrorCode deleteResource( QNetworkRequest &request, 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 bytesReceived, qint64 bytesTotal );

    Q_DECL_DEPRECATED void downloadFinished() SIP_DEPRECATED;

    void uploadProgress( qint64 bytesReceived, qint64 bytesTotal );

    void finished();
 
  private slots:
    void replyProgress( qint64, qint64 );
    void replyFinished();
    void requestTimedOut( QNetworkReply *reply );
 
  private:
    Qgis::NetworkRequestFlags mFlags;

    QNetworkReply *mReply = nullptr;
 
    Qgis::HttpMethod mMethod = Qgis::HttpMethod::Get;

    std::variant<QIODevice *, QHttpMultiPart *> mPayloadDataVariant;

    QString mAuthCfg;

    QString mErrorMessage;

    ErrorCode mErrorCode = NoError;
 
    QgsNetworkReplyContent mReplyContent;

    bool mIsAborted = false;

    bool mForceRefresh = false;

    bool mTimedout = false;

    bool mGotNonEmptyResponse = false;

    RequestFlags mRequestFlags;
 
    int mExpirationSec = 30;
 
    QPointer< QgsFeedback > mFeedback;
 
    ErrorCode doRequest( Qgis::HttpMethod method, QNetworkRequest &request, bool forceRefresh, QgsFeedback *feedback = nullptr, RequestFlags requestFlags = RequestFlags() );
 
    QString errorMessageFailedAuth();
 
    void sendRequestToNetworkAccessManager( const QNetworkRequest &request );
 
    void abortIfNotPartialContentReturned();
};

#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