Morph MORPH
SIGN IN SIGN UP
SeleniumHQ / selenium UNCLAIMED

A browser automation framework and ecosystem.

0 0 558 Java
Normal View History Raw
Copyright uniformity for C++ projects Fixes copyright notices for files in the iedriver, iedriverserver, and webdriver-server, in accordance with issue #401.
2015-04-13 12:09:26 -04:00
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you under the Apache License, Version 2.0 (the "License");
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "HtmlDialog.h"
Moving implementation code of IE driver command handlers from headers The initial implementation of the IE driver's command handlers put the implementation for each command directly in the header files. While this works, it's not standard practice, and has led to a spaghetti-code of include statements. This takes the first step toward fixing that by moving the implementation of each command into a .cpp file, leaving the header to only contain the class definition.
2017-02-14 09:48:56 -08:00
#include "errorcodes.h"
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
#include "logging.h"
Moving implementation code of IE driver command handlers from headers The initial implementation of the IE driver's command handlers put the implementation for each command directly in the header files. While this works, it's not standard practice, and has led to a spaghetti-code of include statements. This takes the first step toward fixing that by moving the implementation of each command into a .cpp file, leaving the header to only contain the class definition.
2017-02-14 09:48:56 -08:00
#include "BrowserFactory.h"
#include "StringUtilities.h"
IE driver code cleanup - moving #defines from header files
2019-01-18 15:54:41 -08:00
#include "WebDriverConstants.h"
Moving implementation code of IE driver command handlers from headers The initial implementation of the IE driver's command handlers put the implementation for each command directly in the header files. While this works, it's not standard practice, and has led to a spaghetti-code of include statements. This takes the first step toward fixing that by moving the implementation of each command into a .cpp file, leaving the header to only contain the class definition.
2017-02-14 09:48:56 -08:00
Fixing IE change in behavior recognizing closing of showModalDialog windows Fixes issue #6574.
2018-10-25 12:31:18 -07:00
#define HIDDEN_PARENT_WINDOW_CLASS "Internet Explorer_Hidden"
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
namespace webdriver {
HtmlDialog::HtmlDialog(IHTMLWindow2* window, HWND hwnd, HWND session_handle) : DocumentHost(hwnd, session_handle) {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::HtmlDialog";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
this->is_navigating_ = false;
this->window_ = window;
this->AttachEvents();
}
HtmlDialog::~HtmlDialog(void) {
}
void HtmlDialog::AttachEvents() {
Removing use of CComQIPtr from IE driver native code. The use of CComQIPtr is not needed, as we are substituting a call to the QueryInterface method instead. This is what CComQIPtr does under the covers anyway.
2013-03-07 17:06:31 -05:00
CComPtr<IUnknown> unknown;
Simplifying object handling code in IE driver. COM objects are now correctly referenced everywhere via smart pointers, and use of some aliased types is now replaced by the C++ primitives.
2013-03-25 13:34:23 -04:00
this->window_->QueryInterface<IUnknown>(&unknown);
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
HRESULT hr = this->DispEventAdvise(unknown);
}
void HtmlDialog::DetachEvents() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::DetachEvents";
Removing use of CComQIPtr from IE driver native code. The use of CComQIPtr is not needed, as we are substituting a call to the QueryInterface method instead. This is what CComQIPtr does under the covers anyway.
2013-03-07 17:06:31 -05:00
CComPtr<IUnknown> unknown;
Simplifying object handling code in IE driver. COM objects are now correctly referenced everywhere via smart pointers, and use of some aliased types is now replaced by the C++ primitives.
2013-03-25 13:34:23 -04:00
this->window_->QueryInterface<IUnknown>(&unknown);
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
HRESULT hr = this->DispEventUnadvise(unknown);
}
void __stdcall HtmlDialog::OnBeforeUnload(IHTMLEventObj *pEvtObj) {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::OnBeforeUnload";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
this->is_navigating_ = true;
}
void __stdcall HtmlDialog::OnLoad(IHTMLEventObj *pEvtObj) {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::OnLoad";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
this->is_navigating_ = false;
}
void HtmlDialog::GetDocument(IHTMLDocument2** doc) {
Resize IE window for screenshots using dimensions of top-level document Fixes issue #703.
2015-07-13 15:19:16 -04:00
this->GetDocument(false, doc);
}
void HtmlDialog::GetDocument(const bool force_top_level_document,
IHTMLDocument2** doc) {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::GetDocument";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
HRESULT hr = S_OK;
Resize IE window for screenshots using dimensions of top-level document Fixes issue #703.
2015-07-13 15:19:16 -04:00
if (this->focused_frame_window() == NULL || force_top_level_document) {
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
hr = this->window_->get_document(doc);
} else {
hr = this->focused_frame_window()->get_document(doc);
}
if (FAILED(hr)) {
LOGHR(DEBUG, hr) << "Unable to get document";
}
}
void HtmlDialog::Close() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::Close";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
if (!this->is_closing()) {
this->is_navigating_ = false;
Update close window command to return list of remaining window handles. This makes the command consistent with the W3C WebDriver Specification. Unfortunately, to accurately return the proper list, however, this requires the driver to wait for the window to be completely closed. In previous versions, this was an asynchronous operation, and could return immediately. With this change, the driver must wait for the window to be successfully closed, and this change therefore introduces a slight performance delay when windows are closed. The performance hit is unfortunate, but unavoidable.
2018-05-11 06:16:04 -07:00
this->set_is_closing(true);
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
// Closing the browser, so having focus on a frame doesn't
// make any sense.
this->SetFocusedFrameByElement(NULL);
this->DetachEvents();
this->window_->close();
// Must manually release the CComPtr<IHTMLWindow> so that the
// destructor will not try to release a no-longer-valid object.
this->window_.Release();
this->window_ = NULL;
this->PostQuitMessage();
}
}
Fixing HTML dialog logic for self-closing documents. HTML dialog windows opened using showModalDialog() have no way to properly notify of their closing. The IE driver attempts to detect closing of these windows by listening for user-initiated actions, either by calling the WebDriver close method, or clicking on an element that causes the dialog to close. This commit adds logic to the method used for getting all window handles to validate the existence of any HTML dialog windows, properly notifying the driver if the OS-level window handle is no longer valid. Fixes issue #6249.
2013-10-10 12:44:27 -04:00
bool HtmlDialog::IsValidWindow() {
LOG(TRACE) << "Entering HtmlDialog::IsValidWindow";
// If the window handle is no longer valid, the window is closing,
// and we must post the quit message.
if (!::IsWindow(this->GetTopLevelWindowHandle())) {
this->is_navigating_ = false;
this->DetachEvents();
this->PostQuitMessage();
return false;
}
return true;
}
Updated IE driver to better support W3C WebDriver Specification This is a large update that includes implementation of the following things that are part of the WebDriver spec: * Implement the "get element property" command * Implement the "get named cookie" command * Implement the "minimize window" command * Implement the "fullscreen window" command * Update "set window rect" command to correctly recognize and restore from minimized or full screen state * Fix the "release actions" command to properly roll back all pending actions * Update the "perform actions" command to be more robust for pointer actions * Fix alert handling to handle dialogs with the "Do not show any more dialogs" check box * Added handling for the "dismiss and notify" and "accept and notify" user prompt handler states
2017-08-31 09:41:44 -07:00
bool HtmlDialog::SetFullScreen(bool is_full_screen) {
return false;
}
bool HtmlDialog::IsFullScreen() {
return false;
}
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
bool HtmlDialog::IsBusy() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::IsBusy";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
return false;
}
Adding pageLoadStrategy to IE driver Setting a capability of pageLoadStrategy when creating a session with the IE driver will now change the wait behavior when navigating to a new page. The valid values are: "normal" - Waits for document.readyState to be 'complete'. This is the default, and is the same behavior as all previous versions of the IE driver. "eager" - Will abort the wait when document.readyState is 'interactive' instead of waiting for 'complete'. "none" - Will abort the wait immediately, without waiting for any of the page to load. Setting the capability to an invalid value will result in use of the "normal" page load strategy.
2015-04-16 14:14:11 -04:00
bool HtmlDialog::Wait(const std::string& page_load_strategy) {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::Wait";
Fixing HTML dialog logic for self-closing documents. HTML dialog windows opened using showModalDialog() have no way to properly notify of their closing. The IE driver attempts to detect closing of these windows by listening for user-initiated actions, either by calling the WebDriver close method, or clicking on an element that causes the dialog to close. This commit adds logic to the method used for getting all window handles to validate the existence of any HTML dialog windows, properly notifying the driver if the OS-level window handle is no longer valid. Fixes issue #6249.
2013-10-10 12:44:27 -04:00
// If the window is no longer valid, the window is closing,
// and the wait is completed.
if (!this->is_closing() && !this->IsValidWindow()) {
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
return true;
}
Reorganizing wait algorithm in HtmlDialog. Now is more correctly aborting the wait if a new (cascading) dialog is detected. Fixes issue #6744.
2014-01-29 16:54:31 -05:00
// Check to see if a new dialog has opened up on top of this one.
// If so, the wait is completed, no matter whether the OnUnload
// event has fired signaling navigation started, nor whether the
// OnLoad event has fired signaling navigation complete. Set the
// flag so that the Wait method is no longer called.
HWND child_dialog_handle = this->GetActiveDialogWindowHandle();
if (child_dialog_handle != NULL) {
this->is_navigating_ = false;
this->set_wait_required(false);
return true;
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
}
Reorganizing wait algorithm in HtmlDialog. Now is more correctly aborting the wait if a new (cascading) dialog is detected. Fixes issue #6744.
2014-01-29 16:54:31 -05:00
// Otherwise, we wait a short amount and see if navigation is complete
// (signaled by the OnLoad event firing).
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
::Sleep(250);
return !this->is_navigating_;
}
Internal IE driver API change GetWindowHandle to GetContentWindowHandle Changing the base DocumentHost class to use GetContentWindowHandle as the method name for the method to get the content window handle.
2014-12-15 11:34:03 -05:00
HWND HtmlDialog::GetContentWindowHandle() {
LOG(TRACE) << "Entering HtmlDialog::GetContentWindowHandle";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
return this->window_handle();
}
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.
2014-12-15 12:06:56 -05:00
HWND HtmlDialog::GetBrowserWindowHandle() {
LOG(TRACE) << "Entering HtmlDialog::GetBrowserWindowHandle";
return this->window_handle();
}
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
std::string HtmlDialog::GetWindowName() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::GetWindowName";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
return "";
}
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 #5361.
2013-03-19 13:03:28 -04:00
std::string HtmlDialog::GetBrowserUrl() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::GetBrowserUrl";
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 #5361.
2013-03-19 13:03:28 -04:00
return "";
}
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
std::string HtmlDialog::GetTitle() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::GetTitle";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
CComPtr<IHTMLDocument2> doc;
this->GetDocument(&doc);
CComBSTR title;
HRESULT hr = doc->get_title(&title);
if (FAILED(hr)) {
LOGHR(WARN, hr) << "Unable to get document title";
return "";
}
Replacing CA2W and CW2A macros in IE driver with more transparent StringUtilities class
2013-03-21 13:58:47 -04:00
std::wstring converted_title = title;
std::string title_string = StringUtilities::ToString(converted_title);
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
return title_string;
}
HWND HtmlDialog::GetTopLevelWindowHandle(void) {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::GetTopLevelWindowHandle";
Fixing IE change in behavior recognizing closing of showModalDialog windows Fixes issue #6574.
2018-10-25 12:31:18 -07:00
HWND parent_handle = ::GetParent(this->window_handle());
// "Internet Explorer_Hidden\0" == 25
std::vector<char> parent_class_buffer(25);
if (::GetClassNameA(parent_handle, &parent_class_buffer[0], 25)) {
if (strcmp(HIDDEN_PARENT_WINDOW_CLASS, &parent_class_buffer[0]) == 0) {
// Some versions of Internet Explorer re-parent a closing showModalDialog
// window to a hidden parent window. If that is what we see happening
// here, that will be equivalent to the parent window no longer being
// valid, and we can return an invalid handle, indicating the window is
// "closed."
return NULL;
}
}
return parent_handle;
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
}
HWND HtmlDialog::GetActiveDialogWindowHandle() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::GetActiveDialogWindowHandle";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
DialogWindowInfo info;
info.hwndOwner = this->GetTopLevelWindowHandle();
info.hwndDialog = NULL;
Fixed unexpected occurrences of UnhandledAlertException after closing modal dialogs created using showModalDialog() in IE
2013-02-05 13:25:12 -05:00
if (info.hwndOwner != NULL) {
::EnumWindows(&HtmlDialog::FindChildDialogWindow, reinterpret_cast<LPARAM>(&info));
}
Refactoring notification of new showModalDialog windows. Previously, the code notifying the command executor of new HTML dialog windows (opened by the showModalDialog function) would not always fire in the case where a second modal was opened from a first. We now notify of the existence of the new modal whenever a modal is found. This has the potential to cause mild performance degredation in the modal dialog case, but this is a small price to pay for the correctness of the driver. Fixes issue #6416.
2013-11-04 15:34:15 -05:00
if (info.hwndDialog != NULL) {
std::vector<char> window_class_name(34);
if (::GetClassNameA(info.hwndDialog, &window_class_name[0], 34)) {
if (strcmp(HTML_DIALOG_WINDOW_CLASS, &window_class_name[0]) == 0) {
HWND content_window_handle = this->FindContentWindowHandle(info.hwndDialog);
if (content_window_handle != NULL) {
// Must have a sleep here to give IE a chance to draw the window.
::Sleep(250);
::PostMessage(this->executor_handle(),
WD_NEW_HTML_DIALOG,
NULL,
reinterpret_cast<LPARAM>(content_window_handle));
}
}
}
}
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
return info.hwndDialog;
}
long HtmlDialog::GetWidth() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::GetWidth";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
// TODO: calculate width
return 0L;
}
long HtmlDialog::GetHeight() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::GetHeight";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
// TODO: calculate height
return 0L;
}
void HtmlDialog::SetWidth(long width) {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::SetWidth";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
}
void HtmlDialog::SetHeight(long height) {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::SetHeight";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
}
Adding additional error message info to navigation methods in IE
2019-07-18 15:20:45 -07:00
int HtmlDialog::NavigateToUrl(const std::string& url,
std::string* error_message) {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::NavigateToUrl";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
// Cannot force navigation on windows opened with showModalDialog();
return ENOTIMPLEMENTED;
}
int HtmlDialog::NavigateBack() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::NavigateBack";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
// Cannot force navigation on windows opened with showModalDialog();
return ENOTIMPLEMENTED;
}
int HtmlDialog::NavigateForward() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::NavigateForward";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
// Cannot force navigation on windows opened with showModalDialog();
return ENOTIMPLEMENTED;
}
int HtmlDialog::Refresh() {
Implementing logging for IE driver HtmlDialog class
2013-07-10 15:52:16 -04:00
LOG(TRACE) << "Entering HtmlDialog::Refresh";
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
// Cannot force navigation on windows opened with showModalDialog();
return ENOTIMPLEMENTED;
}
BOOL CALLBACK HtmlDialog::FindChildDialogWindow(HWND hwnd, LPARAM arg) {
DialogWindowInfo* window_info = reinterpret_cast<DialogWindowInfo*>(arg);
if (::GetWindow(hwnd, GW_OWNER) != window_info->hwndOwner) {
return TRUE;
}
Simplifying object handling code in IE driver. COM objects are now correctly referenced everywhere via smart pointers, and use of some aliased types is now replaced by the C++ primitives.
2013-03-25 13:34:23 -04:00
std::vector<char> window_class_name(34);
KristianRosenvold: Removed windows carriage returns
2013-01-11 22:18:32 +01:00
if (::GetClassNameA(hwnd, &window_class_name[0], 34) == 0) {
// No match found. Skip
return TRUE;
}
if (strcmp(ALERT_WINDOW_CLASS, &window_class_name[0]) != 0 &&
strcmp(HTML_DIALOG_WINDOW_CLASS, &window_class_name[0]) != 0) {
return TRUE;
} else {
// If the window style has the WS_DISABLED bit set or the
// WS_VISIBLE bit unset, it can't be handled via the UI,
// and must not be a visible dialog.
if ((::GetWindowLong(hwnd, GWL_STYLE) & WS_DISABLED) != 0 ||
(::GetWindowLong(hwnd, GWL_STYLE) & WS_VISIBLE) == 0) {
return TRUE;
}
}
window_info->hwndDialog = hwnd;
return FALSE;
}
} // namespace webdriver
Reference in New Issue Copy Permalink