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 WhitelistFilter = null;
+let CodeInjectionFilter = 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,
+     BlockingFilter, WhitelistFilter, CodeInjectionFilter, ElemHideBase,
+     ElemHideFilter,
      ElemHideException,
-     ElemHideEmulationFilter} = sandboxedRequire("../lib/filterClasses")
+     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 36 matching lines @@
       result.push("thirdParty=" + filter.thirdParty);
       if (filter instanceof BlockingFilter)
       {
         result.push("type=filterlist");
         result.push("collapse=" + filter.collapse);
         result.push("csp=" + filter.csp);
       }
       else if (filter instanceof WhitelistFilter)
         result.push("type=whitelist");
     }
-    else if (filter instanceof ElemHideBase)
+    else if (filter instanceof CodeInjectionFilter)
     {
       if (filter instanceof ElemHideFilter)
         result.push("type=elemhide");
       else if (filter instanceof ElemHideException)
         result.push("type=elemhideexception");
       else if (filter instanceof ElemHideEmulationFilter)
         result.push("type=elemhideemulation");
+      else if (filter instanceof SnippetFilter)
+        result.push("type=snippet");
 
-      result.push("selectorDomain=" + (filter.selectorDomain || ""));
-      result.push("selector=" + filter.selector);
+      result.push("injectionDomain=" + (filter.injectionDomain || ""));
+      result.push("code=" + filter.code);
     }
   }
   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");
   }
   if (type == "elemhide" || type == "elemhideexception" ||
-      type == "elemhideemulation")
+      type == "elemhideemulation" || type == "snippet")
   {
-    addProperty("selectorDomain", "");
+    addProperty("injectionDomain", "");
     addProperty("domains", "");
   }
 }
 
 function compareFilter(test, text, expected, postInit)
 {
   addDefaults(expected);
 
   let filter = Filter.fromText(text);
   if (postInit)
@@ skipping 23 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 WhitelistFilter, "function", "typeof WhitelistFilter");
+  test.equal(typeof CodeInjectionFilter, "function",
+             "typeof CodeInjectionFilter");
   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 100 matching lines @@
   compareFilter(test, "bla$csp=foo,csp=referrer foo", ["type=invalid", "text=bla$csp=foo,csp=referrer foo", "reason=filter_invalid_csp"]);
   compareFilter(test, "bla$csp=foo,csp=base-uri", ["type=invalid", "text=bla$csp=foo,csp=base-uri", "reason=filter_invalid_csp"]);
   compareFilter(test, "bla$csp=foo,csp=upgrade-insecure-requests", ["type=invalid", "text=bla$csp=foo,csp=upgrade-insecure-requests", "reason=filter_invalid_csp"]);
   compareFilter(test, "bla$csp=foo,csp=ReFeRReR", ["type=invalid", "text=bla$csp=foo,csp=ReFeRReR", "reason=filter_invalid_csp"]);
 
   test.done();
 };
 
 exports.testElementHidingRules = function(test)
 {
-  compareFilter(test, "##ddd", ["type=elemhide", "text=##ddd", "selector=ddd"]);
-  compareFilter(test, "##body > div:first-child", ["type=elemhide", "text=##body > div:first-child", "selector=body > div:first-child"]);
-  compareFilter(test, "foo##ddd", ["type=elemhide", "text=foo##ddd", "selectorDomain=foo", "selector=ddd", "domains=FOO"]);
-  compareFilter(test, "foo,bar##ddd", ["type=elemhide", "text=foo,bar##ddd", "selectorDomain=foo,bar", "selector=ddd", "domains=BAR|FOO"]);
-  compareFilter(test, "foo,~bar##ddd", ["type=elemhide", "text=foo,~bar##ddd", "selectorDomain=foo", "selector=ddd", "domains=FOO|~BAR"]);
-  compareFilter(test, "foo,~baz,bar##ddd", ["type=elemhide", "text=foo,~baz,bar##ddd", "selectorDomain=foo,bar", "selector=ddd", "domains=BAR|FOO|~BAZ"]);
+  compareFilter(test, "##ddd", ["type=elemhide", "text=##ddd", "code=ddd"]);
+  compareFilter(test, "##body > div:first-child", ["type=elemhide", "text=##body > div:first-child", "code=body > div:first-child"]);
+  compareFilter(test, "foo##ddd", ["type=elemhide", "text=foo##ddd", "injectionDomain=foo", "code=ddd", "domains=FOO"]);
+  compareFilter(test, "foo,bar##ddd", ["type=elemhide", "text=foo,bar##ddd", "injectionDomain=foo,bar", "code=ddd", "domains=BAR|FOO"]);
+  compareFilter(test, "foo,~bar##ddd", ["type=elemhide", "text=foo,~bar##ddd", "injectionDomain=foo", "code=ddd", "domains=FOO|~BAR"]);
+  compareFilter(test, "foo,~baz,bar##ddd", ["type=elemhide", "text=foo,~baz,bar##ddd", "injectionDomain=foo,bar", "code=ddd", "domains=BAR|FOO|~BAZ"]);
 
   test.done();
 };
 
 exports.testElementHidingExceptions = function(test)
 {
-  compareFilter(test, "#@#ddd", ["type=elemhideexception", "text=#@#ddd", "selector=ddd"]);
-  compareFilter(test, "#@#body > div:first-child", ["type=elemhideexception", "text=#@#body > div:first-child", "selector=body > div:first-child"]);
-  compareFilter(test, "foo#@#ddd", ["type=elemhideexception", "text=foo#@#ddd", "selectorDomain=foo", "selector=ddd", "domains=FOO"]);
-  compareFilter(test, "foo,bar#@#ddd", ["type=elemhideexception", "text=foo,bar#@#ddd", "selectorDomain=foo,bar", "selector=ddd", "domains=BAR|FOO"]);
-  compareFilter(test, "foo,~bar#@#ddd", ["type=elemhideexception", "text=foo,~bar#@#ddd", "selectorDomain=foo", "selector=ddd", "domains=FOO|~BAR"]);
-  compareFilter(test, "foo,~baz,bar#@#ddd", ["type=elemhideexception", "text=foo,~baz,bar#@#ddd", "selectorDomain=foo,bar", "selector=ddd", "domains=BAR|FOO|~BAZ"]);
+  compareFilter(test, "#@#ddd", ["type=elemhideexception", "text=#@#ddd", "code=ddd"]);
+  compareFilter(test, "#@#body > div:first-child", ["type=elemhideexception", "text=#@#body > div:first-child", "code=body > div:first-child"]);
+  compareFilter(test, "foo#@#ddd", ["type=elemhideexception", "text=foo#@#ddd", "injectionDomain=foo", "code=ddd", "domains=FOO"]);
+  compareFilter(test, "foo,bar#@#ddd", ["type=elemhideexception", "text=foo,bar#@#ddd", "injectionDomain=foo,bar", "code=ddd", "domains=BAR|FOO"]);
+  compareFilter(test, "foo,~bar#@#ddd", ["type=elemhideexception", "text=foo,~bar#@#ddd", "injectionDomain=foo", "code=ddd", "domains=FOO|~BAR"]);
+  compareFilter(test, "foo,~baz,bar#@#ddd", ["type=elemhideexception", "text=foo,~baz,bar#@#ddd", "injectionDomain=foo,bar", "code=ddd", "domains=BAR|FOO|~BAZ"]);
 
   test.done();
 };
 
 exports.testElemHideEmulationFilters = function(test)
 {
   // Check valid domain combinations
-  compareFilter(test, "foo.com#?#:-abp-properties(abc)", ["type=elemhideemulation", "text=foo.com#?#:-abp-properties(abc)", "selectorDomain=foo.com", "selector=:-abp-properties(abc)", "domains=FOO.COM"]);
-  compareFilter(test, "foo.com,~bar.com#?#:-abp-properties(abc)", ["type=elemhideemulation", "text=foo.com,~bar.com#?#:-abp-properties(abc)", "selectorDomain=foo.com", "selector=:-abp-properties(abc)", "domains=FOO.COM|~BAR.COM"]);
-  compareFilter(test, "foo.com,~bar#?#:-abp-properties(abc)", ["type=elemhideemulation", "text=foo.com,~bar#?#:-abp-properties(abc)", "selectorDomain=foo.com", "selector=:-abp-properties(abc)", "domains=FOO.COM|~BAR"]);
-  compareFilter(test, "~foo.com,bar.com#?#:-abp-properties(abc)", ["type=elemhideemulation", "text=~foo.com,bar.com#?#:-abp-properties(abc)", "selectorDomain=bar.com", "selector=:-abp-properties(abc)", "domains=BAR.COM|~FOO.COM"]);
+  compareFilter(test, "foo.com#?#:-abp-properties(abc)", ["type=elemhideemulation", "text=foo.com#?#:-abp-properties(abc)", "injectionDomain=foo.com", "code=:-abp-properties(abc)", "domains=FOO.COM"]);
+  compareFilter(test, "foo.com,~bar.com#?#:-abp-properties(abc)", ["type=elemhideemulation", "text=foo.com,~bar.com#?#:-abp-properties(abc)", "injectionDomain=foo.com", "code=:-abp-properties(abc)", "domains=FOO.COM|~BAR.COM"]);
+  compareFilter(test, "foo.com,~bar#?#:-abp-properties(abc)", ["type=elemhideemulation", "text=foo.com,~bar#?#:-abp-properties(abc)", "injectionDomain=foo.com", "code=:-abp-properties(abc)", "domains=FOO.COM|~BAR"]);
+  compareFilter(test, "~foo.com,bar.com#?#:-abp-properties(abc)", ["type=elemhideemulation", "text=~foo.com,bar.com#?#:-abp-properties(abc)", "injectionDomain=bar.com", "code=:-abp-properties(abc)", "domains=BAR.COM|~FOO.COM"]);
 
   // Check some special cases
   compareFilter(test, "#?#:-abp-properties(abc)", ["type=invalid", "text=#?#:-abp-properties(abc)", "reason=filter_elemhideemulation_nodomain"]);
-  compareFilter(test, "foo.com#?#abc", ["type=elemhideemulation", "text=foo.com#?#abc", "selectorDomain=foo.com", "selector=abc", "domains=FOO.COM"]);
-  compareFilter(test, "foo.com#?#:-abp-foobar(abc)", ["type=elemhideemulation", "text=foo.com#?#:-abp-foobar(abc)", "selectorDomain=foo.com", "selector=:-abp-foobar(abc)", "domains=FOO.COM"]);
-  compareFilter(test, "foo.com#?#aaa :-abp-properties(abc) bbb", ["type=elemhideemulation", "text=foo.com#?#aaa :-abp-properties(abc) bbb", "selectorDomain=foo.com", "selector=aaa :-abp-properties(abc) bbb", "domains=FOO.COM"]);
-  compareFilter(test, "foo.com#?#:-abp-properties(|background-image: url(data:*))", ["type=elemhideemulation", "text=foo.com#?#:-abp-properties(|background-image: url(data:*))", "selectorDomain=foo.com", "selector=:-abp-properties(|background-image: url(data:*))", "domains=FOO.COM"]);
+  compareFilter(test, "foo.com#?#abc", ["type=elemhideemulation", "text=foo.com#?#abc", "injectionDomain=foo.com", "code=abc", "domains=FOO.COM"]);
+  compareFilter(test, "foo.com#?#:-abp-foobar(abc)", ["type=elemhideemulation", "text=foo.com#?#:-abp-foobar(abc)", "injectionDomain=foo.com", "code=:-abp-foobar(abc)", "domains=FOO.COM"]);
+  compareFilter(test, "foo.com#?#aaa :-abp-properties(abc) bbb", ["type=elemhideemulation", "text=foo.com#?#aaa :-abp-properties(abc) bbb", "injectionDomain=foo.com", "code=aaa :-abp-properties(abc) bbb", "domains=FOO.COM"]);
+  compareFilter(test, "foo.com#?#:-abp-properties(|background-image: url(data:*))", ["type=elemhideemulation", "text=foo.com#?#:-abp-properties(|background-image: url(data:*))", "injectionDomain=foo.com", "code=:-abp-properties(|background-image: url(data:*))", "domains=FOO.COM"]);
 
   // Check conversion of legacy filters
-  compareFilter(test, "foo.com##[-abp-properties='abc']", ["type=elemhideemulation", "text=foo.com#?#:-abp-properties(abc)", "selectorDomain=foo.com", "selector=:-abp-properties(abc)", "domains=FOO.COM"]);
+  compareFilter(test, "foo.com##[-abp-properties='abc']", ["type=elemhideemulation", "text=foo.com#?#:-abp-properties(abc)", "injectionDomain=foo.com", "code=:-abp-properties(abc)", "domains=FOO.COM"]);
   test.equal(Filter.fromText("foo.com##[-abp-properties='abc']"), Filter.fromText("foo.com#?#:-abp-properties(abc)"));
-  compareFilter(test, "foo.com#@#[-abp-properties='abc']", ["type=elemhideexception", "text=foo.com#@#[-abp-properties='abc']", "selectorDomain=foo.com", "selector=[-abp-properties='abc']", "domains=FOO.COM"]);
-  compareFilter(test, "foo.com#?#[-abp-properties='abc']", ["type=elemhideemulation", "text=foo.com#?#[-abp-properties='abc']", "selectorDomain=foo.com", "selector=[-abp-properties='abc']", "domains=FOO.COM"]);
-  compareFilter(test, "foo.com##aaa [-abp-properties='abc'] bbb", ["type=elemhideemulation", "text=foo.com#?#aaa :-abp-properties(abc) bbb", "selectorDomain=foo.com", "selector=aaa :-abp-properties(abc) bbb", "domains=FOO.COM"]);
+  compareFilter(test, "foo.com#@#[-abp-properties='abc']", ["type=elemhideexception", "text=foo.com#@#[-abp-properties='abc']", "injectionDomain=foo.com", "code=[-abp-properties='abc']", "domains=FOO.COM"]);
+  compareFilter(test, "foo.com#?#[-abp-properties='abc']", ["type=elemhideemulation", "text=foo.com#?#[-abp-properties='abc']", "injectionDomain=foo.com", "code=[-abp-properties='abc']", "domains=FOO.COM"]);
+  compareFilter(test, "foo.com##aaa [-abp-properties='abc'] bbb", ["type=elemhideemulation", "text=foo.com#?#aaa :-abp-properties(abc) bbb", "injectionDomain=foo.com", "code=aaa :-abp-properties(abc) bbb", "domains=FOO.COM"]);
 
   // test matching -abp-properties= (https://issues.adblockplus.org/ticket/5037).
-  compareFilter(test, "foo.com##[-abp-properties-bogus='abc']", ["type=elemhide", "text=foo.com##[-abp-properties-bogus='abc']", "selectorDomain=foo.com", "selector=[-abp-properties-bogus='abc']", "domains=FOO.COM"]);
+  compareFilter(test, "foo.com##[-abp-properties-bogus='abc']", ["type=elemhide", "text=foo.com##[-abp-properties-bogus='abc']", "injectionDomain=foo.com", "code=[-abp-properties-bogus='abc']", "domains=FOO.COM"]);
 
   test.done();
 };
 
 exports.testEmptyElemHideDomains = function(test)
 {
   let emptyDomainFilters = [
     ",##selector", ",,,##selector", "~,foo.com##selector", "foo.com,##selector",
     ",foo.com##selector", "foo.com,~##selector",
     "foo.com,,bar.com##selector", "foo.com,~,bar.com##selector"
   ];
 
   for (let filterText of emptyDomainFilters)
   {
     let filter = Filter.fromText(filterText);
     test.ok(filter instanceof InvalidFilter);
     test.equal(filter.reason, "filter_invalid_domain");
   }
 
   test.done();
 };
 
 exports.testElemHideRulesWithBraces = function(test)
 {
   compareFilter(
     test, "###foo{color: red}", [
       "type=elemhide",
       "text=###foo{color: red}",
-      "selectorDomain=",
-      "selector=#foo\\7B color: red\\7D ",
+      "injectionDomain=",
+      "code=#foo\\7B color: red\\7D ",
       "domains="
     ]
   );
   compareFilter(
     test, "foo.com#?#:-abp-properties(/margin: [3-4]{2}/)", [
       "type=elemhideemulation",
       "text=foo.com#?#:-abp-properties(/margin: [3-4]{2}/)",
-      "selectorDomain=foo.com",
-      "selector=:-abp-properties(/margin: [3-4]\\7B 2\\7D /)",
+      "injectionDomain=foo.com",
+      "code=:-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", "injectionDomain=foo.com", "code=abc", "domains=FOO.COM"]);
+  compareFilter(test, "foo.com,~bar.com#$#abc", ["type=snippet", "text=foo.com,~bar.com#$#abc", "injectionDomain=foo.com", "code=abc", "domains=FOO.COM|~BAR.COM"]);
+  compareFilter(test, "foo.com,~bar#$#abc", ["type=snippet", "text=foo.com,~bar#$#abc", "injectionDomain=foo.com", "code=abc", "domains=FOO.COM|~BAR"]);
+  compareFilter(test, "~foo.com,bar.com#$#abc", ["type=snippet", "text=~foo.com,bar.com#$#abc", "injectionDomain=bar.com", "code=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 24 matching lines @@
              "foo$csp=bar,$csp=c s p");
   test.equal(Filter.normalize(" f o   o   $      bar   $csp=ba r"),
              "foo$bar$csp=ba r");
   test.equal(Filter.normalize("f    $    o    $    o    $    csp=f o o "),
              "f$o$o$csp=f o o");
   test.equal(Filter.normalize("/foo$/$ csp = script-src  http://example.com/?$1=1&$2=2&$3=3"),
              "/foo$/$csp=script-src http://example.com/?$1=1&$2=2&$3=3");
 
   test.done();
 };