ReactOS 0.4.15-dev-7889-g76290a6
protocol.c
Go to the documentation of this file.
1/*
2 * Copyright 2007 Misha Koshelev
3 * Copyright 2009 Jacek Caban for CodeWeavers
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
18 */
19
20#include "urlmon_main.h"
21
22#include "wine/debug.h"
23
25
27{
28 return IInternetProtocolSink_ReportProgress(protocol->protocol_sink, status_code, status_text);
29}
30
32{
33 if (!(protocol->flags & FLAG_RESULT_REPORTED) && protocol->protocol_sink) {
35 IInternetProtocolSink_ReportResult(protocol->protocol_sink, hres, 0, NULL);
36 }
37
38 return hres;
39}
40
42{
43 DWORD bscf;
44
45 if((protocol->flags & FLAG_LAST_DATA_REPORTED) || !protocol->protocol_sink)
46 return;
47
49 bscf = BSCF_INTERMEDIATEDATANOTIFICATION;
50 }else {
52 bscf = BSCF_FIRSTDATANOTIFICATION;
53 }
54
57 bscf |= BSCF_LASTDATANOTIFICATION;
58 }
59
60 IInternetProtocolSink_ReportData(protocol->protocol_sink, bscf,
61 protocol->current_position+protocol->available_bytes,
62 protocol->content_length);
63}
64
66{
68
71}
72
74{
76
77 hres = protocol->vtbl->start_downloading(protocol);
78 if(FAILED(hres)) {
79 if(hres == INET_E_REDIRECT_FAILED)
80 return S_OK;
83 return hres;
84 }
85
86 if(protocol->bindf & BINDF_NEEDFILE) {
88 DWORD buflen = sizeof(cache_file);
89
91 report_progress(protocol, BINDSTATUS_CACHEFILENAMEAVAILABLE, cache_file);
92 }else {
93 FIXME("Could not get cache file\n");
94 }
95 }
96
98 return S_OK;
99}
100
102{
103 BOOL res;
105
106 protocol->flags |= FLAG_SYNC_READ;
107
109 if(FAILED(hres))
110 return hres;
111
112 res = InternetQueryDataAvailable(protocol->request, &protocol->query_available, 0, 0);
113 if(res)
114 protocol->available_bytes = protocol->query_available;
115 else
116 WARN("InternetQueryDataAvailable failed: %u\n", GetLastError());
117
119 IInternetProtocolSink_ReportData(protocol->protocol_sink, BSCF_LASTDATANOTIFICATION|BSCF_DATAFULLYAVAILABLE,
120 protocol->available_bytes, protocol->content_length);
121 return S_OK;
122}
123
125{
126 PROTOCOLDATA data;
127
128 TRACE("(%p)->(%p)\n", protocol, ar);
129
130 /* PROTOCOLDATA same as native */
131 memset(&data, 0, sizeof(data));
132 data.dwState = 0xf1000000;
133
134 if(ar->dwResult) {
136
137 if(!protocol->request) {
138 TRACE("setting request handle %p\n", (HINTERNET)ar->dwResult);
139 protocol->request = (HINTERNET)ar->dwResult;
140 }
141
143 data.pData = UlongToPtr(BINDSTATUS_ENDDOWNLOADCOMPONENTS);
144 else
145 data.pData = UlongToPtr(BINDSTATUS_DOWNLOADINGDATA);
146
147 }else {
148 protocol->flags |= FLAG_ERROR;
149 data.pData = UlongToPtr(ar->dwError);
150 }
151
152 if (protocol->bindf & BINDF_FROMURLMON)
153 IInternetProtocolSink_Switch(protocol->protocol_sink, &data);
154 else
156}
157
159 DWORD internet_status, LPVOID status_info, DWORD status_info_len)
160{
162
163 switch(internet_status) {
165 TRACE("%p INTERNET_STATUS_RESOLVING_NAME\n", protocol);
166 report_progress(protocol, BINDSTATUS_FINDINGRESOURCE, (LPWSTR)status_info);
167 break;
168
170 WCHAR *info;
171
172 TRACE("%p INTERNET_STATUS_CONNECTING_TO_SERVER %s\n", protocol, (const char*)status_info);
173
174 info = heap_strdupAtoW(status_info);
175 if(!info)
176 return;
177
178 report_progress(protocol, BINDSTATUS_CONNECTING, info);
180 break;
181 }
182
184 TRACE("%p INTERNET_STATUS_SENDING_REQUEST\n", protocol);
185 report_progress(protocol, BINDSTATUS_SENDINGREQUEST, (LPWSTR)status_info);
186 break;
187
189 TRACE("%p INTERNET_STATUS_REDIRECT\n", protocol);
190 report_progress(protocol, BINDSTATUS_REDIRECTING, (LPWSTR)status_info);
191 break;
192
194 request_complete(protocol, status_info);
195 break;
196
198 TRACE("%p INTERNET_STATUS_HANDLE_CREATED\n", protocol);
199 IInternetProtocol_AddRef(protocol->protocol);
200 break;
201
203 TRACE("%p INTERNET_STATUS_HANDLE_CLOSING\n", protocol);
204
205 if(*(HINTERNET *)status_info == protocol->request) {
206 protocol->request = NULL;
207 if(protocol->protocol_sink) {
208 IInternetProtocolSink_Release(protocol->protocol_sink);
209 protocol->protocol_sink = NULL;
210 }
211
212 if(protocol->bind_info.cbSize) {
213 ReleaseBindInfo(&protocol->bind_info);
214 memset(&protocol->bind_info, 0, sizeof(protocol->bind_info));
215 }
216 }else if(*(HINTERNET *)status_info == protocol->connection) {
217 protocol->connection = NULL;
218 }
219
220 IInternetProtocol_Release(protocol->protocol);
221 break;
222
223 default:
224 WARN("Unhandled Internet status callback %d\n", internet_status);
225 }
226}
227
229{
230 BYTE buf[0x20000];
231 DWORD written;
232 ULONG size;
233 BOOL res;
235
236 protocol->flags &= ~FLAG_REQUEST_COMPLETE;
237
238 while(1) {
239 size = 0;
240 hres = IStream_Read(protocol->post_stream, buf, sizeof(buf), &size);
241 if(FAILED(hres) || !size)
242 break;
243 res = InternetWriteFile(protocol->request, buf, size, &written);
244 if(!res) {
245 FIXME("InternetWriteFile failed: %u\n", GetLastError());
246 hres = E_FAIL;
247 break;
248 }
249 }
250
251 if(SUCCEEDED(hres)) {
252 IStream_Release(protocol->post_stream);
253 protocol->post_stream = NULL;
254
255 hres = protocol->vtbl->end_request(protocol);
256 }
257
258 if(FAILED(hres))
259 return report_result(protocol, hres);
260
261 return S_OK;
262}
263
265{
266 LPWSTR global_user_agent = NULL;
268 ULONG size = 0;
271
272 hres = IInternetBindInfo_GetBindString(bind_info, BINDSTRING_USER_AGENT, &user_agent, 1, &size);
273 if(hres != S_OK || !size)
274 global_user_agent = get_useragent();
275
276 ret = InternetOpenW(user_agent ? user_agent : global_user_agent, 0, NULL, NULL, INTERNET_FLAG_ASYNC);
277 heap_free(global_user_agent);
279 if(!ret) {
280 WARN("InternetOpen failed: %d\n", GetLastError());
281 return NULL;
282 }
283
285 return ret;
286}
287
289
291{
292 HINTERNET new_session;
293
295 return internet_session;
296
297 if(!bind_info)
298 return NULL;
299
300 new_session = create_internet_session(bind_info);
301 if(new_session && InterlockedCompareExchangePointer((void**)&internet_session, new_session, NULL))
302 InternetCloseHandle(new_session);
303
304 return internet_session;
305}
306
308{
311}
312
315{
316 DWORD request_flags;
318
319 protocol->protocol = prot;
320
321 IInternetProtocolSink_AddRef(protocol_sink);
322 protocol->protocol_sink = protocol_sink;
323
324 memset(&protocol->bind_info, 0, sizeof(protocol->bind_info));
325 protocol->bind_info.cbSize = sizeof(BINDINFO);
326 hres = IInternetBindInfo_GetBindInfo(bind_info, &protocol->bindf, &protocol->bind_info);
327 if(hres != S_OK) {
328 WARN("GetBindInfo failed: %08x\n", hres);
329 return report_result(protocol, hres);
330 }
331
332 if(!(protocol->bindf & BINDF_FROMURLMON))
333 report_progress(protocol, BINDSTATUS_DIRECTBIND, NULL);
334
336 return report_result(protocol, INET_E_NO_SESSION);
337
338 request_flags = INTERNET_FLAG_KEEP_CONNECTION;
339 if(protocol->bindf & BINDF_NOWRITECACHE)
340 request_flags |= INTERNET_FLAG_NO_CACHE_WRITE;
341 if(protocol->bindf & BINDF_NEEDFILE)
342 request_flags |= INTERNET_FLAG_NEED_FILE;
343 if(protocol->bind_info.dwOptions & BINDINFO_OPTIONS_DISABLEAUTOREDIRECTS)
344 request_flags |= INTERNET_FLAG_NO_AUTO_REDIRECT;
345
346 hres = protocol->vtbl->open_request(protocol, uri, request_flags, internet_session, bind_info);
347 if(FAILED(hres)) {
349 return report_result(protocol, hres);
350 }
351
352 return S_OK;
353}
354
356{
357 BOOL is_start;
359
360 is_start = !data || data->pData == UlongToPtr(BINDSTATUS_DOWNLOADINGDATA);
361
362 if(!protocol->request) {
363 WARN("Expected request to be non-NULL\n");
364 return S_OK;
365 }
366
367 if(!protocol->protocol_sink) {
368 WARN("Expected IInternetProtocolSink pointer to be non-NULL\n");
369 return S_OK;
370 }
371
372 if(protocol->flags & FLAG_ERROR) {
373 protocol->flags &= ~FLAG_ERROR;
374 protocol->vtbl->on_error(protocol, PtrToUlong(data->pData));
375 return S_OK;
376 }
377
378 if(protocol->post_stream)
380
381 if(is_start) {
383 if(FAILED(hres))
384 return S_OK;
385 }
386
387 if(!data || data->pData >= UlongToPtr(BINDSTATUS_DOWNLOADINGDATA)) {
388 if(!protocol->available_bytes) {
389 if(protocol->query_available) {
390 protocol->available_bytes = protocol->query_available;
391 }else {
392 BOOL res;
393
394 /* InternetQueryDataAvailable may immediately fork and perform its asynchronous
395 * read, so clear the flag _before_ calling so it does not incorrectly get cleared
396 * after the status callback is called */
397 protocol->flags &= ~FLAG_REQUEST_COMPLETE;
398 res = InternetQueryDataAvailable(protocol->request, &protocol->query_available, 0, 0);
399 if(res) {
400 TRACE("available %u bytes\n", protocol->query_available);
401 if(!protocol->query_available) {
403 return S_OK;
404 }
405 protocol->available_bytes = protocol->query_available;
406 }else if(GetLastError() != ERROR_IO_PENDING) {
408 WARN("InternetQueryDataAvailable failed: %d\n", GetLastError());
409 report_result(protocol, INET_E_DATA_NOT_AVAILABLE);
410 return S_OK;
411 }
412 }
413
415 }
416
418 }
419
420 return S_OK;
421}
422
424{
425 ULONG read = 0;
426 BOOL res;
428
429 if(protocol->flags & FLAG_ALL_DATA_READ) {
430 *read_ret = 0;
431 return S_FALSE;
432 }
433
434 if(!(protocol->flags & FLAG_SYNC_READ) && (!(protocol->flags & FLAG_REQUEST_COMPLETE) || !protocol->available_bytes)) {
435 *read_ret = 0;
436 return E_PENDING;
437 }
438
439 while(read < size && protocol->available_bytes) {
440 ULONG len;
441
442 res = InternetReadFile(protocol->request, ((BYTE *)buf)+read,
443 protocol->available_bytes > size-read ? size-read : protocol->available_bytes, &len);
444 if(!res) {
445 WARN("InternetReadFile failed: %d\n", GetLastError());
446 hres = INET_E_DOWNLOAD_FAILURE;
448 break;
449 }
450
451 if(!len) {
453 break;
454 }
455
456 read += len;
457 protocol->current_position += len;
458 protocol->available_bytes -= len;
459
460 TRACE("current_position %d, available_bytes %d\n", protocol->current_position, protocol->available_bytes);
461
462 if(!protocol->available_bytes) {
463 /* InternetQueryDataAvailable may immediately fork and perform its asynchronous
464 * read, so clear the flag _before_ calling so it does not incorrectly get cleared
465 * after the status callback is called */
466 protocol->flags &= ~FLAG_REQUEST_COMPLETE;
467 res = InternetQueryDataAvailable(protocol->request, &protocol->query_available, 0, 0);
468 if(!res) {
470 hres = E_PENDING;
471 }else {
472 WARN("InternetQueryDataAvailable failed: %d\n", GetLastError());
473 hres = INET_E_DATA_NOT_AVAILABLE;
475 }
476 break;
477 }
478
479 if(!protocol->query_available) {
481 break;
482 }
483
484 protocol->available_bytes = protocol->query_available;
485 }
486 }
487
488 *read_ret = read;
489
490 if (hres != E_PENDING)
492 if(FAILED(hres))
493 return hres;
494
495 return read ? S_OK : S_FALSE;
496}
497
499{
500 if (!InternetLockRequestFile(protocol->request, &protocol->lock))
501 WARN("InternetLockRequest failed: %d\n", GetLastError());
502
503 return S_OK;
504}
505
507{
508 if(!protocol->lock)
509 return S_OK;
510
512 WARN("InternetUnlockRequest failed: %d\n", GetLastError());
513 protocol->lock = 0;
514
515 return S_OK;
516}
517
519{
520 if(!protocol->protocol_sink)
521 return S_OK;
522
523 /* NOTE: IE10 returns S_OK here */
524 if(protocol->flags & FLAG_RESULT_REPORTED)
525 return INET_E_RESULT_DISPATCHED;
526
528 return S_OK;
529}
530
532{
533 protocol->vtbl->close_connection(protocol);
534
535 if(protocol->request)
537
538 if(protocol->connection)
539 InternetCloseHandle(protocol->connection);
540
541 if(protocol->post_stream) {
542 IStream_Release(protocol->post_stream);
543 protocol->post_stream = NULL;
544 }
545
546 protocol->flags = 0;
547}
#define read
Definition: acwin.h:96
static WCHAR * heap_strdupAtoW(const char *str)
Definition: appwiz.h:81
static BOOL heap_free(void *mem)
Definition: appwiz.h:76
#define WINE_DEFAULT_DEBUG_CHANNEL(t)
Definition: precomp.h:23
#define FIXME(fmt,...)
Definition: debug.h:111
#define WARN(fmt,...)
Definition: debug.h:112
#define ERROR_IO_PENDING
Definition: dderror.h:15
#define E_FAIL
Definition: ddrawi.h:102
#define E_PENDING
Definition: dinput.h:172
#define NULL
Definition: types.h:112
static WCHAR reason[MAX_STRING_RESOURCE_LEN]
Definition: object.c:1904
#define MAX_PATH
Definition: compat.h:34
#define lstrlenW
Definition: compat.h:750
static HRESULT report_result(MimeHtmlProtocol *protocol, HRESULT result)
Definition: protocol.c:105
static void request_complete(Protocol *protocol, INTERNET_ASYNC_RESULT *ar)
Definition: protocol.c:124
HRESULT protocol_syncbinding(Protocol *protocol)
Definition: protocol.c:101
static void report_data(Protocol *protocol)
Definition: protocol.c:41
static void all_data_read(Protocol *protocol)
Definition: protocol.c:65
HRESULT protocol_lock_request(Protocol *protocol)
Definition: protocol.c:498
HRESULT protocol_abort(Protocol *protocol, HRESULT reason)
Definition: protocol.c:518
static HINTERNET create_internet_session(IInternetBindInfo *bind_info)
Definition: protocol.c:264
HINTERNET get_internet_session(IInternetBindInfo *bind_info)
Definition: protocol.c:290
static HRESULT write_post_stream(Protocol *protocol)
Definition: protocol.c:228
void update_user_agent(WCHAR *user_agent)
Definition: protocol.c:307
void protocol_close_connection(Protocol *protocol)
Definition: protocol.c:531
static void WINAPI internet_status_callback(HINTERNET internet, DWORD_PTR context, DWORD internet_status, LPVOID status_info, DWORD status_info_len)
Definition: protocol.c:158
static HRESULT start_downloading(Protocol *protocol)
Definition: protocol.c:73
HRESULT protocol_unlock_request(Protocol *protocol)
Definition: protocol.c:506
static HINTERNET internet_session
Definition: protocol.c:288
HRESULT protocol_continue(Protocol *protocol, PROTOCOLDATA *data)
Definition: protocol.c:355
static HRESULT report_progress(Protocol *protocol, ULONG status_code, LPCWSTR status_text)
Definition: protocol.c:26
LPWSTR get_useragent(void)
Definition: session.c:609
static LPWSTR user_agent
Definition: session.c:520
BOOL WINAPI InternetQueryOptionW(HINTERNET hInternet, DWORD dwOption, LPVOID lpBuffer, LPDWORD lpdwBufferLength)
Definition: internet.c:2697
BOOL WINAPI InternetWriteFile(HINTERNET hFile, LPCVOID lpBuffer, DWORD dwNumOfBytesToWrite, LPDWORD lpdwNumOfBytesWritten)
Definition: internet.c:2114
BOOL WINAPI InternetLockRequestFile(HINTERNET hInternet, HANDLE *lphLockReqHandle)
Definition: internet.c:4032
BOOL WINAPI InternetUnlockRequestFile(HANDLE hLockHandle)
Definition: internet.c:4061
BOOL WINAPI InternetReadFile(HINTERNET hFile, LPVOID lpBuffer, DWORD dwNumOfBytesToRead, LPDWORD pdwNumOfBytesRead)
Definition: internet.c:2154
INTERNET_STATUS_CALLBACK WINAPI InternetSetStatusCallbackW(HINTERNET hInternet, INTERNET_STATUS_CALLBACK lpfnIntCB)
Definition: internet.c:2075
BOOL WINAPI InternetCloseHandle(HINTERNET hInternet)
Definition: internet.c:1414
BOOL WINAPI InternetQueryDataAvailable(HINTERNET hFile, LPDWORD lpdwNumberOfBytesAvailable, DWORD dwFlags, DWORD_PTR dwContext)
Definition: internet.c:3959
HINTERNET WINAPI InternetOpenW(LPCWSTR lpszAgent, DWORD dwAccessType, LPCWSTR lpszProxy, LPCWSTR lpszProxyBypass, DWORD dwFlags)
Definition: internet.c:979
BOOL WINAPI InternetSetOptionW(HINTERNET hInternet, DWORD dwOption, LPVOID lpBuffer, DWORD dwBufferLength)
Definition: internet.c:2837
#define UlongToPtr(u)
Definition: config.h:106
#define PtrToUlong(u)
Definition: config.h:107
unsigned int BOOL
Definition: ntddk_ex.h:94
unsigned long DWORD
Definition: ntddk_ex.h:95
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: gl.h:1950
GLsizeiptr size
Definition: glext.h:5919
GLuint res
Definition: glext.h:9613
GLenum GLuint GLenum GLsizei const GLchar * buf
Definition: glext.h:7751
GLenum GLsizei len
Definition: glext.h:6722
VOID WINAPI CoTaskMemFree(LPVOID ptr)
Definition: ifs.c:442
#define InterlockedCompareExchangePointer
Definition: interlocked.h:129
#define S_OK
Definition: intsafe.h:52
#define SUCCEEDED(hr)
Definition: intsafe.h:50
#define FAILED(hr)
Definition: intsafe.h:51
static IInternetProtocolSink protocol_sink
Definition: mimeole.c:1411
static IInternetBindInfo bind_info
Definition: mimeole.c:1273
HRESULT hres
Definition: protocol.c:465
#define protocol_start(p, u, e)
Definition: protocol.c:303
static const WCHAR * cache_file
Definition: protocol.c:102
static int protocol_read
Definition: htmldoc.c:205
static LPOLESTR
Definition: stg_prop.c:27
const char * uri
Definition: sec_mgr.c:1588
#define memset(x, y, z)
Definition: compat.h:39
#define TRACE(s)
Definition: solgame.cpp:4
DWORD_PTR dwResult
Definition: wininet.h:155
Definition: http.c:7252
uint32_t DWORD_PTR
Definition: typedefs.h:65
uint32_t ULONG
Definition: typedefs.h:59
void WINAPI ReleaseBindInfo(BINDINFO *pbindinfo)
Definition: urlmon_main.c:572
#define FLAG_REQUEST_COMPLETE
Definition: urlmon_main.h:152
#define FLAG_FIRST_DATA_REPORTED
Definition: urlmon_main.h:154
#define FLAG_LAST_DATA_REPORTED
Definition: urlmon_main.h:156
#define FLAG_FIRST_CONTINUE_COMPLETE
Definition: urlmon_main.h:153
#define FLAG_SYNC_READ
Definition: urlmon_main.h:159
#define FLAG_ERROR
Definition: urlmon_main.h:158
#define FLAG_RESULT_REPORTED
Definition: urlmon_main.h:157
#define FLAG_ALL_DATA_READ
Definition: urlmon_main.h:155
int ret
DWORD WINAPI GetLastError(void)
Definition: except.c:1042
#define WINAPI
Definition: msvc.h:6
#define S_FALSE
Definition: winerror.h:2357
LPVOID HINTERNET
Definition: winhttp.h:32
#define INTERNET_FLAG_NO_AUTO_REDIRECT
Definition: wininet.h:73
#define INTERNET_FLAG_ASYNC
Definition: wininet.h:64
#define INTERNET_FLAG_KEEP_CONNECTION
Definition: wininet.h:72
#define INTERNET_OPTION_USER_AGENT
Definition: wininet.h:735
#define INTERNET_STATUS_SENDING_REQUEST
Definition: wininet.h:887
#define INTERNET_OPTION_DATAFILE_NAME
Definition: wininet.h:727
#define INTERNET_STATUS_HANDLE_CLOSING
Definition: wininet.h:896
#define INTERNET_FLAG_NEED_FILE
Definition: wininet.h:88
#define INTERNET_STATUS_RESOLVING_NAME
Definition: wininet.h:883
#define INTERNET_FLAG_NO_CACHE_WRITE
Definition: wininet.h:66
#define INTERNET_STATUS_REDIRECT
Definition: wininet.h:899
#define INTERNET_STATUS_REQUEST_COMPLETE
Definition: wininet.h:898
#define INTERNET_STATUS_CONNECTING_TO_SERVER
Definition: wininet.h:885
#define INTERNET_STATUS_HANDLE_CREATED
Definition: wininet.h:895
__wchar_t WCHAR
Definition: xmlstorage.h:180
WCHAR * LPWSTR
Definition: xmlstorage.h:184
const WCHAR * LPCWSTR
Definition: xmlstorage.h:185
unsigned char BYTE
Definition: xxhash.c:193