Merge pull request #1115 from LibertyGlobal/jgocol/ONEM-31242-upstream

Add configuration option to allow moving window to background when window.close is called

Author: magomez

Source/WTF/Scripts/Preferences/WebPreferences.yaml

@@ -120,6 +120,19 @@ AllowMediaContentTypesRequiringHardwareSupportAsFallback:
     WebCore:
       default: false
 
+AllowMoveToSuspendOnWindowClose:
+  type: bool
+  humanReadableName: "Allow move to suspend on window.close()"
+  humanReadableDescription: "Allow to suspend browser instead of closing window on window.close()"
+  condition: PLATFORM(WPE)
+  defaultValue:
+    WebKitLegacy:
+      default: false
+    WebKit:
+      default: false
+    WebCore:
+      default: false
+
 AllowMultiElementImplicitSubmission:
   type: bool
   webKitLegacyPreferenceKey: WebKitAllowMultiElementImplicitFormSubmissionPreferenceKey

Source/WebCore/page/DOMWindow.cpp

@@ -1073,17 +1073,19 @@ void DOMWindow::close()
     if (!frame->isMainFrame())
         return;
 
-    if (!(page->openedByDOM() || page->backForward().count() <= 1 || frame->settings().allowScriptsToCloseWindows())) {
-        console()->addMessage(MessageSource::JS, MessageLevel::Warning, "Can't close the window since it was not opened by JavaScript"_s);
-        return;
-    }
+    if (!frame->settings().allowMoveToSuspendOnWindowClose()) {
+        if (!(page->openedByDOM() || page->backForward().count() <= 1 || frame->settings().allowScriptsToCloseWindows())) {
+            console()->addMessage(MessageSource::JS, MessageLevel::Warning, "Can't close the window since it was not opened by JavaScript"_s);
+            return;
+        }
 
-    if (!frame->loader().shouldClose())
-        return;
+        if (!frame->loader().shouldClose())
+            return;
 
-    ResourceLoadObserver::shared().updateCentralStatisticsStore([] { });
+        ResourceLoadObserver::shared().updateCentralStatisticsStore([] { });
 
-    page->setIsClosing();
+        page->setIsClosing();
+    }
 
     document()->eventLoop().queueTask(TaskSource::DOMManipulation, [this, protectedThis = Ref { *this }] {
         if (auto* page = this->page())

Source/WebKit/UIProcess/API/glib/WebKitSettings.cpp

@@ -177,6 +177,7 @@ enum {
     PROP_ALLOW_RUNNING_OF_INSECURE_CONTENT,
     PROP_ALLOW_DISPLAY_OF_INSECURE_CONTENT,
     PROP_ALLOW_SCRIPTS_TO_CLOSE_WINDOWS,
+    PROP_ALLOW_MOVE_TO_SUSPEND_ON_WINDOW_CLOSE,
     PROP_ENABLE_DIRECTORY_UPLOAD,
     N_PROPERTIES,
 };
@@ -423,6 +424,9 @@ ALLOW_DEPRECATED_DECLARATIONS_END
     case PROP_ALLOW_SCRIPTS_TO_CLOSE_WINDOWS:
         webkit_settings_set_allow_scripts_to_close_windows(settings, g_value_get_boolean(value));
         break;
+    case PROP_ALLOW_MOVE_TO_SUSPEND_ON_WINDOW_CLOSE:
+        webkit_settings_set_allow_move_to_suspend_on_window_close(settings, g_value_get_boolean(value));
+        break;
     case PROP_ENABLE_DIRECTORY_UPLOAD:
         webkit_settings_set_enable_directory_upload(settings, g_value_get_boolean(value));
         break;
@@ -642,6 +646,9 @@ ALLOW_DEPRECATED_DECLARATIONS_END
     case PROP_ALLOW_SCRIPTS_TO_CLOSE_WINDOWS:
         g_value_set_boolean(value, webkit_settings_get_allow_scripts_to_close_windows(settings));
         break;
+    case PROP_ALLOW_MOVE_TO_SUSPEND_ON_WINDOW_CLOSE:
+        g_value_set_boolean(value, webkit_settings_get_allow_move_to_suspend_on_window_close(settings));
+        break;
     case PROP_ENABLE_DIRECTORY_UPLOAD:
         g_value_set_boolean(value, webkit_settings_get_enable_directory_upload(settings));
         break;
@@ -1699,6 +1706,19 @@ static void webkit_settings_class_init(WebKitSettingsClass* klass)
         FALSE,
         readWriteConstructParamFlags);
 
+    /**
+     * WebKitSettings:allow-move-to-suspend-on-window-close:
+     *
+     * Allow browser to move to suspend on window close.
+     *
+     */
+    sObjProperties[PROP_ALLOW_MOVE_TO_SUSPEND_ON_WINDOW_CLOSE] = g_param_spec_boolean(
+        "allow-scripts-to-close-windows",
+        _("Allow move to suspend on window.close()"),
+        _("Allow to suspend browser instead of closing window on window.close()"),
+        FALSE,
+        readWriteConstructParamFlags);
+
     /**
      * WebKitSettings:enable-directory-upload:
      *
@@ -4260,6 +4280,42 @@ webkit_settings_set_allow_scripts_to_close_windows(WebKitSettings *settings, gbo
     g_object_notify(G_OBJECT(settings), "allow-scripts-to-close-windows");
 }
 
+/**
+ * webkit_settings_get_allow_move_to_suspend_on_window_close:
+ * @settings: a #WebKitSettings
+ *
+ * Get the #WebKitSettings:allow-move-to-suspend-on-window-close property.
+ *
+ * Returns: %TRUE If browser can be suspended on window close.
+ */
+gboolean webkit_settings_get_allow_move_to_suspend_on_window_close (WebKitSettings *settings)
+{
+    g_return_val_if_fail(WEBKIT_IS_SETTINGS(settings), FALSE);
+
+    return settings->priv->preferences->allowMoveToSuspendOnWindowClose();
+}
+
+/**
+ * webkit_settings_set_allow_move_to_suspend_on_window_close
+ * @settings: a #WebKitSettings
+ * @allowed: Value to be set
+ *
+ * Set the #WebKitSettings:allow-move-to-suspend-on-window-close property.
+ */
+WEBKIT_API void
+webkit_settings_set_allow_move_to_suspend_on_window_close(WebKitSettings *settings, gboolean allowed)
+{
+    g_return_if_fail(WEBKIT_IS_SETTINGS(settings));
+
+    WebKitSettingsPrivate* priv = settings->priv;
+    bool currentValue = priv->preferences->allowMoveToSuspendOnWindowClose();
+    if (currentValue == allowed)
+        return;
+
+    priv->preferences->setAllowMoveToSuspendOnWindowClose(allowed);
+    g_object_notify(G_OBJECT(settings), "allow-move-to-suspend-on-window-close");
+}
+
 /**
  * webkit_settings_get_enable_directory_upload:
  * @settings: a #WebKitSettings

Source/WebKit/UIProcess/API/wpe/WebKitSettings.h

@@ -513,6 +513,12 @@ webkit_settings_get_allow_scripts_to_close_windows              (WebKitSettings
 WEBKIT_API void
 webkit_settings_set_allow_scripts_to_close_windows              (WebKitSettings *settings,
                                                                  gboolean        allowed);
+WEBKIT_API gboolean
+webkit_settings_get_allow_move_to_suspend_on_window_close       (WebKitSettings *settings);
+
+WEBKIT_API void
+webkit_settings_set_allow_move_to_suspend_on_window_close       (WebKitSettings *settings,
+                                                                 gboolean allowed);
 
 WEBKIT_API gboolean
 webkit_settings_get_enable_directory_upload                    (WebKitSettings *settings);