-
-
Notifications
You must be signed in to change notification settings - Fork 8k
/
IECommandExecutor.cpp
executable file
·1482 lines (1330 loc) · 61.6 KB
/
IECommandExecutor.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// 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 "IECommandExecutor.h"
#include <algorithm>
#include <ctime>
#include <vector>
#include <mutex>
#include <iepmapi.h>
#include "command_types.h"
#include "errorcodes.h"
#include "logging.h"
#include "response.h"
#include "Alert.h"
#include "Browser.h"
#include "BrowserFactory.h"
#include "CommandExecutor.h"
#include "CommandHandlerRepository.h"
#include "CookieManager.h"
#include "Element.h"
#include "ElementFinder.h"
#include "ElementRepository.h"
#include "IECommandHandler.h"
#include "InputManager.h"
#include "HtmlDialog.h"
#include "ProxyManager.h"
#include "StringUtilities.h"
#include "Script.h"
#include "WebDriverConstants.h"
#include "WindowUtilities.h"
#define MAX_HTML_DIALOG_RETRIES 5
#define WAIT_TIME_IN_MILLISECONDS 50
#define DEFAULT_SCRIPT_TIMEOUT_IN_MILLISECONDS 30000
#define DEFAULT_PAGE_LOAD_TIMEOUT_IN_MILLISECONDS 300000
#define DEFAULT_FILE_UPLOAD_DIALOG_TIMEOUT_IN_MILLISECONDS 3000
#define DEFAULT_BROWSER_REATTACH_TIMEOUT_IN_MILLISECONDS 10000
namespace webdriver {
struct WaitThreadContext {
HWND window_handle;
bool is_deferred_command;
LPSTR deferred_response;
};
struct DelayPostMessageThreadContext {
HWND window_handle;
DWORD delay;
UINT msg;
};
LRESULT IECommandExecutor::OnCreate(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnCreate";
CREATESTRUCT* create = reinterpret_cast<CREATESTRUCT*>(lParam);
IECommandExecutorThreadContext* context = reinterpret_cast<IECommandExecutorThreadContext*>(create->lpCreateParams);
this->port_ = context->port;
// NOTE: COM should be initialized on this thread, so we
// could use CoCreateGuid() and StringFromGUID2() instead.
UUID guid;
RPC_WSTR guid_string = NULL;
RPC_STATUS status = ::UuidCreate(&guid);
status = ::UuidToString(&guid, &guid_string);
// RPC_WSTR is currently typedef'd in RpcDce.h (pulled in by rpc.h)
// as unsigned short*. It needs to be typedef'd as wchar_t*
wchar_t* cast_guid_string = reinterpret_cast<wchar_t*>(guid_string);
this->SetWindowText(cast_guid_string);
std::string session_id = StringUtilities::ToString(cast_guid_string);
this->session_id_ = session_id;
this->is_valid_ = true;
::RpcStringFree(&guid_string);
this->PopulateElementFinderMethods();
this->current_browser_id_ = "";
this->serialized_response_ = "";
this->unexpected_alert_behavior_ = "";
this->implicit_wait_timeout_ = 0;
this->async_script_timeout_ = DEFAULT_SCRIPT_TIMEOUT_IN_MILLISECONDS;
this->page_load_timeout_ = DEFAULT_PAGE_LOAD_TIMEOUT_IN_MILLISECONDS;
this->reattach_browser_timeout_ = DEFAULT_BROWSER_REATTACH_TIMEOUT_IN_MILLISECONDS;
this->is_waiting_ = false;
this->is_quitting_ = false;
this->is_awaiting_new_window_ = false;
this->use_strict_file_interactability_ = false;
this->page_load_strategy_ = "normal";
this->file_upload_dialog_timeout_ = DEFAULT_FILE_UPLOAD_DIALOG_TIMEOUT_IN_MILLISECONDS;
this->managed_elements_ = new ElementRepository();
this->input_manager_ = new InputManager();
this->proxy_manager_ = new ProxyManager();
this->factory_ = new BrowserFactory();
this->element_finder_ = new ElementFinder();
this->command_handlers_ = new CommandHandlerRepository();
this->is_edge_chromium_ = false;
return 0;
}
LRESULT IECommandExecutor::OnDestroy(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(DEBUG) << "Entering IECommandExecutor::OnDestroy";
LOG(DEBUG) << "Clearing managed element cache";
this->managed_elements_->Clear();
delete this->managed_elements_;
LOG(DEBUG) << "Closing command handler repository";
delete this->command_handlers_;
LOG(DEBUG) << "Closing element finder";
delete this->element_finder_;
LOG(DEBUG) << "Closing input manager";
delete this->input_manager_;
LOG(DEBUG) << "Closing proxy manager";
delete this->proxy_manager_;
LOG(DEBUG) << "Closing browser factory";
delete this->factory_;
LOG(DEBUG) << "Posting quit message";
::PostQuitMessage(0);
LOG(DEBUG) << "Leaving IECommandExecutor::OnDestroy";
return 0;
}
LRESULT IECommandExecutor::OnSetCommand(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnSetCommand";
LRESULT set_command_result = 0;
LPCSTR json_command = reinterpret_cast<LPCSTR>(lParam);
Command requested_command;
requested_command.Deserialize(json_command);
this->set_command_mutex_.lock();
if (this->current_command_.command_type() == CommandType::NoCommand ||
requested_command.command_type() == CommandType::Quit) {
this->current_command_.Deserialize(json_command);
set_command_result = 1;
}
this->set_command_mutex_.unlock();
return set_command_result;
}
LRESULT IECommandExecutor::OnExecCommand(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnExecCommand";
this->DispatchCommand();
return 0;
}
LRESULT IECommandExecutor::OnGetResponseLength(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
// Not logging trace entering IECommandExecutor::OnGetResponseLength,
// because it is polled repeatedly for a non-zero return value.
size_t response_length = 0;
if (!this->is_waiting_) {
response_length = this->serialized_response_.size();
}
return response_length;
}
LRESULT IECommandExecutor::OnGetResponse(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnGetResponse";
LPSTR str = reinterpret_cast<LPSTR>(lParam);
strcpy_s(str,
this->serialized_response_.size() + 1,
this->serialized_response_.c_str());
// Reset the serialized response for the next command.
this->serialized_response_ = "";
this->current_command_.Reset();
return 0;
}
LRESULT IECommandExecutor::OnWait(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnWait";
LPCSTR str = reinterpret_cast<LPCSTR>(lParam);
std::string deferred_response(str);
delete[] str;
LOG(DEBUG) << "Starting wait cycle.";
if (this->is_awaiting_new_window_) {
LOG(DEBUG) << "Awaiting new window. Aborting current wait cycle and "
<< "scheduling another.";
this->CreateWaitThread(deferred_response);
return 0;
}
bool is_single_wait = (wParam == 0);
BrowserHandle browser;
int status_code = this->GetCurrentBrowser(&browser);
if (status_code == WD_SUCCESS) {
if (!browser->is_closing()) {
if (this->page_load_timeout_ >= 0 && this->wait_timeout_ < clock()) {
LOG(DEBUG) << "Page load timeout reached. Ending wait cycle.";
Response timeout_response;
timeout_response.SetErrorResponse(ERROR_WEBDRIVER_TIMEOUT,
"Timed out waiting for page to load.");
browser->set_wait_required(false);
this->serialized_response_ = timeout_response.Serialize();
this->is_waiting_ = false;
return 0;
} else {
LOG(DEBUG) << "Beginning wait.";
this->is_waiting_ = !(browser->Wait(this->page_load_strategy_));
if (is_single_wait) {
LOG(DEBUG) << "Single requested wait with no deferred "
<< "response complete. Ending wait cycle.";
this->is_waiting_ = false;
return 0;
} else {
if (this->is_waiting_) {
LOG(DEBUG) << "Wait not complete. Scheduling another wait cycle.";
this->CreateWaitThread(deferred_response);
return 0;
}
}
}
}
}
LOG(DEBUG) << "Wait complete. Setting serialized response to deferred value "
<< deferred_response;
this->serialized_response_ = deferred_response;
this->is_waiting_ = false;
return 0;
}
LRESULT IECommandExecutor::OnBeforeNewWindow(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnBeforeNewWindow";
LOG(DEBUG) << "Setting await new window flag";
this->is_awaiting_new_window_ = true;
return 0;
}
LRESULT IECommandExecutor::OnAfterNewWindow(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnAfterNewWindow";
if (wParam > 0) {
LOG(DEBUG) << "Creating thread and reposting message.";
this->CreateDelayPostMessageThread(static_cast<DWORD>(wParam),
this->m_hWnd,
WD_AFTER_NEW_WINDOW);
} else {
LOG(DEBUG) << "Clearing await new window flag";
this->is_awaiting_new_window_ = false;
}
return 0;
}
LRESULT IECommandExecutor::OnBrowserNewWindow(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnBrowserNewWindow";
NewWindowInfo* info = reinterpret_cast<NewWindowInfo*>(lParam);
std::string target_url = info->target_url;
std::string new_browser_id = this->OpenNewBrowsingContext(WINDOW_WINDOW_TYPE,
target_url);
BrowserHandle new_window_wrapper;
this->GetManagedBrowser(new_browser_id, &new_window_wrapper);
if (new_window_wrapper->IsCrossZoneUrl(target_url)) {
new_window_wrapper->InitiateBrowserReattach();
}
LOG(DEBUG) << "Attempting to marshal interface pointer to requesting thread.";
IWebBrowser2* browser = new_window_wrapper->browser();
HRESULT hr = ::CoMarshalInterThreadInterfaceInStream(IID_IWebBrowser2,
browser,
&(info->browser_stream));
if (FAILED(hr)) {
LOGHR(WARN, hr) << "Marshalling of interface pointer b/w threads is failed.";
}
return 0;
}
LRESULT IECommandExecutor::OnBrowserCloseWait(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnBrowserCloseWait";
LPCSTR str = reinterpret_cast<LPCSTR>(lParam);
std::string browser_id(str);
delete[] str;
BrowserMap::iterator found_iterator = this->managed_browsers_.find(browser_id);
if (found_iterator != this->managed_browsers_.end()) {
HWND alert_handle;
bool is_alert_active = this->IsAlertActive(found_iterator->second,
&alert_handle);
if (is_alert_active) {
// If there's an alert window active, the browser's Quit event does
// not fire until any alerts are handled. Note that OnBeforeUnload
// alerts must be handled here; the driver contains the ability to
// handle other standard alerts on the next received command. We rely
// on the browser's Quit command to remove the driver from the list of
// managed browsers.
Alert dialog(found_iterator->second, alert_handle);
if (!dialog.is_standard_alert()) {
dialog.Accept();
is_alert_active = false;
}
}
if (!is_alert_active) {
::Sleep(100);
// If no alert is present, repost the message to the message pump, so
// that we can wait until the browser is fully closed to return the
// proper still-open list of window handles.
LPSTR message_payload = new CHAR[browser_id.size() + 1];
strcpy_s(message_payload, browser_id.size() + 1, browser_id.c_str());
::PostMessage(this->m_hWnd,
WD_BROWSER_CLOSE_WAIT,
NULL,
reinterpret_cast<LPARAM>(message_payload));
return 0;
}
} else {
LOG(WARN) << "Unable to find browser to quit with ID " << browser_id;
}
Json::Value handles(Json::arrayValue);
std::vector<std::string> handle_list;
this->GetManagedBrowserHandles(&handle_list);
std::vector<std::string>::const_iterator handle_iterator = handle_list.begin();
for (; handle_iterator != handle_list.end(); ++handle_iterator) {
handles.append(*handle_iterator);
}
Response close_window_response;
close_window_response.SetSuccessResponse(handles);
this->serialized_response_ = close_window_response.Serialize();
this->is_waiting_ = false;
return 0;
}
LRESULT IECommandExecutor::OnBrowserQuit(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnBrowserQuit";
LPCSTR str = reinterpret_cast<LPCSTR>(lParam);
std::string browser_id(str);
delete[] str;
BrowserMap::iterator found_iterator = this->managed_browsers_.find(browser_id);
if (found_iterator != this->managed_browsers_.end()) {
this->managed_browsers_.erase(browser_id);
if (this->managed_browsers_.size() == 0) {
this->current_browser_id_ = "";
}
} else {
LOG(WARN) << "Unable to find browser to quit with ID " << browser_id;
}
return 0;
}
LRESULT IECommandExecutor::OnBeforeBrowserReattach(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnBeforeBrowserReattach";
if (this->factory_->ignore_protected_mode_settings()) {
this->reattach_wait_timeout_ = clock() + (static_cast<int>(this->reattach_browser_timeout_) / 1000 * CLOCKS_PER_SEC);
}
return 0;
}
LRESULT IECommandExecutor::OnBrowserReattach(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnBrowserReattach";
BrowserReattachInfo* info = reinterpret_cast<BrowserReattachInfo*>(lParam);
DWORD current_process_id = info->current_process_id;
std::string browser_id = info->browser_id;
std::vector<DWORD> known_process_ids = info->known_process_ids;
delete info;
if (!this->factory_->ignore_protected_mode_settings()) {
return 0;
}
if (this->reattach_wait_timeout_ < clock()) {
LOG(WARN) << "Reattach attempt has timed out";
return 0;
}
LOG(DEBUG) << "Starting browser reattach process";
std::vector<DWORD> new_process_ids;
this->GetNewBrowserProcessIds(&known_process_ids, &new_process_ids);
if (new_process_ids.size() == 0) {
LOG(DEBUG) << "No new process found, rescheduling reattach";
// If no new process IDs were found yet, repost the message
this->PostBrowserReattachMessage(current_process_id,
browser_id,
known_process_ids);
}
if (new_process_ids.size() > 1) {
LOG(WARN) << "Found more than one new iexplore.exe process. It is "
<< "impossible to know which is the proper one. Choosing one "
<< "at random.";
}
DWORD new_process_id = new_process_ids[0];
if (!this->factory_->IsBrowserProcessInitialized(new_process_id)) {
// If the browser for the new process ID is not yet ready,
// repost the message
LOG(DEBUG) << "Browser process " << new_process_id
<< " not initialized, rescheduling reattach";
this->PostBrowserReattachMessage(current_process_id,
browser_id,
known_process_ids);
return 0;
}
std::string error_message = "";
ProcessWindowInfo process_window_info;
process_window_info.dwProcessId = new_process_id;
process_window_info.hwndBrowser = NULL;
process_window_info.pBrowser = NULL;
bool attached = this->factory_->AttachToBrowser(&process_window_info, &error_message);
BrowserMap::iterator found_iterator = this->managed_browsers_.find(browser_id);
if (found_iterator != this->managed_browsers_.end()) {
this->proxy_manager_->SetProxySettings(process_window_info.hwndBrowser);
found_iterator->second->cookie_manager()->Initialize(process_window_info.hwndBrowser);
found_iterator->second->ReattachBrowser(process_window_info.pBrowser);
} else {
LOG(WARN) << "The managed browser was not found to reattach to.";
}
return 0;
}
LRESULT IECommandExecutor::OnIsSessionValid(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnIsSessionValid";
return this->is_valid_ ? 1 : 0;
}
LRESULT IECommandExecutor::OnNewHtmlDialog(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandles) {
LOG(TRACE) << "Entering IECommandExecutor::OnNewHtmlDialog";
HWND dialog_handle = reinterpret_cast<HWND>(lParam);
BrowserMap::const_iterator it = this->managed_browsers_.begin();
for (; it != this->managed_browsers_.end(); ++it) {
if (dialog_handle == it->second->window_handle()) {
LOG(DEBUG) << "Dialog is equal to one managed browser";
return 0;
}
}
int retry_count = 0;
CComPtr<IHTMLDocument2> document;
bool found_document = this->factory_->GetDocumentFromWindowHandle(dialog_handle, &document);
while (found_document && retry_count < MAX_HTML_DIALOG_RETRIES) {
CComPtr<IHTMLWindow2> window;
HRESULT hr = document->get_parentWindow(&window);
if (FAILED(hr)) {
// Getting the parent window of the dialog's document failed. This
// usually means that the document changed out from under us before we
// could get the window reference. The canonical case for this is a
// redirect using JavaScript. Sleep for a short time, then retry to
// obtain the reference.
LOGHR(DEBUG, hr) << "IHTMLDocument2::get_parentWindow failed. Retrying.";
::Sleep(100);
document.Release();
found_document = this->factory_->GetDocumentFromWindowHandle(dialog_handle, &document);
++retry_count;
} else {
this->AddManagedBrowser(BrowserHandle(new HtmlDialog(window,
dialog_handle,
this->m_hWnd)));
return 0;
}
}
if (found_document) {
LOG(WARN) << "Got document from dialog, but could not get window";
} else {
LOG(WARN) << "Unable to get document from dialog";
}
return 0;
}
LRESULT IECommandExecutor::OnQuit(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
return 0;
}
LRESULT IECommandExecutor::OnGetQuitStatus(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
return this->is_quitting_ && this->managed_browsers_.size() > 0 ? 1 : 0;
}
LRESULT IECommandExecutor::OnScriptWait(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnScriptWait";
BrowserHandle browser;
int status_code = this->GetCurrentBrowser(&browser);
if (status_code == WD_SUCCESS && !browser->is_closing()) {
if (this->async_script_timeout_ >= 0 && this->wait_timeout_ < clock()) {
::SendMessage(browser->script_executor_handle(),
WD_ASYNC_SCRIPT_DETACH_LISTENTER,
NULL,
NULL);
Response timeout_response;
timeout_response.SetErrorResponse(ERROR_SCRIPT_TIMEOUT,
"Timed out waiting for script to complete.");
this->serialized_response_ = timeout_response.Serialize();
this->is_waiting_ = false;
browser->set_script_executor_handle(NULL);
} else {
HWND alert_handle;
bool is_execution_finished = ::SendMessage(browser->script_executor_handle(),
WD_ASYNC_SCRIPT_IS_EXECUTION_COMPLETE,
NULL,
NULL) != 0;
bool is_alert_active = this->IsAlertActive(browser, &alert_handle);
this->is_waiting_ = !is_execution_finished && !is_alert_active;
if (this->is_waiting_) {
// If we are still waiting, we need to wait a bit then post a message to
// ourselves to run the wait again. However, we can't wait using Sleep()
// on this thread. This call happens in a message loop, and we would be
// unable to process the COM events in the browser if we put this thread
// to sleep.
unsigned int thread_id = 0;
HANDLE thread_handle = reinterpret_cast<HANDLE>(_beginthreadex(NULL,
0,
&IECommandExecutor::ScriptWaitThreadProc,
(void *)this->m_hWnd,
0,
&thread_id));
if (thread_handle != NULL) {
::CloseHandle(thread_handle);
} else {
LOGERR(DEBUG) << "Unable to create waiter thread";
}
} else {
Response response;
Json::Value script_result;
::SendMessage(browser->script_executor_handle(),
WD_ASYNC_SCRIPT_DETACH_LISTENTER,
NULL,
NULL);
int status_code = static_cast<int>(::SendMessage(browser->script_executor_handle(),
WD_ASYNC_SCRIPT_GET_RESULT,
NULL,
reinterpret_cast<LPARAM>(&script_result)));
if (status_code != WD_SUCCESS) {
std::string error_message = "Error executing JavaScript";
if (script_result.isString()) {
error_message = script_result.asString();
}
response.SetErrorResponse(status_code, error_message);
} else {
response.SetSuccessResponse(script_result);
}
::SendMessage(browser->script_executor_handle(), WM_CLOSE, NULL, NULL);
browser->set_script_executor_handle(NULL);
this->serialized_response_ = response.Serialize();
}
}
} else {
this->is_waiting_ = false;
}
return 0;
}
LRESULT IECommandExecutor::OnRefreshManagedElements(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
this->managed_elements_->ClearCache();
return 0;
}
LRESULT IECommandExecutor::OnHandleUnexpectedAlerts(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnHandleUnexpectedAlerts";
BrowserMap::const_iterator it = this->managed_browsers_.begin();
for (; it != this->managed_browsers_.end(); ++it) {
HWND alert_handle = it->second->GetActiveDialogWindowHandle();
if (alert_handle != NULL) {
std::string alert_text;
this->HandleUnexpectedAlert(it->second, alert_handle, true, &alert_text);
}
}
return 0;
}
LRESULT IECommandExecutor::OnTransferManagedElement(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnTransferManagedElement";
ElementInfo* info = reinterpret_cast<ElementInfo*>(lParam);
std::string element_id = info->element_id;
LPSTREAM element_stream = info->element_stream;
BrowserHandle browser_handle;
this->GetCurrentBrowser(&browser_handle);
CComPtr<IHTMLElement> element;
::CoGetInterfaceAndReleaseStream(element_stream,
IID_IHTMLElement,
reinterpret_cast<void**>(&element));
delete info;
ElementHandle element_handle;
this->managed_elements_->AddManagedElement(browser_handle,
element,
&element_handle);
RemappedElementInfo* return_info = new RemappedElementInfo;
return_info->original_element_id = element_id;
return_info->element_id = element_handle->element_id();
::PostMessage(browser_handle->script_executor_handle(),
WD_ASYNC_SCRIPT_NOTIFY_ELEMENT_TRANSFERRED,
NULL,
reinterpret_cast<LPARAM>(return_info));
return WD_SUCCESS;
}
LRESULT IECommandExecutor::OnScheduleRemoveManagedElement(UINT uMsg,
WPARAM wParam,
LPARAM lParam,
BOOL& bHandled) {
LOG(TRACE) << "Entering IECommandExecutor::OnScheduleRemoveManagedElement";
ElementInfo* info = reinterpret_cast<ElementInfo*>(lParam);
std::string element_id = info->element_id;
delete info;
this->RemoveManagedElement(element_id);
return WD_SUCCESS;
}
unsigned int WINAPI IECommandExecutor::WaitThreadProc(LPVOID lpParameter) {
LOG(TRACE) << "Entering IECommandExecutor::WaitThreadProc";
WaitThreadContext* thread_context = reinterpret_cast<WaitThreadContext*>(lpParameter);
HWND window_handle = thread_context->window_handle;
bool is_deferred_command = thread_context->is_deferred_command;
std::string deferred_response(thread_context->deferred_response);
delete thread_context->deferred_response;
delete thread_context;
LPSTR message_payload = new CHAR[deferred_response.size() + 1];
strcpy_s(message_payload,
deferred_response.size() + 1,
deferred_response.c_str());
::Sleep(WAIT_TIME_IN_MILLISECONDS);
::PostMessage(window_handle,
WD_WAIT,
static_cast<WPARAM>(deferred_response.size()),
reinterpret_cast<LPARAM>(message_payload));
if (is_deferred_command) {
// This wait is requested by the automatic handling of a user prompt
// before a command was executed, so re-queue the command execution
// for after the wait.
::PostMessage(window_handle, WD_EXEC_COMMAND, NULL, NULL);
}
return 0;
}
unsigned int WINAPI IECommandExecutor::ScriptWaitThreadProc(LPVOID lpParameter) {
LOG(TRACE) << "Entering IECommandExecutor::ScriptWaitThreadProc";
HWND window_handle = reinterpret_cast<HWND>(lpParameter);
::Sleep(SCRIPT_WAIT_TIME_IN_MILLISECONDS);
::PostMessage(window_handle, WD_SCRIPT_WAIT, NULL, NULL);
return 0;
}
unsigned int WINAPI IECommandExecutor::DelayPostMessageThreadProc(LPVOID lpParameter) {
LOG(TRACE) << "Entering IECommandExecutor::DelayPostMessageThreadProc";
DelayPostMessageThreadContext* context = reinterpret_cast<DelayPostMessageThreadContext*>(lpParameter);
HWND window_handle = context->window_handle;
DWORD sleep_time = context->delay;
UINT message_to_post = context->msg;
delete context;
::Sleep(sleep_time);
::PostMessage(window_handle, message_to_post, NULL, NULL);
return 0;
}
unsigned int WINAPI IECommandExecutor::ThreadProc(LPVOID lpParameter) {
LOG(TRACE) << "Entering IECommandExecutor::ThreadProc";
IECommandExecutorThreadContext* thread_context = reinterpret_cast<IECommandExecutorThreadContext*>(lpParameter);
HWND window_handle = thread_context->hwnd;
// it is better to use IECommandExecutorSessionContext instead
// but use ThreadContext for code minimization
IECommandExecutorThreadContext* session_context = new IECommandExecutorThreadContext();
session_context->port = thread_context->port;
DWORD error = 0;
HRESULT hr = ::CoInitializeEx(NULL, COINIT_APARTMENTTHREADED);
if (FAILED(hr)) {
LOGHR(DEBUG, hr) << "COM library initialization encountered an error";
}
IECommandExecutor new_session;
HWND session_window_handle = new_session.Create(/*HWND*/ HWND_MESSAGE,
/*_U_RECT rect*/ CWindow::rcDefault,
/*LPCTSTR szWindowName*/ NULL,
/*DWORD dwStyle*/ NULL,
/*DWORD dwExStyle*/ NULL,
/*_U_MENUorID MenuOrID*/ 0U,
/*LPVOID lpCreateParam*/ reinterpret_cast<LPVOID*>(session_context));
if (session_window_handle == NULL) {
LOGERR(WARN) << "Unable to create new IECommandExecutor session";
}
MSG msg;
::PeekMessage(&msg, NULL, WM_USER, WM_USER, PM_NOREMOVE);
// Return the HWND back through lpParameter, and signal that the
// window is ready for messages.
thread_context->hwnd = session_window_handle;
HANDLE event_handle = ::OpenEvent(EVENT_ALL_ACCESS, FALSE, WEBDRIVER_START_EVENT_NAME);
if (event_handle != NULL) {
::SetEvent(event_handle);
::CloseHandle(event_handle);
} else {
LOGERR(DEBUG) << "Unable to signal that window is ready";
}
// Run the message loop
BOOL get_message_return_value;
while ((get_message_return_value = ::GetMessage(&msg, NULL, 0, 0)) != 0) {
if (get_message_return_value == -1) {
LOGERR(WARN) << "Windows GetMessage() API returned error";
break;
} else {
if (msg.message == WD_SHUTDOWN) {
LOG(DEBUG) << "Shutdown message received";
new_session.DestroyWindow();
LOG(DEBUG) << "Returned from DestroyWindow()";
break;
} else {
// We need to lock this mutex here to make sure only one thread is processing
// win32 messages at a time.
static std::mutex messageLock;
std::lock_guard<std::mutex> lock(messageLock);
::TranslateMessage(&msg);
::DispatchMessage(&msg);
}
}
}
LOG(DEBUG) << "Exited IECommandExecutor thread message loop";
::CoUninitialize();
delete session_context;
return 0;
}
void IECommandExecutor::DispatchCommand() {
LOG(TRACE) << "Entering IECommandExecutor::DispatchCommand";
Response response;
if (!this->command_handlers_->IsValidCommand(this->current_command_.command_type())) {
LOG(WARN) << "Unable to find command handler for " << this->current_command_.command_type();
response.SetErrorResponse(ERROR_UNKNOWN_COMMAND, "Command not implemented");
} else if (!this->current_command_.is_valid_parameters()) {
response.SetErrorResponse(ERROR_INVALID_ARGUMENT, "parameters property of command is not a valid JSON object");
} else {
BrowserHandle browser;
int status_code = WD_SUCCESS;
std::string command_type = this->current_command_.command_type();
if (command_type != webdriver::CommandType::NewSession) {
// There should never be a modal dialog or alert to check for if the command
// is the "newSession" command.
status_code = this->GetCurrentBrowser(&browser);
if (status_code == WD_SUCCESS) {
LOG(DEBUG) << "Checking for alert before executing " << command_type << " command";
HWND alert_handle = NULL;
bool alert_is_active = this->IsAlertActive(browser, &alert_handle);
if (alert_is_active) {
if (this->IsCommandValidWithAlertPresent()) {
LOG(DEBUG) << "Alert is detected, and the sent command is valid";
} else {
LOG(DEBUG) << "Unexpected alert is detected, and the sent command "
<< "is invalid when an alert is present";
bool is_quit_command = command_type == webdriver::CommandType::Quit;
std::string alert_text;
bool is_notify_unexpected_alert = this->HandleUnexpectedAlert(browser,
alert_handle,
is_quit_command,
&alert_text);
if (!is_quit_command) {
if (is_notify_unexpected_alert) {
// To keep pace with what the specification suggests, we'll
// return the text of the alert in the error response.
response.SetErrorResponse(EUNEXPECTEDALERTOPEN,
"Modal dialog present with text: " + alert_text);
response.AddAdditionalData("text", alert_text);
this->serialized_response_ = response.Serialize();
return;
} else {
LOG(DEBUG) << "Command other than quit was issued, and option "
<< "to not notify was specified. Continuing with "
<< "command after automatically closing alert.";
// Push a wait cycle, then re-execute the current command (which
// hasn't actually been executed yet). Note that an empty string
// for the deferred response parameter of CreateWaitThread will
// re-queue the execution of the command.
this->CreateWaitThread("", true);
return;
}
} else {
LOG(DEBUG) << "Quit command was issued. Continuing with "
<< "command after automatically closing alert.";
}
}
}
} else {
LOG(WARN) << "Unable to find current browser";
}
}
LOG(DEBUG) << "Executing command: " << command_type;
CommandHandlerHandle command_handler = this->command_handlers_->GetCommandHandler(command_type);
command_handler->Execute(*this, this->current_command_, &response);
LOG(DEBUG) << "Command execution for " << command_type << " complete";
status_code = this->GetCurrentBrowser(&browser);
if (status_code == WD_SUCCESS) {
if (browser->is_closing() && !this->is_quitting_) {
// Case 1: The browser window is closing, but not via the Quit command,
// so the executor must wait for the browser window to be closed and
// removed from the list of managed browser windows.
LOG(DEBUG) << "Browser is closing; awaiting close.";
LPSTR message_payload = new CHAR[browser->browser_id().size() + 1];
strcpy_s(message_payload,
browser->browser_id().size() + 1,
browser->browser_id().c_str());
this->is_waiting_ = true;
::Sleep(WAIT_TIME_IN_MILLISECONDS);
::PostMessage(this->m_hWnd,
WD_BROWSER_CLOSE_WAIT,
NULL,
reinterpret_cast<LPARAM>(message_payload));
return;
} else if (browser->script_executor_handle() != NULL) {
// Case 2: There is a pending asynchronous JavaScript execution in
// progress, so the executor must wait for the script to complete
// or a timeout.
this->is_waiting_ = true;
if (this->async_script_timeout_ >= 0) {
this->wait_timeout_ = clock() + (static_cast<int>(this->async_script_timeout_) / 1000 * CLOCKS_PER_SEC);
}
LOG(DEBUG) << "Awaiting completion of in-progress asynchronous JavaScript execution.";
::PostMessage(this->m_hWnd, WD_SCRIPT_WAIT, NULL, NULL);
return;
} else if (browser->wait_required()) {
// Case 3: The command handler has explicitly asked to wait for page
// load, so the executor must wait for page load or timeout.
this->is_waiting_ = true;
if (this->page_load_timeout_ >= 0) {
this->wait_timeout_ = clock() + (static_cast<int>(this->page_load_timeout_) / 1000 * CLOCKS_PER_SEC);
}
std::string deferred_response = response.Serialize();
LOG(DEBUG) << "Command handler requested wait. This will cause a minimal wait of at least 50 milliseconds.";
this->CreateWaitThread(deferred_response);
return;
}
} else {
if (this->current_command_.command_type() != webdriver::CommandType::Quit) {
LOG(WARN) << "Unable to get current browser";
}
}
}
this->serialized_response_ = response.Serialize();
LOG(DEBUG) << "Setting serialized response to " << this->serialized_response_;
LOG(DEBUG) << "Is waiting flag: " << this->is_waiting_ ? "true" : "false";
}
bool IECommandExecutor::IsCommandValidWithAlertPresent() {
std::string command_type = this->current_command_.command_type();
if (command_type == webdriver::CommandType::GetAlertText ||
command_type == webdriver::CommandType::SendKeysToAlert ||
command_type == webdriver::CommandType::AcceptAlert ||
command_type == webdriver::CommandType::DismissAlert ||
command_type == webdriver::CommandType::SetAlertCredentials ||
command_type == webdriver::CommandType::GetTimeouts ||
command_type == webdriver::CommandType::SetTimeouts ||
command_type == webdriver::CommandType::Screenshot ||
command_type == webdriver::CommandType::ElementScreenshot ||
command_type == webdriver::CommandType::GetCurrentWindowHandle ||
command_type == webdriver::CommandType::GetWindowHandles ||
command_type == webdriver::CommandType::SwitchToWindow) {
return true;
}
return false;
}
void IECommandExecutor::CreateWaitThread(const std::string& deferred_response) {
this->CreateWaitThread(deferred_response, false);
}
void IECommandExecutor::CreateWaitThread(const std::string& deferred_response,
const bool is_deferred_command_execution) {
// If we are still waiting, we need to wait a bit then post a message to
// ourselves to run the wait again. However, we can't wait using Sleep()
// on this thread. This call happens in a message loop, and we would be
// unable to process the COM events in the browser if we put this thread
// to sleep.
LOG(DEBUG) << "Creating wait thread with deferred response of `" << deferred_response << "`";
if (is_deferred_command_execution) {
LOG(DEBUG) << "Command execution will be rescheduled.";
}
WaitThreadContext* thread_context = new WaitThreadContext;
thread_context->window_handle = this->m_hWnd;
thread_context->is_deferred_command = is_deferred_command_execution;
thread_context->deferred_response = new CHAR[deferred_response.size() + 1];
strcpy_s(thread_context->deferred_response,
deferred_response.size() + 1,
deferred_response.c_str());
unsigned int thread_id = 0;
HANDLE thread_handle = reinterpret_cast<HANDLE>(_beginthreadex(NULL,
0,
&IECommandExecutor::WaitThreadProc,
reinterpret_cast<void*>(thread_context),
0,
&thread_id));
if (thread_handle != NULL) {
::CloseHandle(thread_handle);
}
else {
LOGERR(DEBUG) << "Unable to create waiter thread";
}
}
void IECommandExecutor::CreateDelayPostMessageThread(const DWORD delay_time,
const HWND window_handle,
const UINT message_to_post) {
DelayPostMessageThreadContext* context = new DelayPostMessageThreadContext;
context->delay = delay_time;