Issue 6402 - Split filter hit / request logging out into own API

lib/cssInjection.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present 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 cssInjection */
 
 "use strict";
 
-const {RegExpFilter} = require("filterClasses");
-const {ElemHide} = require("elemHide");
-const {ElemHideEmulation} = require("elemHideEmulation");
-const {checkWhitelisted} = require("whitelisting");
-const {extractHostFromFrame} = require("url");
-const {port} = require("messaging");
-const {hasListener} = require("hitLogger");
-const info = require("info");
+const {RegExpFilter} = require("../adblockpluscore/lib/filterClasses");
+const {ElemHide} = require("../adblockpluscore/lib/elemHide");
+const {ElemHideEmulation} = require("../adblockpluscore/lib/elemHideEmulation");
+const {checkWhitelisted} = require("./whitelisting");
+const {extractHostFromFrame} = require("./url");
+const {port} = require("./messaging");
+const {HitLogger} = require("./hitLogger");
+const info = require("../buildtools/info");
 
 // Chromium's support for tabs.removeCSS is still a work in progress and the
 // API is likely to be different from Firefox's; for now we just don't use it
 // at all, even if it's available.
 // See https://crbug.com/608854
 const styleSheetRemovalSupported = info.platform == "gecko";
 
 const selectorGroupSize = 1024;
 
 let userStyleSheetsSupported = true;
@@ skipping 23 matching lines @@
 
 function createStyleSheet(selectors)
 {
   return Array.from(createRules(selectors)).join("\n");
 }
 
 function addStyleSheet(tabId, frameId, styleSheet)
 {
   try
   {
-    browser.tabs.insertCSS(tabId, {
+    let promise = browser.tabs.insertCSS(tabId, {
       code: styleSheet,
       cssOrigin: "user",
       frameId,
       matchAboutBlank: true,
       runAt: "document_start"
     });
+
+    // See error handling notes in the catch block.
+    promise.catch(() => {});
   }
   catch (error)
   {
+    // If the error is about the "cssOrigin" option, this is an older version
+    // of Chromium (65 and below) or Firefox (52 and below) that does not
+    // support user style sheets.
     if (/\bcssOrigin\b/.test(error.message))
       userStyleSheetsSupported = false;
 
+    // For other errors, we simply return false to indicate failure.
+    //
+    // One common error that occurs frequently is when a frame is not found
+    // (e.g. "Error: No frame with id 574 in tab 266"), which can happen when
+    // the code in the parent document has removed the frame before the
+    // background page has had a chance to respond to the content script's
+    // "elemhide.getSelectors" message. We simply ignore such errors, because
+    // otherwise they show up in the log too often and make debugging
+    // difficult.
+    //
+    // Also note that the missing frame error is thrown synchronously on
+    // Firefox, while on Chromium it is an asychronous promise rejection. In
+    // the latter case, we cannot indicate failure to the caller, but we still
+    // explicitly ignore the error.
     return false;
   }
 
   return true;
 }
 
 function removeStyleSheet(tabId, frameId, styleSheet)
 {
   if (!styleSheetRemovalSupported)
     return;
 
   browser.tabs.removeCSS(tabId, {
     code: styleSheet,
     cssOrigin: "user",
     frameId,
     matchAboutBlank: true
   });
 }
 
-function updateFrameStyles(tabId, frameId, selectors, groupName)
-{
-  let styleSheet = null;
+function updateFrameStyles(tabId, frameId, selectors, groupName, appendOnly)
+{
+  let styleSheet = "";
   if (selectors.length > 0)
     styleSheet = createStyleSheet(selectors);
 
   let frame = ext.getFrame(tabId, frameId);
   if (!frame)
     return false;
 
   if (!frame.injectedStyleSheets)
     frame.injectedStyleSheets = new Map();
 
   let oldStyleSheet = frame.injectedStyleSheets.get(groupName);
+
+  if (appendOnly && oldStyleSheet)
+    styleSheet = oldStyleSheet + styleSheet;
 
   // Ideally we would compare the old and new style sheets and skip this code
   // if they're the same, but the old style sheet can be a leftover from a
   // previous instance of the frame. We must add the new style sheet
   // regardless.
 
   // Add the new style sheet first to keep previously hidden elements from
   // reappearing momentarily.
   if (styleSheet && !addStyleSheet(tabId, frameId, styleSheet))
     return false;
 
   // Sometimes the old and new style sheets can be exactly the same. In such a
   // case, do not remove the "old" style sheet, because it is in fact the new
   // style sheet now.
   if (oldStyleSheet && oldStyleSheet != styleSheet)
     removeStyleSheet(tabId, frameId, oldStyleSheet);
 
   frame.injectedStyleSheets.set(groupName, styleSheet);
   return true;
 }
 
 port.on("elemhide.getSelectors", (message, sender) =>
 {
   let selectors = [];
   let emulatedPatterns = [];
-  let trace = hasListener(sender.page.id);
+  let trace = HitLogger.hasListener(sender.page.id);
   let inline = !userStyleSheetsSupported;
 
-  if (!checkWhitelisted(sender.page, sender.frame,
+  if (!checkWhitelisted(sender.page, sender.frame, null,
                         RegExpFilter.typeMap.DOCUMENT |
                         RegExpFilter.typeMap.ELEMHIDE))
   {
     let hostname = extractHostFromFrame(sender.frame);
-    let specificOnly = checkWhitelisted(sender.page, sender.frame,
+    let specificOnly = checkWhitelisted(sender.page, sender.frame, null,
                                         RegExpFilter.typeMap.GENERICHIDE);
 
     selectors = ElemHide.getSelectorsForDomain(
       hostname,
       specificOnly ? ElemHide.SPECIFIC_ONLY : ElemHide.ALL_MATCHING
     );
 
     for (let filter of ElemHideEmulation.getRulesForDomain(hostname))
       emulatedPatterns.push({selector: filter.selector, text: filter.text});
   }
@@ skipping 14 matching lines @@
   // add styles for emulation filters inline.
   if (!styleSheetRemovalSupported)
     response.inlineEmulated = true;
 
   return response;
 });
 
 port.on("elemhide.injectSelectors", (message, sender) =>
 {
   updateFrameStyles(sender.page.id, sender.frame.id, message.selectors,
-                    message.groupName);
+                    message.groupName, message.appendOnly);
 });