Differential D14379 Diff 39241 webenginepart/src/webenginepartcookiejar.cpp

Changeset View

Standalone View

View Options

webenginepart/src/webenginepartcookiejar.cpp

  • This file was added.
1​/*
2​ * This file is part of the KDE project
3​ * Copyright (C) 2018 Stefano Crocco <stefano.crocco@alice.it>
4​ *
5​ * This program is free software; you can redistribute it and/or
6​ * modify it under the terms of the GNU General Public License as
7​ * published by the Free Software Foundation; either version 2 of
8​ * the License or (at your option) version 3 or any later version
9​ * accepted by the membership of KDE e.V. (or its successor approved
10​ * by the membership of KDE e.V.), which shall act as a proxy
11​ * defined in Section 14 of version 3 of the license.
12​ *
13​ * This library is distributed in the hope that it will be useful,
14​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
15​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16​ * Library General Public License for more details.
17​ *
18​ * You should have received a copy of the GNU Library General Public License
19​ * along with this library; see the file COPYING.LIB. If not, write to
20​ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21​ * Boston, MA 02110-1301, USA.
22​ *
23​*/
24​
25​#include "webenginepartcookiejar.h"
26​#include "settings/webenginesettings.h"
27​
28​#include <QtWebEngine/QtWebEngineVersion>
29​#include <QWebEngineProfile>
30​#include <QWebEngineCookieStore>
31​#include <QStringList>
32​#include <QDBusInterface>
33​#include <QDBusReply>
34​#include <QDebug>
35​#include <QWidget>
36​#include <QDateTime>
37​#include <QTimeZone>
38​#include <QApplication>
39​
40​const QVariant WebEnginePartCookieJar::s_findCookieFields = QVariant::fromValue(QList<int>{
41​ static_cast<int>(CookieDetails::domain),
42​ static_cast<int>(CookieDetails::path),
43​ static_cast<int>(CookieDetails::name),
44​ static_cast<int>(CookieDetails::host),
45​ static_cast<int>(CookieDetails::value),
46​ static_cast<int>(CookieDetails::expirationDate),
47​ static_cast<int>(CookieDetails::protocolVersion),
48​ static_cast<int>(CookieDetails::secure)
49​ }
50​);
51​
52​WebEnginePartCookieJar::CookieIdentifier::CookieIdentifier(const QNetworkCookie& cookie):
53​ name(cookie.name()), domain(cookie.domain()), path(cookie.path())
54​{
55​}
56​
57​WebEnginePartCookieJar::CookieIdentifier::CookieIdentifier(const QString& n, const QString& d, const QString& p):
58​ name(n), domain(d), path(p)
59​{
60​}
61​
62​WebEnginePartCookieJar::WebEnginePartCookieJar(QWebEngineProfile *prof, QObject *parent):
63​ QObject(parent), m_cookieStore(prof->cookieStore()),
64​ m_cookieServer("org.kde.kcookiejar5", "/modules/kcookiejar", "org.kde.KCookieServer")
65​{
66​ prof->setPersistentCookiesPolicy(QWebEngineProfile::NoPersistentCookies);
67​ connect(qApp, &QApplication::lastWindowClosed, this, &WebEnginePartCookieJar::deleteSessionCookies);
68​ connect(m_cookieStore, &QWebEngineCookieStore::cookieAdded, this, &WebEnginePartCookieJar::addCookie);
69​ connect(m_cookieStore, &QWebEngineCookieStore::cookieRemoved, this, &WebEnginePartCookieJar::removeCookie);
70​ if(!m_cookieServer.isValid()){
71​ qDebug() << "Couldn't connect to KCookieServer";
72​ }
73​ loadKIOCookies();
74​
75​ //QWebEngineCookieStore::setCookieFilter only exists from Qt 5.11.0
76​#if QTWEBENGINE_VERSION >= QT_VERSION_CHECK(5,11,0)
77​ auto filter = [this](const QWebEngineCookieStore::FilterRequest &req){return filterCookie(req);};
78​ m_cookieStore->setCookieFilter(filter);
79​#endif //QTWEBENGINE_VERSION >= QT_VERSION_CHECK(5,11,0)
80​}
81​
82​WebEnginePartCookieJar::~WebEnginePartCookieJar()
83​{
84​}
85​
86​bool WebEnginePartCookieJar::filterCookie(const QWebEngineCookieStore::FilterRequest& req)
87​{
88​ return WebEngineSettings::self()->acceptCrossDomainCookies() || !req.thirdParty;
89​}
90​
91​void WebEnginePartCookieJar::deleteSessionCookies()
92​{
93​ if (!m_cookieServer.isValid()) {
94​ return;
95​ }
96​ foreach(qlonglong id, m_windowsWithSessionCookies) {
97​ m_cookieServer.call(QDBus::NoBlock, "deleteSessionCookies", id);
98​ }
99​}
100​
101​QUrl WebEnginePartCookieJar::constructUrlForCookie(const QNetworkCookie& cookie) const
102​{
103​ QUrl url;
104​ QString domain = cookie.domain().startsWith(".") ? cookie.domain().mid(1) : cookie.domain();
105​ if (!domain.isEmpty()) {
106​ url.setScheme("http");
107​ url.setHost(domain);
108​ url.setPath(cookie.path());
109​ } else {
110​ qDebug() << "EMPTY COOKIE DOMAIN for" << cookie.name();
111​ }
112​ return url;
113​}
114​
115​qlonglong WebEnginePartCookieJar::findWinID()
116​{
117​ QWidget *mainWindow = qApp->activeWindow();
118​ if (mainWindow && !(mainWindow->windowFlags() & Qt::Dialog)) {
dfaureUnsubmitted
Not Done

Hmm, if this can be triggered async, the active window could be anything at the time this gets called. Including a dialog box... no way to pass along some proper view identifier?

dfaure: Hmm, if this can be triggered async, the active window could be anything at the time this gets…
stefanocroccoAuthorUnsubmitted
Not Done

I can't think of a way to pass a view identifier. To avoid the possibility of a dialog box, I checked for the absence of the Qt::Dialog window flag.

stefanocrocco: I can't think of a way to pass a view identifier. To avoid the possibility of a dialog box, I…
dfaureUnsubmitted
Not Done

OK, that's already something.

It leaves the risk that the user had time to switch to another browser window meanwhile, but yeah, not sure what we can do about it.

dfaure: OK, that's already something. It leaves the risk that the user had time to switch to another…
119​ return mainWindow->winId();
120​ } else {
121​ QWidgetList windows = qApp->topLevelWidgets();
122​ foreach(QWidget *w, windows){
123​ if (w->isWindow() && !(w->windowFlags() & Qt::Dialog)) {
124​ return w->winId();
dfaureUnsubmitted
Not Done

Shouldn't this test for dialogs too?

dfaure: Shouldn't this test for dialogs too?
125​ }
126​ }
127​ }
128​ return 0;
129​}
130​
131​void WebEnginePartCookieJar::addCookie(const QNetworkCookie& _cookie)
132​{
133​ //If the added cookie is in m_cookiesLoadedFromKCookieServer, it means
134​ //we're loading the cookie from KCookieServer (from the call to loadKIOCookies
135​ //in the constructor (QWebEngineCookieStore::setCookie is asynchronous, though,
136​ //so we're not in the constructor anymore)), so don't attempt to add
137​ //the cookie back to KCookieServer; instead, remove it from the list.
138​ if (m_cookiesLoadedFromKCookieServer.removeOne(_cookie)) {
139​ return;
140​ }
141​
142​ QNetworkCookie cookie(_cookie);
143​ CookieIdentifier id(cookie);
144​
145​ if (!m_cookieServer.isValid()) {
146​ return;
147​ }
148​
149​ if (cookie.expirationDate().isValid()) {
150​ //There's a bug in KCookieJar which causes the expiration date to be interpreted as local time
151​ //instead of GMT as it should. The bug is fixed in KIO 5.50
dfaureUnsubmitted
Not Done

Please update the comment now that I fixed the bug.

The fix will only be in 5.50 though, so you can keep a workaround with a KIO version ifdef, if you want.

dfaure: Please update the comment now that I fixed the bug. The fix will only be in 5.50 though, so…
152​#if KIO_VERSION < QT_VERSION_CHECK(5,50,0)
153​ QDateTime dt = cookie.expirationDate();
154​ dt.setTimeZone(QTimeZone("GMT"));
155​ cookie.setExpirationDate(dt);
156​#endif
157​ }
158​ QUrl url = constructUrlForCookie(cookie);
159​ if (url.isEmpty()) {
160​ return;
161​ }
162​ QByteArray header("Set-Cookie: ");
163​ header += cookie.toRawForm();
164​ header += "\n";
165​ qlonglong winId = findWinID();
166​ if (!cookie.expirationDate().isValid()) {
167​ m_windowsWithSessionCookies.insert(winId);
168​ }
169​// qDebug() << url;
170​ QString advice = askAdvice(url);
171​ if (advice == "Reject"){
172​ m_pendingRejectedCookies << CookieIdentifier(_cookie);
173​ m_cookieStore->deleteCookie(_cookie);
174​ } else if (advice == "AcceptForSession" && !cookie.isSessionCookie()) {
175​ cookie.setExpirationDate(QDateTime());
176​ addCookie(cookie);
177​ } else {
178​ int oldTimeout = m_cookieServer.timeout();
179​ if (advice == "Ask") {
180​ //Give the user time (10 minutes = 600 000ms) to analyze the cookie
181​ m_cookieServer.setTimeout(10*60*1000);
182​ }
183​ m_cookieServer.call(QDBus::Block, "addCookies", url.toString(), header, winId);
dfaureUnsubmitted
Not Done

I find 10 * 60 * 1000 more readable, but OK, I'm nitpicking ;)

dfaure: I find 10 * 60 * 1000 more readable, but OK, I'm nitpicking ;)
184​ m_cookieServer.setTimeout(oldTimeout);
185​ if (m_cookieServer.lastError().isValid()) {
186​ qDebug() << m_cookieServer.lastError();
187​ return;
188​ }
189​ if (!advice.startsWith("Accept") && !cookieInKCookieJar(id, url)) {
190​ m_pendingRejectedCookies << id;
191​ m_cookieStore->deleteCookie(_cookie);
192​ }
193​ }
194​}
195​
196​QString WebEnginePartCookieJar::askAdvice(const QUrl& url)
197​{
198​ if (!m_cookieServer.isValid()) {
199​ return QString();
200​ }
201​ QDBusReply<QString> rep = m_cookieServer.call(QDBus::Block, "getDomainAdvice", url.toString());
202​ if (rep.isValid()) {
203​ return rep.value();
204​ } else {
205​ qDebug() << rep.error().message();
206​ return QString();
207​ }
dfaureUnsubmitted
Not Done

join with previous line

dfaure: join with previous line
208​}
209​
210​bool WebEnginePartCookieJar::cookieInKCookieJar(const WebEnginePartCookieJar::CookieIdentifier& _id, const QUrl& url)
211​{
212​ if (!m_cookieServer.isValid()) {
213​ return false;
214​ }
215​ CookieIdentifier id(_id.name, prependDotToDomain(_id.domain), _id.path);
216​ QList<int> fields = {
217​ static_cast<int>(CookieDetails::name),
218​ static_cast<int>(CookieDetails::domain),
219​ static_cast<int>(CookieDetails::path)
220​ };
221​ QDBusReply<QStringList> rep = m_cookieServer.call(QDBus::Block, "findCookies", QVariant::fromValue(fields), id.domain, url.toString(QUrl::FullyEncoded), id.path, id.name);
222​ if (!rep.isValid()) {
223​ qDebug() << rep.error().message();
224​ return false;
225​ }
226​ QStringList cookies = rep.value();
227​ for(int i = 0; i < cookies.length()-2; i+=3){
228​ if (CookieIdentifier(cookies.at(i), cookies.at(i+1), cookies.at(i+2)) == id) {
229​ return true;
230​ }
dfaureUnsubmitted
Not Done

This could go out of bounds if cookies doesn't have a multiple-of-3 number of items. Safer to write i < cookies.length() - 2, right?

dfaure: This could go out of bounds if `cookies` doesn't have a multiple-of-3 number of items. Safer to…
stefanocroccoAuthorUnsubmitted
Not Done

It should never happen, since KCookieServer::findCookies returns 3 fields (the number of elements in the fields variable) for each cookie. However, as you say, better be on the safe side.

stefanocrocco: It should never happen, since `KCookieServer::findCookies` returns 3 fields (the number of…
231​ }
232​ return false;
233​}
234​
235​void WebEnginePartCookieJar::removeCookie(const QNetworkCookie& cookie)
236​{
237​ CookieIdentifier id(cookie);
238​
239​ int pos = m_pendingRejectedCookies.indexOf(id);
240​ //Ignore pending cookies
241​ if (pos >= 0) {
242​ m_pendingRejectedCookies.takeAt(pos);
243​ return;
244​ }
245​
246​ if (!m_cookieServer.isValid()) {
247​ return;
248​ }
249​
250​ QUrl url = constructUrlForCookie(cookie);
251​ if(url.isEmpty()){
252​ qDebug() << "Can't remove cookie" << cookie.name() << "because its URL isn't known";
253​ return;
254​ }
255​
256​ //Add leading dot to domain, if necessary
257​ id.domain = prependDotToDomain(id.domain);
258​
259​ m_cookieServer.call(QDBus::NoBlock, "deleteCookie", cookie.domain(), url.host().toLower(), cookie.path(), cookie.name());
260​ if (m_cookieServer.lastError().isValid()) {
261​ qDebug() << m_cookieServer.lastError();
262​ }
263​}
264​
265​void WebEnginePartCookieJar::loadKIOCookies()
266​{
267​ CookieList cookies = findKIOCookies();
268​ foreach(const QNetworkCookie& cookie, cookies){
269​ QDateTime currentTime = QDateTime::currentDateTime();
270​ //Don't attempt to add expired cookies
271​ if (cookie.expirationDate().isValid() && cookie.expirationDate() < currentTime) {
272​ continue;
273​ }
274​ m_cookiesLoadedFromKCookieServer << cookie;
275​ m_cookieStore->setCookie(cookie);
276​ }
277​}
278​
279​WebEnginePartCookieJar::CookieList WebEnginePartCookieJar::findKIOCookies()
280​{
281​ CookieList res;
282​ if (!m_cookieServer.isValid()) {
283​ return res;
284​ }
285​ QDBusReply<QStringList> rep = m_cookieServer.call(QDBus::Block, "findDomains");
286​ if(!rep.isValid()){
287​ qDebug() << rep.error().message();
288​ return res;
289​ }
290​ QStringList domains = rep.value();
291​ uint fieldsCount = 8;
292​ foreach( const QString &d, domains){
293​ QDBusReply<QStringList> rep = m_cookieServer.call(QDBus::Block, "findCookies", s_findCookieFields, d, "", "", "");
294​ if (!rep.isValid()) {
295​ qDebug() << rep.error().message();
296​ return res;
297​ }
298​ QStringList data = rep.value();
299​ for(int i = 0; i < data.count(); i+=fieldsCount){
300​ res << parseKIOCookie(data, i);
301​ }
302​ }
303​ return res;
304​}
305​
306​QNetworkCookie WebEnginePartCookieJar::parseKIOCookie(const QStringList& data, int start)
307​{
308​ QNetworkCookie c;
309​ auto extractField = [data, start](CookieDetails field){return data.at(start + static_cast<int>(field));};
310​ c.setDomain(data.at(start+static_cast<int>(CookieDetails::domain)).toUtf8());
311​ c.setExpirationDate(QDateTime::fromSecsSinceEpoch(extractField(CookieDetails::expirationDate).toInt()));
312​ c.setName(extractField(CookieDetails::name).toUtf8());
313​ c.setPath(extractField(CookieDetails::path).toUtf8());
314​ c.setSecure(extractField(CookieDetails::secure).toInt()); //1 for true, 0 for false
315​ c.setValue(extractField(CookieDetails::value).toUtf8());
316​ return c;
317​}
318​
319​QDebug operator<<(QDebug deb, const WebEnginePartCookieJar::CookieIdentifier& id)
320​{
321​ QDebugStateSaver saver(deb);
322​ deb << "(" << id.name << "," << id.domain << "," << id.path << ")";
323​ return deb;
324​}