Issue #1466 - fix usage of BSTR

src/plugin/PluginDomTraverserBase.h

+/*
+ * 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/>.
+ */
+
 #ifndef _PLUGIN_DOM_TRAVERSER_BASE_H_
 #define _PLUGIN_DOM_TRAVERSER_BASE_H_
 
 
 #include "PluginTypedef.h"
 #include "PluginTab.h"
 
 
 class CPluginDomTraverserCacheBase
 {
 public:
 
   long m_elements;
 
   CPluginDomTraverserCacheBase() : m_elements(0) {};
   void Init() { m_elements=0; }
 };
 
 template <class T>
 class CPluginDomTraverserBase
 {
 
 public:
 
   CPluginDomTraverserBase(CPluginTab* tab);
   ~CPluginDomTraverserBase();
 
   void TraverseHeader(bool isHeaderTraversed);
 
-  void TraverseDocument(IWebBrowser2* pBrowser, const std::wstring& domain, const CString& documentName);
+  void TraverseDocument(IWebBrowser2* pBrowser, const std::wstring& domain, const std::wstring& documentName);
   void TraverseSubdocument(IWebBrowser2* pBrowser, const std::wstring& domain, const CString& documentName);
 
   virtual void ClearCache();
 
 protected:
 
-  virtual bool OnIFrame(IHTMLElement* pEl, const CString& url, CString& indent) { return true; }
+  virtual bool OnIFrame(IHTMLElement* pEl, const std::wstring& url, CString& indent) { return true; }
   virtual bool OnElement(IHTMLElement* pEl, const CString& tag, T* cache, bool isDebug, CString& indent) { return true; }
 
   virtual bool IsEnabled();
 
 protected:
 
   void TraverseDocument(IWebBrowser2* pBrowser, bool isMainDoc, CString indent);
   void TraverseChild(IHTMLElement* pEl, IWebBrowser2* pBrowser, CString& indent, bool isCached=true);
 
   CComAutoCriticalSection m_criticalSection;
@@ skipping 31 matching lines @@
   delete [] m_cacheElements;
 }
 
 template <class T>
 void CPluginDomTraverserBase<T>::TraverseHeader(bool isHeaderTraversed)
 {
   m_isHeaderTraversed = isHeaderTraversed;
 }
 
 template <class T>
-void CPluginDomTraverserBase<T>::TraverseDocument(IWebBrowser2* pBrowser, const std::wstring& domain, const CString& documentName)
+void CPluginDomTraverserBase<T>::TraverseDocument(IWebBrowser2* pBrowser, const std::wstring& domain, const std::wstring& documentName)
 {
   m_domain = domain;
 
   TraverseDocument(pBrowser, true, "");
 }
 
 
 template <class T>
 void CPluginDomTraverserBase<T>::TraverseSubdocument(IWebBrowser2* pBrowser, const std::wstring& domain, const CString& documentName)
 {
@@ skipping 113 matching lines @@
     {
       CComVariant vIndex(i);
       CComVariant vRetIndex;
       CComPtr<IDispatch> pFrameDispatch;
 
       if (SUCCEEDED(pFrameCollection->item(vIndex, vRetIndex, &pFrameDispatch)) && pFrameDispatch)
       {
         CComQIPtr<IWebBrowser2> pFrameBrowser = pFrameDispatch;
         if (pFrameBrowser)
         {
+          std::wstring src;
           CComBSTR bstrSrc;
-          CString src;
-
-          if (SUCCEEDED(pFrameBrowser->get_LocationURL(&bstrSrc)))
+          if (SUCCEEDED(pFrameBrowser->get_LocationURL(&bstrSrc)) && bstrSrc)
           {
-            src = bstrSrc;
-            CPluginClient::UnescapeUrl(src);
+            src = std::wstring(bstrSrc,SysStringLen(bstrSrc));
+            UnescapeUrl(src);
           }
-
-          if (!src.IsEmpty())
+          if (!src.empty())
           {
             TraverseDocument(pFrameBrowser, false, indent);
           }
         }
       }
     }
   }
 
   // Iframes
   if (hasIframes)
