Issue 119 - Switch to injecting CSS for element hiding

src/plugin/PluginClass.cpp

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 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 14 matching lines @@
 #include "AdblockPlusClient.h"
 #include "PluginClientBase.h"
 #include "PluginClientFactory.h"
 #include "PluginUtil.h"
 #include "../shared/Utils.h"
 #include "../shared/Dictionary.h"
 #include "IeVersion.h"
 #include "../shared/Version.h"
 #include <thread>
 #include <array>
+#include "WebBrowserEventsListener.h"
 
 #ifdef DEBUG_HIDE_EL
 DWORD profileTime = 0;
 #endif
 
 extern CComModule _Module;
 
 typedef HANDLE (WINAPI *OPENTHEMEDATA)(HWND, LPCWSTR);
 typedef HRESULT (WINAPI *DRAWTHEMEBACKGROUND)(HANDLE, HDC, INT, INT, LPRECT, LPRECT);
 typedef HRESULT (WINAPI *CLOSETHEMEDATA)(HANDLE);
@@ skipping 46 matching lines @@
       if (right < left)
       {
         throw std::runtime_error("invariant violation: rectangle right < left");
       }
       return static_cast<unsigned long>(right - left);
     }
   };
 }
 
 CPluginClass::CPluginClass()
-  : m_webBrowser2(nullptr)
+  : m_data(std::make_shared<Data>())
 {
   DEBUG_GENERAL([this]() -> std::wstring
     {
       std::wstring s = L"CPluginClass::<constructor>, this = ";
       s += ToHexLiteral(this);
       return s;
     }());
 
   //Use this line to debug memory leaks
   //    _CrtDumpMemoryLeaks();
 
   m_isAdvised = false;
   m_hTabWnd = NULL;
   m_hStatusBarWnd = NULL;
   m_hPaneWnd = NULL;
   m_nPaneWidth = 0;
   m_pWndProcStatus = NULL;
   m_hTheme = NULL;
   m_isInitializedOk = false;
 
 
-  m_tab = new CPluginTab();
+  m_data->tab.reset(new CPluginTab());
 
   Dictionary::Create(GetBrowserLanguage());
 }
 
 CPluginClass::~CPluginClass()
 {
   DEBUG_GENERAL([this]() -> std::wstring
     {
       std::wstring s = L"CPluginClass::<destructor>, this = ";
       s += ToHexLiteral(this);
       return s;
     }());
 
-  delete m_tab;
+  m_data.reset();
 }
 
 HWND CPluginClass::GetBrowserHWND() const
 {
-  if (!m_webBrowser2)
+  if (!m_data->webBrowser2)
   {
-    DEBUG_ERROR_LOG(0, 0, 0, "CPluginClass::GetBrowserHWND - Reached with m_webBrowser2 == nullptr");
+    DEBUG_ERROR_LOG(0, 0, 0, "CPluginClass::GetBrowserHWND - Reached with webBrowser2 == nullptr");
     return nullptr;
   }
   SHANDLE_PTR hBrowserWndHandle = 0;
-  HRESULT hr = m_webBrowser2->get_HWND(&hBrowserWndHandle);
+  HRESULT hr = m_data->webBrowser2->get_HWND(&hBrowserWndHandle);
   if (FAILED(hr))
   {
     DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_GET_BROWSER_WINDOW, "Class::GetBrowserHWND - failed");
     return nullptr;
   }
   return (HWND)hBrowserWndHandle;
 }
 
 bool CPluginClass::IsRootBrowser(IWebBrowser2* otherBrowser)
 {
-  return m_webBrowser2.IsEqualObject(otherBrowser);
+  return m_data->webBrowser2.IsEqualObject(otherBrowser);
 }
 
 CComQIPtr<IWebBrowser2> CPluginClass::GetAsyncBrowser()
 {
   CComQIPtr<IWebBrowser2> browser;
 
   s_criticalSectionLocal.Lock();
   {
     browser = s_asyncWebBrowser2;
   }
   s_criticalSectionLocal.Unlock();
 
   return browser;
 }
 
 std::wstring CPluginClass::GetBrowserUrl() const
 {
   std::wstring url;
-  if (m_webBrowser2)
+  if (m_data->webBrowser2)
   {
     CComBSTR bstrURL;
-    if (SUCCEEDED(m_webBrowser2->get_LocationURL(&bstrURL)))
+    if (SUCCEEDED(m_data->webBrowser2->get_LocationURL(&bstrURL)))
     {
       url = ToWstring(bstrURL);
     }
   }
   else
   {
-    DEBUG_GENERAL(L"CPluginClass::GetBrowserUrl - Reached with m_webBrowser2 == nullptr (probable invariant violation)");
+    DEBUG_GENERAL(L"CPluginClass::GetBrowserUrl - Reached with webBrowser2 == nullptr (probable invariant violation)");
   }
   if (url.empty())
   {
-    url = m_tab->GetDocumentUrl();
+    url = m_data->tab->GetDocumentUrl();
   }
   return url;
 }
 
 DWORD WINAPI CPluginClass::StartInitObject(LPVOID thisPtr)
 {
   if (thisPtr == NULL)
     return 0;
   if (!((CPluginClass*)thisPtr)->InitObject())
   {
@@ skipping 23 matching lines @@
 
       HRESULT hr = ::CoInitialize(NULL);
       if (FAILED(hr))
       {
         DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_COINIT, "Class::SetSite - CoInitialize");
       }
 
       /*
        * We were instantiated as a BHO, so our site is always of type IWebBrowser2.
        */
-      m_webBrowser2 = ATL::CComQIPtr<IWebBrowser2>(unknownSite);
-      if (!m_webBrowser2)
+      m_data->webBrowser2 = ATL::CComQIPtr<IWebBrowser2>(unknownSite);
+      if (!m_data->webBrowser2)
       {
         throw std::logic_error("CPluginClass::SetSite - Unable to convert site pointer to IWebBrowser2*");
       }
       DEBUG_GENERAL([this]() -> std::wstring
         {
           std::wstringstream ss;
           ss << L"CPluginClass::SetSite, this = " << ToHexLiteral(this);
-          ss << L", browser = " << ToHexLiteral(m_webBrowser2);
+          ss << L", browser = " << ToHexLiteral(m_data->webBrowser2);
           return ss.str();
         }());
 
       //register the mimefilter
       //and only mimefilter
       //on some few computers the mimefilter does not get properly registered when it is done on another thread
       s_criticalSectionLocal.Lock();
       {
         // Always register on startup, then check if we need to unregister in a separate thread
         s_mimeFilter = CPluginClientFactory::GetMimeFilterClientInstance();
         s_asyncWebBrowser2 = unknownSite;
         s_instances.insert(this);
       }
       s_criticalSectionLocal.Unlock();
 
       try
       {
-        HRESULT hr = DispEventAdvise(m_webBrowser2);
+        HRESULT hr = DispEventAdvise(m_data->webBrowser2);
         if (SUCCEEDED(hr))
         {
           m_isAdvised = true;
           try
           {
             std::thread startInitObjectThread(StartInitObject, this);
             startInitObjectThread.detach(); // TODO: but actually we should wait for the thread in the dtr.
           }
           catch (const std::system_error& ex)
           {
@@ skipping 55 matching lines @@
           s_threadInstances.erase(it);
         }
         if (s_instances.empty())
         {
           // TODO: Explicitly releasing a resource when a container becomes empty looks like a job better suited for shared_ptr
           CPluginClientFactory::ReleaseMimeFilterClientInstance();
         }
       }
       s_criticalSectionLocal.Unlock();
 
-      m_webBrowser2 = nullptr;
+      m_data->webBrowser2 = nullptr;
 
       DEBUG_GENERAL("================================================================================\nNEW TAB UI - END\n================================================================================")
 
       ::CoUninitialize();
     }
 
   }
   catch (...)
   {
   }
