Issue 6538, 6781 - Implement support for snippet filters

test/filterClasses.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/>.
  */
 
 "use strict";
 
 const {createSandbox} = require("./_common");
 
 let Filter = null;
 let InvalidFilter = null;
 let CommentFilter = null;
 let ActiveFilter = null;
 let RegExpFilter = null;
 let BlockingFilter = null;
+let ScriptFilter = null;
 let WhitelistFilter = null;
 let ElemHideBase = null;
 let ElemHideFilter = null;
 let ElemHideException = null;
 let ElemHideEmulationFilter = null;
+let SnippetFilter = null;
 
 let t = null;
 let defaultTypes = null;
 
 exports.setUp = function(callback)
 {
   let sandboxedRequire = createSandbox();
   (
     {Filter, InvalidFilter, CommentFilter, ActiveFilter, RegExpFilter,
-     BlockingFilter, WhitelistFilter, ElemHideBase, ElemHideFilter,
-     ElemHideException,
-     ElemHideEmulationFilter} = sandboxedRequire("../lib/filterClasses")
+     BlockingFilter, WhitelistFilter, ScriptFilter, ElemHideBase,
+     ElemHideFilter, ElemHideException, ElemHideEmulationFilter,
+     SnippetFilter} = sandboxedRequire("../lib/filterClasses")
   );
   t = RegExpFilter.typeMap;
   defaultTypes = 0x7FFFFFFF & ~(t.CSP | t.ELEMHIDE | t.DOCUMENT | t.POPUP |
                                 t.GENERICHIDE | t.GENERICBLOCK);
 
   callback();
 };
 
 function serializeFilter(filter)
 {
@@ skipping 52 matching lines @@
         result.push("type=elemhideexception");
       else if (filter instanceof ElemHideEmulationFilter)
         result.push("type=elemhideemulation");
 
       result.push("selectorDomains=" +
                   [...filter.domains || []]
                   .filter(([domain, isIncluded]) => isIncluded)
                   .map(([domain]) => domain.toLowerCase()));
       result.push("selector=" + filter.selector);
     }
+    else if (filter instanceof SnippetFilter)
+    {
+      result.push("type=snippet");
+      result.push("scriptDomains=" +
+                  [...filter.domains || []]
+                  .filter(([domain, isIncluded]) => isIncluded)
+                  .map(([domain]) => domain.toLowerCase()));
+      result.push("script=" + filter.script);
+    }
   }
   return result;
 }
 
 function addDefaults(expected)
 {
   let type = null;
   let hasProperty = {};
   for (let entry of expected)
   {
     if (/^type=(.*)/.test(entry))
       type = RegExp.$1;
     else if (/^(\w+)/.test(entry))
       hasProperty[RegExp.$1] = true;
   }
 
   function addProperty(prop, value)
   {
     if (!(prop in hasProperty))
       expected.push(prop + "=" + value);
   }
 
   if (type == "whitelist" || type == "filterlist" || type == "elemhide" ||
-      type == "elemhideexception" || type == "elemhideemulation")
+      type == "elemhideexception" || type == "elemhideemulation" ||
+      type == "snippet")
   {
     addProperty("disabled", "false");
     addProperty("lastHit", "0");
     addProperty("hitCount", "0");
   }
   if (type == "whitelist" || type == "filterlist")
   {
     addProperty("contentType", 0x7FFFFFFF & ~(
       t.CSP | t.DOCUMENT | t.ELEMHIDE | t.POPUP | t.GENERICHIDE | t.GENERICBLOCK
     ));
     addProperty("matchCase", "false");
     addProperty("thirdParty", "null");
     addProperty("domains", "");
     addProperty("sitekeys", "");
   }
   if (type == "filterlist")
   {
     addProperty("collapse", "null");
     addProperty("csp", "null");
     addProperty("rewrite", "null");
   }
   if (type == "elemhide" || type == "elemhideexception" ||
       type == "elemhideemulation")
   {
     addProperty("selectorDomains", "");
     addProperty("domains", "");
   }
