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
|
/* 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/. */
/* eslint-env mozilla/remote-page */
/**
* Determines whether a given value is a fluent id or plain text and adds it to an element
* @param {Array<[HTMLElement, string]>} items An array of [element, value] where value is
* a fluent id starting with "fluent:" or plain text
*/
function translateElements(items) {
items.forEach(([element, value]) => {
// Skip empty text or elements
if (!element || !value) {
return;
}
const fluentId = value.replace(/^fluent:/, "");
if (fluentId !== value) {
document.l10n.setAttributes(element, fluentId);
} else {
element.textContent = value;
element.removeAttribute("data-l10n-id");
}
});
}
function renderInfo({
infoEnabled,
infoTitle,
infoTitleEnabled,
infoBody,
infoLinkText,
infoLinkUrl,
infoIcon,
} = {}) {
const container = document.querySelector(".info");
if (infoEnabled === false) {
container.hidden = true;
return;
}
container.hidden = false;
const titleEl = document.getElementById("info-title");
const bodyEl = document.getElementById("info-body");
const linkEl = document.getElementById("private-browsing-myths");
let feltPrivacyEnabled = RPMGetBoolPref(
"browser.privatebrowsing.felt-privacy-v1",
false
);
if (infoIcon && !feltPrivacyEnabled) {
container.style.backgroundImage = `url(${infoIcon})`;
}
if (feltPrivacyEnabled) {
// Record exposure event for Felt Privacy experiment
window.FeltPrivacyExposureTelemetry();
infoTitleEnabled = true;
infoTitle = "fluent:about-private-browsing-felt-privacy-v1-info-header";
infoBody = "fluent:about-private-browsing-felt-privacy-v1-info-body";
infoLinkText = "fluent:about-private-browsing-felt-privacy-v1-info-link";
}
titleEl.hidden = !infoTitleEnabled;
translateElements([
[titleEl, infoTitle],
[bodyEl, infoBody],
[linkEl, infoLinkText],
]);
if (infoLinkUrl) {
linkEl.setAttribute("href", infoLinkUrl);
}
}
async function renderPromo({
messageId = null,
promoEnabled = false,
promoType = "VPN",
promoTitle,
promoTitleEnabled,
promoLinkText,
promoLinkType,
promoSectionStyle,
promoHeader,
promoImageLarge,
promoImageSmall,
promoButton = null,
} = {}) {
const shouldShow = await RPMSendQuery("ShouldShowPromo", { type: promoType });
const container = document.querySelector(".promo");
if (!promoEnabled || !shouldShow) {
container.remove();
return false;
}
const titleEl = document.getElementById("private-browsing-promo-text");
const linkEl = document.getElementById("private-browsing-promo-link");
const promoHeaderEl = document.getElementById("promo-header");
const infoContainerEl = document.querySelector(".info");
const promoImageLargeEl = document.querySelector(".promo-image-large img");
const promoImageSmallEl = document.querySelector(".promo-image-small img");
const dismissBtn = document.querySelector("#dismiss-btn");
if (promoLinkType === "link") {
linkEl.classList.remove("primary");
linkEl.classList.add("text-link", "promo-link");
}
if (promoButton?.action) {
linkEl.addEventListener("click", async event => {
event.preventDefault();
// Record promo click telemetry and set metrics as allow for spotlight
// modal opened on promo click if user is enrolled in an experiment
let isExperiment = window.PrivateBrowsingRecordClick("PromoLink");
const promoButtonData = promoButton?.action?.data;
if (
promoButton?.action?.type === "SHOW_SPOTLIGHT" &&
promoButtonData?.content
) {
promoButtonData.content.metrics = isExperiment ? "allow" : "block";
}
await RPMSendQuery("SpecialMessageActionDispatch", promoButton.action);
});
} else {
// If the action doesn't exist, remove the promo completely
container.remove();
return false;
}
const onDismissBtnClick = () => {
window.ASRouterMessage({
type: "BLOCK_MESSAGE_BY_ID",
data: { id: messageId },
});
window.PrivateBrowsingRecordClick("DismissButton");
container.remove();
};
if (dismissBtn && messageId) {
dismissBtn.addEventListener("click", onDismissBtnClick, { once: true });
}
if (promoSectionStyle) {
container.classList.add(promoSectionStyle);
switch (promoSectionStyle) {
case "below-search":
container.remove();
infoContainerEl?.insertAdjacentElement("beforebegin", container);
break;
case "top":
container.remove();
document.body.insertAdjacentElement("afterbegin", container);
}
}
if (promoImageLarge) {
promoImageLargeEl.src = promoImageLarge;
} else {
promoImageLargeEl.parentNode.remove();
}
if (promoImageSmall) {
promoImageSmallEl.src = promoImageSmall;
} else {
promoImageSmallEl.parentNode.remove();
}
if (!promoTitleEnabled) {
titleEl.remove();
}
if (!promoHeader) {
promoHeaderEl.remove();
}
translateElements([
[titleEl, promoTitle],
[linkEl, promoLinkText],
[promoHeaderEl, promoHeader],
]);
// Only make promo section visible after adding content
// and translations to prevent layout shifting in page
container.classList.add("promo-visible");
return true;
}
/**
* For every PB newtab loaded, a second is pre-rendered in the background.
* We need to guard against invalid impressions by checking visibility state.
* If visible, record. Otherwise, listen for visibility change and record later.
*/
function recordOnceVisible(message) {
const recordImpression = () => {
if (document.visibilityState === "visible") {
window.ASRouterMessage({
type: "IMPRESSION",
data: message,
});
// Similar telemetry, but for Nimbus experiments
window.PrivateBrowsingPromoExposureTelemetry();
document.removeEventListener("visibilitychange", recordImpression);
}
};
if (document.visibilityState === "visible") {
window.ASRouterMessage({
type: "IMPRESSION",
data: message,
});
// Similar telemetry, but for Nimbus experiments
window.PrivateBrowsingPromoExposureTelemetry();
} else {
document.addEventListener("visibilitychange", recordImpression);
}
}
// The PB newtab may be pre-rendered. Once the tab is visible, check to make sure the message wasn't blocked after the initial render. If it was, remove the promo.
function handlePromoOnPreload(message) {
async function removePromoIfBlocked() {
if (document.visibilityState === "visible") {
let blocked = await RPMSendQuery("IsPromoBlocked", message);
if (blocked) {
const container = document.querySelector(".promo");
container.remove();
}
}
document.removeEventListener("visibilitychange", removePromoIfBlocked);
}
// Only add the listener to pre-rendered tabs that aren't visible
if (document.visibilityState !== "visible") {
document.addEventListener("visibilitychange", removePromoIfBlocked);
}
}
async function setupMessageConfig(config = null) {
let message = null;
if (!config) {
let hideDefault = window.PrivateBrowsingShouldHideDefault();
try {
let response = await window.ASRouterMessage({
type: "PBNEWTAB_MESSAGE_REQUEST",
data: { hideDefault: !!hideDefault },
});
message = response?.message;
config = message?.content;
config.messageId = message?.id;
} catch (e) {}
}
renderInfo(config);
let hasRendered = await renderPromo(config);
if (hasRendered && message) {
recordOnceVisible(message);
handlePromoOnPreload(message);
}
// For tests
document.documentElement.setAttribute("PrivateBrowsingRenderComplete", true);
}
let SHOW_DEVTOOLS_MESSAGE = "ShowDevToolsMessage";
function showDevToolsMessage(msg) {
msg.data.content.messageId = "DEVTOOLS_MESSAGE";
setupMessageConfig(msg?.data?.content);
RPMRemoveMessageListener(SHOW_DEVTOOLS_MESSAGE, showDevToolsMessage);
}
document.addEventListener("DOMContentLoaded", function () {
// check the url to see if we're rendering a devtools message
if (document.location.toString().includes("debug")) {
RPMAddMessageListener(SHOW_DEVTOOLS_MESSAGE, showDevToolsMessage);
return;
}
if (!RPMIsWindowPrivate()) {
document.documentElement.classList.remove("private");
document.documentElement.classList.add("normal");
document
.getElementById("startPrivateBrowsing")
.addEventListener("click", function () {
RPMSendAsyncMessage("OpenPrivateWindow");
});
return;
}
// The default info content is already in the markup, but we need to use JS to
// set up the learn more link, since it's dynamically generated.
const linkEl = document.getElementById("private-browsing-myths");
linkEl.setAttribute(
"href",
RPMGetFormatURLPref("app.support.baseURL") + "private-browsing-myths"
);
linkEl.addEventListener("click", () => {
window.PrivateBrowsingRecordClick("InfoLink");
});
// We don't do this setup until now, because we don't want to record any impressions until we're
// sure we're actually running a private window, not just about:privatebrowsing in a normal window.
setupMessageConfig();
// Set up the private search banner.
const privateSearchBanner = document.getElementById("search-banner");
RPMSendQuery("ShouldShowSearchBanner", {}).then(engineName => {
if (engineName) {
document.l10n.setAttributes(
document.getElementById("about-private-browsing-search-banner-title"),
"about-private-browsing-search-banner-title",
{ engineName }
);
privateSearchBanner.removeAttribute("hidden");
document.body.classList.add("showBanner");
}
// We set this attribute so that tests know when we are done.
document.documentElement.setAttribute("SearchBannerInitialized", true);
});
function hideSearchBanner() {
privateSearchBanner.hidden = true;
document.body.classList.remove("showBanner");
RPMSendAsyncMessage("SearchBannerDismissed");
}
document
.getElementById("search-banner-close-button")
.addEventListener("click", () => {
hideSearchBanner();
});
let openSearchOptions = document.getElementById(
"about-private-browsing-search-banner-description"
);
let openSearchOptionsEvtHandler = evt => {
if (
evt.target.id == "open-search-options-link" &&
(evt.keyCode == evt.DOM_VK_RETURN || evt.type == "click")
) {
RPMSendAsyncMessage("OpenSearchPreferences");
hideSearchBanner();
}
};
openSearchOptions.addEventListener("click", openSearchOptionsEvtHandler);
openSearchOptions.addEventListener("keypress", openSearchOptionsEvtHandler);
// Setup the search hand-off box.
let btn = document.getElementById("search-handoff-button");
let editable = document.getElementById("fake-editable");
let DISABLE_SEARCH_TOPIC = "DisableSearch";
let SHOW_SEARCH_TOPIC = "ShowSearch";
let SEARCH_HANDOFF_TOPIC = "SearchHandoff";
function showSearch() {
btn.classList.remove("focused");
btn.classList.remove("disabled");
RPMRemoveMessageListener(SHOW_SEARCH_TOPIC, showSearch);
}
function disableSearch() {
btn.classList.add("disabled");
}
function handoffSearch(text) {
RPMSendAsyncMessage(SEARCH_HANDOFF_TOPIC, { text });
RPMAddMessageListener(SHOW_SEARCH_TOPIC, showSearch);
if (text) {
disableSearch();
} else {
btn.classList.add("focused");
RPMAddMessageListener(DISABLE_SEARCH_TOPIC, disableSearch);
}
}
btn.addEventListener("focus", function () {
handoffSearch();
});
btn.addEventListener("click", function () {
handoffSearch();
});
// Hand-off any text that gets dropped or pasted
editable.addEventListener("drop", function (ev) {
ev.preventDefault();
let text = ev.dataTransfer.getData("text");
if (text) {
handoffSearch(text);
}
});
editable.addEventListener("paste", function (ev) {
ev.preventDefault();
handoffSearch(ev.clipboardData.getData("Text"));
});
// Load contentSearchUI so it sets the search engine icon and name for us.
new window.ContentSearchHandoffUIController();
});
|