michael@0: <?xml version="1.0"?>
michael@0: # -*- Mode: HTML -*-
michael@0: # This Source Code Form is subject to the terms of the Mozilla Public
michael@0: # License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0: # file, You can obtain one at http://mozilla.org/MPL/2.0/.
michael@0: 
michael@0: <!DOCTYPE bindings [
michael@0: <!ENTITY % searchBarDTD SYSTEM "chrome://browser/locale/searchbar.dtd" >
michael@0: %searchBarDTD;
michael@0: <!ENTITY % browserDTD SYSTEM "chrome://browser/locale/browser.dtd">
michael@0: %browserDTD;
michael@0: ]>
michael@0: 
michael@0: <bindings id="SearchBindings"
michael@0:           xmlns="http://www.mozilla.org/xbl"
michael@0:           xmlns:xul="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
michael@0:           xmlns:xbl="http://www.mozilla.org/xbl">
michael@0: 
michael@0:   <binding id="searchbar">
michael@0:     <resources>
michael@0:       <stylesheet src="chrome://browser/content/search/searchbarBindings.css"/>
michael@0:       <stylesheet src="chrome://browser/skin/searchbar.css"/>
michael@0:     </resources>
michael@0:     <content>
michael@0:       <xul:stringbundle src="chrome://browser/locale/search.properties"
michael@0:                         anonid="searchbar-stringbundle"/>
michael@0:       <!--
michael@0:       There is a dependency between "maxrows" attribute and
michael@0:       "SuggestAutoComplete._historyLimit" (nsSearchSuggestions.js). Changing
michael@0:       one of them requires changing the other one.
michael@0:       -->
michael@0:       <xul:textbox class="searchbar-textbox"
michael@0:                    anonid="searchbar-textbox"
michael@0:                    type="autocomplete"
michael@0:                    flex="1"
michael@0:                    autocompletepopup="PopupAutoComplete"
michael@0:                    autocompletesearch="search-autocomplete"
michael@0:                    autocompletesearchparam="searchbar-history"
michael@0:                    timeout="250"
michael@0:                    maxrows="10"
michael@0:                    completeselectedindex="true"
michael@0:                    showcommentcolumn="true"
michael@0:                    tabscrolling="true"
michael@0:                    xbl:inherits="disabled,disableautocomplete,searchengine,src,newlines">
michael@0:         <!--
michael@0:         Empty <box> to properly position the icon within the autocomplete
michael@0:         binding's anonymous children (the autocomplete binding positions <box>
michael@0:         children differently)
michael@0:         -->
michael@0:         <xul:box>
michael@0:           <xul:button class="searchbar-engine-button"
michael@0:                       type="menu"
michael@0:                       anonid="searchbar-engine-button">
michael@0:             <xul:image class="searchbar-engine-image" xbl:inherits="src"/>
michael@0:             <xul:image class="searchbar-dropmarker-image"/>
michael@0:             <xul:menupopup class="searchbar-popup"
michael@0:                            anonid="searchbar-popup">
michael@0:               <xul:menuseparator/>
michael@0:               <xul:menuitem class="open-engine-manager"
michael@0:                             anonid="open-engine-manager"
michael@0:                             label="&cmd_engineManager.label;"
michael@0:                             oncommand="openManager(event);"/>
michael@0:             </xul:menupopup>
michael@0:           </xul:button>
michael@0:         </xul:box>
michael@0:         <xul:hbox class="search-go-container">
michael@0:           <xul:image class="search-go-button"
michael@0:                      anonid="search-go-button"
michael@0:                      onclick="handleSearchCommand(event);"
michael@0:                      tooltiptext="&searchEndCap.label;"/>
michael@0:         </xul:hbox>
michael@0:       </xul:textbox>
michael@0:     </content>
michael@0: 
michael@0:     <implementation implements="nsIObserver">
michael@0:       <constructor><![CDATA[
michael@0:         if (this.parentNode.parentNode.localName == "toolbarpaletteitem")
michael@0:           return;
michael@0:         // Make sure we rebuild the popup in onpopupshowing
michael@0:         this._needToBuildPopup = true;
michael@0: 
michael@0:         var os =
michael@0:                Components.classes["@mozilla.org/observer-service;1"]
michael@0:                          .getService(Components.interfaces.nsIObserverService);
michael@0:         os.addObserver(this, "browser-search-engine-modified", false);
michael@0: 
michael@0:         this._initialized = true;
michael@0: 
michael@0:         this.searchService.init((function search_init_cb(aStatus) {
michael@0:           // Bail out if the binding's been destroyed
michael@0:           if (!this._initialized)
michael@0:             return;
michael@0: 
michael@0:           if (Components.isSuccessCode(aStatus)) {
michael@0:             // Refresh the display (updating icon, etc)
michael@0:             this.updateDisplay();
michael@0:           } else {
michael@0:             Components.utils.reportError("Cannot initialize search service, bailing out: " + aStatus);
michael@0:           }
michael@0:         }).bind(this));
michael@0:       ]]></constructor>
michael@0: 
michael@0:       <destructor><![CDATA[
michael@0:         if (this._initialized) {
michael@0:           this._initialized = false;
michael@0: 
michael@0:           var os = Components.classes["@mozilla.org/observer-service;1"]
michael@0:                              .getService(Components.interfaces.nsIObserverService);
michael@0:           os.removeObserver(this, "browser-search-engine-modified");
michael@0:         }
michael@0: 
michael@0:         // Make sure to break the cycle from _textbox to us. Otherwise we leak
michael@0:         // the world. But make sure it's actually pointing to us.
michael@0:         if (this._textbox.mController.input == this)
michael@0:           this._textbox.mController.input = null;
michael@0:       ]]></destructor>
michael@0: 
michael@0:       <field name="_stringBundle">document.getAnonymousElementByAttribute(this,
michael@0:           "anonid", "searchbar-stringbundle");</field>
michael@0:       <field name="_textbox">document.getAnonymousElementByAttribute(this,
michael@0:           "anonid", "searchbar-textbox");</field>
michael@0:       <field name="_popup">document.getAnonymousElementByAttribute(this,
michael@0:           "anonid", "searchbar-popup");</field>
michael@0:       <field name="_ss">null</field>
michael@0:       <field name="_engines">null</field>
michael@0:       <field name="FormHistory" readonly="true">
michael@0:         (Components.utils.import("resource://gre/modules/FormHistory.jsm", {})).FormHistory;
michael@0:       </field>
michael@0: 
michael@0:       <property name="engines" readonly="true">
michael@0:         <getter><![CDATA[
michael@0:           if (!this._engines)
michael@0:             this._engines = this.searchService.getVisibleEngines();
michael@0:           return this._engines;
michael@0:         ]]></getter>
michael@0:       </property>
michael@0: 
michael@0:       <field name="searchButton">document.getAnonymousElementByAttribute(this,
michael@0:           "anonid", "searchbar-engine-button");</field>
michael@0: 
michael@0:       <property name="currentEngine">
michael@0:         <setter><![CDATA[
michael@0:           let ss = this.searchService;
michael@0:           ss.defaultEngine = ss.currentEngine = val;
michael@0:           return val;
michael@0:         ]]></setter>
michael@0:         <getter><![CDATA[
michael@0:           var currentEngine = this.searchService.currentEngine;
michael@0:           // Return a dummy engine if there is no currentEngine
michael@0:           return currentEngine || {name: "", uri: null};
michael@0:         ]]></getter>
michael@0:       </property>
michael@0: 
michael@0:       <!-- textbox is used by sanitize.js to clear the undo history when
michael@0:            clearing form information. -->
michael@0:       <property name="textbox" readonly="true"
michael@0:                 onget="return this._textbox;"/>
michael@0: 
michael@0:       <property name="searchService" readonly="true">
michael@0:         <getter><![CDATA[
michael@0:           if (!this._ss) {
michael@0:             const nsIBSS = Components.interfaces.nsIBrowserSearchService;
michael@0:             this._ss =
michael@0:                  Components.classes["@mozilla.org/browser/search-service;1"]
michael@0:                            .getService(nsIBSS);
michael@0:           }
michael@0:           return this._ss;
michael@0:         ]]></getter>
michael@0:       </property>
michael@0: 
michael@0:       <property name="value" onget="return this._textbox.value;"
michael@0:                              onset="return this._textbox.value = val;"/>
michael@0: 
michael@0:       <method name="focus">
michael@0:         <body><![CDATA[
michael@0:           this._textbox.focus();
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <method name="select">
michael@0:         <body><![CDATA[
michael@0:           this._textbox.select();
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <method name="observe">
michael@0:         <parameter name="aEngine"/>
michael@0:         <parameter name="aTopic"/>
michael@0:         <parameter name="aVerb"/>
michael@0:         <body><![CDATA[
michael@0:           if (aTopic == "browser-search-engine-modified") {
michael@0:             switch (aVerb) {
michael@0:             case "engine-removed":
michael@0:               this.offerNewEngine(aEngine);
michael@0:               break;
michael@0:             case "engine-added":
michael@0:               this.hideNewEngine(aEngine);
michael@0:               break;
michael@0:             case "engine-current":
michael@0:               // The current engine was changed.  Rebuilding the menu appears to
michael@0:               // confuse its idea of whether it should be open when it's just
michael@0:               // been clicked, so we force it to close now.
michael@0:               this._popup.hidePopup();
michael@0:               break;
michael@0:             case "engine-changed":
michael@0:               // An engine was removed (or hidden) or added, or an icon was
michael@0:               // changed.  Do nothing special.
michael@0:             }
michael@0: 
michael@0:             // Make sure the engine list is refetched next time it's needed
michael@0:             this._engines = null;
michael@0: 
michael@0:             // Rebuild the popup and update the display after any modification.
michael@0:             this.rebuildPopup();
michael@0:             this.updateDisplay();
michael@0:           }
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <!-- There are two seaprate lists of search engines, whose uses intersect
michael@0:       in this file.  The search service (nsIBrowserSearchService and
michael@0:       nsSearchService.js) maintains a list of Engine objects which is used to
michael@0:       populate the searchbox list of available engines and to perform queries.
michael@0:       That list is accessed here via this.SearchService, and it's that sort of
michael@0:       Engine that is passed to this binding's observer as aEngine.
michael@0: 
michael@0:       In addition, browser.js fills two lists of autodetected search engines
michael@0:       (browser.engines and browser.hiddenEngines) as properties of
michael@0:       mCurrentBrowser.  Those lists contain unnamed JS objects of the form
michael@0:       { uri:, title:, icon: }, and that's what the searchbar uses to determine
michael@0:       whether to show any "Add <EngineName>" menu items in the drop-down.
michael@0: 
michael@0:       The two types of engines are currently related by their identifying
michael@0:       titles (the Engine object's 'name'), although that may change; see bug
michael@0:       335102.  -->
michael@0: 
michael@0:       <!-- If the engine that was just removed from the searchbox list was
michael@0:       autodetected on this page, move it to each browser's active list so it
michael@0:       will be offered to be added again. -->
michael@0:       <method name="offerNewEngine">
michael@0:         <parameter name="aEngine"/>
michael@0:         <body><![CDATA[
michael@0:           var allbrowsers = getBrowser().mPanelContainer.childNodes;
michael@0:           for (var tab = 0; tab < allbrowsers.length; tab++) {
michael@0:             var browser = getBrowser().getBrowserAtIndex(tab);
michael@0:             if (browser.hiddenEngines) {
michael@0:               // XXX This will need to be changed when engines are identified by
michael@0:               // URL rather than title; see bug 335102.
michael@0:               var removeTitle = aEngine.wrappedJSObject.name;
michael@0:               for (var i = 0; i < browser.hiddenEngines.length; i++) {
michael@0:                 if (browser.hiddenEngines[i].title == removeTitle) {
michael@0:                   if (!browser.engines)
michael@0:                     browser.engines = [];
michael@0:                   browser.engines.push(browser.hiddenEngines[i]);
michael@0:                   browser.hiddenEngines.splice(i, 1);
michael@0:                   break;
michael@0:                 }
michael@0:               }
michael@0:             }
michael@0:           }
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <!-- If the engine that was just added to the searchbox list was
michael@0:       autodetected on this page, move it to each browser's hidden list so it is
michael@0:       no longer offered to be added. -->
michael@0:       <method name="hideNewEngine">
michael@0:         <parameter name="aEngine"/>
michael@0:         <body><![CDATA[
michael@0:           var allbrowsers = getBrowser().mPanelContainer.childNodes;
michael@0:           for (var tab = 0; tab < allbrowsers.length; tab++) {
michael@0:             var browser = getBrowser().getBrowserAtIndex(tab);
michael@0:             if (browser.engines) {
michael@0:               // XXX This will need to be changed when engines are identified by
michael@0:               // URL rather than title; see bug 335102.
michael@0:               var removeTitle = aEngine.wrappedJSObject.name;
michael@0:               for (var i = 0; i < browser.engines.length; i++) {
michael@0:                 if (browser.engines[i].title == removeTitle) {
michael@0:                   if (!browser.hiddenEngines)
michael@0:                     browser.hiddenEngines = [];
michael@0:                   browser.hiddenEngines.push(browser.engines[i]);
michael@0:                   browser.engines.splice(i, 1);
michael@0:                   break;
michael@0:                 }
michael@0:               }
michael@0:             }
michael@0:           }
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <method name="setIcon">
michael@0:         <parameter name="element"/>
michael@0:         <parameter name="uri"/>
michael@0:         <body><![CDATA[
michael@0:           if (uri) {
michael@0:             let size = Math.round(16 * window.devicePixelRatio);
michael@0:             if (!uri.contains("#"))
michael@0:               uri += "#-moz-resolution=" + size + "," + size;
michael@0:           }
michael@0:           element.setAttribute("src", uri);
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <method name="updateDisplay">
michael@0:         <body><![CDATA[
michael@0:           var uri = this.currentEngine.iconURI;
michael@0:           this.setIcon(this, uri ? uri.spec : "");
michael@0: 
michael@0:           var name = this.currentEngine.name;
michael@0:           var text = this._stringBundle.getFormattedString("searchtip", [name]);
michael@0:           this._textbox.placeholder = name;
michael@0:           this._textbox.label = text;
michael@0:           this._textbox.tooltipText = text;
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <!-- Rebuilds the dynamic portion of the popup menu (i.e., the menu items
michael@0:            for new search engines that can be added to the available list).  This
michael@0:            is called each time the popup is shown.
michael@0:       -->
michael@0:       <method name="rebuildPopupDynamic">
michael@0:         <body><![CDATA[
michael@0:           // We might not have added the main popup items yet, do that first
michael@0:           // if needed.
michael@0:           if (this._needToBuildPopup)
michael@0:             this.rebuildPopup();
michael@0: 
michael@0:           var popup = this._popup;
michael@0:           // Clear any addengine menuitems, including addengine-item entries and
michael@0:           // the addengine-separator.  Work backward to avoid invalidating the
michael@0:           // indexes as items are removed.
michael@0:           var items = popup.childNodes;
michael@0:           for (var i = items.length - 1; i >= 0; i--) {
michael@0:             if (items[i].classList.contains("addengine-item") ||
michael@0:                 items[i].classList.contains("addengine-separator"))
michael@0:               popup.removeChild(items[i]);
michael@0:           }
michael@0: 
michael@0:           var addengines = getBrowser().mCurrentBrowser.engines;
michael@0:           if (addengines && addengines.length > 0) {
michael@0:             const kXULNS =
michael@0:                "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";
michael@0: 
michael@0:             // Find the (first) separator in the remaining menu, or the first item
michael@0:             // if no separators are present.
michael@0:             var insertLocation = popup.firstChild;
michael@0:             while (insertLocation.nextSibling &&
michael@0:                    insertLocation.localName != "menuseparator") {
michael@0:               insertLocation = insertLocation.nextSibling;
michael@0:             }
michael@0:             if (insertLocation.localName != "menuseparator")
michael@0:               insertLocation = popup.firstChild;
michael@0: 
michael@0:             var separator = document.createElementNS(kXULNS, "menuseparator");
michael@0:             separator.setAttribute("class", "addengine-separator");
michael@0:             popup.insertBefore(separator, insertLocation);
michael@0: 
michael@0:             // Insert the "add this engine" items.
michael@0:             for (var i = 0; i < addengines.length; i++) {
michael@0:               var menuitem = document.createElement("menuitem");
michael@0:               var engineInfo = addengines[i];
michael@0:               var labelStr =
michael@0:                   this._stringBundle.getFormattedString("cmd_addFoundEngine",
michael@0:                                                         [engineInfo.title]);
michael@0:               menuitem = document.createElementNS(kXULNS, "menuitem");
michael@0:               menuitem.setAttribute("class", "menuitem-iconic addengine-item");
michael@0:               menuitem.setAttribute("label", labelStr);
michael@0:               menuitem.setAttribute("tooltiptext", engineInfo.uri);
michael@0:               menuitem.setAttribute("uri", engineInfo.uri);
michael@0:               if (engineInfo.icon)
michael@0:                 this.setIcon(menuitem, engineInfo.icon);
michael@0:               menuitem.setAttribute("title", engineInfo.title);
michael@0:               popup.insertBefore(menuitem, insertLocation);
michael@0:             }
michael@0:           }
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <!-- Rebuilds the list of visible search engines in the menu.  Does not remove
michael@0:            or update any dynamic entries (i.e., "Add this engine" items) nor the
michael@0:            Manage Engines item.  This is called by the observer when the list of
michael@0:            visible engines, or the currently selected engine, has changed.
michael@0:       -->
michael@0:       <method name="rebuildPopup">
michael@0:         <body><![CDATA[
michael@0:           var popup = this._popup;
michael@0: 
michael@0:           // Clear the popup, down to the first separator
michael@0:           while (popup.firstChild && popup.firstChild.localName != "menuseparator")
michael@0:             popup.removeChild(popup.firstChild);
michael@0: 
michael@0:           const kXULNS =
michael@0:                "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";
michael@0: 
michael@0:           var engines = this.engines;
michael@0:           for (var i = engines.length - 1; i >= 0; --i) {
michael@0:             var menuitem = document.createElementNS(kXULNS, "menuitem");
michael@0:             var name = engines[i].name;
michael@0:             menuitem.setAttribute("label", name);
michael@0:             menuitem.setAttribute("id", name);
michael@0:             menuitem.setAttribute("class", "menuitem-iconic searchbar-engine-menuitem menuitem-with-favicon");
michael@0:             // Since this menu is rebuilt by the observer method whenever a new
michael@0:             // engine is selected, the "selected" attribute does not need to be
michael@0:             // explicitly cleared anywhere.
michael@0:             if (engines[i] == this.currentEngine)
michael@0:               menuitem.setAttribute("selected", "true");
michael@0:             var tooltip = this._stringBundle.getFormattedString("searchtip", [name]);
michael@0:             menuitem.setAttribute("tooltiptext", tooltip);
michael@0:             if (engines[i].iconURI)
michael@0:               this.setIcon(menuitem, engines[i].iconURI.spec);
michael@0:             popup.insertBefore(menuitem, popup.firstChild);
michael@0:             menuitem.engine = engines[i];
michael@0:           }
michael@0: 
michael@0:           this._needToBuildPopup = false;
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <method name="openManager">
michael@0:         <parameter name="aEvent"/>
michael@0:         <body><![CDATA[
michael@0:           var wm =
michael@0:                 Components.classes["@mozilla.org/appshell/window-mediator;1"]
michael@0:                           .getService(Components.interfaces.nsIWindowMediator);
michael@0: 
michael@0:           var window = wm.getMostRecentWindow("Browser:SearchManager");
michael@0:           if (window)
michael@0:             window.focus()
michael@0:           else {
michael@0:             setTimeout(function () {
michael@0:               openDialog("chrome://browser/content/search/engineManager.xul",
michael@0:                          "_blank", "chrome,dialog,modal,centerscreen,resizable");
michael@0:             }, 0);
michael@0:           }
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <method name="selectEngine">
michael@0:         <parameter name="aEvent"/>
michael@0:         <parameter name="isNextEngine"/>
michael@0:         <body><![CDATA[
michael@0:           // Find the new index
michael@0:           var newIndex = this.engines.indexOf(this.currentEngine);
michael@0:           newIndex += isNextEngine ? 1 : -1;
michael@0: 
michael@0:           if (newIndex >= 0 && newIndex < this.engines.length) {
michael@0:             this.currentEngine = this.engines[newIndex];
michael@0:           }
michael@0: 
michael@0:           aEvent.preventDefault();
michael@0:           aEvent.stopPropagation();
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <method name="handleSearchCommand">
michael@0:         <parameter name="aEvent"/>
michael@0:         <body><![CDATA[
michael@0:           var textBox = this._textbox;
michael@0:           var textValue = textBox.value;
michael@0: 
michael@0:           var where = "current";
michael@0:           if (aEvent && aEvent.originalTarget.getAttribute("anonid") == "search-go-button") {
michael@0:             if (aEvent.button == 2)
michael@0:               return;
michael@0:             where = whereToOpenLink(aEvent, false, true);
michael@0:           }
michael@0:           else {
michael@0:             var newTabPref = textBox._prefBranch.getBoolPref("browser.search.openintab");
michael@0:             if ((aEvent && aEvent.altKey) ^ newTabPref)
michael@0:               where = "tab";
michael@0:           }
michael@0: 
michael@0:           this.doSearch(textValue, where);
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <method name="doSearch">
michael@0:         <parameter name="aData"/>
michael@0:         <parameter name="aWhere"/>
michael@0:         <body><![CDATA[
michael@0:           var textBox = this._textbox;
michael@0:         
michael@0:           // Save the current value in the form history
michael@0:           if (aData && !PrivateBrowsingUtils.isWindowPrivate(window)) {
michael@0:             this.FormHistory.update(
michael@0:               { op : "bump",
michael@0:                 fieldname : textBox.getAttribute("autocompletesearchparam"),
michael@0:                 value : aData },
michael@0:               { handleError : function(aError) {
michael@0:                   Components.utils.reportError("Saving search to form history failed: " + aError.message);
michael@0:               }});
michael@0:           }
michael@0:           
michael@0:           // null parameter below specifies HTML response for search
michael@0:           var submission = this.currentEngine.getSubmission(aData, null, "searchbar");
michael@0:           BrowserSearch.recordSearchInHealthReport(this.currentEngine, "searchbar");
michael@0:           openUILinkIn(submission.uri.spec, aWhere, null, submission.postData);
michael@0:         ]]></body>
michael@0:       </method>
michael@0:     </implementation>
michael@0: 
michael@0:     <handlers>
michael@0:       <handler event="command"><![CDATA[
michael@0:         const target = event.originalTarget;
michael@0:         if (target.engine) {
michael@0:           this.currentEngine = target.engine;
michael@0:         } else if (target.classList.contains("addengine-item")) {
michael@0:           var searchService =
michael@0:             Components.classes["@mozilla.org/browser/search-service;1"]
michael@0:                       .getService(Components.interfaces.nsIBrowserSearchService);
michael@0:           // We only detect OpenSearch files
michael@0:           var type = Components.interfaces.nsISearchEngine.DATA_XML;
michael@0:           // Select the installed engine if the installation succeeds
michael@0:           var installCallback = {
michael@0:             onSuccess: engine => this.currentEngine = engine
michael@0:           }
michael@0:           searchService.addEngine(target.getAttribute("uri"), type,
michael@0:                                   target.getAttribute("src"), false,
michael@0:                                   installCallback);
michael@0:         }
michael@0:         else
michael@0:           return;
michael@0: 
michael@0:         this.focus();
michael@0:         this.select();
michael@0:       ]]></handler>
michael@0: 
michael@0:       <handler event="popupshowing" action="this.rebuildPopupDynamic();"/>
michael@0: 
michael@0:       <handler event="DOMMouseScroll"
michael@0:                phase="capturing"
michael@0:                modifiers="accel"
michael@0:                action="this.selectEngine(event, (event.detail > 0));"/>
michael@0: 
michael@0:       <handler event="focus">
michael@0:       <![CDATA[
michael@0:         // Speculatively connect to the current engine's search URI (and
michael@0:         // suggest URI, if different) to reduce request latency
michael@0: 
michael@0:         const SUGGEST_TYPE = "application/x-suggestions+json";
michael@0:         var engine = this.currentEngine;
michael@0:         var connector =
michael@0:             Services.io.QueryInterface(Components.interfaces.nsISpeculativeConnect);
michael@0:         var searchURI = engine.getSubmission("dummy", null, "searchbar").uri;
michael@0:         let callbacks = window.QueryInterface(Components.interfaces.nsIInterfaceRequestor)
michael@0:                               .getInterface(Components.interfaces.nsIWebNavigation)
michael@0:                               .QueryInterface(Components.interfaces.nsILoadContext);
michael@0:         connector.speculativeConnect(searchURI, callbacks);
michael@0: 
michael@0:         if (engine.supportsResponseType(SUGGEST_TYPE)) {
michael@0:           var suggestURI = engine.getSubmission("dummy", SUGGEST_TYPE, "searchbar").uri;
michael@0:           if (suggestURI.prePath != searchURI.prePath)
michael@0:             connector.speculativeConnect(suggestURI, callbacks);
michael@0:         }
michael@0:       ]]></handler>
michael@0:     </handlers>
michael@0:   </binding>
michael@0: 
michael@0:   <binding id="searchbar-textbox"
michael@0:       extends="chrome://global/content/bindings/autocomplete.xml#autocomplete">
michael@0:     <implementation implements="nsIObserver">
michael@0:       <constructor><![CDATA[
michael@0:         const kXULNS =
michael@0:           "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";
michael@0: 
michael@0:         if (document.getBindingParent(this).parentNode.parentNode.localName ==
michael@0:             "toolbarpaletteitem")
michael@0:           return;
michael@0: 
michael@0:         // Initialize fields
michael@0:         this._stringBundle = document.getBindingParent(this)._stringBundle;
michael@0:         this._prefBranch =
michael@0:                   Components.classes["@mozilla.org/preferences-service;1"]
michael@0:                             .getService(Components.interfaces.nsIPrefBranch);
michael@0:         this._suggestEnabled =
michael@0:             this._prefBranch.getBoolPref("browser.search.suggest.enabled");
michael@0: 
michael@0:         if (this._prefBranch.getBoolPref("browser.urlbar.clickSelectsAll"))
michael@0:           this.setAttribute("clickSelectsAll", true);
michael@0: 
michael@0:         // Add items to context menu and attach controller to handle them
michael@0:         var textBox = document.getAnonymousElementByAttribute(this,
michael@0:                                               "anonid", "textbox-input-box");
michael@0:         var cxmenu = document.getAnonymousElementByAttribute(textBox,
michael@0:                                           "anonid", "input-box-contextmenu");
michael@0:         var pasteAndSearch;
michael@0:         cxmenu.addEventListener("popupshowing", function() {
michael@0:           if (!pasteAndSearch)
michael@0:             return;
michael@0:           var controller = document.commandDispatcher.getControllerForCommand("cmd_paste");
michael@0:           var enabled = controller.isCommandEnabled("cmd_paste");
michael@0:           if (enabled)
michael@0:             pasteAndSearch.removeAttribute("disabled");
michael@0:           else
michael@0:             pasteAndSearch.setAttribute("disabled", "true");
michael@0:         }, false);
michael@0: 
michael@0:         var element, label, akey;
michael@0: 
michael@0:         element = document.createElementNS(kXULNS, "menuseparator");
michael@0:         cxmenu.appendChild(element);
michael@0: 
michael@0:         var insertLocation = cxmenu.firstChild;
michael@0:         while (insertLocation.nextSibling &&
michael@0:                insertLocation.getAttribute("cmd") != "cmd_paste")
michael@0:           insertLocation = insertLocation.nextSibling;
michael@0:         if (insertLocation) {
michael@0:           element = document.createElementNS(kXULNS, "menuitem");
michael@0:           label = this._stringBundle.getString("cmd_pasteAndSearch");
michael@0:           element.setAttribute("label", label);
michael@0:           element.setAttribute("anonid", "paste-and-search");
michael@0:           element.setAttribute("oncommand",
michael@0:               "BrowserSearch.searchBar.select(); goDoCommand('cmd_paste'); BrowserSearch.searchBar.handleSearchCommand();");
michael@0:           cxmenu.insertBefore(element, insertLocation.nextSibling);
michael@0:           pasteAndSearch = element;
michael@0:         }
michael@0: 
michael@0:         element = document.createElementNS(kXULNS, "menuitem");
michael@0:         label = this._stringBundle.getString("cmd_clearHistory");
michael@0:         akey = this._stringBundle.getString("cmd_clearHistory_accesskey");
michael@0:         element.setAttribute("label", label);
michael@0:         element.setAttribute("accesskey", akey);
michael@0:         element.setAttribute("cmd", "cmd_clearhistory");
michael@0:         cxmenu.appendChild(element);
michael@0: 
michael@0:         element = document.createElementNS(kXULNS, "menuitem");
michael@0:         label = this._stringBundle.getString("cmd_showSuggestions");
michael@0:         akey = this._stringBundle.getString("cmd_showSuggestions_accesskey");
michael@0:         element.setAttribute("anonid", "toggle-suggest-item");
michael@0:         element.setAttribute("label", label);
michael@0:         element.setAttribute("accesskey", akey);
michael@0:         element.setAttribute("cmd", "cmd_togglesuggest");
michael@0:         element.setAttribute("type", "checkbox");
michael@0:         element.setAttribute("checked", this._suggestEnabled);
michael@0:         element.setAttribute("autocheck", "false");
michael@0:         this._suggestMenuItem = element;
michael@0:         cxmenu.appendChild(element);
michael@0: 
michael@0:         this.controllers.appendController(this.searchbarController);
michael@0: 
michael@0:         // Add observer for suggest preference
michael@0:         var prefs = Components.classes["@mozilla.org/preferences-service;1"]
michael@0:                             .getService(Components.interfaces.nsIPrefBranch);
michael@0:         prefs.addObserver("browser.search.suggest.enabled", this, false);
michael@0:       ]]></constructor>
michael@0: 
michael@0:       <destructor><![CDATA[
michael@0:           var prefs = Components.classes["@mozilla.org/preferences-service;1"]
michael@0:                               .getService(Components.interfaces.nsIPrefBranch);
michael@0:           prefs.removeObserver("browser.search.suggest.enabled", this);
michael@0: 
michael@0:         // Because XBL and the customize toolbar code interacts poorly,
michael@0:         // there may not be anything to remove here
michael@0:         try {
michael@0:           this.controllers.removeController(this.searchbarController);
michael@0:         } catch (ex) { }
michael@0:       ]]></destructor>
michael@0: 
michael@0:       <field name="_stringBundle"/>
michael@0:       <field name="_prefBranch"/>
michael@0:       <field name="_suggestMenuItem"/>
michael@0:       <field name="_suggestEnabled"/>
michael@0: 
michael@0:       <!--
michael@0:         This overrides the searchParam property in autocomplete.xml.  We're
michael@0:         hijacking this property as a vehicle for delivering the privacy
michael@0:         information about the window into the guts of nsSearchSuggestions.
michael@0: 
michael@0:         Note that the setter is the same as the parent.  We were not sure whether
michael@0:         we can override just the getter.  If that proves to be the case, the setter
michael@0:         can be removed.
michael@0:       -->
michael@0:       <property name="searchParam"
michael@0:                 onget="return this.getAttribute('autocompletesearchparam') +
michael@0:                        (PrivateBrowsingUtils.isWindowPrivate(window) ? '|private' : '');"
michael@0:                 onset="this.setAttribute('autocompletesearchparam', val); return val;"/>
michael@0: 
michael@0:       <!--
michael@0:         This method overrides the autocomplete binding's openPopup (essentially
michael@0:         duplicating the logic from the autocomplete popup binding's
michael@0:         openAutocompletePopup method), modifying it so that the popup is aligned with
michael@0:         the inner textbox, but sized to not extend beyond the search bar border.
michael@0:       -->
michael@0:       <method name="openPopup">
michael@0:         <body><![CDATA[
michael@0:           var popup = this.popup;
michael@0:           if (!popup.mPopupOpen) {
michael@0:             // Initially the panel used for the searchbar (PopupAutoComplete
michael@0:             // in browser.xul) is hidden to avoid impacting startup / new
michael@0:             // window performance. The base binding's openPopup would normally
michael@0:             // call the overriden openAutocompletePopup in urlbarBindings.xml's
michael@0:             // browser-autocomplete-result-popup binding to unhide the popup,
michael@0:             // but since we're overriding openPopup we need to unhide the panel
michael@0:             // ourselves.
michael@0:             popup.hidden = false;
michael@0: 
michael@0:             popup.mInput = this;
michael@0:             popup.view = this.controller.QueryInterface(Components.interfaces.nsITreeView);
michael@0:             popup.invalidate();
michael@0: 
michael@0:             popup.showCommentColumn = this.showCommentColumn;
michael@0:             popup.showImageColumn = this.showImageColumn;
michael@0: 
michael@0:             document.popupNode = null;
michael@0: 
michael@0:             const isRTL = getComputedStyle(this, "").direction == "rtl";
michael@0: 
michael@0:             var outerRect = this.getBoundingClientRect();
michael@0:             var innerRect = this.inputField.getBoundingClientRect();
michael@0:             if (isRTL) {
michael@0:               var width = innerRect.right - outerRect.left;
michael@0:             } else {
michael@0:               var width = outerRect.right - innerRect.left;
michael@0:             }
michael@0:             popup.setAttribute("width", width > 100 ? width : 100);
michael@0: 
michael@0:             var yOffset = outerRect.bottom - innerRect.bottom;
michael@0:             popup.openPopup(this.inputField, "after_start", 0, yOffset, false, false);
michael@0:           }
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <method name="observe">
michael@0:         <parameter name="aSubject"/>
michael@0:         <parameter name="aTopic"/>
michael@0:         <parameter name="aData"/>
michael@0:         <body><![CDATA[
michael@0:           if (aTopic == "nsPref:changed") {
michael@0:             this._suggestEnabled =
michael@0:               this._prefBranch.getBoolPref("browser.search.suggest.enabled");
michael@0:             this._suggestMenuItem.setAttribute("checked", this._suggestEnabled);
michael@0:           }
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <method name="openSearch">
michael@0:         <body>
michael@0:           <![CDATA[
michael@0:             // Don't open search popup if history popup is open
michael@0:             if (!this.popupOpen) {
michael@0:               document.getBindingParent(this).searchButton.open = true;
michael@0:               return false;
michael@0:             }
michael@0:             return true;
michael@0:           ]]>
michael@0:         </body>
michael@0:       </method>
michael@0: 
michael@0:       <!-- override |onTextEntered| in autocomplete.xml -->
michael@0:       <method name="onTextEntered">
michael@0:         <parameter name="aEvent"/>
michael@0:         <body><![CDATA[
michael@0:           var evt = aEvent || this.mEnterEvent;
michael@0:           document.getBindingParent(this).handleSearchCommand(evt);
michael@0:           this.mEnterEvent = null;
michael@0:         ]]></body>
michael@0:       </method>
michael@0: 
michael@0:       <!-- nsIController -->
michael@0:       <field name="searchbarController" readonly="true"><![CDATA[({
michael@0:         _self: this,
michael@0:         supportsCommand: function(aCommand) {
michael@0:           return aCommand == "cmd_clearhistory" ||
michael@0:                  aCommand == "cmd_togglesuggest";
michael@0:         },
michael@0: 
michael@0:         isCommandEnabled: function(aCommand) {
michael@0:           return true;
michael@0:         },
michael@0: 
michael@0:         doCommand: function (aCommand) {
michael@0:           switch (aCommand) {
michael@0:             case "cmd_clearhistory":
michael@0:               var param = this._self.getAttribute("autocompletesearchparam");
michael@0: 
michael@0:               let searchBar = this._self.parentNode;
michael@0: 
michael@0:               BrowserSearch.searchBar.FormHistory.update({ op : "remove", fieldname : param }, null);
michael@0:               this._self.value = "";
michael@0:               break;
michael@0:             case "cmd_togglesuggest":
michael@0:               // The pref observer will update _suggestEnabled and the menu
michael@0:               // checkmark.
michael@0:               this._self._prefBranch.setBoolPref("browser.search.suggest.enabled",
michael@0:                                                  !this._self._suggestEnabled);
michael@0:               break;
michael@0:             default:
michael@0:               // do nothing with unrecognized command
michael@0:           }
michael@0:         }
michael@0:       })]]></field>
michael@0:     </implementation>
michael@0: 
michael@0:     <handlers>
michael@0:       <handler event="keypress" keycode="VK_UP" modifiers="accel"
michael@0:                phase="capturing"
michael@0:                action="document.getBindingParent(this).selectEngine(event, false);"/>
michael@0: 
michael@0:       <handler event="keypress" keycode="VK_DOWN" modifiers="accel"
michael@0:                phase="capturing"
michael@0:                action="document.getBindingParent(this).selectEngine(event, true);"/>
michael@0: 
michael@0:       <handler event="keypress" keycode="VK_DOWN" modifiers="alt"
michael@0:                phase="capturing"
michael@0:                action="return this.openSearch();"/>
michael@0: 
michael@0:       <handler event="keypress" keycode="VK_UP" modifiers="alt"
michael@0:                phase="capturing"
michael@0:                action="return this.openSearch();"/>
michael@0: 
michael@0: #ifndef XP_MACOSX
michael@0:       <handler event="keypress" keycode="VK_F4"
michael@0:                phase="capturing"
michael@0:                action="return this.openSearch();"/>
michael@0: #endif
michael@0: 
michael@0:       <handler event="dragover">
michael@0:       <![CDATA[
michael@0:         var types = event.dataTransfer.types;
michael@0:         if (types.contains("text/plain") || types.contains("text/x-moz-text-internal"))
michael@0:           event.preventDefault();
michael@0:       ]]>
michael@0:       </handler>
michael@0: 
michael@0:       <handler event="drop">
michael@0:       <![CDATA[
michael@0:         var dataTransfer = event.dataTransfer;
michael@0:         var data = dataTransfer.getData("text/plain");
michael@0:         if (!data)
michael@0:           data = dataTransfer.getData("text/x-moz-text-internal");
michael@0:         if (data) {
michael@0:           event.preventDefault();
michael@0:           this.value = data;
michael@0:           this.onTextEntered(event);
michael@0:         }
michael@0:       ]]>
michael@0:       </handler>
michael@0: 
michael@0:     </handlers>
michael@0:   </binding>
michael@0: </bindings>