Issue 3823 - Split up message responder code

lib/filterComposer.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 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/>.
  */
 
 /** @module filterComposer */
 
+"use strict";
+
 let {extractHostFromFrame, stringifyURL, isThirdParty} = require("url");
 let {getKey, checkWhitelisted} = require("whitelisting");
 let {defaultMatcher} = require("matcher");
 let {RegExpFilter} = require("filterClasses");
+let {port} = require("messaging");
 
 function isValidString(s) {
   return s && s.indexOf("\0") == -1;
 }
 
 function escapeChar(chr)
 {
   let code = chr.charCodeAt(0);
 
   // Control characters and leading digits must be escaped based on
@@ skipping 25 matching lines @@
  *
  * @param {string} value
  * @return {string}
  * @static
  */
 exports.quoteCSS = function(value)
 {
   return '"' + value.replace(/["\\\{\}\x00-\x1F\x7F]/g, escapeChar) + '"';
 };
 
-/**

[kzar, 2016/03/18 15:22:10]

Any reason you deleted this documentation? (I understand it's no longer an
exported function but what's the harm in leaving it in? It could still be useful
to someone who is trying to understand the code.)

[Sebastian Noack, 2016/03/18 15:26:21]

I found the documentation for this function quite long given that it's mostly
boilerplate not really adding anything that isn't already obvious. So I used the
chance to remove that documentation while it's no longer a public function.

[kzar, 2016/03/18 15:52:39]

I think it's useful but if you disagree I guess we can leave the deciding vote
to Wlaidmir.

- * Generates filters to block an element.
- * @param {Object}   details
- * @param {string}   details.tagName  The element's tag name
- * @param {string}   details.id       The element's "id" attribute
- * @param {string}   details.src      The element's "src" attribute
- * @param {string}   details.style    The element's "style" attribute
- * @param {string[]} details.classes  The classes given by the element's "class" attribute
- * @param {string[]} details.urls     The URLs considered when loading the element
- * @param {string}   details.type     The request type (will be ignored if there are no URLs)
- * @param {string}   details.baseURL  The URL of the document containing the element
- * @param {Page}     details.page     The page containing the element
- * @param {Frame}    details.frame    The frame containing the element
- *
- * @return {object} An object holding the list of generated filters and
- *                  the list of CSS selectors for the included element
- *                  hiding filters: {filters: [...], selectors: [...]}
- */
-exports.composeFilters = function(details)
+function composeFilters(details)
 {
   let filters = [];
   let selectors = [];
 
   let page = details.page;
   let frame = details.frame;
 
   if (!checkWhitelisted(page, frame))
   {
     let typeMask = RegExpFilter.typeMap[details.type];
@@ skipping 46 matching lines @@
       if (isValidString(details.style) && selectors.length == 0 && filters.length == 0)
         selectors.push(escapeCSS(details.tagName) + "[style=" + quoteCSS(details.style) + "]");
 
       // Add an element hiding filter for each generated CSS selector
       for (let selector of selectors)
         filters.push(docDomain.replace(/^www\./, "") + "##" + selector);
     }
   }
 
   return {filters: filters, selectors: selectors};
-};
+}
+
+port.on("composer.ready", (message, sender) =>
+{
+  htmlPages.set(sender.page, null);
+  refreshIconAndContextMenu(sender.page);
+});
+
+port.on("composer.openDialog", (message, sender) =>
+{
+  return new Promise(resolve =>
+  {
+    ext.windows.create({
+      url: ext.getURL("block.html"),
+      left: 50,
+      top: 50,
+      width: 420,
+      height: 200,
+      focused: true,
+      type: "popup"
+    },
+    popupPage =>
+    {
+      let popupPageId = popupPage.id;
+      function onRemoved(removedPageId)
+      {
+        if (popupPageId == removedPageId)
+        {
+          sender.page.sendMessage({
+            type: "blockelement-popup-closed",
+            popupId: popupPageId
+          });
+          ext.pages.onRemoved.removeListener(onRemoved);
+        }
+      }
+      ext.pages.onRemoved.addListener(onRemoved);
+      resolve(popupPageId);
+    });
+  });
+});
+
+port.on("composer.getFilters", (message, sender) =>
+{
+  return composeFilters({
+    tagName: message.tagName,
+    id:      message.id,
+    src:     message.src,
+    style:   message.style,
+    classes: message.classes,
+    urls:    message.urls,
+    type:    message.mediatype,
+    baseURL: message.baseURL,
+    page:    sender.page,
+    frame:   sender.frame
+  });
+});