Issue 370 - Make "Block element" hide elements for added filters

include.postload.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 235 matching lines @@
   // elt.parentNode.appendChild(overlay, elt);
   document.documentElement.appendChild(overlay);
   return overlay;
 }
 
 // Show dialog asking user whether she wants to add the proposed filters derived
 // from selected page element
 function clickHide_showDialog(left, top, filters)
 {
   // If we are already selecting, abort now
-  if (clickHide_activated || clickHideFiltersDialog)
-    clickHide_deactivate(true);
+  if (clickHide_activated)
+    clickHide_rulesPending();
 
   clickHide_filters = filters;
 
   clickHideFiltersDialog = document.createElement("iframe");
   clickHideFiltersDialog.src = ext.getURL("block.html");
   clickHideFiltersDialog.setAttribute("style", "position: fixed !important; visibility: hidden; display: block !important; border: 0px !important;");
   clickHideFiltersDialog.style.WebkitBoxShadow = "5px 5px 20px rgba(0,0,0,0.5)";
   clickHideFiltersDialog.style.zIndex = 0x7FFFFFFF;
 
   // Position in upper-left all the time
@@ skipping 59 matching lines @@
   document.removeEventListener("mousedown", clickHide_stopPropagation, true);
   document.removeEventListener("mouseup", clickHide_stopPropagation, true);
   document.removeEventListener("mouseenter", clickHide_stopPropagation, true);
   document.removeEventListener("mouseleave", clickHide_stopPropagation, true);
   document.removeEventListener("mouseover", clickHide_mouseOver, true);
   document.removeEventListener("mouseout", clickHide_mouseOut, true);
   document.removeEventListener("click", clickHide_mouseClick, true);
   document.removeEventListener("keydown", clickHide_keyDown, true);
 }
 
-// Turn off click-to-hide
-function clickHide_deactivate(keepOverlays)
-{
+function clickHide_deactivate()
+{
+  clickHide_rulesPending();
+
   if (clickHideFiltersDialog)
   {
     document.documentElement.removeChild(clickHideFiltersDialog);
     clickHideFiltersDialog = null;
   }
 
-  clickHide_activated = false;
   clickHide_filters = null;
-  if(!document)
-    return; // This can happen inside a nuked iframe...I think
-
-  document.removeEventListener("mousedown", clickHide_stopPropagation, true);
-  document.removeEventListener("mouseup", clickHide_stopPropagation, true);
-  document.removeEventListener("mouseenter", clickHide_stopPropagation, true);
-  document.removeEventListener("mouseleave", clickHide_stopPropagation, true);
-  document.removeEventListener("mouseover", clickHide_mouseOver, true);
-  document.removeEventListener("mouseout", clickHide_mouseOut, true);
-  document.removeEventListener("click", clickHide_mouseClick, true);
-  document.removeEventListener("keydown", clickHide_keyDown, true);
-
-  if (keepOverlays !== true)
-  {
-    lastRightClickEvent = null;
-
-    if (currentElement) {
-      currentElement.removeEventListener("contextmenu",  clickHide_elementClickHandler, true);
-      unhighlightElements();
-      unhighlightElement(currentElement);
-      currentElement = null;
-    }
+  lastRightClickEvent = null;
+
+  if (currentElement)
+  {
+    currentElement.removeEventListener("contextmenu",  clickHide_elementClickHandler, true);
     unhighlightElements();
-
-    var overlays = document.getElementsByClassName("__adblockplus__overlay");
-    while (overlays.length > 0)
-      overlays[0].parentNode.removeChild(overlays[0]);
-
-    ext.onExtensionUnloaded.removeListener(clickHide_deactivate);
-  }
+    unhighlightElement(currentElement);
+    currentElement = null;
+  }
+  unhighlightElements();
+
+  var overlays = document.getElementsByClassName("__adblockplus__overlay");
+  while (overlays.length > 0)
+    overlays[0].parentNode.removeChild(overlays[0]);
+
+  ext.onExtensionUnloaded.removeListener(clickHide_deactivate);
 }
 
 function clickHide_stopPropagation(e)
 {
   e.stopPropagation();
 }
 
 function clickHide_elementClickHandler(e) {
   e.preventDefault();
   e.stopPropagation();
@@ skipping 326 matching lines @@
       case "clickhide-move":
         if (clickHideFiltersDialog)
         {
           clickHideFiltersDialog.style.left = (parseInt(clickHideFiltersDialog.style.left, 10) + msg.x) + "px";
           clickHideFiltersDialog.style.top = (parseInt(clickHideFiltersDialog.style.top, 10) + msg.y) + "px";
         }
         break;
       case "clickhide-close":
         if (currentElement && msg.remove)
         {
+          // Hide the selected element itself if an added blocking
+          // filter is causing it to collapse. Note that this
+          // behavior is incomplete, but the best we can do here,
+          // e.g. if an added blocking filter matches other elements,
+          // the effect won't be visible until the page is is reloaded.
           checkCollapse(currentElement.prisoner || currentElement);

[kzar, 2015/03/04 13:09:03]

IMHO there should be a comment here to mention we're hiding the right clicked
upon element if a blocking rule now matches it.

 
-          var selectors = msg.selectors;

[kzar, 2015/03/04 11:04:02]

Shouldn't we check msg.remove is true first?

[Sebastian Noack, 2015/03/04 11:34:52]

Well, we do above. ;)

[kzar, 2015/03/04 13:09:03]

Gah, sorry!

[kzar, 2015/03/04 13:09:03]

I think there should also be a comment here to say that selectors are returned
for any new hiding rules we added and so we need to hide matched elements for
those.

[Sebastian Noack, 2015/03/04 14:02:01]

I don't think it needs to be that verbose. But the other case might need some
more explanation.

[kzar, 2015/03/04 14:04:14]

Looks great.

-          if (selectors.length > 0)
-            hideElements(selectors);
+          // Apply added element hiding filters.
+          updateStylesheet();
         }
         clickHide_deactivate();
         break;
       case "clickhide-show-dialog":
         if (window.self == window.top)
           clickHide_showDialog(msg.screenX + window.pageXOffset,
                                msg.screenY + window.pageYOffset,
                                msg.clickHideFilters);
         break;
       case "clickhide-clear-last-right-click-event":
         if (lastRightClickEventValid)
           lastRightClickEventValid = false;
         else
           lastRightClickEvent = null;
         break;
     }
   });
 
   if (window == window.top)
     ext.backgroundPage.sendMessage({type: "report-html-page"});
 }