Add Setting to allow passing unknown URL schemes to QDesktopServices

A new enum UnknownUrlSchemePolicy was added to WebEngineSettings,
QWebEngineSettings and QQuickWebEngineSettings.
WebContentsDelegate now has a new attribute of that type, which can
be read and written through the public APIs
Q(Quick)WebEngineSettings::unknownUrlSchemeNavigationPolicy and
Q(Quick)WebEngineSettings::setUnknownUrlSchemeNavigationPolicy.

This way, one can control, whether URLs with unknown schemes are passed
to QDesktopServices. WebContentsAdapterClient::navigationRequested is
called on these requests, so this allows more fine-grained control
over the schemes and origins, that are allowed.

Task-number: QTBUG-58627
Change-Id: Ie81d9503456d63ea1ed5606483254acf437cd8f7
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>

3 files changed, 72 insertions, 3 deletions

diff --git a/src/webengine/api/qquickwebenginesettings.cpp b/src/webengine/api/qquickwebenginesettings.cpp
index 12d313783..44bd308ca 100644
--- a/src/webengine/api/qquickwebenginesettings.cpp
+++ b/src/webengine/api/qquickwebenginesettings.cpp
@@ -73,6 +73,22 @@ QQuickWebEngineSettings::~QQuickWebEngineSettings()
 { }
 
 /*!
+    \enum QQuickWebEngineSettings::UnknownUrlSchemePolicy
+    \since WebEngine 1.6
+
+    This enum describes how navigation requests to URLs with unknown schemes are handled.
+
+    \value DisallowUnknownUrlSchemes
+           Disallows all navigation requests to URLs with unknown schemes.
+    \value AllowUnknownUrlSchemesFromUserInteraction
+           Allows navigation requests to URLs with unknown schemes that are issued from
+           user-interaction (like a mouse-click), whereas other navigation requests (for example
+           from JavaScript) are suppressed.
+    \value AllowAllUnknownUrlSchemes
+           Allows all navigation requests to URLs with unknown schemes.
+*/
+
+/*!
     \qmlproperty bool WebEngineSettings::autoLoadImages
 
     Automatically loads images on web pages.
@@ -395,6 +411,22 @@ QString QQuickWebEngineSettings::defaultTextEncoding() const
     return d_ptr->defaultTextEncoding();
 }
 
+ASSERT_ENUMS_MATCH(QQuickWebEngineSettings::DisallowUnknownUrlSchemes, WebEngineSettings::DisallowUnknownUrlSchemes)
+ASSERT_ENUMS_MATCH(QQuickWebEngineSettings::AllowUnknownUrlSchemesFromUserInteraction, WebEngineSettings::AllowUnknownUrlSchemesFromUserInteraction)
+ASSERT_ENUMS_MATCH(QQuickWebEngineSettings::AllowAllUnknownUrlSchemes, WebEngineSettings::AllowAllUnknownUrlSchemes)
+
+/*!
+  \qmlproperty WebEngineSettings::UnknownUrlSchemePolicy WebEngineSettings::unknownUrlSchemePolicy
+  \since QtWebEngine 1.6
+  Specifies how navigation requests to URLs with unknown schemes are handled.
+
+  Default is \l{QWebEngineSettings::UnknownUrlSchemePolicy}{WebEngineSettings.AllowUnknownUrlSchemesFromUserInteraction}.
+*/
+QQuickWebEngineSettings::UnknownUrlSchemePolicy QQuickWebEngineSettings::unknownUrlSchemePolicy() const
+{
+    return static_cast<QQuickWebEngineSettings::UnknownUrlSchemePolicy>(d_ptr->unknownUrlSchemePolicy());
+}
+
 void QQuickWebEngineSettings::setAutoLoadImages(bool on)
 {
     bool wasOn = d_ptr->testAttribute(WebEngineSettings::AutoLoadImages);
@@ -599,6 +631,15 @@ void QQuickWebEngineSettings::setHideScrollbars(bool on)
         Q_EMIT hideScrollbarsChanged();
 }
 
