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

**

** 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$

**

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

#include "qnetworkaccessmanager.h"

#include "qnetworkaccessmanager_p.h"

#include "qnetworkrequest.h"

#include "qnetworkreply.h"

#include "qnetworkreply_p.h"

#include "qnetworkcookie.h"

#include "qabstractnetworkcache.h"

#include "QtNetwork/qnetworksession.h"

#include "qnetworkaccesshttpbackend_p.h"

#include "qnetworkaccessftpbackend_p.h"

#include "qnetworkaccessfilebackend_p.h"

#include "qnetworkaccessdatabackend_p.h"

#include "qnetworkaccessdebugpipebackend_p.h"

#include "qfilenetworkreply_p.h"

#include "QtCore/qbuffer.h"

#include "QtCore/qurl.h"

#include "QtCore/qvector.h"

#include "QtNetwork/qauthenticator.h"

#include "QtNetwork/qsslconfiguration.h"

#include "QtNetwork/qnetworkconfigmanager.h"

QT_BEGIN_NAMESPACE

#ifndef QT_NO_HTTP

Q_GLOBAL_STATIC(QNetworkAccessHttpBackendFactory, httpBackend)

#endif // QT_NO_HTTP

Q_GLOBAL_STATIC(QNetworkAccessFileBackendFactory, fileBackend)

Q_GLOBAL_STATIC(QNetworkAccessDataBackendFactory, dataBackend)

#ifndef QT_NO_FTP

Q_GLOBAL_STATIC(QNetworkAccessFtpBackendFactory, ftpBackend)

#endif // QT_NO_FTP

#ifdef QT_BUILD_INTERNAL

Q_GLOBAL_STATIC(QNetworkAccessDebugPipeBackendFactory, debugpipeBackend)

#endif

static void ensureInitialized()

{

#ifndef QT_NO_HTTP

    (void) httpBackend();

#endif // QT_NO_HTTP

    (void) dataBackend();

#ifndef QT_NO_FTP

    (void) ftpBackend();

#endif

#ifdef QT_BUILD_INTERNAL

    (void) debugpipeBackend();

#endif

    // leave this one last since it will query the special QAbstractFileEngines

    (void) fileBackend();

}

/*!

    \class QNetworkAccessManager

    \brief The QNetworkAccessManager class allows the application to

    send network requests and receive replies

    \since 4.4

    \ingroup network

    \inmodule QtNetwork

    \reentrant

    The Network Access API is constructed around one QNetworkAccessManager

    object, which holds the common configuration and settings for the requests

    it sends. It contains the proxy and cache configuration, as well as the

    signals related to such issues, and reply signals that can be used to

    monitor the progress of a network operation. One QNetworkAccessManager

    should be enough for the whole Qt application.

    Once a QNetworkAccessManager object has been created, the application can

    use it to send requests over the network. A group of standard functions

    are supplied that take a request and optional data, and each return a

    QNetworkReply object. The returned object is used to obtain any data

    returned in response to the corresponding request.

    A simple download off the network could be accomplished with:

    \snippet doc/src/snippets/code/src_network_access_qnetworkaccessmanager.cpp 0

    QNetworkAccessManager has an asynchronous API.

    When the \tt replyFinished slot above is called, the parameter it

    takes is the QNetworkReply object containing the downloaded data

    as well as meta-data (headers, etc.).

    \note After the request has finished, it is the responsibility of the user

    to delete the QNetworkReply object at an appropriate time. Do not directly

    delete it inside the slot connected to finished(). You can use the

    deleteLater() function.

    \note QNetworkAccessManager queues the requests it receives. The number

    of requests executed in parallel is dependent on the protocol.

    Currently, for the HTTP protocol on desktop platforms, 6 requests are

    executed in parallel for one host/port combination.

    A more involved example, assuming the manager is already existent,

    can be:

    \snippet doc/src/snippets/code/src_network_access_qnetworkaccessmanager.cpp 1

    \section1 Network and Roaming support

    With the addition of the \l {Bearer Management} API to Qt 4.7

    QNetworkAccessManager gained the ability to manage network connections.

    QNetworkAccessManager can start the network interface if the device is

    offline and terminates the interface if the current process is the last

    one to use the uplink. Note that some platform utilize grace periods from

    when the last application stops using a uplink until the system actually

    terminates the connectivity link. Roaming is equally transparent. Any

    queued/pending network requests are automatically transferred to new

    access point.

    Clients wanting to utilize this feature should not require any changes. In fact

    it is likely that existing platform specific connection code can simply be

    removed from the application.

    \note The network and roaming support in QNetworkAccessManager is conditional

    upon the platform supporting connection management. The

    \l QNetworkConfigurationManager::NetworkSessionRequired can be used to

    detect whether QNetworkAccessManager utilizes this feature. Currently only

    Meego/Harmattan and Symbian platforms provide connection management support.

    \note This feature cannot be used in combination with the Bearer Management

    API as provided by QtMobility. Applications have to migrate to the Qt version

    of Bearer Management.

    \section1 Symbian Platform Security Requirements

    On Symbian, processes which use this class must have the

    \c NetworkServices platform security capability. If the client

    process lacks this capability, operations will result in a panic.

    Platform security capabilities are added via the

    \l{qmake-variable-reference.html#target-capability}{TARGET.CAPABILITY}

    qmake variable.

    \sa QNetworkRequest, QNetworkReply, QNetworkProxy

*/

