qgshttptransaction.h

Go to the documentation of this file.

/***************************************************************************
  qgshttptransaction.h  -  Tracks a HTTP request with its response,
                           with particular attention to tracking
                           HTTP redirect responses
                             -------------------
    begin                : 17 Mar, 2005
    copyright            : (C) 2005 by Brendan Morley
    email                : morb at ozemail dot com dot au
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSHTTPTRANSACTION_H
#define QGSHTTPTRANSACTION_H

#include <QHttp>
#include <QNetworkProxy>
#include <QString>

class QTimer;

class CORE_EXPORT QgsHttpTransaction : public QObject
{

    Q_OBJECT

  public:
    QgsHttpTransaction( const QString& uri,
                        const QString& proxyHost = QString(),
                        int     proxyPort = 80,
                        const QString& proxyUser = QString(),
                        const QString& proxyPass = QString(),
                        QNetworkProxy::ProxyType proxyType = QNetworkProxy::NoProxy,
                        const QString& userName = QString(),
                        const QString& password = QString() );

    virtual ~QgsHttpTransaction();

    void getAsynchronously();


    bool getSynchronously( QByteArray &respondedContent, int redirections = 0, const QByteArray* postData = nullptr );

    QString responseContentType();

    QString errorString();

    static bool applyProxySettings( QHttp& http, const QString& url );

    void setCredentials( const QString& username, const QString &password );

    int networkTimeout() const { return mNetworkTimeoutMsec;}
    void setNetworkTimeout( int msec ) { mNetworkTimeoutMsec = msec;}


  public slots:

    void dataStarted( int id );

    void dataHeaderReceived( const QHttpResponseHeader& resp );

    void dataReceived( const QHttpResponseHeader& resp );

    void dataProgress( int done, int total );

    void dataFinished( int id, bool error );

    void transactionFinished( bool error );

    void dataStateChanged( int state );

    void networkTimedOut();

    void abort();

  signals:

    void setProgress( int done, int total );

    void dataReadProgress( int theProgress );
    void totalSteps( int theTotalSteps );

    void statusChanged( const QString& theStatusQString );


  private:

    QgsHttpTransaction();

    QHttp* http;

    int httpid;

    bool httpactive;

    /*
     * Indicates the response from the QHttp
     */
    QByteArray httpresponse;

    /*
     * Indicates the content type of the response from the QHttp
     */
    QString    httpresponsecontenttype;

    QString httpurl;

    QString httphost;

    QString httpredirecturl;

    int httpredirections;

    QTimer * mWatchdogTimer;

    QString mError;

    QString mUserName;

    QString mPassword;

    int mNetworkTimeoutMsec;
};

#endif

// ENDS