-
Notifications
You must be signed in to change notification settings - Fork 36
/
snippet.js
699 lines (624 loc) · 23.9 KB
/
snippet.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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
'use strict';
var SNIPPET_METRICS_SAMPLE_RATE = {{ settings.METRICS_SAMPLE_RATE }};
var SNIPPET_METRICS_URL = '{{ metrics_url }}';
var ABOUTHOME_SHOWN_SNIPPET = null;
var USER_COUNTRY = null;
var GEO_CACHE_DURATION = 1000 * 60 * 60 * 24 * 30; // 30 days
// Start MozUITour
// Copy from https://hg.mozilla.org/mozilla-central/file/tip/browser/components/uitour/UITour-lib.js
if (typeof Mozilla == 'undefined') {
var Mozilla = {};
}
if (typeof Mozilla.UITour == 'undefined') {
Mozilla.UITour = {};
}
function _sendEvent(action, data) {
var event = new CustomEvent('mozUITour', {
bubbles: true,
detail: {
action: action,
data: data || {}
}
});
document.dispatchEvent(event);
}
function _generateCallbackID() {
return Math.random().toString(36).replace(/[^a-z]+/g, '');
}
function _waitForCallback(callback) {
var id = _generateCallbackID();
function listener(event) {
if (typeof event.detail != 'object')
return;
if (event.detail.callbackID != id)
return;
document.removeEventListener('mozUITourResponse', listener);
callback(event.detail.data);
}
document.addEventListener('mozUITourResponse', listener);
return id;
}
Mozilla.UITour.showHighlight = function(target, effect) {
_sendEvent('showHighlight', {
target: target,
effect: effect
});
};
Mozilla.UITour.hideHighlight = function() {
_sendEvent('hideHighlight');
};
Mozilla.UITour.showMenu = function(name, callback) {
var showCallbackID;
if (callback)
showCallbackID = _waitForCallback(callback);
_sendEvent('showMenu', {
name: name,
showCallbackID: showCallbackID
});
};
Mozilla.UITour.hideMenu = function(name) {
_sendEvent('hideMenu', {
name: name
});
};
Mozilla.UITour.getConfiguration = function(configName, callback) {
_sendEvent('getConfiguration', {
callbackID: _waitForCallback(callback),
configuration: configName,
});
};
Mozilla.UITour.setConfiguration = function(configName, configValue) {
_sendEvent('setConfiguration', {
configuration: configName,
value: configValue
});
};
// End MozUITour
(function(showDefaultSnippets) {
'use strict';
// showDefaultSnippets polyfill, available in about:home v4
if (typeof showDefaultSnippets !== 'function') {
showDefaultSnippets = function() {
localStorage.snippets = '';
showSnippets();
};
}
// gSnippetsMap polyfill, available in Firefox 22 and above.
var gSnippetsMap = null;
if (supportsLocalStorage()) {
// localStorage is available, so we wrap it with gSnippetsMap.
gSnippetsMap = {
set: function(key, value) {
localStorage[key] = value;
},
get: function(key) {
return localStorage[key];
}
};
window.gSnippetsMap = gSnippetsMap;
} else {
// localStorage isn't available, use gSnippetsMap (backed by IndexedDB).
gSnippetsMap = window.gSnippetsMap;
}
var show_snippet = null;
if (ABOUTHOME_SNIPPETS.length > 0) {
show_snippet = chooseSnippet(ABOUTHOME_SNIPPETS);
}
if (show_snippet) {
ABOUTHOME_SHOWN_SNIPPET = show_snippet;
// Inject the snippet onto the page.
var snippetContainer = document.createElement('div');
snippetContainer.innerHTML = show_snippet.code;
document.getElementById('snippets').appendChild(snippetContainer);
activateScriptTags(snippetContainer);
try {
activateSnippetsButtonClick(show_snippet);
} catch (err) {
// Do nothing, most likely a newer version of Firefox w/o
// activateSnippetsButtonClick
}
// By the time show_snippet event reaches #snippets the snippet
// will have finished initializing and altering the DOM. It's the
// time to modifyLinks() and addSnippetBlockLinks().
var snippets = document.getElementById('snippets');
snippets.addEventListener('show_snippet', function(event) {
var topSection = document.getElementById('topSection');
// Add sample rate and snippet ID to currently displayed links.
var parameters = ('sample_rate=' + SNIPPET_METRICS_SAMPLE_RATE + '&snippet_name=' +
ABOUTHOME_SHOWN_SNIPPET.id);
modifyLinks(topSection.querySelectorAll('a'), parameters);
addSnippetBlockLinks(topSection.querySelectorAll('.block-snippet-button'));
keypressIsMine(snippetContainer.querySelector('.snippet'));
sendImpression();
});
// Trigger show_snippet event
var evt = document.createEvent('Event');
evt.initEvent('show_snippet', true, true);
snippetContainer.querySelector('.snippet').dispatchEvent(evt);
} else {
showDefaultSnippets();
}
// Update FxAccount Status
updateFxAccountStatus();
// Update Default Browser Status
updateDefaultBrowserStatus();
// Update Selected Search Engine
updateSelectedSearchEngine();
// Fetch user country if we don't have it.
if (!haveUserCountry()) {
downloadUserCountry();
}
{% if preview %}
function chooseSnippet(snippets) {
return snippets[0];
}
{% else %}
// Choose which snippet to display to the user based on various factors,
// such as which country they are in.
function chooseSnippet(snippets) {
USER_COUNTRY = getUserCountry();
if (USER_COUNTRY) {
snippets = snippets.filter(
function(snippet) {
var countries = snippet.countries;
if (countries.length && countries.indexOf(USER_COUNTRY) === -1) {
return false;
}
return true;
}
);
}
else {
// If we don't have the user's country, remove all geolocated snippets.
// Bug 1140476
snippets = snippets.filter(
function(snippet) {
return snippet.countries.length === 0;
}
)
}
// Filter Snippets based on the has_fxaccount attribute.
var has_fxaccount = gSnippetsMap.get('fxaccount');
if (has_fxaccount === true) {
snippets = snippets.filter(
function(snippet) {
return (snippet.client_options.has_fxaccount == 'yes' ||
snippet.client_options.has_fxaccount == 'any');
}
)
} else if (has_fxaccount === false) {
snippets = snippets.filter(
function(snippet) {
return (snippet.client_options.has_fxaccount == 'no' ||
snippet.client_options.has_fxaccount == 'any');
}
);
} else {
snippets = snippets.filter(
function(snippet) {
return (snippet.client_options.has_fxaccount == 'any');
}
);
}
// Filter Snippets based on TestPilot addon existence.
var has_testpilot = Boolean(window.navigator.testpilotAddon);
if (has_testpilot === true) {
snippets = snippets.filter(
function(snippet) {
return (snippet.client_options.has_testpilot == 'yes' ||
snippet.client_options.has_testpilot == 'any');
}
)
} else {
snippets = snippets.filter(
function(snippet) {
return (snippet.client_options.has_testpilot == 'no' ||
snippet.client_options.has_testpilot == 'any');
}
);
}
// Filter Snippets based on whether Firefox is the default browser or now.
var is_default_browser = gSnippetsMap.get('is_default_browser');
if (is_default_browser === true || is_default_browser === undefined) {
snippets = snippets.filter(
function(snippet) {
return (snippet.client_options.is_default_browser == 'yes' ||
snippet.client_options.is_default_browser == 'any');
}
)
} else {
snippets = snippets.filter(
function(snippet) {
return (snippet.client_options.is_default_browser == 'no' ||
snippet.client_options.is_default_browser == 'any');
}
);
}
// Exclude snippets from search providers.
var searchProvider = gSnippetsMap.get('selectedSearchEngine');
if (searchProvider) {
snippets = snippets.filter(
function(snippet) {
var excludeFromSearchEngines = snippet.exclude_from_search_engines;
if (excludeFromSearchEngines.length && excludeFromSearchEngines.indexOf(searchProvider) !== -1) {
return false;
}
return true;
}
);
}
// Filter Snippets based on TestPilot addon existence.
var has_testpilot = Boolean(window.navigator.testpilotAddon);
if (has_testpilot === true) {
snippets = snippets.filter(
function(snippet) {
return (snippet.client_options.has_testpilot == 'yes' ||
snippet.client_options.has_testpilot == 'any');
}
)
} else {
snippets = snippets.filter(
function(snippet) {
return (snippet.client_options.has_testpilot == 'no' ||
snippet.client_options.has_testpilot == 'any');
}
);
}
// Filter based on Firefox version
var userAgent = window.navigator.userAgent.match(/Firefox\/([0-9]+)\./);
var firefox_version = userAgent ? parseInt(userAgent[1]) : 0;
if (firefox_version !== 0) {
snippets = snippets.filter(
function(snippet) {
var lower_bound = snippet.client_options.version_lower_bound;
var upper_bound = snippet.client_options.version_upper_bound;
if (lower_bound && lower_bound !== 'any') {
if (lower_bound === 'current_release') {
if (firefox_version !== CURRENT_RELEASE)
return false;
}
else {
if (firefox_version < lower_bound) {
return false;
}
}
}
if (upper_bound && upper_bound !== 'any') {
if (upper_bound === 'older_than_current_release') {
if (firefox_version >= CURRENT_RELEASE)
return false;
}
else {
if (firefox_version > upper_bound)
return false;
}
}
return true;
});
}
// Filter based on screen resolution
var verticalScreenResolution = screen.width;
snippets = snippets.filter(
function(snippet) {
let snippetResolutions = snippet.client_options.screen_resolutions.split(';');
let display = false;
snippetResolutions.forEach(function(resolution) {
let minmax = resolution.split('-');
if (parseInt(minmax[0]) <= verticalScreenResolution
&& verticalScreenResolution < parseInt(minmax[1])) {
display = true;
return;
}
});
return display;
}
);
// Exclude snippets in block list.
var blockList = getBlockList();
snippets = snippets.filter(
function (snippet) {
var blockID = snippet.campaign || snippet.id;
if (blockList.indexOf(blockID) === -1) {
return true;
}
return false;
}
);
// Choose a random snippet from the snippets list.
if (snippets && snippets.length) {
var sum = 0;
var number_of_snippets = snippets.length;
for (var k = 0; k < number_of_snippets; k++) {
sum += snippets[k].weight;
snippets[k].weight = sum;
}
var random_number = Math.random() * sum;
for (var k = 0; k < number_of_snippets; k++) {
if (random_number < snippets[k].weight) {
return snippets[k];
}
}
} else {
return null;
}
}
{% endif %}
function updateFxAccountStatus() {
var callback = function(result) {
gSnippetsMap.set('fxaccount', result.setup);
}
var event = new CustomEvent(
'mozUITour', {
bubbles: true,
detail: {
action:'getConfiguration',
data: {
configuration: 'sync',
callbackID: _waitForCallback(callback)
}
}
}
);
document.dispatchEvent(event);
}
function updateDefaultBrowserStatus() {
var callback = function(result) {
gSnippetsMap.set('is_default_browser', result.defaultBrowser);
}
var event = new CustomEvent(
'mozUITour', {
bubbles: true,
detail: {
action:'getConfiguration',
data: {
configuration: 'appinfo',
callbackID: _waitForCallback(callback)
}
}
}
);
document.dispatchEvent(event);
}
function updateSelectedSearchEngine() {
var callback = function(result) {
gSnippetsMap.set('selectedSearchEngine', result.searchEngineIdentifier);
}
var event = new CustomEvent(
'mozUITour', {
bubbles: true,
detail: {
action:'getConfiguration',
data: {
configuration: 'selectedSearchEngine',
callbackID: _waitForCallback(callback)
}
}
}
);
document.dispatchEvent(event);
}
// Check whether we have the user's country stored and if it is still valid.
function haveUserCountry() {
// Check if there's an existing country code to use.
if (gSnippetsMap.get('geoCountry')) {
// Make sure we have a valid lastUpdated date.
var lastUpdated = Date.parse(gSnippetsMap.get('geoLastUpdated'));
if (lastUpdated) {
// Make sure that it is past the lastUpdated date.
var now = new Date();
if (now < lastUpdated + GEO_CACHE_DURATION) {
return true;
}
}
}
return false;
}
function getUserCountry() {
if (haveUserCountry()) {
return gSnippetsMap.get('geoCountry').toLowerCase();
} else {
return null;
}
}
// Download the user's country using the geolocation service.
// Please do not directly use this code or Snippets key.
// Contact MLS team for your own credentials.
// https://location.services.mozilla.com/contact
function downloadUserCountry() {
var GEO_URL = "{{ settings.GEO_URL }}";
var request = new XMLHttpRequest();
request.timeout = 60000;
request.onreadystatechange = function() {
if (request.readyState == 4 && request.status == 200) {
var country_data = JSON.parse(request.responseText);
try {
gSnippetsMap.set('geoCountry', country_data.country_code);
gSnippetsMap.set('geoLastUpdated', new Date());
} catch (e) {
// Most likely failed to load Data file. Continue on without us,
// we'll try again next time.
}
}
};
request.open('GET', GEO_URL, true);
request.send();
}
// Notifies stats server that the given snippet ID
// was shown. No personally-identifiable information
// is sent.
function sendImpression() {
sendMetric('impression');
}
// Modifies the given links to include the specified GET parameters.
function modifyLinks(links, parameters) {
for (var k = 0, len = links.length; k < len; k++) {
var link = links[k];
var delimeter = (link.href.indexOf('?') !== -1 ? '&' : '?');
// Pull the fragment off of the link
var fragment_position = link.href.indexOf('#');
if (fragment_position === -1) {
fragment_position = link.href.length;
}
var href = link.href.substring(0, fragment_position);
var fragment = link.href.substring(fragment_position);
link.href = href + delimeter + parameters + fragment;
}
}
// Add links to buttons that block snippets.
function addSnippetBlockLinks(elements) {
var blockSnippet = function (event) {
event.preventDefault();
event.stopPropagation();
addToBlockList();
// Waiting for 500ms before reloading the page after user blocks a snippet,
// will allow the IndexedDB more time to complete its transaction. While
// this is an imperfect non-deterministic solution it will fix the issue
// for most of the users. Ideally we would create our own
// connection to the iDB and ensure that the write completes
// before we reload the page. Bug 1236090.
function reloadWindow() {
window.location.reload();
}
sendMetric('snippet-blocked', function() { setTimeout(reloadWindow, 500); });
};
for (var k = 0; k < elements.length; k++) {
var button = elements[k];
button.addEventListener('click', blockSnippet);
}
}
// Bug 1238092. Got fixed in Fx45. We can drop this when Fx44
// usage drops significantly.
function keypressIsMine(snippet) {
snippet.addEventListener('keypress', function(event) {
var tagName = event.target.tagName.toLowerCase();
if (tagName === 'input' || tagName === 'select') {
event.stopPropagation();
}
});
}
// Check for localStorage support. Copied from Modernizr.
function supportsLocalStorage() {
var s = 'snippets-test';
try {
localStorage.setItem(s, s);
localStorage.removeItem(s);
return true;
} catch(e) {
return false;
}
}
// Scripts injected by innerHTML are inactive, so we have to relocate them
// through DOM manipulation to activate their contents.
// (Adapted from http://mxr.mozilla.org/mozilla-central/source/browser/base/content/abouthome/aboutHome.js)
function activateScriptTags(element) {
Array.forEach(element.getElementsByTagName('script'), function(elt) {
var relocatedScript = document.createElement('script');
relocatedScript.type = 'text/javascript;version=1.8';
relocatedScript.text = elt.text;
elt.parentNode.replaceChild(relocatedScript, elt);
});
}
// Listen for clicks on links, send metrics and handle
// about:account custom links.
var topSection = document.getElementById('topSection');
topSection.addEventListener('click', function(event) {
var target = event.target;
while (target.tagName && target.tagName.toLowerCase() !== 'a') {
// Do not track clicks outside topSection.
if (target.id === 'topSection') {
return;
}
target = target.parentNode;
}
// Count snippet clicks.
if (target.dataset.eventCounted !== 'true') {
target.dataset.eventCounted = 'true';
// Fetch custom metric or default to 'click'
var metric = target.dataset.metric || 'click';
// If user is not opening a new tab, preventDefault action.
if (target.href && (event.button === 0 && !(event.metaKey || event.ctrlKey))) {
event.preventDefault();
var callback = function() {
target.click();
};
}
sendMetric(metric, callback, target.href);
}
// Handle about:accounts clicks.
if (target.href && target.href.indexOf('about:accounts') === 0) {
var snippet_id = ABOUTHOME_SHOWN_SNIPPET.id;
var metric = snippet_id + '-about-accounts-click';
var fire_event = function() {
var event = new CustomEvent(
'mozUITour',
{ bubbles: true, detail: { action:'showFirefoxAccounts', data: {}}}
);
document.dispatchEvent(event);
};
sendMetric(metric, fire_event, target.href);
}
}, false);
})(window.showDefaultSnippets);
// Send impressions and other interactions to the service
// If no parameter is entered, quit function
function sendMetric(metric, callback, href) {
{# In preview mode, disable sampling, log metric, but do not send to service #}
{% if preview %}
console.log("[preview mode] Sending metric: " + metric);
if (callback) {
setTimeout(callback);
}
return;
{% else %}
if (!SNIPPET_METRICS_URL || (Math.random() > SNIPPET_METRICS_SAMPLE_RATE) || (!metric)) {
if (callback) {
// setTimeout is here because when metrics succeeds the callback is async.
// When we don't use metrics, we should be consistent and
// fire the callback async too.
setTimeout(callback);
}
return;
}
var locale = '{{ locale }}';
var userCountry = USER_COUNTRY || '';
var campaign = ABOUTHOME_SHOWN_SNIPPET.campaign;
var snippet_id = ABOUTHOME_SHOWN_SNIPPET.id;
var snippet_full_name = ABOUTHOME_SHOWN_SNIPPET.name;
var url = (SNIPPET_METRICS_URL + '?snippet_name=' + snippet_id +
'&snippet_full_name=' + snippet_full_name +
'&locale=' + locale + '&country=' + userCountry +
'&metric=' + metric + '&campaign=' + campaign);
if (href) {
url = url + "&href=" + escape(href);
}
var request = new XMLHttpRequest();
request.open('GET', url);
if (callback) {
request.addEventListener('loadend', callback, false);
}
request.send();
return request;
{% endif %}
}
function popFromBlockList(snippetID) {
var blockList = getBlockList();
var item = blockList.pop(snippetID);
gSnippetsMap.set('blockList', blockList);
return item;
}
function addToBlockList(snippetID) {
var blockList = getBlockList();
if (snippetID === undefined) {
snippetID = ABOUTHOME_SHOWN_SNIPPET.campaign || ABOUTHOME_SHOWN_SNIPPET.id;
}
if (blockList.indexOf(snippetID) === -1) {
blockList = [snippetID].concat(blockList);
gSnippetsMap.set('blockList', blockList);
}
}
function getBlockList() {
if (gSnippetsMap.get('blockList') === undefined) {
gSnippetsMap.set('blockList', []);
}
return gSnippetsMap.get('blockList');
}