Adding ability to get current URL from IWebBrowser2 if IHTMLDocument2

fails.

Under normal circumstances, the IE driver gets the current URL from the
document loaded in the browser. When IE browses to a non-HTML page, such
as a PDF file with the Adobe Reader plugin installed, getting the document
fails, since there is no "document" in the browser. In that case, fall
back to getting the LocationURL property of the IWebBrowser2 interface.
It's arguable that this is the wrong thing to do, since the driver is
useless without an actual document, but we'll let this work anyway. Fixes
issue SeleniumHQ#5361.

cpp/IEDriver/Browser.cpp

@@ -155,6 +155,20 @@ std::string Browser::GetTitle() {
   return title_string;
 }
 
+std::string Browser::GetBrowserUrl() {
+  LOG(TRACE) << "Entering Browser::GetBrowserUrl";
+
+  CComBSTR url;
+  HRESULT hr = this->browser_->get_LocationURL(&url);
+  if (FAILED(hr)) {
+    LOGHR(WARN, hr) << "Unable to get current URL, call to IWebBrowser2::get_LocationURL failed";
+    return "";
+  }
+
+  std::string current_url = CW2A(url, CP_UTF8);
+  return current_url;
+}
+
 HWND Browser::GetWindowHandle() {
   LOG(TRACE) << "Entering Browser::GetWindowHandle";
 

cpp/IEDriver/Browser.h

@@ -93,6 +93,7 @@ class Browser : public DocumentHost, public IDispEventSimpleImpl<1, Browser, &DI
   void GetDocument(IHTMLDocument2** doc);
   std::string GetWindowName(void);
   std::string GetTitle(void);
+  std::string GetBrowserUrl(void);
   HWND GetWindowHandle(void);
   HWND GetTopLevelWindowHandle(void);
   HWND GetActiveDialogWindowHandle(void);

cpp/IEDriver/DocumentHost.cpp

@@ -61,8 +61,9 @@ std::string DocumentHost::GetCurrentUrl() {
   CComPtr<IHTMLDocument2> doc;
   this->GetDocument(&doc);
   if (!doc) {
-    LOG(WARN) << "Unable to get document object, DocumentHost::GetDocument returned NULL";
-    return "";
+    LOG(WARN) << "Unable to get document object, DocumentHost::GetDocument returned NULL. "
+              << "Attempting to get URL from IWebBrowser2 object";
+    return this->GetBrowserUrl();
   }
 
   CComBSTR url;

cpp/IEDriver/DocumentHost.h

@@ -39,6 +39,7 @@ class DocumentHost {
   virtual HWND GetWindowHandle(void) = 0;
   virtual std::string GetWindowName(void) = 0;
   virtual std::string GetTitle(void) = 0;
+  virtual std::string GetBrowserUrl(void) = 0;
   virtual HWND GetActiveDialogWindowHandle(void) = 0;
   virtual HWND GetTopLevelWindowHandle(void) = 0;
 

cpp/IEDriver/HtmlDialog.cpp

@@ -135,6 +135,10 @@ std::string HtmlDialog::GetWindowName() {
   return "";
 }
 
+std::string HtmlDialog::GetBrowserUrl() {
+  return "";
+}
+
 std::string HtmlDialog::GetTitle() {
   CComPtr<IHTMLDocument2> doc;
   this->GetDocument(&doc);

cpp/IEDriver/HtmlDialog.h

@@ -32,7 +32,7 @@ struct DialogWindowInfo {
 };
 
 class HtmlDialog : public DocumentHost, public IDispEventSimpleImpl<1, HtmlDialog, &DIID_HTMLWindowEvents2>  {
-public:
+ public:
   HtmlDialog(IHTMLWindow2* window, HWND hwnd, HWND session_handle);
   virtual ~HtmlDialog(void);
 
@@ -56,6 +56,7 @@ class HtmlDialog : public DocumentHost, public IDispEventSimpleImpl<1, HtmlDialo
   HWND GetWindowHandle(void);
   std::string GetWindowName(void);
   std::string GetTitle(void);
+  std::string GetBrowserUrl(void);
   HWND GetActiveDialogWindowHandle(void);
   HWND GetTopLevelWindowHandle(void);
 
@@ -69,7 +70,7 @@ class HtmlDialog : public DocumentHost, public IDispEventSimpleImpl<1, HtmlDialo
   int NavigateForward(void);
   int Refresh(void);
 
-private:
+ private:
   static BOOL CALLBACK FindChildDialogWindow(HWND hwnd, LPARAM arg);
 
   void AttachEvents(void);