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

**

** Copyright (C) 2009 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 "qnetworkcookie.h"

#include "qnetworkcookie_p.h"

#include "qnetworkrequest.h"

#include "qnetworkreply.h"

#include "QtCore/qbytearray.h"

#include "QtCore/qdebug.h"

#include "QtCore/qlist.h"

#include "QtCore/qlocale.h"

#include "QtCore/qstring.h"

#include "QtCore/qstringlist.h"

#include "QtCore/qurl.h"

#include "private/qobject_p.h"

QT_BEGIN_NAMESPACE

/*!

    \class QNetworkCookie

    \since 4.4

    \brief The QNetworkCookie class holds one network cookie.

    Cookies are small bits of information that stateless protocols

    like HTTP use to maintain some persistent information across

    requests.

    A cookie is set by a remote server when it replies to a request

    and it expects the same cookie to be sent back when further

    requests are sent.

    QNetworkCookie holds one such cookie as received from the

    network. A cookie has a name and a value, but those are opaque to

    the application (that is, the information stored in them has no

    meaning to the application). A cookie has an associated path name

    and domain, which indicate when the cookie should be sent again to

    the server.

    A cookie can also have an expiration date, indicating its

    validity. If the expiration date is not present, the cookie is

    considered a "session cookie" and should be discarded when the

    application exits (or when its concept of session is over).

    QNetworkCookie provides a way of parsing a cookie from the HTTP

    header format using the QNetworkCookie::parseCookies()

    function. However, when received in a QNetworkReply, the cookie is

    already parsed.

    This class implements cookies as described by the

    \l{Netscape Cookie Specification}{initial cookie specification by

    Netscape}, which is somewhat similar to the \l{RFC 2109} specification,

    plus the \l{Mitigating Cross-site Scripting With HTTP-only Cookies}

    {"HttpOnly" extension}. The more recent \l{RFC 2965} specification

    (which uses the Set-Cookie2 header) is not supported.

    \sa QNetworkCookieJar, QNetworkRequest, QNetworkReply

*/

/*!

    Create a new QNetworkCookie object, initializing the cookie name

    to \a name and its value to \a value.

    A cookie is only valid if it has a name. However, the value is

    opaque to the application and being empty may have significance to

    the remote server.

*/

QNetworkCookie::QNetworkCookie(const QByteArray &name, const QByteArray &value)

    : d(new QNetworkCookiePrivate)

{

    qRegisterMetaType<QNetworkCookie>();

    qRegisterMetaType<QList<QNetworkCookie> >();

    d->name = name;

    d->value = value;

}

/*!

    Creates a new QNetworkCookie object by copying the contents of \a

    other.

*/

QNetworkCookie::QNetworkCookie(const QNetworkCookie &other)

    : d(other.d)

{

}

/*!

    Destroys this QNetworkCookie object.

*/

QNetworkCookie::~QNetworkCookie()

{

    // QSharedDataPointer auto deletes

    d = 0;

}

/*!

    Copies the contents of the QNetworkCookie object \a other to this

    object.

*/

QNetworkCookie &QNetworkCookie::operator=(const QNetworkCookie &other)

{

    d = other.d;

    return *this;

}

/*!

    \fn bool QNetworkCookie::operator!=(const QNetworkCookie &other) const

    Returns true if this cookie is not equal to \a other.

    \sa operator==()

*/

/*!

    Returns true if this cookie is equal to \a other. This function

    only returns true if all fields of the cookie are the same.

    However, in some contexts, two cookies of the same name could be

    considered equal.

    \sa operator!=()

*/

bool QNetworkCookie::operator==(const QNetworkCookie &other) const

{

    if (d == other.d)

        return true;

    return d->name == other.d->name &&

        d->value == other.d->value &&

        d->expirationDate.toUTC() == other.d->expirationDate.toUTC() &&

        d->domain == other.d->domain &&

        d->path == other.d->path &&

        d->secure == other.d->secure &&

        d->comment == other.d->comment;

}

/*!

    Returns true if the "secure" option was specified in the cookie

    string, false otherwise.

    Secure cookies may contain private information and should not be

    resent over unencrypted connections.

    \sa setSecure()

*/

bool QNetworkCookie::isSecure() const

{

    return d->secure;

}

