fix(#509): add disable on current site control

_locales/en/messages.json

@@ -123,6 +123,38 @@
         "message": "Open the log",
         "description": "This string is used as title for the log button on the popup page."
     },
+    "popup_html_site_head": {
+        "message": "Site",
+        "description": "This string is used as title for the current site section on the popup page."
+    },
+    "popup_html_site_disable": {
+        "message": "Disable on this site",
+        "description": "This string is used as label for disabling ClearURLs on the current site."
+    },
+    "popup_html_site_disable_title": {
+        "message": "Disable ClearURLs on the current site",
+        "description": "This string is used as title for the current-site disable button."
+    },
+    "popup_html_site_enable": {
+        "message": "Enable on this site",
+        "description": "This string is used as label for enabling ClearURLs on the current site."
+    },
+    "popup_html_site_enable_title": {
+        "message": "Enable ClearURLs again on the current site",
+        "description": "This string is used as title for the current-site enable button."
+    },
+    "popup_html_site_enabled": {
+        "message": "ClearURLs is active on $1",
+        "description": "This string is used to show that ClearURLs is active on the current site."
+    },
+    "popup_html_site_disabled": {
+        "message": "ClearURLs is disabled on $1",
+        "description": "This string is used to show that ClearURLs is disabled on the current site."
+    },
+    "popup_html_site_unavailable": {
+        "message": "This page does not have a normal site hostname.",
+        "description": "This string is used when the current tab does not expose a normal site hostname."
+    },
     "popup_html_report_button": {
         "message": "Report current URL",
         "description": "Note: Currently not used."
@@ -375,4 +407,4 @@
         "message": " ",
         "description": "not needed, only to prevent exceptions"
     }
-}
+}

clearurls.js

@@ -155,7 +155,7 @@
         if (fields.toString() !== "") finalURL += "?" + urlSearchParamsToString(fields);
         if (fragments.toString() !== "") finalURL += "#" + fragments.toString();
 
         url = finalURL.replace(new RegExp("\\?&"), "?").replace(new RegExp("#&"), "#");
     }
 
 
