Issue 3129/3144 - Fixed: Findbar key handling conflicted with filter editing

chrome/content/ui/filters-search.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+let {BrowserUtils} = Cu.import("resource://gre/modules/BrowserUtils.jsm");
+
 /**
  * Implementation of the filter search functionality.
  * @class
  */
 var FilterSearch =
 {
   /**
    * Initializes findbar widget.
    */
   init: function()
@@ skipping 15 matching lines @@
 
     findbar.addEventListener("keypress", function(event)
     {
       // Work-around for bug 490047
       if (event.keyCode == KeyEvent.DOM_VK_RETURN)
         event.preventDefault();
     }, false);
 
     // Hack to prevent "highlight all" from getting enabled
     findbar.toggleHighlight = function() {};
-
-    // Ignore accessibility.typeaheadfind preference to avoid findbar
-    // being opened when interacting with filter tree
-    Object.defineProperty(findbar, "_findAsYouType", {
-      get: () => false,
-      enumerable: true,
-      configurable: true
-    });

[Wladimir Palant, 2015/10/05 14:17:20]

I don't think we need to disable the functionality altogether, it does make
sense. We should however make sure that keyboards events from our tree editor
are left alone.

The real problem is that we are passing events to the findbar without checking
them first. However, that's not how their content script works now - see
http://hg.mozilla.org/mozilla-central/file/45f01961ecd0/toolkit/content/brows....
So the real solution here and in issue 3144 would be checking for event.ctrlKey
|| event.altKey || event.metaKey || event.defaultPrevented in our code.

[Thomas Greiner, 2015/10/05 16:45:20]

Thanks for the link, I wasn't aware of this implementation. Seems like their
content script does a bit more than that check so I added all the relevant
parts.

BTW I love their note in the content script that says "Please keep in sync with
toolkit/content/widgets/findbar.xml". :D

   },
 
   /**
    * Performs a text search.
    * @param {String} text  text to be searched
    * @param {Integer} direction  search direction: -1 (backwards), 0 (forwards
    *                  starting with current), 1 (forwards starting with next)
    * @param {Boolean} caseSensitive  if true, a case-sensitive search is performed
    * @result {Integer} one of the nsITypeAheadFind constants
    */
@@ skipping 164 matching lines @@
       E("filtersTree").boxObject.scrollByLines(num);
     },
     scrollByPages: function(num)
     {
       E("filtersTree").boxObject.scrollByPages(num);
     },
   },
 
   messageManager:
   {
+    FAYT_LINKS_KEY: "'".charCodeAt(0),
+    FAYT_TEXT_KEY: "/".charCodeAt(0),
     _messageMap: {
       "Findbar:Mouseup": "mouseup",
       "Findbar:Keypress": "keypress"
     },
 
     _messageFromEvent: function(event)
     {
       for (let message in this._messageMap)
         if (this._messageMap[message] == event.type)
           return {target: event.currentTarget, name: message, data: event};
       return null;
     },
 
     addMessageListener: function(message, listener)
     {
       if (!this._messageMap.hasOwnProperty(message))
         return;
 
       if (!("_ABPHandler" in listener))
-        listener._ABPHandler = (event) => listener.receiveMessage(this._messageFromEvent(event));
+      {
+        listener._ABPHandler = (event) => {
+          if (event.type == "keypress")
+          {
+            if (event.ctrlKey || event.altKey || event.metaKey
+              || event.defaultPrevented)
+              return;
+
+            let findbar = E("findbar");
+            if (findbar.findMode == findbar.FIND_NORMAL
+              && !findbar.findAsYouType
+              && event.charCode != this.FAYT_LINKS_KEY
+              && event.charCode != this.FAYT_TEXT_KEY)
+              return;
+
+            let target = Services.focus.getFocusedElementForWindow(window, true, {});
+            if (!BrowserUtils.shouldFastFind(target, window))
+              return;
+          }
+
+          listener.receiveMessage(this._messageFromEvent(event));
+        };
+      }
 
       E("filtersTree").addEventListener(this._messageMap[message], listener._ABPHandler, false);
     },
 
     removeMessageListener: function(message, listener)
     {
       if (this._messageMap.hasOwnProperty(message) && listener._ABPHandler)
         E("filtersTree").removeEventListener(this._messageMap[message], listener._ABPHandler, false);
     },
 
     sendAsyncMessage: function() {}
   }
 };
 
 window.addEventListener("load", function()
 {
   FilterSearch.init();
 }, false);