Source code
Revision control
Copy as Markdown
Other Tools
/* 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
export class PopupAndRedirectBlocker {
/**
* The <xul:browser> element that this blocker is associated with.
* Used as the main entry point to access the browsing context tree.
*/
#mBrowser;
/**
* WeakMap mapping WindowGlobal objects to the number of blocked popups
* in that browsing context. This allows tracking blocked popups per
* frame/window without leaking memory, since keys are GC'd when
* WindowGlobals go away.
* @type {WeakMap<WindowGlobalParent, number>}
*/
#mBlockedPopupCounts;
/**
* WeakMap mapping the browser's top-level WindowGlobal to the
* BrowsingContext that attempted a blocked redirect. This allows
* identifying the source frame/window of a blocked redirect.
* @type {WeakMap<WindowGlobalParent, BrowsingContext>}
*/
#mBlockedRedirects;
constructor(aBrowser) {
this.#mBrowser = aBrowser;
this.#mBlockedPopupCounts = new WeakMap();
this.#mBlockedRedirects = new WeakMap();
}
getBlockedPopupCount() {
let blockedPopupCount = 0;
// We need to walk the entire BrowsingContext tree starting from the
// top-level browser. Popups can be triggered not only from the top
// document but also from iframes and nested browsing contexts. By
// traversing the tree, we accumulate the blocked popup counts from
// every relevant WindowGlobal.
const contextsToVisit = [this.#mBrowser.browsingContext];
while (contextsToVisit.length) {
const currentBC = contextsToVisit.pop();
const currentWG = currentBC.currentWindowGlobal;
if (!currentWG) {
continue;
}
const currentCount = this.#mBlockedPopupCounts.get(currentWG) || 0;
blockedPopupCount += currentCount;
contextsToVisit.push(...currentBC.children);
}
return blockedPopupCount;
}
isRedirectBlocked() {
const browserBC = this.#mBrowser.browsingContext;
const browserWG = browserBC.currentWindowGlobal;
if (!browserWG) {
return null;
}
return this.#mBlockedRedirects.has(browserWG);
}
async getBlockedPopups() {
const contextsToVisit = [this.#mBrowser.browsingContext];
const result = [];
while (contextsToVisit.length) {
const currentBC = contextsToVisit.pop();
const currentWG = currentBC.currentWindowGlobal;
if (!currentWG) {
continue;
}
const currentCount = this.#mBlockedPopupCounts.get(currentWG) || 0;
if (currentCount) {
const actor = currentWG.getActor("PopupAndRedirectBlocking");
const popups = await actor.sendQuery("GetBlockedPopups");
for (const popup of popups) {
result.push({
browsingContext: currentBC,
innerWindowId: currentWG.innerWindowId,
popupWindowURISpec: popup.popupWindowURISpec,
});
}
}
contextsToVisit.push(...currentBC.children);
}
return result;
}
async getBlockedRedirect() {
const browserBC = this.#mBrowser.browsingContext;
const browserWG = browserBC.currentWindowGlobal;
if (!browserWG) {
return null;
}
const sourceBC = this.#mBlockedRedirects.get(browserWG);
if (!sourceBC) {
return null;
}
const sourceWG = sourceBC.currentWindowGlobal;
if (!sourceWG) {
return null;
}
const actor = sourceWG.getActor("PopupAndRedirectBlocking");
const redirect = await actor.sendQuery("GetBlockedRedirect");
return {
browsingContext: sourceBC,
innerWindowId: sourceWG.innerWindowId,
redirectURISpec: redirect.redirectURISpec,
};
}
unblockPopup(aBrowsingContext, aInnerWindowId, aPopupIndex) {
const sourceWG = aBrowsingContext.currentWindowGlobal;
if (sourceWG?.innerWindowId != aInnerWindowId) {
return;
}
const actor = sourceWG.getActor("PopupAndRedirectBlocking");
actor.sendAsyncMessage("UnblockPopup", { index: aPopupIndex });
}
unblockRedirect(aBrowsingContext, aInnerWindowId, aRedirectURISpec) {
const sourceWG = aBrowsingContext.currentWindowGlobal;
if (!sourceWG || sourceWG.innerWindowId != aInnerWindowId) {
return;
}
const uri = Services.io.newURI(aRedirectURISpec);
aBrowsingContext.top.loadURI(uri, {
triggeringPrincipal: sourceWG.documentPrincipal,
});
}
async unblockAllPopups() {
const popups = await this.getBlockedPopups();
for (let idx = 0; idx < popups.length; ++idx) {
const popup = popups[idx];
this.unblockPopup(popup.browsingContext, popup.innerWindowId, idx);
}
}
async unblockFirstRedirect() {
const redirect = await this.getBlockedRedirect();
if (!redirect) {
return;
}
this.unblockRedirect(
redirect.browsingContext,
redirect.innerWindowId,
redirect.redirectURISpec
);
}
sendObserverUpdateBlockedPopupsEvent() {
const event = new Event("DOMUpdateBlockedPopups", {
bubbles: true,
cancelable: true,
});
this.#mBrowser.dispatchEvent(event);
}
sendObserverUpdateBlockedRedirectEvent() {
const event = new Event("DOMUpdateBlockedRedirect", {
bubbles: true,
cancelable: true,
});
this.#mBrowser.dispatchEvent(event);
}
updateObserverAboutBlockedPopups(aBrowsingContext, aBlockedPopupCount) {
const sourceWG = aBrowsingContext.currentWindowGlobal;
if (!sourceWG) {
return;
}
this.#mBlockedPopupCounts.set(sourceWG, aBlockedPopupCount);
this.sendObserverUpdateBlockedPopupsEvent();
}
updateObserverAboutBlockedRedirect(aBrowsingContext) {
const sourceWG = aBrowsingContext.currentWindowGlobal;
if (!sourceWG) {
return;
}
const browserBC = this.#mBrowser.browsingContext;
const browserWG = browserBC.currentWindowGlobal;
if (!browserWG) {
return;
}
if (this.#mBlockedRedirects.has(browserWG)) {
return;
}
this.#mBlockedRedirects.set(browserWG, aBrowsingContext);
this.sendObserverUpdateBlockedRedirectEvent();
}
destroy(aBrowsingContext) {
const sourceWG = aBrowsingContext.currentWindowGlobal;
this.#mBlockedPopupCounts.delete(sourceWG);
this.sendObserverUpdateBlockedPopupsEvent();
if (aBrowsingContext == aBrowsingContext.top) {
const browserBC = this.#mBrowser.browsingContext;
const browserWG = browserBC.currentWindowGlobal;
this.#mBlockedRedirects.delete(browserWG);
this.sendObserverUpdateBlockedRedirectEvent();
}
}
}
export class PopupAndRedirectBlockingParent extends JSWindowActorParent {
didDestroy() {
const browser = this.browsingContext.top.embedderElement;
if (!browser) {
return;
}
browser.popupAndRedirectBlocker.destroy(this.browsingContext);
}
receiveMessage(aMessage) {
switch (aMessage.name) {
case "UpdateBlockedPopups":
this.updateBrowserAboutPopupCount(aMessage);
break;
case "UpdateBlockedRedirect":
this.updateBrowserAboutBlockedRedirect();
break;
}
}
updateBrowserAboutPopupCount(aMessage) {
const browser = this.browsingContext.top.embedderElement;
if (!browser) {
return;
}
browser.popupAndRedirectBlocker.updateObserverAboutBlockedPopups(
this.browsingContext,
aMessage.data.count
);
}
updateBrowserAboutBlockedRedirect() {
const browser = this.browsingContext.top.embedderElement;
if (!browser) {
return;
}
browser.popupAndRedirectBlocker.updateObserverAboutBlockedRedirect(
this.browsingContext
);
}
}