Issue 1201 - Enabling/disabling ABP everywhere applies only in the next opened tab

src/plugin/PluginClass.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
@@ skipping 29 matching lines @@
 
 typedef HANDLE (WINAPI *OPENTHEMEDATA)(HWND, LPCWSTR);
 typedef HRESULT (WINAPI *DRAWTHEMEBACKGROUND)(HANDLE, HDC, INT, INT, LPRECT, LPRECT);
 typedef HRESULT (WINAPI *CLOSETHEMEDATA)(HANDLE);
 
 HICON CPluginClass::s_hIcons[ICON_MAX] = { NULL, NULL, NULL };
 DWORD CPluginClass::s_hIconTypes[ICON_MAX] = { IDI_ICON_DISABLED, IDI_ICON_ENABLED, IDI_ICON_DEACTIVATED };
 uint32_t iconHeight = 32;
 uint32_t iconWidth = 32;
 
+CPluginMimeFilterClient* CPluginClass::s_mimeFilter = NULL;
+
 CLOSETHEMEDATA pfnClose = NULL;
 DRAWTHEMEBACKGROUND pfnDrawThemeBackground = NULL;
 OPENTHEMEDATA pfnOpenThemeData = NULL;
 
 ATOM CPluginClass::s_atomPaneClass = NULL;
 HINSTANCE CPluginClass::s_hUxtheme = NULL;
 std::set<CPluginClass*> CPluginClass::s_instances;
 std::map<DWORD, CPluginClass*> CPluginClass::s_threadInstances;
 
 CComAutoCriticalSection CPluginClass::s_criticalSectionLocal;
@@ skipping 132 matching lines @@
   {
     url = m_tab->GetDocumentUrl();
   }
   return url;
 }
 
 DWORD WINAPI CPluginClass::StartInitObject(LPVOID thisPtr)
 {
   if (thisPtr == NULL)
     return 0;
-  if (!((CPluginClass*)thisPtr)->InitObject(true))
+  if (!((CPluginClass*)thisPtr)->InitObject())
   {
     ((CPluginClass*)thisPtr)->Unadvise();
   }
 
   return 0;
 }
 
