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     struct HttpAuthInfo *pAuthInfo;
 213     struct HttpAuthInfo *pProxyAuthInfo;
 214 } WININETHTTPREQW, *LPWININETHTTPREQW;
 215
 216
 217 struct _WININETFTPSESSIONW;
 218
 219 typedef struct
 220 {
 221     WININETHANDLEHEADER hdr;
 222     struct _WININETFTPSESSIONW *lpFtpSession;
 223     BOOL session_deleted;
 224     int nDataSocket;
 225 } WININETFTPFILE, *LPWININETFTPFILE;
 226
 227
 228 typedef struct _WININETFTPSESSIONW
 229 {
 230     WININETHANDLEHEADER hdr;
 231     WININETAPPINFOW *lpAppInfo;
 232     int sndSocket;
 233     int lstnSocket;
 234     int pasvSocket; /* data socket connected by us in case of passive FTP */
 235     LPWININETFTPFILE download_in_progress;
 236     struct sockaddr_in socketAddress;
 237     struct sockaddr_in lstnSocketAddress;
 238     LPWSTR  lpszPassword;
 239     LPWSTR  lpszUserName;
 240 } WININETFTPSESSIONW, *LPWININETFTPSESSIONW;
 241
 242
 243 typedef struct
 244 {
 245     BOOL bIsDirectory;
 246     LPWSTR lpszName;
 247     DWORD nSize;
 248     struct tm tmLastModified;
 249     unsigned short permissions;
 250 } FILEPROPERTIESW, *LPFILEPROPERTIESW;
 251
 252
 253 typedef struct
 254 {
 255     WININETHANDLEHEADER hdr;
 256     WININETFTPSESSIONW *lpFtpSession;
 257     DWORD index;
 258     DWORD size;
 259     LPFILEPROPERTIESW lpafp;
 260 } WININETFTPFINDNEXTW, *LPWININETFTPFINDNEXTW;
 261
 262 struct WORKREQ_FTPPUTFILEW
 263 {
 264     LPWSTR lpszLocalFile;
 265     LPWSTR lpszNewRemoteFile;
 266     DWORD  dwFlags;
 267     DWORD_PTR dwContext;
 268 };
 269
 270 struct WORKREQ_FTPSETCURRENTDIRECTORYW
 271 {
 272     LPWSTR lpszDirectory;
 273 };
 274
 275 struct WORKREQ_FTPCREATEDIRECTORYW
 276 {
 277     LPWSTR lpszDirectory;
 278 };
 279
 280 struct WORKREQ_FTPFINDFIRSTFILEW
 281 {
 282     LPWSTR lpszSearchFile;
 283     LPWIN32_FIND_DATAW lpFindFileData;
 284     DWORD  dwFlags;
 285     DWORD_PTR dwContext;
 286 };
 287
 288 struct WORKREQ_FTPGETCURRENTDIRECTORYW
 289 {
 290     LPWSTR lpszDirectory;
 291     DWORD *lpdwDirectory;
 292 };
 293
 294 struct WORKREQ_FTPOPENFILEW
 295 {
 296     LPWSTR lpszFilename;
 297     DWORD  dwAccess;
 298     DWORD  dwFlags;
 299     DWORD_PTR dwContext;
 300 };
 301
 302 struct WORKREQ_FTPGETFILEW
 303 {
 304     LPWSTR lpszRemoteFile;
 305     LPWSTR lpszNewFile;
 306     BOOL   fFailIfExists;
 307     DWORD  dwLocalFlagsAttribute;
 308     DWORD  dwFlags;
 309     DWORD_PTR dwContext;
 310 };
 311
 312 struct WORKREQ_FTPDELETEFILEW
 313 {
 314     LPWSTR lpszFilename;
 315 };
 316
 317 struct WORKREQ_FTPREMOVEDIRECTORYW
 318 {
 319     LPWSTR lpszDirectory;
 320 };
 321
 322 struct WORKREQ_FTPRENAMEFILEW
 323 {
 324     LPWSTR lpszSrcFile;
 325     LPWSTR lpszDestFile;
 326 };
 327
 328 struct WORKREQ_FTPFINDNEXTW
 329 {
 330     LPWIN32_FIND_DATAW lpFindFileData;
 331 };
 332
 333 struct WORKREQ_HTTPSENDREQUESTW
 334 {
 335     LPWSTR lpszHeader;
 336     DWORD  dwHeaderLength;
 337     LPVOID lpOptional;
 338     DWORD  dwOptionalLength;
 339     DWORD  dwContentLength;
 340     BOOL   bEndRequest;
 341 };
 342
 343 struct WORKREQ_SENDCALLBACK
 344 {
 345     DWORD_PTR dwContext;
 346     DWORD     dwInternetStatus;
 347     LPVOID    lpvStatusInfo;
 348     DWORD     dwStatusInfoLength;
 349 };
 350
 351 struct WORKREQ_INTERNETOPENURLW
 352 {
 353     HINTERNET hInternet;
 354     LPWSTR     lpszUrl;
 355     LPWSTR     lpszHeaders;
 356     DWORD     dwHeadersLength;
 357     DWORD     dwFlags;
 358     DWORD_PTR dwContext;
 359 };
 360
 361 struct WORKREQ_INTERNETREADFILEEXA
 362 {
 363     LPINTERNET_BUFFERSA lpBuffersOut;
 364 };
 365
 366 typedef struct WORKREQ
 367 {
 368     void (*asyncproc)(struct WORKREQ*);
 369     WININETHANDLEHEADER *hdr;
 370
 371     union {
 372         struct WORKREQ_FTPPUTFILEW              FtpPutFileW;
 373         struct WORKREQ_FTPSETCURRENTDIRECTORYW  FtpSetCurrentDirectoryW;
 374         struct WORKREQ_FTPCREATEDIRECTORYW      FtpCreateDirectoryW;
 375         struct WORKREQ_FTPFINDFIRSTFILEW        FtpFindFirstFileW;
 376         struct WORKREQ_FTPGETCURRENTDIRECTORYW  FtpGetCurrentDirectoryW;
 377         struct WORKREQ_FTPOPENFILEW             FtpOpenFileW;
 378         struct WORKREQ_FTPGETFILEW              FtpGetFileW;
 379         struct WORKREQ_FTPDELETEFILEW           FtpDeleteFileW;
 380         struct WORKREQ_FTPREMOVEDIRECTORYW      FtpRemoveDirectoryW;
 381         struct WORKREQ_FTPRENAMEFILEW           FtpRenameFileW;
 382         struct WORKREQ_FTPFINDNEXTW             FtpFindNextW;
 383         struct WORKREQ_HTTPSENDREQUESTW         HttpSendRequestW;
 384         struct WORKREQ_SENDCALLBACK             SendCallback;
 385         struct WORKREQ_INTERNETOPENURLW         InternetOpenUrlW;
 386         struct WORKREQ_INTERNETREADFILEEXA      InternetReadFileExA;
 387     } u;
 388
 389 } WORKREQUEST, *LPWORKREQUEST;
 390
 391 HINTERNET WININET_AllocHandle( LPWININETHANDLEHEADER info );
 392 LPWININETHANDLEHEADER WININET_GetObject( HINTERNET hinternet );
 393 LPWININETHANDLEHEADER WININET_AddRef( LPWININETHANDLEHEADER info );
 394 BOOL WININET_Release( LPWININETHANDLEHEADER info );
 395 BOOL WININET_FreeHandle( HINTERNET hinternet );
 396
 397 time_t ConvertTimeString(LPCWSTR asctime);
 398
 399 HINTERNET FTP_Connect(LPWININETAPPINFOW hIC, LPCWSTR lpszServerName,
 400         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
 401         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
 402         DWORD dwInternalFlags);
 403
 404 HINTERNET HTTP_Connect(LPWININETAPPINFOW hIC, LPCWSTR lpszServerName,
 405         INTERNET_PORT nServerPort, LPCWSTR lpszUserName,
 406         LPCWSTR lpszPassword, DWORD dwFlags, DWORD_PTR dwContext,
 407         DWORD dwInternalFlags);
 408
 409 BOOL GetAddress(LPCWSTR lpszServerName, INTERNET_PORT nServerPort,
 410         struct sockaddr_in *psa);
 411
 412 void INTERNET_SetLastError(DWORD dwError);
 413 DWORD INTERNET_GetLastError(void);
 414 BOOL INTERNET_AsyncCall(LPWORKREQUEST lpWorkRequest);
 415 LPSTR INTERNET_GetResponseBuffer(void);
 416 LPSTR INTERNET_GetNextLine(INT nSocket, LPDWORD dwLen);
 417 BOOL INTERNET_ReadFile(LPWININETHANDLEHEADER lpwh, LPVOID lpBuffer,
 418                        DWORD dwNumOfBytesToRead, LPDWORD pdwNumOfBytesRead,
 419                        BOOL bWait, BOOL bSendCompletionStatus);
 420
 421 BOOLAPI FTP_FtpPutFileW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszLocalFile,
 422     LPCWSTR lpszNewRemoteFile, DWORD dwFlags, DWORD_PTR dwContext);
 423 BOOLAPI FTP_FtpSetCurrentDirectoryW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszDirectory);
 424 BOOLAPI FTP_FtpCreateDirectoryW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszDirectory);
 425 INTERNETAPI HINTERNET WINAPI FTP_FtpFindFirstFileW(LPWININETFTPSESSIONW lpwfs,
 426     LPCWSTR lpszSearchFile, LPWIN32_FIND_DATAW lpFindFileData, DWORD dwFlags, DWORD_PTR dwContext);
 427 BOOL WINAPI FTP_FindNextFileW(LPWININETFTPFINDNEXTW lpwh, LPVOID lpvFindData);
 428 BOOLAPI FTP_FtpGetCurrentDirectoryW(LPWININETFTPSESSIONW lpwfs, LPWSTR lpszCurrentDirectory,
 429         LPDWORD lpdwCurrentDirectory);
 430 BOOL FTP_ConvertFileProp(LPFILEPROPERTIESW lpafp, LPWIN32_FIND_DATAW lpFindFileData);
 431 BOOL FTP_FtpRenameFileW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszSrc, LPCWSTR lpszDest);
 432 BOOL FTP_FtpRemoveDirectoryW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszDirectory);
 433 BOOL FTP_FtpDeleteFileW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszFileName);
 434 HINTERNET FTP_FtpOpenFileW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszFileName,
 435         DWORD fdwAccess, DWORD dwFlags, DWORD_PTR dwContext);
 436 BOOLAPI FTP_FtpGetFileW(LPWININETFTPSESSIONW lpwfs, LPCWSTR lpszRemoteFile, LPCWSTR lpszNewFile,
 437         BOOL fFailIfExists, DWORD dwLocalFlagsAttribute, DWORD dwInternetFlags,
 438         DWORD_PTR dwContext);
 439
 440 BOOLAPI HTTP_HttpSendRequestW(LPWININETHTTPREQW lpwhr, LPCWSTR lpszHeaders,
 441         DWORD dwHeaderLength, LPVOID lpOptional, DWORD dwOptionalLength,
 442         DWORD dwContentLength, BOOL bEndRequest);
 443 INTERNETAPI HINTERNET WINAPI HTTP_HttpOpenRequestW(LPWININETHTTPSESSIONW lpwhs,
 444         LPCWSTR lpszVerb, LPCWSTR lpszObjectName, LPCWSTR lpszVersion,
 445         LPCWSTR lpszReferrer , LPCWSTR *lpszAcceptTypes,
 446         DWORD dwFlags, DWORD_PTR dwContext);
 447 BOOL HTTP_FinishedReading(LPWININETHTTPREQW lpwhr);
 448
 449 VOID SendAsyncCallback(LPWININETHANDLEHEADER hdr, DWORD_PTR dwContext,
 450                        DWORD dwInternetStatus, LPVOID lpvStatusInfo,
 451                        DWORD dwStatusInfoLength);
 452
 453 VOID INTERNET_SendCallback(LPWININETHANDLEHEADER hdr, DWORD_PTR dwContext,
 454                            DWORD dwInternetStatus, LPVOID lpvStatusInfo,
 455                            DWORD dwStatusInfoLength);
 456
 457 LPHTTPHEADERW HTTP_GetHeader(LPWININETHTTPREQW lpwhr, LPCWSTR header);
 458
 459 BOOL NETCON_connected(WININET_NETCONNECTION *connection);
 460 BOOL NETCON_init(WININET_NETCONNECTION *connnection, BOOL useSSL);
 461 BOOL NETCON_create(WININET_NETCONNECTION *connection, int domain,
 462               int type, int protocol);
 463 BOOL NETCON_close(WININET_NETCONNECTION *connection);
 464 BOOL NETCON_connect(WININET_NETCONNECTION *connection, const struct sockaddr *serv_addr,
 465                     unsigned int addrlen);
 466 BOOL NETCON_secure_connect(WININET_NETCONNECTION *connection, LPCWSTR hostname);
 467 BOOL NETCON_send(WININET_NETCONNECTION *connection, const void *msg, size_t len, int flags,
 468                 int *sent /* out */);
 469 BOOL NETCON_recv(WININET_NETCONNECTION *connection, void *buf, size_t len, int flags,
 470                 int *recvd /* out */);
 471 BOOL NETCON_query_data_available(WININET_NETCONNECTION *connection, DWORD *available);
 472 BOOL NETCON_getNextLine(WININET_NETCONNECTION *connection, LPSTR lpszBuffer, LPDWORD dwBuffer);
 473 LPCVOID NETCON_GetCert(WININET_NETCONNECTION *connection);
 474 BOOL NETCON_set_timeout(WININET_NETCONNECTION *connection, BOOL send, int value);
 475
 476 extern void URLCacheContainers_CreateDefaults(void);
 477 extern void URLCacheContainers_DeleteAll(void);
 478
 479 #define MAX_REPLY_LEN           0x5B4
 480
 481 /* Used for debugging - maybe need to be shared in the Wine debugging code ? */
 482 typedef struct
 483 {
 484     DWORD val;
 485     const char* name;
 486 } wininet_flag_info;
 487
 488 #endif /* _WINE_INTERNET_H_ */