1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
// Match WebNavigation URL Filters.
export class MatchURLFilters {
constructor(filters) {
if (!Array.isArray(filters)) {
throw new TypeError("filters should be an array");
}
if (!filters.length) {
throw new Error("filters array should not be empty");
}
this.filters = filters;
}
matches(url) {
let uri = Services.io.newURI(url);
// Set uriURL to an empty object (needed because some schemes, e.g. about doesn't support nsIURL).
let uriURL = {};
if (uri instanceof Ci.nsIURL) {
uriURL = uri;
}
// Set host to a empty string by default (needed so that schemes without an host,
// e.g. about, can pass an empty string for host based event filtering as expected).
let host = "";
try {
host = uri.host;
} catch (e) {
// 'uri.host' throws an exception with some uri schemes (e.g. about).
}
let port;
try {
port = uri.port;
} catch (e) {
// 'uri.port' throws an exception with some uri schemes (e.g. about),
// in which case it will be |undefined|.
}
let data = {
// NOTE: This properties are named after the name of their related
// filters (e.g. `pathContains/pathEquals/...` will be tested against the
// `data.path` property, and the same is done for the `host`, `query` and `url`
// components as well).
path: uriURL.filePath,
query: uriURL.query,
host,
port,
url,
};
// If any of the filters matches, matches returns true.
return this.filters.some(filter =>
this.matchURLFilter({ filter, data, uri, uriURL })
);
}
matchURLFilter({ filter, data, uri, uriURL }) {
// Test for scheme based filtering.
if (filter.schemes) {
// Return false if none of the schemes matches.
if (!filter.schemes.some(scheme => uri.schemeIs(scheme))) {
return false;
}
}
// Test for exact port matching or included in a range of ports.
if (filter.ports) {
let port = data.port;
if (port === -1) {
// NOTE: currently defaultPort for "resource" and "chrome" schemes defaults to -1,
// for "about", "data" and "javascript" schemes defaults to undefined.
if (["resource", "chrome"].includes(uri.scheme)) {
port = undefined;
} else {
port = Services.io.getDefaultPort(uri.scheme);
}
}
// Return false if none of the ports (or port ranges) is verified
const portMatch = filter.ports.some(filterPort => {
if (Array.isArray(filterPort)) {
let [lower, upper] = filterPort;
return port >= lower && port <= upper;
}
return port === filterPort;
});
if (!portMatch) {
return false;
}
}
// Filters on host, url, path, query:
// hostContains, hostEquals, hostSuffix, hostPrefix,
// urlContains, urlEquals, ...
for (let urlComponent of ["host", "path", "query", "url"]) {
if (!this.testMatchOnURLComponent({ urlComponent, data, filter })) {
return false;
}
}
// urlMatches is a regular expression string and it is tested for matches
// on the "url without the ref".
if (filter.urlMatches) {
let urlWithoutRef = uri.specIgnoringRef;
if (!urlWithoutRef.match(filter.urlMatches)) {
return false;
}
}
// originAndPathMatches is a regular expression string and it is tested for matches
// on the "url without the query and the ref".
if (filter.originAndPathMatches) {
let urlWithoutQueryAndRef = uri.resolve(uriURL.filePath);
// The above 'uri.resolve(...)' will be null for some URI schemes
// (e.g. about).
// TODO: handle schemes which will not be able to resolve the filePath
// (e.g. for "about:blank", 'urlWithoutQueryAndRef' should be "about:blank" instead
// of null)
if (
!urlWithoutQueryAndRef ||
!urlWithoutQueryAndRef.match(filter.originAndPathMatches)
) {
return false;
}
}
return true;
}
testMatchOnURLComponent({ urlComponent: key, data, filter }) {
// Test for equals.
// NOTE: an empty string should not be considered a filter to skip.
if (filter[`${key}Equals`] != null) {
if (data[key] !== filter[`${key}Equals`]) {
return false;
}
}
// Test for contains.
if (filter[`${key}Contains`]) {
let value = (key == "host" ? "." : "") + data[key];
if (!data[key] || !value.includes(filter[`${key}Contains`])) {
return false;
}
}
// Test for prefix.
if (filter[`${key}Prefix`]) {
if (!data[key] || !data[key].startsWith(filter[`${key}Prefix`])) {
return false;
}
}
// Test for suffix.
if (filter[`${key}Suffix`]) {
if (!data[key] || !data[key].endsWith(filter[`${key}Suffix`])) {
return false;
}
}
return true;
}
serialize() {
return this.filters;
}
}
|
