Issue 5325 - Add support for separator characters

test/abp2blocklist.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
@@ skipping 34 matching lines @@
       {trigger: {"url-filter": "^https?://([^/:]*\\.)?test\\.com[/:]",
                  "url-filter-is-case-sensitive": true},
        action: {type: "css-display-none", selector: ".whatever"}}
     ]);
 
     test.done();
   },
 
   testElementHidingExceptions: function(test)
   {
-    // Element hiding rules should be in the following order: (1) generic
-    // rules, (2) exceptions for generic rules, (3) domain-specific rules,
-    // (4) exceptions for all rules.
     testRules(test, [
       "##.whatever",
       "test.com###something",
       "@@||special.test.com^$elemhide",
-      "@@||test.com^$generichide"
+      "@@||test.com^$generichide",
+      "@@^something^$elemhide",
+      "@@^anything^$generichide"
     ], [
-      ["^https?://", "css-display-none"],
-      ["^https?://([^/]+\\.)?test\\.com([^-_.%a-z0-9].*)?$",
-       "ignore-previous-rules"],
-      ["^https?://([^/:]*\\.)?test\\.com[/:]", "css-display-none"],
-      ["^https?://([^/]+\\.)?special\\.test\\.com([^-_.%a-z0-9].*)?$",
-       "ignore-previous-rules"]
+      ["^https?://", ["*test.com", "*special.test.com"]],
+      ["^https?://([^/:]*\\.)?test\\.com[/:]", ["*special.test.com"]]
     ], rules => rules.map(rule => [rule.trigger["url-filter"],
-                                   rule.action.type]));
+                                   rule.trigger["unless-domain"]]));
 
     testRules(test, ["#@#whatever"], []);
     testRules(test, ["test.com#@#whatever"], []);
     testRules(test, ["~test.com#@#whatever"], []);
 
     // We currently completely ignore any element hiding filters that have the
     // same selector as an element hiding exception. In these examples #whatever
     // should be hidden for all domains not ending in test.com instead of
     // nowhere!
     testRules(test, ["test.com#@#whatever", "##whatever"], []);
     testRules(test, ["~test.com##whatever"], []);
 
     test.done();
   },
 
   testRequestFilters: function(test)
   {
-    testRules(test, ["/foo", "||test.com^", "http://example.com/foo", "^foo^"], [
-      {trigger: {"url-filter": "^https?://.*/foo",
-                 "resource-type": ["image", "style-sheet", "script", "font",
-                                   "media", "raw", "document"],
-                 "unless-top-url": ["^https?://.*/foo"]},
-       action: {type: "block"}},
-      {trigger: {"url-filter": "^https?://([^/]+\\.)?test\\.com([^-_.%a-z0-9].*)?$",
-                 "url-filter-is-case-sensitive": true,
-                 "resource-type": ["image", "style-sheet", "script", "font",
-                                   "media", "raw", "document"],
-                 "unless-top-url": ["^https?://([^/]+\\.)?test\\.com([^-_.%a-z0-9].*)?$"],
-                 "top-url-filter-is-case-sensitive": true},
-       action: {type: "block"}},
-      {trigger: {"url-filter": "http://example\\.com/foo",
-                 "resource-type": ["image", "style-sheet", "script", "font",
-                                   "media", "raw", "document"],
-                 "unless-top-url": ["http://example\\.com/foo"]},
-       action: {type: "block"}},
-      {trigger: {"url-filter": "^https?://(.*[^-_.%A-Za-z0-9])?foo([^-_.%A-Za-z0-9].*)?$",
-                 "resource-type": ["image", "style-sheet", "script", "font",
-                                   "media", "raw", "document"],
-                 "unless-top-url": ["^https?://(.*[^-_.%A-Za-z0-9])?foo([^-_.%A-Za-z0-9].*)?$"]},
-       action: {type: "block"}}
+    testRules(test, [
+      "/foo", "||test.com^", "http://example.com/foo", "^foo^"
+    ], [
+      {
+        trigger: {
+          "url-filter": "^https?://.*/foo",
+          "resource-type": ["image", "style-sheet", "script", "font",
+                            "media", "raw"]
+        },
+        action: {type: "block"}
+      },
+      {
+        trigger: {
+          "url-filter": "^https?://([^/]+\\.)?test\\.com([^-_.%a-z0-9].*)?$",
+          "url-filter-is-case-sensitive": true,
+          "resource-type": ["image", "style-sheet", "script", "font",
+                            "media", "raw", "document"],
+          "unless-top-url": [
+            "^https?://([^/]+\\.)?test\\.com([^-_.%a-z0-9].*)?$"
+          ],
+          "top-url-filter-is-case-sensitive": true
+        },
+        action: {type: "block"}
+      },
+      {
+        trigger: {
+          "url-filter": "http://example\\.com/foo",
+          "resource-type": ["image", "style-sheet", "script", "font",
+                            "media", "raw", "document"],
+          "unless-top-url": ["http://example\\.com/foo"]
+        },
+        action: {type: "block"}
+      },
+      {
+        trigger: {
+          "url-filter":
+            "^https?://(.*[^-_.%A-Za-z0-9])?foo([^-_.%A-Za-z0-9].*)?$",
+          "resource-type": ["image", "style-sheet", "script", "font",
+                            "media", "raw"]
+        },
+        action: {type: "block"}
+      }
     ]);
 
     testRules(test, ["||example.com"], [
       {trigger: {"url-filter": "^https?://([^/]+\\.)?example\\.com",
                  "url-filter-is-case-sensitive": true,
                  "resource-type": ["image", "style-sheet", "script", "font",
                                    "media", "raw", "document"],
                  "unless-top-url": ["^https?://([^/]+\\.)?example\\.com"],
                  "top-url-filter-is-case-sensitive": true},
 
@@ skipping 32 matching lines @@
               ["###example", "test.com###EXAMPLE"],
               ["[id=example]", "[id=EXAMPLE]"],
               rules => rules.map(rule => rule.action.selector));
 
     test.done();
   },
 
   testDomainWhitelisting: function(test)
   {
     testRules(test, ["@@||example.com^$document"], [
-      {trigger: {"url-filter": ".*",
-                 "if-domain": ["*example.com"]},
-       action: {type: "ignore-previous-rules"}}
+      {
+        trigger: {
+          "url-filter": ".*",
+          "if-domain": ["*example.com"]
+        },
+        action: {type: "ignore-previous-rules"}
+      }
     ]);
     testRules(test, ["@@||example.com^$document,image"], [
-      {trigger: {"url-filter": ".*",
-                 "if-domain": ["*example.com"]},
-       action: {type: "ignore-previous-rules"}},
-      {trigger: {"url-filter": "^https?://([^/]+\\.)?example\\.com([^-_.%a-z0-9].*)?$",
-                 "url-filter-is-case-sensitive": true,
-                 "resource-type": ["image"]},
-       action: {type: "ignore-previous-rules"}}
+      {
+        trigger: {
+          "url-filter": ".*",
+          "if-domain": ["*example.com"]
+        },
+        action: {type: "ignore-previous-rules"}
+      },
+      {
+        trigger: {
+          "url-filter": "^https?://([^/]+\\.)?example\\.com([^-_.%a-z0-9].*)?$",
+          "url-filter-is-case-sensitive": true,
+          "resource-type": ["image"]
+        },
+        action: {type: "ignore-previous-rules"}
+      }
     ]);
     testRules(test, ["@@||example.com/path^$font,document"], [
-      {trigger: {"url-filter": "^https?://([^/]+\\.)?example\\.com/path([^-_.%A-Za-z0-9].*)?$",

[kzar, 2017/07/07 12:46:18]

Nit: Mind fixing these long lines where possible?

[Manish Jethani, 2017/07/08 06:33:57]

Acknowledged.

I'll try to fix this.

[Manish Jethani, 2017/07/09 10:50:52]

Done.

-                 "resource-type": ["font"]},
-       action: {type: "ignore-previous-rules"}}
+      {
+        trigger: {
+          "url-filter":
+            "^https?://([^/]+\\.)?example\\.com/path([^-_.%A-Za-z0-9].*)?$",
+          "resource-type": ["font"]
+        },
+        action: {type: "ignore-previous-rules"}
+      }
     ]);
 
     test.done();
   },
 
   testGenericblockExceptions: function(test)
   {
     testRules(test, ["^ad.jpg|", "@@||example.com^$genericblock"],
               [[undefined, ["*example.com"]]],
               rules => rules.map(rule => [rule.trigger["if-domain"],
@@ skipping 31 matching lines @@
   },
 
   testRequestTypeMapping: function(test)
   {
     testRules(
       test,
       ["1", "2$image", "3$stylesheet", "4$script", "5$font", "6$media",
        "7$popup", "8$object", "9$object_subrequest", "10$xmlhttprequest",
        "11$ping", "12$subdocument", "13$other", "14$IMAGE",
        "15$script,PING,Popup", "16$~image"],
-      [["image", "style-sheet", "script", "font", "media", "raw", "document" ],
+      [["image", "style-sheet", "script", "font", "media", "raw"],
        ["image"],
        ["style-sheet"],
        ["script"],
        ["font"],
        ["media"],
        ["popup"],
        ["media"],
        ["raw"],
        ["raw"],
        ["raw"],
-       ["document"],
        ["raw"],
        ["image"],
        ["script", "popup", "raw" ],
-       ["style-sheet", "script", "font", "media", "raw", "document"]],
+       ["style-sheet", "script", "font", "media", "raw"]],
       rules => rules.map(rule => rule.trigger["resource-type"])
     );
 
     test.done();
   },
 
   testUnsupportedfilters: function(test)
   {
     // These types of filters are currently completely unsupported.
     testRules(test, ["foo$sitekey=bar"], []);
@@ skipping 18 matching lines @@
               ["foo.com"],
               rules => rules[0]["trigger"]["if-domain"]);
 
     test.done();
   },
 
   testUnicode: function(test)
   {
     testRules(test, ["$domain=🐈.cat"], ["*xn--zn8h.cat"],
               rules => rules[0]["trigger"]["if-domain"]);
-    testRules(test, ["🐈$domain=🐈.cat"], []);
-    testRules(test, ["###🐈"], []);
+    testRules(test, ["||🐈"], "^https?://([^/]+\\.)?xn--zn8h",
+              rules => rules[0]["trigger"]["url-filter"]);
+    testRules(test, ["🐈$domain=🐈.cat"], "^https?://.*%F0%9F%90%88",
+              rules => rules[0]["trigger"]["url-filter"]);
+    testRules(test, ["🐈%F0%9F%90%88$domain=🐈.cat"],
+              "^https?://.*%F0%9F%90%88%F0%9F%90%88",
+              rules => rules[0]["trigger"]["url-filter"]);
+    testRules(test, ["###🐈"], "[id=🐈]",
+              rules => rules[0]["action"]["selector"]);
 
     test.done();
   }
 };