WebKitTools:
[WebKit-https.git] / WebKitTools / DumpRenderTree / win / ResourceLoadDelegate.cpp
1 /*
2  * Copyright (C) 2007 Apple Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "DumpRenderTree.h"
30 #include "ResourceLoadDelegate.h"
31
32 #include "LayoutTestController.h"
33 #include <wtf/HashMap.h>
34 #include <wtf/Vector.h>
35 #include <sstream>
36
37 using std::wstring;
38 using std::wiostream;
39
40 static inline wstring wstringFromBSTR(BSTR str)
41 {
42     return wstring(str, ::SysStringLen(str));
43 }
44
45 wstring wstringFromInt(int i)
46 {
47     std::wostringstream ss;
48     ss << i;
49     return ss.str();
50 }
51
52 typedef HashMap<unsigned long, wstring> IdentifierMap;
53
54 IdentifierMap& urlMap()
55 {
56     static IdentifierMap urlMap;
57
58     return urlMap;
59 }
60
61 static wstring descriptionSuitableForTestResult(unsigned long identifier)
62 {
63     IdentifierMap::iterator it = urlMap().find(identifier);
64     
65     if (it == urlMap().end())
66         return L"<unknown>";
67
68     return urlSuitableForTestResult(it->second);
69 }
70
71 static wstring descriptionSuitableForTestResult(IWebURLRequest* request)
72 {
73     if (!request)
74         return L"(null)";
75
76     BSTR urlBSTR;
77     if (FAILED(request->URL(&urlBSTR)))
78         return wstring();
79     
80     wstring url = urlSuitableForTestResult(wstringFromBSTR(urlBSTR));
81     ::SysFreeString(urlBSTR);
82
83     return L"<NSURLRequest " + url + L">";
84 }
85
86 static wstring descriptionSuitableForTestResult(IWebURLResponse* response)
87 {
88     if (!response)
89         return L"(null)";
90
91     BSTR urlBSTR;
92     if (FAILED(response->URL(&urlBSTR)))
93         return wstring();
94     
95     wstring url = urlSuitableForTestResult(wstringFromBSTR(urlBSTR));
96     ::SysFreeString(urlBSTR);
97
98     return L"<NSURLResponse " + url + L">";
99 }
100
101 static wstring descriptionSuitableForTestResult(IWebError* error, unsigned long identifier)
102 {
103     wstring result = L"<NSError ";
104
105     BSTR domainSTR;
106     if (FAILED(error->domain(&domainSTR)))
107         return wstring();
108
109     wstring domain = wstringFromBSTR(domainSTR);
110     ::SysFreeString(domainSTR);
111
112     int code;
113     if (FAILED(error->code(&code)))
114         return wstring();
115
116     if (domain == L"CFURLErrorDomain") {
117         domain = L"NSURLErrorDomain";
118
119         // Convert kCFURLErrorUnknown to NSURLErrorUnknown
120         if (code == -998)
121             code = -1;
122     } else if (domain == L"kCFErrorDomainWinSock") {
123         domain = L"NSURLErrorDomain";
124
125         // Convert the winsock error code to an NSURLError code.
126         if (code == WSAEADDRNOTAVAIL)
127             code = -1004; // NSURLErrorCannotConnectToHose;
128     }
129
130     result += L"domain " + domain;
131     result += L", code " + wstringFromInt(code);
132
133     BSTR failingURLSTR;
134     if (FAILED(error->failingURL(&failingURLSTR)))
135         return wstring();
136
137     wstring failingURL;
138     
139     // If the error doesn't have a failing URL, we fake one by using the URL the resource had 
140     // at creation time. This seems to work fine for now.
141     // See <rdar://problem/5064234> CFErrors should have failingURL key.
142     if (failingURLSTR)
143         failingURL = wstringFromBSTR(failingURLSTR);
144     else
145         failingURL = descriptionSuitableForTestResult(identifier);
146
147     ::SysFreeString(failingURLSTR);
148
149     result += L", failing URL \"" + urlSuitableForTestResult(failingURL) + L"\">";
150
151     return result;
152 }
153
154 ResourceLoadDelegate::ResourceLoadDelegate()
155     : m_refCount(1)
156 {
157 }
158
159 ResourceLoadDelegate::~ResourceLoadDelegate()
160 {
161 }
162
163 HRESULT STDMETHODCALLTYPE ResourceLoadDelegate::QueryInterface(REFIID riid, void** ppvObject)
164 {
165     *ppvObject = 0;
166     if (IsEqualGUID(riid, IID_IUnknown))
167         *ppvObject = static_cast<IWebResourceLoadDelegate*>(this);
168     else if (IsEqualGUID(riid, IID_IWebResourceLoadDelegate))
169         *ppvObject = static_cast<IWebResourceLoadDelegate*>(this);
170     else
171         return E_NOINTERFACE;
172
173     AddRef();
174     return S_OK;
175 }
176
177 ULONG STDMETHODCALLTYPE ResourceLoadDelegate::AddRef(void)
178 {
179     return ++m_refCount;
180 }
181
182 ULONG STDMETHODCALLTYPE ResourceLoadDelegate::Release(void)
183 {
184     ULONG newRef = --m_refCount;
185     if (!newRef)
186         delete(this);
187
188     return newRef;
189 }
190
191 HRESULT STDMETHODCALLTYPE ResourceLoadDelegate::identifierForInitialRequest( 
192     /* [in] */ IWebView* webView,
193     /* [in] */ IWebURLRequest* request,
194     /* [in] */ IWebDataSource* dataSource,
195     /* [in] */ unsigned long identifier)
196
197     if (!done && layoutTestController->dumpResourceLoadCallbacks()) {
198         BSTR urlStr;
199         if (FAILED(request->URL(&urlStr)))
200             return E_FAIL;
201
202         urlMap().set(identifier, wstringFromBSTR(urlStr));
203     }
204
205     return S_OK;
206 }
207
208 HRESULT STDMETHODCALLTYPE ResourceLoadDelegate::willSendRequest( 
209     /* [in] */ IWebView* webView,
210     /* [in] */ unsigned long identifier,
211     /* [in] */ IWebURLRequest* request,
212     /* [in] */ IWebURLResponse* redirectResponse,
213     /* [in] */ IWebDataSource* dataSource,
214     /* [retval][out] */ IWebURLRequest **newRequest)
215 {
216     if (!done && layoutTestController->dumpResourceLoadCallbacks()) {
217         printf("%S - willSendRequest %S redirectResponse %S\n", 
218             descriptionSuitableForTestResult(identifier).c_str(),
219             descriptionSuitableForTestResult(request).c_str(),
220             descriptionSuitableForTestResult(redirectResponse).c_str());
221     }
222
223     request->AddRef();
224     *newRequest = request;
225     return S_OK;
226 }
227
228 HRESULT STDMETHODCALLTYPE ResourceLoadDelegate::didFinishLoadingFromDataSource( 
229     /* [in] */ IWebView* webView,
230     /* [in] */ unsigned long identifier,
231     /* [in] */ IWebDataSource* dataSource)
232 {
233     if (!done && layoutTestController->dumpResourceLoadCallbacks()) {
234         printf("%S - didFinishLoading\n",
235             descriptionSuitableForTestResult(identifier).c_str()),
236        urlMap().remove(identifier);
237     }
238
239    return S_OK;
240 }
241         
242 HRESULT STDMETHODCALLTYPE ResourceLoadDelegate::didFailLoadingWithError( 
243     /* [in] */ IWebView* webView,
244     /* [in] */ unsigned long identifier,
245     /* [in] */ IWebError* error,
246     /* [in] */ IWebDataSource* dataSource)
247 {
248     if (!done && layoutTestController->dumpResourceLoadCallbacks()) {
249         printf("%S - didFailLoadingWithError: %S\n", 
250             descriptionSuitableForTestResult(identifier).c_str(),
251             descriptionSuitableForTestResult(error, identifier).c_str());
252         urlMap().remove(identifier);
253     }
254
255     return S_OK;
256 }