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