Issue 119 - Switch to injecting CSS for element hiding

src/plugin/PluginTabBase.cpp

 /*
  * 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
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #include "PluginStdAfx.h"
 #include "AdblockPlusClient.h"
 #include "PluginClientBase.h"
 #include "PluginSettings.h"
 #include "AdblockPlusDomTraverser.h"
 #include "PluginTabBase.h"
 #include "IeVersion.h"
 #include "../shared/Utils.h"
 #include <Mshtmhst.h>
+#include "../shared/Utils.h"
 
 CPluginTabBase::CPluginTabBase(CPluginClass* plugin)
   : m_plugin(plugin)
   , m_isActivated(false)
   , m_continueThreadRunning(true)
 {
   m_filter = std::auto_ptr<CPluginFilter>(new CPluginFilter());
   m_filter->hideFiltersLoadedEvent = CreateEvent(NULL, true, false, NULL);
 
   CPluginClient* client = CPluginClient::GetInstance();
@@ skipping 121 matching lines @@
   }
   DEBUG_GENERAL(L"InjectABP. Injecting");
   CComPtr<IDispatch> pDocDispatch;
   browser->get_Document(&pDocDispatch);
   CComQIPtr<IHTMLDocument2> pDoc2(pDocDispatch);
   if (!pDoc2)
   {
     DEBUG_ERROR_LOG(0, PLUGIN_ERROR_CREATE_SETTINGS_JAVASCRIPT, PLUGIN_ERROR_CREATE_SETTINGS_JAVASCRIPT_INVOKE, "CPluginTabBase::InjectABP - Failed to QI document");
     return;
   }
+
   CComPtr<IHTMLWindow2> pWnd2;
   pDoc2->get_parentWindow(&pWnd2);
   if (!pWnd2)
   {
     DEBUG_ERROR_LOG(0, PLUGIN_ERROR_CREATE_SETTINGS_JAVASCRIPT, PLUGIN_ERROR_CREATE_SETTINGS_JAVASCRIPT_INVOKE, "CPluginTabBase::InjectABP - Failed to get parent window");
     return;
   }
   CComQIPtr<IDispatchEx> pWndEx(pWnd2);
   if (!pWndEx)
   {
@@ skipping 19 matching lines @@
   params.rgvarg = &var;
   params.rgdispidNamedArgs = 0;
   hr = pWndEx->Invoke(dispid, IID_NULL, LOCALE_USER_DEFAULT, DISPATCH_PROPERTYPUT | DISPATCH_PROPERTYPUTREF, &params, 0, 0, 0);
   DEBUG_GENERAL("Invoke");
   if (FAILED(hr))
   {
     DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_CREATE_SETTINGS_JAVASCRIPT, PLUGIN_ERROR_CREATE_SETTINGS_JAVASCRIPT_INVOKE, "CPluginTabBase::InjectABP - Failed to create Settings in JavaScript");
   }
 }
 
+bool CPluginTabBase::IsTraverserEnabled()
+{
+  return !IsCSSInjectionEnabled();
+}
+
+bool CPluginTabBase::IsCSSInjectionEnabled()
+{
+  return IsWindowsVistaOrLater() && AdblockPlus::IE::InstalledMajorVersion() >= 10;
+}

[Eric, 2015/12/02 17:00:15]

I'd like to see a user setting for these predicates that can override what's
already here. The use cases are for developers running and debugging traverser
code. Without something we can override, it's going to be quite a bother
degrading the IE version just to run the traverser code.

I suggest two mechanisms.

(1) An in-memory static variable that can be explicitly toggled inside the VS
debugger. This can be evaluated the first time and left alone after that, which
means a second "is initialized" value somewhere.

(2) An external configuration option, either in a file or in the registry, that
configures operation when not running under the debugger.

[sergei, 2016/02/25 17:48:28]

I have created those methods exactly for that reason.
Currently developers can insert `return false;` here or add some code to read it
from some file (3 lines of code) or use something else. Not so difficult, I
guess.

I agree that we need some external flag, see #3631.

+
+namespace
+{
+  void InjectABPCSS(IHTMLDocument2& htmlDocument2, const std::vector<std::wstring>& hideFilters)
+  {
+    // pseudocode: styleHtmlElement = htmlDocument2.createElement("style");
+    ATL::CComQIPtr<IHTMLStyleElement> styleHtmlElement;
+    {
+      ATL::CComPtr<IHTMLElement> stylePureHtmlElement;
+      if (FAILED(htmlDocument2.createElement(ATL::CComBSTR(L"style"), &stylePureHtmlElement)))
+      {
+        DEBUG_GENERAL(L"Cannot create style element");
+        return;
+      }
+      if (!(styleHtmlElement = stylePureHtmlElement))
+      {
+        DEBUG_GENERAL(L"Cannot obtain IHTMLStyleElement from IHTMLElement");
+        return;
+      }
+    }
+    // pseudocode: styleHtmlElement.type = "text/css";
+    if (FAILED(styleHtmlElement->put_type(ATL::CComBSTR("text/css"))))
+    {
+      DEBUG_GENERAL(L"Cannot set type text/css");
+      return;
+    }
+    // pseudocode: styleSheet4 = styleHtmlElement.sheet;
+    ATL::CComQIPtr<IHTMLStyleSheet4> styleSheet4;
+    {
+      // IHTMLStyleElement2 is availabe starting from IE9, Vista
+      ATL::CComQIPtr<IHTMLStyleElement2> styleHtmlElement2 = styleHtmlElement;
+      if (!styleHtmlElement2)
+      {
+        DEBUG_GENERAL(L"Cannot obtain IHTMLStyleElement2 from IHTMLStyleElement");
+        return;
+      }
+      ATL::CComQIPtr<IHTMLStyleSheet> styleSheet;
+      if (FAILED(styleHtmlElement2->get_sheet(&styleSheet)) || !styleSheet)
+      {
+        DEBUG_GENERAL(L"Cannot obtain IHTMLStyleSheet");
+        return;
+      }
+      // IHTMLStyleSheet4 is availabe starting from IE9, Vista
+      styleSheet4 = styleSheet;
+      if (!styleSheet4)
+      {
+        DEBUG_GENERAL(L"Cannot obtain IHTMLStyleSheet4");
+        return;
+      }
+    }
+    // pseudocode: for (auto i = 0; i < hideFilters.length; ++i) {
+    // pseudocode:   i = styleSheet4.insertRule(hideFilters + cssValue, i);
+    // pseudocode: }
+    long newIndex = 0;
+    std::wstring cssValue = L"{ display: none !important; }";
+    for (const auto& selector : hideFilters)
+    {
+      auto cssRule = selector + cssValue;
+      ATL::CComBSTR selector(cssRule.size(), cssRule.c_str());
+      if (SUCCEEDED(styleSheet4->insertRule(selector, newIndex, &newIndex)))
+      {
+        ++newIndex;
+      }
+      else
+      {
+        DEBUG_GENERAL(L"Cannot add rule for selector " + cssRule);
+      }
+    }
+
+    // pseudocode: htmlDocument2.head.appendChild(styleHtmlElement);
+    {
+      // IHTMLDocument7 is availabe starting from IE9, Vista
+      ATL::CComQIPtr<IHTMLDocument7> htmlDocument7 = &htmlDocument2;
+      if (!htmlDocument7)
+      {
+        DEBUG_GENERAL(L"Cannot obtain IHTMLDocument7 from htmlDocument2");
+        return;
+      }
+      ATL::CComPtr<IHTMLElement> headHtmlElement;
+      if (FAILED(htmlDocument7->get_head(&headHtmlElement)))
+      {
+        DEBUG_GENERAL(L"Cannot obtain head from pDoc7");
+        return;
+      }
+      ATL::CComQIPtr<IHTMLDOMNode> headNode = headHtmlElement;
+      if (!headNode)
+      {
+        DEBUG_GENERAL(L"Cannot obtain headNode from headHtmlElement");
+        return;
+      }
+      ATL::CComQIPtr<IHTMLDOMNode> styleNode = styleHtmlElement;
+      if (!styleNode)
+      {
+        DEBUG_GENERAL(L"Cannot obtain IHTMLDOMNode from stylePureHtmlElement");
+        return;
+      }
+      if (FAILED(headNode->appendChild(styleNode, nullptr)))
+      {
+        DEBUG_GENERAL(L"Cannot append blocking style");
+      }
+    }
+  }
+}
+
 namespace
 {
   ATL::CComPtr<IWebBrowser2> GetParent(IWebBrowser2& browser)
   {
     ATL::CComPtr<IDispatch> parentDispatch;
     if (FAILED(browser.get_Parent(&parentDispatch)) || !parentDispatch)
     {
       return nullptr;
     }
     // The InternetExplorer application always returns a pointer to itself.
@@ skipping 28 matching lines @@
       frameHierarchy.push_back(ToUtf8String(GetLocationUrl(*frame)));
     }
     CPluginClient* client = CPluginClient::GetInstance();
     return client->IsWhitelistedUrl(url, frameHierarchy)
         || client->IsElemhideWhitelistedOnDomain(url, frameHierarchy);
   }
 }
 
 void CPluginTabBase::OnDownloadComplete(IWebBrowser2* browser)
 {
-  CPluginClient* client = CPluginClient::GetInstance();
-  std::wstring url = GetDocumentUrl();
-  if (!client->IsWhitelistedUrl(url) && !client->IsElemhideWhitelistedOnDomain(url))
+  if (IsTraverserEnabled())
   {
-    m_traverser->TraverseDocument(browser, GetDocumentDomain(), GetDocumentUrl());
+    CPluginClient* client = CPluginClient::GetInstance();
+    std::wstring url = GetDocumentUrl();
+    if (!client->IsWhitelistedUrl(url) && !client->IsElemhideWhitelistedOnDomain(url))
+    {
+      m_traverser->TraverseDocument(browser, GetDocumentDomain(), GetDocumentUrl());
+    }
   }
   InjectABP(browser);
 }
 
 void CPluginTabBase::OnDocumentComplete(IWebBrowser2* browser, const std::wstring& url, bool isDocumentBrowser)
 {
   std::wstring documentUrl = GetDocumentUrl();
 
   if (isDocumentBrowser)
   {
     if (url != documentUrl)
     {
       SetDocumentUrl(url);
     }
     InjectABP(browser);
   }
   CString urlLegacy = ToCString(url);
-  if (urlLegacy.Left(6) != "res://")
+  if (urlLegacy.Left(6) == "res://")
   {
-    // Get document
-    CComPtr<IDispatch> pDocDispatch;
-    HRESULT hr = browser->get_Document(&pDocDispatch);
-    if (FAILED(hr) || !pDocDispatch)
+    return;
+  }

[Eric, 2015/12/02 17:00:15]

This optimization, for early return on a "res://" URL, could be committed
separately and immediately. It will make the changes below easier to review. At
present it all looks different because the indentation changes, when in fact
most of it's the same.

[sergei, 2016/02/25 17:48:28]

Done. It's already not relevant.

+  // Get document
+  CComPtr<IDispatch> pDocDispatch;
+  HRESULT hr = browser->get_Document(&pDocDispatch);
+  if (FAILED(hr) || !pDocDispatch)
+  {
+    return;
+  }
+
+  CComQIPtr<IHTMLDocument2> pDoc(pDocDispatch);
+  if (!pDoc)
+  {
+    return;
+  }
+
+  if (IsCSSInjectionEnabled() && CPluginSettings::GetInstance()->GetPluginEnabled())
+  {
+    if (!IsFrameWhiteListed(browser))
     {
-      return;
+      DEBUG_GENERAL(L"Inject CSS into " + url);
+      InjectABPCSS(*pDoc, m_filter->GetHideFilters());
     }
+  }
 
-    CComQIPtr<IHTMLDocument2> pDoc(pDocDispatch);
-    if (!pDoc)
+  ATL::CComQIPtr<IOleObject> pOleObj(pDocDispatch);
+  if (!pOleObj)
+    return;
+
+  ATL::CComQIPtr<IOleClientSite> pClientSite;
+  pOleObj->GetClientSite(&pClientSite);
+  if (pClientSite != NULL)
+  {
+    ATL::CComQIPtr<IDocHostUIHandler> docHostUIHandler(pClientSite);
+    if (docHostUIHandler != NULL)
     {
-      return;
-    }
-
-    CComPtr<IOleObject> pOleObj;
-    pDocDispatch->QueryInterface(&pOleObj);
-    if (!pOleObj)
-    {
-      return;
-    }
-    CComPtr<IOleClientSite> pClientSite;
-    pOleObj->GetClientSite(&pClientSite);
-    if (pClientSite != NULL)
-    {
-      CComPtr<IDocHostUIHandler> docHostUIHandler;
-      pClientSite->QueryInterface(&docHostUIHandler);
-      if (docHostUIHandler != NULL)
-      {
-        docHostUIHandler->UpdateUI();
-      }
+      docHostUIHandler->UpdateUI();
     }
   }
 }
 
 std::wstring CPluginTabBase::GetDocumentDomain()
 {
   std::wstring domain;
 
   m_criticalSection.Lock();
   {
@@ skipping 115 matching lines @@
           LogQueue::LogPluginError(pluginError.GetErrorCode(), pluginError.GetErrorId(), pluginError.GetErrorSubid(), pluginError.GetErrorDescription(), true, pluginError.GetProcessId(), pluginError.GetThreadId());
         }
 
         // Non-hanging sleep
         Sleep(50);
       }
 
       tabLoopIteration++;
   }
 }