Issue 1173 - proposal for entry point

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 221 matching lines @@
 
 
 
 // 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();
+  return EntryPointWithHResult([&]()->HRESULT
+  {
+    CPluginSettings* settings = CPluginSettings::GetInstance();
 
-  MULTIPLE_VERSIONS_CHECK();
+    MULTIPLE_VERSIONS_CHECK();
 
-  if (unknownSite)
-  {
+    if (unknownSite)
+    {
 
-    DEBUG_GENERAL(L"================================================================================\nNEW TAB UI\n================================================================================")
+      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");
-    }
+      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();
+      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
+      //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();
+      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())
+      try
       {
-        DEBUG_GENERAL("Loaded as BHO");
-        CComPtr<IConnectionPoint> pPoint = GetConnectionPoint();
-        if (pPoint)
+        // Check if loaded as BHO
+        if (GetBrowser())
         {
-          HRESULT hr = pPoint->Advise((IDispatch*)this, &m_nConnectionID);
+          DEBUG_GENERAL("Loaded as BHO");
+          CComPtr<IConnectionPoint> pPoint = GetConnectionPoint();
+          if (pPoint)
+          {
+            HRESULT hr = pPoint->Advise((IDispatch*)this, &m_nConnectionID);
+            if (SUCCEEDED(hr))
+            {
+              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());
+              }
+            }
+            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))
           {
-            m_isAdviced = true;
-
-            try
+            if (pServiceProvider)
             {
-              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());
+              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_ADVICE, "Class::SetSite - Advice");
+            DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_QUERY_SERVICE_PROVIDER, "Class::SetSite - QueryInterface (service provider)");
           }
         }
       }
-      else // Check if loaded as toolbar handler
+      catch (std::runtime_error e)
       {
-        DEBUG_GENERAL("Loaded as toolbar handler");
-        CComPtr<IServiceProvider> pServiceProvider;
+        DEBUG_ERROR(e.what());
+        Unadvice();
+      }
+    }
+    else
+    {
+      // Unadvice
+      Unadvice();
 
-        HRESULT hr = unknownSite->QueryInterface(&pServiceProvider);
-        if (SUCCEEDED(hr))
+      // 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())
         {
-          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();
-          }
+          s_threadInstances.erase(it);
         }
-        else
+        if (s_instances.empty())
         {
-          DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_QUERY_SERVICE_PROVIDER, "Class::SetSite - QueryInterface (service provider)");
+          // TODO: Explicitly releasing a resource when a container becomes empty looks like a job better suited for shared_ptr
+          CPluginClientFactory::ReleaseMimeFilterClientInstance();
         }
       }