/*!

    Sets the secure flag of this cookie to \a enable.

    Secure cookies may contain private information and should not be

    resent over unencrypted connections.

    \sa isSecure()

*/

void QNetworkCookie::setSecure(bool enable)

{

    d->secure = enable;

}

/*!

    \since 4.5

    Returns true if the "HttpOnly" flag is enabled for this cookie.

    A cookie that is "HttpOnly" is only set and retrieved by the

    network requests and replies; i.e., the HTTP protocol. It is not

    accessible from scripts running on browsers.

    \sa isSecure()

*/

bool QNetworkCookie::isHttpOnly() const

{

    return d->httpOnly;

}

/*!

    \since 4.5

    Sets this cookie's "HttpOnly" flag to \a enable.

*/

void QNetworkCookie::setHttpOnly(bool enable)

{

    d->httpOnly = enable;

}

/*!

    Returns true if this cookie is a session cookie. A session cookie

    is a cookie which has no expiration date, which means it should be

    discarded when the application's concept of session is over

    (usually, when the application exits).

    \sa expirationDate(), setExpirationDate()

*/

bool QNetworkCookie::isSessionCookie() const

{

    return !d->expirationDate.isValid();

}

/*!

    Returns the expiration date for this cookie. If this cookie is a

    session cookie, the QDateTime returned will not be valid. If the

    date is in the past, this cookie has already expired and should

    not be sent again back to a remote server.

    The expiration date corresponds to the parameters of the "expires"

    entry in the cookie string.

    \sa isSessionCookie(), setExpirationDate()

*/

QDateTime QNetworkCookie::expirationDate() const

{

    return d->expirationDate;

}

/*!

    Sets the expiration date of this cookie to \a date. Setting an

    invalid expiration date to this cookie will mean it's a session

    cookie.

    \sa isSessionCookie(), expirationDate()

*/

void QNetworkCookie::setExpirationDate(const QDateTime &date)

{

    d->expirationDate = date;

}

/*!

    Returns the domain this cookie is associated with. This

    corresponds to the "domain" field of the cookie string.

    Note that the domain here may start with a dot, which is not a

    valid hostname. However, it means this cookie matches all

    hostnames ending with that domain name.

    \sa setDomain()

*/

QString QNetworkCookie::domain() const

{

    return d->domain;

}

/*!

    Sets the domain associated with this cookie to be \a domain.

    \sa domain()

*/

void QNetworkCookie::setDomain(const QString &domain)

{

    d->domain = domain;

}

/*!

    Returns the path associated with this cookie. This corresponds to

    the "path" field of the cookie string.

    \sa setPath()

*/

QString QNetworkCookie::path() const

{

    return d->path;

}

/*!

    Sets the path associated with this cookie to be \a path.

    \sa path()

*/

void QNetworkCookie::setPath(const QString &path)

{

    d->path = path;

}

/*!

    Returns the name of this cookie. The only mandatory field of a

    cookie is its name, without which it is not considered valid.

    \sa setName(), value()

*/

QByteArray QNetworkCookie::name() const

{

    return d->name;

}

/*!

    Sets the name of this cookie to be \a cookieName. Note that

    setting a cookie name to an empty QByteArray will make this cookie

    invalid.

    \sa name(), value()

*/

void QNetworkCookie::setName(const QByteArray &cookieName)

{

    d->name = cookieName;

}

/*!

    Returns this cookies value, as specified in the cookie

    string. Note that a cookie is still valid if its value is empty.

    Cookie name-value pairs are considered opaque to the application:

    that is, their values don't mean anything.

    \sa setValue(), name()

*/

QByteArray QNetworkCookie::value() const

{

    return d->value;

}

/*!

    Sets the value of this cookie to be \a value.

    \sa value(), name()

*/

void QNetworkCookie::setValue(const QByteArray &value)

{

    d->value = value;

}

// ### move this to qnetworkcookie_p.h and share with qnetworkaccesshttpbackend

static QPair<QByteArray, QByteArray> nextField(const QByteArray &text, int &position)

