/**************************************************************************** ** ** Copyright (C) 2016 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtNetwork module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in ** a written agreement between you and The Qt Company. For licensing terms ** and conditions see https://www.qt.io/terms-conditions. For further ** information use the contact form at https://www.qt.io/contact-us. ** ** GNU Lesser General Public License Usage ** Alternatively, this file may be used under the terms of the GNU Lesser ** General Public License version 3 as published by the Free Software ** Foundation and appearing in the file LICENSE.LGPL3 included in the ** packaging of this file. Please review the following information to ** ensure the GNU Lesser General Public License version 3 requirements ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 2.0 or (at your option) the GNU General ** Public license version 3 or any later version approved by the KDE Free ** Qt Foundation. The licenses are as published by the Free Software ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 ** included in the packaging of this file. Please review the following ** information to ensure the GNU General Public License requirements will ** be met: https://www.gnu.org/licenses/gpl-2.0.html and ** https://www.gnu.org/licenses/gpl-3.0.html. ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #ifndef QHTTPNETWORKREPLY_H #define QHTTPNETWORKREPLY_H // // W A R N I N G // ------------- // // This file is not part of the Qt API. It exists for the convenience // of the Network Access API. This header file may change from // version to version without notice, or even be removed. // // We mean it. // #include #ifndef QT_NO_HTTP #include #ifndef QT_NO_COMPRESS struct z_stream_s; #endif #include // it's safe to include these even if SSL support is not enabled #include #include #include #include #include #include #include #include #include #include #include QT_BEGIN_NAMESPACE class QHttpNetworkConnection; class QHttpNetworkConnectionChannel; class QHttpNetworkRequest; class QHttpNetworkConnectionPrivate; class QHttpNetworkReplyPrivate; class Q_AUTOTEST_EXPORT QHttpNetworkReply : public QObject, public QHttpNetworkHeader { Q_OBJECT public: explicit QHttpNetworkReply(const QUrl &url = QUrl(), QObject *parent = 0); virtual ~QHttpNetworkReply(); QUrl url() const override; void setUrl(const QUrl &url) override; int majorVersion() const override; int minorVersion() const override; qint64 contentLength() const override; void setContentLength(qint64 length) override; QList > header() const override; QByteArray headerField(const QByteArray &name, const QByteArray &defaultValue = QByteArray()) const override; void setHeaderField(const QByteArray &name, const QByteArray &data) override; void parseHeader(const QByteArray &header); // mainly for testing QHttpNetworkRequest request() const; void setRequest(const QHttpNetworkRequest &request); int statusCode() const; void setStatusCode(int code); QString errorString() const; void setErrorString(const QString &error); QString reasonPhrase() const; qint64 bytesAvailable() const; qint64 bytesAvailableNextBlock() const; bool readAnyAvailable() const; QByteArray readAny(); QByteArray readAll(); QByteArray read(qint64 amount); qint64 sizeNextBlock(); void setDownstreamLimited(bool t); void setReadBufferSize(qint64 size); bool supportsUserProvidedDownloadBuffer(); void setUserProvidedDownloadBuffer(char*); char* userProvidedDownloadBuffer(); void abort(); bool isAborted() const; bool isFinished() const; bool isPipeliningUsed() const; bool isSpdyUsed() const; void setSpdyWasUsed(bool spdy); qint64 removedContentLength() const; bool isRedirecting() const; QHttpNetworkConnection* connection(); QUrl redirectUrl() const; void setRedirectUrl(const QUrl &url); static bool isHttpRedirect(int statusCode); #ifndef QT_NO_SSL QSslConfiguration sslConfiguration() const; void setSslConfiguration(const QSslConfiguration &config); void ignoreSslErrors(); void ignoreSslErrors(const QList &errors); Q_SIGNALS: void encrypted(); void sslErrors(const QList &errors); void preSharedKeyAuthenticationRequired(QSslPreSharedKeyAuthenticator *authenticator); #endif Q_SIGNALS: void readyRead(); void finished(); void finishedWithError(QNetworkReply::NetworkError errorCode, const QString &detail = QString()); void headerChanged(); void dataReadProgress(qint64 done, qint64 total); void dataSendProgress(qint64 done, qint64 total); void cacheCredentials(const QHttpNetworkRequest &request, QAuthenticator *authenticator); #ifndef QT_NO_NETWORKPROXY void proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator); #endif void authenticationRequired(const QHttpNetworkRequest &request, QAuthenticator *authenticator); void redirected(const QUrl &url, int httpStatus, int maxRedirectsRemaining); private: Q_DECLARE_PRIVATE(QHttpNetworkReply) friend class QHttpSocketEngine; friend class QHttpNetworkConnection; friend class QHttpNetworkConnectionPrivate; friend class QHttpNetworkConnectionChannel; friend class QHttp2ProtocolHandler; friend class QHttpProtocolHandler; friend class QSpdyProtocolHandler; }; class Q_AUTOTEST_EXPORT QHttpNetworkReplyPrivate : public QObjectPrivate, public QHttpNetworkHeaderPrivate { public: QHttpNetworkReplyPrivate(const QUrl &newUrl = QUrl()); ~QHttpNetworkReplyPrivate(); qint64 readStatus(QAbstractSocket *socket); bool parseStatus(const QByteArray &status); qint64 readHeader(QAbstractSocket *socket); void parseHeader(const QByteArray &header); qint64 readBody(QAbstractSocket *socket, QByteDataBuffer *out); qint64 readBodyVeryFast(QAbstractSocket *socket, char *b); qint64 readBodyFast(QAbstractSocket *socket, QByteDataBuffer *rb); bool findChallenge(bool forProxy, QByteArray &challenge) const; QAuthenticatorPrivate::Method authenticationMethod(bool isProxy) const; void clear(); void clearHttpLayerInformation(); qint64 readReplyBodyRaw(QAbstractSocket *in, QByteDataBuffer *out, qint64 size); qint64 readReplyBodyChunked(QAbstractSocket *in, QByteDataBuffer *out); qint64 getChunkSize(QAbstractSocket *in, qint64 *chunkSize); bool isRedirecting() const; bool shouldEmitSignals(); bool expectContent(); void eraseData(); qint64 bytesAvailable() const; bool isChunked(); bool isConnectionCloseEnabled(); bool isCompressed(); void removeAutoDecompressHeader(); enum ReplyState { NothingDoneState, ReadingStatusState, ReadingHeaderState, ReadingDataState, AllDoneState, SPDYSYNSent, SPDYUploading, SPDYHalfClosed, SPDYClosed, Aborted } state; QHttpNetworkRequest request; bool ssl; int statusCode; int majorVersion; int minorVersion; QString errorString; QString reasonPhrase; qint64 bodyLength; qint64 contentRead; qint64 totalProgress; QByteArray fragment; // used for header, status, chunk header etc, not for reply data bool chunkedTransferEncoding; bool connectionCloseEnabled; bool forceConnectionCloseEnabled; bool lastChunkRead; qint64 currentChunkSize; qint64 currentChunkRead; qint64 readBufferMaxSize; qint32 windowSizeDownload; // only for SPDY qint32 windowSizeUpload; // only for SPDY qint32 currentlyReceivedDataInWindow; // only for SPDY qint32 currentlyUploadedDataInWindow; // only for SPDY qint64 totallyUploadedData; // only for SPDY qint64 removedContentLength; QPointer connection; QPointer connectionChannel; bool autoDecompress; QByteDataBuffer responseData; // uncompressed body QByteArray compressedData; // compressed body (temporary) bool requestIsPrepared; bool pipeliningUsed; bool spdyUsed; bool downstreamLimited; char* userProvidedDownloadBuffer; QUrl redirectUrl; #ifndef QT_NO_COMPRESS z_stream_s *inflateStrm; int initializeInflateStream(); qint64 uncompressBodyData(QByteDataBuffer *in, QByteDataBuffer *out); #endif }; QT_END_NAMESPACE #endif // QT_NO_HTTP #endif // QHTTPNETWORKREPLY_H