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