/*!

    \enum QNetworkAccessManager::Operation

    Indicates the operation this reply is processing.

    \value HeadOperation        retrieve headers operation (created

    with head())

    \value GetOperation         retrieve headers and download contents

    (created with get())

    \value PutOperation         upload contents operation (created

    with put())

    \value PostOperation        send the contents of an HTML form for

    processing via HTTP POST (created with post())

    \value DeleteOperation      delete contents operation (created with

    deleteResource())

    \value CustomOperation      custom operation (created with

    \omitvalue UnknownOperation

    \sa QNetworkReply::operation()

*/

/*!

    \enum QNetworkAccessManager::NetworkAccessibility

    Indicates whether the network is accessible via this network access manager.

    \value UnknownAccessibility     The network accessibility cannot be determined.

    \value NotAccessible            The network is not currently accessible, either because there

                                    is currently no network coverage or network access has been

                                    explicitly disabled by a call to setNetworkAccessible().

    \value Accessible               The network is accessible.

    \sa networkAccessible

*/

/*!

    \property QNetworkAccessManager::networkAccessible

    \brief whether the network is currently accessible via this network access manager.

    \since 4.7

    If the network is \l {NotAccessible}{not accessible} the network access manager will not

    process any new network requests, all such requests will fail with an error.  Requests with

    URLs with the file:// scheme will still be processed.

    By default the value of this property reflects the physical state of the device.  Applications

    may override it to disable all network requests via this network access manager by calling

    \snippet doc/src/snippets/code/src_network_access_qnetworkaccessmanager.cpp 4

    Network requests can be reenabled again by calling

    \snippet doc/src/snippets/code/src_network_access_qnetworkaccessmanager.cpp 5

    \note Calling setNetworkAccessible() does not change the network state.

*/

/*!

    \fn void QNetworkAccessManager::networkAccessibleChanged(QNetworkAccessManager::NetworkAccessibility accessible)

    This signal is emitted when the value of the \l networkAccessible property changes.

    \a accessible is the new network accessibility.

*/

/*!

    \fn void QNetworkAccessManager::networkSessionConnected()

    \since 4.7

    \internal

    This signal is emitted when the status of the network session changes into a usable (Connected)

    state. It is used to signal to QNetworkReplys to start or migrate their network operation once

    the network session has been opened or finished roaming.

*/

/*!

    \fn void QNetworkAccessManager::proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator)

    This signal is emitted whenever a proxy requests authentication

    and QNetworkAccessManager cannot find a valid, cached

    credential. The slot connected to this signal should fill in the

    credentials for the proxy \a proxy in the \a authenticator object.

    QNetworkAccessManager will cache the credentials internally. The

    next time the proxy requests authentication, QNetworkAccessManager

    will automatically send the same credential without emitting the

    proxyAuthenticationRequired signal again.

    If the proxy rejects the credentials, QNetworkAccessManager will

    emit the signal again.

    \sa proxy(), setProxy(), authenticationRequired()

*/

