Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: lib/filterClasses.js

Issue 29737558: Issue 6538, 6781 - Implement support for snippet filters (Closed) Base URL: https://hg.adblockplus.org/adblockpluscore/
Patch Set: Rename ScriptFilter to ContentFilter Created June 23, 2018, 6:22 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | lib/filterListener.js » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 /* 1 /*
2 * This file is part of Adblock Plus <https://adblockplus.org/>, 2 * This file is part of Adblock Plus <https://adblockplus.org/>,
3 * Copyright (C) 2006-present eyeo GmbH 3 * Copyright (C) 2006-present eyeo GmbH
4 * 4 *
5 * Adblock Plus is free software: you can redistribute it and/or modify 5 * Adblock Plus is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 3 as 6 * it under the terms of the GNU General Public License version 3 as
7 * published by the Free Software Foundation. 7 * published by the Free Software Foundation.
8 * 8 *
9 * Adblock Plus is distributed in the hope that it will be useful, 9 * Adblock Plus is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
(...skipping 66 matching lines...) Expand 10 before | Expand all | Expand 10 after
77 } 77 }
78 }; 78 };
79 79
80 /** 80 /**
81 * Cache for known filters, maps string representation to filter objects. 81 * Cache for known filters, maps string representation to filter objects.
82 * @type {Map.<string,Filter>} 82 * @type {Map.<string,Filter>}
83 */ 83 */
84 Filter.knownFilters = new Map(); 84 Filter.knownFilters = new Map();
85 85
86 /** 86 /**
87 * Regular expression that element hiding filters should match 87 * Regular expression that content filters should match
88 * @type {RegExp} 88 * @type {RegExp}
89 */ 89 */
90 Filter.elemhideRegExp = /^([^/*|@"!]*?)#([@?])?#(.+)$/; 90 Filter.contentRegExp = /^([^/*|@"!]*?)#([@?$])?#(.+)$/;
91 /** 91 /**
92 * Regular expression that RegExp filters specified as RegExps should match 92 * Regular expression that RegExp filters specified as RegExps should match
93 * @type {RegExp} 93 * @type {RegExp}
94 */ 94 */
95 Filter.regexpRegExp = /^(@@)?\/.*\/(?:\$~?[\w-]+(?:=[^,\s]+)?(?:,~?[\w-]+(?:=[^, \s]+)?)*)?$/; 95 Filter.regexpRegExp = /^(@@)?\/.*\/(?:\$~?[\w-]+(?:=[^,\s]+)?(?:,~?[\w-]+(?:=[^, \s]+)?)*)?$/;
96 /** 96 /**
97 * Regular expression that options on a RegExp filter should match 97 * Regular expression that options on a RegExp filter should match
98 * @type {RegExp} 98 * @type {RegExp}
99 */ 99 */
100 Filter.optionsRegExp = /\$(~?[\w-]+(?:=[^,]+)?(?:,~?[\w-]+(?:=[^,]+)?)*)$/; 100 Filter.optionsRegExp = /\$(~?[\w-]+(?:=[^,]+)?(?:,~?[\w-]+(?:=[^,]+)?)*)$/;
101 /** 101 /**
102 * Regular expression that matches an invalid Content Security Policy 102 * Regular expression that matches an invalid Content Security Policy
103 * @type {RegExp} 103 * @type {RegExp}
104 */ 104 */
105 Filter.invalidCSPRegExp = /(;|^) ?(base-uri|referrer|report-to|report-uri|upgrad e-insecure-requests)\b/i; 105 Filter.invalidCSPRegExp = /(;|^) ?(base-uri|referrer|report-to|report-uri|upgrad e-insecure-requests)\b/i;
106 106
107 /** 107 /**
108 * Creates a filter of correct type from its text representation - does the 108 * Creates a filter of correct type from its text representation - does the
109 * basic parsing and calls the right constructor then. 109 * basic parsing and calls the right constructor then.
110 * 110 *
111 * @param {string} text as in Filter() 111 * @param {string} text as in Filter()
112 * @return {Filter} 112 * @return {Filter}
113 */ 113 */
114 Filter.fromText = function(text) 114 Filter.fromText = function(text)
115 { 115 {
116 let filter = Filter.knownFilters.get(text); 116 let filter = Filter.knownFilters.get(text);
117 if (filter) 117 if (filter)
118 return filter; 118 return filter;
119 119
120 let match = (text.includes("#") ? Filter.elemhideRegExp.exec(text) : null); 120 let match = text.includes("#") ? Filter.contentRegExp.exec(text) : null;
121 if (match) 121 if (match)
122 { 122 {
123 let propsMatch; 123 let propsMatch;
124 if (!match[2] && 124 if (!match[2] &&
125 (propsMatch = /\[-abp-properties=(["'])([^"']+)\1\]/.exec(match[3]))) 125 (propsMatch = /\[-abp-properties=(["'])([^"']+)\1\]/.exec(match[3])))
126 { 126 {
127 // This is legacy CSS properties syntax, convert to current syntax 127 // This is legacy CSS properties syntax, convert to current syntax
128 let prefix = match[3].substr(0, propsMatch.index); 128 let prefix = match[3].substr(0, propsMatch.index);
129 let expression = propsMatch[2]; 129 let expression = propsMatch[2];
130 let suffix = match[3].substr(propsMatch.index + propsMatch[0].length); 130 let suffix = match[3].substr(propsMatch.index + propsMatch[0].length);
131 return Filter.fromText(`${match[1]}#?#` + 131 return Filter.fromText(`${match[1]}#?#` +
132 `${prefix}:-abp-properties(${expression})${suffix}`); 132 `${prefix}:-abp-properties(${expression})${suffix}`);
133 } 133 }
134 134
135 filter = ElemHideBase.fromText( 135 if (match[2] == "$")
136 text, match[1], match[2], match[3] 136 filter = new SnippetFilter(text, match[1], match[3]);
137 ); 137 else
138 filter = ElemHideBase.fromText(text, match[1], match[2], match[3]);
138 } 139 }
139 else if (text[0] == "!") 140 else if (text[0] == "!")
140 filter = new CommentFilter(text); 141 filter = new CommentFilter(text);
141 else 142 else
142 filter = RegExpFilter.fromText(text); 143 filter = RegExpFilter.fromText(text);
143 144
144 Filter.knownFilters.set(filter.text, filter); 145 Filter.knownFilters.set(filter.text, filter);
145 return filter; 146 return filter;
146 }; 147 };
147 148
(...skipping 29 matching lines...) Expand all
177 if (!text) 178 if (!text)
178 return text; 179 return text;
179 180
180 // Remove line breaks, tabs etc 181 // Remove line breaks, tabs etc
181 text = text.replace(/[^\S ]+/g, ""); 182 text = text.replace(/[^\S ]+/g, "");
182 183
183 // Don't remove spaces inside comments 184 // Don't remove spaces inside comments
184 if (/^ *!/.test(text)) 185 if (/^ *!/.test(text))
185 return text.trim(); 186 return text.trim();
186 187
187 // Special treatment for element hiding filters, right side is allowed to 188 // Special treatment for content filters, right side is allowed to contain
188 // contain spaces 189 // spaces
189 if (Filter.elemhideRegExp.test(text)) 190 if (Filter.contentRegExp.test(text))
190 { 191 {
191 let [, domains, separator, selector] = /^(.*?)(#[@?]?#?)(.*)$/.exec(text); 192 let [, domains, separator, script] = /^(.*?)(#[@?$]?#?)(.*)$/.exec(text);
192 return domains.replace(/ +/g, "") + separator + selector.trim(); 193 return domains.replace(/ +/g, "") + separator + script.trim();
193 } 194 }
194 195
195 // For most regexp filters we strip all spaces, but $csp filter options 196 // For most regexp filters we strip all spaces, but $csp filter options
196 // are allowed to contain single (non trailing) spaces. 197 // are allowed to contain single (non trailing) spaces.
197 let strippedText = text.replace(/ +/g, ""); 198 let strippedText = text.replace(/ +/g, "");
198 if (!strippedText.includes("$") || !/\bcsp=/i.test(strippedText)) 199 if (!strippedText.includes("$") || !/\bcsp=/i.test(strippedText))
199 return strippedText; 200 return strippedText;
200 201
201 let optionsMatch = Filter.optionsRegExp.exec(strippedText); 202 let optionsMatch = Filter.optionsRegExp.exec(strippedText);
202 if (!optionsMatch) 203 if (!optionsMatch)
(...skipping 777 matching lines...) Expand 10 before | Expand all | Expand 10 after
980 RegExpFilter.call(this, text, regexpSource, contentType, matchCase, domains, 981 RegExpFilter.call(this, text, regexpSource, contentType, matchCase, domains,
981 thirdParty, sitekeys); 982 thirdParty, sitekeys);
982 } 983 }
983 exports.WhitelistFilter = WhitelistFilter; 984 exports.WhitelistFilter = WhitelistFilter;
984 985
985 WhitelistFilter.prototype = extend(RegExpFilter, { 986 WhitelistFilter.prototype = extend(RegExpFilter, {
986 type: "whitelist" 987 type: "whitelist"
987 }); 988 });
988 989
989 /** 990 /**
990 * Base class for element hiding filters 991 * Base class for content filters
991 * @param {string} text see {@link Filter Filter()} 992 * @param {string} text see {@link Filter Filter()}
992 * @param {string} [domains] Host names or domains the filter should be 993 * @param {string} [domains] Host names or domains the filter should be
993 * restricted to 994 * restricted to
994 * @param {string} selector CSS selector for the HTML elements that should be 995 * @param {string} script Script that should be executed
995 * hidden
996 * @constructor 996 * @constructor
997 * @augments ActiveFilter 997 * @augments ActiveFilter
998 */ 998 */
999 function ElemHideBase(text, domains, selector) 999 function ContentFilter(text, domains, script)
1000 { 1000 {
1001 ActiveFilter.call(this, text, domains || null); 1001 ActiveFilter.call(this, text, domains || null);
1002 1002
1003 // Braces are being escaped to prevent CSS rule injection. 1003 this.script = script;
1004 this.selector = selector.replace("{", "\\7B ").replace("}", "\\7D ");
1005 } 1004 }
1006 exports.ElemHideBase = ElemHideBase; 1005 exports.ContentFilter = ContentFilter;
1007 1006
1008 ElemHideBase.prototype = extend(ActiveFilter, { 1007 ContentFilter.prototype = extend(ActiveFilter, {
1009 /** 1008 /**
1010 * @see ActiveFilter.domainSeparator 1009 * @see ActiveFilter.domainSeparator
1011 */ 1010 */
1012 domainSeparator: ",", 1011 domainSeparator: ",",
1013 1012
1014 /** 1013 /**
1014 * Script that should be executed
1015 * @type {string}
1016 */
1017 script: null
1018 });
1019
1020 /*
1021 * Base class for element hiding filters
1022 * @param {string} text see {@link Filter Filter()}
1023 * @param {string} [domains] see {@link ContentFilter ContentFilter()}
1024 * @param {string} selector CSS selector for the HTML elements that should be
1025 * hidden
1026 * @constructor
1027 * @augments ContentFilter
1028 */
1029 function ElemHideBase(text, domains, selector)
1030 {
1031 ContentFilter.call(this, text, domains, selector);
1032
1033 // Braces are being escaped to prevent CSS rule injection.
1034 this.selector = this.script.replace("{", "\\7B ").replace("}", "\\7D ");
1035 }
1036 exports.ElemHideBase = ElemHideBase;
1037
1038 ElemHideBase.prototype = extend(ContentFilter, {
1039 /**
1015 * CSS selector for the HTML elements that should be hidden 1040 * CSS selector for the HTML elements that should be hidden
1016 * @type {string} 1041 * @type {string}
1017 */ 1042 */
1018 selector: null 1043 selector: null
1019 }); 1044 });
1020 1045
1021 /** 1046 /**
1022 * Creates an element hiding filter from a pre-parsed text representation 1047 * Creates an element hiding filter from a pre-parsed text representation
1023 * 1048 *
1024 * @param {string} text same as in Filter() 1049 * @param {string} text same as in Filter()
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after
1100 */ 1125 */
1101 function ElemHideEmulationFilter(text, domains, selector) 1126 function ElemHideEmulationFilter(text, domains, selector)
1102 { 1127 {
1103 ElemHideBase.call(this, text, domains, selector); 1128 ElemHideBase.call(this, text, domains, selector);
1104 } 1129 }
1105 exports.ElemHideEmulationFilter = ElemHideEmulationFilter; 1130 exports.ElemHideEmulationFilter = ElemHideEmulationFilter;
1106 1131
1107 ElemHideEmulationFilter.prototype = extend(ElemHideBase, { 1132 ElemHideEmulationFilter.prototype = extend(ElemHideBase, {
1108 type: "elemhideemulation" 1133 type: "elemhideemulation"
1109 }); 1134 });
1135
1136 /**
1137 * Class for snippet filters
1138 * @param {string} text see Filter()
1139 * @param {string} [domains] see ContentFilter()
1140 * @param {string} script Script that should be executed
1141 * @constructor
1142 * @augments ContentFilter
1143 */
1144 function SnippetFilter(text, domains, script)
1145 {
1146 ContentFilter.call(this, text, domains, script);
1147 }
1148 exports.SnippetFilter = SnippetFilter;
1149
1150 SnippetFilter.prototype = extend(ContentFilter, {
1151 type: "snippet"
1152 });
OLDNEW
« no previous file with comments | « no previous file | lib/filterListener.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld