Bug 718088: offer to re-set keyword.URL if it has a non-default value, r=bz on the docshell parts, r=fryn on the rest, ui-r=limi

--HG--
extra : transplant_source : F%5E%C6ge%1B%5B%14%0C%20%C4%C7%82%DA%D9%96%C0%86%A5%C6

browser/components/nsBrowserGlue.js

@@ -64,6 +64,9 @@ XPCOMUtils.defineLazyGetter(this, "PlacesUtils", function() {
   return PlacesUtils;
 });
 
+XPCOMUtils.defineLazyModuleGetter(this, "KeywordURLResetPrompter",
+                                  "resource:///modules/KeywordURLResetPrompter.jsm");
+
 const PREF_PLUGINS_NOTIFYUSER = "plugins.update.notifyUser";
 const PREF_PLUGINS_UPDATEURL  = "plugins.update.url";
 
@@ -277,6 +280,13 @@ BrowserGlue.prototype = {
           this._initPlaces();
         }
         break;
+      case "defaultURIFixup-using-keyword-pref":
+        if (KeywordURLResetPrompter.shouldPrompt) {
+          let keywordURI = subject.QueryInterface(Ci.nsIURI);
+          KeywordURLResetPrompter.prompt(this.getMostRecentBrowserWindow(),
+                                         keywordURI);
+        }
+        break;
     }
   }, 
 
@@ -306,6 +316,7 @@ BrowserGlue.prototype = {
     os.addObserver(this, "distribution-customization-complete", false);
     os.addObserver(this, "places-shutdown", false);
     this._isPlacesShutdownObserver = true;
+    os.addObserver(this, "defaultURIFixup-using-keyword-pref", false);
   },
 
   // cleanup (called on application shutdown)
