[mv3] Bring popup blocking out of experimental status

Related issue:
uBlockOrigin/uBOL-home#632

Popup blocking will be enabled by default, and is active when default
filtering mode is optimal or complete.

Users can wholly disable popup blocking in the dashboard.

Author: gorhill

platform/mv3/extension/_locales/en/messages.json

@@ -255,6 +255,14 @@
     "message": "Navigation to potentially undesirable sites will be blocked, and you will be offered the option to proceed.",
     "description": "Short description for a checkbox in the options page"
   },
+  "enablePopupBlockLabel": {
+    "message": "Enable pop-up blocking",
+    "description": "Label for a checkbox in the options page"
+  },
+  "enablePopupBlockLegend": {
+    "message": "When active, matching filters will automatically close unwanted browser tabs created by websites.",
+    "description": "Short description for a checkbox in the options page"
+  },
   "developerModeLabel": {
     "message": "Developer mode",
     "description": "Label for a checkbox in the options page"

platform/mv3/extension/dashboard.html

@@ -97,6 +97,7 @@ <h3 data-i18n="behaviorSectionLabel"></h3>
         </p>
         <p><label id="showBlockedCount" data-i18n="showBlockedCountLabel"><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span>_</label>
         <p data-platform-exclude="safari"><label id="strictBlockMode" data-i18n="enableStrictBlockLabel"><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span>_</label><legend data-i18n="enableStrictBlockLegend"></legend>
+        <p><label id="popupBlockMode" data-i18n="enablePopupBlockLabel"><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span>_</label><legend data-i18n="enablePopupBlockLegend"></legend>
         <p id="developerMode"><label data-i18n="developerModeLabel"><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span>_</label><legend data-i18n="developerModeLegend"></legend>
     </div>
     <div>

platform/mv3/extension/js/background.js

@@ -209,6 +209,17 @@ onPermissionsChanged.pending = [];
 
 /******************************************************************************/
 
+async function setPopupBlockMode(state) {
+    state = state === true;
+    if ( state === rulesetConfig.popupBlockMode ) { return; }
+    rulesetConfig.popupBlockMode = state;
+    await saveRulesetConfig();
+    await registerInjectables();
+    broadcastMessage({ popupBlockMode: rulesetConfig.popupBlockMode });
+}
+
+/******************************************************************************/
+
 function setDeveloperMode(state) {
     rulesetConfig.developerMode = state === true;
     toggleDeveloperMode(rulesetConfig.developerMode);
@@ -335,12 +346,17 @@ function onMessage(request, sender, callback) {
                 developerMode: defaultConfig.developerMode,
                 showBlockedCount: defaultConfig.showBlockedCount,
                 strictBlockMode: defaultConfig.strictBlockMode,
+                popupBlockMode: defaultConfig.popupBlockMode,
                 rulesets,
                 filteringModes: Object.assign(defaultFilteringModes),
             });
         });
         return true;
 
