git.oblomov.eu Git - wine/blob - 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     DWORD   connect_timeout;
 257 } appinfo_t;
 258
 259 typedef struct
 260 {
 261     object_header_t hdr;
 262     appinfo_t *appInfo;
 263     LPWSTR  hostName; /* the final destination of the request */
 264     LPWSTR  serverName; /* the name of the server we directly connect to */
 265     LPWSTR  userName;
 266     LPWSTR  password;
 267     INTERNET_PORT hostPort; /* the final destination port of the request */
 268     INTERNET_PORT serverPort; /* the port of the server we directly connect to */
 269     DWORD connect_timeout;
 270     DWORD send_timeout;
 271     DWORD receive_timeout;
 272 } http_session_t;
 273
 274 #define HDR_ISREQUEST           0x0001
 275 #define HDR_COMMADELIMITED      0x0002
 276 #define HDR_SEMIDELIMITED       0x0004
 277
 278 typedef struct
 279 {
 280     LPWSTR lpszField;
 281     LPWSTR lpszValue;
 282     WORD wFlags;
 283     WORD wCount;
 284 } HTTPHEADERW, *LPHTTPHEADERW;
 285
 286
 287 struct HttpAuthInfo;
 288
 289 typedef struct data_stream_vtbl_t data_stream_vtbl_t;
 290
 291 typedef struct {
 292     const data_stream_vtbl_t *vtbl;
 293 }  data_stream_t;
 294
 295 typedef struct {
 296     data_stream_t data_stream;
 297     DWORD content_length;
 298     DWORD content_read;
 299 } netconn_stream_t;
 300
 301 #define READ_BUFFER_SIZE 8192
 302
 303 typedef struct
 304 {
 305     object_header_t hdr;
 306     http_session_t *session;
 307     LPWSTR path;
 308     LPWSTR verb;
 309     LPWSTR rawHeaders;
 310     netconn_t *netconn;
 311     DWORD security_flags;
 312     DWORD connect_timeout;
 313     DWORD send_timeout;
 314     DWORD receive_timeout;
 315     LPWSTR version;
 316     DWORD status_code;
 317     LPWSTR statusText;
 318     DWORD bytesToWrite;
 319     DWORD bytesWritten;
 320     HTTPHEADERW *custHeaders;
 321     DWORD nCustHeaders;
 322     FILETIME last_modified;
 323     HANDLE hCacheFile;
 324     LPWSTR cacheFile;
 325     FILETIME expires;
 326     struct HttpAuthInfo *authInfo;
 327     struct HttpAuthInfo *proxyAuthInfo;
 328
 329     CRITICAL_SECTION read_section;  /* section to protect the following fields */
 330     DWORD contentLength;  /* total number of bytes to be read */
 331     BOOL  read_chunked;   /* are we reading in chunked mode? */
 332     BOOL  read_gzip;      /* are we reading in gzip mode? */
 333     DWORD read_pos;       /* current read position in read_buf */
 334     DWORD read_size;      /* valid data size in read_buf */
 335     BYTE  read_buf[READ_BUFFER_SIZE]; /* buffer for already read but not returned data */
 336
 337     BOOL decoding;
 338     data_stream_t *data_stream;
 339     netconn_stream_t netconn_stream;
 340 } http_request_t;
 341
 342
 343
 344 struct WORKREQ_FTPPUTFILEW
 345 {
 346     LPWSTR lpszLocalFile;
 347     LPWSTR lpszNewRemoteFile;
 348     DWORD  dwFlags;
 349     DWORD_PTR dwContext;
 350 };
 351
 352 struct WORKREQ_FTPSETCURRENTDIRECTORYW
 353 {
 354     LPWSTR lpszDirectory;
 355 };
 356
 357 struct WORKREQ_FTPCREATEDIRECTORYW
 358 {
 359     LPWSTR lpszDirectory;
 360 };
 361
 362 struct WORKREQ_FTPFINDFIRSTFILEW
 363 {
 364     LPWSTR lpszSearchFile;
 365     LPWIN32_FIND_DATAW lpFindFileData;
 366     DWORD  dwFlags;
 367     DWORD_PTR dwContext;
 368 };
 369
 370 struct WORKREQ_FTPGETCURRENTDIRECTORYW
 371 {
 372     LPWSTR lpszDirectory;
 373     DWORD *lpdwDirectory;
 374 };
 375
 376 struct WORKREQ_FTPOPENFILEW
 377 {
 378     LPWSTR lpszFilename;
 379     DWORD  dwAccess;
 380     DWORD  dwFlags;
 381     DWORD_PTR dwContext;
 382 };
 383
 384 struct WORKREQ_FTPGETFILEW
 385 {
 386     LPWSTR lpszRemoteFile;
 387     LPWSTR lpszNewFile;
 388     BOOL   fFailIfExists;
 389     DWORD  dwLocalFlagsAttribute;
 390     DWORD  dwFlags;
 391     DWORD_PTR dwContext;
 392 };
 393
 394 struct WORKREQ_FTPDELETEFILEW
 395 {
 396     LPWSTR lpszFilename;
 397 };
 398
 399 struct WORKREQ_FTPREMOVEDIRECTORYW
 400 {
 401     LPWSTR lpszDirectory;
 402 };
 403
 404 struct WORKREQ_FTPRENAMEFILEW
 405 {
 406     LPWSTR lpszSrcFile;
 407     LPWSTR lpszDestFile;
 408 };
 409
 410 struct WORKREQ_FTPFINDNEXTW
 411 {
 412     LPWIN32_FIND_DATAW lpFindFileData;
 413 };
 414
 415 struct WORKREQ_HTTPSENDREQUESTW
 416 {
 417     LPWSTR lpszHeader;
 418     DWORD  dwHeaderLength;
 419     LPVOID lpOptional;
 420     DWORD  dwOptionalLength;
 421     DWORD  dwContentLength;
 422     BOOL   bEndRequest;
 423 };
 424
 425 struct WORKREQ_HTTPENDREQUESTW
 426 {
 427     DWORD     dwFlags;
 428     DWORD_PTR dwContext;
 429 };
 430
 431 struct WORKREQ_SENDCALLBACK
 432 {
 433     DWORD_PTR dwContext;
 434     DWORD     dwInternetStatus;
 435     LPVOID    lpvStatusInfo;
 436     DWORD     dwStatusInfoLength;
 437 };
 438
 439 struct WORKREQ_INTERNETOPENURLW
 440 {
 441     HINTERNET hInternet;
 442     LPWSTR     lpszUrl;
 443     LPWSTR     lpszHeaders;
 444     DWORD     dwHeadersLength;
 445     DWORD     dwFlags;
 446     DWORD_PTR dwContext;
 447 };
 448
 449 struct WORKREQ_INTERNETREADFILEEXA
 450 {
 451     LPINTERNET_BUFFERSA lpBuffersOut;
 452 };
 453
 454 struct WORKREQ_INTERNETREADFILEEXW
 455 {
 456     LPINTERNET_BUFFERSW lpBuffersOut;
 457 };
 458
 459 typedef struct WORKREQ
 460 {
 461     void (*asyncproc)(struct WORKREQ*);
 462     object_header_t *hdr;
 463
 464     union {
 465         struct WORKREQ_FTPPUTFILEW              FtpPutFileW;
 466         struct WORKREQ_FTPSETCURRENTDIRECTORYW  FtpSetCurrentDirectoryW;
 467         struct WORKREQ_FTPCREATEDIRECTORYW      FtpCreateDirectoryW;
 468         struct WORKREQ_FTPFINDFIRSTFILEW        FtpFindFirstFileW;
 469         struct WORKREQ_FTPGETCURRENTDIRECTORYW  FtpGetCurrentDirectoryW;
 470         struct WORKREQ_FTPOPENFILEW             FtpOpenFileW;
 471         struct WORKREQ_FTPGETFILEW              FtpGetFileW;
 472         struct WORKREQ_FTPDELETEFILEW           FtpDeleteFileW;
 473         struct WORKREQ_FTPREMOVEDIRECTORYW      FtpRemoveDirectoryW;
 474         struct WORKREQ_FTPRENAMEFILEW           FtpRenameFileW;
 475         struct WORKREQ_FTPFINDNEXTW             FtpFindNextW;
 476         struct WORKREQ_HTTPSENDREQUESTW         HttpSendRequestW;
 477         struct WORKREQ_HTTPENDREQUESTW          HttpEndRequestW;
 478         struct WORKREQ_SENDCALLBACK             SendCallback;
 479         struct WORKREQ_INTERNETOPENURLW         InternetOpenUrlW;
 480         struct WORKREQ_INTERNETREADFILEEXA      InternetReadFileExA;
 481         struct WORKREQ_INTERNETREADFILEEXW      InternetReadFileExW;
 482     } u;
 483
 484 } WORKREQUEST, *LPWORKREQUEST;
 485
 486 void *alloc_object(object_header_t*,const object_vtbl_t*,size_t) DECLSPEC_HIDDEN;
 487 object_header_t *get_handle_object( HINTERNET hinternet ) DECLSPEC_HIDDEN;
 488 object_header_t *WININET_AddRef( object_header_t *info ) DECLSPEC_HIDDEN;
 489 BOOL WININET_Release( object_header_t *info ) DECLSPEC_HIDDEN;
 490
 491 DWORD INET_QueryOption(object_header_t*,DWORD,void*,DWORD*,BOOL) DECLSPEC_HIDDEN;
 492 DWORD INET_SetOption(object_header_t*,DWORD,void*,DWORD) DECLSPEC_HIDDEN;
 493
 494 time_t ConvertTimeString(LPCWSTR asctime) DECLSPEC_HIDDEN;
 495
 496 HINTERNET FTP_Connect(appinfo_t *hIC, LPCWSTR lpszServerName,
 497         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
 498         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
 499         DWORD dwInternalFlags) DECLSPEC_HIDDEN;
 500
 501 DWORD HTTP_Connect(appinfo_t*,LPCWSTR,
 502         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
 503         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
 504         DWORD dwInternalFlags, HINTERNET*) DECLSPEC_HIDDEN;
 505
 506 BOOL GetAddress(LPCWSTR lpszServerName, INTERNET_PORT nServerPort,
 507         struct sockaddr *psa, socklen_t *sa_len) DECLSPEC_HIDDEN;
 508
 509 BOOL get_cookie(const WCHAR*,const WCHAR*,WCHAR*,DWORD*) DECLSPEC_HIDDEN;
 510 BOOL set_cookie(const WCHAR*,const WCHAR*,const WCHAR*,const WCHAR*) DECLSPEC_HIDDEN;
 511
 512 void INTERNET_SetLastError(DWORD dwError) DECLSPEC_HIDDEN;
 513 DWORD INTERNET_GetLastError(void) DECLSPEC_HIDDEN;
 514 DWORD INTERNET_AsyncCall(LPWORKREQUEST lpWorkRequest) DECLSPEC_HIDDEN;
 515 LPSTR INTERNET_GetResponseBuffer(void) DECLSPEC_HIDDEN;
 516 LPSTR INTERNET_GetNextLine(INT nSocket, LPDWORD dwLen) DECLSPEC_HIDDEN;
 517
 518 VOID SendAsyncCallback(object_header_t *hdr, DWORD_PTR dwContext,
 519                        DWORD dwInternetStatus, LPVOID lpvStatusInfo,
 520                        DWORD dwStatusInfoLength) DECLSPEC_HIDDEN;
 521
 522 VOID INTERNET_SendCallback(object_header_t *hdr, DWORD_PTR dwContext,
 523                            DWORD dwInternetStatus, LPVOID lpvStatusInfo,
 524                            DWORD dwStatusInfoLength) DECLSPEC_HIDDEN;
 525 BOOL INTERNET_FindProxyForProtocol(LPCWSTR szProxy, LPCWSTR proto, WCHAR *foundProxy, DWORD *foundProxyLen) DECLSPEC_HIDDEN;
 526
 527 DWORD create_netconn(BOOL, server_t *, DWORD, DWORD, netconn_t **) DECLSPEC_HIDDEN;
 528 void free_netconn(netconn_t*) DECLSPEC_HIDDEN;
 529 void NETCON_unload(void) DECLSPEC_HIDDEN;
 530 DWORD NETCON_secure_connect(netconn_t *connection) DECLSPEC_HIDDEN;
 531 DWORD NETCON_send(netconn_t *connection, const void *msg, size_t len, int flags,
 532                 int *sent /* out */) DECLSPEC_HIDDEN;
 533 DWORD NETCON_recv(netconn_t *connection, void *buf, size_t len, int flags,
 534                 int *recvd /* out */) DECLSPEC_HIDDEN;
 535 BOOL NETCON_query_data_available(netconn_t *connection, DWORD *available) DECLSPEC_HIDDEN;
 536 BOOL NETCON_is_alive(netconn_t*) DECLSPEC_HIDDEN;
 537 LPCVOID NETCON_GetCert(netconn_t *connection) DECLSPEC_HIDDEN;
 538 int NETCON_GetCipherStrength(netconn_t*) DECLSPEC_HIDDEN;
 539 DWORD NETCON_set_timeout(netconn_t *connection, BOOL send, DWORD value) DECLSPEC_HIDDEN;
 540 int sock_get_error(int) DECLSPEC_HIDDEN;
 541
 542 extern void URLCacheContainers_CreateDefaults(void) DECLSPEC_HIDDEN;
 543 extern void URLCacheContainers_DeleteAll(void) DECLSPEC_HIDDEN;
 544
 545 #define MAX_REPLY_LEN           0x5B4
 546
 547 /* Used for debugging - maybe need to be shared in the Wine debugging code ? */
 548 typedef struct
 549 {
 550     DWORD val;
 551     const char* name;
 552 } wininet_flag_info;
 553
 554 #endif /* _WINE_INTERNET_H_ */