@@ -334,6 +345,7 @@ BrowserGlue.prototype = {
       os.removeObserver(this, "places-database-locked");
     if (this._isPlacesShutdownObserver)
       os.removeObserver(this, "places-shutdown");
+    os.removeObserver(this, "defaultURIFixup-using-keyword-pref");
   },
 
   _onAppDefaults: function BG__onAppDefaults() {

browser/locales/en-US/chrome/browser/browser.properties

@@ -333,6 +333,22 @@ telemetryYesButtonLabel2 = Yes, I want to help
 telemetryYesButtonAccessKey = Y
 telemetryNoButtonLabel = No
 telemetryNoButtonAccessKey = N
+
+# Keyword.URL reset prompt
+# LOCALIZATION NOTE (keywordPrompt.message):
+#  - %1$S is brandShortName
+#  - %2$S is a host name (e.g. "somewebsearch.com") from the current value of keyword.URL
+#  - %3$S is the name of the default search engine (e.g. "Google")
+keywordPrompt.message = %1$S is using '%2$S' for searches from the location bar. Would you like to restore the default search (%3$S)?
+
+# LOCALIZATION NOTE (keywordPrompt.yesButton): %1$S is the name of the default search engine
+keywordPrompt.yesButton = Yes, use %1$S
+keywordPrompt.yesButton.accessKey = Y
+
+# LOCALIZATION NOTE (keywordPrompt.noButton): %1$S is a host name (e.g. "somewebsearch.com") from the current value of keyword.URL
+keywordPrompt.noButton = No, continue using '%1$S'
+keywordPrompt.noButton.accessKey  = N
+
 # Telemetry opt-out prompt for Aurora and Nightly
 # LOCALIZATION NOTE (telemetryOptOutPrompt): %1$S and %3$S will be replaced by
 # brandFullName, and %2$S by the value of the toolkit.telemetry.server_owner preference.

browser/modules/KeywordURLResetPrompter.jsm

@@ -0,0 +1,105 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+let EXPORTED_SYMBOLS = [ "KeywordURLResetPrompter" ];
+
+const Ci = Components.interfaces;
+const Cc = Components.classes;
+const Cu = Components.utils;
+
+Cu.import("resource://gre/modules/Services.jsm");
+
+const KEYWORD_PROMPT_REV = 1;
+
+let KeywordURLResetPrompter = {
+  get shouldPrompt() {
+    let keywordURLUserSet = Services.prefs.prefHasUserValue("keyword.URL");
+    let declinedRev;
+    try {
+      declinedRev = Services.prefs.getIntPref("browser.keywordURLPromptDeclined");
+    } catch (ex) {}
+
+    return keywordURLUserSet && declinedRev != KEYWORD_PROMPT_REV;
+  },
+
+  prompt: function KeywordURLResetPrompter_prompt(win, keywordURI) {
+    let tabbrowser = win.gBrowser;
+    let notifyBox = tabbrowser.getNotificationBox();
+
+    let existingNotification = notifyBox.getNotificationWithValue("keywordURL-reset");
+    if (existingNotification)
+      return;
+
+    // Find the name/URI of this build's original default engine.
+    // XXX: Can't use originalDefaultEngine getter here, because that doesn't
+    //      use the default pref branch.
+    let defaultURI;
+    let defaultEngine;
+    try {
+      let defaultPB = Services.prefs.getDefaultBranch(null);
+      let defaultName = defaultPB.getComplexValue("browser.search.defaultenginename",
+                                                  Ci.nsIPrefLocalizedString).data;
+      defaultEngine = Services.search.getEngineByName(defaultName);
+      defaultURI = defaultEngine.getSubmission("foo").uri;
+    } catch (ex) {
+      // Something went horribly wrong! bail out
+      return;
+    }
+
+    // If the user-set value has the same base domain as the default, don't
+    // prompt.
+    let keywordBaseDomain;
+    try {
+      keywordBaseDomain = Services.eTLD.getBaseDomain(keywordURI);
+      if (keywordBaseDomain == Services.eTLD.getBaseDomain(defaultURI))
+        return;
+    } catch (ex) {}
+
+    if (!keywordBaseDomain)
+      return;
+
+    let brandBundle  = Services.strings.createBundle("chrome://branding/locale/brand.properties");
+    let brandShortName = brandBundle.GetStringFromName("brandShortName");
+
+    let browserBundle = win.gNavigatorBundle;
+    let msg = browserBundle.getFormattedString("keywordPrompt.message",
+                                               [brandShortName, keywordBaseDomain,
+                                                defaultEngine.name]);
+    let buttons = [
+      {
+        label: browserBundle.getFormattedString("keywordPrompt.yesButton",
+                                                [defaultEngine.name]),
+        accessKey: browserBundle.getString("keywordPrompt.yesButton.accessKey"),
+        popup:     null,
+        callback: function(aNotificationBar, aButton) {
+          Services.prefs.clearUserPref("keyword.URL");
+          try {
+            // If the currently loaded URI still has the same base domain as the
+            // keyword URI (this is used as a rough approximation of whether the
+            // user is still seeing search results as opposed to having clicked
+            // on a result link), load the default engine's searchForm URL so
+            // that they can re-do their search.
+            let currentBaseDomain = Services.eTLD.getBaseDomain(tabbrowser.currentURI);
+            if (currentBaseDomain == keywordBaseDomain)
+              tabbrowser.loadURI(defaultEngine.searchForm);
+          } catch (ex) {}
+        }
+      },
+      {
+        label: browserBundle.getFormattedString("keywordPrompt.noButton",
+                                                [keywordBaseDomain]),
+        accessKey: browserBundle.getString("keywordPrompt.noButton.accessKey"),
+        popup:     null,
+        callback: function(aNotificationBar, aButton) {
+          Services.prefs.setIntPref("browser.keywordURLPromptDeclined", KEYWORD_PROMPT_REV);
+        }
+      }
+    ];
+    
+    let notification = notifyBox.appendNotification(msg, "keywordURL-reset", null, notifyBox.PRIORITY_WARNING_HIGH, buttons);
+    notification.setAttribute("hideclose", true);
+    // stick around for a few page loads in case there are redirects involved
+    notification.persistence = 3;
+  }
+}

browser/modules/Makefile.in

@@ -52,6 +52,7 @@ EXTRA_JS_MODULES = \
 	NewTabUtils.jsm \
 	offlineAppCache.jsm \
 	TelemetryTimestamps.jsm \
+	KeywordURLResetPrompter.jsm \
 	$(NULL)
 
 ifeq ($(MOZ_WIDGET_TOOLKIT),windows) 

docshell/base/nsDefaultURIFixup.cpp

@@ -54,6 +54,7 @@
 #include "nsIURIFixup.h"
 #include "nsDefaultURIFixup.h"
 #include "mozilla/Preferences.h"
+#include "nsIObserverService.h"
 
 using namespace mozilla;
 
@@ -378,7 +379,17 @@ NS_IMETHODIMP nsDefaultURIFixup::KeywordToURI(const nsACString& aKeyword,
 
         spec.Insert(url, 0);
 
-        return NS_NewURI(aURI, spec);
+        nsresult rv = NS_NewURI(aURI, spec);
+        if (NS_FAILED(rv))
+            return rv;
+
+        nsCOMPtr<nsIObserverService> obsSvc = mozilla::services::GetObserverService();
+        if (obsSvc) {
+            obsSvc->NotifyObservers(*aURI,
+                                    "defaultURIFixup-using-keyword-pref",
+                                    nsnull);
+        }
+        return NS_OK;
     }
 
 #ifdef MOZ_TOOLKIT_SEARCH