/
index.md
202 lines (162 loc) · 10 KB
/
index.md
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
---
title: webRequest.onBeforeRedirect
slug: Mozilla/Add-ons/WebExtensions/API/webRequest/onBeforeRedirect
page-type: webextension-api-event
browser-compat: webextensions.api.webRequest.onBeforeRedirect
---
{{AddonSidebar}}
Fired when a server-initiated redirect is about to occur.
Note that you can't pass `"blocking"` for this event, so you can't modify or cancel the request from this event: it's informational only.
## Syntax
```js-nolint
browser.webRequest.onBeforeRedirect.addListener(
listener, // function
filter, // object
extraInfoSpec // optional array of strings
)
browser.webRequest.onBeforeRedirect.removeListener(listener)
browser.webRequest.onBeforeRedirect.hasListener(listener)
```
Events have three functions:
- `addListener(listener, filter, extraInfoSpec)`
- : Adds a listener to this event.
- `removeListener(listener)`
- : Stop listening to this event. The `listener` argument is the listener to remove.
- `hasListener(listener)`
- : Check whether `listener` is registered for this event. Returns `true` if it is listening, `false` otherwise.
## addListener syntax
### Parameters
- `listener`
- : The function called when this event occurs. The function is passed this argument:
- `details`
- : `object`. Details about the request. See the [details](#details_2) section for more information.
- `filter`
- : {{WebExtAPIRef('webRequest.RequestFilter')}}. A filter that restricts the events that is sent to this listener.
- `extraInfoSpec` {{optional_inline}}
- : `array` of `string`. Extra options for the event. You can pass just one value:
- `"responseHeaders"`: include `responseHeaders` in the `details` object passed to the listener
## Additional objects
### details
- `cookieStoreId`
- : `string`. If the request is from a tab open in a contextual identity, the cookie store ID of the contextual identity. See [Work with contextual identities](/en-US/docs/Mozilla/Add-ons/WebExtensions/Work_with_contextual_identities) for more information.
- `documentUrl`
- : `string`. URL of the document in which the resource will be loaded. For example, if the web page at "https\://example.com" contains an image or an iframe, then the `documentUrl` for the image or iframe will be "https\://example.com". For a top-level document, `documentUrl` is undefined.
- `frameId`
- : `integer`. Zero if the request happens in the main frame; a positive value is the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (`type` is `main_frame` or `sub_frame`), `frameId` indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.
- `fromCache`
- : `boolean`. Indicates if this response was fetched from disk cache.
- `incognito`
- : `boolean`. Whether the request is from a private browsing window.
- `ip`
- : `string`. The IP address of the server the request was sent to. It may be a literal IPv6 address.
- `method`
- : `string`. Standard HTTP method: for example, "GET" or "POST".
- `originUrl`
- : `string`. URL of the resource which triggered the request. For example, if "https\://example.com" contains a link, and the user clicks the link, then the `originUrl` for the resulting request is "https\://example.com".
The `originUrl` is often but not always the same as the `documentUrl`. For example, if a page contains an iframe, and the iframe contains a link that loads a new document into the iframe, then the `documentUrl` for the resulting request will be the iframe's parent document, but the `originUrl` will be the URL of the document in the iframe that contained the link.
- `parentFrameId`
- : `integer`. ID of the frame that contains the frame which sent the request. Set to -1 if no parent frame exists.
- `proxyInfo`
- : `object`. This property is present only if the request is being proxied. It contains the following properties:
- `host`
- : `string`. The hostname of the proxy server.
- `port`
- : `integer`. The port number of the proxy server.
- `type`
- : `string`. The type of proxy server. One of:
- "http": HTTP proxy (or SSL CONNECT for HTTPS)
- "https": HTTP proxying over TLS connection to proxy
- "socks": SOCKS v5 proxy
- "socks4": SOCKS v4 proxy
- "direct": no proxy
- "unknown": unknown proxy
- `username`
- : `string`. Username for the proxy service.
- `proxyDNS`
- : `boolean`. True if the proxy will perform domain name resolution based on the hostname supplied, meaning that the client should not do its own DNS lookup.
- `failoverTimeout`
- : `integer`. Failover timeout in seconds. If the proxy connection fails, the proxy will not be used again for this period.
- `redirectUrl`
- : `string`. The new URL.
- `requestId`
- : `string`. The ID of the request. Request IDs are unique within a browser session, so you can use them to relate different events associated with the same request.
- `responseHeaders`
- : {{WebExtAPIRef('webRequest.HttpHeaders')}}. The HTTP response headers that were received along with this redirect.
- `statusCode`
- : `integer`. Standard HTTP status code returned by the server.
- `statusLine`
- : `string`. HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., responses that lack a status line) or an empty string if there are no headers.
- `tabId`
- : `integer`. The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.
- `thirdParty`
- : `boolean`. Indicates whether the request and its content window hierarchy are third party.
- `timeStamp`
- : `number`. The time when this event fired, in [milliseconds since the epoch](https://en.wikipedia.org/wiki/Unix_time).
- `type`
- : {{WebExtAPIRef('webRequest.ResourceType')}}. The type of resource being requested: for example, "image", "script", "stylesheet".
- `url`
- : `string`. Target of the request.
- `urlClassification`
- : `object`. The type of tracking associated with the request, if the request is classified by [Firefox Tracking Protection](https://support.mozilla.org/en-US/kb/enhanced-tracking-protection-firefox-desktop). This is an object with these properties:
- `firstParty`
- : `array` of `strings`. Classification flags for the request's first party.
- `thirdParty`
- : `array` of `strings`. Classification flags for the request or its window hierarchy's third parties.
The classification flags include:
- `fingerprinting` and `fingerprinting_content`: indicates the request is involved in fingerprinting ("an origin found to fingerprint").
- `fingerprinting` indicates the domain is in the fingerprinting and tracking category. Examples of this type of domain include advertisers who want to associate a profile with the visiting user.
- `fingerprinting_content` indicates the domain is in the fingerprinting category but not the tracking category. Examples of this type of domain include payment providers who use fingerprinting techniques to identify the visiting user for anti-fraud purposes.
- `cryptomining` and `cryptomining_content`: similar to the fingerprinting category but for cryptomining resources.
- `tracking`, `tracking_ad`, `tracking_analytics`, `tracking_social`, and `tracking_content`: indicates the request is involved in tracking. `tracking` is any generic tracking request, the `ad`, `analytics`, `social`, and `content` suffixes identify the type of tracker.
- `any_basic_tracking`: a meta flag that combines tracking and fingerprinting flags, excluding `tracking_content` and `fingerprinting_content`.
- `any_strict_tracking`: a meta flag that combines all tracking and fingerprinting flags.
- `any_social_tracking`: a meta flag that combines all social tracking flags.
## Browser compatibility
{{Compat}}
## Examples
```js
let target = "https://developer.mozilla.org/*";
/*
e.g.
"https://developer.mozilla.org/"
"https://developer.mozilla.org/en-US/"
*/
function logResponse(responseDetails) {
console.log(responseDetails.url);
console.log(responseDetails.redirectUrl);
}
browser.webRequest.onBeforeRedirect.addListener(logResponse, {
urls: [target],
});
```
{{WebExtExamples}}
> **Note:** This API is based on Chromium's [`chrome.webRequest`](https://developer.chrome.com/docs/extensions/reference/webRequest/#event-onBeforeRedirect) API. This documentation is derived from [`web_request.json`](https://chromium.googlesource.com/chromium/src/+/master/extensions/common/api/web_request.json) in the Chromium code.
<!--
// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-->