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