Issue #404 - Create common library shared between plugin/engine and installer

src/plugin/PluginTabBase.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 "PluginClient.h"
 #include "PluginSettings.h"
-#include "PluginTab.h"
 #include "AdblockPlusDomTraverser.h"
 #include "PluginClass.h"
 #include "PluginTabBase.h"
 #include "PluginUtil.h"
-#include "IE_Version.h"
+#include "IeVersion.h"
 #include <dispex.h>
 #include <Mshtmhst.h>
-
-int CPluginTabBase::s_dictionaryVersion = 0;
-int CPluginTabBase::s_settingsVersion = 1;
-int CPluginTabBase::s_filterVersion = 0;
-int CPluginTabBase::s_whitelistVersion = 0;
 
 CPluginTabBase::CPluginTabBase(CPluginClass* plugin)
   : m_plugin(plugin)
   , m_isActivated(false)
   , m_continueThreadRunning(true)
 {
   m_filter = std::auto_ptr<CPluginFilter>(new CPluginFilter());
   m_filter->hideFiltersLoadedEvent = CreateEvent(NULL, true, false, NULL);
 
   CPluginClient* client = CPluginClient::GetInstance();
   if (AdblockPlus::IE::InstalledMajorVersion() < 10)
   {
     m_isActivated = true;
   }
 
   try
   {
     m_thread = std::thread(&CPluginTabBase::ThreadProc, this);
   }
   catch (const std::system_error& ex)
   {
-    auto errDescription = std::string("Tab::Thread - Failed to create tab thread") +
-                ex.code().message() + ex.what();
-    DEBUG_ERROR_LOG(ex.code().value(), PLUGIN_ERROR_THREAD, PLUGIN_ERROR_TAB_THREAD_CREATE_PROCESS, errDescription.c_str());
+    DEBUG_SYSTEM_EXCEPTION(ex, PLUGIN_ERROR_THREAD, PLUGIN_ERROR_TAB_THREAD_CREATE_PROCESS,
+      "Tab::Thread - Failed to create tab thread");
   }
   m_traverser = new CPluginDomTraverser(static_cast<CPluginTab*>(this));
 }
 
 
 CPluginTabBase::~CPluginTabBase()
 {
   delete m_traverser;
   m_traverser = NULL;
   m_continueThreadRunning = false;
   if (m_thread.joinable()) {
     m_thread.join();
   }
 }
 
 void CPluginTabBase::OnActivate()
 {
   m_isActivated = true;
 }
 
 
 void CPluginTabBase::OnUpdate()
 {
   m_isActivated = true;
 }
 
 namespace
 {
+  // Entry Point
   void FilterLoader(CPluginTabBase* tabBase)
   {
-    tabBase->m_filter->LoadHideFilters(CPluginClient::GetInstance()->GetElementHidingSelectors(tabBase->GetDocumentDomain()));
-    SetEvent(tabBase->m_filter->hideFiltersLoadedEvent);
-  }
-}
-
-void CPluginTabBase::OnNavigate(const CString& url)
+    try
+    {
+      tabBase->m_filter->LoadHideFilters(CPluginClient::GetInstance()->GetElementHidingSelectors(tabBase->GetDocumentDomain()));
+      SetEvent(tabBase->m_filter->hideFiltersLoadedEvent);
+    }
+    catch (...)
+    {
+      // As a thread-main function, we truncate any C++ exception.
+    }
+  }
+}
+
+void CPluginTabBase::OnNavigate(const std::wstring& url)
 {
   SetDocumentUrl(url);
   ClearFrameCache(GetDocumentDomain());
   std::wstring domainString = GetDocumentDomain();
   ResetEvent(m_filter->hideFiltersLoadedEvent);
   try
   {
     std::thread filterLoaderThread(&FilterLoader, this);
     filterLoaderThread.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 start filter loader 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 start filter loader thread");
   }
   m_traverser->ClearCache();
 }
 
 void CPluginTabBase::InjectABP(IWebBrowser2* browser)
 {
   CriticalSection::Lock lock(m_csInject);
-  CString url = GetDocumentUrl();
-  CString log;
-  log.Format(L"InjectABP. Current URL: %s, settings URL: %s", url, UserSettingsFileUrl().c_str());
+  auto url = GetDocumentUrl();
+
+  std::wstring log = L"InjectABP. Current URL: ";
+  log += url;
+  log += L", settings URL: ";
+  log += UserSettingsFileUrl();
   DEBUG_GENERAL(log);
-  if (!(0 == url.CompareNoCase(CString(UserSettingsFileUrl().c_str())) ||
-      0 == url.CompareNoCase(CString(FirstRunPageFileUrl().c_str()))))
+
+  CString urlLegacy = ToCString(url);
+  if (!(0 == urlLegacy.CompareNoCase(CString(UserSettingsFileUrl().c_str())) ||
+      0 == urlLegacy.CompareNoCase(CString(FirstRunPageFileUrl().c_str()))))
   {
     DEBUG_GENERAL(L"Not injecting");
     return;
   }
   DEBUG_GENERAL(L"Going to inject");
   CComPtr<IDispatch> pDocDispatch;
   browser->get_Document(&pDocDispatch);
   CComQIPtr<IHTMLDocument2> pDoc2 = pDocDispatch;
   if (!pDoc2)
   {
@@ skipping 35 matching lines @@
   DEBUG_GENERAL("Invoke");
   if (FAILED(hr))
   {
     DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_CREATE_SETTINGS_JAVASCRIPT, PLUGIN_ERROR_CREATE_SETTINGS_JAVASCRIPT_INVOKE, "CPluginTabBase::InjectABP - Failed to create Settings in JavaScript");
   }
 }
 
 void CPluginTabBase::OnDownloadComplete(IWebBrowser2* browser)
 {
   CPluginClient* client = CPluginClient::GetInstance();
-  std::wstring url = to_wstring(GetDocumentUrl());
+  std::wstring url = GetDocumentUrl();
   if (!client->IsWhitelistedUrl(url) && !client->IsElemhideWhitelistedOnDomain(url))
   {
     m_traverser->TraverseDocument(browser, GetDocumentDomain(), GetDocumentUrl());
   }
   InjectABP(browser);
 }
 