{

    // format is one of:

    //    (1)  token

    //    (2)  token = token

    //    (3)  token = quoted-string

    int i;

    const int length = text.length();

    position = nextNonWhitespace(text, position);

    // parse the first part, before the equal sign

    for (i = position; i < length; ++i) {

        register char c = text.at(i);

        if (c == ';' || c == ',' || c == '=')

            break;

    }

    QByteArray first = text.mid(position, i - position).trimmed();

    position = i;

    if (first.isEmpty())

        return qMakePair(QByteArray(), QByteArray());

    if (i == length || text.at(i) != '=')

        // no equal sign, we found format (1)

        return qMakePair(first, QByteArray());

    QByteArray second;

    second.reserve(32);         // arbitrary but works for most cases

    i = nextNonWhitespace(text, position + 1);

    if (i < length && text.at(i) == '"') {

        // a quote, we found format (3), where:

        // quoted-string  = ( <"> *(qdtext | quoted-pair ) <"> )

        // qdtext         = <any TEXT except <">>

        // quoted-pair    = "\" CHAR

        ++i;

        while (i < length) {

            register char c = text.at(i);

            if (c == '"') {

                // end of quoted text

                break;

            } else if (c == '\\') {

                ++i;

                if (i >= length)

                    // broken line

                    return qMakePair(QByteArray(), QByteArray());

                c = text.at(i);

            }

            second += c;

            ++i;

        }

        for ( ; i < length; ++i) {

            register char c = text.at(i);

            if (c == ',' || c == ';')

                break;

        }

        position = i;

    } else {

        // no quote, we found format (2)

        position = i;

        for ( ; i < length; ++i) {

            register char c = text.at(i);

            if (c == ',' || c == ';' || isLWS(c))

                break;

        }

        second = text.mid(position, i - position).trimmed();

        position = i;

    }

    if (second.isNull())

        second.resize(0); // turns into empty-but-not-null

    return qMakePair(first, second);

}

/*!

    \enum QNetworkCookie::RawForm

    This enum is used with the toRawForm() function to declare which

    form of a cookie shall be returned.

    \value NameAndValueOnly     makes toRawForm() return only the

        "NAME=VALUE" part of the cookie, as suitable for sending back

        to a server in a client request's "Cookie:" header. Multiple

        cookies are separated by a semi-colon in the "Cookie:" header

        field.

    \value Full                 makes toRawForm() return the full

        cookie contents, as suitable for sending to a client in a

        server's "Set-Cookie:" header. Multiple cookies are separated

        by commas in a "Set-Cookie:" header.

    Note that only the Full form of the cookie can be parsed back into

    its original contents.

    \sa toRawForm(), parseCookies()

*/

/*!

    Returns the raw form of this QNetworkCookie. The QByteArray

    returned by this function is suitable for an HTTP header, either

    in a server response (the Set-Cookie header) or the client request

    (the Cookie header). You can choose from one of two formats, using

    \a form.

    \sa parseCookies()

*/

QByteArray QNetworkCookie::toRawForm(RawForm form) const

{

    QByteArray result;

    if (d->name.isEmpty())

        return result;          // not a valid cookie

    result = d->name;

    result += '=';

    if (d->value.contains(';') ||

        d->value.contains(',') ||

        d->value.contains(' ') ||

        d->value.contains('"')) {

        result += '"';

        QByteArray value = d->value;

        value.replace('"', "\\\"");

        result += value;

        result += '"';

    } else {

        result += d->value;

    }

    if (form == Full) {

        // same as above, but encoding everything back

        if (isSecure())

            result += "; secure";

        if (isHttpOnly())

            result += "; HttpOnly";

        if (!isSessionCookie()) {

            result += "; expires=";

            result += QLocale::c().toString(d->expirationDate.toUTC(),

                                            QLatin1String("ddd, dd-MMM-yyyy hh:mm:ss 'GMT")).toLatin1();

        }

        if (!d->domain.isEmpty()) {

            result += "; domain=";

            QString domainNoDot = d->domain;

            if (domainNoDot.startsWith(QLatin1Char('.'))) {

                result += '.';

                domainNoDot = domainNoDot.mid(1);

            }

            result += QUrl::toAce(domainNoDot);

        }

        if (!d->path.isEmpty()) {

            result += "; path=";

            result += QUrl::toPercentEncoding(d->path, "/");

        }

    }

    return result;

}

static const char zones[] =

    "pst\0" // -8

    "pdt\0"

    "mst\0" // -7

    "mdt\0"

    "cst\0" // -6

    "cdt\0"