@@ -172,7 +172,7 @@
      *
      * @param {object} obj
      */
     function getKeys(obj) {
         for (const key in obj) {
             prvKeys.push(key);
         }
@@ -245,7 +245,7 @@
     /**
      * Deactivates ClearURLs, if no rules can be downloaded and also no old rules in storage
      */
     function deactivateOnFailure() {
         if (storage.ClearURLsData.length === 0) {
             storage.globalStatus = false;
             storage.dataHash = "";
@@ -274,7 +274,7 @@
             if (result.status === 200 && result.hash) {
                 dataHash = result.hash;
 
                 if (dataHash !== localDataHash.trim()) {
                     fetchFromURL();
                 } else {
                     toObject(storage.ClearURLsData);
@@ -342,7 +342,7 @@
      * @param {boolean} _forceRedirection    Whether redirects should be enforced via a "tabs.update"
      * @param {boolean} _isActive            Is the provider active?
      */
     function Provider(_name, _completeProvider = false, _forceRedirection = false, _isActive = true) {
         let name = _name;
         let urlPattern;
         let enabled_rules = {};
@@ -512,7 +512,7 @@
          * @param {String} method HTTP Method Name
          */
         this.addMethod = function (method) {
             if (methods.indexOf(method) === -1) {
                 methods.push(method);
             }
         }
@@ -525,7 +525,7 @@
          */
         this.matchMethod = function (details) {
             if (!methods.length) return true;
             return methods.indexOf(details['method']) > -1;
         }
 
         /**
@@ -606,6 +606,10 @@
      * @return {Array}                  redirectUrl or none
      */
     function clearUrl(request) {
+        if (isURLDisabled(getRequestContextURL(request))) {
+            return {};
+        }
+
         const URLbeforeReplaceCount = countFields(request.url);
 
         //Add Fields form Request to global url counter
@@ -710,7 +714,7 @@
      * @type {requestDetails}
      * @return {boolean}
      */
     function isDataURL(requestDetails) {
         const s = requestDetails.url;
 
         return s.substring(0, 4) === "data";

core_js/historyListener.js

@@ -37,7 +37,7 @@ function historyListenerStart() {
 * which is associated with the new history entry created by replaceState()
 */
 function historyCleaner(details) {
-    if(storage.globalStatus) {
+    if(storage.globalStatus && !isURLDisabled(details.url)) {
         const urlBefore = details.url;
         const urlAfter = pureCleaning(details.url);
 

core_js/popup.js

@@ -31,6 +31,10 @@
 var loggingStatus;
 var statisticsStatus;
 var currentURL;
+var disabledDomains = [];
+var currentHostname = "";
+var siteSwitchButton = document.getElementById('siteSwitchButton');
+var siteStatus = document.getElementById('siteStatus');
 
 /**
 * Initialize the UI.
@@ -44,6 +48,7 @@
     setSwitchButton("statistics", "statisticsStatus");
     setHashStatus();
     changeStatistics();
+    updateSiteSection();
 }
 
 /**
@@ -53,7 +58,7 @@
 {
     globalPercentage = ((cleanedCounter/totalCounter)*100).toFixed(3);
 
     if(isNaN(Number(globalPercentage))) globalPercentage = 0;
 
     element.textContent = cleanedCounter.toLocaleString();
     elGlobalPercentage.textContent = globalPercentage+"%";
@@ -180,6 +185,78 @@
     changeStatistics();
 }
 
+function updateSiteSection() {
+    if (!siteSwitchButton || !siteStatus) {
+        return;
+    }
+
+    const siteDisabled = disabledDomains.includes(currentHostname);
+
+    if (!currentHostname) {
+        siteStatus.textContent = translate('popup_html_site_unavailable');
+        siteSwitchButton.disabled = true;
+        siteSwitchButton.textContent = translate('popup_html_site_disable');
+        siteSwitchButton.removeAttribute('title');
+        return;
+    }
+
+    siteSwitchButton.disabled = false;
+
+    if (siteDisabled) {
+        siteStatus.textContent = translate('popup_html_site_disabled', currentHostname);
+        siteSwitchButton.textContent = translate('popup_html_site_enable');
+        siteSwitchButton.setAttribute('title', translate('popup_html_site_enable_title'));
+    } else {
+        siteStatus.textContent = translate('popup_html_site_enabled', currentHostname);
+        siteSwitchButton.textContent = translate('popup_html_site_disable');
+        siteSwitchButton.setAttribute('title', translate('popup_html_site_disable_title'));
+    }
+}
+
+function toggleCurrentSite() {
+    if (!currentHostname) {
+        return;
+    }
+
+    const siteDisabled = disabledDomains.includes(currentHostname);
+
+    browser.runtime.sendMessage({
+        function: "setDisabledDomain",
+        params: [currentHostname, !siteDisabled]
+    }).then(() => {
+        if (siteDisabled) {
+            disabledDomains = disabledDomains.filter((domain) => domain !== currentHostname);
+        } else {
+            disabledDomains.push(currentHostname);
+            disabledDomains.sort((left, right) => left.localeCompare(right));
+        }
+
+        updateSiteSection();
+
+        return browser.runtime.sendMessage({
+            function: "saveOnExit",
+            params: []
+        });
+    }).catch(handleError);
+}
+
+function loadCurrentTab() {
+    return browser.tabs.query({
+        active: true,
+        currentWindow: true
+    }).then((tabs) => {
+        const activeTab = tabs[0];
+
+        currentURL = activeTab && activeTab.url ? activeTab.url : "";
+
+        try {
+            currentHostname = currentURL ? new URL(currentURL).hostname.toLowerCase() : "";
+        } catch (error) {
+            currentHostname = "";
+        }
+    });
+}
+
 (function() {
     loadData("cleanedCounter")
         .then(() => loadData("totalCounter"))
@@ -188,14 +265,16 @@
         .then(() => loadData("hashStatus"))
         .then(() => loadData("loggingStatus"))
         .then(() => loadData("statisticsStatus"))
-        .then(() => loadData("getCurrentURL", "currentURL"))
+        .then(() => loadData("disabledDomains"))
+        .then(() => loadCurrentTab())
         .then(() => {
             init();
             document.getElementById('reset_counter_btn').onclick = resetGlobalCounter;
             changeSwitchButton("globalStatus", "globalStatus");
             changeSwitchButton("tabcounter", "badgedStatus");
             changeSwitchButton("logging", "loggingStatus");
             changeSwitchButton("statistics", "statisticsStatus");
+            siteSwitchButton.onclick = toggleCurrentSite;
             document.getElementById('loggingPage').href = browser.runtime.getURL('./html/log.html');
             document.getElementById('settings').href = browser.runtime.getURL('./html/settings.html');
             document.getElementById('cleaning_tools').href = browser.runtime.getURL('./html/cleaningTool.html');
@@ -209,6 +288,7 @@
 function setText()
 {
     injectText('loggingPage','popup_html_log_head');
+    injectText('siteHead', 'popup_html_site_head');
     injectText('reset_counter_btn','popup_html_statistics_reset_button');
     injectText('rules_status_head','popup_html_rules_status_head');
     injectText('statistics_percentage','popup_html_statistics_percentage');
@@ -221,6 +301,7 @@
     injectText('configs_head','popup_html_configs_head');
     injectText('configs_switch_statistics','configs_switch_statistics');
     document.getElementById('donate').title = translate('donate_button');
+    updateSiteSection();
 }
 
 /**
@@ -271,9 +352,9 @@
 *
 * @param {string} string Name of the attribute used for localization
 */
-function translate(string)
+function translate(string, ...placeholders)
 {
-    return browser.i18n.getMessage(string);
+    return browser.i18n.getMessage(string, placeholders);
 }
 
 function handleError(error) {

core_js/storage.js

@@ -116,6 +116,9 @@
         //Set correct icon on startup
         changeIcon();
 
+        // Cache active and open tab URLs for per-site controls and filtering
+        initializeTabURLs();
+
         // Start the context_menu
         contextMenuStart();
 
@@ -163,6 +166,9 @@
         case "types":
             storage[key] = value.split(',');
             break;
+        case "disabledDomains":
+            storage[key] = Array.isArray(value) ? value : value.split(',').filter(Boolean);
+            break;
         case "logLimit":
             storage[key] = Math.max(0, Number(value));
             break;
@@ -224,6 +230,7 @@
     storage.domainBlocking = true;
     storage.pingBlocking = true;
     storage.eTagFiltering = false;
+    storage.disabledDomains = [];
     storage.watchDogErrorCount = 0;
 
     if (getBrowser() === "Firefox") {