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