Issue 1557 - Update to the recent libadblockplus to reduce additional updates in the logic later.

src/plugin/PluginFilter.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 "PluginFilter.h"
 #include "PluginSettings.h"
 #include "PluginClient.h"
 #include "PluginClientFactory.h"
 #include "PluginMutex.h"
 #include "PluginSettings.h"
 #include "PluginSystem.h"
 #include "PluginClass.h"
 #include "mlang.h"
 
 #include "..\shared\CriticalSection.h"
 #include "..\shared\Utils.h"
-#include "..\shared\ContentType.h"
-
 
 // The filters are described at http://adblockplus.org/en/filters
 
 static CriticalSection s_criticalSectionFilterMap;
 
 namespace
 {
   struct GetHtmlElementAttributeResult
   {
     GetHtmlElementAttributeResult() : isAttributeFound(false)
     {
     }
     std::wstring attributeValue;
     bool isAttributeFound;
   };
 
-  bool GetHtmlElementAttribute(IHTMLElement* htmlElement,
-    const ATL::CComBSTR& attributeName, GetHtmlElementAttributeResult& retValue)
-  {
-    if (!htmlElement)
-    {
-      return false;
-    }
+  GetHtmlElementAttributeResult GetHtmlElementAttribute(IHTMLElement& htmlElement,
+    const ATL::CComBSTR& attributeName)
+  {
+    GetHtmlElementAttributeResult retValue;
     ATL::CComVariant vAttr;
     ATL::CComPtr<IHTMLElement4> htmlElement4;
-    if (FAILED(htmlElement->QueryInterface(&htmlElement4)) || !htmlElement4)
-    {
-      return false;
+    if (FAILED(htmlElement.QueryInterface(&htmlElement4)) || !htmlElement4)
+    {
+      return retValue;
     }
     ATL::CComPtr<IHTMLDOMAttribute> attributeNode;
     if (FAILED(htmlElement4->getAttributeNode(attributeName, &attributeNode)) || !attributeNode)
     {
-      return false;
+      return retValue;
     }
     // we set that attribute found but it's not necessary that we can retrieve its value
     retValue.isAttributeFound = true;
     if (FAILED(attributeNode->get_nodeValue(&vAttr)))
     {
-      return false;
+      return retValue;
     }
     if (vAttr.vt == VT_BSTR && vAttr.bstrVal)
     {
       retValue.attributeValue = vAttr.bstrVal;
     }
     else if (vAttr.vt == VT_I4)
     {
       retValue.attributeValue = std::to_wstring(vAttr.iVal);
     }
-    return true;
+    return retValue;
   }
 }
 
 // ============================================================================
 // CFilterElementHideAttrSelector
 // ============================================================================
 
 CFilterElementHideAttrSelector::CFilterElementHideAttrSelector() : m_type(TYPE_NONE), m_pos(POS_NONE), m_bstrAttr(NULL)
 {
 }
@@ skipping 176 matching lines @@
   m_predecessor = filter.m_predecessor;
 }
 
 
 // ============================================================================
 // CFilter
 // ============================================================================
 
 CFilter::CFilter(const CFilter& filter)
 {
-  m_contentType = filter.m_contentType;
   m_filterType  = filter.m_filterType;
 
   m_isFirstParty = filter.m_isFirstParty;
   m_isThirdParty = filter.m_isThirdParty;
 
   m_isMatchCase  = filter.m_isMatchCase;
   m_isFromStart = filter.m_isFromStart;
   m_isFromEnd = filter.m_isFromEnd;
 
   m_filterText = filter.m_filterText;
 
   m_hitCount = filter.m_hitCount;
 }
 
 
 CFilter::CFilter() : m_isMatchCase(false), m_isFirstParty(false),
-  m_isThirdParty(false), m_contentType(AdblockPlus::FilterEngine::ContentType::CONTENT_TYPE_OTHER),
+  m_isThirdParty(false),
   m_isFromStart(false), m_isFromEnd(false), m_hitCount(0)
 {
 }
 
 
 bool CFilterElementHide::IsMatchFilterElementHide(IHTMLElement* pEl) const
 {
   HRESULT hr;
 
   if (!m_tagId.IsEmpty())
@@ skipping 74 matching lines @@
     {
       CComBSTR bstrId;
       if (SUCCEEDED(pEl->get_id(&bstrId)) && bstrId)
       {
         value = bstrId;
         attrFound = true;
       }
     }
     else
     {
-      GetHtmlElementAttributeResult attributeValue;
-      bool rc = GetHtmlElementAttribute(pEl, attrIt->m_bstrAttr, attributeValue);
-      if (rc && (attrFound = attributeValue.isAttributeFound))
+      auto attributeValue = GetHtmlElementAttribute(*pEl, attrIt->m_bstrAttr);
+      if (attrFound = attributeValue.isAttributeFound)
       {
         value = ToCString(attributeValue.attributeValue);
       }
     }
 
     if (attrFound)
     {
       if (attrIt->m_pos == CFilterElementHideAttrPos::EXACT)
       {
         // TODO: IE rearranges the style attribute completely. Figure out if anything can be done about it.
@@ skipping 137 matching lines @@
         }
       }
     } while (separatorChar != '\0');
   }
 
   return true;
 }
 
 bool CPluginFilter::IsElementHidden(const std::wstring& tag, IHTMLElement* pEl, const std::wstring& domain, const std::wstring& indent) const
 {
-  CString tagCString = to_CString(tag);
+  CString tagCString = ToCString(tag);
 
   CString id;
   CComBSTR bstrId;
   if (SUCCEEDED(pEl->get_id(&bstrId)) && bstrId)
   {
     id = bstrId;
   }
 
   CString classNames;
   CComBSTR bstrClassNames;
   if (SUCCEEDED(pEl->get_className(&bstrClassNames)) && bstrClassNames)
   {
     classNames = bstrClassNames;
   }
 
   CriticalSection::Lock filterEngineLock(s_criticalSectionFilterMap);
   {
     // Search tag/id filters
     if (!id.IsEmpty())
     {
       std::pair<TFilterElementHideTagsNamed::const_iterator, TFilterElementHideTagsNamed::const_iterator> idItEnum =
         m_elementHideTagsId.equal_range(std::make_pair(tagCString, id));
       for (TFilterElementHideTagsNamed::const_iterator idIt = idItEnum.first; idIt != idItEnum.second; idIt ++)
       {
         if (idIt->second.IsMatchFilterElementHide(pEl))
         {
 #ifdef ENABLE_DEBUG_RESULT
           DEBUG_HIDE_EL(indent + "HideEl::Found (tag/id) filter:" + idIt->second.m_filterText)
-            CPluginDebug::DebugResultHiding(tagCString, "id:" + id, idIt->second.m_filterText);
+            CPluginDebug::DebugResultHiding(tagCString, L"id:" + id, idIt->second.m_filterText);
 #endif
           return true;
         }
       }
 
       // Search general id
       idItEnum = m_elementHideTagsId.equal_range(std::make_pair("", id));
       for (TFilterElementHideTagsNamed::const_iterator idIt = idItEnum.first; idIt != idItEnum.second; idIt ++)
       {
         if (idIt->second.IsMatchFilterElementHide(pEl))
         {
 #ifdef ENABLE_DEBUG_RESULT
           DEBUG_HIDE_EL(indent + "HideEl::Found (?/id) filter:" + idIt->second.m_filterText)
-            CPluginDebug::DebugResultHiding(tagCString, "id:" + id, idIt->second.m_filterText);
+            CPluginDebug::DebugResultHiding(tagCString, L"id:" + id, idIt->second.m_filterText);
 #endif
           return true;
         }
       }
     }
 
     // Search tag/className filters
     if (!classNames.IsEmpty())
     {
       int pos = 0;
       CString className = classNames.Tokenize(L" \t\n\r", pos);
       while (pos >= 0)
       {
         std::pair<TFilterElementHideTagsNamed::const_iterator, TFilterElementHideTagsNamed::const_iterator> classItEnum = 
           m_elementHideTagsClass.equal_range(std::make_pair(tagCString, className));
 
         for (TFilterElementHideTagsNamed::const_iterator classIt = classItEnum.first; classIt != classItEnum.second; ++classIt)
         {
           if (classIt->second.IsMatchFilterElementHide(pEl))
           {
 #ifdef ENABLE_DEBUG_RESULT
             DEBUG_HIDE_EL(indent + "HideEl::Found (tag/class) filter:" + classIt->second.m_filterText)
-              CPluginDebug::DebugResultHiding(tagCString, "class:" + className, classIt->second.m_filterText);
+              CPluginDebug::DebugResultHiding(tagCString, L"class:" + className, classIt->second.m_filterText);
 #endif
             return true;
           }
         }
 
         // Search general class name
         classItEnum = m_elementHideTagsClass.equal_range(std::make_pair("", className));
         for (TFilterElementHideTagsNamed::const_iterator classIt = classItEnum.first; classIt != classItEnum.second; ++ classIt)
         {
           if (classIt->second.IsMatchFilterElementHide(pEl))
@@ skipping 63 matching lines @@
       }
     }
   }
 
   return isRead;
 }
 
 void CPluginFilter::ClearFilters()
 {
   // Clear filter maps
-  CriticalSection::Lock filterEngineLock(s_criticalSectionFilterMap);    
+  CriticalSection::Lock filterEngineLock(s_criticalSectionFilterMap);
   {
     for (int i = 0; i < 2; i++)
     {
       for (int j = 0; j < 2; j++)
       {
         m_filterMap[i][j].clear();
       }
       m_filterMapDefault[i].clear();
     }
 
     m_elementHideTags.clear();
     m_elementHideTagsId.clear();
     m_elementHideTagsClass.clear();
   }
 }
 
 bool CPluginFilter::ShouldBlock(const std::wstring& src, AdblockPlus::FilterEngine::ContentType contentType, const std::wstring& domain, bool addDebug) const
 {
-  CString srcCString = to_CString(src);
+  std::wstring srcTrimmed = TrimString(src);
 
   // We should not block the empty string, so all filtering does not make sense
   // Therefore we just return
-  if (srcCString.Trim().IsEmpty())
+  if (srcTrimmed.empty())
   {
     return false;
   }
 
   CPluginSettings* settings = CPluginSettings::GetInstance();
 
   CPluginClient* client = CPluginClient::GetInstance();
-  bool result = client->Matches(to_wstring(srcCString), contentType, domain);
+  bool result = client->Matches(srcTrimmed, contentType, domain);
 
 #ifdef ENABLE_DEBUG_RESULT
   if (addDebug)
   {
-    std::wstring type = ToUtf16String(ContentTypeToString(contentType));
+    std::wstring type = ToUtf16String(AdblockPlus::FilterEngine::ContentTypeToString(contentType));
     if (result)
     {
-      DEBUG_FILTER("Filter::ShouldBlock " + type + " YES");
-      CPluginDebug::DebugResultBlocking(to_CString(type), srcCString, domain);
+      CPluginDebug::DebugResultBlocking(ToCString(type), srcTrimmed, domain);
     }
     else
     {
-      CPluginDebug::DebugResultIgnoring(to_CString(type), srcCString, domain);
+      CPluginDebug::DebugResultIgnoring(ToCString(type), srcTrimmed, domain);
     }
   }
 #endif
   return result;
 }