-// This gets called when a new browser window is created (which also triggers the
-// creation of this object). The pointer passed in should be to a IWebBrowser2
-// interface that represents the browser for the window.
-// it is also called when a tab is closed, this unknownSite will be null
-// so we should handle that it is called this way several times during a session
+/*
+ * IE calls this when it creates a new browser window or tab, immediately after it also 
+ * creates the object. The argument 'unknownSite' in is the OLE "site" of the object, 
+ * which is an IWebBrowser2 interface associated with the window/tab. 
+ *
+ * IE also ordinarily calls this again when its window/tab is closed, in which case
+ * 'unknownSite' will be null. Extraordinarily, this is sometimes _not_ called when IE
+ * is shutting down. Thus 'SetSite(nullptr)' has some similarities with a destructor,
+ * but it is not a proper substitute for one.
+ */
 STDMETHODIMP CPluginClass::SetSite(IUnknown* unknownSite)
 {
-  CPluginSettings* settings = CPluginSettings::GetInstance();
-
-  MULTIPLE_VERSIONS_CHECK();
-
-  if (unknownSite)
-  {
-
-    DEBUG_GENERAL(L"================================================================================\nNEW TAB UI\n================================================================================")
-
-    HRESULT hr = ::CoInitialize(NULL);
-    if (FAILED(hr))
-    {
-      DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_COINIT, "Class::SetSite - CoInitialize");
-    }
-
-    s_criticalSectionBrowser.Lock();
-    {
-      m_webBrowser2 = unknownSite;
-    }
-    s_criticalSectionBrowser.Unlock();
-
-    //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
-      CPluginClientFactory::GetMimeFilterClientInstance();
-      s_asyncWebBrowser2 = unknownSite;
-      s_instances.insert(this);
-    }
-    s_criticalSectionLocal.Unlock();
-
-    try
-    {
-      // Check if loaded as BHO
-      auto webBrowser = GetBrowser();
-      if (webBrowser)
-      {
-        DEBUG_GENERAL("Loaded as BHO");
-        HRESULT hr = DispEventAdvise(webBrowser);
-        if (SUCCEEDED(hr))
-        {
-          m_isAdvised = true;
-          try
+  try
+  {
+    if (unknownSite)
+    {
+
+      DEBUG_GENERAL(L"================================================================================\nNEW TAB UI\n================================================================================")
+
+      HRESULT hr = ::CoInitialize(NULL);
+      if (FAILED(hr))
+      {
+        DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_COINIT, "Class::SetSite - CoInitialize");
+      }
+
+      s_criticalSectionBrowser.Lock();
+      {
+        m_webBrowser2 = unknownSite;
+      }
+      s_criticalSectionBrowser.Unlock();
+
+      //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
+      {
+        auto webBrowser = GetBrowser();
+        if (webBrowser)
+        {
+          DEBUG_GENERAL("Loaded as BHO");
+          HRESULT hr = DispEventAdvise(webBrowser);
+          if (SUCCEEDED(hr))
           {
-            std::thread startInitObjectThread(StartInitObject, this);
-            startInitObjectThread.detach(); // TODO: but actually we should wait for the thread in the dtr.
+            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)
+            {
+              DEBUG_SYSTEM_EXCEPTION(ex, PLUGIN_ERROR_THREAD, PLUGIN_ERROR_MAIN_THREAD_CREATE_PROCESS, 
+                "Class::Thread - Failed to create StartInitObject thread");
+            }
           }
-          catch (const std::system_error& ex)
+          else
           {
-            DEBUG_SYSTEM_EXCEPTION(ex, PLUGIN_ERROR_THREAD, PLUGIN_ERROR_MAIN_THREAD_CREATE_PROCESS, 
-              "Class::Thread - Failed to create StartInitObject thread");
+            DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_ADVICE, "Class::SetSite - Advise");
           }
         }
-        else
-        {
-          DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_ADVICE, "Class::SetSite - Advise");
-        }
-      }
-      else // Check if loaded as toolbar handler
-      {
-        DEBUG_GENERAL("Loaded as toolbar handler");
-        CComPtr<IServiceProvider> pServiceProvider;
-
-        HRESULT hr = unknownSite->QueryInterface(&pServiceProvider);
-        if (SUCCEEDED(hr))
-        {
-          if (pServiceProvider)
-          {
-            s_criticalSectionBrowser.Lock();
-            {
-              HRESULT hr = pServiceProvider->QueryService(IID_IWebBrowserApp, &m_webBrowser2);
-              if (SUCCEEDED(hr))
-              {
-                if (m_webBrowser2)
-                {
-                  InitObject(false);
-                }
-              }
-              else
-              {
-                DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_QUERY_BROWSER, "Class::SetSite - QueryService (IID_IWebBrowserApp)");
-              }
-            }
-            s_criticalSectionBrowser.Unlock();
-          }
-        }
-        else
-        {
-          DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_QUERY_SERVICE_PROVIDER, "Class::SetSite - QueryInterface (service provider)");
-        }
-      }
-    }
-    catch (const std::runtime_error& ex)
-    {
-      DEBUG_EXCEPTION(ex);
+      }
+      catch (const std::runtime_error& ex)
+      {
+        DEBUG_EXCEPTION(ex);
+        Unadvise();
+      }
+    }
+    else
+    {
       Unadvise();
-    }
-  }
-  else
-  {
-    Unadvise();
-
-    // Destroy window
-    if (m_pWndProcStatus)
-    {
-      ::SetWindowLongPtr(m_hStatusBarWnd, GWLP_WNDPROC, (LPARAM)(WNDPROC)m_pWndProcStatus);
-
-      m_pWndProcStatus = NULL;
-    }
-
-    if (m_hPaneWnd)
-    {
-      DestroyWindow(m_hPaneWnd);
-      m_hPaneWnd = NULL;
-    }
-
-    m_hTabWnd = NULL;
-    m_hStatusBarWnd = NULL;
-
-    // Remove instance from the list, shutdown threads
-    HANDLE hMainThread = NULL;
-    HANDLE hTabThread = NULL;
-
-    s_criticalSectionLocal.Lock();
-    {
-      s_instances.erase(this);
-
-      std::map<DWORD,CPluginClass*>::iterator it = s_threadInstances.find(::GetCurrentThreadId());
-      if (it != s_threadInstances.end())
-      {
-        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();
-
-    // Release browser interface
-    s_criticalSectionBrowser.Lock();
-    {
-      m_webBrowser2.Release();
-    }
-    s_criticalSectionBrowser.Unlock();
-
-    DEBUG_GENERAL("================================================================================\nNEW TAB UI - END\n================================================================================")
-
-    ::CoUninitialize();
-  }
-
-  return IObjectWithSiteImpl<CPluginClass>::SetSite(unknownSite);
+
+      // Destroy window
+      if (m_pWndProcStatus)
+      {
+        ::SetWindowLongPtr(m_hStatusBarWnd, GWLP_WNDPROC, (LPARAM)(WNDPROC)m_pWndProcStatus);
+
+        m_pWndProcStatus = NULL;
+      }
+
+      if (m_hPaneWnd)
+      {
+        DestroyWindow(m_hPaneWnd);
+        m_hPaneWnd = NULL;
+      }
+
+      m_hTabWnd = NULL;
+      m_hStatusBarWnd = NULL;
+
+      // Remove instance from the list, shutdown threads
+      HANDLE hMainThread = NULL;
+      HANDLE hTabThread = NULL;
+
+      s_criticalSectionLocal.Lock();
+      {
+        s_instances.erase(this);
+
+        std::map<DWORD,CPluginClass*>::iterator it = s_threadInstances.find(::GetCurrentThreadId());
+        if (it != s_threadInstances.end())
+        {
+          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();
+
+      // Release browser interface
+      s_criticalSectionBrowser.Lock();
+      {
+        m_webBrowser2.Release();
+      }
+      s_criticalSectionBrowser.Unlock();
+
+      DEBUG_GENERAL("================================================================================\nNEW TAB UI - END\n================================================================================")
+
+      ::CoUninitialize();
+    }
+
+    IObjectWithSiteImpl<CPluginClass>::SetSite(unknownSite);
+  }
+  catch (...)
+  {
+  }
+  return S_OK;
 }
 
 bool CPluginClass::IsStatusBarEnabled()
 {
   DEBUG_GENERAL("IsStatusBarEnabled start");
   HKEY pHkey;
   HKEY pHkeySub;
   RegOpenCurrentUser(KEY_QUERY_VALUE, &pHkey);
   DWORD truth = 1;
   DWORD truthSize = sizeof(truth);
@@ skipping 204 matching lines @@
       && flags == (OLECMDIDF_WINDOWSTATE_USERVISIBLE | OLECMDIDF_WINDOWSTATE_ENABLED);
     if (newtabshown)
     {
       std::map<DWORD,CPluginClass*>::const_iterator it = s_threadInstances.find(GetCurrentThreadId());
       if (it == s_threadInstances.end())
       {
         s_threadInstances[::GetCurrentThreadId()] = this;
         if (!m_isInitializedOk)
         {
           m_isInitializedOk = true;
-          InitObject(true);
+          InitObject();
           UpdateStatusBar();
         }
       }
     }
     notificationMessage.Hide();
     DEBUG_GENERAL(L"WindowStateChanged (check tab changed) end");
   }
   catch (...)
   {
   }
@@ skipping 32 matching lines @@
 {
   try
   {
     Unadvise();
   }
   catch (...)
   {
   }
 }
 
-bool CPluginClass::InitObject(bool bBHO)
+bool CPluginClass::InitObject()
 {
   DEBUG_GENERAL("InitObject");
   CPluginSettings* settings = CPluginSettings::GetInstance();
 
   if (!settings->GetPluginEnabled())
   {
-    CPluginClientFactory::ReleaseMimeFilterClientInstance();

[Oleksandr, 2015/03/27 08:02:29]

This fixes the issue. Just calling Unregister() here is not releasing m_spCFHTTP
and m_spCFHTTPS in CPluginMimeFilterClient, which apparently means our
Asynchronous Pluggable Protocols remain invoked. This renders s_mimeFilter
irrelevant, so removing it.

[sergei, 2015/04/01 18:49:32]

No, it does not mean that our APP handlers remain invoked. If we unregistered
them they are not called anymore, which is actually expected. According to the
debugger, the reference counter of the factories is equal to 1, so they are not
referenced by something else.

+    s_mimeFilter->Unregister();
   }
 
   // Load theme module
   s_criticalSectionLocal.Lock();
   {
     if (!s_hUxtheme)
     {
       s_hUxtheme = ::GetModuleHandle(L"uxtheme.dll");
       if (s_hUxtheme)
       {
@@ skipping 49 matching lines @@
 
     if (!GetAtomPaneClass())
     {
       DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_REGISTER_PANE_CLASS, "Class::InitObject - RegisterClassEx");
       return false;
     }
   }
 
   int ieVersion = AdblockPlus::IE::InstalledMajorVersion();
   // Create status pane
-  if (bBHO && ieVersion > 6 && !CreateStatusBarPane())
+  if (ieVersion > 6 && !CreateStatusBarPane())
   {
     return false;
   }
   
   s_criticalSectionLocal.Lock();
   if (CPluginClient::GetInstance()->GetPref(L"currentVersion", L"0.0").find(L"simpleadblock") != std::wstring::npos)
   {
     CPluginClient::GetInstance()->SetPref(L"isFromSimpleAdblock", true);
     CPluginClient::GetInstance()->SetPref(L"currentVersion", std::wstring(IEPLUGIN_VERSION));
   }
@@ skipping 368 matching lines @@
     {
       CPluginSettings* settings = CPluginSettings::GetInstance();
 
       settings->TogglePluginEnabled();
 
       // Enable / disable mime filter
       s_criticalSectionLocal.Lock();
       {
         if (settings->GetPluginEnabled())
         {
-          CPluginClientFactory::GetMimeFilterClientInstance();
+          s_mimeFilter = CPluginClientFactory::GetMimeFilterClientInstance();
         }
         else
         {
+          s_mimeFilter = NULL;
+
           CPluginClientFactory::ReleaseMimeFilterClientInstance();
         }
       }
       s_criticalSectionLocal.Unlock();
     }
     break;
   case ID_MENU_SETTINGS:
     {
       CComQIPtr<IWebBrowser2> browser = GetAsyncBrowser();
       if (browser)
@@ skipping 15 matching lines @@
             DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_NAVIGATION, PLUGIN_ERROR_NAVIGATION_SETTINGS, "Navigation::Failed")
           }
         }
       }
       break;
     }
   case ID_MENU_DISABLE_ON_SITE:
     {
       CPluginSettings* settings = CPluginSettings::GetInstance();
       std::wstring urlString = GetTab()->GetDocumentUrl();
-      if (client->IsWhitelistedUrl(urlString))
-      {
-        settings->RemoveWhiteListedDomain(ToCString(client->GetHostFromUrl(urlString)));
+      std::string filterText = client->GetWhitelistingFilter(urlString);
+      if (!filterText.empty())
+      {
+        client->RemoveFilter(filterText);
       }
       else
       {
         settings->AddWhiteListedDomain(ToCString(client->GetHostFromUrl(urlString)));
       }
       GetBrowser()->Refresh();
     }
   default:
     break;
   }
@@ skipping 589 matching lines @@
           s_criticalSectionLocal.Unlock();
 
         }
       }
     }
 
     hTabWnd = ::GetWindow(hTabWnd, GW_HWNDNEXT);
   }
   return hTabWnd;
 }