| // 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"); |
| // 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 "Script.h" |
| |
| #include "errorcodes.h" |
| #include "logging.h" |
| |
| #include "AsyncScriptExecutor.h" |
| #include "Element.h" |
| #include "IECommandExecutor.h" |
| #include "ScriptException.h" |
| #include "StringUtilities.h" |
| #include "VariantUtilities.h" |
| #include "WebDriverConstants.h" |
| |
| namespace webdriver { |
| |
| Script::Script(IHTMLDocument2* document, |
| std::string script_source, |
| unsigned long argument_count) { |
| std::wstring wide_script = StringUtilities::ToWString(script_source); |
| this->Initialize(document, wide_script, argument_count); |
| } |
| |
| Script::Script(IHTMLDocument2* document, |
| std::wstring script_source, |
| unsigned long argument_count) { |
| this->Initialize(document, script_source, argument_count); |
| } |
| |
| Script::Script(IHTMLDocument2* document, |
| std::string script_source) { |
| std::wstring wide_script = StringUtilities::ToWString(script_source); |
| this->Initialize(document, wide_script, 0); |
| } |
| |
| Script::Script(IHTMLDocument2* document, |
| std::wstring script_source) { |
| this->Initialize(document, script_source, 0); |
| } |
| |
| Script::~Script(void) { |
| } |
| |
| void Script::Initialize(IHTMLDocument2* document, |
| const std::wstring& script_source, |
| const unsigned long argument_count) { |
| LOG(TRACE) << "Entering Script::Initialize"; |
| |
| this->script_engine_host_ = document; |
| this->source_code_ = script_source; |
| this->argument_count_ = argument_count; |
| this->current_arg_index_ = 0; |
| |
| // Calling vector::resize() is okay here, because the vector |
| // should be empty when Initialize() is called, and the |
| // reallocation of variants shouldn't give us too much of a |
| // negative impact. |
| this->argument_array_.resize(this->argument_count_); |
| } |
| |
| void Script::AddArgument(const std::string& argument) { |
| LOG(TRACE) << "Entering Script::AddArgument(std::string)"; |
| std::wstring wide_argument = StringUtilities::ToWString(argument); |
| this->AddArgument(wide_argument); |
| } |
| |
| void Script::AddArgument(const std::wstring& argument) { |
| LOG(TRACE) << "Entering Script::AddArgument(std::wstring)"; |
| CComVariant dest_argument(argument.c_str()); |
| this->AddArgument(dest_argument); |
| } |
| |
| void Script::AddArgument(const int argument) { |
| LOG(TRACE) << "Entering Script::AddArgument(int)"; |
| CComVariant dest_argument((long)argument); |
| this->AddArgument(dest_argument); |
| } |
| |
| void Script::AddArgument(const double argument) { |
| LOG(TRACE) << "Entering Script::AddArgument(double)"; |
| CComVariant dest_argument(argument); |
| this->AddArgument(dest_argument); |
| } |
| |
| void Script::AddArgument(const bool argument) { |
| LOG(TRACE) << "Entering Script::AddArgument(bool)"; |
| CComVariant dest_argument(argument); |
| this->AddArgument(dest_argument); |
| } |
| |
| void Script::AddArgument(ElementHandle argument) { |
| LOG(TRACE) << "Entering Script::AddArgument(ElementHandle)"; |
| this->AddArgument(argument->element()); |
| } |
| |
| void Script::AddArgument(IHTMLElement* argument) { |
| LOG(TRACE) << "Entering Script::AddArgument(IHTMLElement*)"; |
| CComVariant dest_argument(argument); |
| this->AddArgument(dest_argument); |
| } |
| |
| void Script::AddArgument(VARIANT argument) { |
| LOG(TRACE) << "Entering Script::AddArgument(VARIANT)"; |
| CComVariant wrapped_argument(argument); |
| this->argument_array_[this->current_arg_index_] = wrapped_argument; |
| ++this->current_arg_index_; |
| } |
| |
| void Script::AddNullArgument() { |
| LOG(TRACE) << "Entering Script::AddNullArgument"; |
| CComVariant null_arg; |
| null_arg.vt = VT_NULL; |
| this->AddArgument(null_arg); |
| } |
| |
| bool Script::ResultIsString() { |
| LOG(TRACE) << "Entering Script::ResultIsString"; |
| return VariantUtilities::VariantIsString(this->result_); |
| } |
| |
| bool Script::ResultIsInteger() { |
| LOG(TRACE) << "Entering Script::ResultIsInteger"; |
| return VariantUtilities::VariantIsInteger(this->result_); |
| } |
| |
| bool Script::ResultIsDouble() { |
| LOG(TRACE) << "Entering Script::ResultIsDouble"; |
| return VariantUtilities::VariantIsDouble(this->result_); |
| } |
| |
| bool Script::ResultIsBoolean() { |
| LOG(TRACE) << "Entering Script::ResultIsBoolean"; |
| return VariantUtilities::VariantIsBoolean(this->result_); |
| } |
| |
| bool Script::ResultIsEmpty() { |
| LOG(TRACE) << "Entering Script::ResultIsEmpty"; |
| return VariantUtilities::VariantIsEmpty(this->result_); |
| } |
| |
| bool Script::ResultIsIDispatch() { |
| LOG(TRACE) << "Entering Script::ResultIsIDispatch"; |
| return VariantUtilities::VariantIsIDispatch(this->result_); |
| } |
| |
| bool Script::ResultIsElementCollection() { |
| LOG(TRACE) << "Entering Script::ResultIsElementCollection"; |
| return VariantUtilities::VariantIsElementCollection(this->result_); |
| } |
| |
| bool Script::ResultIsElement() { |
| LOG(TRACE) << "Entering Script::ResultIsElement"; |
| return VariantUtilities::VariantIsElement(this->result_); |
| } |
| |
| bool Script::ResultIsArray() { |
| LOG(TRACE) << "Entering Script::ResultIsArray"; |
| return VariantUtilities::VariantIsArray(this->result_); |
| } |
| |
| bool Script::ResultIsObject() { |
| LOG(TRACE) << "Entering Script::ResultIsObject"; |
| return VariantUtilities::VariantIsObject(this->result_); |
| } |
| |
| int Script::Execute() { |
| LOG(TRACE) << "Entering Script::Execute"; |
| |
| HRESULT hr = S_OK; |
| CComVariant result = L""; |
| CComBSTR error_description = L""; |
| |
| if (this->script_engine_host_ == NULL) { |
| LOG(WARN) << "Script engine host is NULL"; |
| return ENOSUCHDOCUMENT; |
| } |
| |
| CComBSTR design_mode = L""; |
| this->script_engine_host_->get_designMode(&design_mode); |
| design_mode.ToLower(); |
| if (design_mode == "on") { |
| CComBSTR set_design_mode = "off"; |
| this->script_engine_host_->put_designMode(set_design_mode); |
| } |
| |
| CComVariant temp_function; |
| if (!this->CreateAnonymousFunction(&temp_function)) { |
| LOG(WARN) << "Cannot create anonymous function"; |
| return EUNEXPECTEDJSERROR; |
| } |
| |
| if (temp_function.vt != VT_DISPATCH) { |
| LOG(DEBUG) << "No return value that we care about"; |
| return WD_SUCCESS; |
| } |
| |
| CComPtr<IDispatchEx> function_dispatch; |
| hr = temp_function.pdispVal->QueryInterface<IDispatchEx>(&function_dispatch); |
| if (FAILED(hr)) { |
| LOG(WARN) << "Anonymous function object does not implement IDispatchEx"; |
| return EUNEXPECTEDJSERROR; |
| } |
| |
| // Grab the "call" method out of the returned function |
| DISPID call_member_id; |
| CComBSTR call_member_name = L"call"; |
| hr = function_dispatch->GetDispID(call_member_name, 0, &call_member_id); |
| if (FAILED(hr)) { |
| LOGHR(WARN, hr) << "Cannot locate call method on anonymous function"; |
| return EUNEXPECTEDJSERROR; |
| } |
| |
| CComPtr<IHTMLWindow2> win; |
| hr = this->script_engine_host_->get_parentWindow(&win); |
| if (FAILED(hr)) { |
| LOGHR(WARN, hr) << "Cannot get parent window, IHTMLDocument2::get_parentWindow failed"; |
| return EUNEXPECTEDJSERROR; |
| } |
| |
| // IDispatch::Invoke() expects the arguments to be passed into it |
| // in reverse order. To accomplish this, we create a new variant |
| // array of size n + 1 where n is the number of arguments we have. |
| // we copy each element of arguments_array_ into the new array in |
| // reverse order, and add an extra argument, the window object, |
| // to the end of the array to use as the "this" parameter for the |
| // function invocation. |
| size_t arg_count = this->argument_array_.size(); |
| std::vector<CComVariant> argument_array_copy(arg_count + 1); |
| CComVariant window_variant(win); |
| argument_array_copy[arg_count].Copy(&window_variant); |
| |
| for (size_t index = 0; index < arg_count; ++index) { |
| argument_array_copy[arg_count - 1 - index].Copy(&this->argument_array_[index]); |
| } |
| |
| DISPPARAMS call_parameters = { 0 }; |
| memset(&call_parameters, 0, sizeof call_parameters); |
| call_parameters.cArgs = static_cast<unsigned int>(argument_array_copy.size()); |
| call_parameters.rgvarg = &argument_array_copy[0]; |
| |
| int return_code = WD_SUCCESS; |
| EXCEPINFO exception; |
| memset(&exception, 0, sizeof exception); |
| CComPtr<IServiceProvider> custom_exception_service_provider; |
| hr = ScriptException::CreateInstance<IServiceProvider>(&custom_exception_service_provider); |
| CComPtr<IScriptException> custom_exception; |
| hr = custom_exception_service_provider.QueryInterface<IScriptException>(&custom_exception); |
| hr = function_dispatch->InvokeEx(call_member_id, |
| LOCALE_USER_DEFAULT, |
| DISPATCH_METHOD, |
| &call_parameters, |
| &result, |
| &exception, |
| custom_exception_service_provider); |
| |
| if (FAILED(hr)) { |
| if (DISP_E_EXCEPTION == hr) { |
| error_description = exception.bstrDescription ? exception.bstrDescription : L"EUNEXPECTEDJSERROR"; |
| CComBSTR error_source(exception.bstrSource ? exception.bstrSource : L"EUNEXPECTEDJSERROR"); |
| LOG(INFO) << "Exception message was: '" << error_description << "'"; |
| LOG(INFO) << "Exception source was: '" << error_source << "'"; |
| } else { |
| bool is_handled = false; |
| hr = custom_exception->IsExceptionHandled(&is_handled); |
| if (is_handled) { |
| error_description = "Error from JavaScript: "; |
| CComBSTR script_message = L""; |
| custom_exception->GetDescription(&script_message); |
| error_description.Append(script_message); |
| LOG(DEBUG) << script_message; |
| } else { |
| LOGHR(DEBUG, hr) << "Failed to execute anonymous function, no exception information retrieved"; |
| } |
| } |
| |
| result.Clear(); |
| result.vt = VT_BSTR; |
| result.bstrVal = error_description; |
| return_code = EUNEXPECTEDJSERROR; |
| } |
| |
| this->result_.Copy(&result); |
| |
| return return_code; |
| } |
| |
| int Script::Execute(const IECommandExecutor& command_executor, |
| const Json::Value& args, |
| Json::Value* result) { |
| IECommandExecutor& mutable_executor = const_cast<IECommandExecutor&>(command_executor); |
| int status_code = this->AddArguments(mutable_executor.element_manager(), |
| args); |
| status_code = this->Execute(); |
| status_code = this->ConvertResultToJsonValue(command_executor, result); |
| return status_code; |
| } |
| |
| int Script::ExecuteAsync(const IECommandExecutor& command_executor, |
| const Json::Value& args, |
| HWND* async_executor_handle) { |
| return this->ExecuteAsync(command_executor, args, 0, async_executor_handle); |
| } |
| |
| int Script::ExecuteAsync(const IECommandExecutor& command_executor, |
| const Json::Value& args, |
| const int timeout_override_in_milliseconds, |
| HWND* async_executor_handle) { |
| LOG(TRACE) << "Entering Script::ExecuteAsync"; |
| int return_code = WD_SUCCESS; |
| |
| Json::StreamWriterBuilder writer; |
| std::wstring serialized_args = StringUtilities::ToWString(Json::writeString(writer, args)); |
| this->argument_count_ = args.size(); |
| return_code = this->CreateAsyncScriptExecutor(command_executor.window_handle(), |
| serialized_args, |
| async_executor_handle); |
| |
| if (return_code != WD_SUCCESS) { |
| return return_code; |
| } |
| |
| return_code = this->SetAsyncScriptDocument(*async_executor_handle); |
| |
| if (this->polling_source_code_.size() > 0) { |
| ::SendMessage(*async_executor_handle, |
| WD_ASYNC_SCRIPT_SET_POLLING_SCRIPT, |
| NULL, |
| reinterpret_cast<LPARAM>(this->polling_source_code_.c_str())); |
| } |
| |
| std::string required_element_list = ""; |
| ::SendMessage(*async_executor_handle, |
| WD_ASYNC_SCRIPT_GET_REQUIRED_ELEMENT_LIST, |
| NULL, |
| reinterpret_cast<LPARAM>(&required_element_list)); |
| Json::Value required_elements; |
| std::string parse_errors; |
| std::stringstream json_stream; |
| json_stream.str(required_element_list); |
| Json::parseFromStream(Json::CharReaderBuilder(), |
| json_stream, |
| &required_elements, |
| &parse_errors); |
| |
| for (Json::UInt i = 0; i < required_elements.size(); ++i) { |
| std::string element_id = required_elements[i].asString(); |
| this->SetAsyncScriptElementArgument(*async_executor_handle, |
| command_executor, |
| element_id); |
| } |
| |
| // Note: this is hard-coded to 200 milliseconds per element, but since |
| // we're just accessing the known element repository via a direct call, |
| // that should be way more than enough time. |
| int execution_prep_timeout = 200 * required_elements.size(); |
| int retry_counter = static_cast<int>(execution_prep_timeout / SCRIPT_WAIT_TIME_IN_MILLISECONDS); |
| bool is_execution_ready = ::SendMessage(*async_executor_handle, |
| WD_ASYNC_SCRIPT_IS_EXECUTION_READY, |
| NULL, |
| NULL) != 0; |
| while (!is_execution_ready && --retry_counter > 0) { |
| ::Sleep(SCRIPT_WAIT_TIME_IN_MILLISECONDS); |
| is_execution_ready = ::SendMessage(*async_executor_handle, |
| WD_ASYNC_SCRIPT_IS_EXECUTION_READY, |
| NULL, |
| NULL) != 0; |
| } |
| |
| ::PostMessage(*async_executor_handle, WD_ASYNC_SCRIPT_EXECUTE, NULL, NULL); |
| if (timeout_override_in_milliseconds > 0) { |
| // If we set a timeout override, that means we expect relatively quick |
| // execution with no need to retrieve elements as part of the script |
| // result. We will wait a short bit and poll for the execution of the |
| // script to be complete. This will allow us to say synchronous for |
| // short-running scripts like clearing an input element, yet still be |
| // able to continue processing when the script is blocked, as when an |
| // alert() window is present. |
| LOG(TRACE) << "Waiting for async script execution to be complete"; |
| int execution_retry_counter = static_cast<int>(timeout_override_in_milliseconds / SCRIPT_WAIT_TIME_IN_MILLISECONDS); |
| bool is_execution_finished = ::SendMessage(*async_executor_handle, |
| WD_ASYNC_SCRIPT_IS_EXECUTION_COMPLETE, |
| NULL, |
| NULL) != 0; |
| while (!is_execution_finished && --retry_counter > 0) { |
| ::Sleep(SCRIPT_WAIT_TIME_IN_MILLISECONDS); |
| is_execution_finished = ::SendMessage(*async_executor_handle, |
| WD_ASYNC_SCRIPT_IS_EXECUTION_COMPLETE, |
| NULL, |
| NULL) != 0; |
| } |
| |
| if (is_execution_finished) { |
| LOG(TRACE) << "Async script execution completed, getting result"; |
| Json::Value script_result; |
| int status_code = static_cast<int>(::SendMessage(*async_executor_handle, |
| WD_ASYNC_SCRIPT_GET_RESULT, |
| NULL, |
| reinterpret_cast<LPARAM>(&script_result))); |
| return status_code; |
| } else { |
| LOG(TRACE) << "Async script execution not completed after timeout, detaching listener"; |
| ::SendMessage(*async_executor_handle, |
| WD_ASYNC_SCRIPT_DETACH_LISTENTER, |
| NULL, |
| NULL); |
| } |
| } |
| return WD_SUCCESS; |
| } |
| |
| int Script::CreateAsyncScriptExecutor(HWND element_repository_handle, |
| const std::wstring& serialized_args, |
| HWND* async_executor_handle) { |
| LOG(TRACE) << "Entering Script::CreateAsyncScriptExecutor"; |
| CComVariant result = L""; |
| CComBSTR error_description = L""; |
| |
| AsyncScriptExecutorThreadContext thread_context; |
| thread_context.script_source = this->source_code_.c_str(); |
| thread_context.script_argument_count = this->argument_count_; |
| thread_context.main_element_repository_handle = element_repository_handle; |
| thread_context.serialized_script_args = serialized_args.c_str(); |
| |
| // We need exclusive access to this event. If it's already created, |
| // OpenEvent returns non-NULL, so we need to wait a bit and retry |
| // until OpenEvent returns NULL. |
| int retry_counter = 50; |
| HANDLE event_handle = ::OpenEvent(SYNCHRONIZE, FALSE, ASYNC_SCRIPT_EVENT_NAME); |
| while (event_handle != NULL && --retry_counter > 0) { |
| ::CloseHandle(event_handle); |
| ::Sleep(50); |
| event_handle = ::OpenEvent(SYNCHRONIZE, FALSE, ASYNC_SCRIPT_EVENT_NAME); |
| } |
| |
| // Failure condition here. |
| if (event_handle != NULL) { |
| ::CloseHandle(event_handle); |
| LOG(WARN) << "OpenEvent() returned non-NULL, event already exists."; |
| result.Clear(); |
| result.vt = VT_BSTR; |
| error_description = L"Couldn't create an event for synchronizing the creation of the thread. This generally means that you were trying to click on an option in two different instances."; |
| result.bstrVal = error_description; |
| this->result_.Copy(&result); |
| return EUNEXPECTEDJSERROR; |
| } |
| |
| LOG(DEBUG) << "Creating synchronization event for new thread"; |
| event_handle = ::CreateEvent(NULL, TRUE, FALSE, ASYNC_SCRIPT_EVENT_NAME); |
| if (event_handle == NULL || ::GetLastError() == ERROR_ALREADY_EXISTS) { |
| if (event_handle == NULL) { |
| LOG(WARN) << "CreateEvent() failed."; |
| error_description = L"Couldn't create an event for synchronizing the creation of the thread. This is an internal failure at the Windows OS level, and is generally not due to an error in the IE driver."; |
| } else { |
| ::CloseHandle(event_handle); |
| LOG(WARN) << "Synchronization event is already created in another instance."; |
| error_description = L"Couldn't create an event for synchronizing the creation of the thread. This generally means that you were trying to click on an option in multiple different instances."; |
| } |
| result.Clear(); |
| result.vt = VT_BSTR; |
| result.bstrVal = error_description; |
| this->result_.Copy(&result); |
| return EUNEXPECTEDJSERROR; |
| } |
| |
| // Start the thread and wait up to 1 second to be signaled that it is ready |
| // to receive messages, then close the event handle. |
| LOG(DEBUG) << "Starting new thread"; |
| unsigned int thread_id = 0; |
| HANDLE thread_handle = reinterpret_cast<HANDLE>(_beginthreadex(NULL, |
| 0, |
| AsyncScriptExecutor::ThreadProc, |
| reinterpret_cast<void*>(&thread_context), |
| 0, |
| &thread_id)); |
| |
| LOG(DEBUG) << "Waiting for new thread to be ready for messages"; |
| DWORD event_wait_result = ::WaitForSingleObject(event_handle, 5000); |
| if (event_wait_result != WAIT_OBJECT_0) { |
| LOG(WARN) << "Waiting for event to be signaled returned unexpected value: " << event_wait_result; |
| } |
| ::CloseHandle(event_handle); |
| |
| if (thread_handle == NULL) { |
| LOG(WARN) << "_beginthreadex() failed."; |
| result.Clear(); |
| result.vt = VT_BSTR; |
| error_description = L"Couldn't create a thread for executing JavaScript asynchronously."; |
| result.bstrVal = error_description; |
| this->result_.Copy(&result); |
| return EUNEXPECTEDJSERROR; |
| } |
| |
| *async_executor_handle = thread_context.hwnd; |
| return WD_SUCCESS; |
| } |
| |
| int Script::SetAsyncScriptDocument(HWND async_executor_handle) { |
| LOG(TRACE) << "Entering Script::SetAsyncScriptDocument"; |
| // Marshal the document and the element to click to streams for use in another thread. |
| LOG(DEBUG) << "Marshaling document to stream to send to new thread"; |
| LPSTREAM document_stream; |
| HRESULT hr = ::CoMarshalInterThreadInterfaceInStream(IID_IHTMLDocument2, |
| this->script_engine_host_, |
| &document_stream); |
| if (FAILED(hr)) { |
| LOGHR(WARN, hr) << "CoMarshalInterfaceThreadInStream() for document failed"; |
| CComVariant result = L""; |
| CComBSTR error_description = L""; |
| result.Clear(); |
| result.vt = VT_BSTR; |
| error_description = L"Couldn't marshal the IHTMLDocument2 interface to a stream. This is an internal COM error."; |
| result.bstrVal = error_description; |
| this->result_.Copy(&result); |
| return EUNEXPECTEDJSERROR; |
| } |
| ::SendMessage(async_executor_handle, |
| WD_ASYNC_SCRIPT_SET_DOCUMENT, |
| NULL, |
| reinterpret_cast<LPARAM>(document_stream)); |
| return WD_SUCCESS; |
| } |
| |
| int Script::SetAsyncScriptElementArgument(HWND async_executor_handle, |
| const IECommandExecutor& command_executor, |
| const std::string& element_id) { |
| LOG(TRACE) << "Entering Script::SetAsyncScriptElementArgument"; |
| ElementInfo* info = new ElementInfo; |
| info->element_id = element_id; |
| ElementHandle element_wrapper; |
| int return_code = command_executor.GetManagedElement(element_id, |
| &element_wrapper); |
| if (return_code != WD_SUCCESS) { |
| LOG(WARN) << "Element requested with id " << element_id |
| << " does not exist."; |
| return return_code; |
| } |
| HRESULT hr = ::CoMarshalInterThreadInterfaceInStream(IID_IHTMLElement, |
| element_wrapper->element(), |
| &info->element_stream); |
| if (FAILED(hr)) { |
| CComVariant result; |
| CComBSTR error_description = L""; |
| LOGHR(WARN, hr) << "CoMarshalInterfaceThreadInStream() for IDispatch argument failed"; |
| result.Clear(); |
| result.vt = VT_BSTR; |
| error_description = L"Couldn't marshal the IDispatch interface to a stream. This is an internal COM error."; |
| result.bstrVal = error_description; |
| this->result_.Copy(&result); |
| return EUNEXPECTEDJSERROR; |
| } |
| ::PostMessage(async_executor_handle, |
| WD_ASYNC_SCRIPT_SET_ELEMENT_ARGUMENT, |
| NULL, |
| reinterpret_cast<LPARAM>(info)); |
| return return_code; |
| } |
| |
| int Script::ConvertResultToJsonValue(const IECommandExecutor& executor, |
| Json::Value* value) { |
| LOG(TRACE) << "Entering Script::ConvertResultToJsonValue"; |
| IECommandExecutor& mutable_executor = const_cast<IECommandExecutor&>(executor); |
| return this->ConvertResultToJsonValue(mutable_executor.element_manager(), value); |
| } |
| |
| int Script::ConvertResultToJsonValue(IElementManager* element_manager, |
| Json::Value* value) { |
| LOG(TRACE) << "Entering Script::ConvertResultToJsonValue"; |
| int status_code = VariantUtilities::VariantAsJsonValue(element_manager, |
| this->result_, |
| value); |
| if (status_code != WD_SUCCESS) { |
| // Attempting to convert the VARIANT script result to a JSON value |
| // has failed. As a last-ditch effort, attempt to use JSON.stringify() |
| // to accomplish the same thing. |
| // TODO: Check the return value for a cyclic reference error first, and |
| // if that's the reason for the failure to convert, we can bypass this |
| // script execution and just return that as the error reason. |
| LOG(DEBUG) << "Script result could not be directly converted; " |
| << "attempting to use JSON.stringify()"; |
| std::wstring json_stringify_script = ANONYMOUS_FUNCTION_START; |
| json_stringify_script.append(L"return function(){ return JSON.stringify(arguments[0]); };"); |
| json_stringify_script.append(ANONYMOUS_FUNCTION_END); |
| Script stringify_script_wrapper(this->script_engine_host_, |
| json_stringify_script, |
| 1); |
| stringify_script_wrapper.AddArgument(this->result_); |
| status_code = stringify_script_wrapper.Execute(); |
| if (status_code == WD_SUCCESS) { |
| CComVariant result = stringify_script_wrapper.result(); |
| if (result.vt == VT_BSTR) { |
| std::wstring wide_json = result.bstrVal; |
| std::string json = StringUtilities::ToString(wide_json); |
| Json::Value interim_value; |
| std::string parse_errors; |
| std::stringstream json_stream; |
| json_stream.str(json); |
| bool successful_parse = Json::parseFromStream(Json::CharReaderBuilder(), |
| json_stream, |
| &interim_value, |
| &parse_errors); |
| if (successful_parse) { |
| *value = interim_value; |
| } |
| } |
| } else { |
| // If the call to JSON.stringify() fails, log the description of the |
| // error thrown by that call as the reason for the script returning a |
| // JavaScript error. |
| if (stringify_script_wrapper.result().vt == VT_BSTR) { |
| std::wstring error = stringify_script_wrapper.result().bstrVal; |
| *value = StringUtilities::ToString(error); |
| } |
| } |
| } |
| return status_code; |
| } |
| |
| bool Script::CreateAnonymousFunction(VARIANT* result) { |
| LOG(TRACE) << "Entering Script::CreateAnonymousFunction"; |
| |
| std::wstring function_eval_script = L"window.document.__webdriver_script_fn = "; |
| function_eval_script.append(this->source_code_.c_str()); |
| CComBSTR code(function_eval_script.c_str()); |
| CComBSTR lang(L"JScript"); |
| CComVariant exec_script_result; |
| |
| CComPtr<IHTMLWindow2> window; |
| HRESULT hr = this->script_engine_host_->get_parentWindow(&window); |
| if (FAILED(hr)) { |
| LOGHR(WARN, hr) << "Unable to get parent window, call to IHTMLDocument2::get_parentWindow failed"; |
| return false; |
| } |
| |
| hr = window->execScript(code, lang, &exec_script_result); |
| if (FAILED(hr)) { |
| LOGHR(WARN, hr) << "Unable to execute code, call to IHTMLWindow2::execScript failed"; |
| return false; |
| } |
| |
| bool get_result_success = VariantUtilities::GetVariantObjectPropertyValue( |
| this->script_engine_host_, |
| L"__webdriver_script_fn", |
| result); |
| return get_result_success; |
| } |
| |
| int Script::AddArguments(IElementManager* element_manager, const Json::Value& arguments) { |
| LOG(TRACE) << "Entering Script::AddArguments"; |
| |
| int status_code = WD_SUCCESS; |
| |
| // Calling vector::resize() is okay here, because the vector |
| // should be empty when Initialize() is called, and the |
| // reallocation of variants shouldn't give us too much of a |
| // negative impact. |
| this->argument_array_.resize(arguments.size()); |
| |
| for (UINT arg_index = 0; arg_index < arguments.size(); ++arg_index) { |
| Json::Value arg = arguments[arg_index]; |
| status_code = this->AddArgument(element_manager, arg); |
| if (status_code != WD_SUCCESS) { |
| break; |
| } |
| } |
| |
| return status_code; |
| } |
| |
| int Script::AddArgument(IElementManager* element_manager, const Json::Value& arg) { |
| LOG(TRACE) << "Entering Script::AddArgument"; |
| |
| int status_code = WD_SUCCESS; |
| if (arg.isString()) { |
| std::string value = arg.asString(); |
| this->AddArgument(value); |
| } else if (arg.isInt()) { |
| int int_number = arg.asInt(); |
| this->AddArgument(int_number); |
| } else if (arg.isDouble()) { |
| double dbl_number = arg.asDouble(); |
| this->AddArgument(dbl_number); |
| } else if (arg.isBool()) { |
| bool bool_arg = arg.asBool(); |
| this->AddArgument(bool_arg); |
| } else if (arg.isNull()) { |
| this->AddNullArgument(); |
| } else if (arg.isArray()) { |
| status_code = this->WalkArray(element_manager, arg); |
| } else if (arg.isObject()) { |
| if (arg.isMember(JSON_ELEMENT_PROPERTY_NAME)) { |
| std::string element_id = arg[JSON_ELEMENT_PROPERTY_NAME].asString(); |
| ElementHandle wrapped_element; |
| status_code = element_manager->GetManagedElement(element_id, &wrapped_element); |
| if (status_code == WD_SUCCESS) { |
| bool is_element_valid = wrapped_element->IsAttachedToDom(); |
| if (is_element_valid) { |
| is_element_valid = wrapped_element->IsDocumentFocused(this->script_engine_host_); |
| } else { |
| element_manager->RemoveManagedElement(element_id); |
| } |
| |
| if (is_element_valid) { |
| this->AddArgument(wrapped_element->element()); |
| } else { |
| status_code = EOBSOLETEELEMENT; |
| } |
| } |
| } else { |
| status_code = this->WalkObject(element_manager, arg); |
| } |
| } |
| |
| return status_code; |
| } |
| |
| int Script::WalkArray(IElementManager* element_manager, |
| const Json::Value& array_value) { |
| LOG(TRACE) << "Entering Script::WalkArray"; |
| |
| int status_code = WD_SUCCESS; |
| Json::UInt array_size = array_value.size(); |
| std::wstring array_script = L"(function(){ return function() { return ["; |
| for (Json::UInt index = 0; index < array_size; ++index) { |
| if (index != 0) { |
| array_script += L","; |
| } |
| std::wstring index_string = std::to_wstring(static_cast<long long>(index)); |
| array_script += L"arguments[" + index_string + L"]"; |
| } |
| array_script += L"];}})();"; |
| |
| Script array_script_wrapper(this->script_engine_host_, array_script, array_size); |
| for (Json::UInt index = 0; index < array_size; ++index) { |
| status_code = array_script_wrapper.AddArgument(element_manager, array_value[index]); |
| if (status_code != WD_SUCCESS) { |
| break; |
| } |
| } |
| |
| if (status_code == WD_SUCCESS) { |
| status_code = array_script_wrapper.Execute(); |
| } |
| |
| if (status_code == WD_SUCCESS) { |
| this->AddArgument(array_script_wrapper.result()); |
| } |
| |
| return status_code; |
| } |
| |
| int Script::WalkObject(IElementManager* element_manager, |
| const Json::Value& object_value) { |
| LOG(TRACE) << "Entering Script::WalkObject"; |
| |
| int status_code = WD_SUCCESS; |
| Json::Value::const_iterator it = object_value.begin(); |
| int counter = 0; |
| std::string object_script = "(function(){ return function() { return {"; |
| for (; it != object_value.end(); ++it) { |
| if (counter != 0) { |
| object_script += ","; |
| } |
| std::string counter_string = std::to_string(static_cast<long long>(counter)); |
| std::string name = it.name(); |
| object_script += "\"" + name + "\"" + ":arguments[" + counter_string + "]"; |
| ++counter; |
| } |
| object_script += "};}})();"; |
| |
| Script object_script_wrapper(this->script_engine_host_, object_script, counter); |
| for (it = object_value.begin(); it != object_value.end(); ++it) { |
| status_code = object_script_wrapper.AddArgument(element_manager, object_value[it.name()]); |
| if (status_code != WD_SUCCESS) { |
| break; |
| } |
| } |
| |
| if (status_code == WD_SUCCESS) { |
| status_code = object_script_wrapper.Execute(); |
| } |
| |
| if (status_code == WD_SUCCESS) { |
| this->AddArgument(object_script_wrapper.result()); |
| } |
| return status_code; |
| } |
| |
| } // namespace webdriver |
