/
refererDetection.js
284 lines (246 loc) · 8.65 KB
/
refererDetection.js
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
/**
* The referer detection module attempts to gather referer information from the current page that prebid.js resides in.
* The information that it tries to collect includes:
* The detected top url in the nav bar,
* Whether it was able to reach the top most window (if for example it was embedded in several iframes),
* The number of iframes it was embedded in if applicable (by default max ten iframes),
* A list of the domains of each embedded window if applicable.
* Canonical URL which refers to an HTML link element, with the attribute of rel="canonical", found in the <head> element of your webpage
*/
import { config } from './config.js';
import {logWarn} from './utils.js';
/**
* Prepend a URL with the page's protocol (http/https), if necessary.
*/
export function ensureProtocol(url, win = window) {
if (!url) return url;
if (/\w+:\/\//.exec(url)) {
// url already has protocol
return url;
}
let windowProto = win.location.protocol;
try {
windowProto = win.top.location.protocol;
} catch (e) {}
if (/^\/\//.exec(url)) {
// url uses relative protocol ("//example.com")
return windowProto + url;
} else {
return `${windowProto}//${url}`;
}
}
/**
* Extract the domain portion from a URL.
* @param url
* @param noLeadingWww: if true, remove 'www.' appearing at the beginning of the domain.
* @param noPort: if true, do not include the ':[port]' portion
*/
export function parseDomain(url, {noLeadingWww = false, noPort = false} = {}) {
try {
url = new URL(ensureProtocol(url));
} catch (e) {
return;
}
url = noPort ? url.hostname : url.host;
if (noLeadingWww && url.startsWith('www.')) {
url = url.substring(4);
}
return url;
}
/**
* This function returns canonical URL which refers to an HTML link element, with the attribute of rel="canonical", found in the <head> element of your webpage
*
* @param {Object} doc document
* @returns {string|null}
*/
function getCanonicalUrl(doc) {
try {
const element = doc.querySelector("link[rel='canonical']");
if (element !== null) {
return element.href;
}
} catch (e) {
// Ignore error
}
return null;
}
/**
* @param {Window} win Window
* @returns {Function}
*/
export function detectReferer(win) {
/**
* This function would return a read-only array of hostnames for all the parent frames.
* win.location.ancestorOrigins is only supported in webkit browsers. For non-webkit browsers it will return undefined.
*
* @param {Window} win Window object
* @returns {(undefined|Array)} Ancestor origins or undefined
*/
function getAncestorOrigins(win) {
try {
if (!win.location.ancestorOrigins) {
return;
}
return win.location.ancestorOrigins;
} catch (e) {
// Ignore error
}
}
// TODO: the meaning of "reachedTop" seems to be intentionally ambiguous - best to leave them out of
// the typedef for now. (for example, unit tests enforce that "reachedTop" should be false in some situations where we
// happily provide a location for the top).
/**
* @typedef {Object} refererInfo
* @property {string|null} location the browser's location, or null if not available (due to cross-origin restrictions)
* @property {string|null} canonicalUrl the site's canonical URL as set by the publisher, through setConfig({pageUrl}) or <link rel="canonical" />
* @property {string|null} page the best candidate for the current page URL: `canonicalUrl`, falling back to `location`
* @property {string|null} domain the domain portion of `page`
* @property {string|null} ref the referrer (document.referrer) to the current page, or null if not available (due to cross-origin restrictions)
* @property {string} topmostLocation of the top-most frame for which we could guess the location. Outside of cross-origin scenarios, this is equivalent to `location`.
* @property {number} numIframes number of steps between window.self and window.top
* @property {Array[string|null]} stack our best guess at the location for each frame, in the direction top -> self.
*/
/**
* Walk up the windows to get the origin stack and best available referrer, canonical URL, etc.
*
* @returns {refererInfo}
*/
function refererInfo() {
const stack = [];
const ancestors = getAncestorOrigins(win);
const maxNestedIframes = config.getConfig('maxNestedIframes');
let currentWindow;
let bestLocation;
let bestCanonicalUrl;
let reachedTop = false;
let level = 0;
let valuesFromAmp = false;
let inAmpFrame = false;
let hasTopLocation = false;
do {
const previousWindow = currentWindow;
const wasInAmpFrame = inAmpFrame;
let currentLocation;
let crossOrigin = false;
let foundLocation = null;
inAmpFrame = false;
currentWindow = currentWindow ? currentWindow.parent : win;
try {
currentLocation = currentWindow.location.href || null;
} catch (e) {
crossOrigin = true;
}
if (crossOrigin) {
if (wasInAmpFrame) {
const context = previousWindow.context;
try {
foundLocation = context.sourceUrl;
bestLocation = foundLocation;
hasTopLocation = true;
valuesFromAmp = true;
if (currentWindow === win.top) {
reachedTop = true;
}
if (context.canonicalUrl) {
bestCanonicalUrl = context.canonicalUrl;
}
} catch (e) { /* Do nothing */ }
} else {
logWarn('Trying to access cross domain iframe. Continuing without referrer and location');
try {
// the referrer to an iframe is the parent window
const referrer = previousWindow.document.referrer;
if (referrer) {
foundLocation = referrer;
if (currentWindow === win.top) {
reachedTop = true;
}
}
} catch (e) { /* Do nothing */ }
if (!foundLocation && ancestors && ancestors[level - 1]) {
foundLocation = ancestors[level - 1];
if (currentWindow === win.top) {
hasTopLocation = true;
}
}
if (foundLocation && !valuesFromAmp) {
bestLocation = foundLocation;
}
}
} else {
if (currentLocation) {
foundLocation = currentLocation;
bestLocation = foundLocation;
valuesFromAmp = false;
if (currentWindow === win.top) {
reachedTop = true;
const canonicalUrl = getCanonicalUrl(currentWindow.document);
if (canonicalUrl) {
bestCanonicalUrl = canonicalUrl;
}
}
}
if (currentWindow.context && currentWindow.context.sourceUrl) {
inAmpFrame = true;
}
}
stack.push(foundLocation);
level++;
} while (currentWindow !== win.top && level < maxNestedIframes);
stack.reverse();
let ref;
try {
ref = win.top.document.referrer;
} catch (e) {}
const location = reachedTop || hasTopLocation ? bestLocation : null;
const canonicalUrl = config.getConfig('pageUrl') || bestCanonicalUrl || null;
let page = config.getConfig('pageUrl') || location || ensureProtocol(canonicalUrl, win);
if (location && location.indexOf('?') > -1 && page.indexOf('?') === -1) {
page = `${page}${location.substring(location.indexOf('?'))}`;
}
return {
reachedTop,
isAmp: valuesFromAmp,
numIframes: level - 1,
stack,
topmostLocation: bestLocation || null,
location,
canonicalUrl,
page,
domain: parseDomain(page) || null,
ref: ref || null,
// TODO: the "legacy" refererInfo object is provided here, for now, to accomodate
// adapters that decided to just send it verbatim to their backend.
legacy: {
reachedTop,
isAmp: valuesFromAmp,
numIframes: level - 1,
stack,
referer: bestLocation || null,
canonicalUrl
}
};
}
return refererInfo;
}
// cache result of fn (= referer info) as long as:
// - we are the top window
// - canonical URL tag and window location have not changed
export function cacheWithLocation(fn, win = window) {
if (win.top !== win) return fn;
let canonical, href, value;
return function () {
const newCanonical = getCanonicalUrl(win.document);
const newHref = win.location.href;
if (canonical !== newCanonical || newHref !== href) {
canonical = newCanonical;
href = newHref;
value = fn();
}
return value;
}
}
/**
* @type {function(): refererInfo}
*/
export const getRefererInfo = cacheWithLocation(detectReferer(window));