@@ skipping 129 matching lines @@
     ATL::CComQIPtr<IWebBrowser2> webBrowser = frameBrowserDisp;
     if (!webBrowser)
     {
       return;
     }
     if (!urlVariant || urlVariant->vt != VT_BSTR)
     {
       return;
     }
     std::wstring url = ToWstring(urlVariant->bstrVal);
+    EnsureWebBrowserConnected(webBrowser);
 
     // If webbrowser2 is equal to top level browser (as set in SetSite), we are
     // navigating new page
     CPluginClient* client = CPluginClient::GetInstance();
     if (url.find(L"javascript") == 0)
     {
     }
     else if (IsRootBrowser(webBrowser))
     {
-      m_tab->OnNavigate(url);
+      m_data->tab->OnNavigate(url);
       DEBUG_GENERAL(
       L"================================================================================\n"
       L"Begin main navigation url:" + url + L"\n"
       L"================================================================================")
 
 #ifdef ENABLE_DEBUG_RESULT
       CPluginDebug::DebugResultDomain(url);
 #endif
       UpdateStatusBar();
     }
     else
     {
       DEBUG_NAVI(L"Navi::Begin navigation url:" + url)
-      m_tab->CacheFrame(url);
+      m_data->tab->CacheFrame(url);
     }
   }
   catch (...)
   {
   }
 }
 
 // Entry point
 void STDMETHODCALLTYPE CPluginClass::OnDownloadComplete()
 {
   try
   {
-    if (!m_webBrowser2)
+    if (!m_data->webBrowser2)
     {
-      DEBUG_ERROR_LOG(0, 0, 0, "CPluginClass::OnDownloadComplete - Reached with m_webBrowser2 == nullptr");
+      DEBUG_ERROR_LOG(0, 0, 0, "CPluginClass::OnDownloadComplete - Reached with webBrowser2 == nullptr");
       return;
     }
     DEBUG_NAVI(L"Navi::Download Complete")
-    m_tab->OnDownloadComplete(m_webBrowser2);
+      m_data->tab->OnDownloadComplete(m_data->webBrowser2);
   }
   catch (...)
   {
-  }
-}
-
-// Entry point
-void STDMETHODCALLTYPE CPluginClass::OnDocumentComplete(IDispatch* frameBrowserDisp, VARIANT* /*urlOrPidl*/)
-{
-  try
-  {
-    DEBUG_NAVI(L"Navi::Document Complete");
-    ATL::CComQIPtr<IWebBrowser2> webBrowser2 = frameBrowserDisp;
-    if (!webBrowser2)
-    {
-      return;
-    }
-    std::wstring frameSrc = GetLocationUrl(*webBrowser2);
-    m_tab->OnDocumentComplete(webBrowser2, frameSrc, IsRootBrowser(webBrowser2));
-  }
-  catch (...)
-  {
   }
 }
 
 // Entry point
 void STDMETHODCALLTYPE CPluginClass::OnWindowStateChanged(unsigned long flags, unsigned long validFlagsMask)
 {
   try
   {
     DEBUG_GENERAL(L"WindowStateChanged (check tab changed)");
     bool newtabshown = validFlagsMask == (OLECMDIDF_WINDOWSTATE_USERVISIBLE | OLECMDIDF_WINDOWSTATE_ENABLED)
@@ skipping 418 matching lines @@
       }
     }
   }
   s_criticalSectionLocal.Unlock();
 
   return result;
 }
 
 CPluginTab* CPluginClass::GetTab()
 {
-  return m_tab;
+  return m_data->tab.get();
 }
 
 CPluginTab* CPluginClass::GetTab(DWORD dwThreadId)
 {
   CPluginTab* tab = NULL;
 
   s_criticalSectionLocal.Lock();
   {
     std::map<DWORD,CPluginClass*>::const_iterator it = s_threadInstances.find(dwThreadId);
     if (it != s_threadInstances.end())
     {
-      tab = it->second->m_tab;
+      tab = it->second->m_data->tab.get();
     }
   }
   s_criticalSectionLocal.Unlock();
 
   return tab;
 }
 
 // Entry point
 STDMETHODIMP CPluginClass::QueryStatus(const GUID* pguidCmdGroup, ULONG cCmds, OLECMD prgCmds[], OLECMDTEXT* pCmdText)
 {
@@ skipping 224 matching lines @@
 {
   try
   {
     HWND hBrowserWnd = GetBrowserHWND();
     if (!hBrowserWnd)
     {
       return E_FAIL;
     }
 
     // Create menu
-    HMENU hMenu = CreatePluginMenu(m_tab->GetDocumentUrl());
+    HMENU hMenu = CreatePluginMenu(m_data->tab->GetDocumentUrl());
     if (!hMenu)
     {
       return E_FAIL;
     }
 
     // Check if button in toolbar was pressed
     int nIDCommand = -1;
     BOOL bRightAlign = FALSE;
 
     POINT pt;
@@ skipping 395 matching lines @@
   if (m_hPaneWnd == NULL)
   {
     CreateStatusBarPane();
   }
   if ((m_hPaneWnd != NULL) && !::InvalidateRect(m_hPaneWnd, NULL, FALSE))
   {
       DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_INVALIDATE_STATUSBAR, "Class::Invalidate statusbar");
   }
 }
 
-
 void CPluginClass::Unadvise()
 {
-  if (!m_webBrowser2)
+  if (!m_data->webBrowser2)
   {
-    DEBUG_ERROR_LOG(0, 0, 0, "CPluginClass::Unadvise - Reached with m_webBrowser2 == nullptr");
+    DEBUG_ERROR_LOG(0, 0, 0, "CPluginClass::Unadvise - Reached with webBrowser2 == nullptr");
     return;
   }
   s_criticalSectionLocal.Lock();
   {
     if (m_isAdvised)
     {
-      HRESULT hr = DispEventUnadvise(m_webBrowser2);
+      HRESULT hr = DispEventUnadvise(m_data->webBrowser2);
       if (FAILED(hr))
       {
         DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_UNADVISE, "Class::Unadvise - Unadvise");
       }
       m_isAdvised = false;
     }
   }
   s_criticalSectionLocal.Unlock();
 }
 
