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