Issue 3224 - Unbreak filter assistant

lib/requestNotifier.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
@@ skipping 21 matching lines @@
  * @type Map.<number,RequestNotifier>
  */
 let notifiers = new Map();
 
 let messageManager = Cc["@mozilla.org/parentprocessmessagemanager;1"]
                        .getService(Ci.nsIMessageListenerManager)
                        .QueryInterface(Ci.nsIMessageBroadcaster);
 
 Utils.addChildMessageListener("AdblockPlus:FoundNodeData", onNodeData);
 Utils.addChildMessageListener("AdblockPlus:ScanComplete", onScanComplete);
-Utils.addChildMessageListener("AdblockPlus:RetrieveNodeSizeResponse", onNodeSizeReceived);
+Utils.addChildMessageListener("AdblockPlus:NotifierResponse", onNotifierResponse);
 Utils.addChildMessageListener("AdblockPlus:RetrieveWindowStatsResponse", onWindowStatsReceived);
 
 function onNodeData({notifierID, data})
 {
   let notifier = notifiers.get(notifierID);
   if (notifier)
     notifier.notifyListener(data);
 }
 
 function onScanComplete(notifierID)
 {
   let notifier = notifiers.get(notifierID);
   if (notifier)
     notifier.onComplete();
 }
 
-function onNodeSizeReceived({notifierID, responseID, size})
+function onNotifierResponse({notifierID, responseID, response})
 {
   let notifier = notifiers.get(notifierID);
   if (notifier)
-    notifier.onNodeSizeReceived(responseID, size);
+    notifier.onResponse(responseID, response);
 }
 
 function onWindowStatsReceived({responseID, stats})
 {
   let callback = windowStatsCallbacks.get(responseID);
   windowStatsCallbacks.delete(responseID);
   if (typeof callback == "function")
     callback(stats);
 }
 
 /**
  * Creates a notifier object for a particular window. After creation the window
  * will first be scanned for previously saved requests. Once that scan is
  * complete only new requests for this window will be reported.
  * @param {Integer} outerWindowID  ID of the window to attach the notifier to
  * @param {Function} listener  listener to be called whenever a new request is found
  * @param {Object} [listenerObj]  "this" pointer to be used when calling the listener
  */
 function RequestNotifier(outerWindowID, listener, listenerObj)
 {
   this.listener = listener;
   this.listenerObj = listenerObj || null;
   this.id = ++requestNotifierMaxId;
   notifiers.set(this.id, this);
-  this._nodeSizeCallbacks = new Map();
+  this._callbacks = new Map();
 
   messageManager.broadcastAsyncMessage("AdblockPlus:StartWindowScan", {
     notifierID: this.id,
     outerWindowID: outerWindowID
   });
 }
 exports.RequestNotifier = RequestNotifier;
 
 RequestNotifier.prototype =
 {
@@ skipping 57 matching lines @@
     if (!requests)
       requests = [];
 
     messageManager.broadcastAsyncMessage("AdblockPlus:FlashNodes", {
       notifierID: this.id,
       requests,
       scrollToItem
     });
   },
 
-  _nodeSizeMaxResponseID: 0,
-  _nodeSizeCallbacks: null,
+  _maxResponseID: 0,
+  _callbacks: null,
 
   /**
    * Attempts to calculate the size of the nodes associated with the requests.
-   * Callback will only be called on success.
    * @param {number[]} requests  list of request IDs that were previously
    *                             reported by this notifier.
    * @param {Function} callback  function to be called with two parameters (x,y)
    */
   retrieveNodeSize: function(requests, callback)
   {
     if (!requests)
       requests = [];
 
-    let id = ++this._nodeSizeMaxResponseID;
-    this._nodeSizeCallbacks.set(id, callback);
+    let id = ++this._maxResponseID;
+    this._callbacks.set(id, callback);
 
     messageManager.broadcastAsyncMessage("AdblockPlus:RetrieveNodeSize", {
       notifierID: this.id,
       responseID: id,
       requests,
     });
   },
 
-  onNodeSizeReceived: function(responseID, size)
+  onResponse: function(responseID, response)
   {
-    let callback = this._nodeSizeCallbacks.get(responseID);
-    this._nodeSizeCallbacks.delete(responseID);
-    if (size && typeof callback == "function")
-      callback(size);
+    let callback = this._callbacks.get(responseID);
+    this._callbacks.delete(responseID);
+    if (typeof callback == "function")
+      callback(response);
+  },
+
+  /**
+   * Stores the nodes associated with the requests and generates a unique ID
+   * for them that can be used with Policy.refilterNodes(). Note that
+   * Policy.deleteNodes() always has to be called to release the memory.
+   * @param {number[]} requests  list of request IDs that were previously
+   *                             reported by this notifier.
+   * @param {Function} callback  function to be called with the nodes ID.
+   */
+  storeNodesForEntries: function(requests, callback)
+  {
+    if (!requests)
+      requests = [];
+
+    let id = ++this._maxResponseID;
+    this._callbacks.set(id, callback);
+
+    messageManager.broadcastAsyncMessage("AdblockPlus:StoreNodesForEntries", {
+      notifierID: this.id,
+      responseID: id,
+      requests,
+    });
   }
 };
 
 RequestNotifier.storeSelection = function(/**Window*/ wnd, /**String*/ selection)
 {
   windowSelection.set(wnd.document, selection);
 };
 RequestNotifier.getSelection = function(/**Window*/ wnd) /**String*/
 {
   if (windowSelection.has(wnd.document))
@@ skipping 12 matching lines @@
 RequestNotifier.getWindowStatistics = function(outerWindowID, callback)
 {
   let id = ++windowStatsMaxResponseID;
   windowStatsCallbacks.set(id, callback);
 
   messageManager.broadcastAsyncMessage("AdblockPlus:RetrieveWindowStats", {
     responseID: id,
     outerWindowID
   });
 }