☰

The Ultimate Popup Blocker

Configurable popup blocker that blocks ALL (even user-initiated) popup windows by default. But you can easily open the blocked popup or whitelist a domain, directly from the page.

  1. // ==UserScript==
  2. // @name           The Ultimate Popup Blocker
  3. // @description    Configurable popup blocker that blocks ALL (even user-initiated) popup windows by default. But you can easily open the blocked popup or whitelist a domain, directly from the page.
  4. // @namespace      jakub-g.github.com
  5. // @author         http://jakub-g.github.com/
  6. // @version        0.1-20130112
  7. // @userscriptsOrg http://userscripts.org/scripts/show/...
  8. // @grant          GM_getValue
  9. // @grant          GM_setValue
  10. // @include        *
  11. // @exclude        http*://*.youtube.com/*
  12. // @exclude        http*://mail.google.com/*
  13. // @exclude        http*://*.blogspot.tld/*
  14. // @exclude        http*://poczta.wp.pl/*
  15. // ==/UserScript==
  16.  
  17. // Why another popup blocker?
  18.  
  19. // Built-in Firefox popup blocker blocks only the popup that were created automatically via
  20. // script on page load etc. When you click on a button on the page, it won't block it.
  21. // However, malicious websites can create JS code that will launch the popups whenever you click
  22. // on any blank space on the page for instance.
  23.  
  24. // In JavaScript, functions are first-order citizens. It means you can store a function in a variable
  25. // and pass it freely. You can also modify the native functions provided by the browser, like 'window.open'.
  26. // Here, we override 'window.open' with our own implementation which doesn't really open the window.
  27. // However the user may want to open a popup - cool, we stored original native window.open function
  28. // in a variable and we will call it!
  29.  
  30. // Of course, we'd like to white list some domains. Greasemonkey offers an option to specify @exclude entries
  31. // in the metadata block of the script. However this means you'll have to edit this text file each time you
  32. // want to whitelist a domain. However, GM also offers a way to set config entries in Firefox storage
  33. // (about:config entries) and we'll make use of it to dynamically add entries to the white list 
  34. // right from the page.
  35.  
  36. // The essence of the blocking code is substituting window.open with the function returning FakeWindow,
  37. // which can be a one-liner.
  38. // The majority of the code here is the handling of whitelisting logic and informational logging.
  39.  
  40. // Tests: http://www.popuptest.com/
  41.  
  42. (function() {
  43.     // ============================== CONFIG =================================
  44.     var bDisplayMessageOnPopupBlocked = true;
  45.     var bDisplayOpenPopupLink = true;
  46.     var bDisplayWhiteListThisDomainLink = true;
  47.     var LOG_ID = "ultimate_popup_blocker"; // HTML ID in the page
  48.     
  49.     // ============================ FUNCTIONS ================================
  50.     var global = unsafeWindow; // reference to page's "window" through GreaseMonkey
  51.     
  52.     /*
  53.      * Helper to create a button with inner text @text executing onclick @clickCallback,
  54.      * appended as a child of @logDiv
  55.      */
  56.     var putButton = function (logDiv, text, clickCallback, inlineStyle) {
  57.         var button = document.createElement("button");
  58.         button.innerHTML = text;
  59.         button.style.cssText = "text-decoration:none; color:black; cursor:pointer;\
  60.             margin: 0 5px; font: 8pt microsoft sans serif; padding: 1px 3px;\
  61.             background-color:rgb(212,208,200); border-width:2px; border-style:outset;\
  62.             border-color:#eee #555 #555 #eee; color:black;" + inlineStyle;
  63.         logDiv.appendChild(button);
  64.         button.addEventListener("click", clickCallback);
  65.     };
  66.     
  67.     /*
  68.      * Helper to create a button (child of @logDiv) which onclick whitelists @domain
  69.      * in internal Firefox storage.
  70.      */
  71.     var putWhitelistButton = function (logDiv, domain) {
  72.         putButton(logDiv, domain, function(){
  73.             GM_setValue("whitelisted_" + domain, true);
  74.         });
  75.     };
  76.     
  77.     /* 
  78.      * Helper to create a text node with @text and append to @logDiv
  79.      */
  80.     var putText = function (logDiv, text) {
  81.         var node = document.createTextNode(text);
  82.         logDiv.appendChild(node);
  83.     };
  84.     
  85.     /*
  86.      * Return logger div, or create it ad-hoc.
  87.      */
  88.     var getLogDiv = function () {
  89.         var logDiv = document.getElementById(LOG_ID);
  90.         if(!logDiv){
  91.             logDiv = document.createElement("div");
  92.             logDiv.setAttribute("id", LOG_ID);
  93.             logDiv.style.cssText="position:fixed; top:0; left:0; width:100%;\
  94.                 padding:5px 5px 5px 29px; font: 8pt microsoft sans serif;\
  95.                 background-color: linen; color:black; border:1px solid black;\
  96.                 ";
  97.             document.body.appendChild(logDiv);
  98.         }
  99.         return logDiv;
  100.     };
  101.     
  102.     /*
  103.      * Get array of domains for which it would make sense to whitelist them.
  104.      * Sample valid outputs:
  105.      *  // localhost       -> ['localhost']
  106.      *  // youtube.com     -> ['youtube.com']
  107.      *  // www.youtube.com -> ['youtube.com', 'www.youtube.com']
  108.      *  // a.b.c.d         -> ['c.d', 'b.c.d', 'a.b.c.d']
  109.      */
  110.     var getDomainsArray = function(documentDomain){
  111.         // e.g. domain = www.google.com, topDomain = google.com
  112.         var d1 = documentDomain;
  113.         var domainsArr = [];
  114.         
  115.         var lastDot1 = d1.lastIndexOf('.');
  116.         if(lastDot1 != -1){
  117.             var lastDot2 = d1.lastIndexOf('.', lastDot1-1);
  118.             if(lastDot2 != -1 && lastDot2 != lastDot1) {
  119.                 var d2 = d1.substr(lastDot2 + 1);
  120.                 domainsArr.push(d2);
  121.   
  122.                 var lastDot3 = d1.lastIndexOf('.', lastDot2-1);
  123.                 if(lastDot3 != -1 && lastDot3 != lastDot2) {
  124.                     var d3 = d1.substr(lastDot3 + 1);
  125.                     domainsArr.push(d3);
  126.                 }
  127.             }
  128.         }
  129.         
  130.         domainsArr.push(d1);
  131.         return domainsArr;
  132.     };
  133.     
  134.     /*
  135.      * Checks if domain we're currently browsing has been whitelisted by the user
  136.      * to display popups.
  137.      */
  138.     var isCurrentDomainWhiteListed = function() {
  139.         var domains = getDomainsArray(document.domain);
  140.         var whitelisted = domains.some(function(d){
  141.             return GM_getValue("whitelisted_" + d);
  142.         }); // if any 'd' in 'domains' was whitelisted, we return true
  143.         return whitelisted;
  144.     };
  145.     
  146.     /*
  147.      * "window.open()" returns Window which might be then used by the originator page
  148.      * to focus the popup (annoying splash popup) or blur it to retain focus in the original page
  149.      * (pay-by-impressions popup, I don't need it to actually see it).
  150.      * We need to return the fake window to not encounter JS runtime error when the popup originator
  151.      * page wants to call focus() or blur().
  152.      */
  153.     var FakeWindow = {
  154.         blur: function() {return false;},
  155.         focus: function() {return false;}
  156.     };
  157.     
  158.     /*
  159.      * Storing a reference to real "window.open" method in case we wanted
  160.      * to actually open a blocked popup
  161.      */
  162.     var realWindowOpen = global.open;
  163.  
  164.     /*
  165.      * This function will be called each time a script wants to open a new window,
  166.      * if the blocker is activated.
  167.      * We handle the blocking & messaging logic here.
  168.      */
  169.     var fakeWindowOpen = function(url){
  170.         if(!bDisplayMessageOnPopupBlocked){
  171.             return FakeWindow;
  172.         }
  173.         var logDiv = getLogDiv();
  174.         logMessage(logDiv, url);
  175.         
  176.         if(bDisplayOpenPopupLink){
  177.             displayOpenPopupLink(logDiv, arguments);
  178.         }
  179.         if(bDisplayWhiteListThisDomainLink) {
  180.             displayWhiteListThisDomainLink(logDiv);
  181.         }
  182.         displayCloseButton(logDiv);
  183.         return FakeWindow; // see the doc of FakeWindow
  184.     };
  185.     
  186.     var logMessage = function (logDiv, url) {
  187.         global.upb_counter = (global.upb_counter || 0);
  188.         url = (url[0] == '/') ? document.domain + url : url;
  189.         var msg = ["UPB has blocked <b>", ++global.upb_counter, "</b> popup windows, last: <u>", url, "</u>"].join("");
  190.         logDiv.innerHTML = msg;
  191.         console.log(msg);
  192.         logDiv.style.display = "block";
  193.     };
  194.     
  195.     var displayOpenPopupLink = function (logDiv, realArguments){
  196.         putButton (logDiv, "open the popup", function(){
  197.             realWindowOpen.apply(null, realArguments);
  198.         });
  199.     };
  200.     
  201.     var displayWhiteListThisDomainLink = function(logDiv) {
  202.         var domainsArr = getDomainsArray(document.domain);
  203.         
  204.         putText(logDiv, ' whitelist the domain: '); // using 'innerHTML += ' breaks event listeners strangely
  205.         putWhitelistButton(logDiv, domainsArr[0]);
  206.         if(domainsArr[1]){
  207.             putWhitelistButton(logDiv, domainsArr[1]);
  208.         }
  209.         if(domainsArr[2]){
  210.             putWhitelistButton(logDiv, domainsArr[2]);
  211.         }
  212.     };
  213.     
  214.     var displayCloseButton = function(logDiv) {
  215.         putButton (logDiv, "x", function(){
  216.             logDiv.style.display = 'none';
  217.         }, 'background-color: #a00; color:white; margin:0 32px 0 0; float:right');
  218.     };
  219.     
  220.     /*
  221.      * Override browser's "window.open" with our own implementation.
  222.      */
  223.     var activateBlocker = function() {
  224.         global.open = fakeWindowOpen;
  225.     };
  226.     
  227.     // ============================ LET'S RUN IT ================================
  228.     
  229.     var disabled = isCurrentDomainWhiteListed();
  230.     if(disabled){
  231.         console.log('[UPB] current domain was found on a white list. UPB disabled.');
  232.     }else{
  233.         activateBlocker();
  234.     }
  235. })();