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