+    case 'getCurrentConfig':
+        callback(rulesetConfig);
+        break;
+
     case 'getOptionsPageData':
         Promise.all([
             hasBroadHostPermissions(),
@@ -369,6 +385,7 @@ function onMessage(request, sender, callback) {
                 showBlockedCount: rulesetConfig.showBlockedCount,
                 canShowBlockedCount,
                 strictBlockMode: rulesetConfig.strictBlockMode,
+                popupBlockMode: rulesetConfig.popupBlockMode,
                 firstRun: process.firstRun,
                 isSideloaded,
                 developerMode: rulesetConfig.developerMode,
@@ -410,10 +427,6 @@ function onMessage(request, sender, callback) {
         });
         return true;
 
-    case 'getShowBlockedCount':
-        callback(rulesetConfig.showBlockedCount);
-        break;
-
     case 'setShowBlockedCount':
         rulesetConfig.showBlockedCount = request.state && true || false;
         if ( canShowBlockedCount ) {
@@ -434,6 +447,12 @@ function onMessage(request, sender, callback) {
         });
         return true;
 
+    case 'setPopupBlockMode':
+        setPopupBlockMode(request.state).then(( ) => {
+            callback();
+        });
+        return true;
+
     case 'setDeveloperMode':
         setDeveloperMode(request.state).then(( ) => {
             callback();

platform/mv3/extension/js/config.js

@@ -33,6 +33,7 @@ export const rulesetConfig = {
     autoReload: true,
     showBlockedCount: true,
     strictBlockMode: webextFlavor !== 'safari',
+    popupBlockMode: true,
     developerMode: false,
     hasBroadHostPermissions: true,
 };
@@ -44,9 +45,11 @@ export const process = {
     wakeupRun: false,
 };
 
+let pendingOpPromise = Promise.resolve();
+
 /******************************************************************************/
 
-export async function loadRulesetConfig() {
+async function _loadRulesetConfig() {
     const sessionData = await sessionRead('rulesetConfig');
     if ( sessionData ) {
         Object.assign(rulesetConfig, sessionData);
@@ -64,7 +67,19 @@ export async function loadRulesetConfig() {
     process.firstRun = true;
 }
 
-export async function saveRulesetConfig() {
+async function _saveRulesetConfig() {
     sessionWrite('rulesetConfig', rulesetConfig);
     return localWrite('rulesetConfig', rulesetConfig);
 }
+
+/******************************************************************************/
+
+export function loadRulesetConfig() {
+    pendingOpPromise = pendingOpPromise.then(_loadRulesetConfig);
+    return pendingOpPromise;
+}
+
+export function saveRulesetConfig() {
+    pendingOpPromise = pendingOpPromise.then(_saveRulesetConfig);
+    return pendingOpPromise;
+}

platform/mv3/extension/js/prevent-popup.js

@@ -20,12 +20,14 @@
 */
 
 import { matchesFromHostnames } from './utils.js';
+import { rulesetConfig } from './config.js';
 
 /******************************************************************************/
 
 // https://github.com/uBlockOrigin/uBOL-home/issues/632
 
 export async function registerPreventPopup(context) {
+    if ( rulesetConfig.popupBlockMode !== true ) { return; }
     const js = [];
     for ( const { id, popups } of context.rulesetsDetails ) {
         if ( popups === undefined ) { continue; }
@@ -40,11 +42,11 @@ export async function registerPreventPopup(context) {
     const { none, basic, optimal, complete } = context.filteringModeDetails;
     let matches = [];
     let excludeMatches = [];
-    if ( complete.has('all-urls') ) {
+    if ( complete.has('all-urls') || optimal.has('all-urls') ) {
         matches = [ '*' ];
-        excludeMatches = [ ...none, ...basic, ...optimal ];
+        excludeMatches = [ ...none, ...basic ];
     } else {
-        matches = [ ...complete ];
+        matches = [ ...complete, ...optimal ];
     }
     if ( matches.length === 0 ) { return; }
 

platform/mv3/extension/js/settings.js

@@ -67,6 +67,11 @@ function renderWidgets() {
         dom.attr(input, 'disabled', canStrictBlock ? null : '');
     }
 
+    {
+        const input = qs$('#popupBlockMode input[type="checkbox"]');
+        input.checked = cachedRulesetData.popupBlockMode;
+    }
+
     {
         const state = Boolean(cachedRulesetData.developerMode) &&
             cachedRulesetData.disabledFeatures?.includes('develop') !== true;
@@ -213,6 +218,13 @@ dom.on('#strictBlockMode input[type="checkbox"]', 'change', ev => {
     });
 });
 
+dom.on('#popupBlockMode input[type="checkbox"]', 'change', ev => {
+    sendMessage({
+        what: 'setPopupBlockMode',
+        state: ev.target.checked,
+    });
+});
+
 dom.on('#developerMode input[type="checkbox"]', 'change', ev => {
     const state = ev.target.checked;
     sendMessage({ what: 'setDeveloperMode', state });
@@ -279,6 +291,13 @@ listen.onmessage = ev => {
         }
     }
 
+    if ( message.popupBlockMode !== undefined ) {
+        if ( message.popupBlockMode !== local.popupBlockMode ) {
+            local.popupBlockMode = message.popupBlockMode;
+            render = true;
+        }
+    }
+
     if ( message.developerMode !== undefined ) {
         if ( message.developerMode !== local.developerMode ) {
             local.developerMode = message.developerMode;

platform/mv3/extension/js/strictblock.js

@@ -109,12 +109,11 @@ function fragmentFromTemplate(template, placeholder, text, details) {
 // Enforce popup filters
 
 (async ( ) => {
-    const filteringMode = await sendMessage({
-        what: 'getFilteringMode',
-        hostname: toURL.hostname,
+    const currentConfig = await sendMessage({
+        what: 'getCurrentConfig',
     });
     // Enforce popup filtering in complete mode only
-    if ( filteringMode < 3 ) { return; }
+    if ( currentConfig.popupBlockingMode !== true ) { return; }
     const rulesetDetails = await rulesetDetailsPromise;
     const toImport = [];
     for ( const details of rulesetDetails ) {

platform/mv3/extension/js/troubleshooting.js

@@ -54,23 +54,23 @@ export async function getTroubleshootingInfo(details) {
     const [
         platformInfo,
         defaultConfig,
+        currentConfig,
         enabledRulesets,
         rulesetDetails,
         defaultMode,
         userRules,
         consoleOutput,
-        showBlockedCount,
         registeredScripts,
         hasOmnipotence,
     ] = await Promise.all([
         runtime.getPlatformInfo(),
         sendMessage({ what: 'getDefaultConfig' }),
+        sendMessage({ what: 'getCurrentConfig' }),
         sendMessage({ what: 'getEnabledRulesets' }),
         sendMessage({ what: 'getRulesetDetails' }).then(a => new Map(a.map(a => [ a.id, a ]))),
         sendMessage({ what: 'getDefaultFilteringMode' }),
         sendMessage({ what: 'getEffectiveUserRules' }),
         sendMessage({ what: 'getConsoleOutput' }),
-        sendMessage({ what: 'getShowBlockedCount' }),
         sendMessage({ what: 'getRegisteredContentScripts' }),
         sendMessage({ what: 'hasBroadHostPermissions' }),
     ]);
@@ -113,9 +113,15 @@ export async function getTroubleshootingInfo(details) {
         filtering,
         permission: hasOmnipotence ? 'all' : 'ask',
     };
+    if ( currentConfig.strictBlockMode !== defaultConfig.strictBlockMode ) {
+        config.strictblock = currentConfig.strictBlockMode;
+    }
+    if ( currentConfig.popupBlockMode !== defaultConfig.popupBlockMode ) {
+        config.popupblock = currentConfig.popupBlockMode;
+    }
     if ( details?.tabId ) {
         let badge = '?';
-        if ( showBlockedCount ) {
+        if ( currentConfig.showBlockedCount ) {
             badge = await browser.action.getBadgeText({ tabId: details.tabId });
         }
         if ( badge ) {