Issue #1158 - removed unnecessary definitions and #ifdef/#else/#endif sections

src/plugin/PluginTabBase.cpp

 #include "PluginStdAfx.h"
 
 #include "PluginClient.h"
 #include "PluginSettings.h"
-#ifdef SUPPORT_CONFIG
-#include "PluginConfig.h"
-#endif
 #include "PluginTab.h"
 #include "PluginDomTraverser.h"
 #include "PluginClass.h"
-
 #include "PluginTabBase.h"
 #include "PluginUtil.h"
 #include <dispex.h>
 #include <Mshtmhst.h>
 
 int CPluginTabBase::s_dictionaryVersion = 0;
 int CPluginTabBase::s_settingsVersion = 1;
-#ifdef SUPPORT_FILTER
 int CPluginTabBase::s_filterVersion = 0;
-#endif
-#ifdef SUPPORT_WHITELIST
 int CPluginTabBase::s_whitelistVersion = 0;
-#endif
-#ifdef SUPPORT_CONFIG
-int CPluginTabBase::s_configVersion = 0;
-#endif
-
 
 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 (client->GetIEVersion() < 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());
   }
-
-#ifdef SUPPORT_DOM_TRAVERSER

[Oleksandr, 2014/08/18 20:46:04]

I would leave this ifdef and others concerning the traverser for future. It is
sometimes useful to test the plugin without ad hiding, also this is good to have
if at some point we decide to actually swtich to CSS injection instead.

[Felix Dahlke, 2014/09/30 09:33:29]

IMHO the traverser code is pretty well isolated from the rest - otherwise I
would agree with keeping the defines around to figure out where the traverser
code is.

For debugging, it should suffice to uncomment the `TraverseDocument` line below,
wouldn't it? Doesn't seem like the (then) pointless UpdateUI() call would hurt.

When it comes to switching to CSS injection - I've got a feeling we will end up
keeping the traverser around for older IE issues or maybe specific filters in
there, so it'll most likely be a runtime decision.

[Oleksandr, 2014/10/02 21:24:02]

Good point. Agreed.
On 2014/09/30 09:33:29, Felix H. Dahlke wrote:

   m_traverser = new CPluginDomTraverser(static_cast<CPluginTab*>(this));
-#endif // SUPPORT_DOM_TRAVERSER
 }
 
 
 CPluginTabBase::~CPluginTabBase()
 {
-#ifdef SUPPORT_DOM_TRAVERSER
   delete m_traverser;
   m_traverser = NULL;
-#endif // SUPPORT_DOM_TRAVERSER
-
   m_continueThreadRunning = false;
   if (m_thread.joinable()) {
     m_thread.join();
   }
 }
 
 void CPluginTabBase::OnActivate()
 {
   m_isActivated = true;
 }
 
 
 void CPluginTabBase::OnUpdate()
 {
   m_isActivated = true;
 }
 
 namespace
 {
   void FilterLoader(CPluginTabBase* tabBase)
   {
     tabBase->m_filter->LoadHideFilters(CPluginClient::GetInstance()->GetElementHidingSelectors(tabBase->GetDocumentDomain().GetString()));
     SetEvent(tabBase->m_filter->hideFiltersLoadedEvent);
   }
 }
 
 void CPluginTabBase::OnNavigate(const CString& url)
 {
   SetDocumentUrl(url);
-
-
-#ifdef SUPPORT_FRAME_CACHING
   ClearFrameCache(GetDocumentDomain());
-#endif
-
   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());
   }
-
-#ifdef SUPPORT_DOM_TRAVERSER
   m_traverser->ClearCache();
-#endif
 }
 
 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());
   DEBUG_GENERAL(log);
   if (!(0 == url.CompareNoCase(CString(UserSettingsFileUrl().c_str())) ||
@@ skipping 45 matching lines @@
   hr = pWndEx->Invoke(dispid, IID_NULL, LOCALE_USER_DEFAULT, DISPATCH_PROPERTYPUT | DISPATCH_PROPERTYPUTREF, &params, 0, 0, 0);
   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)
 {
-#ifdef SUPPORT_DOM_TRAVERSER
   if (!CPluginClient::GetInstance()->IsWhitelistedUrl(std::wstring(GetDocumentUrl())))
   {
     m_traverser->TraverseDocument(browser, GetDocumentDomain(), GetDocumentUrl());
   }
-#endif // SUPPORT_DOM_TRAVERSER
-
   InjectABP(browser);
 }
 
 void CPluginTabBase::OnDocumentComplete(IWebBrowser2* browser, const CString& url, bool isDocumentBrowser)
 {
   CString documentUrl = GetDocumentUrl();
 
   if (isDocumentBrowser)
   {
     if (url != documentUrl)
     {
       SetDocumentUrl(url);
     }
     InjectABP(browser);
   }
-
-#ifdef SUPPORT_DOM_TRAVERSER
   if (url.Left(6) != "res://")
   {
     // Get document
     CComPtr<IDispatch> pDocDispatch;
     HRESULT hr = browser->get_Document(&pDocDispatch);
     if (FAILED(hr) || !pDocDispatch)
     {
       return;
     }
 
@@ skipping 15 matching lines @@
       pClientSite->QueryInterface(IID_IDocHostUIHandler, (void**)&docHostUIHandler);
       if (docHostUIHandler != NULL)
       {
         docHostUIHandler->UpdateUI();
       }
     }
 
     pDoc.Release();
     pDocDispatch.Release();
   }
-#endif
 }
 
 CString CPluginTabBase::GetDocumentDomain()
 {
   CString domain;
 
   m_criticalSection.Lock();
   {
     domain = m_documentDomain;
   }
@@ skipping 22 matching lines @@
   }
   m_criticalSection.Unlock();
 
   return url;
 }
 
 
 // ============================================================================
 // Frame caching
 // ============================================================================
-
-#ifdef SUPPORT_FRAME_CACHING
-
 bool CPluginTabBase::IsFrameCached(const CString& url)
 {
   bool isFrame;
 
   m_criticalSectionCache.Lock();
   {
     isFrame = m_cacheFrames.find(url) != m_cacheFrames.end();
   }
   m_criticalSectionCache.Unlock();
 
@@ skipping 15 matching lines @@
   {
     if (domain.IsEmpty() || domain != m_cacheDomain)
     {
       m_cacheFrames.clear();
       m_cacheDomain = domain;
     }
   }
   m_criticalSectionCache.Unlock();
 }
 
-#endif // SUPPORT_FRAME_CACHING
-
-
 void CPluginTabBase::ThreadProc()
 {
   // Force loading/creation of settings
   CPluginSettings* settings = CPluginSettings::GetInstance();
 
   settings->SetWorkingThreadId();
 
   CString threadInfo;
   threadInfo.Format(L"%d.%d", ::GetCurrentProcessId(), ::GetCurrentThreadId());
 
@@ skipping 48 matching lines @@
           CPluginClient::LogPluginError(pluginError.GetErrorCode(), pluginError.GetErrorId(), pluginError.GetErrorSubid(), pluginError.GetErrorDescription(), true, pluginError.GetProcessId(), pluginError.GetThreadId());
         }
 
         // Non-hanging sleep
         Sleep(50);
       }
 
       tabLoopIteration++;
   }
 }