5 use PhpXmlRpc\Helper\Logger;
8 * Used to represent a client of an XML-RPC server.
12 const USE_CURL_NEVER = 0;
13 const USE_CURL_ALWAYS = 1;
14 const USE_CURL_AUTO = 2;
16 /// @todo: do these need to be public?
17 public $method = 'http';
26 public $username = '';
27 public $password = '';
31 public $certpass = '';
33 public $cacertdir = '';
36 public $verifypeer = true;
37 public $verifyhost = 2;
38 public $sslversion = 0; // corresponds to CURL_SSLVERSION_DEFAULT
41 public $proxyport = 0;
42 public $proxy_user = '';
43 public $proxy_pass = '';
44 public $proxy_authtype = 1;
46 public $cookies = array();
47 public $extracurlopts = array();
48 public $use_curl = self::USE_CURL_AUTO;
53 * This determines whether the multicall() method will try to take advantage of the system.multicall xmlrpc method
54 * to dispatch to the server an array of requests in a single http roundtrip or simply execute many consecutive http
55 * calls. Defaults to FALSE, but it will be enabled automatically on the first failure of execution of
58 public $no_multicall = false;
61 * List of http compression methods accepted by the client for responses.
62 * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib.
64 * 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
65 * decide the compression methods it supports. You might check for the presence of 'zlib' in the output of
66 * curl_version() to determine whether compression is supported or not
68 public $accepted_compression = array();
71 * Name of compression scheme to be used for sending requests.
72 * Either null, gzip or deflate.
74 public $request_compression = '';
77 * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see:
78 * http://curl.haxx.se/docs/faq.html#7.3).
81 public $xmlrpc_curl_handle = null;
83 /// Whether to use persistent connections for http 1.1 and https
84 public $keepalive = false;
86 /// Charset encodings that can be decoded without problems by the client
87 public $accepted_charset_encodings = array();
90 * The charset encoding that will be used for serializing request sent by the client.
91 * It defaults to NULL, which means using US-ASCII and encoding all characters outside of the ASCII range using
92 * their xml character entity representation (this has the benefit that line end characters will not be mangled in
93 * the transfer, a CR-LF will be preserved as well as a singe LF).
94 * Valid values are 'US-ASCII', 'UTF-8' and 'ISO-8859-1'
96 public $request_charset_encoding = '';
99 * Decides the content of Response objects returned by calls to send() and multicall().
100 * Valid values are 'xmlrpcvals', 'phpvals' or 'xml'.
102 * Determines whether the value returned inside an Response object as results of calls to the send() and multicall()
103 * methods will be a Value object, a plain php value or a raw xml string.
104 * Allowed values are 'xmlrpcvals' (the default), 'phpvals' and 'xml'.
105 * To allow the user to differentiate between a correct and a faulty response, fault responses will be returned as
106 * Response objects in any case.
107 * Note that the 'phpvals' setting will yield faster execution times, but some of the information from the original
108 * response will be lost. It will be e.g. impossible to tell whether a particular php string value was sent by the
109 * server as an xmlrpc string or base64 value.
111 public $return_type = 'xmlrpcvals';
114 * Sent to servers in http headers.
119 * @param string $path either the PATH part of the xmlrpc server URL, or complete server URL (in which case you
120 * should use and empty string for all other parameters)
121 * e.g. /xmlrpc/server.php
122 * e.g. http://phpxmlrpc.sourceforge.net/server.php
123 * e.g. https://james:bond@secret.service.com:443/xmlrpcserver?agent=007
124 * @param string $server the server name / ip address
125 * @param integer $port the port the server is listening on, when omitted defaults to 80 or 443 depending on
127 * @param string $method the http protocol variant: defaults to 'http'; 'https' and 'http11' can be used if CURL is
128 * installed. The value set here can be overridden in any call to $this->send().
130 public function __construct($path, $server = '', $port = '', $method = '')
132 // allow user to specify all params in $path
133 if ($server == '' && $port == '' && $method == '') {
134 $parts = parse_url($path);
135 $server = $parts['host'];
136 $path = isset($parts['path']) ? $parts['path'] : '';
137 if (isset($parts['query'])) {
138 $path .= '?' . $parts['query'];
140 if (isset($parts['fragment'])) {
141 $path .= '#' . $parts['fragment'];
143 if (isset($parts['port'])) {
144 $port = $parts['port'];
146 if (isset($parts['scheme'])) {
147 $method = $parts['scheme'];
149 if (isset($parts['user'])) {
150 $this->username = $parts['user'];
152 if (isset($parts['pass'])) {
153 $this->password = $parts['pass'];
156 if ($path == '' || $path[0] != '/') {
157 $this->path = '/' . $path;
161 $this->server = $server;
166 $this->method = $method;
169 // if ZLIB is enabled, let the client by default accept compressed responses
170 if (function_exists('gzinflate') || (
171 function_exists('curl_init') && (($info = curl_version()) &&
172 ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version'])))
175 $this->accepted_compression = array('gzip', 'deflate');
178 // keepalives: enabled by default
179 $this->keepalive = true;
181 // by default the xml parser can support these 3 charset encodings
182 $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');
184 // Add all charsets which mbstring can handle, but remove junk not found in IANA registry at
185 // http://www.iana.org/assignments/character-sets/character-sets.xhtml
186 // NB: this is disabled to avoid making all the requests sent huge... mbstring supports more than 80 charsets!
187 /*if (function_exists('mb_list_encodings')) {
189 $encodings = array_diff(mb_list_encodings(), array('pass', 'auto', 'wchar', 'BASE64', 'UUENCODE', 'ASCII',
190 'HTML-ENTITIES', 'Quoted-Printable', '7bit','8bit', 'byte2be', 'byte2le', 'byte4be', 'byte4le'));
191 $this->accepted_charset_encodings = array_unique(array_merge($this->accepted_charset_encodings, $encodings));
194 // initialize user_agent string
195 $this->user_agent = PhpXmlRpc::$xmlrpcName . ' ' . PhpXmlRpc::$xmlrpcVersion;
199 * Enable/disable the echoing to screen of the xmlrpc responses received. The default is not no output anything.
201 * The debugging information at level 1 includes the raw data returned from the XML-RPC server it was querying
202 * (including bot HTTP headers and the full XML payload), and the PHP value the client attempts to create to
203 * represent the value returned by the server
204 * At level2, the complete payload of the xmlrpc request is also printed, before being sent t the server.
206 * This option can be very useful when debugging servers as it allows you to see exactly what the client sends and
207 * the server returns.
209 * @param integer $level values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)
211 public function setDebug($level)
213 $this->debug = $level;
217 * Sets the username and password for authorizing the client to the server.
219 * With the default (HTTP) transport, this information is used for HTTP Basic authorization.
220 * Note that username and password can also be set using the class constructor.
221 * With HTTP 1.1 and HTTPS transport, NTLM and Digest authentication protocols are also supported. To enable them use
222 * the constants CURLAUTH_DIGEST and CURLAUTH_NTLM as values for the auth type parameter.
224 * @param string $user username
225 * @param string $password password
226 * @param integer $authType auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC
227 * (basic auth). Note that auth types NTLM and Digest will only work if the Curl php
228 * extension is enabled.
230 public function setCredentials($user, $password, $authType = 1)
232 $this->username = $user;
233 $this->password = $password;
234 $this->authtype = $authType;
238 * Set the optional certificate and passphrase used in SSL-enabled communication with a remote server.
240 * Note: to retrieve information about the client certificate on the server side, you will need to look into the
241 * environment variables which are set up by the webserver. Different webservers will typically set up different
244 * @param string $cert the name of a file containing a PEM formatted certificate
245 * @param string $certPass the password required to use it
247 public function setCertificate($cert, $certPass = '')
250 $this->certpass = $certPass;
254 * Add a CA certificate to verify server with in SSL-enabled communication when SetSSLVerifypeer has been set to TRUE.
256 * See the php manual page about CURLOPT_CAINFO for more details.
258 * @param string $caCert certificate file name (or dir holding certificates)
259 * @param bool $isDir set to true to indicate cacert is a dir. defaults to false
261 public function setCaCertificate($caCert, $isDir = false)
264 $this->cacertdir = $caCert;
266 $this->cacert = $caCert;
271 * Set attributes for SSL communication: private SSL key.
273 * NB: does not work in older php/curl installs.
274 * Thanks to Daniel Convissor.
276 * @param string $key The name of a file containing a private SSL key
277 * @param string $keyPass The secret password needed to use the private SSL key
279 public function setKey($key, $keyPass)
282 $this->keypass = $keyPass;
286 * Set attributes for SSL communication: verify the remote host's SSL certificate, and cause the connection to fail
287 * if the cert verification fails.
289 * By default, verification is enabled.
290 * To specify custom SSL certificates to validate the server with, use the setCaCertificate method.
292 * @param bool $i enable/disable verification of peer certificate
294 public function setSSLVerifyPeer($i)
296 $this->verifypeer = $i;
300 * Set attributes for SSL communication: verify the remote host's SSL certificate's common name (CN).
302 * Note that support for value 1 has been removed in cURL 7.28.1
304 * @param int $i Set to 1 to only the existence of a CN, not that it matches
306 public function setSSLVerifyHost($i)
308 $this->verifyhost = $i;
312 * Set attributes for SSL communication: SSL version to use. Best left at 0 (default value ): let cURL decide
316 public function setSSLVersion($i)
318 $this->sslversion = $i;
324 * NB: CURL versions before 7.11.10 cannot use a proxy to communicate with https servers.
326 * @param string $proxyHost
327 * @param string $proxyPort Defaults to 8080 for HTTP and 443 for HTTPS
328 * @param string $proxyUsername Leave blank if proxy has public access
329 * @param string $proxyPassword Leave blank if proxy has public access
330 * @param int $proxyAuthType defaults to CURLAUTH_BASIC (Basic authentication protocol); set to constant CURLAUTH_NTLM
331 * to use NTLM auth with proxy (has effect only when the client uses the HTTP 1.1 protocol)
333 public function setProxy($proxyHost, $proxyPort, $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1)
335 $this->proxy = $proxyHost;
336 $this->proxyport = $proxyPort;
337 $this->proxy_user = $proxyUsername;
338 $this->proxy_pass = $proxyPassword;
339 $this->proxy_authtype = $proxyAuthType;
343 * Enables/disables reception of compressed xmlrpc responses.
345 * This requires the "zlib" extension to be enabled in your php install. If it is, by default xmlrpc_client
346 * instances will enable reception of compressed content.
347 * Note that enabling reception of compressed responses merely adds some standard http headers to xmlrpc requests.
348 * It is up to the xmlrpc server to return compressed responses when receiving such requests.
350 * @param string $compMethod either 'gzip', 'deflate', 'any' or ''
352 public function setAcceptedCompression($compMethod)
354 if ($compMethod == 'any') {
355 $this->accepted_compression = array('gzip', 'deflate');
356 } elseif ($compMethod == false) {
357 $this->accepted_compression = array();
359 $this->accepted_compression = array($compMethod);
364 * Enables/disables http compression of xmlrpc request.
366 * This requires the "zlib" extension to be enabled in your php install.
367 * Take care when sending compressed requests: servers might not support them (and automatic fallback to
368 * uncompressed requests is not yet implemented).
370 * @param string $compMethod either 'gzip', 'deflate' or ''
372 public function setRequestCompression($compMethod)
374 $this->request_compression = $compMethod;
378 * Adds a cookie to list of cookies that will be sent to server with every further request (useful e.g. for keeping
379 * session info outside of the xml-rpc payload).
381 * NB: By default cookies are sent using the 'original/netscape' format, which is also the same as the RFC 2965;
382 * setting any param but name and value will turn the cookie into a 'version 1' cookie (i.e. RFC 2109 cookie) that
383 * might not be fully supported by the server. Note that RFC 2109 has currently 'historic' status...
385 * @param string $name nb: will not be escaped in the request's http headers. Take care not to use CTL chars or
387 * @param string $value
388 * @param string $path leave this empty unless the xml-rpc server only accepts RFC 2109 cookies
389 * @param string $domain leave this empty unless the xml-rpc server only accepts RFC 2109 cookies
390 * @param int $port leave this empty unless the xml-rpc server only accepts RFC 2109 cookies
392 * @todo check correctness of urlencoding cookie value (copied from php way of doing it, but php is generally sending
393 * response not requests. We do the opposite...)
394 * @todo strip invalid chars from cookie name? As per RFC6265, we should follow RFC2616, Section 2.2
396 public function setCookie($name, $value = '', $path = '', $domain = '', $port = null)
398 $this->cookies[$name]['value'] = rawurlencode($value);
399 if ($path || $domain || $port) {
400 $this->cookies[$name]['path'] = $path;
401 $this->cookies[$name]['domain'] = $domain;
402 $this->cookies[$name]['port'] = $port;
403 $this->cookies[$name]['version'] = 1;
405 $this->cookies[$name]['version'] = 0;
410 * Directly set cURL options, for extra flexibility (when in cURL mode).
412 * It allows eg. to bind client to a specific IP interface / address.
414 * @param array $options
416 public function setCurlOptions($options)
418 $this->extracurlopts = $options;
422 * @param int $useCurlMode self::USE_CURL_ALWAYS, self::USE_CURL_AUTO or self::USE_CURL_NEVER
424 public function setUseCurl($useCurlMode)
426 $this->use_curl = $useCurlMode;
431 * Set user-agent string that will be used by this client instance in http headers sent to the server.
433 * The default user agent string includes the name of this library and the version number.
435 * @param string $agentString
437 public function setUserAgent($agentString)
439 $this->user_agent = $agentString;
443 * Send an xmlrpc request to the server.
445 * @param Request|Request[]|string $req The Request object, or an array of requests for using multicall, or the
446 * complete xml representation of a request.
447 * When sending an array of Request objects, the client will try to make use of
448 * a single 'system.multicall' xml-rpc method call to forward to the server all
449 * the requests in a single HTTP round trip, unless $this->no_multicall has
450 * been previously set to TRUE (see the multicall method below), in which case
451 * many consecutive xmlrpc requests will be sent. The method will return an
452 * array of Response objects in both cases.
453 * The third variant allows to build by hand (or any other means) a complete
454 * xmlrpc request message, and send it to the server. $req should be a string
455 * containing the complete xml representation of the request. It is e.g. useful
456 * when, for maximal speed of execution, the request is serialized into a
457 * string using the native php xmlrpc functions (see http://www.php.net/xmlrpc)
458 * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply.
459 * This timeout value is passed to fsockopen(). It is also used for detecting server
460 * timeouts during communication (i.e. if the server does not send anything to the client
461 * for $timeout seconds, the connection will be closed).
462 * @param string $method valid values are 'http', 'http11' and 'https'. If left unspecified, the http protocol
463 * chosen during creation of the object will be used.
465 * @return Response|Response[] Note that the client will always return a Response object, even if the call fails
467 public function send($req, $timeout = 0, $method = '')
469 // if user does not specify http protocol, use native method of this client
470 // (i.e. method set during call to constructor)
472 $method = $this->method;
475 if (is_array($req)) {
476 // $req is an array of Requests
477 $r = $this->multicall($req, $timeout, $method);
480 } elseif (is_string($req)) {
481 $n = new Request('');
486 // where req is a Request
487 $req->setDebug($this->debug);
489 /// @todo we could be smarter about this and force usage of curl in scenarios where it is both available and
490 /// needed, such as digest or ntlm auth. Do not attempt to use it for https if not present
491 $useCurl = ($this->use_curl == self::USE_CURL_ALWAYS) || ($this->use_curl == self::USE_CURL_AUTO &&
492 ($method == 'https' || $method == 'http11'));
495 $r = $this->sendPayloadCURL(
511 $this->proxy_authtype,
513 $method == 'http11' ? 'http' : $method,
520 // plain 'http 1.0': default to using socket
521 $r = $this->sendPayloadSocket(
537 $this->proxy_authtype,
550 * @param Request $req
551 * @param string $server
553 * @param int $timeout
554 * @param string $username
555 * @param string $password
556 * @param int $authType
557 * @param string $proxyHost
558 * @param int $proxyPort
559 * @param string $proxyUsername
560 * @param string $proxyPassword
561 * @param int $proxyAuthType
562 * @param string $method
565 protected function sendPayloadHTTP10($req, $server, $port, $timeout = 0, $username = '', $password = '',
566 $authType = 1, $proxyHost = '', $proxyPort = 0, $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1,
569 //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
571 return $this->sendPayloadSocket($req, $server, $port, $timeout, $username, $password, $authType, null, null,
572 null, null, $proxyHost, $proxyPort, $proxyUsername, $proxyPassword, $proxyAuthType, $method);
577 * @param Request $req
578 * @param string $server
580 * @param int $timeout
581 * @param string $username
582 * @param string $password
583 * @param int $authType
584 * @param string $cert
585 * @param string $certPass
586 * @param string $caCert
587 * @param string $caCertDir
588 * @param string $proxyHost
589 * @param int $proxyPort
590 * @param string $proxyUsername
591 * @param string $proxyPassword
592 * @param int $proxyAuthType
593 * @param bool $keepAlive
595 * @param string $keyPass
596 * @param int $sslVersion
599 protected function sendPayloadHTTPS($req, $server, $port, $timeout = 0, $username = '', $password = '',
600 $authType = 1, $cert = '', $certPass = '', $caCert = '', $caCertDir = '', $proxyHost = '', $proxyPort = 0,
601 $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1, $keepAlive = false, $key = '', $keyPass = '',
604 //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
606 return $this->sendPayloadCURL($req, $server, $port, $timeout, $username,
607 $password, $authType, $cert, $certPass, $caCert, $caCertDir, $proxyHost, $proxyPort,
608 $proxyUsername, $proxyPassword, $proxyAuthType, 'https', $keepAlive, $key, $keyPass, $sslVersion);
612 * @param Request $req
613 * @param string $server
615 * @param int $timeout
616 * @param string $username
617 * @param string $password
618 * @param int $authType only value supported is 1
619 * @param string $cert
620 * @param string $certPass
621 * @param string $caCert
622 * @param string $caCertDir
623 * @param string $proxyHost
624 * @param int $proxyPort
625 * @param string $proxyUsername
626 * @param string $proxyPassword
627 * @param int $proxyAuthType only value supported is 1
628 * @param string $method 'http' (synonym for 'http10'), 'http10' or 'https'
630 * @param string $keyPass @todo not implemented yet.
631 * @param int $sslVersion @todo not implemented yet. See http://php.net/manual/en/migration56.openssl.php
634 protected function sendPayloadSocket($req, $server, $port, $timeout = 0, $username = '', $password = '',
635 $authType = 1, $cert = '', $certPass = '', $caCert = '', $caCertDir = '', $proxyHost = '', $proxyPort = 0,
636 $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1, $method='http', $key = '', $keyPass = '',
640 $port = ( $method === 'https' ) ? 443 : 80;
643 // Only create the payload if it was not created previously
644 if (empty($req->payload)) {
645 $req->createPayload($this->request_charset_encoding);
648 $payload = $req->payload;
649 // Deflate request body and set appropriate request headers
651 if (function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) {
652 if ($this->request_compression == 'gzip') {
653 $a = @gzencode($payload);
656 $encodingHdr = "Content-Encoding: gzip\r\n";
659 $a = @gzcompress($payload);
662 $encodingHdr = "Content-Encoding: deflate\r\n";
667 // thanks to Grant Rauscher <grant7@firstworld.net> for this
669 if ($username != '') {
670 $credentials = 'Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";
671 if ($authType != 1) {
672 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported with HTTP 1.0');
676 $acceptedEncoding = '';
677 if (is_array($this->accepted_compression) && count($this->accepted_compression)) {
678 $acceptedEncoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n";
681 $proxyCredentials = '';
683 if ($proxyPort == 0) {
686 $connectServer = $proxyHost;
687 $connectPort = $proxyPort;
689 $uri = 'http://' . $server . ':' . $port . $this->path;
690 if ($proxyUsername != '') {
691 if ($proxyAuthType != 1) {
692 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported with HTTP 1.0');
694 $proxyCredentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyUsername . ':' . $proxyPassword) . "\r\n";
697 $connectServer = $server;
698 $connectPort = $port;
699 $transport = ( $method === 'https' ) ? 'tls' : 'tcp';
703 // Cookie generation, as per rfc2965 (version 1 cookies) or netscape's rules (version 0 cookies)
705 if (count($this->cookies)) {
707 foreach ($this->cookies as $name => $cookie) {
708 if ($cookie['version']) {
709 $version = ' $Version="' . $cookie['version'] . '";';
710 $cookieHeader .= ' ' . $name . '="' . $cookie['value'] . '";';
711 if ($cookie['path']) {
712 $cookieHeader .= ' $Path="' . $cookie['path'] . '";';
714 if ($cookie['domain']) {
715 $cookieHeader .= ' $Domain="' . $cookie['domain'] . '";';
717 if ($cookie['port']) {
718 $cookieHeader .= ' $Port="' . $cookie['port'] . '";';
721 $cookieHeader .= ' ' . $name . '=' . $cookie['value'] . ";";
724 $cookieHeader = 'Cookie:' . $version . substr($cookieHeader, 0, -1) . "\r\n";
727 // omit port if default
728 if (($port == 80 && in_array($method, array('http', 'http10'))) || ($port == 443 && $method == 'https')) {
734 $op = 'POST ' . $uri . " HTTP/1.0\r\n" .
735 'User-Agent: ' . $this->user_agent . "\r\n" .
736 'Host: ' . $server . $port . "\r\n" .
741 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" .
743 'Content-Type: ' . $req->content_type . "\r\nContent-Length: " .
744 strlen($payload) . "\r\n\r\n" .
747 if ($this->debug > 1) {
748 Logger::instance()->debugMessage("---SENDING---\n$op\n---END---");
751 $contextOptions = array();
752 if ($method == 'https') {
754 $contextOptions['ssl']['local_cert'] = $cert;
755 if ($certPass != '') {
756 $contextOptions['ssl']['passphrase'] = $certPass;
760 $contextOptions['ssl']['cafile'] = $caCert;
762 if ($caCertDir != '') {
763 $contextOptions['ssl']['capath'] = $caCertDir;
766 $contextOptions['ssl']['local_pk'] = $key;
768 $contextOptions['ssl']['verify_peer'] = $this->verifypeer;
769 $contextOptions['ssl']['verify_peer_name'] = $this->verifypeer;
771 $context = stream_context_create($contextOptions);
774 $connectTimeout = ini_get('default_socket_timeout');
776 $connectTimeout = $timeout;
782 $fp = @stream_socket_client("$transport://$connectServer:$connectPort", $this->errno, $this->errstr, $connectTimeout,
783 STREAM_CLIENT_CONNECT, $context);
786 stream_set_timeout($fp, $timeout);
789 if ($this->errstr == '') {
790 $err = error_get_last();
791 $this->errstr = $err['message'];
793 $this->errstr = 'Connect error: ' . $this->errstr;
794 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], $this->errstr . ' (' . $this->errno . ')');
799 if (!fputs($fp, $op, strlen($op))) {
801 $this->errstr = 'Write error';
802 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], $this->errstr);
807 // Close socket before parsing.
808 // It should yield slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)
811 // shall we check for $data === FALSE?
812 // as per the manual, it signals an error
813 $ipd .= fread($fp, 32768);
814 } while (!feof($fp));
817 $r = $req->parseResponse($ipd, false, $this->return_type);
823 * Contributed by Justin Miller <justin@voxel.net>
824 * Requires curl to be built into PHP
825 * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!
827 * @param Request $req
828 * @param string $server
830 * @param int $timeout
831 * @param string $username
832 * @param string $password
833 * @param int $authType
834 * @param string $cert
835 * @param string $certPass
836 * @param string $caCert
837 * @param string $caCertDir
838 * @param string $proxyHost
839 * @param int $proxyPort
840 * @param string $proxyUsername
841 * @param string $proxyPassword
842 * @param int $proxyAuthType
843 * @param string $method 'http' (let curl decide), 'http10', 'http11' or 'https'
844 * @param bool $keepAlive
846 * @param string $keyPass
847 * @param int $sslVersion
850 protected function sendPayloadCURL($req, $server, $port, $timeout = 0, $username = '', $password = '',
851 $authType = 1, $cert = '', $certPass = '', $caCert = '', $caCertDir = '', $proxyHost = '', $proxyPort = 0,
852 $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1, $method = 'https', $keepAlive = false, $key = '',
853 $keyPass = '', $sslVersion = 0)
855 if (!function_exists('curl_init')) {
856 $this->errstr = 'CURL unavailable on this install';
857 return new Response(0, PhpXmlRpc::$xmlrpcerr['no_curl'], PhpXmlRpc::$xmlrpcstr['no_curl']);
859 if ($method == 'https') {
860 if (($info = curl_version()) &&
861 ((is_string($info) && strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version'])))
863 $this->errstr = 'SSL unavailable on this install';
864 return new Response(0, PhpXmlRpc::$xmlrpcerr['no_ssl'], PhpXmlRpc::$xmlrpcstr['no_ssl']);
869 if (in_array($method, array('http', 'http10', 'http11'))) {
876 // Only create the payload if it was not created previously
877 if (empty($req->payload)) {
878 $req->createPayload($this->request_charset_encoding);
881 // Deflate request body and set appropriate request headers
882 $payload = $req->payload;
883 if (function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) {
884 if ($this->request_compression == 'gzip') {
885 $a = @gzencode($payload);
888 $encodingHdr = 'Content-Encoding: gzip';
891 $a = @gzcompress($payload);
894 $encodingHdr = 'Content-Encoding: deflate';
901 if ($this->debug > 1) {
902 Logger::instance()->debugMessage("---SENDING---\n$payload\n---END---");
905 if (!$keepAlive || !$this->xmlrpc_curl_handle) {
906 if ($method == 'http11' || $method == 'http10') {
911 $curl = curl_init($protocol . '://' . $server . ':' . $port . $this->path);
913 $this->xmlrpc_curl_handle = $curl;
916 $curl = $this->xmlrpc_curl_handle;
919 // results into variable
920 curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
922 if ($this->debug > 1) {
923 curl_setopt($curl, CURLOPT_VERBOSE, true);
924 /// @todo allow callers to redirect curlopt_stderr to some stream which can be buffered
926 curl_setopt($curl, CURLOPT_USERAGENT, $this->user_agent);
927 // required for XMLRPC: post the data
928 curl_setopt($curl, CURLOPT_POST, 1);
930 curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);
932 // return the header too
933 curl_setopt($curl, CURLOPT_HEADER, 1);
935 // NB: if we set an empty string, CURL will add http header indicating
936 // ALL methods it is supporting. This is possibly a better option than letting the user tell what curl can / cannot do...
937 if (is_array($this->accepted_compression) && count($this->accepted_compression)) {
938 //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression));
939 // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
940 if (count($this->accepted_compression) == 1) {
941 curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]);
943 curl_setopt($curl, CURLOPT_ENCODING, '');
947 $headers = array('Content-Type: ' . $req->content_type, 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings));
948 // if no keepalive is wanted, let the server know it in advance
950 $headers[] = 'Connection: close';
952 // request compression header
954 $headers[] = $encodingHdr;
957 // Fix the HTTP/1.1 417 Expectation Failed Bug (curl by default adds a 'Expect: 100-continue' header when POST
958 // size exceeds 1025 bytes, apparently)
959 $headers[] = 'Expect:';
961 curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
964 curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1);
967 if ($method == 'http10') {
968 curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);
969 } elseif ($method == 'http11') {
970 curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
973 if ($username && $password) {
974 curl_setopt($curl, CURLOPT_USERPWD, $username . ':' . $password);
975 if (defined('CURLOPT_HTTPAUTH')) {
976 curl_setopt($curl, CURLOPT_HTTPAUTH, $authType);
977 } elseif ($authType != 1) {
978 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported by the current PHP/curl install');
982 if ($method == 'https') {
985 curl_setopt($curl, CURLOPT_SSLCERT, $cert);
989 curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certPass);
991 // whether to verify remote host's cert
992 curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer);
993 // set ca certificates file/dir
995 curl_setopt($curl, CURLOPT_CAINFO, $caCert);
998 curl_setopt($curl, CURLOPT_CAPATH, $caCertDir);
1000 // set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
1002 curl_setopt($curl, CURLOPT_SSLKEY, $key);
1004 // set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
1006 curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keyPass);
1008 // whether to verify cert's common name (CN); 0 for no, 1 to verify that it exists, and 2 to verify that
1009 // it matches the hostname used
1010 curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost);
1011 // allow usage of different SSL versions
1012 curl_setopt($curl, CURLOPT_SSLVERSION, $sslVersion);
1017 if ($proxyPort == 0) {
1018 $proxyPort = 8080; // NB: even for HTTPS, local connection is on port 8080
1020 curl_setopt($curl, CURLOPT_PROXY, $proxyHost . ':' . $proxyPort);
1021 if ($proxyUsername) {
1022 curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyUsername . ':' . $proxyPassword);
1023 if (defined('CURLOPT_PROXYAUTH')) {
1024 curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyAuthType);
1025 } elseif ($proxyAuthType != 1) {
1026 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported by the current PHP/curl install');
1031 // NB: should we build cookie http headers by hand rather than let CURL do it?
1032 // the following code does not honour 'expires', 'path' and 'domain' cookie attributes set to client obj the the user...
1033 if (count($this->cookies)) {
1035 foreach ($this->cookies as $name => $cookie) {
1036 $cookieHeader .= $name . '=' . $cookie['value'] . '; ';
1038 curl_setopt($curl, CURLOPT_COOKIE, substr($cookieHeader, 0, -2));
1041 foreach ($this->extracurlopts as $opt => $val) {
1042 curl_setopt($curl, $opt, $val);
1045 $result = curl_exec($curl);
1047 if ($this->debug > 1) {
1048 $message = "---CURL INFO---\n";
1049 foreach (curl_getinfo($curl) as $name => $val) {
1050 if (is_array($val)) {
1051 $val = implode("\n", $val);
1053 $message .= $name . ': ' . $val . "\n";
1055 $message .= '---END---';
1056 Logger::instance()->debugMessage($message);
1060 /// @todo we should use a better check here - what if we get back '' or '0'?
1062 $this->errstr = 'no response';
1063 $resp = new Response(0, PhpXmlRpc::$xmlrpcerr['curl_fail'], PhpXmlRpc::$xmlrpcstr['curl_fail'] . ': ' . curl_error($curl));
1066 $this->xmlrpc_curl_handle = null;
1072 $resp = $req->parseResponse($result, true, $this->return_type);
1073 // if we got back a 302, we can not reuse the curl handle for later calls
1074 if ($resp->faultCode() == PhpXmlRpc::$xmlrpcerr['http_error'] && $keepAlive) {
1076 $this->xmlrpc_curl_handle = null;
1084 * Send an array of requests and return an array of responses.
1086 * Unless $this->no_multicall has been set to true, it will try first to use one single xmlrpc call to server method
1087 * system.multicall, and revert to sending many successive calls in case of failure.
1088 * This failure is also stored in $this->no_multicall for subsequent calls.
1089 * Unfortunately, there is no server error code universally used to denote the fact that multicall is unsupported,
1090 * so there is no way to reliably distinguish between that and a temporary failure.
1091 * If you are sure that server supports multicall and do not want to fallback to using many single calls, set the
1092 * fourth parameter to FALSE.
1094 * NB: trying to shoehorn extra functionality into existing syntax has resulted
1095 * in pretty much convoluted code...
1097 * @param Request[] $reqs an array of Request objects
1098 * @param integer $timeout connection timeout (in seconds). See the details in the docs for the send() method
1099 * @param string $method the http protocol variant to be used. See the details in the docs for the send() method
1100 * @param boolean fallback When true, upon receiving an error during multicall, multiple single calls will be
1103 * @return Response[]
1105 public function multicall($reqs, $timeout = 0, $method = '', $fallback = true)
1107 if ($method == '') {
1108 $method = $this->method;
1110 if (!$this->no_multicall) {
1111 $results = $this->_try_multicall($reqs, $timeout, $method);
1112 if (is_array($results)) {
1113 // System.multicall succeeded
1116 // either system.multicall is unsupported by server,
1117 // or call failed for some other reason.
1119 // Don't try it next time...
1120 $this->no_multicall = true;
1122 if (is_a($results, '\PhpXmlRpc\Response')) {
1125 $result = new Response(0, PhpXmlRpc::$xmlrpcerr['multicall_error'], PhpXmlRpc::$xmlrpcstr['multicall_error']);
1130 // override fallback, in case careless user tries to do two
1131 // opposite things at the same time
1137 // system.multicall is (probably) unsupported by server:
1138 // emulate multicall via multiple requests
1139 foreach ($reqs as $req) {
1140 $results[] = $this->send($req, $timeout, $method);
1143 // user does NOT want to fallback on many single calls:
1144 // since we should always return an array of responses,
1145 // return an array with the same error repeated n times
1146 foreach ($reqs as $req) {
1147 $results[] = $result;
1155 * Attempt to boxcar $reqs via system.multicall.
1157 * Returns either an array of Response, a single error Response or false (when received response does not respect
1158 * valid multicall syntax).
1160 * @param Request[] $reqs
1161 * @param int $timeout
1162 * @param string $method
1163 * @return Response[]|bool|mixed|Response
1165 private function _try_multicall($reqs, $timeout, $method)
1167 // Construct multicall request
1169 foreach ($reqs as $req) {
1170 $call['methodName'] = new Value($req->method(), 'string');
1171 $numParams = $req->getNumParams();
1173 for ($i = 0; $i < $numParams; $i++) {
1174 $params[$i] = $req->getParam($i);
1176 $call['params'] = new Value($params, 'array');
1177 $calls[] = new Value($call, 'struct');
1179 $multiCall = new Request('system.multicall');
1180 $multiCall->addParam(new Value($calls, 'array'));
1183 $result = $this->send($multiCall, $timeout, $method);
1185 if ($result->faultCode() != 0) {
1186 // call to system.multicall failed
1190 // Unpack responses.
1191 $rets = $result->value();
1193 if ($this->return_type == 'xml') {
1195 } elseif ($this->return_type == 'phpvals') {
1196 /// @todo test this code branch...
1197 $rets = $result->value();
1198 if (!is_array($rets)) {
1199 return false; // bad return type from system.multicall
1201 $numRets = count($rets);
1202 if ($numRets != count($reqs)) {
1203 return false; // wrong number of return values.
1206 $response = array();
1207 for ($i = 0; $i < $numRets; $i++) {
1209 if (!is_array($val)) {
1212 switch (count($val)) {
1214 if (!isset($val[0])) {
1215 return false; // Bad value
1217 // Normal return value
1218 $response[$i] = new Response($val[0], 0, '', 'phpvals');
1221 /// @todo remove usage of @: it is apparently quite slow
1222 $code = @$val['faultCode'];
1223 if (!is_int($code)) {
1226 $str = @$val['faultString'];
1227 if (!is_string($str)) {
1230 $response[$i] = new Response(0, $code, $str);
1239 // return type == 'xmlrpcvals'
1241 $rets = $result->value();
1242 if ($rets->kindOf() != 'array') {
1243 return false; // bad return type from system.multicall
1245 $numRets = $rets->count();
1246 if ($numRets != count($reqs)) {
1247 return false; // wrong number of return values.
1250 $response = array();
1251 foreach($rets as $val) {
1252 switch ($val->kindOf()) {
1254 if ($val->count() != 1) {
1255 return false; // Bad value
1257 // Normal return value
1258 $response[] = new Response($val[0]);
1261 $code = $val['faultCode'];
1262 /** @var Value $code */
1263 if ($code->kindOf() != 'scalar' || $code->scalartyp() != 'int') {
1266 $str = $val['faultString'];
1267 /** @var Value $str */
1268 if ($str->kindOf() != 'scalar' || $str->scalartyp() != 'string') {
1271 $response[] = new Response(0, $code->scalarval(), $str->scalarval());