X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=php%2Fphpxmlrpc%2Fsrc%2FClient.php;h=cd1491c327aef00fb80e8bb8a1fcd090327eccfe;hb=c379c0fff5edc592cc5d5d647c7fadb91317db87;hp=d31e9f5ef966e40cf7e6ae25b991fdb91a726b22;hpb=ae8b10f8363f7a1df02e77cbd820904c4ded10b8;p=plcapi.git diff --git a/php/phpxmlrpc/src/Client.php b/php/phpxmlrpc/src/Client.php index d31e9f5..cd1491c 100644 --- a/php/phpxmlrpc/src/Client.php +++ b/php/phpxmlrpc/src/Client.php @@ -3,12 +3,18 @@ namespace PhpXmlRpc; use PhpXmlRpc\Helper\Logger; - +use PhpXmlRpc\Helper\XMLParser; /** * Used to represent a client of an XML-RPC server. */ class Client { + const USE_CURL_NEVER = 0; + const USE_CURL_ALWAYS = 1; + const USE_CURL_AUTO = 2; + + protected static $logger; + /// @todo: do these need to be public? public $method = 'http'; public $server; @@ -41,6 +47,7 @@ class Client public $cookies = array(); public $extracurlopts = array(); + public $use_curl = self::USE_CURL_AUTO; /** * @var bool @@ -56,10 +63,9 @@ class Client * List of http compression methods accepted by the client for responses. * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib. * - * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since - * in those cases it will be up to CURL to decide the compression methods - * it supports. You might check for the presence of 'zlib' in the output of - * curl_version() to determine wheter compression is supported or not + * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since in those cases it will be up to CURL to + * decide the compression methods it supports. You might check for the presence of 'zlib' in the output of + * curl_version() to determine whether compression is supported or not */ public $accepted_compression = array(); @@ -67,11 +73,12 @@ class Client * Name of compression scheme to be used for sending requests. * Either null, gzip or deflate. */ - public $request_compression = ''; + /** * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see: * http://curl.haxx.se/docs/faq.html#7.3). + * @internal */ public $xmlrpc_curl_handle = null; @@ -83,10 +90,11 @@ class Client /** * The charset encoding that will be used for serializing request sent by the client. - * It defaults to NULL, which means using US-ASCII and encoding all characters outside of the ASCII range using - * their xml character entity representation (this has the benefit that line end characters will not be mangled in - * the transfer, a CR-LF will be preserved as well as a singe LF). - * Valid values are 'US-ASCII', 'UTF-8' and 'ISO-8859-1' + * It defaults to NULL, which means using US-ASCII and encoding all characters outside of the ASCII printable range + * using their xml character entity representation (this has the benefit that line end characters will not be mangled + * in the transfer, a CR-LF will be preserved as well as a singe LF). + * Valid values are 'US-ASCII', 'UTF-8' and 'ISO-8859-1'. + * For the fastest mode of operation, set your both your app internal encoding as well as this to UTF-8. */ public $request_charset_encoding = ''; @@ -103,13 +111,26 @@ class Client * response will be lost. It will be e.g. impossible to tell whether a particular php string value was sent by the * server as an xmlrpc string or base64 value. */ - public $return_type = 'xmlrpcvals'; + public $return_type = XMLParser::RETURN_XMLRPCVALS; /** * Sent to servers in http headers. */ public $user_agent; + public function getLogger() + { + if (self::$logger === null) { + self::$logger = Logger::instance(); + } + return self::$logger; + } + + public static function setLogger($logger) + { + self::$logger = $logger; + } + /** * @param string $path either the PATH part of the xmlrpc server URL, or complete server URL (in which case you * should use and empty string for all other parameters) @@ -125,7 +146,7 @@ class Client public function __construct($path, $server = '', $port = '', $method = '') { // allow user to specify all params in $path - if ($server == '' and $port == '' and $method == '') { + if ($server == '' && $port == '' && $method == '') { $parts = parse_url($path); $server = $parts['host']; $path = isset($parts['path']) ? $parts['path'] : ''; @@ -163,7 +184,7 @@ class Client // if ZLIB is enabled, let the client by default accept compressed responses if (function_exists('gzinflate') || ( - function_exists('curl_init') && (($info = curl_version()) && + function_exists('curl_version') && (($info = curl_version()) && ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version']))) ) ) { @@ -177,7 +198,7 @@ class Client $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII'); // Add all charsets which mbstring can handle, but remove junk not found in IANA registry at - // in http://www.iana.org/assignments/character-sets/character-sets.xhtml + // http://www.iana.org/assignments/character-sets/character-sets.xhtml // NB: this is disabled to avoid making all the requests sent huge... mbstring supports more than 80 charsets! /*if (function_exists('mb_list_encodings')) { @@ -201,7 +222,7 @@ class Client * This option can be very useful when debugging servers as it allows you to see exactly what the client sends and * the server returns. * - * @param integer $in values 0, 1 and 2 are supported (2 = echo sent msg too, before received response) + * @param integer $level values 0, 1 and 2 are supported (2 = echo sent msg too, before received response) */ public function setDebug($level) { @@ -304,7 +325,7 @@ class Client } /** - * Set attributes for SSL communication: SSL version to use. Best left at 0 (default value ): let cURL decide + * Set attributes for SSL communication: SSL version to use. Best left at 0 (default value): let cURL decide * * @param int $i */ @@ -390,7 +411,7 @@ class Client */ public function setCookie($name, $value = '', $path = '', $domain = '', $port = null) { - $this->cookies[$name]['value'] = urlencode($value); + $this->cookies[$name]['value'] = rawurlencode($value); if ($path || $domain || $port) { $this->cookies[$name]['path'] = $path; $this->cookies[$name]['domain'] = $domain; @@ -413,6 +434,15 @@ class Client $this->extracurlopts = $options; } + /** + * @param int $useCurlMode self::USE_CURL_ALWAYS, self::USE_CURL_AUTO or self::USE_CURL_NEVER + */ + public function setUseCurl($useCurlMode) + { + $this->use_curl = $useCurlMode; + } + + /** * Set user-agent string that will be used by this client instance in http headers sent to the server. * @@ -448,8 +478,8 @@ class Client * @param string $method valid values are 'http', 'http11' and 'https'. If left unspecified, the http protocol * chosen during creation of the object will be used. * - * * @return Response|Response[] Note that the client will always return a Response object, even if the call fails + * @todo allow throwing exceptions instead of returning responses in case of failed calls and/or Fault responses */ public function send($req, $timeout = 0, $method = '') { @@ -473,8 +503,13 @@ class Client // where req is a Request $req->setDebug($this->debug); - if ($method == 'https') { - $r = $this->sendPayloadHTTPS( + /// @todo we could be smarter about this and force usage of curl in scenarios where it is both available and + /// needed, such as digest or ntlm auth. Do not attempt to use it for https if not present + $useCurl = ($this->use_curl == self::USE_CURL_ALWAYS) || ($this->use_curl == self::USE_CURL_AUTO && + ($method == 'https' || $method == 'http11')); + + if ($useCurl) { + $r = $this->sendPayloadCURL( $req, $this->server, $this->port, @@ -491,34 +526,16 @@ class Client $this->proxy_user, $this->proxy_pass, $this->proxy_authtype, + // bc + $method == 'http11' ? 'http' : $method, $this->keepalive, $this->key, $this->keypass, $this->sslversion ); - } elseif ($method == 'http11') { - $r = $this->sendPayloadCURL( - $req, - $this->server, - $this->port, - $timeout, - $this->username, - $this->password, - $this->authtype, - null, - null, - null, - null, - $this->proxy, - $this->proxyport, - $this->proxy_user, - $this->proxy_pass, - $this->proxy_authtype, - 'http', - $this->keepalive - ); } else { - $r = $this->sendPayloadHTTP10( + // plain 'http 1.0': default to using socket + $r = $this->sendPayloadSocket( $req, $this->server, $this->port, @@ -526,12 +543,19 @@ class Client $this->username, $this->password, $this->authtype, + $this->cert, + $this->certpass, + $this->cacert, + $this->cacertdir, $this->proxy, $this->proxyport, $this->proxy_user, $this->proxy_pass, $this->proxy_authtype, - $method + $method, + $this->key, + $this->keypass, + $this->sslversion ); } @@ -539,6 +563,7 @@ class Client } /** + * @deprecated * @param Request $req * @param string $server * @param int $port @@ -557,18 +582,89 @@ class Client protected function sendPayloadHTTP10($req, $server, $port, $timeout = 0, $username = '', $password = '', $authType = 1, $proxyHost = '', $proxyPort = 0, $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1, $method='http') + { + //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED); + + return $this->sendPayloadSocket($req, $server, $port, $timeout, $username, $password, $authType, null, null, + null, null, $proxyHost, $proxyPort, $proxyUsername, $proxyPassword, $proxyAuthType, $method); + } + + /** + * @deprecated + * @param Request $req + * @param string $server + * @param int $port + * @param int $timeout + * @param string $username + * @param string $password + * @param int $authType + * @param string $cert + * @param string $certPass + * @param string $caCert + * @param string $caCertDir + * @param string $proxyHost + * @param int $proxyPort + * @param string $proxyUsername + * @param string $proxyPassword + * @param int $proxyAuthType + * @param bool $keepAlive + * @param string $key + * @param string $keyPass + * @param int $sslVersion + * @return Response + */ + protected function sendPayloadHTTPS($req, $server, $port, $timeout = 0, $username = '', $password = '', + $authType = 1, $cert = '', $certPass = '', $caCert = '', $caCertDir = '', $proxyHost = '', $proxyPort = 0, + $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1, $keepAlive = false, $key = '', $keyPass = '', + $sslVersion = 0) + { + //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED); + + return $this->sendPayloadCURL($req, $server, $port, $timeout, $username, + $password, $authType, $cert, $certPass, $caCert, $caCertDir, $proxyHost, $proxyPort, + $proxyUsername, $proxyPassword, $proxyAuthType, 'https', $keepAlive, $key, $keyPass, $sslVersion); + } + + /** + * @param Request $req + * @param string $server + * @param int $port + * @param int $timeout + * @param string $username + * @param string $password + * @param int $authType only value supported is 1 + * @param string $cert + * @param string $certPass + * @param string $caCert + * @param string $caCertDir + * @param string $proxyHost + * @param int $proxyPort + * @param string $proxyUsername + * @param string $proxyPassword + * @param int $proxyAuthType only value supported is 1 + * @param string $method 'http' (synonym for 'http10'), 'http10' or 'https' + * @param string $key + * @param string $keyPass @todo not implemented yet. + * @param int $sslVersion @todo not implemented yet. See http://php.net/manual/en/migration56.openssl.php + * @return Response + */ + protected function sendPayloadSocket($req, $server, $port, $timeout = 0, $username = '', $password = '', + $authType = 1, $cert = '', $certPass = '', $caCert = '', $caCertDir = '', $proxyHost = '', $proxyPort = 0, + $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1, $method='http', $key = '', $keyPass = '', + $sslVersion = 0) { if ($port == 0) { - $port = ( $method === "https" ) ? 443 : 80; + $port = ( $method === 'https' ) ? 443 : 80; } // Only create the payload if it was not created previously if (empty($req->payload)) { - $req->createPayload($this->request_charset_encoding); + $req->serialize($this->request_charset_encoding); } $payload = $req->payload; // Deflate request body and set appropriate request headers + $encodingHdr = ''; if (function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) { if ($this->request_compression == 'gzip') { $a = @gzencode($payload); @@ -583,8 +679,6 @@ class Client $encodingHdr = "Content-Encoding: deflate\r\n"; } } - } else { - $encodingHdr = ''; } // thanks to Grant Rauscher for this @@ -592,7 +686,7 @@ class Client if ($username != '') { $credentials = 'Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n"; if ($authType != 1) { - error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported with HTTP 1.0'); + $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported with HTTP 1.0'); } } @@ -608,24 +702,22 @@ class Client } $connectServer = $proxyHost; $connectPort = $proxyPort; - $transport = "tcp"; + $transport = 'tcp'; $uri = 'http://' . $server . ':' . $port . $this->path; if ($proxyUsername != '') { if ($proxyAuthType != 1) { - error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported with HTTP 1.0'); + $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported with HTTP 1.0'); } $proxyCredentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyUsername . ':' . $proxyPassword) . "\r\n"; } } else { $connectServer = $server; $connectPort = $port; - /// @todo if supporting https, we should support all its current options as well: peer name verification etc... - $transport = ( $method === "https" ) ? "tls" : "tcp"; + $transport = ( $method === 'https' ) ? 'tls' : 'tcp'; $uri = $this->path; } - // Cookie generation, as per rfc2965 (version 1 cookies) or - // netscape's rules (version 0 cookies) + // Cookie generation, as per rfc2965 (version 1 cookies) or netscape's rules (version 0 cookies) $cookieHeader = ''; if (count($this->cookies)) { $version = ''; @@ -649,8 +741,12 @@ class Client $cookieHeader = 'Cookie:' . $version . substr($cookieHeader, 0, -1) . "\r\n"; } - // omit port if 80 - $port = ($port == 80) ? '' : (':' . $port); + // omit port if default + if (($port == 80 && in_array($method, array('http', 'http10'))) || ($port == 443 && $method == 'https')) { + $port = ''; + } else { + $port = ':' . $port; + } $op = 'POST ' . $uri . " HTTP/1.0\r\n" . 'User-Agent: ' . $this->user_agent . "\r\n" . @@ -666,19 +762,53 @@ class Client $payload; if ($this->debug > 1) { - Logger::instance()->debugMessage("---SENDING---\n$op\n---END---"); + $this->getLogger()->debugMessage("---SENDING---\n$op\n---END---"); + } + + $contextOptions = array(); + if ($method == 'https') { + if ($cert != '') { + $contextOptions['ssl']['local_cert'] = $cert; + if ($certPass != '') { + $contextOptions['ssl']['passphrase'] = $certPass; + } + } + if ($caCert != '') { + $contextOptions['ssl']['cafile'] = $caCert; + } + if ($caCertDir != '') { + $contextOptions['ssl']['capath'] = $caCertDir; + } + if ($key != '') { + $contextOptions['ssl']['local_pk'] = $key; + } + $contextOptions['ssl']['verify_peer'] = $this->verifypeer; + $contextOptions['ssl']['verify_peer_name'] = $this->verifypeer; } - if ($timeout > 0) { - $fp = @stream_socket_client("$transport://$connectServer:$connectPort", $this->errno, $this->errstr, $timeout); + $context = stream_context_create($contextOptions); + + if ($timeout <= 0) { + $connectTimeout = ini_get('default_socket_timeout'); } else { - $fp = @stream_socket_client("$transport://$connectServer:$connectPort", $this->errno, $this->errstr); + $connectTimeout = $timeout; } + + $this->errno = 0; + $this->errstr = ''; + + $fp = @stream_socket_client("$transport://$connectServer:$connectPort", $this->errno, $this->errstr, $connectTimeout, + STREAM_CLIENT_CONNECT, $context); if ($fp) { if ($timeout > 0) { stream_set_timeout($fp, $timeout); } } else { + if ($this->errstr == '') { + $err = error_get_last(); + $this->errstr = $err['message']; + } + $this->errstr = 'Connect error: ' . $this->errstr; $r = new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], $this->errstr . ' (' . $this->errno . ')'); @@ -691,12 +821,10 @@ class Client $r = new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], $this->errstr); return $r; - } else { - // reset errno and errstr on successful socket connection - $this->errstr = ''; } - // G. Giunta 2005/10/24: close socket before parsing. - // should yield slightly better execution times, and make easier recursive calls (e.g. to follow http redirects) + + // Close socket before parsing. + // It should yield slightly better execution times, and make easier recursive calls (e.g. to follow http redirects) $ipd = ''; do { // shall we check for $data === FALSE? @@ -704,44 +832,12 @@ class Client $ipd .= fread($fp, 32768); } while (!feof($fp)); fclose($fp); + $r = $req->parseResponse($ipd, false, $this->return_type); return $r; } - /** - * @param Request $req - * @param string $server - * @param int $port - * @param int $timeout - * @param string $username - * @param string $password - * @param int $authType - * @param string $cert - * @param string $certPass - * @param string $caCert - * @param string $caCertDir - * @param string $proxyHost - * @param int $proxyPort - * @param string $proxyUsername - * @param string $proxyPassword - * @param int $proxyAuthType - * @param bool $keepAlive - * @param string $key - * @param string $keyPass - * @param int $sslVersion - * @return Response - */ - protected function sendPayloadHTTPS($req, $server, $port, $timeout = 0, $username = '', $password = '', - $authType = 1, $cert = '', $certPass = '', $caCert = '', $caCertDir = '', $proxyHost = '', $proxyPort = 0, - $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1, $keepAlive = false, $key = '', $keyPass = '', - $sslVersion = 0) - { - return $this->sendPayloadCURL($req, $server, $port, $timeout, $username, - $password, $authType, $cert, $certPass, $caCert, $caCertDir, $proxyHost, $proxyPort, - $proxyUsername, $proxyPassword, $proxyAuthType, 'https', $keepAlive, $key, $keyPass, $sslVersion); - } - /** * Contributed by Justin Miller * Requires curl to be built into PHP @@ -763,7 +859,7 @@ class Client * @param string $proxyUsername * @param string $proxyPassword * @param int $proxyAuthType - * @param string $method + * @param string $method 'http' (let curl decide), 'http10', 'http11' or 'https' * @param bool $keepAlive * @param string $key * @param string $keyPass @@ -789,7 +885,7 @@ class Client } if ($port == 0) { - if ($method == 'http') { + if (in_array($method, array('http', 'http10', 'http11'))) { $port = 80; } else { $port = 443; @@ -798,7 +894,7 @@ class Client // Only create the payload if it was not created previously if (empty($req->payload)) { - $req->createPayload($this->request_charset_encoding); + $req->serialize($this->request_charset_encoding); } // Deflate request body and set appropriate request headers @@ -822,11 +918,16 @@ class Client } if ($this->debug > 1) { - Logger::instance()->debugMessage("---SENDING---\n$payload\n---END---"); + $this->getLogger()->debugMessage("---SENDING---\n$payload\n---END---"); } if (!$keepAlive || !$this->xmlrpc_curl_handle) { - $curl = curl_init($method . '://' . $server . ':' . $port . $this->path); + if ($method == 'http11' || $method == 'http10') { + $protocol = 'http'; + } else { + $protocol = $method; + } + $curl = curl_init($protocol . '://' . $server . ':' . $port . $this->path); if ($keepAlive) { $this->xmlrpc_curl_handle = $curl; } @@ -851,8 +952,7 @@ class Client curl_setopt($curl, CURLOPT_HEADER, 1); // NB: if we set an empty string, CURL will add http header indicating - // ALL methods it is supporting. This is possibly a better option than - // letting the user tell what curl can / cannot do... + // ALL methods it is supporting. This is possibly a better option than letting the user tell what curl can / cannot do... if (is_array($this->accepted_compression) && count($this->accepted_compression)) { //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression)); // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?) @@ -873,18 +973,28 @@ class Client $headers[] = $encodingHdr; } + // Fix the HTTP/1.1 417 Expectation Failed Bug (curl by default adds a 'Expect: 100-continue' header when POST + // size exceeds 1025 bytes, apparently) + $headers[] = 'Expect:'; + curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); // timeout is borked if ($timeout) { curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1); } + if ($method == 'http10') { + curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0); + } elseif ($method == 'http11') { + curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1); + } + if ($username && $password) { curl_setopt($curl, CURLOPT_USERPWD, $username . ':' . $password); if (defined('CURLOPT_HTTPAUTH')) { curl_setopt($curl, CURLOPT_HTTPAUTH, $authType); } elseif ($authType != 1) { - error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported by the current PHP/curl install'); + $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported by the current PHP/curl install'); } } @@ -914,7 +1024,8 @@ class Client if ($keyPass) { curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keyPass); } - // whether to verify cert's common name (CN); 0 for no, 1 to verify that it exists, and 2 to verify that it matches the hostname used + // whether to verify cert's common name (CN); 0 for no, 1 to verify that it exists, and 2 to verify that + // it matches the hostname used curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost); // allow usage of different SSL versions curl_setopt($curl, CURLOPT_SSLVERSION, $sslVersion); @@ -931,14 +1042,13 @@ class Client if (defined('CURLOPT_PROXYAUTH')) { curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyAuthType); } elseif ($proxyAuthType != 1) { - error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported by the current PHP/curl install'); + $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported by the current PHP/curl install'); } } } // NB: should we build cookie http headers by hand rather than let CURL do it? - // the following code does not honour 'expires', 'path' and 'domain' cookie attributes - // set to client obj the the user... + // the following code does not honour 'expires', 'path' and 'domain' cookie attributes set to client obj the the user... if (count($this->cookies)) { $cookieHeader = ''; foreach ($this->cookies as $name => $cookie) { @@ -961,8 +1071,8 @@ class Client } $message .= $name . ': ' . $val . "\n"; } - $message .= "---END---"; - Logger::instance()->debugMessage($message); + $message .= '---END---'; + $this->getLogger()->debugMessage($message); } if (!$result) { @@ -1168,10 +1278,12 @@ class Client break; case 'struct': $code = $val['faultCode']; + /** @var Value $code */ if ($code->kindOf() != 'scalar' || $code->scalartyp() != 'int') { return false; } $str = $val['faultString']; + /** @var Value $str */ if ($str->kindOf() != 'scalar' || $str->scalartyp() != 'string') { return false; }