Issue 1103 - Migrate Simple Adblock users

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
  * 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 "PluginClass.h"
 #include "PluginSettings.h"
 #include "PluginSystem.h"
 #include "PluginFilter.h"
 #include "PluginMimeFilterClient.h"
-#include "PluginClient.h"
+#include "AdblockPlusClient.h"
+#include "PluginClientBase.h"
 #include "PluginClientFactory.h"
-#include "PluginMutex.h"
-#include "sddl.h"
 #include "PluginUtil.h"
-#include "PluginUserSettings.h"
 #include "../shared/Utils.h"
 #include "../shared/Dictionary.h"
-#include "../shared/IE_version.h"
+#include "IeVersion.h"
+#include "../shared/Version.h"
 #include <thread>
 #include <array>
 
 #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);
 
 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;
 
@@ skipping 37 matching lines @@
       return right - left;
     }
   };
 }
 
 CPluginClass::CPluginClass()
 {
   //Use this line to debug memory leaks
   //    _CrtDumpMemoryLeaks();
 
-  m_isAdviced = false;
-  m_nConnectionID = 0;
+  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(this);
@@ skipping 17 matching lines @@
 
 void CPluginClass::FinalRelease()
 {
   s_criticalSectionBrowser.Lock();
   {
     m_webBrowser2.Release();
   }
   s_criticalSectionBrowser.Unlock();
 }
 
-
-// This method tries to get a 'connection point' from the stored browser, which can be
-// used to attach or detach from the stream of browser events
-CComPtr<IConnectionPoint> CPluginClass::GetConnectionPoint()
-{
-  CComQIPtr<IConnectionPointContainer, &IID_IConnectionPointContainer> pContainer(GetBrowser());
-  if (!pContainer)
-  {
-    return NULL;
-  }
-
-  CComPtr<IConnectionPoint> pPoint;
-  HRESULT hr = pContainer->FindConnectionPoint(DIID_DWebBrowserEvents2, &pPoint);
-  if (FAILED(hr))
-  {
-    DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_FIND_CONNECTION_POINT, "Class::GetConnectionPoint - FindConnectionPoint")
-      return NULL;
-  }
-
-  return pPoint;
-}
-
 HWND CPluginClass::GetBrowserHWND() const
 {
   SHANDLE_PTR hBrowserWndHandle = NULL;
 
   CComQIPtr<IWebBrowser2> browser = GetBrowser();
   if (browser)
   {
     HRESULT hr = browser->get_HWND(&hBrowserWndHandle);
     if (FAILED(hr))
     {
@@ skipping 49 matching lines @@
   {
     url = m_tab->GetDocumentUrl();
   }
   return url;
 }
 
 DWORD WINAPI CPluginClass::StartInitObject(LPVOID thisPtr)
 {
   if (thisPtr == NULL)
     return 0;
-  if (!((CPluginClass*)thisPtr)->InitObject(true))
-  {
-    ((CPluginClass*)thisPtr)->Unadvice();
+  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
-      s_mimeFilter = CPluginClientFactory::GetMimeFilterClientInstance();
-      s_asyncWebBrowser2 = unknownSite;
-      s_instances.insert(this);
-    }
-    s_criticalSectionLocal.Unlock();
-
-    try
-    {
-      // Check if loaded as BHO
-      if (GetBrowser())
-      {
-        DEBUG_GENERAL("Loaded as BHO");
-        CComPtr<IConnectionPoint> pPoint = GetConnectionPoint();
-        if (pPoint)
-        {
-          HRESULT hr = pPoint->Advise((IDispatch*)this, &m_nConnectionID);
+  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))
           {
-            m_isAdviced = true;
-
+            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)
             {
-              auto errDescription = std::string("Class::Thread - Failed to create StartInitObject thread, ") +
-                ex.code().message() + ex.what();
-              DEBUG_ERROR_LOG(ex.code().value(), PLUGIN_ERROR_THREAD, PLUGIN_ERROR_MAIN_THREAD_CREATE_PROCESS, errDescription.c_str());
+              DEBUG_SYSTEM_EXCEPTION(ex, PLUGIN_ERROR_THREAD, PLUGIN_ERROR_MAIN_THREAD_CREATE_PROCESS, 
+                "Class::Thread - Failed to create StartInitObject thread");
             }
           }
           else
           {
-            DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_ADVICE, "Class::SetSite - Advice");
+            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 (std::runtime_error e)
-    {
-      DEBUG_ERROR(e.what());
-      Unadvice();
-    }
-  }
-  else
-  {
-    // Unadvice
-    Unadvice();
-
-    // 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);
+      catch (const std::runtime_error& ex)
+      {
+        DEBUG_EXCEPTION(ex);
+        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();
+    }
+
+    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 95 matching lines @@
       }
     }
     else
     {
       DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_GET_STATUSBAR, "Class::Get statusbar state");
     }
   }
   DEBUG_GENERAL("ShowStatusBar end");
 }
 
