OLD | NEW |
| (Empty) |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 #include "chrome_frame/urlmon_bind_status_callback.h" | |
6 | |
7 #include <mshtml.h> | |
8 #include <shlguid.h> | |
9 | |
10 #include "base/logging.h" | |
11 #include "base/strings/string_util.h" | |
12 #include "base/strings/stringprintf.h" | |
13 #include "base/strings/utf_string_conversions.h" | |
14 #include "base/threading/platform_thread.h" | |
15 #include "chrome_frame/bind_context_info.h" | |
16 #include "chrome_frame/chrome_tab.h" | |
17 #include "chrome_frame/exception_barrier.h" | |
18 #include "chrome_frame/urlmon_moniker.h" | |
19 | |
20 | |
21 // A helper to given feed data to the specified |bscb| using | |
22 // CacheStream instance. | |
23 HRESULT CacheStream::BSCBFeedData(IBindStatusCallback* bscb, const char* data, | |
24 size_t size, CLIPFORMAT clip_format, | |
25 size_t flags, bool eof) { | |
26 if (!bscb) { | |
27 NOTREACHED() << "invalid IBindStatusCallback"; | |
28 return E_INVALIDARG; | |
29 } | |
30 | |
31 // We can't use a CComObjectStackEx here since mshtml will hold | |
32 // onto the stream pointer. | |
33 CComObject<CacheStream>* cache_stream = NULL; | |
34 HRESULT hr = CComObject<CacheStream>::CreateInstance(&cache_stream); | |
35 if (FAILED(hr)) { | |
36 NOTREACHED(); | |
37 return hr; | |
38 } | |
39 | |
40 scoped_refptr<CacheStream> cache_ref = cache_stream; | |
41 hr = cache_stream->Initialize(data, size, eof); | |
42 if (FAILED(hr)) | |
43 return hr; | |
44 | |
45 FORMATETC format_etc = { clip_format, NULL, DVASPECT_CONTENT, -1, | |
46 TYMED_ISTREAM }; | |
47 STGMEDIUM medium = {0}; | |
48 medium.tymed = TYMED_ISTREAM; | |
49 medium.pstm = cache_stream; | |
50 | |
51 hr = bscb->OnDataAvailable(flags, size, &format_etc, &medium); | |
52 return hr; | |
53 } | |
54 | |
55 HRESULT CacheStream::Initialize(const char* cache, size_t size, bool eof) { | |
56 position_ = 0; | |
57 eof_ = eof; | |
58 | |
59 HRESULT hr = S_OK; | |
60 cache_.reset(new char[size]); | |
61 if (cache_.get()) { | |
62 memcpy(cache_.get(), cache, size); | |
63 size_ = size; | |
64 } else { | |
65 DLOG(ERROR) << "failed to allocate cache stream."; | |
66 hr = E_OUTOFMEMORY; | |
67 } | |
68 | |
69 return hr; | |
70 } | |
71 | |
72 // Read is the only call that we expect. Return E_PENDING if there | |
73 // is no more data to serve. Otherwise this will result in a | |
74 // read with 0 bytes indicating that no more data is available. | |
75 STDMETHODIMP CacheStream::Read(void* pv, ULONG cb, ULONG* read) { | |
76 if (!pv || !read) | |
77 return E_INVALIDARG; | |
78 | |
79 if (!cache_.get()) { | |
80 *read = 0; | |
81 return S_FALSE; | |
82 } | |
83 | |
84 // Default to E_PENDING to signal that this is a partial data. | |
85 HRESULT hr = eof_ ? S_FALSE : E_PENDING; | |
86 if (position_ < size_) { | |
87 *read = std::min(size_ - position_, size_t(cb)); | |
88 memcpy(pv, cache_ .get() + position_, *read); | |
89 position_ += *read; | |
90 hr = S_OK; | |
91 } | |
92 | |
93 return hr; | |
94 } | |
95 | |
96 | |
97 ///////////////////////////////////////////////////////////////////// | |
98 | |
99 HRESULT SniffData::InitializeCache(const std::wstring& url) { | |
100 url_ = url; | |
101 renderer_type_ = UNDETERMINED; | |
102 | |
103 const int kInitialSize = 4 * 1024; // 4K | |
104 HGLOBAL mem = GlobalAlloc(0, kInitialSize); | |
105 DCHECK(mem) << "GlobalAlloc failed: " << GetLastError(); | |
106 | |
107 HRESULT hr = CreateStreamOnHGlobal(mem, TRUE, cache_.Receive()); | |
108 if (SUCCEEDED(hr)) { | |
109 ULARGE_INTEGER size = {0}; | |
110 cache_->SetSize(size); | |
111 } else { | |
112 DLOG(ERROR) << "CreateStreamOnHGlobal failed: " << hr; | |
113 } | |
114 | |
115 return hr; | |
116 } | |
117 | |
118 HRESULT SniffData::ReadIntoCache(IStream* stream, bool force_determination) { | |
119 if (!stream) { | |
120 NOTREACHED(); | |
121 return E_INVALIDARG; | |
122 } | |
123 | |
124 HRESULT hr = S_OK; | |
125 while (SUCCEEDED(hr)) { | |
126 const size_t kChunkSize = 4 * 1024; | |
127 char buffer[kChunkSize]; | |
128 DWORD read = 0; | |
129 hr = stream->Read(buffer, sizeof(buffer), &read); | |
130 if (read) { | |
131 DWORD written = 0; | |
132 cache_->Write(buffer, read, &written); | |
133 size_ += written; | |
134 } | |
135 | |
136 if ((S_FALSE == hr) || !read) | |
137 break; | |
138 } | |
139 | |
140 bool last_chance = force_determination || (size() >= kMaxSniffSize); | |
141 eof_ = force_determination; | |
142 DetermineRendererType(last_chance); | |
143 return hr; | |
144 } | |
145 | |
146 HRESULT SniffData::DrainCache(IBindStatusCallback* bscb, DWORD bscf, | |
147 CLIPFORMAT clip_format) { | |
148 if (!is_cache_valid()) { | |
149 return S_OK; | |
150 } | |
151 | |
152 // Ideally we could just use the cache_ IStream implementation but | |
153 // can't use it here since we have to return E_PENDING for the | |
154 // last call | |
155 HGLOBAL memory = NULL; | |
156 HRESULT hr = GetHGlobalFromStream(cache_, &memory); | |
157 if (SUCCEEDED(hr) && memory) { | |
158 char* buffer = reinterpret_cast<char*>(GlobalLock(memory)); | |
159 hr = CacheStream::BSCBFeedData(bscb, buffer, size_, clip_format, bscf, | |
160 eof_); | |
161 GlobalUnlock(memory); | |
162 } | |
163 | |
164 size_ = 0; | |
165 cache_.Release(); | |
166 return hr; | |
167 } | |
168 | |
169 // Scan the buffer or OptIn URL list and decide if the renderer is | |
170 // to be switched. Last chance means there's no more data. | |
171 void SniffData::DetermineRendererType(bool last_chance) { | |
172 if (is_undetermined()) { | |
173 if (last_chance) | |
174 renderer_type_ = OTHER; | |
175 if (IsChrome(RendererTypeForUrl(url_))) { | |
176 renderer_type_ = CHROME; | |
177 } else { | |
178 if (is_cache_valid() && cache_) { | |
179 HGLOBAL memory = NULL; | |
180 GetHGlobalFromStream(cache_, &memory); | |
181 const char* buffer = reinterpret_cast<const char*>(GlobalLock(memory)); | |
182 | |
183 std::wstring html_contents; | |
184 // TODO(joshia): detect and handle different content encodings | |
185 if (buffer && size_) { | |
186 base::UTF8ToWide(buffer, std::min(size_, kMaxSniffSize), | |
187 &html_contents); | |
188 GlobalUnlock(memory); | |
189 } | |
190 | |
191 // Note that document_contents_ may have NULL characters in it. While | |
192 // browsers may handle this properly, we don't and will stop scanning | |
193 // for the XUACompat content value if we encounter one. | |
194 std::wstring xua_compat_content; | |
195 UtilGetXUACompatContentValue(html_contents, &xua_compat_content); | |
196 if (StrStrI(xua_compat_content.c_str(), kChromeContentPrefix)) { | |
197 renderer_type_ = CHROME; | |
198 } | |
199 } | |
200 } | |
201 DVLOG(1) << __FUNCTION__ << "Url: " << url_ << base::StringPrintf( | |
202 "Renderer type: %s", renderer_type_ == CHROME ? "CHROME" : "OTHER"); | |
203 } | |
204 } | |
205 | |
206 ///////////////////////////////////////////////////////////////////// | |
207 | |
208 BSCBStorageBind::BSCBStorageBind() : clip_format_(CF_NULL) { | |
209 } | |
210 | |
211 BSCBStorageBind::~BSCBStorageBind() { | |
212 std::for_each(saved_progress_.begin(), saved_progress_.end(), | |
213 utils::DeleteObject()); | |
214 } | |
215 | |
216 HRESULT BSCBStorageBind::Initialize(IMoniker* moniker, IBindCtx* bind_ctx) { | |
217 DVLOG(1) << __FUNCTION__ << me() | |
218 << base::StringPrintf(" tid=%i", base::PlatformThread::CurrentId()); | |
219 | |
220 std::wstring url = GetActualUrlFromMoniker(moniker, bind_ctx, | |
221 std::wstring()); | |
222 HRESULT hr = data_sniffer_.InitializeCache(url); | |
223 if (FAILED(hr)) | |
224 return hr; | |
225 | |
226 hr = AttachToBind(bind_ctx); | |
227 if (FAILED(hr)) { | |
228 NOTREACHED() << __FUNCTION__ << me() << "AttachToBind error: " << hr; | |
229 return hr; | |
230 } | |
231 | |
232 if (!delegate()) { | |
233 NOTREACHED() << __FUNCTION__ << me() << "No existing callback: " << hr; | |
234 return E_FAIL; | |
235 } | |
236 | |
237 return hr; | |
238 } | |
239 | |
240 STDMETHODIMP BSCBStorageBind::OnProgress(ULONG progress, ULONG progress_max, | |
241 ULONG status_code, LPCWSTR status_text) { | |
242 DVLOG(1) << __FUNCTION__ << me() | |
243 << base::StringPrintf(" status=%i tid=%i %ls", status_code, | |
244 base::PlatformThread::CurrentId(), | |
245 status_text); | |
246 // Report all crashes in the exception handler if we wrap the callback. | |
247 // Note that this avoids having the VEH report a crash if an SEH earlier in | |
248 // the chain handles the exception. | |
249 ExceptionBarrier barrier; | |
250 | |
251 HRESULT hr = S_OK; | |
252 | |
253 // TODO(ananta) | |
254 // ChromeFrame will not be informed of any redirects which occur while we | |
255 // switch into Chrome. This will only break the moniker patch which is | |
256 // legacy and needs to be deleted. | |
257 | |
258 if (ShouldCacheProgress(status_code)) { | |
259 saved_progress_.push_back(new Progress(progress, progress_max, status_code, | |
260 status_text)); | |
261 } else { | |
262 hr = CallbackImpl::OnProgress(progress, progress_max, status_code, | |
263 status_text); | |
264 } | |
265 | |
266 return hr; | |
267 } | |
268 | |
269 // Refer to urlmon_moniker.h for explanation of how things work. | |
270 STDMETHODIMP BSCBStorageBind::OnDataAvailable(DWORD flags, DWORD size, | |
271 FORMATETC* format_etc, | |
272 STGMEDIUM* stgmed) { | |
273 DVLOG(1) << __FUNCTION__ | |
274 << base::StringPrintf(" tid=%i", base::PlatformThread::CurrentId()); | |
275 // Report all crashes in the exception handler if we wrap the callback. | |
276 // Note that this avoids having the VEH report a crash if an SEH earlier in | |
277 // the chain handles the exception. | |
278 ExceptionBarrier barrier; | |
279 // Do not touch anything other than text/html. | |
280 bool is_interesting = (format_etc && stgmed && stgmed->pstm && | |
281 stgmed->tymed == TYMED_ISTREAM && | |
282 IsTextHtmlClipFormat(format_etc->cfFormat)); | |
283 | |
284 if (!is_interesting) { | |
285 // Play back report progress so far. | |
286 MayPlayBack(flags); | |
287 return CallbackImpl::OnDataAvailable(flags, size, format_etc, stgmed); | |
288 } | |
289 | |
290 HRESULT hr = S_OK; | |
291 if (!clip_format_) | |
292 clip_format_ = format_etc->cfFormat; | |
293 | |
294 if (data_sniffer_.is_undetermined()) { | |
295 bool force_determination = !!(flags & | |
296 (BSCF_LASTDATANOTIFICATION | BSCF_DATAFULLYAVAILABLE)); | |
297 hr = data_sniffer_.ReadIntoCache(stgmed->pstm, force_determination); | |
298 // If we don't have sufficient data to determine renderer type | |
299 // wait for the next data notification. | |
300 if (data_sniffer_.is_undetermined()) | |
301 return S_OK; | |
302 } | |
303 | |
304 DCHECK(!data_sniffer_.is_undetermined()); | |
305 | |
306 if (data_sniffer_.is_cache_valid()) { | |
307 hr = MayPlayBack(flags); | |
308 DCHECK(!data_sniffer_.is_cache_valid()); | |
309 } else { | |
310 hr = CallbackImpl::OnDataAvailable(flags, size, format_etc, stgmed); | |
311 } | |
312 return hr; | |
313 } | |
314 | |
315 STDMETHODIMP BSCBStorageBind::OnStopBinding(HRESULT hresult, LPCWSTR error) { | |
316 DVLOG(1) << __FUNCTION__ | |
317 << base::StringPrintf(" tid=%i", base::PlatformThread::CurrentId()); | |
318 // Report all crashes in the exception handler if we wrap the callback. | |
319 // Note that this avoids having the VEH report a crash if an SEH earlier in | |
320 // the chain handles the exception. | |
321 ExceptionBarrier barrier; | |
322 | |
323 HRESULT hr = MayPlayBack(BSCF_LASTDATANOTIFICATION); | |
324 if (FAILED(hr)) | |
325 return hr; | |
326 hr = CallbackImpl::OnStopBinding(hresult, error); | |
327 ReleaseBind(); | |
328 return hr; | |
329 } | |
330 | |
331 // Play back the cached data to the delegate. Normally this would happen | |
332 // when we have read enough data to determine the renderer. In this case | |
333 // we first play back the data from the cache and then go into a 'pass | |
334 // through' mode. In some cases we may end up getting OnStopBinding | |
335 // before we get a chance to determine. Also it's possible that the | |
336 // BindToStorage call will return before OnStopBinding is sent. Hence | |
337 // This is called from 3 places and it's important to maintain the | |
338 // exact sequence of calls. | |
339 // Once the data is played back, calling this again is a no op. | |
340 HRESULT BSCBStorageBind::MayPlayBack(DWORD flags) { | |
341 // Force renderer type determination if not already done since | |
342 // we want to play back data now. | |
343 data_sniffer_.DetermineRendererType(true); | |
344 DCHECK(!data_sniffer_.is_undetermined()); | |
345 | |
346 HRESULT hr = S_OK; | |
347 if (data_sniffer_.is_chrome()) { | |
348 // Remember clip format. If we are switching to chrome, then in order | |
349 // to make mshtml return INET_E_TERMINATED_BIND and reissue navigation | |
350 // with the same bind context, we have to return a mime type that is | |
351 // special cased by mshtml. | |
352 static const CLIPFORMAT kMagicClipFormat = | |
353 RegisterClipboardFormat(CFSTR_MIME_MPEG); | |
354 clip_format_ = kMagicClipFormat; | |
355 } else { | |
356 if (!saved_progress_.empty()) { | |
357 for (ProgressVector::iterator i = saved_progress_.begin(); | |
358 i != saved_progress_.end(); i++) { | |
359 Progress* p = (*i); | |
360 // We don't really expect a race condition here but just for sake | |
361 // of completeness we check. | |
362 if (p) { | |
363 (*i) = NULL; | |
364 CallbackImpl::OnProgress(p->progress(), p->progress_max(), | |
365 p->status_code(), p->status_text()); | |
366 delete p; | |
367 } | |
368 } | |
369 saved_progress_.clear(); | |
370 } | |
371 } | |
372 | |
373 if (data_sniffer_.is_cache_valid()) { | |
374 if (data_sniffer_.is_chrome()) { | |
375 base::win::ScopedComPtr<BindContextInfo> info; | |
376 BindContextInfo::FromBindContext(bind_ctx_, info.Receive()); | |
377 DCHECK(info); | |
378 if (info) { | |
379 info->SetToSwitch(data_sniffer_.cache_); | |
380 } | |
381 } | |
382 | |
383 hr = data_sniffer_.DrainCache(delegate(), | |
384 flags | BSCF_FIRSTDATANOTIFICATION, clip_format_); | |
385 DLOG_IF(WARNING, INET_E_TERMINATED_BIND != hr) << __FUNCTION__ << | |
386 " mshtml OnDataAvailable returned: " << std::hex << hr; | |
387 } | |
388 | |
389 return hr; | |
390 } | |
391 | |
392 // We cache and suppress sending progress notifications till | |
393 // we get the first OnDataAvailable. This is to prevent | |
394 // mshtml from making up its mind about the mime type. | |
395 // However, this is the invasive part of the patch and | |
396 // could trip other software that's due to mistimed progress | |
397 // notifications. It is probably not a good idea to hide redirects | |
398 // and some cookie notifications. | |
399 // | |
400 // We only need to suppress data notifications like | |
401 // BINDSTATUS_MIMETYPEAVAILABLE, | |
402 // BINDSTATUS_CACHEFILENAMEAVAILABLE etc. | |
403 // | |
404 // This is an atempt to reduce the exposure by starting to | |
405 // cache only when we receive one of the interesting progress | |
406 // notification. | |
407 bool BSCBStorageBind::ShouldCacheProgress(unsigned long status_code) const { | |
408 // We need to cache progress notifications only if we haven't yet figured | |
409 // out which way the request is going. | |
410 if (data_sniffer_.is_undetermined()) { | |
411 // If we are already caching then continue. | |
412 if (!saved_progress_.empty()) | |
413 return true; | |
414 // Start caching only if we see one of the interesting progress | |
415 // notifications. | |
416 switch (status_code) { | |
417 case BINDSTATUS_BEGINDOWNLOADDATA: | |
418 case BINDSTATUS_DOWNLOADINGDATA: | |
419 case BINDSTATUS_USINGCACHEDCOPY: | |
420 case BINDSTATUS_MIMETYPEAVAILABLE: | |
421 case BINDSTATUS_CACHEFILENAMEAVAILABLE: | |
422 case BINDSTATUS_SERVER_MIMETYPEAVAILABLE: | |
423 return true; | |
424 default: | |
425 break; | |
426 } | |
427 } | |
428 | |
429 return false; | |
430 } | |
OLD | NEW |