quartz: Remove unused variables.
[wine] / dlls / wininet / internet.h
1 /*
2  * Wininet
3  *
4  * Copyright 1999 Corel Corporation
5  *
6  * Ulrich Czekalla
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21  */
22
23 #ifndef _WINE_INTERNET_H_
24 #define _WINE_INTERNET_H_
25
26 #ifndef __WINE_CONFIG_H
27 # error You must include config.h to use this header
28 #endif
29
30 #include "wine/unicode.h"
31 #include "wine/list.h"
32
33 #include <time.h>
34 #ifdef HAVE_NETDB_H
35 # include <netdb.h>
36 #endif
37 #ifdef HAVE_NETINET_IN_H
38 # include <sys/types.h>
39 # include <netinet/in.h>
40 #endif
41 #ifdef HAVE_SYS_SOCKET_H
42 # include <sys/socket.h>
43 #endif
44
45 #if !defined(__MINGW32__) && !defined(_MSC_VER)
46 #define closesocket close
47 #define ioctlsocket ioctl
48 #endif /* __MINGW32__ */
49
50 #include "winineti.h"
51
52 extern HMODULE WININET_hModule DECLSPEC_HIDDEN;
53
54 #ifndef INET6_ADDRSTRLEN
55 #define INET6_ADDRSTRLEN 46
56 #endif
57
58 typedef struct {
59     WCHAR *name;
60     INTERNET_PORT port;
61     BOOL is_https;
62     struct sockaddr_storage addr;
63     socklen_t addr_len;
64     char addr_str[INET6_ADDRSTRLEN];
65
66     WCHAR *scheme_host_port;
67     const WCHAR *host_port;
68     const WCHAR *canon_host_port;
69
70     LONG ref;
71
72     DWORD security_flags;
73     const CERT_CHAIN_CONTEXT *cert_chain;
74
75     struct list entry;
76     struct list conn_pool;
77 } server_t;
78
79 void server_addref(server_t*) DECLSPEC_HIDDEN;
80 void server_release(server_t*) DECLSPEC_HIDDEN;
81
82 typedef enum {
83     COLLECT_TIMEOUT,
84     COLLECT_CONNECTIONS,
85     COLLECT_CLEANUP
86 } collect_type_t;
87 BOOL collect_connections(collect_type_t) DECLSPEC_HIDDEN;
88
89 /* used for netconnection.c stuff */
90 typedef struct
91 {
92     BOOL useSSL;
93     int socketFD;
94     void *ssl_s;
95     server_t *server;
96     DWORD security_flags;
97     BOOL mask_errors;
98
99     BOOL keep_alive;
100     DWORD64 keep_until;
101     struct list pool_entry;
102 } netconn_t;
103
104 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc(size_t len)
105 {
106     return HeapAlloc(GetProcessHeap(), 0, len);
107 }
108
109 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc_zero(size_t len)
110 {
111     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
112 }
113
114 static inline void * __WINE_ALLOC_SIZE(2) heap_realloc(void *mem, size_t len)
115 {
116     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
117 }
118
119 static inline void * __WINE_ALLOC_SIZE(2) heap_realloc_zero(void *mem, size_t len)
120 {
121     return HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len);
122 }
123
124 static inline BOOL heap_free(void *mem)
125 {
126     return HeapFree(GetProcessHeap(), 0, mem);
127 }
128
129 static inline LPWSTR heap_strdupW(LPCWSTR str)
130 {
131     LPWSTR ret = NULL;
132
133     if(str) {
134         DWORD size;
135
136         size = (strlenW(str)+1)*sizeof(WCHAR);
137         ret = heap_alloc(size);
138         if(ret)
139             memcpy(ret, str, size);
140     }
141
142     return ret;
143 }
144
145 static inline LPWSTR heap_strndupW(LPCWSTR str, UINT max_len)
146 {
147     LPWSTR ret;
148     UINT len;
149
150     if(!str)
151         return NULL;
152
153     for(len=0; len<max_len; len++)
154         if(str[len] == '\0')
155             break;
156
157     ret = heap_alloc(sizeof(WCHAR)*(len+1));
158     if(ret) {
159         memcpy(ret, str, sizeof(WCHAR)*len);
160         ret[len] = '\0';
161     }
162
163     return ret;
164 }
165
166 static inline WCHAR *heap_strdupAtoW(const char *str)
167 {
168     LPWSTR ret = NULL;
169
170     if(str) {
171         DWORD len;
172
173         len = MultiByteToWideChar(CP_ACP, 0, str, -1, NULL, 0);
174         ret = heap_alloc(len*sizeof(WCHAR));
175         if(ret)
176             MultiByteToWideChar(CP_ACP, 0, str, -1, ret, len);
177     }
178
179     return ret;
180 }
181
182 static inline char *heap_strdupWtoA(LPCWSTR str)
183 {
184     char *ret = NULL;
185
186     if(str) {
187         DWORD size = WideCharToMultiByte(CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
188         ret = heap_alloc(size);
189         if(ret)
190             WideCharToMultiByte(CP_ACP, 0, str, -1, ret, size, NULL, NULL);
191     }
192
193     return ret;
194 }
195
196 static inline void WININET_find_data_WtoA(LPWIN32_FIND_DATAW dataW, LPWIN32_FIND_DATAA dataA)
197 {
198     dataA->dwFileAttributes = dataW->dwFileAttributes;
199     dataA->ftCreationTime   = dataW->ftCreationTime;
200     dataA->ftLastAccessTime = dataW->ftLastAccessTime;
201     dataA->ftLastWriteTime  = dataW->ftLastWriteTime;
202     dataA->nFileSizeHigh    = dataW->nFileSizeHigh;
203     dataA->nFileSizeLow     = dataW->nFileSizeLow;
204     dataA->dwReserved0      = dataW->dwReserved0;
205     dataA->dwReserved1      = dataW->dwReserved1;
206     WideCharToMultiByte(CP_ACP, 0, dataW->cFileName, -1, 
207         dataA->cFileName, sizeof(dataA->cFileName),
208         NULL, NULL);
209     WideCharToMultiByte(CP_ACP, 0, dataW->cAlternateFileName, -1, 
210         dataA->cAlternateFileName, sizeof(dataA->cAlternateFileName),
211         NULL, NULL);
212 }
213
214 typedef enum
215 {
216     WH_HINIT = INTERNET_HANDLE_TYPE_INTERNET,
217     WH_HFTPSESSION = INTERNET_HANDLE_TYPE_CONNECT_FTP,
218     WH_HGOPHERSESSION = INTERNET_HANDLE_TYPE_CONNECT_GOPHER,
219     WH_HHTTPSESSION = INTERNET_HANDLE_TYPE_CONNECT_HTTP,
220     WH_HFILE = INTERNET_HANDLE_TYPE_FTP_FILE,
221     WH_HFTPFINDNEXT = INTERNET_HANDLE_TYPE_FTP_FIND,
222     WH_HHTTPREQ = INTERNET_HANDLE_TYPE_HTTP_REQUEST,
223 } WH_TYPE;
224
225 #define INET_OPENURL 0x0001
226 #define INET_CALLBACKW 0x0002
227
228 typedef struct _object_header_t object_header_t;
229
230 typedef struct {
231     void (*Destroy)(object_header_t*);
232     void (*CloseConnection)(object_header_t*);
233     DWORD (*QueryOption)(object_header_t*,DWORD,void*,DWORD*,BOOL);
234     DWORD (*SetOption)(object_header_t*,DWORD,void*,DWORD);
235     DWORD (*ReadFile)(object_header_t*,void*,DWORD,DWORD*);
236     DWORD (*ReadFileExA)(object_header_t*,INTERNET_BUFFERSA*,DWORD,DWORD_PTR);
237     DWORD (*ReadFileExW)(object_header_t*,INTERNET_BUFFERSW*,DWORD,DWORD_PTR);
238     DWORD (*WriteFile)(object_header_t*,const void*,DWORD,DWORD*);
239     DWORD (*QueryDataAvailable)(object_header_t*,DWORD*,DWORD,DWORD_PTR);
240     DWORD (*FindNextFileW)(object_header_t*,void*);
241 } object_vtbl_t;
242
243 #define INTERNET_HANDLE_IN_USE 1
244
245 struct _object_header_t
246 {
247     WH_TYPE htype;
248     const object_vtbl_t *vtbl;
249     HINTERNET hInternet;
250     BOOL valid_handle;
251     DWORD  dwFlags;
252     DWORD_PTR dwContext;
253     DWORD  dwError;
254     ULONG  ErrorMask;
255     DWORD  dwInternalFlags;
256     LONG   refs;
257     INTERNET_STATUS_CALLBACK lpfnStatusCB;
258     struct list entry;
259     struct list children;
260 };
261
262
263 typedef struct
264 {
265     object_header_t hdr;
266     LPWSTR  agent;
267     LPWSTR  proxy;
268     LPWSTR  proxyBypass;
269     LPWSTR  proxyUsername;
270     LPWSTR  proxyPassword;
271     DWORD   accessType;
272     DWORD   connect_timeout;
273 } appinfo_t;
274
275 typedef struct
276 {
277     object_header_t hdr;
278     appinfo_t *appInfo;
279     LPWSTR  hostName; /* the final destination of the request */
280     LPWSTR  userName;
281     LPWSTR  password;
282     INTERNET_PORT hostPort; /* the final destination port of the request */
283     DWORD connect_timeout;
284     DWORD send_timeout;
285     DWORD receive_timeout;
286 } http_session_t;
287
288 #define HDR_ISREQUEST           0x0001
289 #define HDR_COMMADELIMITED      0x0002
290 #define HDR_SEMIDELIMITED       0x0004
291
292 typedef struct
293 {
294     LPWSTR lpszField;
295     LPWSTR lpszValue;
296     WORD wFlags;
297     WORD wCount;
298 } HTTPHEADERW, *LPHTTPHEADERW;
299
300
301 struct HttpAuthInfo;
302
303 typedef struct data_stream_vtbl_t data_stream_vtbl_t;
304
305 typedef struct {
306     const data_stream_vtbl_t *vtbl;
307 }  data_stream_t;
308
309 typedef struct {
310     data_stream_t data_stream;
311     DWORD content_length;
312     DWORD content_read;
313 } netconn_stream_t;
314
315 #define READ_BUFFER_SIZE 8192
316
317 typedef struct
318 {
319     object_header_t hdr;
320     http_session_t *session;
321     server_t *server;
322     server_t *proxy;
323     LPWSTR path;
324     LPWSTR verb;
325     LPWSTR rawHeaders;
326     netconn_t *netconn;
327     DWORD security_flags;
328     DWORD connect_timeout;
329     DWORD send_timeout;
330     DWORD receive_timeout;
331     LPWSTR version;
332     DWORD status_code;
333     LPWSTR statusText;
334     DWORD bytesToWrite;
335     DWORD bytesWritten;
336     HTTPHEADERW *custHeaders;
337     DWORD nCustHeaders;
338     FILETIME last_modified;
339     HANDLE hCacheFile;
340     LPWSTR cacheFile;
341     FILETIME expires;
342     struct HttpAuthInfo *authInfo;
343     struct HttpAuthInfo *proxyAuthInfo;
344
345     CRITICAL_SECTION read_section;  /* section to protect the following fields */
346     DWORD contentLength;  /* total number of bytes to be read */
347     BOOL  read_chunked;   /* are we reading in chunked mode? */
348     BOOL  read_gzip;      /* are we reading in gzip mode? */
349     DWORD read_pos;       /* current read position in read_buf */
350     DWORD read_size;      /* valid data size in read_buf */
351     BYTE  read_buf[READ_BUFFER_SIZE]; /* buffer for already read but not returned data */
352
353     BOOL decoding;
354     data_stream_t *data_stream;
355     netconn_stream_t netconn_stream;
356 } http_request_t;
357
358
359
360 struct WORKREQ_FTPPUTFILEW
361 {
362     LPWSTR lpszLocalFile;
363     LPWSTR lpszNewRemoteFile;
364     DWORD  dwFlags;
365     DWORD_PTR dwContext;
366 };
367
368 struct WORKREQ_FTPSETCURRENTDIRECTORYW
369 {
370     LPWSTR lpszDirectory;
371 };
372
373 struct WORKREQ_FTPCREATEDIRECTORYW
374 {
375     LPWSTR lpszDirectory;
376 };
377
378 struct WORKREQ_FTPFINDFIRSTFILEW
379 {
380     LPWSTR lpszSearchFile;
381     LPWIN32_FIND_DATAW lpFindFileData;
382     DWORD  dwFlags;
383     DWORD_PTR dwContext;
384 };
385
386 struct WORKREQ_FTPGETCURRENTDIRECTORYW
387 {
388     LPWSTR lpszDirectory;
389     DWORD *lpdwDirectory;
390 };
391
392 struct WORKREQ_FTPOPENFILEW
393 {
394     LPWSTR lpszFilename;
395     DWORD  dwAccess;
396     DWORD  dwFlags;
397     DWORD_PTR dwContext;
398 };
399
400 struct WORKREQ_FTPGETFILEW
401 {
402     LPWSTR lpszRemoteFile;
403     LPWSTR lpszNewFile;
404     BOOL   fFailIfExists;
405     DWORD  dwLocalFlagsAttribute;
406     DWORD  dwFlags;
407     DWORD_PTR dwContext;
408 };
409
410 struct WORKREQ_FTPDELETEFILEW
411 {
412     LPWSTR lpszFilename;
413 };
414
415 struct WORKREQ_FTPREMOVEDIRECTORYW
416 {
417     LPWSTR lpszDirectory;
418 };
419
420 struct WORKREQ_FTPRENAMEFILEW
421 {
422     LPWSTR lpszSrcFile;
423     LPWSTR lpszDestFile;
424 };
425
426 struct WORKREQ_FTPFINDNEXTW
427 {
428     LPWIN32_FIND_DATAW lpFindFileData;
429 };
430
431 struct WORKREQ_HTTPSENDREQUESTW
432 {
433     LPWSTR lpszHeader;
434     DWORD  dwHeaderLength;
435     LPVOID lpOptional;
436     DWORD  dwOptionalLength;
437     DWORD  dwContentLength;
438     BOOL   bEndRequest;
439 };
440
441 struct WORKREQ_HTTPENDREQUESTW
442 {
443     DWORD     dwFlags;
444     DWORD_PTR dwContext;
445 };
446
447 struct WORKREQ_SENDCALLBACK
448 {
449     DWORD_PTR dwContext;
450     DWORD     dwInternetStatus;
451     LPVOID    lpvStatusInfo;
452     DWORD     dwStatusInfoLength;
453 };
454
455 struct WORKREQ_INTERNETOPENURLW
456 {
457     HINTERNET hInternet;
458     LPWSTR     lpszUrl;
459     LPWSTR     lpszHeaders;
460     DWORD     dwHeadersLength;
461     DWORD     dwFlags;
462     DWORD_PTR dwContext;
463 };
464
465 struct WORKREQ_INTERNETREADFILEEXA
466 {
467     LPINTERNET_BUFFERSA lpBuffersOut;
468 };
469
470 struct WORKREQ_INTERNETREADFILEEXW
471 {
472     LPINTERNET_BUFFERSW lpBuffersOut;
473 };
474
475 typedef struct WORKREQ
476 {
477     void (*asyncproc)(struct WORKREQ*);
478     object_header_t *hdr;
479
480     union {
481         struct WORKREQ_FTPPUTFILEW              FtpPutFileW;
482         struct WORKREQ_FTPSETCURRENTDIRECTORYW  FtpSetCurrentDirectoryW;
483         struct WORKREQ_FTPCREATEDIRECTORYW      FtpCreateDirectoryW;
484         struct WORKREQ_FTPFINDFIRSTFILEW        FtpFindFirstFileW;
485         struct WORKREQ_FTPGETCURRENTDIRECTORYW  FtpGetCurrentDirectoryW;
486         struct WORKREQ_FTPOPENFILEW             FtpOpenFileW;
487         struct WORKREQ_FTPGETFILEW              FtpGetFileW;
488         struct WORKREQ_FTPDELETEFILEW           FtpDeleteFileW;
489         struct WORKREQ_FTPREMOVEDIRECTORYW      FtpRemoveDirectoryW;
490         struct WORKREQ_FTPRENAMEFILEW           FtpRenameFileW;
491         struct WORKREQ_FTPFINDNEXTW             FtpFindNextW;
492         struct WORKREQ_HTTPSENDREQUESTW         HttpSendRequestW;
493         struct WORKREQ_HTTPENDREQUESTW          HttpEndRequestW;
494         struct WORKREQ_SENDCALLBACK             SendCallback;
495         struct WORKREQ_INTERNETOPENURLW         InternetOpenUrlW;
496         struct WORKREQ_INTERNETREADFILEEXA      InternetReadFileExA;
497         struct WORKREQ_INTERNETREADFILEEXW      InternetReadFileExW;
498     } u;
499
500 } WORKREQUEST, *LPWORKREQUEST;
501
502 void *alloc_object(object_header_t*,const object_vtbl_t*,size_t) DECLSPEC_HIDDEN;
503 object_header_t *get_handle_object( HINTERNET hinternet ) DECLSPEC_HIDDEN;
504 object_header_t *WININET_AddRef( object_header_t *info ) DECLSPEC_HIDDEN;
505 BOOL WININET_Release( object_header_t *info ) DECLSPEC_HIDDEN;
506
507 DWORD INET_QueryOption(object_header_t*,DWORD,void*,DWORD*,BOOL) DECLSPEC_HIDDEN;
508 DWORD INET_SetOption(object_header_t*,DWORD,void*,DWORD) DECLSPEC_HIDDEN;
509
510 time_t ConvertTimeString(LPCWSTR asctime) DECLSPEC_HIDDEN;
511
512 HINTERNET FTP_Connect(appinfo_t *hIC, LPCWSTR lpszServerName,
513         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
514         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
515         DWORD dwInternalFlags) DECLSPEC_HIDDEN;
516
517 DWORD HTTP_Connect(appinfo_t*,LPCWSTR,
518         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
519         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
520         DWORD dwInternalFlags, HINTERNET*) DECLSPEC_HIDDEN;
521
522 BOOL GetAddress(LPCWSTR lpszServerName, INTERNET_PORT nServerPort,
523         struct sockaddr *psa, socklen_t *sa_len) DECLSPEC_HIDDEN;
524
525 BOOL get_cookie(const WCHAR*,const WCHAR*,WCHAR*,DWORD*) DECLSPEC_HIDDEN;
526 BOOL set_cookie(const WCHAR*,const WCHAR*,const WCHAR*,const WCHAR*) DECLSPEC_HIDDEN;
527
528 void INTERNET_SetLastError(DWORD dwError) DECLSPEC_HIDDEN;
529 DWORD INTERNET_GetLastError(void) DECLSPEC_HIDDEN;
530 DWORD INTERNET_AsyncCall(LPWORKREQUEST lpWorkRequest) DECLSPEC_HIDDEN;
531 LPSTR INTERNET_GetResponseBuffer(void) DECLSPEC_HIDDEN;
532 LPSTR INTERNET_GetNextLine(INT nSocket, LPDWORD dwLen) DECLSPEC_HIDDEN;
533
534 VOID SendAsyncCallback(object_header_t *hdr, DWORD_PTR dwContext,
535                        DWORD dwInternetStatus, LPVOID lpvStatusInfo,
536                        DWORD dwStatusInfoLength) DECLSPEC_HIDDEN;
537
538 VOID INTERNET_SendCallback(object_header_t *hdr, DWORD_PTR dwContext,
539                            DWORD dwInternetStatus, LPVOID lpvStatusInfo,
540                            DWORD dwStatusInfoLength) DECLSPEC_HIDDEN;
541 BOOL INTERNET_FindProxyForProtocol(LPCWSTR szProxy, LPCWSTR proto, WCHAR *foundProxy, DWORD *foundProxyLen) DECLSPEC_HIDDEN;
542
543 DWORD create_netconn(BOOL,server_t*,DWORD,BOOL,DWORD,netconn_t**) DECLSPEC_HIDDEN;
544 void free_netconn(netconn_t*) DECLSPEC_HIDDEN;
545 void NETCON_unload(void) DECLSPEC_HIDDEN;
546 DWORD NETCON_secure_connect(netconn_t*,server_t*) DECLSPEC_HIDDEN;
547 DWORD NETCON_send(netconn_t *connection, const void *msg, size_t len, int flags,
548                 int *sent /* out */) DECLSPEC_HIDDEN;
549 DWORD NETCON_recv(netconn_t *connection, void *buf, size_t len, int flags,
550                 int *recvd /* out */) DECLSPEC_HIDDEN;
551 BOOL NETCON_query_data_available(netconn_t *connection, DWORD *available) DECLSPEC_HIDDEN;
552 BOOL NETCON_is_alive(netconn_t*) DECLSPEC_HIDDEN;
553 LPCVOID NETCON_GetCert(netconn_t *connection) DECLSPEC_HIDDEN;
554 int NETCON_GetCipherStrength(netconn_t*) DECLSPEC_HIDDEN;
555 DWORD NETCON_set_timeout(netconn_t *connection, BOOL send, DWORD value) DECLSPEC_HIDDEN;
556 int sock_get_error(int) DECLSPEC_HIDDEN;
557
558 server_t *get_server(const WCHAR*,INTERNET_PORT,BOOL,BOOL);
559
560 BOOL init_urlcache(void) DECLSPEC_HIDDEN;
561 void free_urlcache(void) DECLSPEC_HIDDEN;
562 void free_cookie(void) DECLSPEC_HIDDEN;
563
564 #define MAX_REPLY_LEN           0x5B4
565
566 /* Used for debugging - maybe need to be shared in the Wine debugging code ? */
567 typedef struct
568 {
569     DWORD val;
570     const char* name;
571 } wininet_flag_info;
572
573 /* Undocumented security flags */
574 #define _SECURITY_FLAG_CERT_REV_FAILED    0x00800000
575 #define _SECURITY_FLAG_CERT_INVALID_CA    0x01000000
576 #define _SECURITY_FLAG_CERT_INVALID_CN    0x02000000
577 #define _SECURITY_FLAG_CERT_INVALID_DATE  0x04000000
578
579 #define _SECURITY_ERROR_FLAGS_MASK              \
580     (_SECURITY_FLAG_CERT_REV_FAILED             \
581     |_SECURITY_FLAG_CERT_INVALID_CA             \
582     |_SECURITY_FLAG_CERT_INVALID_CN             \
583     |_SECURITY_FLAG_CERT_INVALID_DATE)
584
585 #endif /* _WINE_INTERNET_H_ */