From 17bd9d9de2d424ef7f7a193e17d1619d6effec7b Mon Sep 17 00:00:00 2001
From: Allan Sandfeld Jensen <allan.jensen@qt.io>
Date: Tue, 24 Jul 2018 09:41:25 +0200
Subject: Add setRequestInterceptor to QWebEnginePage
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Makes it possible to make page specific intercepts, and is at the same
time safer by running in the UI-thread.

[ChangeLog][QtWebEngineWidgets][QWebEnginePage] Added
setRequestInterceptor, similar to the same call on profile except
it operates on a per-page basis and on the UI-thread.

Change-Id: Id5a7173156c25d0f030f00b6ef314d283c7c8cdd
Reviewed-by: Jüri Valdmann <juri.valdmann@qt.io>
---
 src/webenginewidgets/api/qwebenginepage.cpp  | 37 ++++++++++++++++++++++++++++
 src/webenginewidgets/api/qwebenginepage.h    |  3 +++
 src/webenginewidgets/api/qwebenginepage_p.h  |  2 ++
 src/webenginewidgets/api/qwebengineprofile.h |  1 +
 4 files changed, 43 insertions(+)

(limited to 'src/webenginewidgets/api')

diff --git a/src/webenginewidgets/api/qwebenginepage.cpp b/src/webenginewidgets/api/qwebenginepage.cpp
index fbb7c1f9e..1f9b2f72a 100644
--- a/src/webenginewidgets/api/qwebenginepage.cpp
+++ b/src/webenginewidgets/api/qwebenginepage.cpp
@@ -241,6 +241,7 @@ QWebEnginePagePrivate::QWebEnginePagePrivate(QWebEngineProfile *_profile)
     , webChannelWorldId(QWebEngineScript::MainWorld)
     , defaultAudioMuted(false)
     , defaultZoomFactor(1.0)
+    , requestInterceptor(nullptr)
 #if QT_CONFIG(webengine_printing_and_pdf)
     , currentPrinter(nullptr)
 #endif
@@ -260,6 +261,8 @@ QWebEnginePagePrivate::QWebEnginePagePrivate(QWebEngineProfile *_profile)
 
 QWebEnginePagePrivate::~QWebEnginePagePrivate()
 {
+    if (requestInterceptor)
+        profile->d_ptr->profileAdapter()->removePageRequestInterceptor();
     delete history;
     delete settings;
 }
@@ -1781,6 +1784,40 @@ void QWebEnginePagePrivate::printRequested()
     });
 }
 
+/*!
+    \since 5.13
+
+    Registers the request interceptor \a interceptor to intercept URL requests.
+
+    The page does not take ownership of the pointer. This interceptor is called
+    after any interceptors on the profile, and unlike profile interceptors, is run
+    on the UI thread, making it thread-safer. Only URL requests from this page are
+    intercepted.
+
+    To unset the request interceptor, set a \c nullptr.
+
+    \sa QWebEngineUrlRequestInfo, QWebEngineProfile::setRequestInterceptor()
+*/
+
+void QWebEnginePage::setRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)
+{
+    Q_D(QWebEnginePage);
+    bool hadInterceptorChanged = bool(d->requestInterceptor) != bool(interceptor);
+    d->requestInterceptor = interceptor;
+    if (hadInterceptorChanged) {
+        if (interceptor)
+            d->profile->d_ptr->profileAdapter()->addPageRequestInterceptor();
+        else
+            d->profile->d_ptr->profileAdapter()->removePageRequestInterceptor();
+    }
+}
+
+void QWebEnginePagePrivate::interceptRequest(QWebEngineUrlRequestInfo &info)
+{
+    if (requestInterceptor)
+        requestInterceptor->interceptRequest(info);
+}
+
 #if QT_CONFIG(menu)
 QMenu *QWebEnginePage::createStandardContextMenu()
 {
diff --git a/src/webenginewidgets/api/qwebenginepage.h b/src/webenginewidgets/api/qwebenginepage.h
index 6dd2da21c..a6bad4f26 100644
--- a/src/webenginewidgets/api/qwebenginepage.h
+++ b/src/webenginewidgets/api/qwebenginepage.h
@@ -71,6 +71,7 @@ class QWebEngineQuotaRequest;
 class QWebEngineRegisterProtocolHandlerRequest;
 class QWebEngineScriptCollection;
 class QWebEngineSettings;
+class QWebEngineUrlRequestInterceptor;
 
 class QWEBENGINEWIDGETS_EXPORT QWebEnginePage : public QObject {
     Q_OBJECT
@@ -305,6 +306,8 @@ public:
     void setDevToolsPage(QWebEnginePage *page);
     QWebEnginePage *devToolsPage() const;
 
+    void setRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor);
+
     const QWebEngineContextMenuData &contextMenuData() const;
 
 Q_SIGNALS:
diff --git a/src/webenginewidgets/api/qwebenginepage_p.h b/src/webenginewidgets/api/qwebenginepage_p.h
index 66a92dec9..6d214adca 100644
--- a/src/webenginewidgets/api/qwebenginepage_p.h
+++ b/src/webenginewidgets/api/qwebenginepage_p.h
@@ -149,6 +149,7 @@ public:
     void printRequested() override;
     const QObject *holdingQObject() const override;
     ClientType clientType() override { return QtWebEngineCore::WebContentsAdapterClient::WidgetsClient; }
+    void interceptRequest(QWebEngineUrlRequestInfo &) override;
 
     QtWebEngineCore::ProfileAdapter *profileAdapter() override;
     QtWebEngineCore::WebContentsAdapter *webContentsAdapter() override;
@@ -187,6 +188,7 @@ public:
     bool defaultAudioMuted;
     qreal defaultZoomFactor;
     QTimer wasShownTimer;
+    QWebEngineUrlRequestInterceptor *requestInterceptor;
 
     mutable QtWebEngineCore::CallbackDirectory m_callbacks;
     mutable QAction *actions[QWebEnginePage::WebActionCount];
diff --git a/src/webenginewidgets/api/qwebengineprofile.h b/src/webenginewidgets/api/qwebengineprofile.h
index 2c0b5ca03..3f17137e7 100644
--- a/src/webenginewidgets/api/qwebengineprofile.h
+++ b/src/webenginewidgets/api/qwebengineprofile.h
@@ -144,6 +144,7 @@ private:
     Q_DECLARE_PRIVATE(QWebEngineProfile)
     QWebEngineProfile(QWebEngineProfilePrivate *, QObject *parent = Q_NULLPTR);
 
+    friend class QWebEnginePage;
     friend class QWebEnginePagePrivate;
     friend class QWebEngineUrlSchemeHandler;
     QScopedPointer<QWebEngineProfilePrivate> d_ptr;
-- 
cgit v1.2.3