Issue 1672 - Subscribe and listen COM events using ATL::IDispEventImpl and BEGIN_SINK_MAP

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 74 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 51 matching lines @@
   }
   return url;
 }
 
 DWORD WINAPI CPluginClass::StartInitObject(LPVOID thisPtr)
 {
   if (thisPtr == NULL)
     return 0;
   if (!((CPluginClass*)thisPtr)->InitObject(true))
   {
-    ((CPluginClass*)thisPtr)->Unadvice();
+    ((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
 STDMETHODIMP CPluginClass::SetSite(IUnknown* unknownSite)
 {
   CPluginSettings* settings = CPluginSettings::GetInstance();
 
   MULTIPLE_VERSIONS_CHECK();
@@ skipping 24 matching lines @@
       // 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())
+      auto webBrowser = GetBrowser();
+      if (webBrowser)
       {
         DEBUG_GENERAL("Loaded as BHO");
-        CComPtr<IConnectionPoint> pPoint = GetConnectionPoint();
-        if (pPoint)
-        {
-          HRESULT hr = pPoint->Advise((IDispatch*)this, &m_nConnectionID);
-          if (SUCCEEDED(hr))
+        HRESULT hr = DispEventAdvise(webBrowser);
+        if (SUCCEEDED(hr))
+        {
+          m_isAdvised = true;
+          try
           {
-            m_isAdviced = 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());
-            }
+            std::thread startInitObjectThread(StartInitObject, this);
+            startInitObjectThread.detach(); // TODO: but actually we should wait for the thread in the dtr.
           }
-          else
+          catch (const std::system_error& ex)
           {
-            DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_ADVICE, "Class::SetSite - Advice");
+            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());
           }
         }
+        else
+        {
+          DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_ADVICE, "Class::SetSite - Advice");
+        }
       }
       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)
@@ skipping 18 matching lines @@
         }
         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();
+      Unadvise();
     }
   }
   else
   {
-    // Unadvice
-    Unadvice();
+    Unadvise();
 
     // Destroy window
     if (m_pWndProcStatus)
     {
       ::SetWindowLongPtr(m_hStatusBarWnd, GWLP_WNDPROC, (LPARAM)(WNDPROC)m_pWndProcStatus);
 
       m_pWndProcStatus = NULL;
     }
 
     if (m_hPaneWnd)
@@ skipping 147 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================================================================================")
-
-#ifdef ENABLE_DEBUG_RESULT
+// Entry point
+void STDMETHODCALLTYPE CPluginClass::OnBeforeNavigate2(
+                        /* [in] */ IDispatch* frameBrowserDisp,

[Oleksandr, 2015/03/12 05:10:57]

Since we do have Doxygen set up, how about using
/**< [in] */ instead of /* [in] */

[Oleksandr, 2015/03/13 16:42:03]

So how about this comment?

[sergei, 2015/03/13 17:03:14]

I've tested it, neither /* [in] */ nor /**< [in] */ are recognized by doxygen
(1.8.9.1).

Actually, I could remove it, should I remove them?

+                        /* [in] */ VARIANT* urlVariant,
+                        /* [in] */ VARIANT* /*Flags*/,
+                        /* [in] */ VARIANT* /*TargetFrameName*/,
+                        /* [in] */ VARIANT* /*PostData*/,
+                        /* [in] */ VARIANT* /*Headers*/,
+                        /* [in, out] */ VARIANT_BOOL* /*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);
+
+    //Register a mime filter if it's not registered yet
+    if (s_mimeFilter == nullptr)
+    {
+      s_mimeFilter = CPluginClientFactory::GetMimeFilterClientInstance();
+    }
+
+    // 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);
+      CString urlLegacy = ToCString(url);
+      DEBUG_GENERAL(L"================================================================================\nBegin main navigation url:" + urlLegacy + "\n================================================================================")
+  #ifdef ENABLE_DEBUG_RESULT
       CPluginDebug::DebugResultDomain(urlLegacy);
-#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)
+  #endif
+      UpdateStatusBar();
+    }
+    else
+    {
+      DEBUG_NAVI(L"Navi::Begin navigation url:" + ToCString(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);

[Eric, 2015/03/12 22:43:14]

FYI. Some of the individual event-handling functions do not have a debug trace
that corresponds this statement. I don't find this anything like a fatal flaw,
but it's worth noting.

-    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("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
+  {
+    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("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(true);
+          UpdateStatusBar();
+        }
+      }
+    }
+    notificationMessage.Hide();
+    DEBUG_GENERAL("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;
-          BOOL rectRes = GetClientRect(m_hStatusBarWnd, &rect);
-          if (rectRes == TRUE)
-          {
-            MoveWindow(m_hPaneWnd, rect.right - 200, 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;
+      {
+        RECT rect;
+        BOOL rectRes = GetClientRect(m_hStatusBarWnd, &rect);
+        if (rectRes == TRUE)
+        {
+          MoveWindow(m_hPaneWnd, rect.right - 200, 0, m_nPaneWidth, rect.bottom - rect.top, TRUE);
+        }
+      }
+    }
+  }
+  catch (...)
+  {
+  }
 }
 
 bool CPluginClass::InitObject(bool bBHO)
 {
   DEBUG_GENERAL("InitObject");
   CPluginSettings* settings = CPluginSettings::GetInstance();
 
   if (!settings->GetPluginEnabled())
   {
     s_mimeFilter->Unregister();
@@ skipping 970 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::Unadvice()
+// Entry point
+void STDMETHODCALLTYPE CPluginClass::OnOnQuit()
+{
+  try
+  {
+    Unadvise();
+  }
+  catch (...)
+  {
+  }
+}
+
+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();
@@ skipping 77 matching lines @@
             break;
           }
           s_criticalSectionLocal.Unlock();
 
         }
       }
     }
 
     hTabWnd = ::GetWindow(hTabWnd, GW_HWNDNEXT);
   }
-
   return hTabWnd;
-
-}
+}