/
RemoteWebElement.php
540 lines (476 loc) · 15.1 KB
/
RemoteWebElement.php
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
<?php
namespace Facebook\WebDriver\Remote;
use Facebook\WebDriver\Exception\WebDriverException;
use Facebook\WebDriver\Interactions\Internal\WebDriverCoordinates;
use Facebook\WebDriver\Internal\WebDriverLocatable;
use Facebook\WebDriver\WebDriverBy;
use Facebook\WebDriver\WebDriverDimension;
use Facebook\WebDriver\WebDriverElement;
use Facebook\WebDriver\WebDriverKeys;
use Facebook\WebDriver\WebDriverPoint;
use ZipArchive;
/**
* Represents an HTML element.
*/
class RemoteWebElement implements WebDriverElement, WebDriverLocatable
{
/**
* @var RemoteExecuteMethod
*/
protected $executor;
/**
* @var string
*/
protected $id;
/**
* @var FileDetector
*/
protected $fileDetector;
/**
* @var bool
*/
protected $isW3cCompliant;
/**
* @param RemoteExecuteMethod $executor
* @param string $id
* @param bool $isW3cCompliant
*/
public function __construct(RemoteExecuteMethod $executor, $id, $isW3cCompliant = false)
{
$this->executor = $executor;
$this->id = $id;
$this->fileDetector = new UselessFileDetector();
$this->isW3cCompliant = $isW3cCompliant;
}
/**
* Clear content editable or resettable element
*
* @return RemoteWebElement The current instance.
*/
public function clear()
{
$this->executor->execute(
DriverCommand::CLEAR_ELEMENT,
[':id' => $this->id]
);
return $this;
}
/**
* Click this element.
*
* @return RemoteWebElement The current instance.
*/
public function click()
{
$this->executor->execute(
DriverCommand::CLICK_ELEMENT,
[':id' => $this->id]
);
return $this;
}
/**
* Find the first WebDriverElement within this element using the given mechanism.
*
* @param WebDriverBy $by
* @return RemoteWebElement NoSuchElementException is thrown in HttpCommandExecutor if no element is found.
* @see WebDriverBy
*/
public function findElement(WebDriverBy $by)
{
$params = JsonWireCompat::getUsing($by, $this->isW3cCompliant);
$params[':id'] = $this->id;
$raw_element = $this->executor->execute(
DriverCommand::FIND_CHILD_ELEMENT,
$params
);
return $this->newElement(JsonWireCompat::getElement($raw_element));
}
/**
* Find all WebDriverElements within this element using the given mechanism.
*
* @param WebDriverBy $by
* @return RemoteWebElement[] A list of all WebDriverElements, or an empty
* array if nothing matches
* @see WebDriverBy
*/
public function findElements(WebDriverBy $by)
{
$params = JsonWireCompat::getUsing($by, $this->isW3cCompliant);
$params[':id'] = $this->id;
$raw_elements = $this->executor->execute(
DriverCommand::FIND_CHILD_ELEMENTS,
$params
);
$elements = [];
foreach ($raw_elements as $raw_element) {
$elements[] = $this->newElement(JsonWireCompat::getElement($raw_element));
}
return $elements;
}
/**
* Get the value of the given attribute of the element.
*
* @param string $attribute_name The name of the attribute.
* @return string|null The value of the attribute.
*/
public function getAttribute($attribute_name)
{
$params = [
':name' => $attribute_name,
':id' => $this->id,
];
if ($this->isW3cCompliant && ($attribute_name === 'value' || $attribute_name === 'index')) {
$value = $this->executor->execute(DriverCommand::GET_ELEMENT_PROPERTY, $params);
if ($value === true) {
return 'true';
}
if ($value === false) {
return 'false';
}
if ($value !== null) {
return (string) $value;
}
}
return $this->executor->execute(DriverCommand::GET_ELEMENT_ATTRIBUTE, $params);
}
/**
* Get the value of a given CSS property.
*
* @param string $css_property_name The name of the CSS property.
* @return string The value of the CSS property.
*/
public function getCSSValue($css_property_name)
{
$params = [
':propertyName' => $css_property_name,
':id' => $this->id,
];
return $this->executor->execute(
DriverCommand::GET_ELEMENT_VALUE_OF_CSS_PROPERTY,
$params
);
}
/**
* Get the location of element relative to the top-left corner of the page.
*
* @return WebDriverPoint The location of the element.
*/
public function getLocation()
{
$location = $this->executor->execute(
DriverCommand::GET_ELEMENT_LOCATION,
[':id' => $this->id]
);
return new WebDriverPoint($location['x'], $location['y']);
}
/**
* Try scrolling the element into the view port and return the location of
* element relative to the top-left corner of the page afterwards.
*
* @return WebDriverPoint The location of the element.
*/
public function getLocationOnScreenOnceScrolledIntoView()
{
$location = $this->executor->execute(
DriverCommand::GET_ELEMENT_LOCATION_ONCE_SCROLLED_INTO_VIEW,
[':id' => $this->id]
);
return new WebDriverPoint($location['x'], $location['y']);
}
/**
* @return WebDriverCoordinates
*/
public function getCoordinates()
{
$element = $this;
$on_screen = null; // planned but not yet implemented
$in_view_port = static function () use ($element) {
return $element->getLocationOnScreenOnceScrolledIntoView();
};
$on_page = static function () use ($element) {
return $element->getLocation();
};
$auxiliary = $this->getID();
return new WebDriverCoordinates(
$on_screen,
$in_view_port,
$on_page,
$auxiliary
);
}
/**
* Get the size of element.
*
* @return WebDriverDimension The dimension of the element.
*/
public function getSize()
{
$size = $this->executor->execute(
DriverCommand::GET_ELEMENT_SIZE,
[':id' => $this->id]
);
return new WebDriverDimension($size['width'], $size['height']);
}
/**
* Get the (lowercase) tag name of this element.
*
* @return string The tag name.
*/
public function getTagName()
{
// Force tag name to be lowercase as expected by JsonWire protocol for Opera driver
// until this issue is not resolved :
// https://github.com/operasoftware/operadriver/issues/102
// Remove it when fixed to be consistent with the protocol.
return mb_strtolower($this->executor->execute(
DriverCommand::GET_ELEMENT_TAG_NAME,
[':id' => $this->id]
));
}
/**
* Get the visible (i.e. not hidden by CSS) innerText of this element,
* including sub-elements, without any leading or trailing whitespace.
*
* @return string The visible innerText of this element.
*/
public function getText()
{
return $this->executor->execute(
DriverCommand::GET_ELEMENT_TEXT,
[':id' => $this->id]
);
}
/**
* Is this element displayed or not? This method avoids the problem of having
* to parse an element's "style" attribute.
*
* @return bool
*/
public function isDisplayed()
{
return $this->executor->execute(
DriverCommand::IS_ELEMENT_DISPLAYED,
[':id' => $this->id]
);
}
/**
* Is the element currently enabled or not? This will generally return true
* for everything but disabled input elements.
*
* @return bool
*/
public function isEnabled()
{
return $this->executor->execute(
DriverCommand::IS_ELEMENT_ENABLED,
[':id' => $this->id]
);
}
/**
* Determine whether this element is selected or not.
*
* @return bool
*/
public function isSelected()
{
return $this->executor->execute(
DriverCommand::IS_ELEMENT_SELECTED,
[':id' => $this->id]
);
}
/**
* Simulate typing into an element, which may set its value.
*
* @param mixed $value The data to be typed.
* @return RemoteWebElement The current instance.
*/
public function sendKeys($value)
{
$local_file = $this->fileDetector->getLocalFile($value);
$params = [];
if ($local_file === null) {
if ($this->isW3cCompliant) {
// Work around the Geckodriver NULL issue by splitting on NULL and calling sendKeys multiple times.
// See https://bugzilla.mozilla.org/show_bug.cgi?id=1494661.
$encodedValues = explode(WebDriverKeys::NULL, WebDriverKeys::encode($value, true));
foreach ($encodedValues as $encodedValue) {
$params[] = [
'text' => $encodedValue,
':id' => $this->id,
];
}
} else {
$params[] = [
'value' => WebDriverKeys::encode($value),
':id' => $this->id,
];
}
} else {
if ($this->isW3cCompliant) {
try {
// Attempt to upload the file to the remote browser.
// This is so far non-W3C compliant method, so it may fail - if so, we just ignore the exception.
// @see https://github.com/w3c/webdriver/issues/1355
$fileName = $this->upload($local_file);
} catch (WebDriverException $e) {
$fileName = $local_file;
}
$params[] = [
'text' => $fileName,
':id' => $this->id,
];
} else {
$params[] = [
'value' => WebDriverKeys::encode($this->upload($local_file)),
':id' => $this->id,
];
}
}
foreach ($params as $param) {
$this->executor->execute(DriverCommand::SEND_KEYS_TO_ELEMENT, $param);
}
return $this;
}
/**
* Set the fileDetector in order to let the RemoteWebElement to know that you are going to upload a file.
*
* Basically, if you want WebDriver trying to send a file, set the fileDetector
* to be LocalFileDetector. Otherwise, keep it UselessFileDetector.
*
* eg. `$element->setFileDetector(new LocalFileDetector);`
*
* @param FileDetector $detector
* @return RemoteWebElement
* @see FileDetector
* @see LocalFileDetector
* @see UselessFileDetector
*/
public function setFileDetector(FileDetector $detector)
{
$this->fileDetector = $detector;
return $this;
}
/**
* If this current element is a form, or an element within a form, then this will be submitted to the remote server.
*
* @return RemoteWebElement The current instance.
*/
public function submit()
{
if ($this->isW3cCompliant) {
$this->executor->execute(DriverCommand::EXECUTE_SCRIPT, [
// cannot call the submit method directly in case an input of this form is named "submit"
'script' => sprintf(
'return Object.getPrototypeOf(%1$s).submit.call(%1$s);',
$this->getTagName() === 'form' ? 'arguments[0]' : 'arguments[0].form'
),
'args' => [[JsonWireCompat::WEB_DRIVER_ELEMENT_IDENTIFIER => $this->id]],
]);
return $this;
}
$this->executor->execute(
DriverCommand::SUBMIT_ELEMENT,
[':id' => $this->id]
);
return $this;
}
/**
* Get the opaque ID of the element.
*
* @return string The opaque ID.
*/
public function getID()
{
return $this->id;
}
/**
* Take a screenshot of a specific element.
*
* @param string $save_as The path of the screenshot to be saved.
* @return string The screenshot in PNG format.
*/
public function takeElementScreenshot($save_as = null)
{
$screenshot = base64_decode(
$this->executor->execute(
DriverCommand::TAKE_ELEMENT_SCREENSHOT,
[':id' => $this->id]
)
);
if ($save_as !== null) {
$directoryPath = dirname($save_as);
if (!file_exists($directoryPath)) {
mkdir($directoryPath, 0777, true);
}
file_put_contents($save_as, $screenshot);
}
return $screenshot;
}
/**
* Test if two elements IDs refer to the same DOM element.
*
* @param WebDriverElement $other
* @return bool
*/
public function equals(WebDriverElement $other)
{
if ($this->isW3cCompliant) {
return $this->getID() === $other->getID();
}
return $this->executor->execute(DriverCommand::ELEMENT_EQUALS, [
':id' => $this->id,
':other' => $other->getID(),
]);
}
/**
* Return the WebDriverElement with $id
*
* @param string $id
*
* @return static
*/
protected function newElement($id)
{
return new static($this->executor, $id, $this->isW3cCompliant);
}
/**
* Upload a local file to the server
*
* @param string $local_file
*
* @throws WebDriverException
* @return string The remote path of the file.
*/
protected function upload($local_file)
{
if (!is_file($local_file)) {
throw new WebDriverException('You may only upload files: ' . $local_file);
}
$temp_zip_path = $this->createTemporaryZipArchive($local_file);
$remote_path = $this->executor->execute(
DriverCommand::UPLOAD_FILE,
['file' => base64_encode(file_get_contents($temp_zip_path))]
);
unlink($temp_zip_path);
return $remote_path;
}
/**
* @param string $fileToZip
* @return string
*/
protected function createTemporaryZipArchive($fileToZip)
{
// Create a temporary file in the system temp directory.
// Intentionally do not use `tempnam()`, as it creates empty file which zip extension may not handle.
$tempZipPath = sys_get_temp_dir() . '/' . uniqid('WebDriverZip', false);
$zip = new ZipArchive();
if (($errorCode = $zip->open($tempZipPath, ZipArchive::CREATE)) !== true) {
throw new WebDriverException(sprintf('Error creating zip archive: %s', $errorCode));
}
$info = pathinfo($fileToZip);
$file_name = $info['basename'];
$zip->addFile($fileToZip, $file_name);
$zip->close();
return $tempZipPath;
}
}