-/*
- * #1163 This class is the implementation for method DISPID_BEFORENAVIGATE2 in CPluginClass::Invoke.
- * - It validates and convertes its own arguments, rather than unifying them in the Invoke body.
- * - It's declared void and not HRESULT, so DISPID_BEFORENAVIGATE2 can only return S_OK.
- */
-void CPluginClass::BeforeNavigate2(DISPPARAMS* pDispParams)
-{
-
-  if (pDispParams->cArgs < 7)
-  {
-    return;
-  }
-  //Register a mime filter if it's not registered yet
-  if (s_mimeFilter == NULL)
-  {
-    s_mimeFilter = CPluginClientFactory::GetMimeFilterClientInstance();
-  }
-
-  // Get the IWebBrowser2 interface
-  CComQIPtr<IWebBrowser2, &IID_IWebBrowser2> WebBrowser2Ptr;
-  VARTYPE vt = pDispParams->rgvarg[6].vt;
-  if (vt == VT_DISPATCH)
-  {
-    WebBrowser2Ptr = pDispParams->rgvarg[6].pdispVal;
-  }
-  else
-  {
-    // Wrong type, return.
-    return;
-  }
-
-  // Get the URL
-  std::wstring url;
-  const auto& arg = pDispParams->rgvarg[5];
-  vt = arg.vt;
-  if (vt == (VT_BYREF | VT_VARIANT) && arg.pvarVal->vt == VT_BSTR)
-  {
-    BSTR b = arg.pvarVal->bstrVal;
-    if (b) {
-      url = std::wstring(b, SysStringLen(b));
-      UnescapeUrl(url);
-    }
-  }
-  else
-  {
-    // Wrong type, return.
-    return;
-  }
-
-  // If webbrowser2 is equal to top level browser (as set in SetSite), we are navigating new page
-  CPluginClient* client = CPluginClient::GetInstance();
-  CString urlLegacy = ToCString(url);
-  if (urlLegacy.Find(L"javascript") == 0)
-  {
-  }
-  else if (GetBrowser().IsEqualObject(WebBrowser2Ptr))
-  {
-    m_tab->OnNavigate(url);
-
-    DEBUG_GENERAL(L"================================================================================\nBegin main navigation url:" + urlLegacy + "\n================================================================================")
+// Entry point
+void STDMETHODCALLTYPE CPluginClass::OnBeforeNavigate2(
+  IDispatch* frameBrowserDisp /**< [in] */,
+  VARIANT* urlVariant /**< [in] */,
+  VARIANT* /**< [in] Flags*/,
+  VARIANT* /**< [in] TargetFrameName*/,
+  VARIANT* /**< [in] PostData*/,
+  VARIANT* /**< [in] Headers*/,
+  VARIANT_BOOL* /**< [in, out] Cancel*/)
+{
+  try
+  {
+    ATL::CComQIPtr<IWebBrowser2> webBrowser = frameBrowserDisp;
+    if (!webBrowser)
+    {
+      return;
+    }
+    if (!urlVariant || urlVariant->vt != VT_BSTR)
+    {
+      return;
+    }
+    std::wstring url(urlVariant->bstrVal, SysStringLen(urlVariant->bstrVal));
+    UnescapeUrl(url);
+
+    // 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 (GetBrowser().IsEqualObject(webBrowser))
+    {
+      m_tab->OnNavigate(url);
+      DEBUG_GENERAL(
+      L"================================================================================\n"
+      L"Begin main navigation url:" + url + L"\n"
+      L"================================================================================")
 
 #ifdef ENABLE_DEBUG_RESULT
-      CPluginDebug::DebugResultDomain(urlLegacy);
+      CPluginDebug::DebugResultDomain(url);
 #endif
-
-    UpdateStatusBar();
-  }
-  else
-  {
-    DEBUG_NAVI(L"Navi::Begin navigation url:" + urlLegacy)
-    m_tab->CacheFrame(url);
-  }
-}
-
-/*
- * #1163 implements behavior for method DISPID_WINDOWSTATECHANGED in CPluginClass::Invoke
- * - should validate and convert arguments in Invoke, not here
- * - does not validate number of arguments before indexing into 'rgvarg'
- * - does not validate type of argument before using its value
- */
-STDMETHODIMP CPluginClass::OnTabChanged(DISPPARAMS* pDispParams, WORD wFlags)
-{
-  DEBUG_GENERAL("Tab changed");
-  bool newtabshown = pDispParams->rgvarg[1].intVal==3;
-  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);
-        UpdateStatusBar();
-      }
-    }
-  }
-  notificationMessage.Hide();
-  DEBUG_GENERAL("Tab change end");
-  return S_OK;
-}
-
-// This gets called whenever there's a browser event
-// ENTRY POINT
-STDMETHODIMP CPluginClass::Invoke(DISPID dispidMember, REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS* pDispParams, VARIANT* pvarResult, EXCEPINFO* pExcepInfo, UINT* puArgErr)
+      UpdateStatusBar();
+    }
+    else
+    {
+      DEBUG_NAVI(L"Navi::Begin navigation url:" + url)
+      m_tab->CacheFrame(url);
+    }
+  }
+  catch (...)
+  {
+  }
+}
+
+// Entry point
+void STDMETHODCALLTYPE CPluginClass::OnDownloadComplete()
 {
   try
   {
-    WCHAR tmp[256];
-    wsprintf(tmp, L"Invoke: %d\n", dispidMember);
-    DEBUG_GENERAL(tmp);
-    switch (dispidMember)
-    {
-    case DISPID_WINDOWSTATECHANGED:
-      {
-        // #1163 should validate and convert arguments here
-        return OnTabChanged(pDispParams, wFlags);
-      }
-
-    case DISPID_HTMLDOCUMENTEVENTS2_ONBEFOREUPDATE:
-      break;
-
-    case DISPID_HTMLDOCUMENTEVENTS2_ONCLICK:
-      break;
-
-    case DISPID_EVMETH_ONLOAD:
-      DEBUG_NAVI("Navi::OnLoad")
-      break;
-
-    case DISPID_EVMETH_ONCHANGE:
-      break;
-
-    case DISPID_EVMETH_ONMOUSEDOWN:
-      break;
-
-    case DISPID_EVMETH_ONMOUSEENTER:
-      break;
-
-    case DISPID_IHTMLIMGELEMENT_START:
-      break;
-
-    case STDDISPID_XOBJ_ERRORUPDATE:
-      break;
-
-    case STDDISPID_XOBJ_ONPROPERTYCHANGE:
-      break;
-
-    case DISPID_READYSTATECHANGE:
-      DEBUG_NAVI("Navi::ReadyStateChange");
-      break;
-
-    case DISPID_BEFORENAVIGATE:
-      DEBUG_NAVI("Navi::BeforeNavigate");
-      break;
-
-    case DISPID_COMMANDSTATECHANGE:
-      if (m_hPaneWnd == NULL)
-      {
-        CreateStatusBarPane();
-      }
-      else
-      {
+    DEBUG_NAVI(L"Navi::Download Complete")
+    ATL::CComPtr<IWebBrowser2> browser = GetBrowser();
+    if (browser)
+    {
+      m_tab->OnDownloadComplete(browser);
+    }
+  }
+  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);
+    UnescapeUrl(frameSrc);
+    bool isRootPageBrowser = GetBrowser().IsEqualObject(webBrowser2);
+    m_tab->OnDocumentComplete(webBrowser2, frameSrc, isRootPageBrowser);
+  }
+  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)
+      && 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();
+          UpdateStatusBar();
+        }
+      }
+    }
+    notificationMessage.Hide();
+    DEBUG_GENERAL(L"WindowStateChanged (check tab changed) end");
+  }
+  catch (...)
+  {
+  }
+}
+
+// Entry point
+void STDMETHODCALLTYPE CPluginClass::OnCommandStateChange(long /*command*/, VARIANT_BOOL /*enable*/)
+{
+  try
+  {
+    if (m_hPaneWnd == NULL)
+    {
+      CreateStatusBarPane();
+    }
+    else
+    {
       if (AdblockPlus::IE::InstalledMajorVersion() > 6)
-        {
-          RECT rect;
-          //Get the RECT for the leftmost pane (the status text pane)
-          BOOL rectRes = ::SendMessage(m_hStatusBarWnd, SB_GETRECT, 0, (LPARAM)&rect);
-          if (rectRes == TRUE)
-          {
-            MoveWindow(m_hPaneWnd, rect.right - m_nPaneWidth, 0, m_nPaneWidth, rect.bottom - rect.top, TRUE);
-          }
-        }      
-      }
-      break;
-
-    case DISPID_STATUSTEXTCHANGE:
-      break;
-
-    case DISPID_BEFORENAVIGATE2:
-      {
-        // #1163 should validate and convert parameters here
-        BeforeNavigate2(pDispParams);
-      }
-      break;
-
-    case DISPID_DOWNLOADBEGIN:
-      {
-        DEBUG_NAVI("Navi::Download Begin")
-      }
-      break;
-
-    case DISPID_DOWNLOADCOMPLETE:
-      {
-        DEBUG_NAVI("Navi::Download Complete");
-        CComQIPtr<IWebBrowser2> browser = GetBrowser();
-        if (browser)
-        {
-          m_tab->OnDownloadComplete(browser);
-        }
-      }
-      break;
-
-    case DISPID_DOCUMENTCOMPLETE:
-      {
-        DEBUG_NAVI("Navi::Document Complete");
-        CComQIPtr<IWebBrowser2> browser = GetBrowser();
-        if (browser && pDispParams->cArgs >= 2 && pDispParams->rgvarg[1].vt == VT_DISPATCH)
-        {
-          CComQIPtr<IWebBrowser2> pBrowser = pDispParams->rgvarg[1].pdispVal;
-          if (pBrowser)
-          {
-            CComBSTR bstrUrl;
-            if (SUCCEEDED(pBrowser->get_LocationURL(&bstrUrl)) && bstrUrl && ::SysStringLen(bstrUrl) > 0)
-            {
-              std::wstring url = std::wstring(bstrUrl, SysStringLen(bstrUrl));
-              UnescapeUrl(url);
-              m_tab->OnDocumentComplete(browser, url, browser.IsEqualObject(pBrowser));
-            }
-          }
-        }
-      }
-      break;
-
-    case DISPID_ONQUIT:
-    case DISPID_QUIT:
-      {
-        Unadvice();
-      }
-      break;
-
-    default:
-      {
-        CString did;
-        did.Format(L"DispId:%u", dispidMember);
-
-        DEBUG_NAVI(L"Navi::Default " + did)
-      }
-      /*
-       * Ordinarily a method not dispatched should return DISP_E_MEMBERNOTFOUND.
-       * As a conservative initial change, we leave it behaving as before,
-       *   which is to do nothing and return S_OK.
-       */
-      // do nothing
-      break;
-    }
-  }
-  catch(...)
-  {
-    DEBUG_GENERAL( "Caught unknown exception in CPluginClass::Invoke" );
-    return E_FAIL;
-  }
-  return S_OK;
-}
-
-bool CPluginClass::InitObject(bool bBHO)
+      {
+        RECT rect;
+        //Get the RECT for the leftmost pane (the status text pane)
+        BOOL rectRes = ::SendMessage(m_hStatusBarWnd, SB_GETRECT, 0, (LPARAM)&rect);
+        if (rectRes == TRUE)
+        {
+          MoveWindow(m_hPaneWnd, rect.right - m_nPaneWidth, 0, m_nPaneWidth, rect.bottom - rect.top, TRUE);
+        }
+      }
+    }
+  }
+  catch (...)
+  {
+  }
+}
+
+// Entry point
+void STDMETHODCALLTYPE CPluginClass::OnOnQuit()
+{
+  try
+  {
+    Unadvise();
+  }
+  catch (...)
+  {
+  }
+}
+
+bool CPluginClass::InitObject()
 {
   DEBUG_GENERAL("InitObject");
   CPluginSettings* settings = CPluginSettings::GetInstance();
 
   if (!settings->GetPluginEnabled())
   {
     s_mimeFilter->Unregister();
   }
 
   // Load theme module
@@ skipping 56 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();
-  std::wstring curVer = CPluginClient::GetInstance()->GetPref(std::wstring(L"currentVersion"), std::wstring(L"0.0"));

[sergei, 2015/04/22 10:37:09]

How does "0.0" affect `versionCompRes`? I'm not that it's it's a correct value,
should we use a real value of the current version?

[Oleksandr, 2015/04/24 11:50:32]

I don't think we should default to current version. If a version can't be
detected then it's better to play safe and make sure we show the FRP.

-  if (curVer.find(L".") == std::wstring::npos)

[sergei, 2015/04/22 10:37:09]

I would live a comment here about "simpleadblock" case without point.

-  {
-    CPluginClient::GetInstance()->SetPref(L"convertedFrom", curVer);
-  }
+  std::wstring curVer = CPluginClient::GetInstance()->GetPref(L"currentVersion", L"0.0");
   int versionCompRes = CPluginClient::GetInstance()->CompareVersions(curVer, L"1.2");
 
   bool isFirstRun = CPluginClient::GetInstance()->IsFirstRun();
   CPluginClient::GetInstance()->SetPref(L"currentVersion", std::wstring(IEPLUGIN_VERSION));
   // This is the first time ABP was installed
   // Or ABP was updated from the version that did not support Acceptable Ads (<1.2)
   if (isFirstRun || versionCompRes < 0)
   {   
     if (!isFirstRun)
     {
-      if (!CPluginClient::GetInstance()->GetPref(curVer, false))
+      // Display an update page only if it's not a conversion from other product
+      if (CPluginClient::GetInstance()->GetConvertedFrom() == L"")
       {
         CPluginClient::GetInstance()->SetPref(L"displayUpdatePage", true);
       }
     }
 
     // IE6 can't be accessed from another thread, execute in current thread
     if (ieVersion < 7)
     {
       FirstRunThread();
     }
@@ skipping 180 matching lines @@
     
   HDC hdc = GetWindowDC(m_hStatusBarWnd);
   SendMessage(m_hStatusBarWnd, WM_PAINT, (WPARAM)hdc, 0);
   ReleaseDC(m_hStatusBarWnd, hdc);
   
   return true;
 }
 
 void CPluginClass::FirstRunThread()
 {
+  // Just return if the First Run Page should be suppressed
+  if (CPluginClient::GetInstance()->GetPref(L"suppress_first_run_page", false))
+    return;
+
   CoInitialize(NULL);
   VARIANT vFlags;
   vFlags.vt = VT_I4;
   vFlags.intVal = navOpenInNewTab;
 
   CComBSTR navigatePath = CComBSTR(FirstRunPageFileUrl().c_str());
   
   HRESULT hr = GetAsyncBrowser()->Navigate(navigatePath, &vFlags, NULL, NULL, NULL);
   if (FAILED(hr))
   {
@@ skipping 188 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;
   }
 
   // Invalidate and redraw the control
   UpdateStatusBar();
 }
 
 
@@ skipping 470 matching lines @@
   {
     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::Unadvice()
+void CPluginClass::Unadvise()
 {
   s_criticalSectionLocal.Lock();
   {
-    if (m_isAdviced)
-    {
-      CComPtr<IConnectionPoint> pPoint = GetConnectionPoint();
-      if (pPoint)
-      {
-        HRESULT hr = pPoint->Unadvise(m_nConnectionID);
-        if (FAILED(hr))
-        {
-          DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_UNADVICE, "Class::Unadvice - Unadvise");
-        }
-      }
-
-      m_isAdviced = false;
+    if (m_isAdvised)
+    {
+      HRESULT hr = DispEventUnadvise(GetBrowser());
+      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();
 }
 
 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")
+        DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_LOAD_ICON, "Class::GetIcon - LoadIcon");
       }
     }
 
     icon = s_hIcons[type];
   }
   s_criticalSectionLocal.Unlock();
 
   return icon;
 }
 
@@ skipping 60 matching lines @@
             break;
           }
           s_criticalSectionLocal.Unlock();
 
         }
       }
     }
 
     hTabWnd = ::GetWindow(hTabWnd, GW_HWNDNEXT);
   }
-
   return hTabWnd;
-
-}
+}