-    }
-    catch (std::runtime_error e)
-    {
-      DEBUG_ERROR(e.what());
-      Unadvice();
-    }
-  }
-  else
-  {
-    // Unadvice
-    Unadvice();
+      s_criticalSectionLocal.Unlock();
 
-    // Destroy window
-    if (m_pWndProcStatus)
-    {
-      ::SetWindowLongPtr(m_hStatusBarWnd, GWLP_WNDPROC, (LPARAM)(WNDPROC)m_pWndProcStatus);
+      // Release browser interface
+      s_criticalSectionBrowser.Lock();
+      {
+        m_webBrowser2.Release();
+      }
+      s_criticalSectionBrowser.Unlock();
 
-      m_pWndProcStatus = NULL;
+      DEBUG_GENERAL("================================================================================\nNEW TAB UI - END\n================================================================================")
+
+      ::CoUninitialize();
     }
 
-    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);
+    return IObjectWithSiteImpl<CPluginClass>::SetSite(unknownSite);
+  });
 }
 
 bool CPluginClass::IsStatusBarEnabled()
 {
   DEBUG_GENERAL("IsStatusBarEnabled start");
   HKEY pHkey;
   HKEY pHkeySub;
   RegOpenCurrentUser(KEY_QUERY_VALUE, &pHkey);
   DWORD truth = 1;
   DWORD truthSize = sizeof(truth);
@@ skipping 198 matching lines @@
         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)
 {
-  try
+  return EntryPointWithHResult([&]()->HRESULT
   {
     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);
@@ skipping 117 matching lines @@
         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)
 {
   DEBUG_GENERAL("InitObject");
   CPluginSettings* settings = CPluginSettings::GetInstance();
 
   if (!settings->GetPluginEnabled())
   {
     s_mimeFilter->Unregister();
@@ skipping 358 matching lines @@
     }
   }
   s_criticalSectionLocal.Unlock();
 
   return tab;
 }
 
 
 STDMETHODIMP CPluginClass::QueryStatus(const GUID* pguidCmdGroup, ULONG cCmds, OLECMD prgCmds[], OLECMDTEXT* pCmdText)
 {
-  if (cCmds == 0) return E_INVALIDARG;
-  if (prgCmds == 0) return E_POINTER;
+  return EntryPointWithHResult([&]()->HRESULT
+  {
+    if (cCmds == 0) return E_INVALIDARG;
+    if (prgCmds == 0) return E_POINTER;
 
-  prgCmds[0].cmdf = OLECMDF_ENABLED;
+    prgCmds[0].cmdf = OLECMDF_ENABLED;
 
-  return S_OK;
+    return S_OK;
+  });
 }
 
 HMENU CPluginClass::CreatePluginMenu(const std::wstring& url)
 {
   DEBUG_GENERAL("CreatePluginMenu");
   HINSTANCE hInstance = _AtlBaseModule.GetModuleInstance();
 
   HMENU hMenu = ::LoadMenu(hInstance, MAKEINTRESOURCE(IDR_MENU1));
 
   HMENU hMenuTrackPopup = GetSubMenu(hMenu, 0);
@@ skipping 184 matching lines @@
   fmii.dwTypeData = const_cast<LPWSTR>(ctext.c_str());
   fmii.cch = static_cast<UINT>(ctext.size());
   ::SetMenuItemInfoW(hMenu, ID_MENU_SETTINGS, FALSE, &fmii);
 
   return true;
 }
 
 
 STDMETHODIMP CPluginClass::Exec(const GUID*, DWORD nCmdID, DWORD, VARIANTARG*, VARIANTARG*)
 {
-  HWND hBrowserWnd = GetBrowserHWND();
-  if (!hBrowserWnd)
+  return EntryPointWithHResult([&]()->HRESULT
   {
-    return E_FAIL;
-  }
+    HWND hBrowserWnd = GetBrowserHWND();
+    if (!hBrowserWnd)
+    {
+      return E_FAIL;
+    }
 
-  // Create menu
-  HMENU hMenu = CreatePluginMenu(m_tab->GetDocumentUrl());
-  if (!hMenu)
-  {
-    return E_FAIL;
-  }
+    // Create menu
+    HMENU hMenu = CreatePluginMenu(m_tab->GetDocumentUrl());
+    if (!hMenu)
+    {
+      return E_FAIL;
+    }
 
-  // Check if button in toolbar was pressed
-  int nIDCommand = -1;
-  BOOL bRightAlign = FALSE;
+    // Check if button in toolbar was pressed
+    int nIDCommand = -1;
+    BOOL bRightAlign = FALSE;
 
-  POINT pt;
-  GetCursorPos(&pt);
+    POINT pt;
+    GetCursorPos(&pt);
 
-  HWND hWndToolBar = ::WindowFromPoint(pt);
+    HWND hWndToolBar = ::WindowFromPoint(pt);
 
-  DWORD nProcessId;
-  ::GetWindowThreadProcessId(hWndToolBar, &nProcessId);
+    DWORD nProcessId;
+    ::GetWindowThreadProcessId(hWndToolBar, &nProcessId);
 
-  if (hWndToolBar && ::GetCurrentProcessId() == nProcessId)
-  {
-    ::ScreenToClient(hWndToolBar, &pt);
-    int nButton = (int)::SendMessage(hWndToolBar, TB_HITTEST, 0, (LPARAM)&pt);
+    if (hWndToolBar && ::GetCurrentProcessId() == nProcessId)
+    {
+      ::ScreenToClient(hWndToolBar, &pt);
+      int nButton = (int)::SendMessage(hWndToolBar, TB_HITTEST, 0, (LPARAM)&pt);
 
-    if (nButton > 0)
-    {
-      TBBUTTON pTBBtn = {};
+      if (nButton > 0)
+      {
+        TBBUTTON pTBBtn = {};
 
-      if (SendMessage(hWndToolBar, TB_GETBUTTON, nButton, (LPARAM)&pTBBtn))
-      {
-        RECT rcButton;
-        nIDCommand = pTBBtn.idCommand;
+        if (SendMessage(hWndToolBar, TB_GETBUTTON, nButton, (LPARAM)&pTBBtn))
+        {
+          RECT rcButton;
+          nIDCommand = pTBBtn.idCommand;
 
-        if (SendMessage(hWndToolBar, TB_GETRECT, nIDCommand, (LPARAM)&rcButton))
-        {
-          pt.x = rcButton.left;
-          pt.y = rcButton.bottom;
-          ClientToScreen(hWndToolBar, &pt);
-
-          RECT rcWorkArea;
-          SystemParametersInfo(SPI_GETWORKAREA, 0, (LPVOID)&rcWorkArea, 0);
-          if (rcWorkArea.right - pt.x < 150)
+          if (SendMessage(hWndToolBar, TB_GETRECT, nIDCommand, (LPARAM)&rcButton))
           {
-            bRightAlign = TRUE;
-            pt.x = rcButton.right;
+            pt.x = rcButton.left;
             pt.y = rcButton.bottom;
             ClientToScreen(hWndToolBar, &pt);
+
+            RECT rcWorkArea;
+            SystemParametersInfo(SPI_GETWORKAREA, 0, (LPVOID)&rcWorkArea, 0);
+            if (rcWorkArea.right - pt.x < 150)
+            {
+              bRightAlign = TRUE;
+              pt.x = rcButton.right;
+              pt.y = rcButton.bottom;
+              ClientToScreen(hWndToolBar, &pt);
+            }
           }
         }
       }
+      else
+      {
+        GetCursorPos(&pt);
+      }
+    }
+
+    // Display menu
+    UINT nFlags = 0;
+    if (bRightAlign)
+    {
+      nFlags |= TPM_RIGHTALIGN;
     }
     else
     {
-      GetCursorPos(&pt);
+      nFlags |= TPM_LEFTALIGN;
     }
-  }
 
-  // Display menu
-  UINT nFlags = 0;
-  if (bRightAlign)
-  {
-    nFlags |= TPM_RIGHTALIGN;
-  }
-  else
-  {
-    nFlags |= TPM_LEFTALIGN;
-  }
+    DisplayPluginMenu(hMenu, nIDCommand, pt, nFlags);
 
-  DisplayPluginMenu(hMenu, nIDCommand, pt, nFlags);
-
-  return S_OK;
+    return S_OK;
+  });
 }
 
 /////////////////////////////////////////////////////////////////////////////
 // Window procedures
 
 LRESULT CALLBACK CPluginClass::NewStatusProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
 {
   // Find tab
   CPluginClass *pClass = FindInstance(hWnd);
   if (!pClass)
@@ skipping 424 matching lines @@
         }
       }
     }
 
     hTabWnd = ::GetWindow(hTabWnd, GW_HWNDNEXT);
   }
 
   return hTabWnd;
 
 }