/*!

    \fn void QNetworkAccessManager::authenticationRequired(QNetworkReply *reply, QAuthenticator *authenticator)

    This signal is emitted whenever a final server requests

    authentication before it delivers the requested contents. The slot

    connected to this signal should fill the credentials for the

    contents (which can be determined by inspecting the \a reply

    object) in the \a authenticator object.

    QNetworkAccessManager will cache the credentials internally and

    will send the same values if the server requires authentication

    again, without emitting the authenticationRequired() signal. If it

    rejects the credentials, this signal will be emitted again.

    \sa proxyAuthenticationRequired()

*/

/*!

    \fn void QNetworkAccessManager::finished(QNetworkReply *reply)

    This signal is emitted whenever a pending network reply is

    finished. The \a reply parameter will contain a pointer to the

    reply that has just finished. This signal is emitted in tandem

    with the QNetworkReply::finished() signal.

    See QNetworkReply::finished() for information on the status that

    the object will be in.

    \note Do not delete the \a reply object in the slot connected to this

    signal. Use deleteLater().

    \sa QNetworkReply::finished(), QNetworkReply::error()

*/

/*!

    \fn void QNetworkAccessManager::sslErrors(QNetworkReply *reply, const QList<QSslError> &errors)

    This signal is emitted if the SSL/TLS session encountered errors

    during the set up, including certificate verification errors. The

    \a errors parameter contains the list of errors and \a reply is

    the QNetworkReply that is encountering these errors.

    To indicate that the errors are not fatal and that the connection

    should proceed, the QNetworkReply::ignoreSslErrors() function should be called

    from the slot connected to this signal. If it is not called, the

    SSL session will be torn down before any data is exchanged

    (including the URL).

    This signal can be used to display an error message to the user

    indicating that security may be compromised and display the

    SSL settings (see sslConfiguration() to obtain it). If the user

    decides to proceed after analyzing the remote certificate, the

    slot should call ignoreSslErrors().

    \sa QSslSocket::sslErrors(), QNetworkReply::sslErrors(),

    QNetworkReply::sslConfiguration(), QNetworkReply::ignoreSslErrors()

*/

class QNetworkAuthenticationCredential

{

public:

    QString domain;

    QString user;

    QString password;

};

Q_DECLARE_TYPEINFO(QNetworkAuthenticationCredential, Q_MOVABLE_TYPE);

inline bool operator<(const QNetworkAuthenticationCredential &t1, const QString &t2)

{ return t1.domain < t2; }

class QNetworkAuthenticationCache: private QVector<QNetworkAuthenticationCredential>,

                                   public QNetworkAccessCache::CacheableObject

{

public:

    QNetworkAuthenticationCache()

    {

        setExpires(false);

        setShareable(true);

        reserve(1);

    }

    QNetworkAuthenticationCredential *findClosestMatch(const QString &domain)

    {

        iterator it = qLowerBound(begin(), end(), domain);

        if (it == end() && !isEmpty())

            --it;

        if (it == end() || !domain.startsWith(it->domain))

            return 0;

        return &*it;

    }

    void insert(const QString &domain, const QString &user, const QString &password)

    {

        QNetworkAuthenticationCredential *closestMatch = findClosestMatch(domain);

        if (closestMatch && closestMatch->domain == domain) {

            // we're overriding the current credentials

            closestMatch->user = user;

            closestMatch->password = password;

        } else {

            QNetworkAuthenticationCredential newCredential;

            newCredential.domain = domain;

            newCredential.user = user;

            newCredential.password = password;

            if (closestMatch)

                QVector<QNetworkAuthenticationCredential>::insert(++closestMatch, newCredential);

            else

                QVector<QNetworkAuthenticationCredential>::insert(end(), newCredential);

        }

    }

    virtual void dispose() { delete this; }

};