+void QQuickWebEngineSettings::setUnknownUrlSchemePolicy(QQuickWebEngineSettings::UnknownUrlSchemePolicy policy)
+{
+    WebEngineSettings::UnknownUrlSchemePolicy oldPolicy = d_ptr->unknownUrlSchemePolicy();
+    WebEngineSettings::UnknownUrlSchemePolicy newPolicy = static_cast<WebEngineSettings::UnknownUrlSchemePolicy>(policy);
+    d_ptr->setUnknownUrlSchemePolicy(newPolicy);
+    if (oldPolicy != newPolicy)
+        Q_EMIT unknownUrlSchemePolicyChanged();
+}
+
 void QQuickWebEngineSettings::setParentSettings(QQuickWebEngineSettings *parentSettings)
 {
     d_ptr->setParentSettings(parentSettings->d_ptr.data());
diff --git a/src/webengine/api/qquickwebenginesettings_p.h b/src/webengine/api/qquickwebenginesettings_p.h
index da838f52f..234763ecf 100644
--- a/src/webengine/api/qquickwebenginesettings_p.h
+++ b/src/webengine/api/qquickwebenginesettings_p.h
@@ -88,8 +88,17 @@ class Q_WEBENGINE_PRIVATE_EXPORT QQuickWebEngineSettings : public QObject {
     Q_PROPERTY(bool allowGeolocationOnInsecureOrigins READ allowGeolocationOnInsecureOrigins WRITE setAllowGeolocationOnInsecureOrigins NOTIFY allowGeolocationOnInsecureOriginsChanged REVISION 4 FINAL)
     Q_PROPERTY(bool allowWindowActivationFromJavaScript READ allowWindowActivationFromJavaScript WRITE setAllowWindowActivationFromJavaScript NOTIFY allowWindowActivationFromJavaScriptChanged REVISION 5 FINAL)
     Q_PROPERTY(bool hideScrollbars READ hideScrollbars WRITE setHideScrollbars NOTIFY hideScrollbarsChanged REVISION 5 FINAL)
+    Q_PROPERTY(UnknownUrlSchemePolicy unknownUrlSchemePolicy READ unknownUrlSchemePolicy WRITE setUnknownUrlSchemePolicy NOTIFY unknownUrlSchemePolicyChanged REVISION 5 FINAL)
 
 public:
+    enum UnknownUrlSchemePolicy {
+        DisallowUnknownUrlSchemes = 1,
+        AllowUnknownUrlSchemesFromUserInteraction,
+        AllowAllUnknownUrlSchemes
+    };
+
+    Q_ENUM(UnknownUrlSchemePolicy)
+
     ~QQuickWebEngineSettings();
 
     bool autoLoadImages() const;
@@ -117,6 +126,7 @@ public:
     bool allowGeolocationOnInsecureOrigins() const;
     bool allowWindowActivationFromJavaScript() const;
     bool hideScrollbars() const;
+    UnknownUrlSchemePolicy unknownUrlSchemePolicy() const;
 
     void setAutoLoadImages(bool on);
     void setJavascriptEnabled(bool on);
@@ -143,6 +153,7 @@ public:
     void setAllowGeolocationOnInsecureOrigins(bool on);
     void setAllowWindowActivationFromJavaScript(bool on);
     void setHideScrollbars(bool on);
+    void setUnknownUrlSchemePolicy(UnknownUrlSchemePolicy policy);
 
 signals:
     void autoLoadImagesChanged();
@@ -170,6 +181,7 @@ signals:
     Q_REVISION(4) void allowGeolocationOnInsecureOriginsChanged();
     Q_REVISION(5) void allowWindowActivationFromJavaScriptChanged();
     Q_REVISION(5) void hideScrollbarsChanged();
+    Q_REVISION(5) void unknownUrlSchemePolicyChanged();
 
 private:
     explicit QQuickWebEngineSettings(QQuickWebEngineSettings *parentSettings = 0);
diff --git a/src/webengine/plugin/plugins.qmltypes b/src/webengine/plugin/plugins.qmltypes
index 321c462b5..e8ec1fa7a 100644
--- a/src/webengine/plugin/plugins.qmltypes
+++ b/src/webengine/plugin/plugins.qmltypes
@@ -119,10 +119,11 @@ Module {
             "QtWebEngine/WebEngineDownloadItem 1.2",
             "QtWebEngine/WebEngineDownloadItem 1.3",
             "QtWebEngine/WebEngineDownloadItem 1.4",
-            "QtWebEngine/WebEngineDownloadItem 1.5"
+            "QtWebEngine/WebEngineDownloadItem 1.5",
+            "QtWebEngine/WebEngineDownloadItem 1.6"
         ]
         isCreatable: false
-        exportMetaObjectRevisions: [0, 1, 2, 3, 4]
+        exportMetaObjectRevisions: [0, 1, 2, 3, 4, 5]
         Enum {
             name: "DownloadState"
             values: {
@@ -195,12 +196,18 @@ Module {
             isReadonly: true
         }
         Property { name: "interruptReasonString"; revision: 4; type: "string"; isReadonly: true }
+        Property { name: "isFinished"; revision: 5; type: "bool"; isReadonly: true }
+        Property { name: "isPaused"; revision: 5; type: "bool"; isReadonly: true }
         Signal { name: "savePageFormatChanged"; revision: 2 }
         Signal { name: "mimeTypeChanged"; revision: 1 }
         Signal { name: "typeChanged"; revision: 3 }
         Signal { name: "interruptReasonChanged"; revision: 4 }
+        Signal { name: "isFinishedChanged"; revision: 5 }
+        Signal { name: "isPausedChanged"; revision: 5 }
         Method { name: "accept" }
         Method { name: "cancel" }
+        Method { name: "pause" }
+        Method { name: "resume" }
     }
     Component {
         name: "QQuickWebEngineFileDialogRequest"
@@ -514,6 +521,14 @@ Module {
         ]
         isCreatable: false
         exportMetaObjectRevisions: [0, 1, 2, 3, 4, 5]
+        Enum {
+            name: "UnknownUrlSchemePolicy"
+            values: {
+                "DisallowUnknownUrlSchemes": 1,
+                "AllowUnknownUrlSchemesFromUserInteraction": 2,
+                "AllowAllUnknownUrlSchemes": 3
+            }
+        }
         Property { name: "autoLoadImages"; type: "bool" }
         Property { name: "javascriptEnabled"; type: "bool" }
         Property { name: "javascriptCanOpenWindows"; type: "bool" }
@@ -538,6 +553,7 @@ Module {
         Property { name: "allowRunningInsecureContent"; revision: 3; type: "bool" }
         Property { name: "allowGeolocationOnInsecureOrigins"; revision: 4; type: "bool" }
         Property { name: "allowWindowActivationFromJavaScript"; revision: 5; type: "bool" }
+        Property { name: "unknownUrlSchemePolicy"; revision: 5; type: "UnknownUrlSchemePolicy" }
         Signal { name: "fullScreenSupportEnabledChanged"; revision: 1 }
         Signal { name: "screenCaptureEnabledChanged"; revision: 2 }
         Signal { name: "webGLEnabledChanged"; revision: 2 }
@@ -549,6 +565,7 @@ Module {
         Signal { name: "allowRunningInsecureContentChanged"; revision: 3 }
         Signal { name: "allowGeolocationOnInsecureOriginsChanged"; revision: 4 }
         Signal { name: "allowWindowActivationFromJavaScriptChanged"; revision: 5 }
+        Signal { name: "unknownUrlSchemePolicyChanged"; revision: 5 }
     }
     Component {
         name: "QQuickWebEngineSingleton"
@@ -892,7 +909,6 @@ Module {
         Property { name: "audioMuted"; revision: 3; type: "bool" }
         Property { name: "recentlyAudible"; revision: 3; type: "bool"; isReadonly: true }
         Property { name: "webChannelWorld"; revision: 3; type: "uint" }
-        Property { name: "testSupport"; type: "QQuickWebEngineTestSupport"; isPointer: true }
         Signal {
             name: "loadingChanged"
             Parameter { name: "loadRequest"; type: "QQuickWebEngineLoadRequest"; isPointer: true }