1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/webview_ie.cpp
3 // Purpose: wxMSW wxWebViewIE class implementation for web view component
4 // Author: Marianne Gagnon
6 // Copyright: (c) 2010 Marianne Gagnon
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 // For compilers that support precompilation, includes "wx.h".
11 #include "wx/wxprec.h"
13 #if defined(__BORLANDC__)
17 #include "wx/msw/webview_ie.h"
27 // Various definitions are missing from mingw
29 typedef enum CommandStateChangeConstants
{
30 CSC_UPDATECOMMANDS
= (int) 0xFFFFFFFF,
31 CSC_NAVIGATEFORWARD
= 0x1,
32 CSC_NAVIGATEBACK
= 0x2
33 } CommandStateChangeConstants
;
35 #define DISPID_COMMANDSTATECHANGE 105
36 #define DISPID_NAVIGATECOMPLETE2 252
37 #define DISPID_NAVIGATEERROR 271
38 #define DISPID_NEWWINDOW3 273
39 #define OLECMDID_OPTICAL_ZOOM 63
40 #define INET_E_ERROR_FIRST 0x800C0002L
41 #define INET_E_INVALID_URL 0x800C0002L
42 #define INET_E_NO_SESSION 0x800C0003L
43 #define INET_E_CANNOT_CONNECT 0x800C0004L
44 #define INET_E_RESOURCE_NOT_FOUND 0x800C0005L
45 #define INET_E_OBJECT_NOT_FOUND 0x800C0006L
46 #define INET_E_DATA_NOT_AVAILABLE 0x800C0007L
47 #define INET_E_DOWNLOAD_FAILURE 0x800C0008L
48 #define INET_E_AUTHENTICATION_REQUIRED 0x800C0009L
49 #define INET_E_NO_VALID_MEDIA 0x800C000AL
50 #define INET_E_CONNECTION_TIMEOUT 0x800C000BL
51 #define INET_E_INVALID_REQUEST 0x800C000CL
52 #define INET_E_UNKNOWN_PROTOCOL 0x800C000DL
53 #define INET_E_SECURITY_PROBLEM 0x800C000EL
54 #define INET_E_CANNOT_LOAD_DATA 0x800C000FL
55 #define INET_E_CANNOT_INSTANTIATE_OBJECT 0x800C0010L
56 #define INET_E_QUERYOPTION_UNKNOWN 0x800C0013L
57 #define INET_E_REDIRECT_FAILED 0x800C0014L
58 #define INET_E_REDIRECT_TO_DIR 0x800C0015L
59 #define INET_E_CANNOT_LOCK_REQUEST 0x800C0016L
60 #define INET_E_USE_EXTEND_BINDING 0x800C0017L
61 #define INET_E_TERMINATED_BIND 0x800C0018L
62 #define INET_E_INVALID_CERTIFICATE 0x800C0019L
63 #define INET_E_CODE_DOWNLOAD_DECLINED 0x800C0100L
64 #define INET_E_RESULT_DISPATCHED 0x800C0200L
65 #define INET_E_CANNOT_REPLACE_SFP_FILE 0x800C0300L
66 #define INET_E_CODE_INSTALL_BLOCKED_BY_HASH_POLICY 0x800C0500L
67 #define INET_E_CODE_INSTALL_SUPPRESSED 0x800C0400L
69 #define REFRESH_NORMAL 0
70 #define REFRESH_COMPLETELY 3
73 BEGIN_EVENT_TABLE(wxWebViewIE
, wxControl
)
74 EVT_ACTIVEX(wxID_ANY
, wxWebViewIE
::onActiveXEvent
)
75 EVT_ERASE_BACKGROUND(wxWebViewIE
::onEraseBg
)
78 bool wxWebViewIE
::Create(wxWindow
* parent
,
86 if (!wxControl
::Create(parent
, id
, pos
, size
, style
,
87 wxDefaultValidator
, name
))
93 m_canNavigateBack
= false;
94 m_canNavigateForward
= false;
97 if (::CoCreateInstance(CLSID_WebBrowser
, NULL
,
98 CLSCTX_INPROC_SERVER
, // CLSCTX_INPROC,
99 IID_IWebBrowser2
, (void**)&m_webBrowser
) != 0)
101 wxLogError("Failed to initialize IE, CoCreateInstance returned an error");
105 m_ie
.SetDispatchPtr(m_webBrowser
); // wxAutomationObject will release itself
107 m_webBrowser
->put_RegisterAsBrowser(VARIANT_TRUE
);
108 m_webBrowser
->put_RegisterAsDropTarget(VARIANT_TRUE
);
109 //m_webBrowser->put_Silent(VARIANT_FALSE);
111 m_container
= new wxActiveXContainer(this, IID_IWebBrowser2
, m_webBrowser
);
113 SetBackgroundStyle(wxBG_STYLE_PAINT
);
114 SetDoubleBuffered(true);
120 void wxWebViewIE
::LoadUrl(const wxString
& url
)
122 wxVariant out
= m_ie
.CallMethod("Navigate", (BSTR
) url
.wc_str(),
123 NULL
, NULL
, NULL
, NULL
);
125 // FIXME: why is out value null??
126 //(HRESULT)(out.GetLong()) == S_OK;
129 void wxWebViewIE
::SetPage(const wxString
& html
, const wxString
& baseUrl
)
131 LoadUrl("about:blank");
133 // Let the wx events generated for navigation events be processed, so
134 // that the underlying IE component completes its Document object.
135 // FIXME: calling wxYield is not elegant nor very reliable probably
138 wxVariant documentVariant
= m_ie
.GetProperty("Document");
139 void* documentPtr
= documentVariant
.GetVoidPtr();
141 wxASSERT (documentPtr
!= NULL
);
143 // TODO: consider the "baseUrl" parameter if possible
144 // TODO: consider encoding
145 BSTR bstr
= SysAllocString(html
.wc_str());
147 // Creates a new one-dimensional array
148 SAFEARRAY
*psaStrings
= SafeArrayCreateVector(VT_VARIANT
, 0, 1);
149 if (psaStrings
!= NULL
)
152 HRESULT hr
= SafeArrayAccessData(psaStrings
, (LPVOID
*)¶m
);
154 param
->bstrVal
= bstr
;
156 hr
= SafeArrayUnaccessData(psaStrings
);
158 IHTMLDocument2
* document
= (IHTMLDocument2
*)documentPtr
;
159 document
->write(psaStrings
);
161 // SafeArrayDestroy calls SysFreeString for each BSTR
162 SafeArrayDestroy(psaStrings
);
166 wxLogError("wxWebViewIE::SetPage() : psaStrings is NULL");
171 wxString wxWebViewIE
::GetPageSource()
173 wxVariant documentVariant
= m_ie
.GetProperty("Document");
174 void* documentPtr
= documentVariant
.GetVoidPtr();
176 if (documentPtr
== NULL
)
178 return wxEmptyString
;
181 IHTMLDocument2
* document
= (IHTMLDocument2
*)documentPtr
;
183 IHTMLElement
*bodyTag
= NULL
;
184 IHTMLElement
*htmlTag
= NULL
;
185 document
->get_body(&bodyTag
);
186 wxASSERT(bodyTag
!= NULL
);
189 bodyTag
->get_parentElement(&htmlTag
);
190 wxASSERT(htmlTag
!= NULL
);
193 htmlTag
->get_outerHTML(&bstr
);
198 //wxMessageBox(wxString(bstr));
200 // TODO: check encoding
201 return wxString(bstr
);
204 // FIXME? retrieve OLECMDID_GETZOOMRANGE instead of hardcoding range 0-4
205 wxWebViewZoom wxWebViewIE
::GetZoom()
207 const int zoom
= GetIETextZoom();
212 return wxWEB_VIEW_ZOOM_TINY
;
215 return wxWEB_VIEW_ZOOM_SMALL
;
218 return wxWEB_VIEW_ZOOM_MEDIUM
;
221 return wxWEB_VIEW_ZOOM_LARGE
;
224 return wxWEB_VIEW_ZOOM_LARGEST
;
228 return wxWEB_VIEW_ZOOM_MEDIUM
;
231 void wxWebViewIE
::SetZoom(wxWebViewZoom zoom
)
233 // I know I could cast from enum to int since wxWebViewZoom happens to
234 // match with IE's zoom levels, but I don't like doing that, what if enum
238 case wxWEB_VIEW_ZOOM_TINY
:
241 case wxWEB_VIEW_ZOOM_SMALL
:
244 case wxWEB_VIEW_ZOOM_MEDIUM
:
247 case wxWEB_VIEW_ZOOM_LARGE
:
250 case wxWEB_VIEW_ZOOM_LARGEST
:
258 void wxWebViewIE
::SetIETextZoom(int level
)
261 VariantInit (&zoomVariant
);
262 V_VT(&zoomVariant
) = VT_I4
;
263 V_I4(&zoomVariant
) = level
;
265 HRESULT result
= m_webBrowser
->ExecWB(OLECMDID_ZOOM
,
266 OLECMDEXECOPT_DONTPROMPTUSER
,
268 wxASSERT (result
== S_OK
);
270 VariantClear (&zoomVariant
);
273 int wxWebViewIE
::GetIETextZoom()
276 VariantInit (&zoomVariant
);
277 V_VT(&zoomVariant
) = VT_I4
;
278 V_I4(&zoomVariant
) = 4;
280 HRESULT result
= m_webBrowser
->ExecWB(OLECMDID_ZOOM
,
281 OLECMDEXECOPT_DONTPROMPTUSER
,
283 wxASSERT (result
== S_OK
);
285 int zoom
= V_I4(&zoomVariant
);
286 // wxMessageBox(wxString::Format("Zoom : %i", zoom));
287 VariantClear (&zoomVariant
);
292 void wxWebViewIE
::SetIEOpticalZoom(float zoom
)
294 // TODO: add support for optical zoom (IE7+ only)
296 // TODO: get range from OLECMDID_OPTICAL_GETZOOMRANGE instead of hardcoding?
297 wxASSERT(zoom
>= 10.0f
);
298 wxASSERT(zoom
<= 1000.0f
);
301 VariantInit (&zoomVariant
);
302 V_VT(&zoomVariant
) = VT_I4
;
303 V_I4(&zoomVariant
) = (zoom
* 100.0f
);
305 HRESULT result
= m_webBrowser
->ExecWB((OLECMDID
)OLECMDID_OPTICAL_ZOOM
,
306 OLECMDEXECOPT_DODEFAULT
,
309 wxASSERT (result
== S_OK
);
312 float wxWebViewIE
::GetIEOpticalZoom()
314 // TODO: add support for optical zoom (IE7+ only)
317 VariantInit (&zoomVariant
);
318 V_VT(&zoomVariant
) = VT_I4
;
319 V_I4(&zoomVariant
) = -1;
321 HRESULT result
= m_webBrowser
->ExecWB((OLECMDID
)OLECMDID_OPTICAL_ZOOM
,
322 OLECMDEXECOPT_DODEFAULT
, NULL
,
324 wxASSERT (result
== S_OK
);
326 const int zoom
= V_I4(&zoomVariant
);
327 VariantClear (&zoomVariant
);
329 return zoom
/ 100.0f
;
332 void wxWebViewIE
::SetZoomType(wxWebViewZoomType
)
334 // TODO: add support for optical zoom (IE7+ only)
338 wxWebViewZoomType wxWebViewIE
::GetZoomType() const
340 // TODO: add support for optical zoom (IE7+ only)
341 return wxWEB_VIEW_ZOOM_TYPE_TEXT
;
344 bool wxWebViewIE
::CanSetZoomType(wxWebViewZoomType
) const
346 // both are supported
347 // TODO: IE6 only supports text zoom, check if it's IE6 first
351 void wxWebViewIE
::Print()
353 m_webBrowser
->ExecWB(OLECMDID_PRINTPREVIEW
,
354 OLECMDEXECOPT_DODEFAULT
, NULL
, NULL
);
357 void wxWebViewIE
::GoBack()
359 wxVariant out
= m_ie
.CallMethod("GoBack");
361 // FIXME: why is out value null??
362 //return (HRESULT)(out.GetLong()) == S_OK;
365 void wxWebViewIE
::GoForward()
367 wxVariant out
= m_ie
.CallMethod("GoForward");
369 // FIXME: why is out value null??
370 //return (HRESULT)(out.GetLong()) == S_OK;
373 void wxWebViewIE
::Stop()
375 wxVariant out
= m_ie
.CallMethod("Stop");
377 // FIXME: why is out value null??
378 //return (HRESULT)(out.GetLong()) == S_OK;
382 void wxWebViewIE
::Reload(wxWebViewReloadFlags flags
)
386 V_VT(&level
) = VT_I2
;
390 case wxWEB_VIEW_RELOAD_DEFAULT
:
391 V_I2(&level
) = REFRESH_NORMAL
;
393 case wxWEB_VIEW_RELOAD_NO_CACHE
:
394 V_I2(&level
) = REFRESH_COMPLETELY
;
397 wxFAIL_MSG("Unexpected reload type");
400 m_webBrowser
->Refresh2(&level
);
403 bool wxWebViewIE
::IsOfflineMode()
405 wxVariant out
= m_ie
.GetProperty("Offline");
407 wxASSERT(out
.GetType() == "bool");
409 return out
.GetBool();
412 void wxWebViewIE
::SetOfflineMode(bool offline
)
414 // FIXME: the wxWidgets docs do not really document what the return
415 // parameter of PutProperty is
416 const bool success
= m_ie
.PutProperty("Offline", (offline ?
422 bool wxWebViewIE
::IsBusy()
424 if (m_isBusy
) return true;
426 wxVariant out
= m_ie
.GetProperty("Busy");
428 wxASSERT(out
.GetType() == "bool");
430 return out
.GetBool();
433 wxString wxWebViewIE
::GetCurrentURL()
435 wxVariant out
= m_ie
.GetProperty("LocationURL");
437 wxASSERT(out
.GetType() == "string");
438 return out
.GetString();
441 wxString wxWebViewIE
::GetCurrentTitle()
443 wxVariant out
= m_ie
.GetProperty("LocationName");
445 wxASSERT(out
.GetType() == "string");
446 return out
.GetString();
449 void wxWebViewIE
::onActiveXEvent(wxActiveXEvent
& evt
)
451 if (m_webBrowser
== NULL
) return;
453 switch (evt
.GetDispatchId())
455 case DISPID_BEFORENAVIGATE2
:
459 wxString url
= evt
[1].GetString();
460 wxString target
= evt
[3].GetString();
462 wxWebNavigationEvent
event(wxEVT_COMMAND_WEB_VIEW_NAVIGATING
,
463 GetId(), url
, target
, true);
464 event
.SetEventObject(this);
465 HandleWindowEvent(event
);
467 if (event
.IsVetoed())
469 wxActiveXEventNativeMSW
* nativeParams
=
470 evt
.GetNativeParameters();
471 *V_BOOLREF(&nativeParams
->pDispParams
->rgvarg
[0]) = VARIANT_TRUE
;
474 // at this point, either the navigation event has been cancelled
475 // and we're not busy, either it was accepted and IWebBrowser2's
476 // Busy property will be true; so we don't need our override
483 case DISPID_NAVIGATECOMPLETE2
:
485 wxString url
= evt
[1].GetString();
486 // TODO: set target parameter if possible
487 wxString target
= wxEmptyString
;
488 wxWebNavigationEvent
event(wxEVT_COMMAND_WEB_VIEW_NAVIGATED
,
489 GetId(), url
, target
, false);
490 event
.SetEventObject(this);
491 HandleWindowEvent(event
);
495 case DISPID_PROGRESSCHANGE
:
501 case DISPID_DOCUMENTCOMPLETE
:
503 //Only send a complete even if we are actually finished, this brings
504 //the event in to line with webkit
506 m_webBrowser
->get_ReadyState( &rs
);
507 if(rs
!= READYSTATE_COMPLETE
)
510 wxString url
= evt
[1].GetString();
511 // TODO: set target parameter if possible
512 wxString target
= wxEmptyString
;
513 wxWebNavigationEvent
event(wxEVT_COMMAND_WEB_VIEW_LOADED
, GetId(),
515 event
.SetEventObject(this);
516 HandleWindowEvent(event
);
520 case DISPID_STATUSTEXTCHANGE
:
525 case DISPID_TITLECHANGE
:
530 case DISPID_NAVIGATEERROR
:
532 wxWebNavigationError errorType
= wxWEB_NAV_ERR_OTHER
;
533 wxString errorCode
= "?";
534 switch (evt
[3].GetLong())
536 case INET_E_INVALID_URL
: // (0x800C0002L or -2146697214)
537 errorCode
= "INET_E_INVALID_URL";
538 errorType
= wxWEB_NAV_ERR_REQUEST
;
540 case INET_E_NO_SESSION
: // (0x800C0003L or -2146697213)
541 errorCode
= "INET_E_NO_SESSION";
542 errorType
= wxWEB_NAV_ERR_CONNECTION
;
544 case INET_E_CANNOT_CONNECT
: // (0x800C0004L or -2146697212)
545 errorCode
= "INET_E_CANNOT_CONNECT";
546 errorType
= wxWEB_NAV_ERR_CONNECTION
;
548 case INET_E_RESOURCE_NOT_FOUND
: // (0x800C0005L or -2146697211)
549 errorCode
= "INET_E_RESOURCE_NOT_FOUND";
550 errorType
= wxWEB_NAV_ERR_NOT_FOUND
;
552 case INET_E_OBJECT_NOT_FOUND
: // (0x800C0006L or -2146697210)
553 errorCode
= "INET_E_OBJECT_NOT_FOUND";
554 errorType
= wxWEB_NAV_ERR_NOT_FOUND
;
556 case INET_E_DATA_NOT_AVAILABLE
: // (0x800C0007L or -2146697209)
557 errorCode
= "INET_E_DATA_NOT_AVAILABLE";
558 errorType
= wxWEB_NAV_ERR_NOT_FOUND
;
560 case INET_E_DOWNLOAD_FAILURE
: // (0x800C0008L or -2146697208)
561 errorCode
= "INET_E_DOWNLOAD_FAILURE";
562 errorType
= wxWEB_NAV_ERR_CONNECTION
;
564 case INET_E_AUTHENTICATION_REQUIRED
: // (0x800C0009L or -2146697207)
565 errorCode
= "INET_E_AUTHENTICATION_REQUIRED";
566 errorType
= wxWEB_NAV_ERR_AUTH
;
568 case INET_E_NO_VALID_MEDIA
: // (0x800C000AL or -2146697206)
569 errorCode
= "INET_E_NO_VALID_MEDIA";
570 errorType
= wxWEB_NAV_ERR_REQUEST
;
572 case INET_E_CONNECTION_TIMEOUT
: // (0x800C000BL or -2146697205)
573 errorCode
= "INET_E_CONNECTION_TIMEOUT";
574 errorType
= wxWEB_NAV_ERR_CONNECTION
;
576 case INET_E_INVALID_REQUEST
: // (0x800C000CL or -2146697204)
577 errorCode
= "INET_E_INVALID_REQUEST";
578 errorType
= wxWEB_NAV_ERR_REQUEST
;
580 case INET_E_UNKNOWN_PROTOCOL
: // (0x800C000DL or -2146697203)
581 errorCode
= "INET_E_UNKNOWN_PROTOCOL";
582 errorType
= wxWEB_NAV_ERR_REQUEST
;
584 case INET_E_SECURITY_PROBLEM
: // (0x800C000EL or -2146697202)
585 errorCode
= "INET_E_SECURITY_PROBLEM";
586 errorType
= wxWEB_NAV_ERR_SECURITY
;
588 case INET_E_CANNOT_LOAD_DATA
: // (0x800C000FL or -2146697201)
589 errorCode
= "INET_E_CANNOT_LOAD_DATA";
590 errorType
= wxWEB_NAV_ERR_OTHER
;
592 case INET_E_CANNOT_INSTANTIATE_OBJECT
:
593 // CoCreateInstance will return an error code if this happens,
594 // we'll handle this above.
597 case INET_E_REDIRECT_FAILED
: // (0x800C0014L or -2146697196)
598 errorCode
= "INET_E_REDIRECT_FAILED";
599 errorType
= wxWEB_NAV_ERR_OTHER
;
601 case INET_E_REDIRECT_TO_DIR
: // (0x800C0015L or -2146697195)
602 errorCode
= "INET_E_REDIRECT_TO_DIR";
603 errorType
= wxWEB_NAV_ERR_REQUEST
;
605 case INET_E_CANNOT_LOCK_REQUEST
: // (0x800C0016L or -2146697194)
606 errorCode
= "INET_E_CANNOT_LOCK_REQUEST";
607 errorType
= wxWEB_NAV_ERR_OTHER
;
609 case INET_E_USE_EXTEND_BINDING
: // (0x800C0017L or -2146697193)
610 errorCode
= "INET_E_USE_EXTEND_BINDING";
611 errorType
= wxWEB_NAV_ERR_OTHER
;
613 case INET_E_TERMINATED_BIND
: // (0x800C0018L or -2146697192)
614 errorCode
= "INET_E_TERMINATED_BIND";
615 errorType
= wxWEB_NAV_ERR_OTHER
;
617 case INET_E_INVALID_CERTIFICATE
: // (0x800C0019L or -2146697191)
618 errorCode
= "INET_E_INVALID_CERTIFICATE";
619 errorType
= wxWEB_NAV_ERR_CERTIFICATE
;
621 case INET_E_CODE_DOWNLOAD_DECLINED
: // (0x800C0100L or -2146696960)
622 errorCode
= "INET_E_CODE_DOWNLOAD_DECLINED";
623 errorType
= wxWEB_NAV_ERR_USER_CANCELLED
;
625 case INET_E_RESULT_DISPATCHED
: // (0x800C0200L or -2146696704)
626 // cancel request cancelled...
627 errorCode
= "INET_E_RESULT_DISPATCHED";
628 errorType
= wxWEB_NAV_ERR_OTHER
;
630 case INET_E_CANNOT_REPLACE_SFP_FILE
: // (0x800C0300L or -2146696448)
631 errorCode
= "INET_E_CANNOT_REPLACE_SFP_FILE";
632 errorType
= wxWEB_NAV_ERR_SECURITY
;
634 case INET_E_CODE_INSTALL_BLOCKED_BY_HASH_POLICY
:
635 errorCode
= "INET_E_CODE_INSTALL_BLOCKED_BY_HASH_POLICY";
636 errorType
= wxWEB_NAV_ERR_SECURITY
;
638 case INET_E_CODE_INSTALL_SUPPRESSED
:
639 errorCode
= "INET_E_CODE_INSTALL_SUPPRESSED";
640 errorType
= wxWEB_NAV_ERR_SECURITY
;
644 wxString url
= evt
[1].GetString();
645 wxString target
= evt
[2].GetString();
646 wxWebNavigationEvent
event(wxEVT_COMMAND_WEB_VIEW_ERROR
, GetId(),
648 event
.SetEventObject(this);
649 event
.SetInt(errorType
);
650 event
.SetString(errorCode
);
651 HandleWindowEvent(event
);
655 case DISPID_COMMANDSTATECHANGE
:
657 long commandId
= evt
[0].GetLong();
658 bool enable
= evt
[1].GetBool();
659 if (commandId
== CSC_NAVIGATEBACK
)
661 m_canNavigateBack
= enable
;
663 else if (commandId
== CSC_NAVIGATEFORWARD
)
665 m_canNavigateForward
= enable
;
669 case DISPID_NEWWINDOW3
:
671 wxString url
= evt
[4].GetString();
673 wxWebNavigationEvent
event(wxEVT_COMMAND_WEB_VIEW_NEWWINDOW
,
674 GetId(), url
, wxEmptyString
, true);
675 event
.SetEventObject(this);
676 HandleWindowEvent(event
);
678 //If we veto the event then we cancel the new window
679 if (event
.IsVetoed())
681 wxActiveXEventNativeMSW
* nativeParams
= evt
.GetNativeParameters();
682 *V_BOOLREF(&nativeParams
->pDispParams
->rgvarg
[3]) = VARIANT_TRUE
;