Issue #1173 - Protect more entry points with try-catch blocks

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 @@
     int Width() const
     {
       return right - left;
     }
   };
 }
 
 CPluginClass::CPluginClass()
   : m_webBrowser2(nullptr)
 {
+  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(this);
+  m_tab = 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;
 }
 
 HWND CPluginClass::GetBrowserHWND() const
 {
   if (!m_webBrowser2)
   {
     DEBUG_ERROR_LOG(0, 0, 0, "CPluginClass::GetBrowserHWND - Reached with m_webBrowser2 == nullptr");
     return nullptr;
   }
@@ skipping 65 matching lines @@
  * '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)
 {
   try
   {
     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");
       }
 
       /*
        * We were instantiated as a BHO, so our site is always of type IWebBrowser2.
        */
       m_webBrowser2 = ATL::CComQIPtr<IWebBrowser2>(unknownSite);
       if (!m_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);
+          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
       {
-        DEBUG_GENERAL("Loaded as BHO");
         HRESULT hr = DispEventAdvise(m_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)
           {
             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 - Advise");
         }
       }
       catch (const std::runtime_error& ex)
       {
         DEBUG_EXCEPTION(ex);
         Unadvise();
       }
     }
     else
     {
+      DEBUG_GENERAL([this]() -> std::wstring
+      {
+        std::wstringstream ss;
+        ss << L"CPluginClass::SetSite, this = " << ToHexLiteral(this);
+        ss << L", browser = nullptr";
+        return ss.str();
+      }());
+
       Unadvise();
 
       // Destroy window
       if (m_pWndProcStatus)
       {
         ::SetWindowLongPtr(m_hStatusBarWnd, GWLP_WNDPROC, (LPARAM)(WNDPROC)m_pWndProcStatus);
 
         m_pWndProcStatus = NULL;
       }
 
@@ skipping 705 matching lines @@
 {
   try
   {
     if (cCmds == 0) return E_INVALIDARG;
     if (prgCmds == 0) return E_POINTER;
 
     prgCmds[0].cmdf = OLECMDF_ENABLED;
   }
   catch (...)
   {
+    DEBUG_GENERAL(L"CPluginClass::QueryStatus - exception");
     return E_FAIL;
   }
   return S_OK;
 }
 
 HMENU CPluginClass::CreatePluginMenu(const std::wstring& url)
 {
   DEBUG_GENERAL("CreatePluginMenu");
   HINSTANCE hInstance = _AtlBaseModule.GetModuleInstance();
 
@@ skipping 266 matching lines @@
     }
     else
     {
       nFlags |= TPM_LEFTALIGN;
     }
 
     DisplayPluginMenu(hMenu, nIDCommand, pt, nFlags);
   }
   catch (...)
   {
-    return E_FAIL; // Suppress exceptions, should log

[Oleksandr, 2016/01/05 02:06:38]

Not really following the comment. Does this mean that logging will be added in
future change sets? Isn't this the time to add logging? 

[Eric, 2016/01/05 15:59:43]

The only logging we have is in Debug builds. I would like Release build logging
here, particularly for 'logic_error'. Since we don't have it, though, there's no
reason to beggar the present. I've added a Debug build log message here.

+    // Suppress exception, log only
+    DEBUG_GENERAL(L"CPluginClass::Exec - exception");
+    return E_FAIL;
   }
 
   return S_OK;
 }
 
 // Entry point
 LRESULT CALLBACK CPluginClass::NewStatusProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
 {
   CPluginClass *pClass;
   try
@@ skipping 65 matching lines @@
         ::LocalFree(hLocal);
         return hRet;
       }
 
     default:
       break;
     }
   }
   catch (...)
   {
     // Suppress exception. Fall through to default handler.

[Oleksandr, 2016/01/05 02:06:38]

Empty catch blocks always look awry to me. Maybe we can log at least?

+    DEBUG_GENERAL(L"CPluginClass::NewStatusProc - exception");
   }
   return ::CallWindowProc(pClass->m_pWndProcStatus, hWnd, message, wParam, lParam);
 }
 
 
 HICON CPluginClass::GetStatusBarIcon(const std::wstring& url)
 {
   // use the disable icon as defualt, if the client doesn't exists
   HICON hIcon = GetIcon(ICON_PLUGIN_DEACTIVATED);
 
@@ skipping 216 matching lines @@
         std::wstring downloadingText = dictionary->Lookup("updater", "downloading-update-text");
         std::wstring downloadingTitle = dictionary->Lookup("updater", "downloading-update-title");
         pClass->notificationMessage.SetTextAndIcon(downloadingText, downloadingTitle, TTI_INFO);
         break;
       }
     }
   }
   catch (...)
   {
     // Suppress exception. Fall through to default handler.
+    DEBUG_GENERAL(L"CPluginClass::PaneWindowProc - exception");
   }
   return ::DefWindowProc(hWnd, message, wParam, lParam);
 }
 
 
 void CPluginClass::UpdateStatusBar()
 {
   DEBUG_GENERAL("*** Updating statusbar")
   if (m_hPaneWnd == NULL)
   {
@@ skipping 50 matching lines @@
   s_criticalSectionLocal.Unlock();
 
   return icon;
 }
 
 ATOM CPluginClass::GetAtomPaneClass()
 {
   return s_atomPaneClass;
 }