Internal API addition for IE driver to get browser window handle

This commit introduces an API for getting the browser window handle. In
IE6, this would be the top-level window handle. In IE7 and above, this
will be the handle of the tab window. This is separate from the window
which renders the content, which has a window class of
'InternetExplorer_Server'. There is a need to locate both window handles
distinctly in the internal operation of the IE driver.

Author: jimevans

cpp/iedriver/Browser.cpp

@@ -203,7 +203,12 @@ HWND Browser::GetContentWindowHandle() {
 
   if (this->window_handle() == NULL) {
     LOG(INFO) << "Restore window handle from tab";
-    this->set_window_handle(this->GetTabWindowHandle());
+    // GetBrowserWindowHandle gets the TabWindowClass window in IE 7 and 8,
+    // and the top-level window frame in IE 6. The window we need is the
+    // InternetExplorer_Server window.
+    HWND tab_window_handle = this->GetBrowserWindowHandle();
+    HWND content_window_handle = this->FindContentWindowHandle(tab_window_handle);
+    this->set_window_handle(content_window_handle);
   }
 
   return this->window_handle();
@@ -616,8 +621,8 @@ bool Browser::GetDocumentFromWindow(IHTMLWindow2* window,
   return false;
 }
 
-HWND Browser::GetTabWindowHandle() {
-  LOG(TRACE) << "Entering Browser::GetTabWindowHandle";
+HWND Browser::GetBrowserWindowHandle() {
+  LOG(TRACE) << "Entering Browser::GetBrowserWindowHandle";
 
   HWND hwnd = NULL;
   CComPtr<IServiceProvider> service_provider;
@@ -630,10 +635,8 @@ HWND Browser::GetTabWindowHandle() {
                                         reinterpret_cast<void**>(&window));
     if (SUCCEEDED(hr)) {
       // This gets the TabWindowClass window in IE 7 and 8,
-      // and the top-level window frame in IE 6. The window
-      // we need is the InternetExplorer_Server window.
+      // and the top-level window frame in IE 6.
       window->GetWindow(&hwnd);
-      hwnd = this->FindContentWindowHandle(hwnd);
     } else {
       LOGHR(WARN, hr) << "Unable to get window, call to IOleWindow::QueryService for SID_SShellBrowser failed";
     }
@@ -644,6 +647,34 @@ HWND Browser::GetTabWindowHandle() {
   return hwnd;
 }
 
+//HWND Browser::GetTabWindowHandle() {
+//  LOG(TRACE) << "Entering Browser::GetTabWindowHandle";
+//
+//  HWND hwnd = NULL;
+//  CComPtr<IServiceProvider> service_provider;
+//  HRESULT hr = this->browser_->QueryInterface(IID_IServiceProvider,
+//                                              reinterpret_cast<void**>(&service_provider));
+//  if (SUCCEEDED(hr)) {
+//    CComPtr<IOleWindow> window;
+//    hr = service_provider->QueryService(SID_SShellBrowser,
+//                                        IID_IOleWindow,
+//                                        reinterpret_cast<void**>(&window));
+//    if (SUCCEEDED(hr)) {
+//      // This gets the TabWindowClass window in IE 7 and 8,
+//      // and the top-level window frame in IE 6. The window
+//      // we need is the InternetExplorer_Server window.
+//      window->GetWindow(&hwnd);
+//      hwnd = this->FindContentWindowHandle(hwnd);
+//    } else {
+//      LOGHR(WARN, hr) << "Unable to get window, call to IOleWindow::QueryService for SID_SShellBrowser failed";
+//    }
+//  } else {
+//    LOGHR(WARN, hr) << "Unable to get service, call to IWebBrowser2::QueryInterface for IID_IServiceProvider failed";
+//  }
+//
+//  return hwnd;
+//}
+
 HWND Browser::GetActiveDialogWindowHandle() {
   LOG(TRACE) << "Entering Browser::GetActiveDialogWindowHandle";
 

cpp/iedriver/Browser.h

@@ -92,6 +92,7 @@ class Browser : public DocumentHost, public IDispEventSimpleImpl<1, Browser, &DI
   std::string GetTitle(void);
   std::string GetBrowserUrl(void);
   HWND GetContentWindowHandle(void);
+  HWND GetBrowserWindowHandle(void);
   HWND GetTopLevelWindowHandle(void);
   HWND GetActiveDialogWindowHandle(void);
 
@@ -114,7 +115,7 @@ class Browser : public DocumentHost, public IDispEventSimpleImpl<1, Browser, &DI
   void DetachEvents(void);
   bool IsDocumentNavigating(IHTMLDocument2* doc);
   bool GetDocumentFromWindow(IHTMLWindow2* window, IHTMLDocument2** doc);
-  HWND GetTabWindowHandle(void);
+  //HWND GetTabWindowHandle(void);
   void CheckDialogType(HWND dialog_window_handle);
 
   static unsigned int WINAPI GoBackThreadProc(LPVOID param);

cpp/iedriver/DocumentHost.h

@@ -34,6 +34,7 @@ class DocumentHost {
   virtual bool Wait(void) = 0;
   virtual bool IsBusy(void) = 0;
   virtual HWND GetContentWindowHandle(void) = 0;
+  virtual HWND GetBrowserWindowHandle(void) = 0;
   virtual std::string GetWindowName(void) = 0;
   virtual std::string GetTitle(void) = 0;
   virtual std::string GetBrowserUrl(void) = 0;

cpp/iedriver/HtmlDialog.cpp

@@ -132,6 +132,11 @@ HWND HtmlDialog::GetContentWindowHandle() {
   return this->window_handle();
 }
 
+HWND HtmlDialog::GetBrowserWindowHandle() {
+  LOG(TRACE) << "Entering HtmlDialog::GetBrowserWindowHandle";
+  return this->window_handle();
+}
+
 std::string HtmlDialog::GetWindowName() {
   LOG(TRACE) << "Entering HtmlDialog::GetWindowName";
   return "";

cpp/iedriver/HtmlDialog.h

@@ -51,6 +51,7 @@ class HtmlDialog : public DocumentHost, public IDispEventSimpleImpl<1, HtmlDialo
   bool Wait(void);
   bool IsBusy(void);
   HWND GetContentWindowHandle(void);
+  HWND GetBrowserWindowHandle(void);
   std::string GetWindowName(void);
   std::string GetTitle(void);
   std::string GetBrowserUrl(void);