Add QWebEngineCookieStoreClient core API

This class or its subclass can be set on the
QWebEngineProfile and its API enables intercepting
Chromium's cookies, setting and deleting cookies
in the cookie store.
These functions are asynchronous so if the result
of the task is needed the user can provide a
callback which will be run on the calling thread
when the requested operation finishes.
This does not include a hook for QQuick layer yet,
there we have to figure out what the most convenient
way is from a developer's perspective.

Change-Id: I6a3af071883ce632df7a2fb952da93f306ac3fe2
Reviewed-by: Pierre Rossi <pierre.rossi@theqtcompany.com>

1 files changed, 151 insertions, 0 deletions

diff --git a/src/core/api/qwebenginecookiestoreclient.cpp b/src/core/api/qwebenginecookiestoreclient.cpp
new file mode 100644
index 000000000..c8b314be9
--- /dev/null
+++ b/src/core/api/qwebenginecookiestoreclient.cpp
@@ -0,0 +1,151 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later 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 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qwebenginecookiestoreclient.h"
+#include "qwebenginecookiestoreclient_p.h"
+
+#include <QByteArray>
+#include <QUrl>
+
+QT_BEGIN_NAMESPACE
+
+using namespace QtWebEngineCore;
+
+QWebEngineCookieStoreClientPrivate::QWebEngineCookieStoreClientPrivate(QWebEngineCookieStoreClient* q)
+    : m_nextCallbackId(CallbackDirectory::ReservedCallbackIdsEnd)
+    , delegate(0)
+    , q_ptr(q)
+{
+}
+
+QWebEngineCookieStoreClientPrivate::~QWebEngineCookieStoreClientPrivate()
+{
+
+}
+
+void QWebEngineCookieStoreClientPrivate::processPendingUserCookies()
+{
+    Q_ASSERT(delegate);
+    Q_ASSERT(delegate->hasCookieMonster());
+
+    if (m_pendingUserCookies.isEmpty())
+        return;
+
+    Q_FOREACH (const auto &cookieData, m_pendingUserCookies) {
+        if (cookieData.callbackId == CallbackDirectory::DeleteCookieCallbackId)
+            delegate->deleteCookie(cookieData.cookie, cookieData.origin);
+        else
+            delegate->setCookie(cookieData.callbackId, cookieData.cookie, cookieData.origin);
+    }
+
+    m_pendingUserCookies.clear();
+}
+
+void QWebEngineCookieStoreClientPrivate::setCookie(const QWebEngineCallback<bool> &callback, const QNetworkCookie &cookie, const QUrl &origin)
+{
+    const quint64 currentCallbackId = callback ? m_nextCallbackId++ : static_cast<quint64>(CallbackDirectory::NoCallbackId);
+
+    if (currentCallbackId != CallbackDirectory::NoCallbackId)
+        callbackDirectory.registerCallback(currentCallbackId, callback);
+
+    if (!delegate || !delegate->hasCookieMonster()) {
+        m_pendingUserCookies.append(CookieData{ currentCallbackId, cookie, origin });
+        return;
+    }
+
+    delegate->setCookie(currentCallbackId, cookie, origin);
+}
+
+void QWebEngineCookieStoreClientPrivate::deleteCookie(const QNetworkCookie &cookie, const QUrl &url)
+{
+    if (!delegate || !delegate->hasCookieMonster()) {
+        m_pendingUserCookies.append(CookieData{ CallbackDirectory::DeleteCookieCallbackId, cookie, url });
+        return;
+    }
+
+    delegate->deleteCookie(cookie, url);
+}
+
+void QWebEngineCookieStoreClientPrivate::onSetCallbackResult(qint64 callbackId, bool success)
+{
+    callbackDirectory.invoke(callbackId, success);
+}
+
+void QWebEngineCookieStoreClientPrivate::onCookieChanged(const QNetworkCookie &cookie, bool removed)
+{
+    Q_Q(QWebEngineCookieStoreClient);
+    if (removed)
+        Q_EMIT q->cookieRemoved(cookie);
+    else
+        Q_EMIT q->cookieAdded(cookie);
+}
+
+void QWebEngineCookieStoreClientPrivate::onCookieStoreLoaded()
+{
+    Q_Q(QWebEngineCookieStoreClient);
+    Q_EMIT q->cookieStoreLoaded();
+}
+
+QWebEngineCookieStoreClient::QWebEngineCookieStoreClient(QObject *parent)
+    : QObject(parent)
+    , d_ptr(new QWebEngineCookieStoreClientPrivate(this))
+{
+
+}
+
+QWebEngineCookieStoreClient::~QWebEngineCookieStoreClient()
+{
+
+}
+
+void QWebEngineCookieStoreClient::setCookieWithCallback(const QNetworkCookie &cookie, const QWebEngineCallback<bool> &resultCallback, const QUrl &origin)
+{
+    Q_D(QWebEngineCookieStoreClient);
+    d->setCookie(resultCallback, cookie, origin);
+}
+
+void QWebEngineCookieStoreClient::setCookie(const QNetworkCookie &cookie, const QUrl &origin)
+{
+    setCookieWithCallback(cookie, QWebEngineCallback<bool>(), origin);
+}
+
+void QWebEngineCookieStoreClient::deleteCookie(const QNetworkCookie &cookie, const QUrl &origin)
+{
+    Q_D(QWebEngineCookieStoreClient);
+    d->deleteCookie(cookie, origin);
+}
+
+QT_END_NAMESPACE