cpp/IEDriver/CommandHandlers/ClickElementCommandHandler.h - external/selenium - Git at Google

 // Copyright 2011 Software Freedom Conservancy
 // Licensed under the Apache License, Version 2.0 (the "License");
 // 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.

 #ifndef WEBDRIVER_IE_CLICKELEMENTCOMMANDHANDLER_H_
 #define WEBDRIVER_IE_CLICKELEMENTCOMMANDHANDLER_H_

 #define CLICK_OPTION_EVENT_NAME L"ClickOptionEvent"

 #include "../Generated/atoms.h"
 #include "../Browser.h"
 #include "../IECommandHandler.h"
 #include "../IECommandExecutor.h"
 #include "logging.h"

 namespace webdriver {

 class ClickElementCommandHandler : public IECommandHandler {
  public:
   ClickElementCommandHandler(void) {
   }

   virtual ~ClickElementCommandHandler(void) {
   }

  protected:
   void ExecuteInternal(const IECommandExecutor& executor,
                        const LocatorMap& locator_parameters,
                        const ParametersMap& command_parameters,
                        Response* response) {
     LocatorMap::const_iterator id_parameter_iterator = locator_parameters.find("id");
     if (id_parameter_iterator == locator_parameters.end()) {
       response->SetErrorResponse(400, "Missing parameter in URL: id");
       return;
     } else {
       int status_code = SUCCESS;
       std::string element_id = id_parameter_iterator->second;

       BrowserHandle browser_wrapper;
       status_code = executor.GetCurrentBrowser(&browser_wrapper);
       if (status_code != SUCCESS) {
         response->SetErrorResponse(status_code, "Unable to get browser");
         return;
       }

       ElementHandle element_wrapper;
       status_code = this->GetElement(executor, element_id, &element_wrapper);
       if (status_code == SUCCESS) {
         if (executor.input_manager()->enable_native_events()) {
           if (this->IsOptionElement(element_wrapper)) {
             std::string option_click_error = "";
             if (executor.allow_asynchronous_javascript()) {
               status_code = element_wrapper->ExecuteAsyncAtom(
                   CLICK_OPTION_EVENT_NAME,
                   &ClickElementCommandHandler::ClickOptionThreadProc,
                   &option_click_error);
             } else {
               CComPtr<IHTMLDocument2> doc;
               browser_wrapper->GetDocument(&doc);
               CComVariant element_variant(element_wrapper->element());
               status_code = ExecuteClickAtom(doc, element_variant);
             }
             if (status_code != SUCCESS) {
               response->SetErrorResponse(status_code, "Cannot click on option element. " + option_click_error);
               return;
             }
           } else {
             if (executor.input_manager()->require_window_focus()) {
               executor.input_manager()->SetFocusToBrowser(browser_wrapper);
             }
             status_code = element_wrapper->Click(executor.input_manager()->scroll_behavior());
             browser_wrapper->set_wait_required(true);
             if (status_code != SUCCESS) {
               if (status_code == EELEMENTCLICKPOINTNOTSCROLLED) {
                 // We hard-code the error code here to be "Element not visible"
                 // to maintain compatibility with previous behavior.
                 response->SetErrorResponse(EELEMENTNOTDISPLAYED, "The point at which the driver is attempting to click on the element was not scrolled into the viewport.");
               } else {
                 response->SetErrorResponse(status_code, "Cannot click on element");
               }
               return;
             }
           }
         } else {
           std::wstring script_source = L"(function() { return function(){" +
                                        atoms::asString(atoms::INPUTS) +
                                        L"; return webdriver.atoms.inputs.click(arguments[0], arguments[1]);" +
                                        L"};})();";

           CComPtr<IHTMLDocument2> doc;
           browser_wrapper->GetDocument(&doc);
           Script script_wrapper(doc, script_source, 2);
           script_wrapper.AddArgument(element_wrapper);
           script_wrapper.AddArgument(executor.input_manager()->mouse_state());
           status_code = script_wrapper.Execute();
           if (status_code != SUCCESS) {
             // This is a hack. We should change this when we can get proper error
             // codes back from the atoms. We'll assume the script failed because
             // the element isn't visible.
             response->SetErrorResponse(EELEMENTNOTDISPLAYED,
                 "Received a JavaScript error attempting to click on the element using synthetic events. We are assuming this is because the element isn't displayed, but it may be due to other problems with executing JavaScript.");
             return;
           } else {
             IECommandExecutor& mutable_executor = const_cast<IECommandExecutor&>(executor);
             mutable_executor.input_manager()->set_mouse_state(script_wrapper.result());
           }
         }
       } else {
         response->SetErrorResponse(status_code, "Element is no longer valid");
         return;
       }

       response->SetSuccessResponse(Json::Value::null);
     }
   }

  private:
   bool IsOptionElement(ElementHandle element_wrapper) {
     CComQIPtr<IHTMLOptionElement> option(element_wrapper->element());
     return option != NULL;
   }

   static int ExecuteClickAtom(IHTMLDocument2* doc, VARIANT element_variant) {
     // The atom is just the definition of an anonymous
     // function: "function() {...}"; Wrap it in another function so we can
     // invoke it with our arguments without polluting the current namespace.
     std::wstring script_source = L"(function() { return (";
     script_source += atoms::asString(atoms::CLICK);
     script_source += L")})();";

     Script script_wrapper(doc, script_source, 1);
     script_wrapper.AddArgument(element_variant);
     int status_code = script_wrapper.Execute();

     // Require a short sleep here to let the browser update the DOM.
     ::Sleep(100);
     return status_code;
   }

   static unsigned int WINAPI ClickOptionThreadProc(LPVOID param) {
     BOOL bRet;
     MSG msg;
     LOG(DEBUG) << "Initializing message pump on new thread";
     ::PeekMessage(&msg, NULL, WM_USER, WM_USER, PM_NOREMOVE);

     LOG(DEBUG) << "Initializing COM on new thread";
     HRESULT hr = ::CoInitializeEx(NULL, COINIT_APARTMENTTHREADED);

     LOG(DEBUG) << "Unmarshaling document from stream";
     CComPtr<IHTMLDocument2> doc;
     LPSTREAM message_payload = reinterpret_cast<LPSTREAM>(param);
     hr = ::CoGetInterfaceAndReleaseStream(message_payload,
                                           IID_IHTMLDocument2,
                                           reinterpret_cast<void**>(&doc));

     LOG(DEBUG) << "Signaling parent thread that the worker thread is ready for messages";
     HANDLE event_handle = ::OpenEvent(EVENT_MODIFY_STATE, FALSE, CLICK_OPTION_EVENT_NAME);
     if (event_handle != NULL) {
       ::SetEvent(event_handle);
       ::CloseHandle(event_handle);
     }

     while ((bRet = ::GetMessage(&msg, NULL, 0, 0)) != 0) {
       if (msg.message == WD_EXECUTE_ASYNC_SCRIPT) {
         LOG(DEBUG) << "Received execution message. Unmarshaling element from stream";
         int status_code = SUCCESS;
         CComPtr<IDispatch> dispatch;
         LPSTREAM message_payload = reinterpret_cast<LPSTREAM>(param);
         hr = ::CoGetInterfaceAndReleaseStream(message_payload, IID_IDispatch, reinterpret_cast<void**>(&dispatch));
         LOG(DEBUG) << "Element unmarshaled from stream, executing JavaScript on worker thread";
         if (SUCCEEDED(hr) && dispatch != NULL) {
           CComVariant element(dispatch);
           status_code = ExecuteClickAtom(doc, element);
           // The atom is just the definition of an anonymous
           // function: "function() {...}"; Wrap it in another function so we can
           // invoke it with our arguments without polluting the current namespace.
           //std::wstring script_source = L"(function() { return (";
           //script_source += atoms::asString(atoms::CLICK);
           //script_source += L")})();";

           //Script script_wrapper(doc, script_source, 1);
           //script_wrapper.AddArgument(element);
           //status_code = script_wrapper.Execute();

           //// Require a short sleep here to let the browser update the DOM.
           //::Sleep(100);
         } else {
           status_code = EUNEXPECTEDJSERROR;
         }
         ::CoUninitialize();
         return status_code;
       }
     }

     return 0;
   }
 };

 } // namespace webdriver

 #endif // WEBDRIVER_IE_CLICKELEMENTCOMMANDHANDLER_H_
	// Copyright 2011 Software Freedom Conservancy
	// Licensed under the Apache License, Version 2.0 (the "License");
	// 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.

	#ifndef WEBDRIVER_IE_CLICKELEMENTCOMMANDHANDLER_H_
	#define WEBDRIVER_IE_CLICKELEMENTCOMMANDHANDLER_H_

	#define CLICK_OPTION_EVENT_NAME L"ClickOptionEvent"

	#include "../Generated/atoms.h"
	#include "../Browser.h"
	#include "../IECommandHandler.h"
	#include "../IECommandExecutor.h"
	#include "logging.h"

	namespace webdriver {

	class ClickElementCommandHandler : public IECommandHandler {
	public:
	ClickElementCommandHandler(void) {
	}

	virtual ~ClickElementCommandHandler(void) {
	}

	protected:
	void ExecuteInternal(const IECommandExecutor& executor,
	const LocatorMap& locator_parameters,
	const ParametersMap& command_parameters,
	Response* response) {
	LocatorMap::const_iterator id_parameter_iterator = locator_parameters.find("id");
	if (id_parameter_iterator == locator_parameters.end()) {
	response->SetErrorResponse(400, "Missing parameter in URL: id");
	return;
	} else {
	int status_code = SUCCESS;
	std::string element_id = id_parameter_iterator->second;

	BrowserHandle browser_wrapper;
	status_code = executor.GetCurrentBrowser(&browser_wrapper);
	if (status_code != SUCCESS) {
	response->SetErrorResponse(status_code, "Unable to get browser");
	return;
	}

	ElementHandle element_wrapper;
	status_code = this->GetElement(executor, element_id, &element_wrapper);
	if (status_code == SUCCESS) {
	if (executor.input_manager()->enable_native_events()) {
	if (this->IsOptionElement(element_wrapper)) {
	std::string option_click_error = "";
	if (executor.allow_asynchronous_javascript()) {
	status_code = element_wrapper->ExecuteAsyncAtom(
	CLICK_OPTION_EVENT_NAME,
	&ClickElementCommandHandler::ClickOptionThreadProc,
	&option_click_error);
	} else {
	CComPtr<IHTMLDocument2> doc;
	browser_wrapper->GetDocument(&doc);
	CComVariant element_variant(element_wrapper->element());
	status_code = ExecuteClickAtom(doc, element_variant);
	}
	if (status_code != SUCCESS) {
	response->SetErrorResponse(status_code, "Cannot click on option element. " + option_click_error);
	return;
	}
	} else {
	if (executor.input_manager()->require_window_focus()) {
	executor.input_manager()->SetFocusToBrowser(browser_wrapper);
	}
	status_code = element_wrapper->Click(executor.input_manager()->scroll_behavior());
	browser_wrapper->set_wait_required(true);
	if (status_code != SUCCESS) {
	if (status_code == EELEMENTCLICKPOINTNOTSCROLLED) {
	// We hard-code the error code here to be "Element not visible"
	// to maintain compatibility with previous behavior.
	response->SetErrorResponse(EELEMENTNOTDISPLAYED, "The point at which the driver is attempting to click on the element was not scrolled into the viewport.");
	} else {
	response->SetErrorResponse(status_code, "Cannot click on element");
	}
	return;
	}
	}
	} else {
	std::wstring script_source = L"(function() { return function(){" +
	atoms::asString(atoms::INPUTS) +
	L"; return webdriver.atoms.inputs.click(arguments[0], arguments[1]);" +
	L"};})();";

	CComPtr<IHTMLDocument2> doc;
	browser_wrapper->GetDocument(&doc);
	Script script_wrapper(doc, script_source, 2);
	script_wrapper.AddArgument(element_wrapper);
	script_wrapper.AddArgument(executor.input_manager()->mouse_state());
	status_code = script_wrapper.Execute();
	if (status_code != SUCCESS) {
	// This is a hack. We should change this when we can get proper error
	// codes back from the atoms. We'll assume the script failed because
	// the element isn't visible.
	response->SetErrorResponse(EELEMENTNOTDISPLAYED,
	"Received a JavaScript error attempting to click on the element using synthetic events. We are assuming this is because the element isn't displayed, but it may be due to other problems with executing JavaScript.");
	return;
	} else {
	IECommandExecutor& mutable_executor = const_cast<IECommandExecutor&>(executor);
	mutable_executor.input_manager()->set_mouse_state(script_wrapper.result());
	}
	}
	} else {
	response->SetErrorResponse(status_code, "Element is no longer valid");
	return;
	}

	response->SetSuccessResponse(Json::Value::null);
	}
	}

	private:
	bool IsOptionElement(ElementHandle element_wrapper) {
	CComQIPtr<IHTMLOptionElement> option(element_wrapper->element());
	return option != NULL;
	}

	static int ExecuteClickAtom(IHTMLDocument2* doc, VARIANT element_variant) {
	// The atom is just the definition of an anonymous
	// function: "function() {...}"; Wrap it in another function so we can
	// invoke it with our arguments without polluting the current namespace.
	std::wstring script_source = L"(function() { return (";
	script_source += atoms::asString(atoms::CLICK);
	script_source += L")})();";

	Script script_wrapper(doc, script_source, 1);
	script_wrapper.AddArgument(element_variant);
	int status_code = script_wrapper.Execute();

	// Require a short sleep here to let the browser update the DOM.
	::Sleep(100);
	return status_code;
	}

	static unsigned int WINAPI ClickOptionThreadProc(LPVOID param) {
	BOOL bRet;
	MSG msg;
	LOG(DEBUG) << "Initializing message pump on new thread";
	::PeekMessage(&msg, NULL, WM_USER, WM_USER, PM_NOREMOVE);

	LOG(DEBUG) << "Initializing COM on new thread";
	HRESULT hr = ::CoInitializeEx(NULL, COINIT_APARTMENTTHREADED);

	LOG(DEBUG) << "Unmarshaling document from stream";
	CComPtr<IHTMLDocument2> doc;
	LPSTREAM message_payload = reinterpret_cast<LPSTREAM>(param);
	hr = ::CoGetInterfaceAndReleaseStream(message_payload,
	IID_IHTMLDocument2,
	reinterpret_cast<void**>(&doc));

	LOG(DEBUG) << "Signaling parent thread that the worker thread is ready for messages";
	HANDLE event_handle = ::OpenEvent(EVENT_MODIFY_STATE, FALSE, CLICK_OPTION_EVENT_NAME);
	if (event_handle != NULL) {
	::SetEvent(event_handle);
	::CloseHandle(event_handle);
	}

	while ((bRet = ::GetMessage(&msg, NULL, 0, 0)) != 0) {
	if (msg.message == WD_EXECUTE_ASYNC_SCRIPT) {
	LOG(DEBUG) << "Received execution message. Unmarshaling element from stream";
	int status_code = SUCCESS;
	CComPtr<IDispatch> dispatch;
	LPSTREAM message_payload = reinterpret_cast<LPSTREAM>(param);
	hr = ::CoGetInterfaceAndReleaseStream(message_payload, IID_IDispatch, reinterpret_cast<void**>(&dispatch));
	LOG(DEBUG) << "Element unmarshaled from stream, executing JavaScript on worker thread";
	if (SUCCEEDED(hr) && dispatch != NULL) {
	CComVariant element(dispatch);
	status_code = ExecuteClickAtom(doc, element);
	// The atom is just the definition of an anonymous
	// function: "function() {...}"; Wrap it in another function so we can
	// invoke it with our arguments without polluting the current namespace.
	//std::wstring script_source = L"(function() { return (";
	//script_source += atoms::asString(atoms::CLICK);
	//script_source += L")})();";

	//Script script_wrapper(doc, script_source, 1);
	//script_wrapper.AddArgument(element);
	//status_code = script_wrapper.Execute();

	//// Require a short sleep here to let the browser update the DOM.
	//::Sleep(100);
	} else {
	status_code = EUNEXPECTEDJSERROR;
	}
	::CoUninitialize();
	return status_code;
	}
	}

	return 0;
	}
	};

	} // namespace webdriver

	#endif // WEBDRIVER_IE_CLICKELEMENTCOMMANDHANDLER_H_