+  if (type == "snippet")
+  {
+    addProperty("scriptDomains", "");
+    addProperty("domains", "");
+  }
 }
 
 function compareFilter(test, text, expected, postInit)
 {
   addDefaults(expected);
 
   let filter = Filter.fromText(text);
   if (postInit)
     postInit(filter);
   let result = serializeFilter(filter);
@@ skipping 20 matching lines @@
 }
 
 exports.testFilterClassDefinitions = function(test)
 {
   test.equal(typeof Filter, "function", "typeof Filter");
   test.equal(typeof InvalidFilter, "function", "typeof InvalidFilter");
   test.equal(typeof CommentFilter, "function", "typeof CommentFilter");
   test.equal(typeof ActiveFilter, "function", "typeof ActiveFilter");
   test.equal(typeof RegExpFilter, "function", "typeof RegExpFilter");
   test.equal(typeof BlockingFilter, "function", "typeof BlockingFilter");
+  test.equal(typeof ScriptFilter, "function", "typeof ScriptFilter");
   test.equal(typeof WhitelistFilter, "function", "typeof WhitelistFilter");
   test.equal(typeof ElemHideBase, "function", "typeof ElemHideBase");
   test.equal(typeof ElemHideFilter, "function", "typeof ElemHideFilter");
   test.equal(typeof ElemHideException, "function", "typeof ElemHideException");
   test.equal(typeof ElemHideEmulationFilter, "function",
              "typeof ElemHideEmulationFilter");
+  test.equal(typeof SnippetFilter, "function", "typeof SnippetFilter");
 
   test.done();
 };
 
 exports.testComments = function(test)
 {
   compareFilter(test, "!asdf", ["type=comment", "text=!asdf"]);
   compareFilter(test, "!foo#bar", ["type=comment", "text=!foo#bar"]);
   compareFilter(test, "!foo##bar", ["type=comment", "text=!foo##bar"]);
 
@@ skipping 192 matching lines @@
       "type=elemhideemulation",
       "text=foo.com#?#:-abp-properties(/margin: [3-4]{2}/)",
       "selectorDomains=foo.com",
       "selector=:-abp-properties(/margin: [3-4]\\7B 2\\7D /)",
       "domains=foo.com"
     ]
   );
   test.done();
 };
 
+exports.testSnippetFilters = function(test)
+{
+  compareFilter(test, "foo.com#$#abc", ["type=snippet", "text=foo.com#$#abc", "scriptDomains=foo.com", "script=abc", "domains=foo.com"]);
+  compareFilter(test, "foo.com,~bar.com#$#abc", ["type=snippet", "text=foo.com,~bar.com#$#abc", "scriptDomains=foo.com", "script=abc", "domains=foo.com|~bar.com"]);
+  compareFilter(test, "foo.com,~bar#$#abc", ["type=snippet", "text=foo.com,~bar#$#abc", "scriptDomains=foo.com", "script=abc", "domains=foo.com|~bar"]);
+  compareFilter(test, "~foo.com,bar.com#$#abc", ["type=snippet", "text=~foo.com,bar.com#$#abc", "scriptDomains=bar.com", "script=abc", "domains=bar.com|~foo.com"]);
+
+  test.done();
+};
+
 exports.testFilterNormalization = function(test)
 {
   // Line breaks etc
   test.equal(Filter.normalize("\n\t\nad\ns"),
              "ads");
 
   // Comment filters
   test.equal(Filter.normalize("   !  fo  o##  bar   "),
              "!  fo  o##  bar");
 
@@ skipping 19 matching lines @@
   test.equal(Filter.normalize("   domain.c  om#@# # sele ctor   "),
              "domain.com#@## sele ctor");
 
   // Incorrect syntax: the separator "#@#" cannot contain spaces; treated as a
   // regular filter instead (not an element hiding filter either!), because
   // unlike the case with "# ?##" the "##" following the "@" is not considered
   // to be a separator
   test.equal(Filter.normalize("   domain.c  om# @## sele ctor   "),
              "domain.com#@##selector");
 
+  // Snippet filters
+  test.equal(Filter.normalize("   domain.c  om#$#  sni pp  et   "),
+             "domain.com#$#sni pp  et");
+
   // Regular filters
   let normalized = Filter.normalize(
     "    b$l     a$sitekey=  foo  ,domain= do main.com |foo   .com,c sp= c   s p  "
   );
   test.equal(
     normalized,
     "b$la$sitekey=foo,domain=domain.com|foo.com,csp=c s p"
   );
   compareFilter(
     test, normalized, [
@@ skipping 76 matching lines @@
   let rewriteEvil = "/(^https?:\\/\\/[^/])/$script,rewrite=$1.evil.com";
   let filterEvil = Filter.fromText(rewriteEvil);
 
   test.equal(
     filterEvil.rewriteUrl("https://www.adblockplus.org/script.js"),
     "https://www.adblockplus.org/script.js"
   );
 
   test.done();
 };