From 48411fd28057a56d8dccb7c5ec311da39a2291d5 Mon Sep 17 00:00:00 2001
From: Manish Goregaokar <manishearth@gmail.com>
Date: Wed, 29 Jan 2014 17:07:16 -0800
Subject: [PATCH] Bug 474527 - onbeforeaccept handler in a <prefwindow> can't
 prevent the window from closing; r=enndeakin,MattN The majority of the patch
 was by Gavin Sharp.

---
 toolkit/content/tests/chrome/chrome.ini       |  2 +
 .../chrome/test_preferences_beforeaccept.xul  | 61 +++++++++++++++++++
 .../window_preferences_beforeaccept.xul       | 45 ++++++++++++++
 toolkit/content/widgets/preferences.xml       |  9 ++-
 4 files changed, 114 insertions(+), 3 deletions(-)
 create mode 100644 toolkit/content/tests/chrome/test_preferences_beforeaccept.xul
 create mode 100644 toolkit/content/tests/chrome/window_preferences_beforeaccept.xul

diff --git a/toolkit/content/tests/chrome/chrome.ini b/toolkit/content/tests/chrome/chrome.ini
index 34f5478c7658..6ace95648513 100644
--- a/toolkit/content/tests/chrome/chrome.ini
+++ b/toolkit/content/tests/chrome/chrome.ini
@@ -127,6 +127,8 @@ skip-if = os == "win" # Intermittent failures, bug 919016
 [test_popupremoving_frame.xul]
 [test_position.xul]
 [test_preferences.xul]
+[test_preferences_beforeaccept.xul]
+support-files = window_preferences_beforeaccept.xul
 [test_progressmeter.xul]
 [test_props.xul]
 [test_radio.xul]
diff --git a/toolkit/content/tests/chrome/test_preferences_beforeaccept.xul b/toolkit/content/tests/chrome/test_preferences_beforeaccept.xul
new file mode 100644
index 000000000000..eaa9ff10cbe2
--- /dev/null
+++ b/toolkit/content/tests/chrome/test_preferences_beforeaccept.xul
@@ -0,0 +1,61 @@
+<?xml version="1.0"?>
+<?xml-stylesheet href="chrome://global/skin" type="text/css"?>
+<?xml-stylesheet href="chrome://mochikit/content/tests/SimpleTest/test.css" type="text/css"?>
+
+<window title="Preferences Window beforeaccept Tests"
+        xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
+
+  <script type="application/javascript"
+          src="chrome://mochikit/content/MochiKit/packed.js"/>
+  <script type="application/javascript"
+          src="chrome://mochikit/content/tests/SimpleTest/SimpleTest.js"/>
+
+  <script type="application/javascript">
+  <![CDATA[
+    SimpleTest.waitForExplicitFinish();
+
+    // No instant-apply for this test
+    SpecialPowers.setBoolPref("browser.preferences.instantApply", false);
+
+    var prefWindow = openDialog("window_preferences_beforeaccept.xul", "", "", windowOnload);
+
+    SimpleTest.registerCleanupFunction(() => {
+      SpecialPowers.clearUserPref("browser.preferences.instantApply");
+      SpecialPowers.clearUserPref("tests.beforeaccept.dialogShown");
+      SpecialPowers.clearUserPref("tests.beforeaccept.called");
+    });
+
+    function windowOnload() {
+      var dialogShown = prefWindow.document.getElementById("tests.beforeaccept.dialogShown");
+      var called = prefWindow.document.getElementById("tests.beforeaccept.called");
+      is(dialogShown.value, true, "dialog opened, shown pref set");
+      is(dialogShown.valueFromPreferences, null, "shown pref not committed");
+      is(called.value, null, "beforeaccept not yet called");
+      is(called.valueFromPreferences, null, "beforeaccept not yet called, pref not committed");
+
+      // try to accept the dialog, should fail the first time
+      prefWindow.document.documentElement.acceptDialog();
+      is(prefWindow.closed, false, "window not closed");
+      is(dialogShown.value, true, "shown pref still set");
+      is(dialogShown.valueFromPreferences, null, "shown pref still not committed");
+      is(called.value, true, "beforeaccept called");
+      is(called.valueFromPreferences, null, "called pref not committed");
+
+      // try again, this one should succeed
+      prefWindow.document.documentElement.acceptDialog();
+      is(prefWindow.closed, true, "window now closed");
+      is(dialogShown.valueFromPreferences, true, "shown pref committed");
+      is(called.valueFromPreferences, true, "called pref committed");
+
+      SimpleTest.finish();
+    }
+  ]]>
+  </script>
+
+  <body xmlns="http://www.w3.org/1999/xhtml">
+    <p id="display"></p>
+    <div id="content" style="display: none"></div>
+    <pre id="test"></pre>
+  </body>
+
+</window>
diff --git a/toolkit/content/tests/chrome/window_preferences_beforeaccept.xul b/toolkit/content/tests/chrome/window_preferences_beforeaccept.xul
new file mode 100644
index 000000000000..ba200b614947
--- /dev/null
+++ b/toolkit/content/tests/chrome/window_preferences_beforeaccept.xul
@@ -0,0 +1,45 @@
+<?xml version="1.0"?>
+<?xml-stylesheet href="chrome://global/skin" type="text/css"?>
+<!--
+  XUL Widget Test for preferences window with beforeaccept
+-->
+<prefwindow xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
+            title="preferences window"
+            width="300" height="300"
+            windowtype="test:preferences"
+            buttons="accept,cancel"
+            onbeforeaccept="return beforeAccept();"
+            onload="onDialogLoad();"
+>
+  <script type="application/javascript">
+  <![CDATA[
+    function onDialogLoad() {
+      var pref = document.getElementById("tests.beforeaccept.dialogShown");
+      pref.value = true;
+
+      // call the onload handler we were passed
+      window.arguments[0]();
+    }
+
+    function beforeAccept() {
+      var beforeAcceptPref = document.getElementById("tests.beforeaccept.called");
+      var oldValue = beforeAcceptPref.value;
+      beforeAcceptPref.value = true;
+
+      return !!oldValue;
+    }
+  ]]>
+  </script>
+
+  <prefpane id="sample_pane" label="Sample Prefpane">
+    <preferences id="sample_preferences">
+      <preference id="tests.beforeaccept.called"
+                  name="tests.beforeaccept.called"
+                  type="bool"/>
+      <preference id="tests.beforeaccept.dialogShown"
+                  name="tests.beforeaccept.dialogShown"
+                  type="bool"/>
+    </preferences>
+  </prefpane>
+  <label>Test Prefpane</label>
+</prefwindow>
diff --git a/toolkit/content/widgets/preferences.xml b/toolkit/content/widgets/preferences.xml
index fc27733324e4..72ea5ff62131 100644
--- a/toolkit/content/widgets/preferences.xml
+++ b/toolkit/content/widgets/preferences.xml
@@ -1031,9 +1031,10 @@
     <handlers>
       <handler event="dialogaccept">
       <![CDATA[
-        if (!this._fireEvent("beforeaccept", this)) 
-          return;
-        
+        if (!this._fireEvent("beforeaccept", this)){
+          return false;
+        }
+
         if (this.type == "child" && window.opener) {
           var psvc = Components.classes["@mozilla.org/preferences-service;1"]
                                .getService(Components.interfaces.nsIPrefBranch);
@@ -1096,6 +1097,8 @@
                                .getService(Components.interfaces.nsIPrefService);
           psvc.savePrefFile(null);
         }
+
+        return true;
       ]]>
       </handler>
       <handler event="command">