123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236 |
- <?php
- // Copyright 2004-present Facebook. All Rights Reserved.
- //
- // 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.
- abstract class WebDriverBase {
- public static function throwException($status_code, $message, $results) {
- switch ($status_code) {
- case 0:
- // Success
- break;
- case 1:
- throw new IndexOutOfBoundsWebDriverError($message, $results);
- case 2:
- throw new NoCollectionWebDriverError($message, $results);
- case 3:
- throw new NoStringWebDriverError($message, $results);
- case 4:
- throw new NoStringLengthWebDriverError($message, $results);
- case 5:
- throw new NoStringWrapperWebDriverError($message, $results);
- case 6:
- throw new NoSuchDriverWebDriverError($message, $results);
- case 7:
- throw new NoSuchElementWebDriverError($message, $results);
- case 8:
- throw new NoSuchFrameWebDriverError($message, $results);
- case 9:
- throw new UnknownCommandWebDriverError($message, $results);
- case 10:
- throw new ObsoleteElementWebDriverError($message, $results);
- case 11:
- throw new ElementNotDisplayedWebDriverError($message, $results);
- case 12:
- throw new InvalidElementStateWebDriverError($message, $results);
- case 13:
- throw new UnhandledWebDriverError($message, $results);
- case 14:
- throw new ExpectedWebDriverError($message, $results);
- case 15:
- throw new ElementNotSelectableWebDriverError($message, $results);
- case 16:
- throw new NoSuchDocumentWebDriverError($message, $results);
- case 17:
- throw new UnexpectedJavascriptWebDriverError($message, $results);
- case 18:
- throw new NoScriptResultWebDriverError($message, $results);
- case 19:
- throw new XPathLookupWebDriverError($message, $results);
- case 20:
- throw new NoSuchCollectionWebDriverError($message, $results);
- case 21:
- throw new TimeOutWebDriverError($message, $results);
- case 22:
- throw new NullPointerWebDriverError($message, $results);
- case 23:
- throw new NoSuchWindowWebDriverError($message, $results);
- case 24:
- throw new InvalidCookieDomainWebDriverError($message, $results);
- case 25:
- throw new UnableToSetCookieWebDriverError($message, $results);
- case 26:
- throw new UnexpectedAlertOpenWebDriverError($message, $results);
- case 27:
- throw new NoAlertOpenWebDriverError($message, $results);
- case 28:
- throw new ScriptTimeoutWebDriverError($message, $results);
- case 29:
- throw new InvalidElementCoordinatesWebDriverError($message, $results);
- case 30:
- throw new IMENotAvailableWebDriverError($message, $results);
- case 31:
- throw new IMEEngineActivationFailedWebDriverError($message, $results);
- case 32:
- throw new InvalidSelectorWebDriverError($message, $results);
- }
- }
- abstract protected function methods();
- protected $url;
- public function __construct($url = 'http://localhost:4444/wd/hub') {
- $this->url = $url;
- }
- public function __toString() {
- return $this->url;
- }
- public function getURL() {
- return $this->url;
- }
- /**
- * Curl request to webdriver server.
- *
- * $http_method 'GET', 'POST', or 'DELETE'
- * $command If not defined in methods() this function will throw.
- * $params If an array(), they will be posted as JSON parameters
- * If a number or string, "/$params" is appended to url
- * $extra_opts key=>value pairs of curl options to pass to curl_setopt()
- */
- protected function curl(
- $http_method,
- $command,
- $params = null,
- $extra_opts = array()) {
- if ($params && is_array($params) && $http_method !== 'POST') {
- throw new Exception(sprintf(
- 'The http method called for %s is %s but it has to be POST' .
- ' if you want to pass the JSON params %s',
- $command,
- $http_method,
- json_encode($params)));
- }
- $url = sprintf('%s%s', $this->url, $command);
- if ($params && (is_int($params) || is_string($params))) {
- $url .= '/' . $params;
- }
- $curl = curl_init($url);
- curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
- curl_setopt(
- $curl,
- CURLOPT_HTTPHEADER,
- array(
- 'Content-Type: application/json;charset=UTF-8',
- 'Accept: application/json'));
- if ($http_method === 'POST') {
- curl_setopt($curl, CURLOPT_POST, true);
- if ($params && is_array($params)) {
- curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($params));
- }
- } else if ($http_method == 'DELETE') {
- curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
- }
- foreach ($extra_opts as $option => $value) {
- curl_setopt($curl, $option, $value);
- }
- $raw_results = trim(WebDriverEnvironment::CurlExec($curl));
- $info = curl_getinfo($curl);
- if ($error = curl_error($curl)) {
- $msg = sprintf(
- 'Curl error thrown for http %s to %s',
- $http_method,
- $url);
- if ($params && is_array($params)) {
- $msg .= sprintf(' with params: %s', json_encode($params));
- }
- throw new WebDriverCurlException($msg . "\n\n" . $error);
- }
- curl_close($curl);
- $results = json_decode($raw_results, true);
- $value = null;
- if (is_array($results) && array_key_exists('value', $results)) {
- $value = $results['value'];
- }
- $message = null;
- if (is_array($value) && array_key_exists('message', $value)) {
- $message = $value['message'];
- }
- self::throwException($results['status'], $message, $results);
- return array('value' => $value, 'info' => $info);
- }
- public function __call($name, $arguments) {
- if (count($arguments) > 1) {
- throw new Exception(
- 'Commands should have at most only one parameter,' .
- ' which should be the JSON Parameter object');
- }
- if (preg_match('/^(get|post|delete)/', $name, $matches)) {
- $http_method = strtoupper($matches[0]);
- $webdriver_command = strtolower(substr($name, strlen($http_method)));
- $default_http_method = $this->getHTTPMethod($webdriver_command);
- if ($http_method === $default_http_method) {
- throw new Exception(sprintf(
- '%s is the default http method for %s. Please just call %s().',
- $http_method,
- $webdriver_command,
- $webdriver_command));
- }
- $methods = $this->methods();
- if (!in_array($http_method, $methods[$webdriver_command])) {
- throw new Exception(sprintf(
- '%s is not an available http method for the command %s.',
- $http_method,
- $webdriver_command));
- }
- } else {
- $webdriver_command = $name;
- $http_method = $this->getHTTPMethod($webdriver_command);
- }
- $results = $this->curl(
- $http_method,
- '/' . $webdriver_command,
- array_shift($arguments));
- return $results['value'];
- }
- private function getHTTPMethod($webdriver_command) {
- if (!array_key_exists($webdriver_command, $this->methods())) {
- throw new Exception(sprintf(
- '%s is not a valid webdriver command.',
- $webdriver_command));
- }
- $methods = $this->methods();
- $http_methods = (array) $methods[$webdriver_command];
- return array_shift($http_methods);
- }
- }
|