Issue 6539, 6782 - Implement support for snippets

lib/scriptInjection.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 */
+/** @module scriptInjection */
 
 "use strict";
 
 const {RegExpFilter} = require("../adblockpluscore/lib/filterClasses");
 const {ElemHide} = require("../adblockpluscore/lib/elemHide");
 const {ElemHideEmulation} = require("../adblockpluscore/lib/elemHideEmulation");
+const {Snippets, compileScript} = require("../adblockpluscore/lib/snippets");
 const {checkWhitelisted} = require("./whitelisting");
 const {extractHostFromFrame} = require("./url");
 const {port} = require("./messaging");
 const {HitLogger} = require("./hitLogger");
 const info = require("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;
 
+let snippetsLibrarySource = "";
+let executableCode = new Map();
+
 function* splitSelectors(selectors)
 {
   // Chromium's Blink engine supports only up to 8,192 simple selectors, and
   // even fewer compound selectors, in a rule. The exact number of selectors
   // that would work depends on their sizes (e.g. "#foo .bar" has a size of 2).
   // Since we don't know the sizes of the selectors here, we simply split them
   // into groups of 1,024, based on the reasonable assumption that the average
   // selector won't have a size greater than 8. The alternative would be to
   // calculate the sizes of the selectors and divide them up accordingly, but
   // this approach is more efficient and has worked well in practice. In theory
@@ skipping 37 matching lines @@
     // 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
+    // "content.applyFilters" 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;
   }
 
@@ skipping 44 matching lines @@
   // 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) =>
+function getExecutableCode(script)
+{
+  let code = executableCode.get(script);
+  if (code)
+    return code;
+
+  code = compileScript(script, [snippetsLibrarySource]);
+
+  executableCode.set(script, code);
+  return code;
+}
+
+function executeScript(script, tabId, frameId)
+{
+  try
+  {
+    browser.tabs.executeScript(tabId, {
+      code: getExecutableCode(script),
+      frameId,
+      matchAboutBlank: true,
+      runAt: "document_start"
+    })
+    .catch(error =>
+    {
+      // Sometimes a frame is added and removed very quickly, in such cases we
+      // simply ignore the error.
+      if (error.message == "The frame was removed.")
+        return;
+
+      throw error;
+    });
+  }
+  catch (error)
+  {
+  }
+}
+
+port.on("content.applyFilters", (message, sender) =>
 {
   let selectors = [];
   let emulatedPatterns = [];
   let trace = HitLogger.hasListener(sender.page.id);
   let inline = !userStyleSheetsSupported;
 
+  let {elemhide = false, snippets = false} = message.filterTypes ||
+                                             {elemhide: true, snippets: true};
+
   if (!checkWhitelisted(sender.page, sender.frame, null,
-                        RegExpFilter.typeMap.DOCUMENT |
-                        RegExpFilter.typeMap.ELEMHIDE))
+                        RegExpFilter.typeMap.DOCUMENT))
   {
     let hostname = extractHostFromFrame(sender.frame);
-    let specificOnly = checkWhitelisted(sender.page, sender.frame, null,
-                                        RegExpFilter.typeMap.GENERICHIDE);
 
-    selectors = ElemHide.getSelectorsForDomain(hostname, specificOnly);
+    if (snippets)
+    {
+      for (let script of Snippets.getScriptsForDomain(hostname))
+        executeScript(script, sender.page.id, sender.frame.id);
+    }
 
-    for (let filter of ElemHideEmulation.getRulesForDomain(hostname))
-      emulatedPatterns.push({selector: filter.selector, text: filter.text});
+    if (elemhide && !checkWhitelisted(sender.page, sender.frame, null,
+                                      RegExpFilter.typeMap.ELEMHIDE))
+    {
+      let specificOnly = checkWhitelisted(sender.page, sender.frame, null,
+                                          RegExpFilter.typeMap.GENERICHIDE);
+      selectors = ElemHide.getSelectorsForDomain(hostname, specificOnly);
+
+      for (let filter of ElemHideEmulation.getRulesForDomain(hostname))
+        emulatedPatterns.push({selector: filter.selector, text: filter.text});
+    }
   }
 
   if (!inline && !updateFrameStyles(sender.page.id, sender.frame.id,
                                     selectors, "standard"))
   {
     inline = true;
   }
 
   let response = {trace, inline, emulatedPatterns};
   if (trace || inline)
     response.selectors = selectors;
 
   // If we can't remove user style sheets using tabs.removeCSS, we'll only keep
   // adding them, which could cause problems with emulation filters as
   // described in issue #5864. Instead, we can just ask the content script to
   // 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.appendOnly);
 });
+
+fetch(browser.extension.getURL("/snippets.js"), {cache: "no-cache"})
+.then(response => response.ok ? response.text() : "")
+.then(text =>
+{
+  snippetsLibrarySource = text;
+});