Issue 5090 - Use user stylesheets for element hiding if possible

lib/elemHideHelper.js

+/*
+ * This file is part of Adblock Plus <https://adblockplus.org/>,
+ * Copyright (C) 2006-2017 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 elemHideHelper */
+
+"use strict";
+
+const {RegExpFilter} = require("filterClasses");
+const {ElemHide} = require("elemHide");
+const {checkWhitelisted} = require("whitelisting");
+const {extractHostFromFrame} = require("url");
+const {port} = require("messaging");
+const devtools = require("devtools");
+
+let userStylesheetsSupported = true;
+
+function hideElements(tabId, frameId, selectors)
+{
+  let code = selectors.join(", ") + "{display: none !important;}";
+
+  try
+  {
+    chrome.tabs.insertCSS(tabId,
+      {
+        code,
+        cssOrigin: "user",
+        frameId,
+        matchAboutBlank: true
+      }
+    );
+    return true;
+  }
+  catch (error)
+  {
+    if (/\bError processing cssOrigin\b/.test(error.message) == -1)
+      throw error;
+
+    userStylesheetsSupported = false;
+    return false;
+  }
+}
+
+port.on("get-selectors", (msg, sender) =>

[Sebastian Noack, 2017/07/07 16:16:09]

In new code we use component.method (camel-cased) for message names. So this
should probably be "elemhide.getSelectors", and instead of "hide-elements", you
might want to go for "elemhide.injectSelectors".

[Manish Jethani, 2017/07/09 12:09:38]

Done.

+{
+  let selectors;
+  let trace = devtools && devtools.hasPanel(sender.page);
+
+  if (!checkWhitelisted(sender.page, sender.frame,
+                        RegExpFilter.typeMap.DOCUMENT |
+                        RegExpFilter.typeMap.ELEMHIDE))
+  {
+    let specificOnly = checkWhitelisted(sender.page, sender.frame,
+                                        RegExpFilter.typeMap.GENERICHIDE);
+    selectors = ElemHide.getSelectorsForDomain(
+      extractHostFromFrame(sender.frame),
+      specificOnly ? ElemHide.SPECIFIC_ONLY : ElemHide.ALL_MATCHING
+    );
+  }
+  else
+  {
+    selectors = [];
+  }
+
+  if (selectors.length == 0 || userStylesheetsSupported &&
+      hideElements(sender.page.id, sender.frame.id, selectors))
+  {
+    if (trace)
+      return {selectors, trace: true, inject: false};
+
+    return {trace: false, inject: false};
+  }
+
+  return {selectors, trace, inject: true};
+});
+
+port.on("hide-elements", (msg, sender) =>
+{
+  return hideElements(sender.page.id, sender.frame.id, msg.selectors);
+});