@@ skipping 14 matching lines @@
 
       if (SUCCEEDED(pFrameCollection->item(vIndex, vRetIndex, &pFrameDispatch)) && pFrameDispatch)
       {
         CComQIPtr<IHTMLElement> pFrameEl = pFrameDispatch;
         if (pFrameEl)
         {
           CComVariant vAttr;
 
           if (SUCCEEDED(pFrameEl->getAttribute(ATL::CComBSTR(L"scr"), 0, &vAttr)) && vAttr.vt == VT_BSTR && ::SysStringLen(vAttr.bstrVal) > 0)
           {
-            CString src = vAttr.bstrVal;
+            CString srcLegacy = vAttr.bstrVal;
 
             // Some times, domain is missing. Should this be added on image src's as well?''
 
             // eg. gadgetzone.com.au
-            if (src.Left(2) == L"//")
+            if (srcLegacy.Left(2) == L"//")
             {
-              src = L"http:" + src;
+              srcLegacy = L"http:" + srcLegacy;
             }
             // eg. http://w3schools.com/html/html_examples.asp
-            else if (src.Left(4) != L"http" && src.Left(6) != L"res://")
+            else if (srcLegacy.Left(4) != L"http" && srcLegacy.Left(6) != L"res://")
             {
-              src = L"http://" + to_CString(m_domain) + src;
+              srcLegacy = L"http://" + ToCString(m_domain) + srcLegacy;
             }
-
-            CPluginClient::UnescapeUrl(src);
+            std::wstring src(ToWstring(srcLegacy));
+            UnescapeUrl(src);
 
             // Check if Iframe should be traversed
             if (OnIFrame(pFrameEl, src, indent))
             {
               CComQIPtr<IWebBrowser2> pFrameBrowser = pFrameDispatch;
               if (pFrameBrowser)
               {
                 TraverseDocument(pFrameBrowser, false, indent);
               }
-            }                           
+            }
           }
         }
       }
     }
   }
 }
 
 
 template <class T>
 void CPluginDomTraverserBase<T>::TraverseChild(IHTMLElement* pEl, IWebBrowser2* pBrowser, CString& indent, bool isCached)
 {
   int  cacheIndex = -1;
   long cacheAllElementsCount = -1;
 
   m_criticalSection.Lock();
   {
     CComVariant vCacheIndex;
     if (isCached && SUCCEEDED(pEl->getAttribute(ATL::CComBSTR(L"abp"), 0, &vCacheIndex)) && vCacheIndex.vt == VT_I4)
     {
       cacheIndex = vCacheIndex.intVal;
 
       cacheAllElementsCount = m_cacheElements[cacheIndex].m_elements;
     }
     else
     {
       isCached = false;
 
       cacheIndex = m_cacheIndexLast++;
 
-      // Resize cache???            
+      // Resize cache???
       if (cacheIndex >= m_cacheElementsMax)
       {
         T* oldCacheElements = m_cacheElements;
 
         m_cacheElements = new T[2*m_cacheElementsMax];
 
         memcpy(m_cacheElements, oldCacheElements, m_cacheElementsMax*sizeof(T));
 
         m_cacheElementsMax *= 2;
 
-        delete [] oldCacheElements;                
+        delete [] oldCacheElements;
       }
 
       m_cacheElements[cacheIndex].Init();
 
       vCacheIndex.vt = VT_I4;
       vCacheIndex.intVal = cacheIndex;
 
       pEl->setAttribute(ATL::CComBSTR(L"abp"), vCacheIndex);
     }
   }
@@ skipping 104 matching lines @@
   {
     m_cacheIndexLast = 0;
     m_cacheDocumentHasFrames.clear();
     m_cacheDocumentHasIframes.clear();
   }
   m_criticalSection.Unlock();
 }
 
 
 #endif // _PLUGIN_DOM_TRAVERSER_BASE_H_