/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtNetwork module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QHTTPNETWORKCONNECTION_H

#define QHTTPNETWORKCONNECTION_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 <QtNetwork/qnetworkrequest.h>

#include <QtNetwork/qnetworkreply.h>

#include <QtNetwork/qabstractsocket.h>

#include <private/qobject_p.h>

#include <qauthenticator.h>

#include <qnetworkproxy.h>

#include <qbuffer.h>

#include <private/qhttpnetworkheader_p.h>

#include <private/qhttpnetworkrequest_p.h>

#include <private/qhttpnetworkreply_p.h>

#include <private/qhttpnetworkconnectionchannel_p.h>

#ifndef QT_NO_HTTP

#ifndef QT_NO_OPENSSL

#    include <QtNetwork/qsslsocket.h>

#    include <QtNetwork/qsslerror.h>

#else

#   include <QtNetwork/qtcpsocket.h>

#endif

QT_BEGIN_NAMESPACE

class QHttpNetworkRequest;

class QHttpNetworkReply;

class QByteArray;

class QHttpNetworkConnectionPrivate;

class Q_AUTOTEST_EXPORT QHttpNetworkConnection : public QObject

{

    Q_OBJECT

public:

    QHttpNetworkConnection(const QString &hostName, quint16 port = 80, bool encrypt = false, QObject *parent = 0);

    QHttpNetworkConnection(quint16 channelCount, const QString &hostName, quint16 port = 80, bool encrypt = false, QObject *parent = 0);

    ~QHttpNetworkConnection();

    //The hostname to which this is connected to.

    QString hostName() const;

    //The HTTP port in use.

    quint16 port() const;

    //add a new HTTP request through this connection

    QHttpNetworkReply* sendRequest(const QHttpNetworkRequest &request);

#ifndef QT_NO_NETWORKPROXY

    //set the proxy for this connection

    void setCacheProxy(const QNetworkProxy &networkProxy);

    QNetworkProxy cacheProxy() const;

    void setTransparentProxy(const QNetworkProxy &networkProxy);

    QNetworkProxy transparentProxy() const;

#endif

    //enable encryption

    void enableEncryption();

    bool isEncrypted() const;

    //authentication parameters

    void setProxyAuthentication(QAuthenticator *authenticator);

    void setAuthentication(const QString &domain, QAuthenticator *authenticator);

#ifndef QT_NO_OPENSSL

    void setSslConfiguration(const QSslConfiguration &config);

    void ignoreSslErrors(int channel = -1);

    void ignoreSslErrors(const QList<QSslError> &errors, int channel = -1);

Q_SIGNALS:

    void sslErrors(const QList<QSslError> &errors);

#endif

Q_SIGNALS:

#ifndef QT_NO_NETWORKPROXY

    //cannot be used with queued connection.

    void proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator,

                                     const QHttpNetworkConnection *connection = 0);

#endif

    void authenticationRequired(const QHttpNetworkRequest &request, QAuthenticator *authenticator,

                                const QHttpNetworkConnection *connection = 0);

    void error(QNetworkReply::NetworkError errorCode, const QString &detail = QString());

private:

    Q_DECLARE_PRIVATE(QHttpNetworkConnection)

    Q_DISABLE_COPY(QHttpNetworkConnection)

    friend class QHttpNetworkReply;

    friend class QHttpNetworkConnectionChannel;

    Q_PRIVATE_SLOT(d_func(), void _q_startNextRequest())

    Q_PRIVATE_SLOT(d_func(), void _q_restartAuthPendingRequests())

};

// private classes

typedef QPair<QHttpNetworkRequest, QHttpNetworkReply*> HttpMessagePair;

class QHttpNetworkConnectionPrivate : public QObjectPrivate

{

    Q_DECLARE_PUBLIC(QHttpNetworkConnection)

public:

    static const int defaultChannelCount;

    static const int defaultPipelineLength;

    QHttpNetworkConnectionPrivate(const QString &hostName, quint16 port, bool encrypt);

    QHttpNetworkConnectionPrivate(quint16 channelCount, const QString &hostName, quint16 port, bool encrypt);

    ~QHttpNetworkConnectionPrivate();

    void init();

    enum { ChunkSize = 4096 };

    int indexOf(QAbstractSocket *socket) const;

    QHttpNetworkReply *queueRequest(const QHttpNetworkRequest &request);

    void requeueRequest(const HttpMessagePair &pair); // e.g. after pipeline broke

    void dequeueAndSendRequest(QAbstractSocket *socket);

    void prepareRequest(HttpMessagePair &request);

    void fillPipeline(QAbstractSocket *socket);

    bool fillPipeline(QList<HttpMessagePair> &queue, QHttpNetworkConnectionChannel &channel);

    // read more HTTP body after the next event loop spin

    void readMoreLater(QHttpNetworkReply *reply);

    void copyCredentials(int fromChannel, QAuthenticator *auth, bool isProxy);

    // private slots

    void _q_startNextRequest(); // send the next request from the queue

    void _q_restartAuthPendingRequests(); // send the currently blocked request

    void createAuthorization(QAbstractSocket *socket, QHttpNetworkRequest &request);

    QString errorDetail(QNetworkReply::NetworkError errorCode, QAbstractSocket *socket,

                        const QString &extraDetail = QString());

#ifndef QT_NO_COMPRESS

    bool expand(QAbstractSocket *socket, QHttpNetworkReply *reply, bool dataComplete);

#endif

    void removeReply(QHttpNetworkReply *reply);

    QString hostName;

    quint16 port;

    bool encrypt;

    const int channelCount;

    QHttpNetworkConnectionChannel *channels; // parallel connections to the server

    bool pendingAuthSignal; // there is an incomplete authentication signal

    bool pendingProxyAuthSignal; // there is an incomplete proxy authentication signal

    qint64 uncompressedBytesAvailable(const QHttpNetworkReply &reply) const;

    qint64 uncompressedBytesAvailableNextBlock(const QHttpNetworkReply &reply) const;

    void emitReplyError(QAbstractSocket *socket, QHttpNetworkReply *reply, QNetworkReply::NetworkError errorCode);

    bool handleAuthenticateChallenge(QAbstractSocket *socket, QHttpNetworkReply *reply, bool isProxy, bool &resend);

#ifndef QT_NO_NETWORKPROXY

    QNetworkProxy networkProxy;

    void emitProxyAuthenticationRequired(const QHttpNetworkConnectionChannel *chan, const QNetworkProxy &proxy, QAuthenticator* auth);

#endif

    //The request queues

    QList<HttpMessagePair> highPriorityQueue;

    QList<HttpMessagePair> lowPriorityQueue;

    friend class QHttpNetworkConnectionChannel;

};

QT_END_NAMESPACE

#endif // QT_NO_HTTP

#endif