dlls/urlmon/urlmon_main.h

   1 /*
   2  * Copyright 2002 Huw D M Davies for CodeWeavers
   3  * Copyright 2009 Jacek Caban for CodeWeavers
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  18  */
  19
  20 #ifndef __WINE_URLMON_MAIN_H
  21 #define __WINE_URLMON_MAIN_H
  22
  23 #include <stdarg.h>
  24
  25 #define COBJMACROS
  26 #define NONAMELESSUNION
  27 #define NONAMELESSSTRUCT
  28
  29 #include "windef.h"
  30 #include "winbase.h"
  31 #include "winuser.h"
  32 #include "ole2.h"
  33 #include "urlmon.h"
  34 #include "wininet.h"
  35
  36 #include "wine/unicode.h"
  37 #include "wine/list.h"
  38
  39 extern HINSTANCE hProxyDll DECLSPEC_HIDDEN;
  40 extern HRESULT SecManagerImpl_Construct(IUnknown *pUnkOuter, LPVOID *ppobj);
  41 extern HRESULT ZoneMgrImpl_Construct(IUnknown *pUnkOuter, LPVOID *ppobj);
  42 extern HRESULT StdURLMoniker_Construct(IUnknown *pUnkOuter, LPVOID *ppobj);
  43 extern HRESULT FileProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj);
  44 extern HRESULT HttpProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj);
  45 extern HRESULT HttpSProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj);
  46 extern HRESULT FtpProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj);
  47 extern HRESULT GopherProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj);
  48 extern HRESULT MkProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj);
  49 extern HRESULT MimeFilter_Construct(IUnknown *pUnkOuter, LPVOID *ppobj);
  50
  51 extern BOOL WINAPI URLMON_DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved) DECLSPEC_HIDDEN;
  52 extern HRESULT WINAPI URLMON_DllGetClassObject(REFCLSID rclsid, REFIID iid,LPVOID *ppv) DECLSPEC_HIDDEN;
  53 extern HRESULT WINAPI URLMON_DllRegisterServer(void) DECLSPEC_HIDDEN;
  54 extern HRESULT WINAPI URLMON_DllUnregisterServer(void) DECLSPEC_HIDDEN;
  55
  56 extern GUID const CLSID_PSFactoryBuffer DECLSPEC_HIDDEN;
  57
  58 /**********************************************************************
  59  * Dll lifetime tracking declaration for urlmon.dll
  60  */
  61 extern LONG URLMON_refCount;
  62 static inline void URLMON_LockModule(void) { InterlockedIncrement( &URLMON_refCount ); }
  63 static inline void URLMON_UnlockModule(void) { InterlockedDecrement( &URLMON_refCount ); }
  64
  65 IInternetProtocolInfo *get_protocol_info(LPCWSTR);
  66 HRESULT get_protocol_handler(IUri*,CLSID*,BOOL*,IClassFactory**);
  67 IInternetProtocol *get_mime_filter(LPCWSTR);
  68 BOOL is_registered_protocol(LPCWSTR);
  69 void register_urlmon_namespace(IClassFactory*,REFIID,LPCWSTR,BOOL);
  70 HINTERNET get_internet_session(IInternetBindInfo*);
  71 LPWSTR get_useragent(void);
  72 void free_session(void);
  73
  74 HRESULT bind_to_storage(IUri*,IBindCtx*,REFIID,void**);
  75 HRESULT bind_to_object(IMoniker*,IUri*,IBindCtx*,REFIID,void**ppv);
  76
  77 HRESULT create_default_callback(IBindStatusCallback**);
  78 HRESULT wrap_callback(IBindStatusCallback*,IBindStatusCallback**);
  79
  80 typedef struct ProtocolVtbl ProtocolVtbl;
  81
  82 typedef struct {
  83     const ProtocolVtbl *vtbl;
  84
  85     IInternetProtocol *protocol;
  86     IInternetProtocolSink *protocol_sink;
  87
  88     DWORD bindf;
  89     BINDINFO bind_info;
  90
  91     HINTERNET request;
  92     HINTERNET connection;
  93     DWORD flags;
  94     HANDLE lock;
  95
  96     ULONG current_position;
  97     ULONG content_length;
  98     ULONG available_bytes;
  99
 100     IStream *post_stream;
 101
 102     LONG priority;
 103 } Protocol;
 104
 105 struct ProtocolVtbl {
 106     HRESULT (*open_request)(Protocol*,IUri*,DWORD,HINTERNET,IInternetBindInfo*);
 107     HRESULT (*end_request)(Protocol*);
 108     HRESULT (*start_downloading)(Protocol*);
 109     void (*close_connection)(Protocol*);
 110     void (*on_error)(Protocol*,DWORD);
 111 };
 112
 113 /* Flags are needed for, among other things, return HRESULTs from the Read function
 114  * to conform to native. For example, Read returns:
 115  *
 116  * 1. E_PENDING if called before the request has completed,
 117  *        (flags = 0)
 118  * 2. S_FALSE after all data has been read and S_OK has been reported,
 119  *        (flags = FLAG_REQUEST_COMPLETE | FLAG_ALL_DATA_READ | FLAG_RESULT_REPORTED)
 120  * 3. INET_E_DATA_NOT_AVAILABLE if InternetQueryDataAvailable fails. The first time
 121  *    this occurs, INET_E_DATA_NOT_AVAILABLE will also be reported to the sink,
 122  *        (flags = FLAG_REQUEST_COMPLETE)
 123  *    but upon subsequent calls to Read no reporting will take place, yet
 124  *    InternetQueryDataAvailable will still be called, and, on failure,
 125  *    INET_E_DATA_NOT_AVAILABLE will still be returned.
 126  *        (flags = FLAG_REQUEST_COMPLETE | FLAG_RESULT_REPORTED)
 127  *
 128  * FLAG_FIRST_DATA_REPORTED and FLAG_LAST_DATA_REPORTED are needed for proper
 129  * ReportData reporting. For example, if OnResponse returns S_OK, Continue will
 130  * report BSCF_FIRSTDATANOTIFICATION, and when all data has been read Read will
 131  * report BSCF_INTERMEDIATEDATANOTIFICATION|BSCF_LASTDATANOTIFICATION. However,
 132  * if OnResponse does not return S_OK, Continue will not report data, and Read
 133  * will report BSCF_FIRSTDATANOTIFICATION|BSCF_LASTDATANOTIFICATION when all
 134  * data has been read.
 135  */
 136 #define FLAG_REQUEST_COMPLETE         0x0001
 137 #define FLAG_FIRST_CONTINUE_COMPLETE  0x0002
 138 #define FLAG_FIRST_DATA_REPORTED      0x0004
 139 #define FLAG_ALL_DATA_READ            0x0008
 140 #define FLAG_LAST_DATA_REPORTED       0x0010
 141 #define FLAG_RESULT_REPORTED          0x0020
 142 #define FLAG_ERROR                    0x0040
 143
 144 HRESULT protocol_start(Protocol*,IInternetProtocol*,IUri*,IInternetProtocolSink*,IInternetBindInfo*);
 145 HRESULT protocol_continue(Protocol*,PROTOCOLDATA*);
 146 HRESULT protocol_read(Protocol*,void*,ULONG,ULONG*);
 147 HRESULT protocol_lock_request(Protocol*);
 148 HRESULT protocol_unlock_request(Protocol*);
 149 HRESULT protocol_abort(Protocol*,HRESULT);
 150 void protocol_close_connection(Protocol*);
 151
 152 typedef struct {
 153     IInternetProtocol     IInternetProtocol_iface;
 154     IInternetProtocolSink IInternetProtocolSink_iface;
 155
 156     LONG ref;
 157
 158     IInternetProtocolSink *protocol_sink;
 159     IInternetProtocol *protocol;
 160 } ProtocolProxy;
 161
 162 HRESULT create_protocol_proxy(IInternetProtocol*,IInternetProtocolSink*,ProtocolProxy**);
 163
 164 typedef struct _task_header_t task_header_t;
 165
 166 typedef struct {
 167     IInternetProtocolEx   IInternetProtocolEx_iface;
 168     IInternetBindInfo     IInternetBindInfo_iface;
 169     IInternetPriority     IInternetPriority_iface;
 170     IServiceProvider      IServiceProvider_iface;
 171     IInternetProtocolSink IInternetProtocolSink_iface;
 172     IWinInetHttpInfo      IWinInetHttpInfo_iface;
 173
 174     LONG ref;
 175
 176     IInternetProtocol *protocol;
 177     IInternetBindInfo *bind_info;
 178     IInternetProtocolSink *protocol_sink;
 179     IServiceProvider *service_provider;
 180     IWinInetInfo *wininet_info;
 181
 182     struct {
 183         IInternetProtocol IInternetProtocol_iface;
 184     } default_protocol_handler;
 185     IInternetProtocol *protocol_handler;
 186
 187     LONG priority;
 188
 189     BOOL reported_result;
 190     BOOL reported_mime;
 191     BOOL from_urlmon;
 192     DWORD pi;
 193
 194     DWORD bscf;
 195     ULONG progress;
 196     ULONG progress_max;
 197
 198     DWORD apartment_thread;
 199     HWND notif_hwnd;
 200     DWORD continue_call;
 201
 202     CRITICAL_SECTION section;
 203     task_header_t *task_queue_head, *task_queue_tail;
 204
 205     BYTE *buf;
 206     DWORD buf_size;
 207     LPWSTR mime;
 208     IUri *uri;
 209     ProtocolProxy *filter_proxy;
 210 }  BindProtocol;
 211
 212 HRESULT create_binding_protocol(BOOL,BindProtocol**);
 213 void set_binding_sink(BindProtocol*,IInternetProtocolSink*,IInternetBindInfo*);
 214
 215 typedef struct {
 216     HWND notif_hwnd;
 217     DWORD notif_hwnd_cnt;
 218
 219     struct list entry;
 220 } tls_data_t;
 221
 222 tls_data_t *get_tls_data(void);
 223
 224 HWND get_notif_hwnd(void);
 225 void release_notif_hwnd(HWND);
 226
 227 static inline void *heap_alloc(size_t len)
 228 {
 229     return HeapAlloc(GetProcessHeap(), 0, len);
 230 }
 231
 232 static inline void *heap_alloc_zero(size_t len)
 233 {
 234     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
 235 }
 236
 237 static inline void *heap_realloc(void *mem, size_t len)
 238 {
 239     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
 240 }
 241
 242 static inline void *heap_realloc_zero(void *mem, size_t len)
 243 {
 244     return HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len);
 245 }
 246
 247 static inline BOOL heap_free(void *mem)
 248 {
 249     return HeapFree(GetProcessHeap(), 0, mem);
 250 }
 251
 252 static inline LPWSTR heap_strdupW(LPCWSTR str)
 253 {
 254     LPWSTR ret = NULL;
 255
 256     if(str) {
 257         DWORD size;
 258
 259         size = (strlenW(str)+1)*sizeof(WCHAR);
 260         ret = heap_alloc(size);
 261         memcpy(ret, str, size);
 262     }
 263
 264     return ret;
 265 }
 266
 267 static inline LPWSTR heap_strndupW(LPCWSTR str, int len)
 268 {
 269     LPWSTR ret = NULL;
 270
 271     if(str) {
 272         ret = heap_alloc((len+1)*sizeof(WCHAR));
 273         if(ret) {
 274             memcpy(ret, str, len*sizeof(WCHAR));
 275             ret[len] = 0;
 276         }
 277     }
 278
 279     return ret;
 280 }
 281
 282 static inline LPWSTR heap_strdupAtoW(const char *str)
 283 {
 284     LPWSTR ret = NULL;
 285
 286     if(str) {
 287         DWORD len = MultiByteToWideChar(CP_ACP, 0, str, -1, NULL, 0);
 288         ret = heap_alloc(len*sizeof(WCHAR));
 289         MultiByteToWideChar(CP_ACP, 0, str, -1, ret, len);
 290     }
 291
 292     return ret;
 293 }
 294
 295 #endif /* __WINE_URLMON_MAIN_H */