/**************************************************************************** ** ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). ** 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 either Technology Preview License Agreement or the ** Beta Release License Agreement. ** ** 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.0, included in the file LGPL_EXCEPTION.txt in this ** package. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 3.0 as published by the Free Software ** Foundation and appearing in the file LICENSE.GPL included in the ** packaging of this file. Please review the following information to ** ensure the GNU General Public License version 3.0 requirements will be ** met: http://www.gnu.org/copyleft/gpl.html. ** ** If you are unsure which license is appropriate for your use, please ** contact the sales department at http://qt.nokia.com/contact. ** $QT_END_LICENSE$ ** ****************************************************************************/ #include "qnetworkcookiejar.h" #include "qnetworkcookiejar_p.h" #include "QtNetwork/qnetworkcookie.h" #include "QtCore/qurl.h" #include "QtCore/qdatetime.h" QT_BEGIN_NAMESPACE /*! \class QNetworkCookieJar \brief The QNetworkCookieJar class implements a simple jar of QNetworkCookie objects \since 4.4 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. The cookie jar is the object that holds all cookies set in previous requests. Web browsers save their cookie jars to disk in order to conserve permanent cookies across invocations of the application. QNetworkCookieJar does not implement permanent storage: it only keeps the cookies in memory. Once the QNetworkCookieJar object is deleted, all cookies it held will be discarded as well. If you want to save the cookies, you should derive from this class and implement the saving to disk to your own storage format. This class implements only the basic security recommended by the cookie specifications and does not implement any cookie acceptance policy (it accepts all cookies set by any requests). In order to override those rules, you should reimplement the cookiesForUrl() and setCookiesFromUrl() virtual functions. They are called by QNetworkReply and QNetworkAccessManager when they detect new cookies and when they require cookies. \sa QNetworkCookie, QNetworkAccessManager, QNetworkReply, QNetworkRequest, QNetworkAccessManager::setCookieJar() */ /*! Creates a QNetworkCookieJar object and sets the parent object to be \a parent. The cookie jar is initialized to empty. */ QNetworkCookieJar::QNetworkCookieJar(QObject *parent) : QObject(*new QNetworkCookieJarPrivate, parent) { } /*! Destroys this cookie jar object and discards all cookies stored in it. Cookies are not saved to disk in the QNetworkCookieJar default implementation. If you need to save the cookies to disk, you have to derive from QNetworkCookieJar and save the cookies to disk yourself. */ QNetworkCookieJar::~QNetworkCookieJar() { } /*! Returns all cookies stored in this cookie jar. This function is suitable for derived classes to save cookies to disk, as well as to implement cookie expiration and other policies. \sa setAllCookies(), cookiesForUrl() */ QList QNetworkCookieJar::allCookies() const { return d_func()->allCookies; } /*! Sets the internal list of cookies held by this cookie jar to be \a cookieList. This function is suitable for derived classes to implement loading cookies from permanent storage, or their own cookie acceptance policies by reimplementing setCookiesFromUrl(). \sa allCookies(), setCookiesFromUrl() */ void QNetworkCookieJar::setAllCookies(const QList &cookieList) { Q_D(QNetworkCookieJar); d->allCookies = cookieList; } static inline bool isParentPath(QString path, QString reference) { if (!path.endsWith(QLatin1Char('/'))) path += QLatin1Char('/'); if (!reference.endsWith(QLatin1Char('/'))) reference += QLatin1Char('/'); return path.startsWith(reference); } static inline bool isParentDomain(QString domain, QString reference) { if (!reference.startsWith(QLatin1Char('.'))) return domain == reference; return domain.endsWith(reference) || domain == reference.mid(1); } /*! Adds the cookies in the list \a cookieList to this cookie jar. Default values for path and domain are taken from the \a url object. Returns true if one or more cookes are set for url otherwise false. If a cookie already exists in the cookie jar, it will be overridden by those in \a cookieList. The default QNetworkCookieJar class implements only a very basic security policy (it makes sure that the cookies' domain and path match the reply's). To enhance the security policy with your own algorithms, override setCookiesFromUrl(). Also, QNetworkCookieJar does not have a maximum cookie jar size. Reimplement this function to discard older cookies to create room for new ones. \sa cookiesForUrl(), QNetworkAccessManager::setCookieJar() */ bool QNetworkCookieJar::setCookiesFromUrl(const QList &cookieList, const QUrl &url) { Q_D(QNetworkCookieJar); QString defaultDomain = url.host(); QString pathAndFileName = url.path(); QString defaultPath = pathAndFileName.left(pathAndFileName.lastIndexOf(QLatin1Char('/'))+1); if (defaultPath.isEmpty()) defaultPath = QLatin1Char('/'); int added = 0; QDateTime now = QDateTime::currentDateTime(); foreach (QNetworkCookie cookie, cookieList) { bool isDeletion = !cookie.isSessionCookie() && cookie.expirationDate() < now; // validate the cookie & set the defaults if unset if (cookie.path().isEmpty()) cookie.setPath(defaultPath); else if (!isParentPath(pathAndFileName, cookie.path())) continue; // not accepted if (cookie.domain().isEmpty()) { cookie.setDomain(defaultDomain); } else { QString domain = cookie.domain(); if (!(isParentDomain(domain, defaultDomain) || isParentDomain(defaultDomain, domain))) { continue; // not accepted } // reject if domain is like ".com" // (i.e., reject if domain does not contain embedded dots, see RFC 2109 section 4.3.2) // this is just a rudimentary check and does not cover all cases if (domain.lastIndexOf(QLatin1Char('.')) == 0) continue; // not accepted } QList::Iterator it = d->allCookies.begin(), end = d->allCookies.end(); for ( ; it != end; ++it) // does this cookie already exist? if (cookie.name() == it->name() && cookie.domain() == it->domain() && cookie.path() == it->path()) { // found a match d->allCookies.erase(it); break; } // did not find a match if (!isDeletion) { d->allCookies += cookie; ++added; } } return (added > 0); } /*! Returns the cookies to be added to when a request is sent to \a url. This function is called by the default QNetworkAccessManager::createRequest(), which adds the cookies returned by this function to the request being sent. If more than one cookie with the same name is found, but with differing paths, the one with longer path is returned before the one with shorter path. In other words, this function returns cookies sorted by path length. The default QNetworkCookieJar class implements only a very basic security policy (it makes sure that the cookies' domain and path match the reply's). To enhance the security policy with your own algorithms, override cookiesForUrl(). \sa setCookiesFromUrl(), QNetworkAccessManager::setCookieJar() */ QList QNetworkCookieJar::cookiesForUrl(const QUrl &url) const { // \b Warning! This is only a dumb implementation! // It does NOT follow all of the recommendations from // http://wp.netscape.com/newsref/std/cookie_spec.html // It does not implement a very good cross-domain verification yet. Q_D(const QNetworkCookieJar); QDateTime now = QDateTime::currentDateTime(); QList result; // scan our cookies for something that matches QList::ConstIterator it = d->allCookies.constBegin(), end = d->allCookies.constEnd(); for ( ; it != end; ++it) { if (!isParentDomain(url.host(), it->domain())) continue; if (!isParentPath(url.path(), it->path())) continue; if (!(*it).isSessionCookie() && (*it).expirationDate() < now) continue; // insert this cookie into result, sorted by path QList::Iterator insertIt = result.begin(); while (insertIt != result.end()) { if (insertIt->path().length() < it->path().length()) { // insert here insertIt = result.insert(insertIt, *it); break; } else { ++insertIt; } } // this is the shortest path yet, just append if (insertIt == result.end()) result += *it; } return result; } QT_END_NAMESPACE