WebCore:
[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 <string>
36 #include <sstream>
37
38 using std::wstring;
39 using std::wiostream;
40
41 static inline wstring wstringFromBSTR(BSTR str)
42 {
43     return wstring(str, ::SysStringLen(str));
44 }
45
46 static wstring urlSuitableForTestResult(const wstring& url)
47 {
48     // FIXME: This should convert file:/// URLs like the Mac version does.
49     // It's currently not done because the only tests that use file:/// URLs 
50     // are the webarchive tests and we don't support those on Windows.
51     return url;
52 }
53
54 wstring wstringFromInt(int i)
55 {
56     std::wostringstream ss;
57     ss << i;
58     return ss.str();
59 }
60
61 typedef HashMap<unsigned long, wstring> IdentifierMap;
62
63 IdentifierMap& urlMap()
64 {
65     static IdentifierMap urlMap;
66
67     return urlMap;
68 }
69
70 static wstring descriptionSuitableForTestResult(unsigned long identifier)
71 {
72     IdentifierMap::iterator it = urlMap().find(identifier);
73     
74     if (it == urlMap().end())
75         return L"<unknown>";
76
77     return urlSuitableForTestResult(it->second);
78 }
79
80 static wstring descriptionSuitableForTestResult(IWebURLRequest* request)
81 {
82     if (!request)
83         return L"(null)";
84
85     BSTR urlBSTR;
86     if (FAILED(request->URL(&urlBSTR)))
87         return wstring();
88     
89     wstring url = urlSuitableForTestResult(wstringFromBSTR(urlBSTR));
90     ::SysFreeString(urlBSTR);
91
92     return L"<NSURLRequest " + url + L">";
93 }
94
95 static wstring descriptionSuitableForTestResult(IWebURLResponse* response)
96 {
97     if (!response)
98         return L"(null)";
99
100     BSTR urlBSTR;
101     if (FAILED(response->URL(&urlBSTR)))
102         return wstring();
103     
104     wstring url = urlSuitableForTestResult(wstringFromBSTR(urlBSTR));
105     ::SysFreeString(urlBSTR);
106
107     return L"<NSURLResponse " + url + L">";
108 }
109
110 static wstring descriptionSuitableForTestResult(IWebError* error, unsigned long identifier)
111 {
112     wstring result = L"<NSError ";
113
114     BSTR domainSTR;
115     if (FAILED(error->domain(&domainSTR)))
116         return wstring();
117
118     wstring domain = wstringFromBSTR(domainSTR);
119     ::SysFreeString(domainSTR);
120
121     int code;
122     if (FAILED(error->code(&code)))
123         return wstring();
124
125     if (domain == L"CFURLErrorDomain") {
126         domain = L"NSURLErrorDomain";
127
128         // Convert kCFURLErrorUnknown to NSURLErrorUnknown
129         if (code == -998)
130             code = -1;
131     } else if (domain == L"kCFErrorDomainWinSock") {
132         domain = L"NSURLErrorDomain";
133
134         // Convert the winsock error code to an NSURLError code.
135         if (code == WSAEADDRNOTAVAIL)
136             code = -1004; // NSURLErrorCannotConnectToHose;
137     }
138
139     result += L"domain " + domain;
140     result += L", code " + wstringFromInt(code);
141
142     BSTR failingURLSTR;
143     if (FAILED(error->failingURL(&failingURLSTR)))
144         return wstring();
145
146     wstring failingURL;
147     
148     // If the error doesn't have a failing URL, we fake one by using the URL the resource had 
149     // at creation time. This seems to work fine for now.
150     // See <rdar://problem/5064234> CFErrors should have failingURL key.
151     if (failingURLSTR)
152         failingURL = wstringFromBSTR(failingURLSTR);
153     else
154         failingURL = descriptionSuitableForTestResult(identifier);
155
156     ::SysFreeString(failingURLSTR);
157
158     result += L", failing URL \"" + urlSuitableForTestResult(failingURL) + L"\">";
159
160     return result;
161 }
162
163 ResourceLoadDelegate::ResourceLoadDelegate()
164     : m_refCount(1)
165 {
166 }
167
168 ResourceLoadDelegate::~ResourceLoadDelegate()
169 {
170 }
171
172 HRESULT STDMETHODCALLTYPE ResourceLoadDelegate::QueryInterface(REFIID riid, void** ppvObject)
173 {
174     *ppvObject = 0;
175     if (IsEqualGUID(riid, IID_IUnknown))
176         *ppvObject = static_cast<IWebResourceLoadDelegate*>(this);
177     else if (IsEqualGUID(riid, IID_IWebResourceLoadDelegate))
178         *ppvObject = static_cast<IWebResourceLoadDelegate*>(this);
179     else
180         return E_NOINTERFACE;
181
182     AddRef();
183     return S_OK;
184 }
185
186 ULONG STDMETHODCALLTYPE ResourceLoadDelegate::AddRef(void)
187 {
188     return ++m_refCount;
189 }
190
191 ULONG STDMETHODCALLTYPE ResourceLoadDelegate::Release(void)
192 {
193     ULONG newRef = --m_refCount;
194     if (!newRef)
195         delete(this);
196
197     return newRef;
198 }
199
200 HRESULT STDMETHODCALLTYPE ResourceLoadDelegate::identifierForInitialRequest( 
201     /* [in] */ IWebView* webView,
202     /* [in] */ IWebURLRequest* request,
203     /* [in] */ IWebDataSource* dataSource,
204     /* [in] */ unsigned long identifier)
205
206     if (!done && layoutTestController->dumpResourceLoadCallbacks()) {
207         BSTR urlStr;
208         if (FAILED(request->URL(&urlStr)))
209             return E_FAIL;
210
211         urlMap().set(identifier, wstringFromBSTR(urlStr));
212     }
213
214     return S_OK;
215 }
216
217 HRESULT STDMETHODCALLTYPE ResourceLoadDelegate::willSendRequest( 
218     /* [in] */ IWebView* webView,
219     /* [in] */ unsigned long identifier,
220     /* [in] */ IWebURLRequest* request,
221     /* [in] */ IWebURLResponse* redirectResponse,
222     /* [in] */ IWebDataSource* dataSource,
223     /* [retval][out] */ IWebURLRequest **newRequest)
224 {
225     if (!done && layoutTestController->dumpResourceLoadCallbacks()) {
226         printf("%S - willSendRequest %S redirectResponse %S\n", 
227             descriptionSuitableForTestResult(identifier).c_str(),
228             descriptionSuitableForTestResult(request).c_str(),
229             descriptionSuitableForTestResult(redirectResponse).c_str());
230     }
231
232     request->AddRef();
233     *newRequest = request;
234     return S_OK;
235 }
236
237 HRESULT STDMETHODCALLTYPE ResourceLoadDelegate::didFinishLoadingFromDataSource( 
238     /* [in] */ IWebView* webView,
239     /* [in] */ unsigned long identifier,
240     /* [in] */ IWebDataSource* dataSource)
241 {
242     if (!done && layoutTestController->dumpResourceLoadCallbacks()) {
243         printf("%S - didFinishLoading\n",
244             descriptionSuitableForTestResult(identifier).c_str()),
245        urlMap().remove(identifier);
246     }
247
248    return S_OK;
249 }
250         
251 HRESULT STDMETHODCALLTYPE ResourceLoadDelegate::didFailLoadingWithError( 
252     /* [in] */ IWebView* webView,
253     /* [in] */ unsigned long identifier,
254     /* [in] */ IWebError* error,
255     /* [in] */ IWebDataSource* dataSource)
256 {
257     if (!done && layoutTestController->dumpResourceLoadCallbacks()) {
258         printf("%S - didFailLoadingWithError: %S\n", 
259             descriptionSuitableForTestResult(identifier).c_str(),
260             descriptionSuitableForTestResult(error, identifier).c_str());
261         urlMap().remove(identifier);
262     }
263
264     return S_OK;
265 }