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 IInternetProtocolInfo *get_protocol_info(LPCWSTR) DECLSPEC_HIDDEN;
  68 HRESULT get_protocol_handler(IUri*,CLSID*,BOOL*,IClassFactory**) DECLSPEC_HIDDEN;
  69 IInternetProtocol *get_mime_filter(LPCWSTR) DECLSPEC_HIDDEN;
  70 BOOL is_registered_protocol(LPCWSTR) DECLSPEC_HIDDEN;
  71 void register_urlmon_namespace(IClassFactory*,REFIID,LPCWSTR,BOOL) DECLSPEC_HIDDEN;
  72 HINTERNET get_internet_session(IInternetBindInfo*) DECLSPEC_HIDDEN;
  73 LPWSTR get_useragent(void) DECLSPEC_HIDDEN;
  74 void free_session(void) DECLSPEC_HIDDEN;
  75
  76 HRESULT bind_to_storage(IUri*,IBindCtx*,REFIID,void**) DECLSPEC_HIDDEN;
  77 HRESULT bind_to_object(IMoniker*,IUri*,IBindCtx*,REFIID,void**ppv) DECLSPEC_HIDDEN;
  78
  79 HRESULT create_default_callback(IBindStatusCallback**) DECLSPEC_HIDDEN;
  80 HRESULT wrap_callback(IBindStatusCallback*,IBindStatusCallback**) DECLSPEC_HIDDEN;
  81
  82 typedef struct ProtocolVtbl ProtocolVtbl;
  83
  84 typedef struct {
  85     const ProtocolVtbl *vtbl;
  86
  87     IInternetProtocol *protocol;
  88     IInternetProtocolSink *protocol_sink;
  89
  90     DWORD bindf;
  91     BINDINFO bind_info;
  92
  93     HINTERNET request;
  94     HINTERNET connection;
  95     DWORD flags;
  96     HANDLE lock;
  97
  98     ULONG current_position;
  99     ULONG content_length;
 100     ULONG available_bytes;
 101
 102     IStream *post_stream;
 103
 104     LONG priority;
 105 } Protocol;
 106
 107 struct ProtocolVtbl {
 108     HRESULT (*open_request)(Protocol*,IUri*,DWORD,HINTERNET,IInternetBindInfo*);
 109     HRESULT (*end_request)(Protocol*);
 110     HRESULT (*start_downloading)(Protocol*);
 111     void (*close_connection)(Protocol*);
 112     void (*on_error)(Protocol*,DWORD);
 113 };
 114
 115 /* Flags are needed for, among other things, return HRESULTs from the Read function
 116  * to conform to native. For example, Read returns:
 117  *
 118  * 1. E_PENDING if called before the request has completed,
 119  *        (flags = 0)
 120  * 2. S_FALSE after all data has been read and S_OK has been reported,
 121  *        (flags = FLAG_REQUEST_COMPLETE | FLAG_ALL_DATA_READ | FLAG_RESULT_REPORTED)
 122  * 3. INET_E_DATA_NOT_AVAILABLE if InternetQueryDataAvailable fails. The first time
 123  *    this occurs, INET_E_DATA_NOT_AVAILABLE will also be reported to the sink,
 124  *        (flags = FLAG_REQUEST_COMPLETE)
 125  *    but upon subsequent calls to Read no reporting will take place, yet
 126  *    InternetQueryDataAvailable will still be called, and, on failure,
 127  *    INET_E_DATA_NOT_AVAILABLE will still be returned.
 128  *        (flags = FLAG_REQUEST_COMPLETE | FLAG_RESULT_REPORTED)
 129  *
 130  * FLAG_FIRST_DATA_REPORTED and FLAG_LAST_DATA_REPORTED are needed for proper
 131  * ReportData reporting. For example, if OnResponse returns S_OK, Continue will
 132  * report BSCF_FIRSTDATANOTIFICATION, and when all data has been read Read will
 133  * report BSCF_INTERMEDIATEDATANOTIFICATION|BSCF_LASTDATANOTIFICATION. However,
 134  * if OnResponse does not return S_OK, Continue will not report data, and Read
 135  * will report BSCF_FIRSTDATANOTIFICATION|BSCF_LASTDATANOTIFICATION when all
 136  * data has been read.
 137  */
 138 #define FLAG_REQUEST_COMPLETE         0x0001
 139 #define FLAG_FIRST_CONTINUE_COMPLETE  0x0002
 140 #define FLAG_FIRST_DATA_REPORTED      0x0004
 141 #define FLAG_ALL_DATA_READ            0x0008
 142 #define FLAG_LAST_DATA_REPORTED       0x0010
 143 #define FLAG_RESULT_REPORTED          0x0020
 144 #define FLAG_ERROR                    0x0040
 145
 146 HRESULT protocol_start(Protocol*,IInternetProtocol*,IUri*,IInternetProtocolSink*,IInternetBindInfo*) DECLSPEC_HIDDEN;
 147 HRESULT protocol_continue(Protocol*,PROTOCOLDATA*) DECLSPEC_HIDDEN;
 148 HRESULT protocol_read(Protocol*,void*,ULONG,ULONG*) DECLSPEC_HIDDEN;
 149 HRESULT protocol_lock_request(Protocol*) DECLSPEC_HIDDEN;
 150 HRESULT protocol_unlock_request(Protocol*) DECLSPEC_HIDDEN;
 151 HRESULT protocol_abort(Protocol*,HRESULT) DECLSPEC_HIDDEN;
 152 void protocol_close_connection(Protocol*) DECLSPEC_HIDDEN;
 153
 154 void find_domain_name(const WCHAR*,DWORD,INT*) DECLSPEC_HIDDEN;
 155
 156 typedef struct {
 157     IInternetProtocol     IInternetProtocol_iface;
 158     IInternetProtocolSink IInternetProtocolSink_iface;
 159
 160     LONG ref;
 161
 162     IInternetProtocolSink *protocol_sink;
 163     IInternetProtocol *protocol;
 164 } ProtocolProxy;
 165
 166 HRESULT create_protocol_proxy(IInternetProtocol*,IInternetProtocolSink*,ProtocolProxy**) DECLSPEC_HIDDEN;
 167
 168 typedef struct _task_header_t task_header_t;
 169
 170 typedef struct {
 171     IInternetProtocolEx   IInternetProtocolEx_iface;
 172     IInternetBindInfo     IInternetBindInfo_iface;
 173     IInternetPriority     IInternetPriority_iface;
 174     IServiceProvider      IServiceProvider_iface;
 175     IInternetProtocolSink IInternetProtocolSink_iface;
 176     IWinInetHttpInfo      IWinInetHttpInfo_iface;
 177
 178     LONG ref;
 179
 180     IInternetProtocol *protocol;
 181     IInternetBindInfo *bind_info;
 182     IInternetProtocolSink *protocol_sink;
 183     IServiceProvider *service_provider;
 184     IWinInetInfo *wininet_info;
 185     IWinInetHttpInfo *wininet_http_info;
 186
 187     struct {
 188         IInternetProtocol IInternetProtocol_iface;
 189     } default_protocol_handler;
 190     IInternetProtocol *protocol_handler;
 191
 192     LONG priority;
 193
 194     BOOL reported_result;
 195     BOOL reported_mime;
 196     BOOL from_urlmon;
 197     DWORD pi;
 198
 199     DWORD bscf;
 200     ULONG progress;
 201     ULONG progress_max;
 202
 203     DWORD apartment_thread;
 204     HWND notif_hwnd;
 205     DWORD continue_call;
 206
 207     CRITICAL_SECTION section;
 208     task_header_t *task_queue_head, *task_queue_tail;
 209
 210     BYTE *buf;
 211     DWORD buf_size;
 212     LPWSTR mime;
 213     IUri *uri;
 214     BSTR display_uri;
 215     ProtocolProxy *filter_proxy;
 216 }  BindProtocol;
 217
 218 HRESULT create_binding_protocol(BOOL,BindProtocol**) DECLSPEC_HIDDEN;
 219 void set_binding_sink(BindProtocol*,IInternetProtocolSink*,IInternetBindInfo*) DECLSPEC_HIDDEN;
 220
 221 typedef struct {
 222     HWND notif_hwnd;
 223     DWORD notif_hwnd_cnt;
 224
 225     struct list entry;
 226 } tls_data_t;
 227
 228 tls_data_t *get_tls_data(void) DECLSPEC_HIDDEN;
 229
 230 HWND get_notif_hwnd(void) DECLSPEC_HIDDEN;
 231 void release_notif_hwnd(HWND) 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         memcpy(ret, str, size);
 268     }
 269
 270     return ret;
 271 }
 272
 273 static inline LPWSTR heap_strndupW(LPCWSTR str, int len)
 274 {
 275     LPWSTR ret = NULL;
 276
 277     if(str) {
 278         ret = heap_alloc((len+1)*sizeof(WCHAR));
 279         if(ret) {
 280             memcpy(ret, str, len*sizeof(WCHAR));
 281             ret[len] = 0;
 282         }
 283     }
 284
 285     return ret;
 286 }
 287
 288 static inline LPWSTR heap_strdupAtoW(const char *str)
 289 {
 290     LPWSTR ret = NULL;
 291
 292     if(str) {
 293         DWORD len = MultiByteToWideChar(CP_ACP, 0, str, -1, NULL, 0);
 294         ret = heap_alloc(len*sizeof(WCHAR));
 295         MultiByteToWideChar(CP_ACP, 0, str, -1, ret, len);
 296     }
 297
 298     return ret;
 299 }
 300
 301 #endif /* __WINE_URLMON_MAIN_H */