#ifndef QT_NO_NETWORKPROXY

static QByteArray proxyAuthenticationKey(const QNetworkProxy &proxy, const QString &realm)

{

    QUrl key;

    switch (proxy.type()) {

    case QNetworkProxy::Socks5Proxy:

        key.setScheme(QLatin1String("proxy-socks5"));

        break;

    case QNetworkProxy::HttpProxy:

    case QNetworkProxy::HttpCachingProxy:

        key.setScheme(QLatin1String("proxy-http"));

        break;

    case QNetworkProxy::FtpCachingProxy:

        key.setScheme(QLatin1String("proxy-ftp"));

        break;

    case QNetworkProxy::DefaultProxy:

    case QNetworkProxy::NoProxy:

        // shouldn't happen

        return QByteArray();

        // no default:

        // let there be errors if a new proxy type is added in the future

    }

    if (key.scheme().isEmpty())

        // proxy type not handled

        return QByteArray();

    key.setUserName(proxy.user());

    key.setHost(proxy.hostName());

    key.setPort(proxy.port());

    key.setFragment(realm);

    return "auth:" + key.toEncoded();

}

#endif

static inline QByteArray authenticationKey(const QUrl &url, const QString &realm)

{

    QUrl copy = url;

    copy.setFragment(realm);

    return "auth:" + copy.toEncoded(QUrl::RemovePassword | QUrl::RemovePath | QUrl::RemoveQuery);

}

/*!

    Constructs a QNetworkAccessManager object that is the center of

    the Network Access API and sets \a parent as the parent object.

*/

QNetworkAccessManager::QNetworkAccessManager(QObject *parent)

    : QObject(*new QNetworkAccessManagerPrivate, parent)

{

    ensureInitialized();

}

/*!

    Destroys the QNetworkAccessManager object and frees up any

    resources. Note that QNetworkReply objects that are returned from

    this class have this object set as their parents, which means that

    they will be deleted along with it if you don't call

    QObject::setParent() on them.

*/

QNetworkAccessManager::~QNetworkAccessManager()

{

#ifndef QT_NO_NETWORKPROXY

    delete d_func()->proxyFactory;

#endif

    // Delete the QNetworkReply children first.

    // Else a QAbstractNetworkCache might get deleted in ~QObject

    // before a QNetworkReply that accesses the QAbstractNetworkCache

    // object in its destructor.

    qDeleteAll(findChildren<QNetworkReply *>());

    // The other children will be deleted in this ~QObject

    // FIXME instead of this "hack" make the QNetworkReplyImpl

    // properly watch the cache deletion, e.g. via a QWeakPointer.

}

#ifndef QT_NO_NETWORKPROXY

/*!

    Returns the QNetworkProxy that the requests sent using this

    QNetworkAccessManager object will use. The default value for the

    proxy is QNetworkProxy::DefaultProxy.

    \sa setProxy(), setProxyFactory(), proxyAuthenticationRequired()

*/

QNetworkProxy QNetworkAccessManager::proxy() const

{

    return d_func()->proxy;

}

/*!

    Sets the proxy to be used in future requests to be \a proxy. This

    does not affect requests that have already been sent. The

    proxyAuthenticationRequired() signal will be emitted if the proxy

    requests authentication.

    A proxy set with this function will be used for all requests

    issued by QNetworkAccessManager. In some cases, it might be

    necessary to select different proxies depending on the type of

    request being sent or the destination host. If that's the case,

    you should consider using setProxyFactory().

    \sa proxy(), proxyAuthenticationRequired()

*/

void QNetworkAccessManager::setProxy(const QNetworkProxy &proxy)

{

    Q_D(QNetworkAccessManager);

    delete d->proxyFactory;

    d->proxy = proxy;

    d->proxyFactory = 0;

}

/*!

    \fn QNetworkProxyFactory *QNetworkAccessManager::proxyFactory() const

    \since 4.5

    Returns the proxy factory that this QNetworkAccessManager object

    is using to determine the proxies to be used for requests.