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_OPENSSL_SSL_H
  42 #define DSA __ssl_DSA  /* avoid conflict with commctrl.h */
  43 #undef FAR
  44 /* avoid conflict with wincrypt.h */
  45 #undef PKCS7_SIGNER_INFO
  46 #undef X509_NAME
  47 #undef X509_CERT_PAIR
  48 # include <openssl/ssl.h>
  49 #undef FAR
  50 #define FAR do_not_use_this_in_wine
  51 #undef DSA
  52 #endif
  53 #ifdef HAVE_SYS_SOCKET_H
  54 # include <sys/socket.h>
  55 #endif
  56
  57 #if defined(__MINGW32__) || defined (_MSC_VER)
  58 #include "winsock2.h"
  59 #ifndef MSG_WAITALL
  60 #define MSG_WAITALL 0
  61 #endif
  62 #else
  63 #define closesocket close
  64 #endif /* __MINGW32__ */
  65
  66 /* used for netconnection.c stuff */
  67 typedef struct
  68 {
  69     BOOL useSSL;
  70     int socketFD;
  71 #ifdef HAVE_OPENSSL_SSL_H
  72     SSL *ssl_s;
  73     char *peek_msg;
  74     char *peek_msg_mem;
  75     size_t peek_len;
  76 #endif
  77 } WININET_NETCONNECTION;
  78
  79 static inline LPWSTR WININET_strdupW( LPCWSTR str )
  80 {
  81     LPWSTR ret = HeapAlloc( GetProcessHeap(), 0, (strlenW(str) + 1)*sizeof(WCHAR) );
  82     if (ret) strcpyW( ret, str );
  83     return ret;
  84 }
  85
  86 static inline LPWSTR WININET_strdup_AtoW( LPCSTR str )
  87 {
  88     int len = MultiByteToWideChar( CP_ACP, 0, str, -1, NULL, 0);
  89     LPWSTR ret = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) );
  90     if (ret)
  91         MultiByteToWideChar( CP_ACP, 0, str, -1, ret, len);
  92     return ret;
  93 }
  94
  95 static inline LPSTR WININET_strdup_WtoA( LPCWSTR str )
  96 {
  97     int len = WideCharToMultiByte( CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
  98     LPSTR ret = HeapAlloc( GetProcessHeap(), 0, len );
  99     if (ret)
 100         WideCharToMultiByte( CP_ACP, 0, str, -1, ret, len, NULL, NULL);
 101     return ret;
 102 }
 103
 104 static inline void WININET_find_data_WtoA(LPWIN32_FIND_DATAW dataW, LPWIN32_FIND_DATAA dataA)
 105 {
 106     dataA->dwFileAttributes = dataW->dwFileAttributes;
 107     dataA->ftCreationTime   = dataW->ftCreationTime;
 108     dataA->ftLastAccessTime = dataW->ftLastAccessTime;
 109     dataA->ftLastWriteTime  = dataW->ftLastWriteTime;
 110     dataA->nFileSizeHigh    = dataW->nFileSizeHigh;
 111     dataA->nFileSizeLow     = dataW->nFileSizeLow;
 112     dataA->dwReserved0      = dataW->dwReserved0;
 113     dataA->dwReserved1      = dataW->dwReserved1;
 114     WideCharToMultiByte(CP_ACP, 0, dataW->cFileName, -1,
 115         dataA->cFileName, sizeof(dataA->cFileName),
 116         NULL, NULL);
 117     WideCharToMultiByte(CP_ACP, 0, dataW->cAlternateFileName, -1,
 118         dataA->cAlternateFileName, sizeof(dataA->cAlternateFileName),
 119         NULL, NULL);
 120 }
 121
 122 typedef enum
 123 {
 124     WH_HINIT = INTERNET_HANDLE_TYPE_INTERNET,
 125     WH_HFTPSESSION = INTERNET_HANDLE_TYPE_CONNECT_FTP,
 126     WH_HGOPHERSESSION = INTERNET_HANDLE_TYPE_CONNECT_GOPHER,
 127     WH_HHTTPSESSION = INTERNET_HANDLE_TYPE_CONNECT_HTTP,
 128     WH_HFILE = INTERNET_HANDLE_TYPE_FTP_FILE,
 129     WH_HFTPFINDNEXT = INTERNET_HANDLE_TYPE_FTP_FIND,
 130     WH_HHTTPREQ = INTERNET_HANDLE_TYPE_HTTP_REQUEST,
 131 } WH_TYPE;
 132
 133 #define INET_OPENURL 0x0001
 134 #define INET_CALLBACKW 0x0002
 135
 136 struct _WININETHANDLEHEADER;
 137 typedef struct _WININETHANDLEHEADER WININETHANDLEHEADER, *LPWININETHANDLEHEADER;
 138
 139 typedef void (*WININET_object_function)( LPWININETHANDLEHEADER );
 140
 141 struct _WININETHANDLEHEADER
 142 {
 143     WH_TYPE htype;
 144     HINTERNET hInternet;
 145     DWORD  dwFlags;
 146     DWORD_PTR dwContext;
 147     DWORD  dwError;
 148     DWORD  dwInternalFlags;
 149     DWORD  dwRefCount;
 150     WININET_object_function close_connection;
 151     WININET_object_function destroy;
 152     INTERNET_STATUS_CALLBACK lpfnStatusCB;
 153     struct list entry;
 154     struct list children;
 155 };
 156
 157
 158 typedef struct
 159 {
 160     WININETHANDLEHEADER hdr;
 161     LPWSTR  lpszAgent;
 162     LPWSTR  lpszProxy;
 163     LPWSTR  lpszProxyBypass;
 164     LPWSTR  lpszProxyUsername;
 165     LPWSTR  lpszProxyPassword;
 166     DWORD   dwAccessType;
 167 } WININETAPPINFOW, *LPWININETAPPINFOW;
 168
 169
 170 typedef struct
 171 {
 172     WININETHANDLEHEADER hdr;
 173     WININETAPPINFOW *lpAppInfo;
 174     LPWSTR  lpszHostName; /* the final destination of the request */
 175     LPWSTR  lpszServerName; /* the name of the server we directly connect to */
 176     LPWSTR  lpszUserName;
 177     LPWSTR  lpszPassword;
 178     INTERNET_PORT nHostPort; /* the final destination port of the request */
 179     INTERNET_PORT nServerPort; /* the port of the server we directly connect to */
 180     struct sockaddr_in socketAddress;
 181 } WININETHTTPSESSIONW, *LPWININETHTTPSESSIONW;
 182
 183 #define HDR_ISREQUEST           0x0001
 184 #define HDR_COMMADELIMITED      0x0002
 185 #define HDR_SEMIDELIMITED       0x0004
 186
 187 typedef struct
 188 {
 189     LPWSTR lpszField;
 190     LPWSTR lpszValue;
 191     WORD wFlags;
 192     WORD wCount;
 193 } HTTPHEADERW, *LPHTTPHEADERW;
 194
 195
 196 struct HttpAuthInfo;
 197
 198 typedef struct
 199 {
 200     WININETHANDLEHEADER hdr;
 201     WININETHTTPSESSIONW *lpHttpSession;
 202     LPWSTR lpszPath;
 203     LPWSTR lpszVerb;
 204     LPWSTR lpszRawHeaders;
 205     WININET_NETCONNECTION netConnection;
 206     LPWSTR lpszVersion;
 207     LPWSTR lpszStatusText;
 208     DWORD dwContentLength; /* total number of bytes to be read */
 209     DWORD dwContentRead; /* bytes of the content read so far */
 210     HTTPHEADERW *pCustHeaders;
 211     DWORD nCustHeaders;
 212     HANDLE hCacheFile;
 213     LPWSTR lpszCacheFile;
 214     struct HttpAuthInfo *pAuthInfo;
 215     struct HttpAuthInfo *pProxyAuthInfo;
 216 } WININETHTTPREQW, *LPWININETHTTPREQW;
 217
 218
 219 struct _WININETFTPSESSIONW;
 220
 221 typedef struct
 222 {
 223     WININETHANDLEHEADER hdr;
 224     struct _WININETFTPSESSIONW *lpFtpSession;
 225     BOOL session_deleted;
 226     int nDataSocket;
 227 } WININETFTPFILE, *LPWININETFTPFILE;
 228
 229
 230 typedef struct _WININETFTPSESSIONW
 231 {
 232     WININETHANDLEHEADER hdr;
 233     WININETAPPINFOW *lpAppInfo;
 234     int sndSocket;
 235     int lstnSocket;
 236     int pasvSocket; /* data socket connected by us in case of passive FTP */
 237     LPWININETFTPFILE download_in_progress;
 238     struct sockaddr_in socketAddress;
 239     struct sockaddr_in lstnSocketAddress;
 240     LPWSTR  lpszPassword;
 241     LPWSTR  lpszUserName;
 242 } WININETFTPSESSIONW, *LPWININETFTPSESSIONW;
 243
 244
 245 typedef struct
 246 {
 247     BOOL bIsDirectory;
 248     LPWSTR lpszName;
 249     DWORD nSize;
 250     struct tm tmLastModified;
 251     unsigned short permissions;
 252 } FILEPROPERTIESW, *LPFILEPROPERTIESW;
 253
 254
 255 typedef struct
 256 {
 257     WININETHANDLEHEADER hdr;
 258     WININETFTPSESSIONW *lpFtpSession;
 259     DWORD index;
 260     DWORD size;
 261     LPFILEPROPERTIESW lpafp;
 262 } WININETFTPFINDNEXTW, *LPWININETFTPFINDNEXTW;
 263
 264 struct WORKREQ_FTPPUTFILEW
 265 {
 266     LPWSTR lpszLocalFile;
 267     LPWSTR lpszNewRemoteFile;
 268     DWORD  dwFlags;
 269     DWORD_PTR dwContext;
 270 };
 271
 272 struct WORKREQ_FTPSETCURRENTDIRECTORYW
 273 {
 274     LPWSTR lpszDirectory;
 275 };
 276
 277 struct WORKREQ_FTPCREATEDIRECTORYW
 278 {
 279     LPWSTR lpszDirectory;
 280 };
 281
 282 struct WORKREQ_FTPFINDFIRSTFILEW
 283 {
 284     LPWSTR lpszSearchFile;
 285     LPWIN32_FIND_DATAW lpFindFileData;
 286     DWORD  dwFlags;
 287     DWORD_PTR dwContext;
 288 };
 289
 290 struct WORKREQ_FTPGETCURRENTDIRECTORYW
 291 {
 292     LPWSTR lpszDirectory;
 293     DWORD *lpdwDirectory;
 294 };
 295
 296 struct WORKREQ_FTPOPENFILEW
 297 {
 298     LPWSTR lpszFilename;
 299     DWORD  dwAccess;
 300     DWORD  dwFlags;
 301     DWORD_PTR dwContext;
 302 };
 303
 304 struct WORKREQ_FTPGETFILEW
 305 {
 306     LPWSTR lpszRemoteFile;
 307     LPWSTR lpszNewFile;
 308     BOOL   fFailIfExists;
 309     DWORD  dwLocalFlagsAttribute;
 310     DWORD  dwFlags;
 311     DWORD_PTR dwContext;
 312 };
 313
 314 struct WORKREQ_FTPDELETEFILEW
 315 {
 316     LPWSTR lpszFilename;
 317 };
 318
 319 struct WORKREQ_FTPREMOVEDIRECTORYW
 320 {
 321     LPWSTR lpszDirectory;
 322 };
 323
 324 struct WORKREQ_FTPRENAMEFILEW
 325 {
 326     LPWSTR lpszSrcFile;
 327     LPWSTR lpszDestFile;
 328 };
 329
 330 struct WORKREQ_FTPFINDNEXTW
 331 {
 332     LPWIN32_FIND_DATAW lpFindFileData;
 333 };
 334
 335 struct WORKREQ_HTTPSENDREQUESTW
 336 {
 337     LPWSTR lpszHeader;
 338     DWORD  dwHeaderLength;
 339     LPVOID lpOptional;
 340     DWORD  dwOptionalLength;
 341     DWORD  dwContentLength;
 342     BOOL   bEndRequest;
 343 };
 344
 345 struct WORKREQ_SENDCALLBACK
 346 {
 347     DWORD_PTR dwContext;
 348     DWORD     dwInternetStatus;
 349     LPVOID    lpvStatusInfo;
 350     DWORD     dwStatusInfoLength;
 351 };
 352
 353 struct WORKREQ_INTERNETOPENURLW
 354 {
 355     HINTERNET hInternet;
 356     LPWSTR     lpszUrl;
 357     LPWSTR     lpszHeaders;
 358     DWORD     dwHeadersLength;
 359     DWORD     dwFlags;
 360     DWORD_PTR dwContext;
 361 };
 362
 363 struct WORKREQ_INTERNETREADFILEEXA
 364 {
 365     LPINTERNET_BUFFERSA lpBuffersOut;
 366 };
 367
 368 typedef struct WORKREQ
 369 {
 370     void (*asyncproc)(struct WORKREQ*);
 371     WININETHANDLEHEADER *hdr;
 372
 373     union {
 374         struct WORKREQ_FTPPUTFILEW              FtpPutFileW;
 375         struct WORKREQ_FTPSETCURRENTDIRECTORYW  FtpSetCurrentDirectoryW;
 376         struct WORKREQ_FTPCREATEDIRECTORYW      FtpCreateDirectoryW;
 377         struct WORKREQ_FTPFINDFIRSTFILEW        FtpFindFirstFileW;
 378         struct WORKREQ_FTPGETCURRENTDIRECTORYW  FtpGetCurrentDirectoryW;
 379         struct WORKREQ_FTPOPENFILEW             FtpOpenFileW;
 380         struct WORKREQ_FTPGETFILEW              FtpGetFileW;
 381         struct WORKREQ_FTPDELETEFILEW           FtpDeleteFileW;
 382         struct WORKREQ_FTPREMOVEDIRECTORYW      FtpRemoveDirectoryW;
 383         struct WORKREQ_FTPRENAMEFILEW           FtpRenameFileW;
 384         struct WORKREQ_FTPFINDNEXTW             FtpFindNextW;
 385         struct WORKREQ_HTTPSENDREQUESTW         HttpSendRequestW;
 386         struct WORKREQ_SENDCALLBACK             SendCallback;
 387         struct WORKREQ_INTERNETOPENURLW         InternetOpenUrlW;
 388         struct WORKREQ_INTERNETREADFILEEXA      InternetReadFileExA;
 389     } u;
 390
 391 } WORKREQUEST, *LPWORKREQUEST;
 392
 393 HINTERNET WININET_AllocHandle( LPWININETHANDLEHEADER info );
 394 LPWININETHANDLEHEADER WININET_GetObject( HINTERNET hinternet );
 395 LPWININETHANDLEHEADER WININET_AddRef( LPWININETHANDLEHEADER info );
 396 BOOL WININET_Release( LPWININETHANDLEHEADER info );
 397 BOOL WININET_FreeHandle( HINTERNET hinternet );
 398
 399 time_t ConvertTimeString(LPCWSTR asctime);
 400
 401 HINTERNET FTP_Connect(LPWININETAPPINFOW hIC, LPCWSTR lpszServerName,
 402         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
 403         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
 404         DWORD dwInternalFlags);
 405
 406 HINTERNET HTTP_Connect(LPWININETAPPINFOW hIC, LPCWSTR lpszServerName,
 407         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
 408         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
 409         DWORD dwInternalFlags);
 410
 411 BOOL GetAddress(LPCWSTR lpszServerName, INTERNET_PORT nServerPort,
 412         struct sockaddr_in *psa);
 413
 414 void INTERNET_SetLastError(DWORD dwError);
 415 DWORD INTERNET_GetLastError(void);
 416 BOOL INTERNET_AsyncCall(LPWORKREQUEST lpWorkRequest);
 417 LPSTR INTERNET_GetResponseBuffer(void);
 418 LPSTR INTERNET_GetNextLine(INT nSocket, LPDWORD dwLen);
 419 BOOL INTERNET_ReadFile(LPWININETHANDLEHEADER lpwh, LPVOID lpBuffer,
 420                        DWORD dwNumOfBytesToRead, LPDWORD pdwNumOfBytesRead,
 421                        BOOL bWait, BOOL bSendCompletionStatus);
 422
 423 BOOLAPI FTP_FtpPutFileW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszLocalFile,
 424     LPCWSTR lpszNewRemoteFile, DWORD dwFlags, DWORD_PTR dwContext);
 425 BOOLAPI FTP_FtpSetCurrentDirectoryW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszDirectory);
 426 BOOLAPI FTP_FtpCreateDirectoryW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszDirectory);
 427 INTERNETAPI HINTERNET WINAPI FTP_FtpFindFirstFileW(LPWININETFTPSESSIONW lpwfs,
 428     LPCWSTR lpszSearchFile, LPWIN32_FIND_DATAW lpFindFileData, DWORD dwFlags, DWORD_PTR dwContext);
 429 BOOL WINAPI FTP_FindNextFileW(LPWININETFTPFINDNEXTW lpwh, LPVOID lpvFindData);
 430 BOOLAPI FTP_FtpGetCurrentDirectoryW(LPWININETFTPSESSIONW lpwfs, LPWSTR lpszCurrentDirectory,
 431         LPDWORD lpdwCurrentDirectory);
 432 BOOL FTP_ConvertFileProp(LPFILEPROPERTIESW lpafp, LPWIN32_FIND_DATAW lpFindFileData);
 433 BOOL FTP_FtpRenameFileW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszSrc, LPCWSTR lpszDest);
 434 BOOL FTP_FtpRemoveDirectoryW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszDirectory);
 435 BOOL FTP_FtpDeleteFileW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszFileName);
 436 HINTERNET FTP_FtpOpenFileW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszFileName,
 437         DWORD fdwAccess, DWORD dwFlags, DWORD_PTR dwContext);
 438 BOOLAPI FTP_FtpGetFileW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszRemoteFile, LPCWSTR lpszNewFile,
 439         BOOL fFailIfExists, DWORD dwLocalFlagsAttribute, DWORD dwInternetFlags,
 440         DWORD_PTR dwContext);
 441
 442 BOOLAPI HTTP_HttpSendRequestW(LPWININETHTTPREQW lpwhr, LPCWSTR lpszHeaders,
 443         DWORD dwHeaderLength, LPVOID lpOptional, DWORD dwOptionalLength,
 444         DWORD dwContentLength, BOOL bEndRequest);
 445 INTERNETAPI HINTERNET WINAPI HTTP_HttpOpenRequestW(LPWININETHTTPSESSIONW lpwhs,
 446         LPCWSTR lpszVerb, LPCWSTR lpszObjectName, LPCWSTR lpszVersion,
 447         LPCWSTR lpszReferrer , LPCWSTR *lpszAcceptTypes,
 448         DWORD dwFlags, DWORD_PTR dwContext);
 449 BOOL HTTP_FinishedReading(LPWININETHTTPREQW lpwhr);
 450
 451 VOID SendAsyncCallback(LPWININETHANDLEHEADER hdr, DWORD_PTR dwContext,
 452                        DWORD dwInternetStatus, LPVOID lpvStatusInfo,
 453                        DWORD dwStatusInfoLength);
 454
 455 VOID INTERNET_SendCallback(LPWININETHANDLEHEADER hdr, DWORD_PTR dwContext,
 456                            DWORD dwInternetStatus, LPVOID lpvStatusInfo,
 457                            DWORD dwStatusInfoLength);
 458
 459 LPHTTPHEADERW HTTP_GetHeader(LPWININETHTTPREQW lpwhr, LPCWSTR header);
 460
 461 BOOL NETCON_connected(WININET_NETCONNECTION *connection);
 462 BOOL NETCON_init(WININET_NETCONNECTION *connnection, BOOL useSSL);
 463 BOOL NETCON_create(WININET_NETCONNECTION *connection, int domain,
 464               int type, int protocol);
 465 BOOL NETCON_close(WININET_NETCONNECTION *connection);
 466 BOOL NETCON_connect(WININET_NETCONNECTION *connection, const struct sockaddr *serv_addr,
 467                     unsigned int addrlen);
 468 BOOL NETCON_secure_connect(WININET_NETCONNECTION *connection, LPCWSTR hostname);
 469 BOOL NETCON_send(WININET_NETCONNECTION *connection, const void *msg, size_t len, int flags,
 470                 int *sent /* out */);
 471 BOOL NETCON_recv(WININET_NETCONNECTION *connection, void *buf, size_t len, int flags,
 472                 int *recvd /* out */);
 473 BOOL NETCON_query_data_available(WININET_NETCONNECTION *connection, DWORD *available);
 474 BOOL NETCON_getNextLine(WININET_NETCONNECTION *connection, LPSTR lpszBuffer, LPDWORD dwBuffer);
 475 LPCVOID NETCON_GetCert(WININET_NETCONNECTION *connection);
 476 BOOL NETCON_set_timeout(WININET_NETCONNECTION *connection, BOOL send, int value);
 477
 478 extern void URLCacheContainers_CreateDefaults(void);
 479 extern void URLCacheContainers_DeleteAll(void);
 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 #endif /* _WINE_INTERNET_H_ */