dll/win32/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
  27 #ifdef __REACTOS__
  28 #define PROXY_CLSID_IS {0x79EAC9F1,0xBAF9,0x11CE,{0x8C,0x82,0x00,0xAA,0x00,0x4B,0xA9,0x0B}}
  29 #endif
  30
  31 #include "windef.h"
  32 #include "winbase.h"
  33 #include "winuser.h"
  34 #include "ole2.h"
  35 #include "urlmon.h"
  36 #include "wininet.h"
  37
  38 #include "wine/unicode.h"
  39 #include "wine/heap.h"
  40 #include "wine/list.h"
  41
  42 extern HINSTANCE hProxyDll DECLSPEC_HIDDEN;
  43 extern HRESULT SecManagerImpl_Construct(IUnknown *pUnkOuter, LPVOID *ppobj) DECLSPEC_HIDDEN;
  44 extern HRESULT ZoneMgrImpl_Construct(IUnknown *pUnkOuter, LPVOID *ppobj) DECLSPEC_HIDDEN;
  45 extern HRESULT StdURLMoniker_Construct(IUnknown *pUnkOuter, LPVOID *ppobj) DECLSPEC_HIDDEN;
  46 extern HRESULT FileProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj) DECLSPEC_HIDDEN;
  47 extern HRESULT HttpProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj) DECLSPEC_HIDDEN;
  48 extern HRESULT HttpSProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj) DECLSPEC_HIDDEN;
  49 extern HRESULT FtpProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj) DECLSPEC_HIDDEN;
  50 extern HRESULT GopherProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj) DECLSPEC_HIDDEN;
  51 extern HRESULT MkProtocol_Construct(IUnknown *pUnkOuter, LPVOID *ppobj) DECLSPEC_HIDDEN;
  52 extern HRESULT MimeFilter_Construct(IUnknown *pUnkOuter, LPVOID *ppobj) DECLSPEC_HIDDEN;
  53 extern HRESULT Uri_Construct(IUnknown *pUnkOuter, LPVOID *ppobj) DECLSPEC_HIDDEN;
  54
  55 extern BOOL WINAPI URLMON_DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved) DECLSPEC_HIDDEN;
  56 extern HRESULT WINAPI URLMON_DllGetClassObject(REFCLSID rclsid, REFIID iid,LPVOID *ppv) DECLSPEC_HIDDEN;
  57 extern HRESULT WINAPI URLMON_DllRegisterServer(void) DECLSPEC_HIDDEN;
  58 extern HRESULT WINAPI URLMON_DllUnregisterServer(void) DECLSPEC_HIDDEN;
  59
  60 extern GUID const CLSID_PSFactoryBuffer DECLSPEC_HIDDEN;
  61 extern GUID const CLSID_CUri DECLSPEC_HIDDEN;
  62
  63 /**********************************************************************
  64  * Dll lifetime tracking declaration for urlmon.dll
  65  */
  66 extern LONG URLMON_refCount DECLSPEC_HIDDEN;
  67 static inline void URLMON_LockModule(void) { InterlockedIncrement( &URLMON_refCount ); }
  68 static inline void URLMON_UnlockModule(void) { InterlockedDecrement( &URLMON_refCount ); }
  69
  70 extern HINSTANCE urlmon_instance;
  71
  72 IInternetProtocolInfo *get_protocol_info(LPCWSTR) DECLSPEC_HIDDEN;
  73 HRESULT get_protocol_handler(IUri*,CLSID*,IClassFactory**) DECLSPEC_HIDDEN;
  74 IInternetProtocol *get_mime_filter(LPCWSTR) DECLSPEC_HIDDEN;
  75 BOOL is_registered_protocol(LPCWSTR) DECLSPEC_HIDDEN;
  76 HRESULT register_namespace(IClassFactory*,REFIID,LPCWSTR,BOOL) DECLSPEC_HIDDEN;
  77 HINTERNET get_internet_session(IInternetBindInfo*) DECLSPEC_HIDDEN;
  78 WCHAR *get_useragent(void) DECLSPEC_HIDDEN;
  79 void update_user_agent(WCHAR*) DECLSPEC_HIDDEN;
  80 void free_session(void) DECLSPEC_HIDDEN;
  81
  82 HRESULT find_mime_from_ext(const WCHAR*,WCHAR**) DECLSPEC_HIDDEN;
  83
  84 HRESULT bind_to_storage(IUri*,IBindCtx*,REFIID,void**) DECLSPEC_HIDDEN;
  85 HRESULT bind_to_object(IMoniker*,IUri*,IBindCtx*,REFIID,void**ppv) DECLSPEC_HIDDEN;
  86
  87 HRESULT create_default_callback(IBindStatusCallback**) DECLSPEC_HIDDEN;
  88 HRESULT wrap_callback(IBindStatusCallback*,IBindStatusCallback**) DECLSPEC_HIDDEN;
  89 IBindStatusCallback *bsc_from_bctx(IBindCtx*) DECLSPEC_HIDDEN;
  90
  91 typedef HRESULT (*stop_cache_binding_proc_t)(void*,const WCHAR*,HRESULT,const WCHAR*);
  92 HRESULT download_to_cache(IUri*,stop_cache_binding_proc_t,void*,IBindStatusCallback*) DECLSPEC_HIDDEN;
  93
  94 typedef struct ProtocolVtbl ProtocolVtbl;
  95
  96 typedef struct {
  97     const ProtocolVtbl *vtbl;
  98
  99     IInternetProtocol *protocol;
 100     IInternetProtocolSink *protocol_sink;
 101
 102     DWORD bindf;
 103     BINDINFO bind_info;
 104
 105     HINTERNET request;
 106     HINTERNET connection;
 107     DWORD flags;
 108     HANDLE lock;
 109
 110     ULONG current_position;
 111     ULONG content_length;
 112     ULONG available_bytes;
 113     ULONG query_available;
 114
 115     IStream *post_stream;
 116
 117     LONG priority;
 118 } Protocol;
 119
 120 struct ProtocolVtbl {
 121     HRESULT (*open_request)(Protocol*,IUri*,DWORD,HINTERNET,IInternetBindInfo*);
 122     HRESULT (*end_request)(Protocol*);
 123     HRESULT (*start_downloading)(Protocol*);
 124     void (*close_connection)(Protocol*);
 125     void (*on_error)(Protocol*,DWORD);
 126 };
 127
 128 /* Flags are needed for, among other things, return HRESULTs from the Read function
 129  * to conform to native. For example, Read returns:
 130  *
 131  * 1. E_PENDING if called before the request has completed,
 132  *        (flags = 0)
 133  * 2. S_FALSE after all data has been read and S_OK has been reported,
 134  *        (flags = FLAG_REQUEST_COMPLETE | FLAG_ALL_DATA_READ | FLAG_RESULT_REPORTED)
 135  * 3. INET_E_DATA_NOT_AVAILABLE if InternetQueryDataAvailable fails. The first time
 136  *    this occurs, INET_E_DATA_NOT_AVAILABLE will also be reported to the sink,
 137  *        (flags = FLAG_REQUEST_COMPLETE)
 138  *    but upon subsequent calls to Read no reporting will take place, yet
 139  *    InternetQueryDataAvailable will still be called, and, on failure,
 140  *    INET_E_DATA_NOT_AVAILABLE will still be returned.
 141  *        (flags = FLAG_REQUEST_COMPLETE | FLAG_RESULT_REPORTED)
 142  *
 143  * FLAG_FIRST_DATA_REPORTED and FLAG_LAST_DATA_REPORTED are needed for proper
 144  * ReportData reporting. For example, if OnResponse returns S_OK, Continue will
 145  * report BSCF_FIRSTDATANOTIFICATION, and when all data has been read Read will
 146  * report BSCF_INTERMEDIATEDATANOTIFICATION|BSCF_LASTDATANOTIFICATION. However,
 147  * if OnResponse does not return S_OK, Continue will not report data, and Read
 148  * will report BSCF_FIRSTDATANOTIFICATION|BSCF_LASTDATANOTIFICATION when all
 149  * data has been read.
 150  */
 151 #define FLAG_REQUEST_COMPLETE         0x0001
 152 #define FLAG_FIRST_CONTINUE_COMPLETE  0x0002
 153 #define FLAG_FIRST_DATA_REPORTED      0x0004
 154 #define FLAG_ALL_DATA_READ            0x0008
 155 #define FLAG_LAST_DATA_REPORTED       0x0010
 156 #define FLAG_RESULT_REPORTED          0x0020
 157 #define FLAG_ERROR                    0x0040
 158 #define FLAG_SYNC_READ                0x0080
 159
 160 HRESULT protocol_start(Protocol*,IInternetProtocol*,IUri*,IInternetProtocolSink*,IInternetBindInfo*) DECLSPEC_HIDDEN;
 161 HRESULT protocol_continue(Protocol*,PROTOCOLDATA*) DECLSPEC_HIDDEN;
 162 HRESULT protocol_read(Protocol*,void*,ULONG,ULONG*) DECLSPEC_HIDDEN;
 163 HRESULT protocol_lock_request(Protocol*) DECLSPEC_HIDDEN;
 164 HRESULT protocol_unlock_request(Protocol*) DECLSPEC_HIDDEN;
 165 HRESULT protocol_abort(Protocol*,HRESULT) DECLSPEC_HIDDEN;
 166 HRESULT protocol_syncbinding(Protocol*) DECLSPEC_HIDDEN;
 167 void protocol_close_connection(Protocol*) DECLSPEC_HIDDEN;
 168
 169 void find_domain_name(const WCHAR*,DWORD,INT*) DECLSPEC_HIDDEN;
 170
 171 typedef struct _task_header_t task_header_t;
 172
 173 typedef struct {
 174     IInternetProtocolEx   IInternetProtocolEx_iface;
 175     IInternetBindInfo     IInternetBindInfo_iface;
 176     IInternetPriority     IInternetPriority_iface;
 177     IServiceProvider      IServiceProvider_iface;
 178     IInternetProtocolSink IInternetProtocolSink_iface;
 179
 180     LONG ref;
 181
 182     IUnknown *protocol_unk;
 183     IInternetProtocol *protocol;
 184
 185     IInternetBindInfo *bind_info;
 186     IInternetProtocolSink *protocol_sink;
 187     IServiceProvider *service_provider;
 188     IBindCallbackRedirect *redirect_callback;
 189
 190     struct {
 191         IInternetProtocol IInternetProtocol_iface;
 192         IInternetProtocolSink IInternetProtocolSink_iface;
 193     } default_protocol_handler;
 194     IInternetProtocol *protocol_handler;
 195     IInternetProtocolSink *protocol_sink_handler;
 196
 197     LONG priority;
 198
 199     BOOL reported_result;
 200     BOOL reported_mime;
 201     DWORD pi;
 202
 203     DWORD bscf;
 204     ULONG progress;
 205     ULONG progress_max;
 206
 207     DWORD apartment_thread;
 208     HWND notif_hwnd;
 209     DWORD continue_call;
 210
 211     CRITICAL_SECTION section;
 212     task_header_t *task_queue_head, *task_queue_tail;
 213
 214     BYTE *buf;
 215     DWORD buf_size;
 216     LPWSTR mime;
 217     IUri *uri;
 218     BSTR display_uri;
 219 }  BindProtocol;
 220
 221 HRESULT create_binding_protocol(BindProtocol**) DECLSPEC_HIDDEN;
 222 void set_binding_sink(BindProtocol*,IInternetProtocolSink*,IInternetBindInfo*) DECLSPEC_HIDDEN;
 223
 224 typedef struct {
 225     HWND notif_hwnd;
 226     DWORD notif_hwnd_cnt;
 227
 228     struct list entry;
 229 } tls_data_t;
 230
 231 tls_data_t *get_tls_data(void) DECLSPEC_HIDDEN;
 232
 233 void unregister_notif_wnd_class(void) DECLSPEC_HIDDEN;
 234 HWND get_notif_hwnd(void) DECLSPEC_HIDDEN;
 235 void release_notif_hwnd(HWND) DECLSPEC_HIDDEN;
 236
 237 const char *debugstr_bindstatus(ULONG) DECLSPEC_HIDDEN;
 238
 239 static inline void* __WINE_ALLOC_SIZE(2) heap_realloc_zero(void *mem, size_t size)
 240 {
 241     return HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, mem, size);
 242 }
 243
 244 static inline LPWSTR heap_strdupW(LPCWSTR str)
 245 {
 246     LPWSTR ret = NULL;
 247
 248     if(str) {
 249         DWORD size;
 250
 251         size = (strlenW(str)+1)*sizeof(WCHAR);
 252         ret = heap_alloc(size);
 253         if(ret)
 254             memcpy(ret, str, size);
 255     }
 256
 257     return ret;
 258 }
 259
 260 static inline LPWSTR heap_strndupW(LPCWSTR str, int len)
 261 {
 262     LPWSTR ret = NULL;
 263
 264     if(str) {
 265         ret = heap_alloc((len+1)*sizeof(WCHAR));
 266         if(ret) {
 267             memcpy(ret, str, len*sizeof(WCHAR));
 268             ret[len] = 0;
 269         }
 270     }
 271
 272     return ret;
 273 }
 274
 275 static inline LPWSTR heap_strdupAtoW(const char *str)
 276 {
 277     LPWSTR ret = NULL;
 278
 279     if(str) {
 280         DWORD len = MultiByteToWideChar(CP_ACP, 0, str, -1, NULL, 0);
 281         ret = heap_alloc(len*sizeof(WCHAR));
 282         if(ret)
 283             MultiByteToWideChar(CP_ACP, 0, str, -1, ret, len);
 284     }
 285
 286     return ret;
 287 }
 288
 289 static inline char *heap_strdupWtoA(const WCHAR *str)
 290 {
 291     char *ret = NULL;
 292
 293     if(str) {
 294         size_t size = WideCharToMultiByte(CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
 295         ret = heap_alloc(size);
 296         if(ret)
 297             WideCharToMultiByte(CP_ACP, 0, str, -1, ret, size, NULL, NULL);
 298     }
 299
 300     return ret;
 301 }
 302
 303 #endif /* __WINE_URLMON_MAIN_H */