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 #include "wine/unicode.h"
  27 #include "wine/list.h"
  28
  29 #include <time.h>
  30
  31 #include "winineti.h"
  32
  33 extern HMODULE WININET_hModule DECLSPEC_HIDDEN;
  34
  35 typedef struct {
  36     WCHAR *name;
  37     INTERNET_PORT port;
  38     BOOL is_https;
  39     struct sockaddr_storage addr;
  40     int addr_len;
  41     char addr_str[INET6_ADDRSTRLEN];
  42
  43     WCHAR *scheme_host_port;
  44     const WCHAR *host_port;
  45     const WCHAR *canon_host_port;
  46
  47     LONG ref;
  48
  49     DWORD security_flags;
  50     const CERT_CHAIN_CONTEXT *cert_chain;
  51
  52     struct list entry;
  53     struct list conn_pool;
  54 } server_t;
  55
  56 void server_addref(server_t*) DECLSPEC_HIDDEN;
  57 void server_release(server_t*) DECLSPEC_HIDDEN;
  58
  59 typedef enum {
  60     COLLECT_TIMEOUT,
  61     COLLECT_CONNECTIONS,
  62     COLLECT_CLEANUP
  63 } collect_type_t;
  64 BOOL collect_connections(collect_type_t) DECLSPEC_HIDDEN;
  65
  66 /* used for netconnection.c stuff */
  67 typedef struct
  68 {
  69     int socket;
  70     BOOL secure;
  71     BOOL is_blocking;
  72     CtxtHandle ssl_ctx;
  73     SecPkgContext_StreamSizes ssl_sizes;
  74     server_t *server;
  75     char *ssl_buf;
  76     char *extra_buf;
  77     size_t extra_len;
  78     char *peek_msg;
  79     char *peek_msg_mem;
  80     size_t peek_len;
  81     DWORD security_flags;
  82     BOOL mask_errors;
  83
  84     BOOL keep_alive;
  85     DWORD64 keep_until;
  86     struct list pool_entry;
  87 } netconn_t;
  88
  89 BOOL is_valid_netconn(netconn_t *) DECLSPEC_HIDDEN;
  90 void close_netconn(netconn_t *) DECLSPEC_HIDDEN;
  91
  92 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc(size_t len)
  93 {
  94     return HeapAlloc(GetProcessHeap(), 0, len);
  95 }
  96
  97 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc_zero(size_t len)
  98 {
  99     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
 100 }
 101
 102 static inline void * __WINE_ALLOC_SIZE(2) heap_realloc(void *mem, size_t len)
 103 {
 104     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
 105 }
 106
 107 static inline void * __WINE_ALLOC_SIZE(2) heap_realloc_zero(void *mem, size_t len)
 108 {
 109     return HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len);
 110 }
 111
 112 static inline BOOL heap_free(void *mem)
 113 {
 114     return HeapFree(GetProcessHeap(), 0, mem);
 115 }
 116
 117 static inline LPWSTR heap_strdupW(LPCWSTR str)
 118 {
 119     LPWSTR ret = NULL;
 120
 121     if(str) {
 122         DWORD size;
 123
 124         size = (strlenW(str)+1)*sizeof(WCHAR);
 125         ret = heap_alloc(size);
 126         if(ret)
 127             memcpy(ret, str, size);
 128     }
 129
 130     return ret;
 131 }
 132
 133 static inline char *heap_strdupA(const char *str)
 134 {
 135     char *ret = NULL;
 136
 137     if(str) {
 138         DWORD size = strlen(str)+1;
 139
 140         ret = heap_alloc(size);
 141         if(ret)
 142             memcpy(ret, str, size);
 143     }
 144
 145     return ret;
 146 }
 147
 148 static inline LPWSTR heap_strndupW(LPCWSTR str, UINT max_len)
 149 {
 150     LPWSTR ret;
 151     UINT len;
 152
 153     if(!str)
 154         return NULL;
 155
 156     for(len=0; len<max_len; len++)
 157         if(str[len] == '\0')
 158             break;
 159
 160     ret = heap_alloc(sizeof(WCHAR)*(len+1));
 161     if(ret) {
 162         memcpy(ret, str, sizeof(WCHAR)*len);
 163         ret[len] = '\0';
 164     }
 165
 166     return ret;
 167 }
 168
 169 static inline WCHAR *heap_strndupAtoW(const char *str, int len_a, DWORD *len_w)
 170 {
 171     WCHAR *ret = NULL;
 172
 173     if(str) {
 174         size_t len;
 175         if(len_a < 0) len_a = strlen(str);
 176         len = MultiByteToWideChar(CP_ACP, 0, str, len_a, NULL, 0);
 177         ret = heap_alloc((len+1)*sizeof(WCHAR));
 178         if(ret) {
 179             MultiByteToWideChar(CP_ACP, 0, str, len_a, ret, len);
 180             ret[len] = 0;
 181             *len_w = len;
 182         }
 183     }
 184
 185     return ret;
 186 }
 187
 188 static inline WCHAR *heap_strdupAtoW(const char *str)
 189 {
 190     LPWSTR ret = NULL;
 191
 192     if(str) {
 193         DWORD len;
 194
 195         len = MultiByteToWideChar(CP_ACP, 0, str, -1, NULL, 0);
 196         ret = heap_alloc(len*sizeof(WCHAR));
 197         if(ret)
 198             MultiByteToWideChar(CP_ACP, 0, str, -1, ret, len);
 199     }
 200
 201     return ret;
 202 }
 203
 204 static inline char *heap_strdupWtoA(LPCWSTR str)
 205 {
 206     char *ret = NULL;
 207
 208     if(str) {
 209         DWORD size = WideCharToMultiByte(CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
 210         ret = heap_alloc(size);
 211         if(ret)
 212             WideCharToMultiByte(CP_ACP, 0, str, -1, ret, size, NULL, NULL);
 213     }
 214
 215     return ret;
 216 }
 217
 218 typedef struct {
 219     const WCHAR *str;
 220     size_t len;
 221 } substr_t;
 222
 223 static inline substr_t substr(const WCHAR *str, size_t len)
 224 {
 225     substr_t r = {str, len};
 226     return r;
 227 }
 228
 229 static inline substr_t substrz(const WCHAR *str)
 230 {
 231     return substr(str, strlenW(str));
 232 }
 233
 234 static inline void WININET_find_data_WtoA(LPWIN32_FIND_DATAW dataW, LPWIN32_FIND_DATAA dataA)
 235 {
 236     dataA->dwFileAttributes = dataW->dwFileAttributes;
 237     dataA->ftCreationTime   = dataW->ftCreationTime;
 238     dataA->ftLastAccessTime = dataW->ftLastAccessTime;
 239     dataA->ftLastWriteTime  = dataW->ftLastWriteTime;
 240     dataA->nFileSizeHigh    = dataW->nFileSizeHigh;
 241     dataA->nFileSizeLow     = dataW->nFileSizeLow;
 242     dataA->dwReserved0      = dataW->dwReserved0;
 243     dataA->dwReserved1      = dataW->dwReserved1;
 244     WideCharToMultiByte(CP_ACP, 0, dataW->cFileName, -1,
 245         dataA->cFileName, sizeof(dataA->cFileName),
 246         NULL, NULL);
 247     WideCharToMultiByte(CP_ACP, 0, dataW->cAlternateFileName, -1,
 248         dataA->cAlternateFileName, sizeof(dataA->cAlternateFileName),
 249         NULL, NULL);
 250 }
 251
 252 typedef enum
 253 {
 254     WH_HINIT = INTERNET_HANDLE_TYPE_INTERNET,
 255     WH_HFTPSESSION = INTERNET_HANDLE_TYPE_CONNECT_FTP,
 256     WH_HGOPHERSESSION = INTERNET_HANDLE_TYPE_CONNECT_GOPHER,
 257     WH_HHTTPSESSION = INTERNET_HANDLE_TYPE_CONNECT_HTTP,
 258     WH_HFILE = INTERNET_HANDLE_TYPE_FTP_FILE,
 259     WH_HFTPFINDNEXT = INTERNET_HANDLE_TYPE_FTP_FIND,
 260     WH_HHTTPREQ = INTERNET_HANDLE_TYPE_HTTP_REQUEST,
 261 } WH_TYPE;
 262
 263 #define INET_OPENURL 0x0001
 264 #define INET_CALLBACKW 0x0002
 265
 266 typedef struct
 267 {
 268     LONG ref;
 269     HANDLE file_handle;
 270     WCHAR *file_name;
 271     WCHAR *url;
 272     BOOL is_committed;
 273 } req_file_t;
 274
 275 typedef struct _object_header_t object_header_t;
 276
 277 typedef struct {
 278     void (*Destroy)(object_header_t*);
 279     void (*CloseConnection)(object_header_t*);
 280     DWORD (*QueryOption)(object_header_t*,DWORD,void*,DWORD*,BOOL);
 281     DWORD (*SetOption)(object_header_t*,DWORD,void*,DWORD);
 282     DWORD (*ReadFile)(object_header_t*,void*,DWORD,DWORD*,DWORD,DWORD_PTR);
 283     DWORD (*WriteFile)(object_header_t*,const void*,DWORD,DWORD*);
 284     DWORD (*QueryDataAvailable)(object_header_t*,DWORD*,DWORD,DWORD_PTR);
 285     DWORD (*FindNextFileW)(object_header_t*,void*);
 286     DWORD (*LockRequestFile)(object_header_t*,req_file_t**);
 287 } object_vtbl_t;
 288
 289 #define INTERNET_HANDLE_IN_USE 1
 290
 291 struct _object_header_t
 292 {
 293     WH_TYPE htype;
 294     const object_vtbl_t *vtbl;
 295     HINTERNET hInternet;
 296     BOOL valid_handle;
 297     DWORD  dwFlags;
 298     DWORD_PTR dwContext;
 299     DWORD  dwError;
 300     ULONG  ErrorMask;
 301     DWORD  dwInternalFlags;
 302     LONG   refs;
 303     INTERNET_STATUS_CALLBACK lpfnStatusCB;
 304     struct list entry;
 305     struct list children;
 306 };
 307
 308 typedef struct
 309 {
 310     object_header_t hdr;
 311     LPWSTR  agent;
 312     LPWSTR  proxy;
 313     LPWSTR  proxyBypass;
 314     LPWSTR  proxyUsername;
 315     LPWSTR  proxyPassword;
 316     DWORD   accessType;
 317     DWORD   connect_timeout;
 318 } appinfo_t;
 319
 320 typedef struct
 321 {
 322     object_header_t hdr;
 323     appinfo_t *appInfo;
 324     LPWSTR  hostName; /* the final destination of the request */
 325     LPWSTR  userName;
 326     LPWSTR  password;
 327     INTERNET_PORT hostPort; /* the final destination port of the request */
 328     DWORD connect_timeout;
 329     DWORD send_timeout;
 330     DWORD receive_timeout;
 331 } http_session_t;
 332
 333 #define HDR_ISREQUEST           0x0001
 334 #define HDR_COMMADELIMITED      0x0002
 335 #define HDR_SEMIDELIMITED       0x0004
 336
 337 typedef struct
 338 {
 339     LPWSTR lpszField;
 340     LPWSTR lpszValue;
 341     WORD wFlags;
 342     WORD wCount;
 343 } HTTPHEADERW, *LPHTTPHEADERW;
 344
 345
 346 struct HttpAuthInfo;
 347
 348 typedef struct data_stream_vtbl_t data_stream_vtbl_t;
 349
 350 typedef struct {
 351     const data_stream_vtbl_t *vtbl;
 352 }  data_stream_t;
 353
 354 typedef struct {
 355     data_stream_t data_stream;
 356     DWORD content_length;
 357     DWORD content_read;
 358 } netconn_stream_t;
 359
 360 #define READ_BUFFER_SIZE 8192
 361
 362 typedef struct
 363 {
 364     object_header_t hdr;
 365     http_session_t *session;
 366     server_t *server;
 367     server_t *proxy;
 368     LPWSTR path;
 369     LPWSTR verb;
 370     netconn_t *netconn;
 371     DWORD security_flags;
 372     DWORD connect_timeout;
 373     DWORD send_timeout;
 374     DWORD receive_timeout;
 375     LPWSTR version;
 376     DWORD status_code;
 377     LPWSTR statusText;
 378     DWORD bytesToWrite;
 379     DWORD bytesWritten;
 380
 381     CRITICAL_SECTION headers_section;  /* section to protect the headers array */
 382     HTTPHEADERW *custHeaders;
 383     DWORD nCustHeaders;
 384
 385     FILETIME last_modified;
 386     HANDLE hCacheFile;
 387     req_file_t *req_file;
 388     FILETIME expires;
 389     struct HttpAuthInfo *authInfo;
 390     struct HttpAuthInfo *proxyAuthInfo;
 391
 392     CRITICAL_SECTION read_section;  /* section to protect the following fields */
 393     DWORD contentLength;  /* total number of bytes to be read */
 394     BOOL  read_gzip;      /* are we reading in gzip mode? */
 395     DWORD read_pos;       /* current read position in read_buf */
 396     DWORD read_size;      /* valid data size in read_buf */
 397     BYTE  read_buf[READ_BUFFER_SIZE]; /* buffer for already read but not returned data */
 398
 399     BOOL decoding;
 400     data_stream_t *data_stream;
 401     netconn_stream_t netconn_stream;
 402 } http_request_t;
 403
 404 typedef struct task_header_t task_header_t;
 405 typedef void (*async_task_proc_t)(task_header_t*);
 406
 407 struct task_header_t
 408 {
 409     async_task_proc_t proc;
 410     object_header_t *hdr;
 411 };
 412
 413 void *alloc_async_task(object_header_t*,async_task_proc_t,size_t) DECLSPEC_HIDDEN;
 414
 415 void *alloc_object(object_header_t*,const object_vtbl_t*,size_t) DECLSPEC_HIDDEN;
 416 object_header_t *get_handle_object( HINTERNET hinternet ) DECLSPEC_HIDDEN;
 417 object_header_t *WININET_AddRef( object_header_t *info ) DECLSPEC_HIDDEN;
 418 BOOL WININET_Release( object_header_t *info ) DECLSPEC_HIDDEN;
 419
 420 DWORD INET_QueryOption(object_header_t*,DWORD,void*,DWORD*,BOOL) DECLSPEC_HIDDEN;
 421 DWORD INET_SetOption(object_header_t*,DWORD,void*,DWORD) DECLSPEC_HIDDEN;
 422
 423 time_t ConvertTimeString(LPCWSTR asctime) DECLSPEC_HIDDEN;
 424
 425 HINTERNET FTP_Connect(appinfo_t *hIC, LPCWSTR lpszServerName,
 426         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
 427         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
 428         DWORD dwInternalFlags) DECLSPEC_HIDDEN;
 429
 430 DWORD HTTP_Connect(appinfo_t*,LPCWSTR,
 431         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
 432         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
 433         DWORD dwInternalFlags, HINTERNET*) DECLSPEC_HIDDEN;
 434
 435 BOOL GetAddress(const WCHAR*,INTERNET_PORT,SOCKADDR*,int*,char*) DECLSPEC_HIDDEN;
 436
 437 DWORD get_cookie_header(const WCHAR*,const WCHAR*,WCHAR**) DECLSPEC_HIDDEN;
 438 DWORD set_cookie(substr_t,substr_t,substr_t,substr_t,DWORD) DECLSPEC_HIDDEN;
 439
 440 void INTERNET_SetLastError(DWORD dwError) DECLSPEC_HIDDEN;
 441 DWORD INTERNET_GetLastError(void) DECLSPEC_HIDDEN;
 442 DWORD INTERNET_AsyncCall(task_header_t*) DECLSPEC_HIDDEN;
 443 LPSTR INTERNET_GetResponseBuffer(void) DECLSPEC_HIDDEN;
 444
 445 VOID INTERNET_SendCallback(object_header_t *hdr, DWORD_PTR dwContext,
 446                            DWORD dwInternetStatus, LPVOID lpvStatusInfo,
 447                            DWORD dwStatusInfoLength) DECLSPEC_HIDDEN;
 448 WCHAR *INTERNET_FindProxyForProtocol(LPCWSTR szProxy, LPCWSTR proto) DECLSPEC_HIDDEN;
 449
 450 DWORD create_netconn(BOOL,server_t*,DWORD,BOOL,DWORD,netconn_t**) DECLSPEC_HIDDEN;
 451 void free_netconn(netconn_t*) DECLSPEC_HIDDEN;
 452 void NETCON_unload(void) DECLSPEC_HIDDEN;
 453 DWORD NETCON_secure_connect(netconn_t*,server_t*) DECLSPEC_HIDDEN;
 454 DWORD NETCON_send(netconn_t *connection, const void *msg, size_t len, int flags,
 455                 int *sent /* out */) DECLSPEC_HIDDEN;
 456 DWORD NETCON_recv(netconn_t*,void*,size_t,BOOL,int*) DECLSPEC_HIDDEN;
 457 BOOL NETCON_is_alive(netconn_t*) DECLSPEC_HIDDEN;
 458 LPCVOID NETCON_GetCert(netconn_t *connection) DECLSPEC_HIDDEN;
 459 int NETCON_GetCipherStrength(netconn_t*) DECLSPEC_HIDDEN;
 460 DWORD NETCON_set_timeout(netconn_t *connection, BOOL send, DWORD value) DECLSPEC_HIDDEN;
 461 int sock_send(int fd, const void *msg, size_t len, int flags) DECLSPEC_HIDDEN;
 462 int sock_recv(int fd, void *msg, size_t len, int flags) DECLSPEC_HIDDEN;
 463
 464 server_t *get_server(substr_t,INTERNET_PORT,BOOL,BOOL) DECLSPEC_HIDDEN;
 465
 466 DWORD create_req_file(const WCHAR*,req_file_t**) DECLSPEC_HIDDEN;
 467 void req_file_release(req_file_t*) DECLSPEC_HIDDEN;
 468
 469 static inline req_file_t *req_file_addref(req_file_t *req_file)
 470 {
 471     InterlockedIncrement(&req_file->ref);
 472     return req_file;
 473 }
 474
 475 BOOL init_urlcache(void) DECLSPEC_HIDDEN;
 476 void free_urlcache(void) DECLSPEC_HIDDEN;
 477 void free_cookie(void) DECLSPEC_HIDDEN;
 478
 479 void init_winsock(void) DECLSPEC_HIDDEN;
 480
 481 #define MAX_REPLY_LEN           0x5B4
 482
 483 /* Used for debugging - maybe need to be shared in the Wine debugging code ? */
 484 typedef struct
 485 {
 486     DWORD val;
 487     const char* name;
 488 } wininet_flag_info;
 489
 490 /* Undocumented security flags */
 491 #define _SECURITY_FLAG_CERT_REV_FAILED    0x00800000
 492 #define _SECURITY_FLAG_CERT_INVALID_CA    0x01000000
 493 #define _SECURITY_FLAG_CERT_INVALID_CN    0x02000000
 494 #define _SECURITY_FLAG_CERT_INVALID_DATE  0x04000000
 495
 496 #define _SECURITY_ERROR_FLAGS_MASK              \
 497     (_SECURITY_FLAG_CERT_REV_FAILED             \
 498     |_SECURITY_FLAG_CERT_INVALID_CA             \
 499     |_SECURITY_FLAG_CERT_INVALID_CN             \
 500     |_SECURITY_FLAG_CERT_INVALID_DATE)
 501
 502 #endif /* _WINE_INTERNET_H_ */