-void CPluginTabBase::OnDocumentComplete(IWebBrowser2* browser, const CString& url, bool isDocumentBrowser)
-{
-  CString documentUrl = GetDocumentUrl();
+void CPluginTabBase::OnDocumentComplete(IWebBrowser2* browser, const std::wstring& url, bool isDocumentBrowser)
+{
+  std::wstring documentUrl = GetDocumentUrl();
 
   if (isDocumentBrowser)
   {
     if (url != documentUrl)
     {
       SetDocumentUrl(url);
     }
     InjectABP(browser);
   }
-  if (url.Left(6) != "res://")
+  CString urlLegacy = ToCString(url);
+  if (urlLegacy.Left(6) != "res://")
   {
     // Get document
     CComPtr<IDispatch> pDocDispatch;
     HRESULT hr = browser->get_Document(&pDocDispatch);
     if (FAILED(hr) || !pDocDispatch)
     {
       return;
     }
 
     CComQIPtr<IHTMLDocument2> pDoc = pDocDispatch;
@@ skipping 26 matching lines @@
 
   m_criticalSection.Lock();
   {
     domain = m_documentDomain;
   }
   m_criticalSection.Unlock();
 
   return domain;
 }
 
-void CPluginTabBase::SetDocumentUrl(const CString& url)
+void CPluginTabBase::SetDocumentUrl(const std::wstring& url)
 {
   m_criticalSection.Lock();
   {
     m_documentUrl = url;
-    m_documentDomain = CAdblockPlusClient::GetInstance()->GetHostFromUrl(to_wstring(url));
+    m_documentDomain = CAdblockPlusClient::GetInstance()->GetHostFromUrl(url);
   }
   m_criticalSection.Unlock();
 }
 
-CString CPluginTabBase::GetDocumentUrl()
-{
-  CString url;
+std::wstring CPluginTabBase::GetDocumentUrl()
+{
+  std::wstring url;
 
   m_criticalSection.Lock();
   {
     url = m_documentUrl;
   }
   m_criticalSection.Unlock();
 
   return url;
 }
 
 
 // ============================================================================
 // Frame caching
 // ============================================================================
-bool CPluginTabBase::IsFrameCached(const CString& url)
+bool CPluginTabBase::IsFrameCached(const std::wstring& url)
 {
   bool isFrame;
 
   m_criticalSectionCache.Lock();
   {
     isFrame = m_cacheFrames.find(url) != m_cacheFrames.end();
   }
   m_criticalSectionCache.Unlock();
 
   return isFrame;
 }
 
-void CPluginTabBase::CacheFrame(const CString& url)
+void CPluginTabBase::CacheFrame(const std::wstring& url)
 {
   m_criticalSectionCache.Lock();
   {
     m_cacheFrames.insert(url);
   }
   m_criticalSectionCache.Unlock();
 }
 
 void CPluginTabBase::ClearFrameCache(const std::wstring& domain)
 {
   m_criticalSectionCache.Lock();
   {
     if (domain.empty() || domain != m_cacheDomain)
     {
       m_cacheFrames.clear();
       m_cacheDomain = domain;
     }
   }
   m_criticalSectionCache.Unlock();
 }
 
 void CPluginTabBase::ThreadProc()
 {
   // Force loading/creation of settings
-  CPluginSettings* settings = CPluginSettings::GetInstance();
-
-  settings->SetWorkingThreadId();
-
-  CString threadInfo;
-  threadInfo.Format(L"%d.%d", ::GetCurrentProcessId(), ::GetCurrentThreadId());
-
-  CString debugText;
-
-  debugText += L"================================================================================";
-  debugText += L"\nTAB THREAD " + threadInfo;
-  debugText += L"\n================================================================================";
-
-  DEBUG_GENERAL(debugText)
+  CPluginSettings::GetInstance()->SetWorkingThreadId();
+
+  std::string message =
+    "================================================================================\n"
+    "TAB THREAD process=";
+  message += std::to_string(::GetCurrentProcessId());
+  message + " thread=";
+  message += std::to_string(::GetCurrentThreadId());
+  message +=
+    "\n"
+    "================================================================================";
+  DEBUG_GENERAL(message);
 
   // --------------------------------------------------------------------
   // Tab loop
   // --------------------------------------------------------------------
 
   DWORD loopCount = 0;
   DWORD tabLoopIteration = 1;
 
   while (this->m_continueThreadRunning)
   {
 #ifdef ENABLE_DEBUG_THREAD
     CStringA sTabLoopIteration;
     sTabLoopIteration.Format("%u", tabLoopIteration);
 
     DEBUG_THREAD("--------------------------------------------------------------------------------")
       DEBUG_THREAD("Loop iteration " + sTabLoopIteration);
     DEBUG_THREAD("--------------------------------------------------------------------------------")
 #endif
-      if (this->m_isActivated)
-      {
-        bool isChanged = false;
-
-        if (isChanged)
-        {
-          this->m_plugin->UpdateStatusBar();
-        }
-
-        this->m_isActivated = false;
-      }
+      this->m_isActivated = false;
 
       // --------------------------------------------------------------------
       // End loop
       // --------------------------------------------------------------------
 
       // Sleep loop
       while (this->m_continueThreadRunning && !this->m_isActivated && (++loopCount % (TIMER_THREAD_SLEEP_TAB_LOOP / 50)) != 0)
       {
         // Post async plugin error
         CPluginError pluginError;
-        if (CPluginClient::PopFirstPluginError(pluginError))
+        if (LogQueue::PopFirstPluginError(pluginError))
         {
-          CPluginClient::LogPluginError(pluginError.GetErrorCode(), pluginError.GetErrorId(), pluginError.GetErrorSubid(), pluginError.GetErrorDescription(), true, pluginError.GetProcessId(), pluginError.GetThreadId());
+          LogQueue::LogPluginError(pluginError.GetErrorCode(), pluginError.GetErrorId(), pluginError.GetErrorSubid(), pluginError.GetErrorDescription(), true, pluginError.GetProcessId(), pluginError.GetThreadId());
         }
 
         // Non-hanging sleep
         Sleep(50);
       }
 
       tabLoopIteration++;
   }
 }