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 extern HMODULE WININET_hModule DECLSPEC_HIDDEN;
  51
  52 #ifndef INET6_ADDRSTRLEN
  53 #define INET6_ADDRSTRLEN 46
  54 #endif
  55
  56 typedef struct {
  57     WCHAR *name;
  58     INTERNET_PORT port;
  59     struct sockaddr_storage addr;
  60     socklen_t addr_len;
  61     char addr_str[INET6_ADDRSTRLEN];
  62
  63     LONG ref;
  64     DWORD64 keep_until;
  65
  66     struct list entry;
  67     struct list conn_pool;
  68 } server_t;
  69
  70 void server_addref(server_t*) DECLSPEC_HIDDEN;
  71 void server_release(server_t*) DECLSPEC_HIDDEN;
  72 BOOL collect_connections(BOOL) DECLSPEC_HIDDEN;
  73
  74 /* used for netconnection.c stuff */
  75 typedef struct
  76 {
  77     BOOL useSSL;
  78     int socketFD;
  79     void *ssl_s;
  80     server_t *server;
  81     DWORD security_flags;
  82
  83     BOOL keep_alive;
  84     DWORD64 keep_until;
  85     struct list pool_entry;
  86 } netconn_t;
  87
  88 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc(size_t len)
  89 {
  90     return HeapAlloc(GetProcessHeap(), 0, len);
  91 }
  92
  93 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc_zero(size_t len)
  94 {
  95     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
  96 }
  97
  98 static inline void * __WINE_ALLOC_SIZE(2) heap_realloc(void *mem, size_t len)
  99 {
 100     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
 101 }
 102
 103 static inline void * __WINE_ALLOC_SIZE(2) heap_realloc_zero(void *mem, size_t len)
 104 {
 105     return HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len);
 106 }
 107
 108 static inline BOOL heap_free(void *mem)
 109 {
 110     return HeapFree(GetProcessHeap(), 0, mem);
 111 }
 112
 113 static inline LPWSTR heap_strdupW(LPCWSTR str)
 114 {
 115     LPWSTR ret = NULL;
 116
 117     if(str) {
 118         DWORD size;
 119
 120         size = (strlenW(str)+1)*sizeof(WCHAR);
 121         ret = heap_alloc(size);
 122         if(ret)
 123             memcpy(ret, str, size);
 124     }
 125
 126     return ret;
 127 }
 128
 129 static inline LPWSTR heap_strndupW(LPCWSTR str, UINT max_len)
 130 {
 131     LPWSTR ret;
 132     UINT len;
 133
 134     if(!str)
 135         return NULL;
 136
 137     for(len=0; len<max_len; len++)
 138         if(str[len] == '\0')
 139             break;
 140
 141     ret = heap_alloc(sizeof(WCHAR)*(len+1));
 142     if(ret) {
 143         memcpy(ret, str, sizeof(WCHAR)*len);
 144         ret[len] = '\0';
 145     }
 146
 147     return ret;
 148 }
 149
 150 static inline WCHAR *heap_strdupAtoW(const char *str)
 151 {
 152     LPWSTR ret = NULL;
 153
 154     if(str) {
 155         DWORD len;
 156
 157         len = MultiByteToWideChar(CP_ACP, 0, str, -1, NULL, 0);
 158         ret = heap_alloc(len*sizeof(WCHAR));
 159         if(ret)
 160             MultiByteToWideChar(CP_ACP, 0, str, -1, ret, len);
 161     }
 162
 163     return ret;
 164 }
 165
 166 static inline char *heap_strdupWtoA(LPCWSTR str)
 167 {
 168     char *ret = NULL;
 169
 170     if(str) {
 171         DWORD size = WideCharToMultiByte(CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
 172         ret = heap_alloc(size);
 173         if(ret)
 174             WideCharToMultiByte(CP_ACP, 0, str, -1, ret, size, NULL, NULL);
 175     }
 176
 177     return ret;
 178 }
 179
 180 static inline void WININET_find_data_WtoA(LPWIN32_FIND_DATAW dataW, LPWIN32_FIND_DATAA dataA)
 181 {
 182     dataA->dwFileAttributes = dataW->dwFileAttributes;
 183     dataA->ftCreationTime   = dataW->ftCreationTime;
 184     dataA->ftLastAccessTime = dataW->ftLastAccessTime;
 185     dataA->ftLastWriteTime  = dataW->ftLastWriteTime;
 186     dataA->nFileSizeHigh    = dataW->nFileSizeHigh;
 187     dataA->nFileSizeLow     = dataW->nFileSizeLow;
 188     dataA->dwReserved0      = dataW->dwReserved0;
 189     dataA->dwReserved1      = dataW->dwReserved1;
 190     WideCharToMultiByte(CP_ACP, 0, dataW->cFileName, -1,
 191         dataA->cFileName, sizeof(dataA->cFileName),
 192         NULL, NULL);
 193     WideCharToMultiByte(CP_ACP, 0, dataW->cAlternateFileName, -1,
 194         dataA->cAlternateFileName, sizeof(dataA->cAlternateFileName),
 195         NULL, NULL);
 196 }
 197
 198 typedef enum
 199 {
 200     WH_HINIT = INTERNET_HANDLE_TYPE_INTERNET,
 201     WH_HFTPSESSION = INTERNET_HANDLE_TYPE_CONNECT_FTP,
 202     WH_HGOPHERSESSION = INTERNET_HANDLE_TYPE_CONNECT_GOPHER,
 203     WH_HHTTPSESSION = INTERNET_HANDLE_TYPE_CONNECT_HTTP,
 204     WH_HFILE = INTERNET_HANDLE_TYPE_FTP_FILE,
 205     WH_HFTPFINDNEXT = INTERNET_HANDLE_TYPE_FTP_FIND,
 206     WH_HHTTPREQ = INTERNET_HANDLE_TYPE_HTTP_REQUEST,
 207 } WH_TYPE;
 208
 209 #define INET_OPENURL 0x0001
 210 #define INET_CALLBACKW 0x0002
 211
 212 typedef struct _object_header_t object_header_t;
 213
 214 typedef struct {
 215     void (*Destroy)(object_header_t*);
 216     void (*CloseConnection)(object_header_t*);
 217     DWORD (*QueryOption)(object_header_t*,DWORD,void*,DWORD*,BOOL);
 218     DWORD (*SetOption)(object_header_t*,DWORD,void*,DWORD);
 219     DWORD (*ReadFile)(object_header_t*,void*,DWORD,DWORD*);
 220     DWORD (*ReadFileExA)(object_header_t*,INTERNET_BUFFERSA*,DWORD,DWORD_PTR);
 221     DWORD (*ReadFileExW)(object_header_t*,INTERNET_BUFFERSW*,DWORD,DWORD_PTR);
 222     DWORD (*WriteFile)(object_header_t*,const void*,DWORD,DWORD*);
 223     DWORD (*QueryDataAvailable)(object_header_t*,DWORD*,DWORD,DWORD_PTR);
 224     DWORD (*FindNextFileW)(object_header_t*,void*);
 225 } object_vtbl_t;
 226
 227 #define INTERNET_HANDLE_IN_USE 1
 228
 229 struct _object_header_t
 230 {
 231     WH_TYPE htype;
 232     const object_vtbl_t *vtbl;
 233     HINTERNET hInternet;
 234     BOOL valid_handle;
 235     DWORD  dwFlags;
 236     DWORD_PTR dwContext;
 237     DWORD  dwError;
 238     ULONG  ErrorMask;
 239     DWORD  dwInternalFlags;
 240     LONG   refs;
 241     INTERNET_STATUS_CALLBACK lpfnStatusCB;
 242     struct list entry;
 243     struct list children;
 244 };
 245
 246
 247 typedef struct
 248 {
 249     object_header_t hdr;
 250     LPWSTR  agent;
 251     LPWSTR  proxy;
 252     LPWSTR  proxyBypass;
 253     LPWSTR  proxyUsername;
 254     LPWSTR  proxyPassword;
 255     DWORD   accessType;
 256 } appinfo_t;
 257
 258 typedef struct
 259 {
 260     object_header_t hdr;
 261     appinfo_t *appInfo;
 262     LPWSTR  hostName; /* the final destination of the request */
 263     LPWSTR  serverName; /* the name of the server we directly connect to */
 264     LPWSTR  userName;
 265     LPWSTR  password;
 266     INTERNET_PORT hostPort; /* the final destination port of the request */
 267     INTERNET_PORT serverPort; /* the port of the server we directly connect to */
 268     DWORD connect_timeout;
 269     DWORD send_timeout;
 270     DWORD receive_timeout;
 271 } http_session_t;
 272
 273 #define HDR_ISREQUEST           0x0001
 274 #define HDR_COMMADELIMITED      0x0002
 275 #define HDR_SEMIDELIMITED       0x0004
 276
 277 typedef struct
 278 {
 279     LPWSTR lpszField;
 280     LPWSTR lpszValue;
 281     WORD wFlags;
 282     WORD wCount;
 283 } HTTPHEADERW, *LPHTTPHEADERW;
 284
 285
 286 struct HttpAuthInfo;
 287
 288 typedef struct data_stream_vtbl_t data_stream_vtbl_t;
 289
 290 typedef struct {
 291     const data_stream_vtbl_t *vtbl;
 292 }  data_stream_t;
 293
 294 typedef struct {
 295     data_stream_t data_stream;
 296     DWORD content_length;
 297     DWORD content_read;
 298 } netconn_stream_t;
 299
 300 #define READ_BUFFER_SIZE 8192
 301
 302 typedef struct
 303 {
 304     object_header_t hdr;
 305     http_session_t *session;
 306     LPWSTR path;
 307     LPWSTR verb;
 308     LPWSTR rawHeaders;
 309     netconn_t *netconn;
 310     DWORD security_flags;
 311     DWORD connect_timeout;
 312     DWORD send_timeout;
 313     DWORD receive_timeout;
 314     LPWSTR version;
 315     LPWSTR statusText;
 316     DWORD bytesToWrite;
 317     DWORD bytesWritten;
 318     HTTPHEADERW *custHeaders;
 319     DWORD nCustHeaders;
 320     FILETIME last_modified;
 321     HANDLE hCacheFile;
 322     LPWSTR cacheFile;
 323     FILETIME expires;
 324     struct HttpAuthInfo *authInfo;
 325     struct HttpAuthInfo *proxyAuthInfo;
 326
 327     CRITICAL_SECTION read_section;  /* section to protect the following fields */
 328     DWORD contentLength;  /* total number of bytes to be read */
 329     BOOL  read_chunked;   /* are we reading in chunked mode? */
 330     BOOL  read_gzip;      /* are we reading in gzip mode? */
 331     DWORD read_pos;       /* current read position in read_buf */
 332     DWORD read_size;      /* valid data size in read_buf */
 333     BYTE  read_buf[READ_BUFFER_SIZE]; /* buffer for already read but not returned data */
 334
 335     BOOL decoding;
 336     data_stream_t *data_stream;
 337     netconn_stream_t netconn_stream;
 338 } http_request_t;
 339
 340
 341
 342 struct WORKREQ_FTPPUTFILEW
 343 {
 344     LPWSTR lpszLocalFile;
 345     LPWSTR lpszNewRemoteFile;
 346     DWORD  dwFlags;
 347     DWORD_PTR dwContext;
 348 };
 349
 350 struct WORKREQ_FTPSETCURRENTDIRECTORYW
 351 {
 352     LPWSTR lpszDirectory;
 353 };
 354
 355 struct WORKREQ_FTPCREATEDIRECTORYW
 356 {
 357     LPWSTR lpszDirectory;
 358 };
 359
 360 struct WORKREQ_FTPFINDFIRSTFILEW
 361 {
 362     LPWSTR lpszSearchFile;
 363     LPWIN32_FIND_DATAW lpFindFileData;
 364     DWORD  dwFlags;
 365     DWORD_PTR dwContext;
 366 };
 367
 368 struct WORKREQ_FTPGETCURRENTDIRECTORYW
 369 {
 370     LPWSTR lpszDirectory;
 371     DWORD *lpdwDirectory;
 372 };
 373
 374 struct WORKREQ_FTPOPENFILEW
 375 {
 376     LPWSTR lpszFilename;
 377     DWORD  dwAccess;
 378     DWORD  dwFlags;
 379     DWORD_PTR dwContext;
 380 };
 381
 382 struct WORKREQ_FTPGETFILEW
 383 {
 384     LPWSTR lpszRemoteFile;
 385     LPWSTR lpszNewFile;
 386     BOOL   fFailIfExists;
 387     DWORD  dwLocalFlagsAttribute;
 388     DWORD  dwFlags;
 389     DWORD_PTR dwContext;
 390 };
 391
 392 struct WORKREQ_FTPDELETEFILEW
 393 {
 394     LPWSTR lpszFilename;
 395 };
 396
 397 struct WORKREQ_FTPREMOVEDIRECTORYW
 398 {
 399     LPWSTR lpszDirectory;
 400 };
 401
 402 struct WORKREQ_FTPRENAMEFILEW
 403 {
 404     LPWSTR lpszSrcFile;
 405     LPWSTR lpszDestFile;
 406 };
 407
 408 struct WORKREQ_FTPFINDNEXTW
 409 {
 410     LPWIN32_FIND_DATAW lpFindFileData;
 411 };
 412
 413 struct WORKREQ_HTTPSENDREQUESTW
 414 {
 415     LPWSTR lpszHeader;
 416     DWORD  dwHeaderLength;
 417     LPVOID lpOptional;
 418     DWORD  dwOptionalLength;
 419     DWORD  dwContentLength;
 420     BOOL   bEndRequest;
 421 };
 422
 423 struct WORKREQ_HTTPENDREQUESTW
 424 {
 425     DWORD     dwFlags;
 426     DWORD_PTR dwContext;
 427 };
 428
 429 struct WORKREQ_SENDCALLBACK
 430 {
 431     DWORD_PTR dwContext;
 432     DWORD     dwInternetStatus;
 433     LPVOID    lpvStatusInfo;
 434     DWORD     dwStatusInfoLength;
 435 };
 436
 437 struct WORKREQ_INTERNETOPENURLW
 438 {
 439     HINTERNET hInternet;
 440     LPWSTR     lpszUrl;
 441     LPWSTR     lpszHeaders;
 442     DWORD     dwHeadersLength;
 443     DWORD     dwFlags;
 444     DWORD_PTR dwContext;
 445 };
 446
 447 struct WORKREQ_INTERNETREADFILEEXA
 448 {
 449     LPINTERNET_BUFFERSA lpBuffersOut;
 450 };
 451
 452 struct WORKREQ_INTERNETREADFILEEXW
 453 {
 454     LPINTERNET_BUFFERSW lpBuffersOut;
 455 };
 456
 457 typedef struct WORKREQ
 458 {
 459     void (*asyncproc)(struct WORKREQ*);
 460     object_header_t *hdr;
 461
 462     union {
 463         struct WORKREQ_FTPPUTFILEW              FtpPutFileW;
 464         struct WORKREQ_FTPSETCURRENTDIRECTORYW  FtpSetCurrentDirectoryW;
 465         struct WORKREQ_FTPCREATEDIRECTORYW      FtpCreateDirectoryW;
 466         struct WORKREQ_FTPFINDFIRSTFILEW        FtpFindFirstFileW;
 467         struct WORKREQ_FTPGETCURRENTDIRECTORYW  FtpGetCurrentDirectoryW;
 468         struct WORKREQ_FTPOPENFILEW             FtpOpenFileW;
 469         struct WORKREQ_FTPGETFILEW              FtpGetFileW;
 470         struct WORKREQ_FTPDELETEFILEW           FtpDeleteFileW;
 471         struct WORKREQ_FTPREMOVEDIRECTORYW      FtpRemoveDirectoryW;
 472         struct WORKREQ_FTPRENAMEFILEW           FtpRenameFileW;
 473         struct WORKREQ_FTPFINDNEXTW             FtpFindNextW;
 474         struct WORKREQ_HTTPSENDREQUESTW         HttpSendRequestW;
 475         struct WORKREQ_HTTPENDREQUESTW          HttpEndRequestW;
 476         struct WORKREQ_SENDCALLBACK             SendCallback;
 477         struct WORKREQ_INTERNETOPENURLW         InternetOpenUrlW;
 478         struct WORKREQ_INTERNETREADFILEEXA      InternetReadFileExA;
 479         struct WORKREQ_INTERNETREADFILEEXW      InternetReadFileExW;
 480     } u;
 481
 482 } WORKREQUEST, *LPWORKREQUEST;
 483
 484 void *alloc_object(object_header_t*,const object_vtbl_t*,size_t) DECLSPEC_HIDDEN;
 485 object_header_t *get_handle_object( HINTERNET hinternet ) DECLSPEC_HIDDEN;
 486 object_header_t *WININET_AddRef( object_header_t *info ) DECLSPEC_HIDDEN;
 487 BOOL WININET_Release( object_header_t *info ) DECLSPEC_HIDDEN;
 488
 489 DWORD INET_QueryOption( object_header_t *, DWORD, void *, DWORD *, BOOL ) DECLSPEC_HIDDEN;
 490
 491 time_t ConvertTimeString(LPCWSTR asctime) DECLSPEC_HIDDEN;
 492
 493 HINTERNET FTP_Connect(appinfo_t *hIC, LPCWSTR lpszServerName,
 494         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
 495         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
 496         DWORD dwInternalFlags) DECLSPEC_HIDDEN;
 497
 498 DWORD HTTP_Connect(appinfo_t*,LPCWSTR,
 499         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
 500         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
 501         DWORD dwInternalFlags, HINTERNET*) DECLSPEC_HIDDEN;
 502
 503 BOOL GetAddress(LPCWSTR lpszServerName, INTERNET_PORT nServerPort,
 504         struct sockaddr *psa, socklen_t *sa_len) DECLSPEC_HIDDEN;
 505
 506 BOOL get_cookie(const WCHAR*,const WCHAR*,WCHAR*,DWORD*) DECLSPEC_HIDDEN;
 507 BOOL set_cookie(const WCHAR*,const WCHAR*,const WCHAR*,const WCHAR*) DECLSPEC_HIDDEN;
 508
 509 void INTERNET_SetLastError(DWORD dwError) DECLSPEC_HIDDEN;
 510 DWORD INTERNET_GetLastError(void) DECLSPEC_HIDDEN;
 511 DWORD INTERNET_AsyncCall(LPWORKREQUEST lpWorkRequest) DECLSPEC_HIDDEN;
 512 LPSTR INTERNET_GetResponseBuffer(void) DECLSPEC_HIDDEN;
 513 LPSTR INTERNET_GetNextLine(INT nSocket, LPDWORD dwLen) DECLSPEC_HIDDEN;
 514
 515 VOID SendAsyncCallback(object_header_t *hdr, DWORD_PTR dwContext,
 516                        DWORD dwInternetStatus, LPVOID lpvStatusInfo,
 517                        DWORD dwStatusInfoLength) DECLSPEC_HIDDEN;
 518
 519 VOID INTERNET_SendCallback(object_header_t *hdr, DWORD_PTR dwContext,
 520                            DWORD dwInternetStatus, LPVOID lpvStatusInfo,
 521                            DWORD dwStatusInfoLength) DECLSPEC_HIDDEN;
 522 BOOL INTERNET_FindProxyForProtocol(LPCWSTR szProxy, LPCWSTR proto, WCHAR *foundProxy, DWORD *foundProxyLen) DECLSPEC_HIDDEN;
 523
 524 DWORD create_netconn(BOOL, server_t *, DWORD, DWORD, netconn_t **) DECLSPEC_HIDDEN;
 525 void free_netconn(netconn_t*) DECLSPEC_HIDDEN;
 526 void NETCON_unload(void) DECLSPEC_HIDDEN;
 527 DWORD NETCON_secure_connect(netconn_t *connection, LPWSTR hostname) DECLSPEC_HIDDEN;
 528 DWORD NETCON_send(netconn_t *connection, const void *msg, size_t len, int flags,
 529                 int *sent /* out */) DECLSPEC_HIDDEN;
 530 DWORD NETCON_recv(netconn_t *connection, void *buf, size_t len, int flags,
 531                 int *recvd /* out */) DECLSPEC_HIDDEN;
 532 BOOL NETCON_query_data_available(netconn_t *connection, DWORD *available) DECLSPEC_HIDDEN;
 533 BOOL NETCON_is_alive(netconn_t*) DECLSPEC_HIDDEN;
 534 LPCVOID NETCON_GetCert(netconn_t *connection) DECLSPEC_HIDDEN;
 535 int NETCON_GetCipherStrength(netconn_t*) DECLSPEC_HIDDEN;
 536 DWORD NETCON_set_timeout(netconn_t *connection, BOOL send, DWORD value) DECLSPEC_HIDDEN;
 537 int sock_get_error(int) DECLSPEC_HIDDEN;
 538
 539 extern void URLCacheContainers_CreateDefaults(void) DECLSPEC_HIDDEN;
 540 extern void URLCacheContainers_DeleteAll(void) DECLSPEC_HIDDEN;
 541
 542 #define MAX_REPLY_LEN           0x5B4
 543
 544 /* Used for debugging - maybe need to be shared in the Wine debugging code ? */
 545 typedef struct
 546 {
 547     DWORD val;
 548     const char* name;
 549 } wininet_flag_info;
 550
 551 #endif /* _WINE_INTERNET_H_ */