+void CPluginClass::EnsureWebBrowserConnected(const ATL::CComPtr<IWebBrowser2>& webBrowser)
+{
+  auto it = m_data->connectedWebBrowsersCache.find(webBrowser);
+  if (it != m_data->connectedWebBrowsersCache.end())
+  {
+    return;
+  }
+  ATL::CComObject<WebBrowserEventsListener>* listenerImpl = nullptr;
+  if (FAILED(ATL::CComObject<WebBrowserEventsListener>::CreateInstance(&listenerImpl)))
+  {
+    return;
+  }
+  ATL::CComPtr<IUnknown> listenerRefCounterGuard(listenerImpl->GetUnknown());
+  std::weak_ptr<Data> dataForCapturing = m_data;
+  auto onListenerDestroy = [webBrowser, dataForCapturing]
+  {
+    if (auto data = dataForCapturing.lock())
+    {
+      data->connectedWebBrowsersCache.erase(webBrowser);
+    }
+  };
+  auto onReloaded = [webBrowser, dataForCapturing]
+  {
+    if (auto data = dataForCapturing.lock())
+    {
+      auto frameSrc = GetLocationUrl(*webBrowser);
+      data->tab->OnDocumentComplete(webBrowser, frameSrc, data->webBrowser2.IsEqualObject(webBrowser));
+    }
+  };
+  if (FAILED(listenerImpl->Init(webBrowser, onListenerDestroy, onReloaded)))
+  {
+    return;
+  }
+  m_data->connectedWebBrowsersCache.emplace(webBrowser, listenerImpl);
+}
+
 HICON CPluginClass::GetIcon(int type)
 {
   HICON icon = NULL;
 
   s_criticalSectionLocal.Lock();
   {
     if (!s_hIcons[type])
     {
       std::wstring imageToLoad = L"#";
       imageToLoad += std::to_wstring(s_hIconTypes[type]);
       s_hIcons[type] = (HICON)::LoadImage(_Module.m_hInst, imageToLoad.c_str(), IMAGE_ICON, iconWidth, iconHeight, LR_SHARED);
       if (!s_hIcons[type])
       {
         DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_LOAD_ICON, "Class::GetIcon - LoadIcon");
       }
     }
 
     icon = s_hIcons[type];
   }
   s_criticalSectionLocal.Unlock();
 
   return icon;
 }
 
 ATOM CPluginClass::GetAtomPaneClass()
 {
   return s_atomPaneClass;
 }